FACSys® Fax Messaging Gateway
Software Development Kit (SDK)
AFM & Web Services

Download
SDK


Contact

Introduction Object Model Tasks Samples & Programming Languages Packaging Troubleshooting FAQ Appendices

FaxPhonebookContainers Collection Object

The FaxPhonebookContainers collection object contains one or more FaxPhonebookContainer objects representing sub-containers of the current FaxPhonebookContainer.

Properties

Name

Data Type

Access

Class

Long

Read-only

Parent

FaxPhonebook object

Read-only

Session

FaxSession object

Read-only

     

Count

Long

Read-only

Item

FaxPhonebookContainer object

Read-only

 

 

Methods

Name

Input Parameters

Return Values

Add

Name as String

FaxPhonebookContainer object

Remove

Index as Long

 

RemoveAll

(None)

 
 

 

Remarks

Use the Item property to reference a particular FaxPhonebookContainer object.

Back to Top

 

Add Method

The Add method creates and returns a new FaxPhonebookContainer object in the FaxPhonebookContainers collection. The Add method also creates server based resources associated with the new FaxPhonebookContainer.

Syntax

ObjPhonebookContainers.Add (Name)

Remarks

The Name parameter (string) is the name to be assigned to the new container/folder.

Back to Top

 

Count Property

The Count property returns the number of FaxPhonebookContainer objects contained in the collection. Read-only.

Syntax

ObjPhonebookContainers.Count

Data Type

Long

Back to Top

 

Item Property

The Item property returns a single FaxPhonebookContainer object from the collection. Read-only.

Syntax

ObjPhonebookContainers.Item(Index)

where Index is a long integer ranging from 1 to the size of the collection (i.e., value of the Count property).

Data Type

FaxPhonebookContainer object

Remarks

The Item property is the default property of the FaxPhonebookContainers object.

Back to Top

 

Remove Method

The Remove method deletes the FaxPhonebookContainer object with the specified index from the collection. Server based resources associated with the container are also deleted.

Syntax

ObjPhonebookContainers.Remove(Index)

where Index is a long integer ranging from 1 to the size of the collection (i.e., value of the Count property).

Remarks

The Remove method is irreversible. The container/folder will be deleted permanently from the FaxPhonebookContainers collection.

Back to Top

 

RemoveAll Method

The RemoveAll method deletes all FaxPhonebookContainer objects from the collection. Server based resources associated with the containers are also deleted.

Syntax

ObjPhonebookContainers.RemoveAll ( )

Remarks

The RemoveAll method is irreversible. All containers are deleted permanently from the FaxPhonebookContainers collection.

Back to Top

Session

Image

Constant Definitions

Error Codes


Common Properties

Folders

Folder

Messages

Message

Recipients

Recipient

Attachments

Attachment

Phonebooks

Phonebook

Containers

Container

Entries

Entry

Fields

Field

Coverpages

Coverpage

Users

User

Home  |  emFAST  |  FACSys  |  FACSys Support  |  Download Request  |  Contact