FaxPhonebookEntries Collection Object
The FaxPhonebookEntries collection object contains
FaxPhonebookEntry objects for each entry within its
parent FaxPhonebookContainer object.
Properties
Methods
|
Name |
Input Parameters |
Return Values |
|
Add |
EntryID as Long (Optional) |
FaxPhonebookEntry object |
|
Find |
Start as Long,
Field as Long,
Flags as Long,
Value as Variant |
Index |
|
Remove |
Index as Long |
|
|
Sort |
SortProperty as Long,
SortProperty2 as Long,
SortOrder as Long,
SortOrder2 as Long
(All optional) |
|
Remarks
Use the Item property to reference a particular
FaxPhonebookEntry object.
Back to Top
Add Method
The Add method creates and returns a new
FaxPhonebookEntry object in the FaxPhonebookEntries
collection. The Add method also creates server based
resources associated with the new FaxPhonebookEntry.
Syntax
ObjPhonebookEntries.Add ( )
Remarks
The optional EntryID parameter (long) is the ID to be
assigned to the new FaxPhonebookEntry.
Back to Top
Count Property
The Count property returns the number of
FaxPhonebookEntry objects contained in the collection.
Read-only.
Syntax
ObjPhonebookEntries.Count
Data Type
Long
Back to Top
Find Method
The Find method returns a
FaxPhonebookEntry object that matches your search
criteria.
Syntax
ObjPhonebookEntries.Find (Start, Field, Flags, Value)
Remarks
The input parameters are defined as follows:
Start (long) - the 1-based index where the lookup is to
begin.
Field (long) - the field ID/property to search for (e.g.,
FaxMsg_PB_Display_Name).
Flags - reserved for future use.
Value - the value you are searching for. This value may
be incomplete (e.g., a value of "Tom" would match the "Tomas
Smith" entry).
Back to Top
Item Property
The Item property returns a single
FaxPhonebookEntry object from the collection. Read-only.
Syntax
ObjPhonebookEntries.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
FaxPhonebookEntry object
Remarks
The Item property is the default property of the
FaxPhonebookEntries object.
Back to Top
ItemEntryId Property
The ItemEntryId property returns the item's recipient id
property.
Syntax
ObjPhonebookEntries.ItemEntryId(Index)
where Index is a long integer ranging from 1 to the size
of the collection (i.e., value of the Count property).
Remarks
Any Remarks, Jeffrey?
ItemEntryType Property
The ItemEntryType property returns the item's recipient
type property.
Syntax
ObjPhonebookEntries.ItemEntryType(Index)
where Index is a long integer ranging from 1 to the size
of the collection (i.e., value of the Count property).
Remarks
Any Remarks, Jeffrey?
Back to Top
Remove Method
The Remove method deletes the
FaxPhonebookEntry object with the specified index from
the collection. Server based resources associated with the
phonebook entry are also deleted.
Syntax
ObjPhonebookEntries.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 entry
will be deleted permanently from the FaxPhonebookEntries
collection.
Back to Top
RemoveAll Method
The RemoveAll method deletes all
FaxPhonebookEntry objects from the collection.
Server-based resources associated with the phonebook entries
are also deleted.
Syntax
ObjPhonebookEntries.RemoveAll
Remarks
The RemoveAll method is permanent - it cannot be undone.
Back to Top
Sort Method
The Sort method sorts the collection on the specified
SortProperty according to the specified SortOrder.
Syntax
ObjPhonebookEntries.Sort ( )
Remarks
All parameters are optional. If SortOrder or SortProperty
is not specified, the properties used in the previous call
to the Sort method are used again.
Back to Top
|
