FaxMessages Collection Object
The FaxMessages collection object can contain zero or
more
FaxMessage objects.
Properties
Methods
|
Name |
Input Parameters |
Return Values |
|
GetMessage |
MessageID as Long |
FaxMessage object |
|
Refresh |
(None) |
|
|
Remove |
Index as Long |
|
|
RemoveAll |
(None) |
|
|
Sort |
SortProperty as Long,
SortProperty2 as Long,
SortOrder as Long,
SortOrder2 as Long
(All optional) |
|
Remarks
Because there may be many fax messages in a folder, use
the Item property when possible to reference a particular
FaxMessage object. Use the Sort method to sort the
FaxMessage objects in ascending or descending order.
Back to Top
Count Property
The Count property returns the number of
FaxMessage objects contained in the collection.
Read-only.
Syntax
ObjMessages.Count
Data Type
Long
Back to Top
GetMessage Method
The GetMessage method returns a copy of the
FaxMessage object as defined by the MessageID.
Syntax
ObjMessages.GetMessage (MessageID)
where MessageID is the unique identifier of the
FaxMessage object you want to retrieve.
Remarks
The GetMessage method returns the FaxMessage object
associated with the MessageID you specify.
Back to Top
Item Property
The Item property returns a single
FaxMessage object from the collection. Read-only.
Syntax
ObjMessages.Item(Index)
where Index is a long integer ranging from 1 to the size
of the collection (i.e., value of Count property).
Data Type
FaxMessage object
Remarks
The Item property is the default property of the
FaxMessages object.
Back to Top
ItemMsgId Property
The ItemMsgId property returns the item's message id
property
Syntax
ObjMessages.ItemMsgId(Index)
where Index is a long integer ranging from 1 to the size
of the collection (i.e., value of Count property).
Data Type
Long
Remarks
Any Remarks?
Back to Top
ItemMsgType Property
The ItemMsgType property returns the item's message type
property
Syntax
ObjMessages.ItemMsgType(Index)
where Index is a long integer ranging from 1 to the size
of the collection (i.e., value of Count property).
Data Type
Long
Remarks
Any Remarks?
Back to Top
ItemMsgStatus Property
The ItemMsgStatus property returns the item's status
property
Syntax
ObjMessages.ItemMsgStatus(Index)
where Index is a long integer ranging from 1 to the size
of the collection (i.e., value of Count property).
Data Type
Long
Remarks
Any Remarks?
Back to Top
Refresh Method
The Refresh method updates the FaxMessages collection
from the server.
Syntax
ObjMessages.Refresh
Back to Top
Remove Method
The Remove method deletes the
FaxMessage object with the specified index from the
collection. Server based resources associated with the
attachment are also deleted.
Syntax
ObjMessages.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 message is deleted
permanently from the FaxMessages collection.
Back to Top
RemoveAll Method
The RemoveAll method deletes all FaxMessage objects from
the collection. Server based resources associated with the
messages are also deleted.
Syntax
ObjMessages.RemoveAll ( )
Remarks
The RemoveAll method is irreversible. All messages are
deleted permanently from the FaxMessages collection.
Back to Top
Sort Method
The Sort method sorts the collection on the specified
SortProperty according to the specified SortOrder.
Syntax
ObjMessages.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
SortOrder Property
The SortOrder property returns the sort order associated
with the primary sort property. Read-only.
Syntax
ObjMessages.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 the sort order associated
with the secondary sort property. Read-only.
Syntax
ObjMessages.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 the primary sort
property of the messages in the collection. Read-only.
Syntax
ObjMessages.SortProperty
Data Type
Long
Remarks
Valid values for this property are defined by the
FaxMsg_MessageProperties enumeration.
Back to Top
SortProperty2 Property
The SortProperty2 property returns the secondary sort
property of the messages in the collection. Read-only.
Syntax
ObjMessages.SortProperty2
Data
Long
Remarks
Valid values for this property are defined by the
FaxMsg_MessageProperties enumeration.
Back to Top
|
