FaxPhonebook Object

The FaxPhonebook object represents a phonebook available to the current session.

Properties

Methods

Remarks

Use the Type property to distinguish the phonebook type: shared, personal or external ODBC connection.

Back to Top

Close Method

The Close method closes the FaxPhonebook object.

Syntax

ObjPhonebook.Close( )

Back to Top

ConnectionID Property

The ConnectionID property returns the connection ID of the ODBC link. Read-only.

Syntax

ObjPhonebook.ConnectionID

Data Type

Long

Remarks

The ConnectionID property is only valid for ODBC phonebook references. Connection IDs are established for the lifetime of a session.

Back to Top

Containers Property

The Containers property will construct ane return a flat containers collection object - a collection of all containers in the phonebook regardless of hierarchy. Read only.

Syntax

ObjPhonebook.Containers(FaxPhonebookContainers PhonebookContainers)

Data Type

FaxPhonebookContainers

Remarks

Back to Top

Created Property

The Created property returns the date and time the phonebook object was created. Read-only.

Syntax

ObjPhonebook.Created

Data Type

Date

Back to Top

Delete Method

The Delete method removes the FaxPhonebook object from its parent FaxPhonebooks collection, and deletes any fax server based resources associated with the FaxPhonebook object.

Syntax

ObjPhonebook.Delete( )

Remarks

The Delete method will permanently delete the phonebook object - the operation cannot be undone.

Back to Top

GetContainer Method

The GetContainer method returns the FaxPhonebookContainer object having the ContainerID you specify.

Syntax

ObjPhonebook.GetContainer (ContainerID)

Remarks

The returned FaxPhonebookContainer object is accessed directly. After using the GetContainer method, you cannot access the returned FaxPhonebookContainer's "parent" object.

Back to Top

GetEntry Method

The GetEntry method returns the FaxPhonebookEntry object having the EntryID you specify.

Syntax

ObjPhonebook.GetEntry (EntryID)

Remarks

The returned FaxPhonebookEntry object is accessed directly. After using the GetEntry method, you cannot access the returned FaxPhonebookEntry's "parent" object.

Back to Top

Index Property

The Index property returns the index of this phonebook within its parent FaxPhonebooks collection. Read-only.

Syntax

ObjPhonebook.Index

Data Type

Long

Remarks

A phonebook's index property may change if phonebook items are removed from the parent FaxPhonebooks collection.

The first object in the collection has an Index value of 1.

Back to Top

IsOpen Property

The IsOpen property returns the open/closed status of the FaxPhonebook object. Read-only.

Syntax

ObjPhonebook.IsOpen

Data Type

Boolean

Remarks

A non-zero value is returned if the phonebook object is open.

Back to Top

Modified Property

The Modified property returns the date and time when the phonebook object was last modified. Read-only.

Syntax

ObjPhonebook.Modified

Data Type

Date

Back to Top

Name Property

The Name property returns or sets the display name of the FaxPhonebook object as a string. Read/write.

Syntax

ObjPhonebook.Name

Data Type

String

Back to Top

Open Method

The Open method opens the FaxPhonebook object.

Syntax

ObjPhonebook.Open( )

Remarks

To open the phonebook object as read-only, use a non-zero value for the optional ReadOnly parameter.

Back to Top

Rename Method

The Rename method changes the display name of the FaxPhonebook object.

Syntax

ObjPhonebook.Rename(NewName)

Remarks

Define the NewName parameter as a string.

Back to Top

RootContainer Property

The RootContainer property returns the logged on user's top-level FaxPhonebookContainer object on the server. A FaxPhonebookContainer object can contain FaxPhonebookEntries and other FaxPhonebookContainers (sub-containers). Read-only.

Syntax

ObjPhonebook.RootContainer

Data Type

FaxPhonebookContainer object

Back to Top

Type Property

The Type property returns the FaxPhonebook object type. Read-only.

Syntax

ObjPhonebook.Type

Data Type

Long

Remarks

Phonebook types can be "shared," "personal," or "ODBC." Valid values for this property are defined by the FaxMsg_PhonebookType enumeration.

Back to Top