FaxPhonebookContainer Object

The FaxPhonebookContainer object represents a logical grouping of phonebook entries within a phonebook. A FaxPhonebookContainer can contain FaxPhonebookEntry objects and FaxPhonebookContainer objects.

Properties

Methods

Back to Top

ContainerID Property

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

Syntax

ObjPhonebookContainer.ContainerID

Data Type

Long

Back to Top

Containers Property

The Containers property returns a FaxPhonebookContainers object, representing a collection of sub-containers. Read-only.

Syntax

ObjPhonebookContainer.Containers

Data Type

FaxPhonebookContainers

Back to Top

CreateEntry Method

The CreateEntry method creates and returns a new FaxPhonebookEntry object.

Syntax

ObjPhonebookContainer.CreateEntry(Type)

Remarks

Valid values for the Type parameter are defined by the FaxMsg_PhonebookEntryType enumeration.

Back to Top

Delete Method

The Delete method deletes the FaxPhonebookContainer object, including contained containers and phonebook entries. The Delete method will also delete any fax server based resources associated with the FaxPhonebookContainer object.

Syntax

ObjPhonebookContainer.Delete( )

Remarks

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

Back to Top

Description Property

The Description property returns or sets a descriptive string for the FaxPhonebookContainer object. Read/write.

Syntax

ObjPhonebookContainer.Description

Data Type

String

Back to Top

Entries Property

The Entries property returns a FaxPhonebookEntries object, representing a collection of phonebook entries. Read-only.

Syntax

ObjPhonebookContainer.Entries

Data Type

FaxPhonebookEntries

Back to Top

Fields Property

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

Syntax

ObjPhonebookContainer.Fields

Data Type

FaxFields object

Back to Top

Index Property

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

Syntax

ObjPhonebookContainer.Index

Data Type

Long

Remarks

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

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

Back to Top

IsSubFolder Method

The IsSubFolder method queries the current phonebook container's relationship to another container you specify.

Syntax

ObjPhonebookContainer.IsSubFolder(ContainerID)

Remarks

The IsSubFolder method returns a Boolean value. A non-zero value is returned if the ContainerID you specify is a sub-container of the current phonebook container object.

Back to Top

Name Property

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

Syntax

ObjPhonebookContainer.Name

Data Type

String

Back to Top

MoveTo Method

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

Syntax

ObjPhonebookContainer.MoveTo (NewParentID)

Remarks

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

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

Back to Top

ParentContainerID Property

The ParentContainerID property returns the unique 32-bit identifier assigned to the container's parent. Read-only.

Syntax

ObjPhonebookContainer.ParentContainerID

Data Type

Long

Back to Top

SearchEntries Property

Documentation forthcoming.

Syntax

ObjPhonebookContainer.SearchEntries

Data Type

FaxPhonebookEntries object.

Remarks

Back to Top

SearchFields Property

Documentation forthcoming.

Syntax

ObjPhonebookContainer.SearchFields

Data Type

FaxPhonebookFields object.

Remarks

Back to Top

SortOrder Property

The SortOrder property returns or sets a sort order associated with the primary sort property. Read/write.

Syntax

ObjPhonebookContainer.SortOrder

Data Type

Long

Remarks

Valid values for this property are defined by the FaxMsg_Sort enumeration.

Back to Top

SortOrder2 Property

The SortOrder2 property returns or sets a sort order associated with the secondary sort property. Read/write.

Syntax

ObjPhonebookContainer.SortOrder2

Data Type

Long

Remarks

Valid values for this property are defined by the FaxMsg_Sort enumeration.

Back to Top

SortProperty Property

The SortProperty property returns or sets the primary sort property of the container. This defines the field by which the container's FaxPhonebookContainer objects and FaxPhonebookEntry objects will be sorted. Read/write.

Syntax

ObjPhonebookContainer.SortProperty

Data Type

Long

Back to Top

SortProperty2 Property

The SortProperty2 property returns or sets the secondary sort property of the folder. This defines the secondary field by which the container's FaxPhonebookContainer objects and FaxPhonebookEntry objects will be sorted. Read/write.

Syntax

ObjPhonebookContainer.SortProperty2

Data Type

Long

Back to Top

Update Method

The Update method saves changes made to the FaxPhonebookContainer object.

Syntax

ObjPhonebookContainer.Update (Commit)

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

Back to Top