FaxPhonebooks Collection Object
The FaxPhonebooks collection object contains one or more
FaxPhonebook objects available to the current session.
The collection may include FaxPhonebook objects representing
each "shared" phonebook, a personal phonebook (if any), and
any external ODBC connections.
Properties
Methods
|
Name |
Input Parameters |
Return Values |
|
Add |
Name as String,
Type as Long,
(Optional) Source as String |
FaxPhonebook object |
|
Remove |
Index as Long |
|
Remarks
Use the Item property to reference a particular
FaxPhonebook object.
Back to Top
Add Method
The Add method creates and returns a new
FaxPhonebook object in the FaxPhonebooks collection. The
Add method also creates server based resources associated
with the new FaxPhonebook.
Syntax
ObjPhonebooks.Add (Name, Type)
Remarks
The Name parameter (string) is the name to be assigned to
the new phonebook.
The Type parameter (long) defines the phonebook type.
Valid values for this property are defined by the
FaxMsg_PhonebookType enumeration.
The optional Source parameter (string) definition depends
on the phonebook type. For system phonebooks, this parameter
is ignored. For personal phonebooks, the source string is
the actual file name (.ndb). For ODBC links, this parameter
is the name of the ODBC map file specifying the data source
and field mappings for the connection.
Back to Top
Count Property
The Count property returns the number of
FaxPhonebook objects contained in the collection.
Read-only.
Syntax
ObjPhonebooks.Count
Data Type
Long
Back to Top
Item Property
The Item property returns a single
FaxPhonebook object from the collection. Read-only.
Syntax
ObjPhonebooks.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
FaxPhonebook object
Remarks
The Item property is the default property of the
FaxPhonebooks object.
Back to Top
Remove Method
The Remove method deletes the
FaxPhonebook object with the specified index from the
collection. Server based resources associated with the
phonebook are also deleted.
Syntax
ObjPhonebooks.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 phonebook will be
deleted permanently from the FaxPhonebooks collection.
Back to Top
|
