FaxPhonebookEntry Object

The FaxPhonebookEntry object represents a defined phonebook recipient.

Properties

Methods

Remarks

Use the Type property to distinguish the phonebook entry type: individual recipient and group (distribution list) entries.

Back to Top

AddMember Method

The AddMember method adds the specified FaxPhonebookEntry to the group.

Syntax

ObjPhonebookEntry.AddMember(EntryID)

Back to Top

ContainerID Property

The ContainerID property returns the unique 32-bit identifier assigned to the container to which the phonebook entry belongs. Read-only.

Syntax

ObjPhonebookEntry.ContainerID

Data Type

Long

Back to Top

CopyTo Method

The CopyTo method copies the phonebook entry into the container that has the ContainerID you specify.

Syntax

ObjPhonebookEntry.CopyTo(ContainerID)

Remarks

The CopyTo method creates server based resources associated with the new FaxPhonebookEntry object.

Back to Top

DefaultFaxNumber Property

The DefaultFaxNumber property returns the default fax number defined for the FaxPhonebookEntry object. Read-only.

Syntax

ObjPhonebookEntry.DefaultFaxNumber

Data Type

String

Back to Top

Delete Method

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

Syntax

ObjPhonebookEntry.Delete( )

Remarks

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

Back to Top

DeleteMember Method

The DeleteMember method deletes the specified FaxPhonebookEntry from the group.

Syntax

ObjPhonebookEntry.DeleteMember(EntryID)

Back to Top

EntryID Property

The EntryID property returns the unique 32-bit identifier assigned to the phonebook entry. Read-only.

Syntax

ObjPhonebookEntry.EntryID

Data Type

Long

Remarks

The EntryID property can be used to retrieve this phonebook entry at a later time, using the FaxPhonebook object’s GetEntry method.

Back to Top

Fields Property

The Fields property returns a FaxFields collection object and all of its properties. Read-only.

Syntax

ObjPhonebookEntry.Fields

Data Type

FaxFields object

Back to Top

FullName Property

The FullName property returns the name of the FaxPhonebookEntry object as a string. Read-only.

Syntax

ObjPhonebookEntry.FullName

Data Type

String

Back to Top

GetFieldValue Method

The GetFieldValue method returns the value of the FieldID you specify.

Syntax

ObjPhonebookEntry.GetFieldValue (FieldID)

Back to Top

Index Property

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

Syntax

ObjPhonebookEntry.Index

Data Type

Long

Remarks

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

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

Back to Top

Members Property

The Members property returns a FaxPhonebookEntries collection object containing the group members. Read-only.

Syntax

ObjPhonebookEntry.Members

Data Type

FaxPhonebookEntries object

Remarks

Back to Top

MoveTo Method

The MoveTo method moves the FaxPhonebookEntry object to another container object.

Syntax

ObjPhonebookEntry.MoveTo (ContainerID)

Remarks

The MoveTo method moves the phonebook entry to the container having the ContainerID you specify. The ContainerID is the unique identifier of the destination object into which this phonebook entry is to be moved.

All properties that have been set on this entry are moved, whether they have read-only or read/write access. Each property is moved with its value and access unchanged.

Back to Top

PhonebookID Property

The PhonebookID property returns the unique 32-bit identifier assigned to the FaxPhonebook object to which the FaxPhonebookEntry belongs. Read-only.

Syntax

ObjPhonebookEntry.PhonebookID

Data Type

Long

Back to Top

SetFieldValue Method

The SetFieldValue method sets a value for the FieldID you specify.

Syntax

ObjPhonebookEntry.SetFieldValue (FieldID, NewVal)

where FieldID is the unique identifier of the field you want to define and NewVal is the new value of the field.

Back to Top

Type Property

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

Syntax

ObjPhonebookEntry.Type

Data Type

Long

Remarks

PhonebookEntry object types can be either "individual" or "group." Valid values for this property are defined by the FaxMsg_PhonebookEntryType enumeration.

Back to Top

Update Method

The Update method saves changes made to the FaxPhonebookEntry object.

Syntax

ObjPhonebookEntry.Update (Commit)

where Commit can be either TRUE (non-zero) or FALSE (0).

Back to Top