FaxIncomingArchive object
Applies to: desktop apps only
The FaxIncomingArchive object is used by a fax client application to access and configure the archive of inbound fax messages received successfully by the fax service. Use this object to set and retrieve parameters related to configuring the archive of sent faxes. You can also use the FaxIncomingArchive object to retrieve a message from the archive by specifying its message ID.
A FaxIncomingArchive object is accessed through a FaxFolders object. FaxIncomingArchive objects provide access to FaxIncomingMessageIterator objects and FaxIncomingMessage objects.
To create a FaxIncomingArchive object in Microsoft Visual Basic, call the IncomingArchive property of the FaxFolders object.
To create a FaxIncomingArchive object in C++, call the IncomingArchive property.
Members
The FaxIncomingArchive object has these types of members:
Methods
The FaxIncomingArchive object has these methods.
| Method | Description |
|---|---|
| GetMessage |
The GetMessage method gets a fax message from the archive of inbound faxes by using the fax message ID. |
| GetMessages |
The GetMessages method gets a new iterator (archive cursor) for the archive of inbound fax messages. |
| Refresh |
The Refresh method refreshes FaxIncomingArchive object information from the fax server. When the Refresh method is called, any configuration changes made after the last Save method call are lost. Note In Windows Vista, Windows Server 2008, and later versions of Windows, this method is not supported and returns an error. |
| Save |
Saves the FaxIncomingArchive object's data. Note In Windows Vista, Windows Server 2008, and later versions of Windows, this method is not supported and returns an error. |
Properties
The FaxIncomingArchive object has these properties.
| Property | Access type | Description |
|---|---|---|
| Read/write |
The AgeLimit property is a value that indicates the number of days that the fax service retains fax messages in the archive of inbound faxes. The fax service deletes messages from the inbound archive when they exceed the age limit. If the value of this property is zero, the fax service does not enforce an age limit. Note This property is not supported in Windows Vista, Windows Server 2008, and later versions of Windows. To access this property in Windows Vista, Windows Server 2008, and later versions of Windows, get the FaxConfiguration.ArchiveAgeLimit property from the FaxServer object. | |
| Read/write |
The ArchiveFolder property is a null-terminated string that specifies the folder location on the fax server for archived inbound faxes. Note This property is not supported in Windows Vista, Windows Server 2008, and later versions of Windows. To access this property in Windows Vista, Windows Server 2008, and later versions of Windows, get the FaxConfiguration.ArchiveLocation property from the FaxServer object. | |
| Read/write |
The HighQuotaWaterMark property is a value that specifies the upper warning threshold for the size of the archive of inbound fax messages, in megabytes. If the size of the archive exceeds this value, and the SizeQuotaWarning property is equal to True, the fax service issues a warning in the event log. Note This property is not supported in Windows Vista, Windows Server 2008, and later versions of Windows. To access this property in Windows Vista, Windows Server 2008, and later versions of Windows, get the FaxConfiguration.HighQuotaWaterMark property from the FaxServer object. | |
| Read/write |
The LowQuotaWaterMark property is a value that specifies the lower warning threshold for the archive of inbound fax messages, in megabytes. If the fax service has issued a warning in the event log, the service does not issue additional warnings until the size of the inbound archive drops below this value. Note This property is not supported in Windows Vista, Windows Server 2008, and later versions of Windows. To access this property in Windows Vista, Windows Server 2008, and later versions of Windows, get the FaxConfiguration.LowQuotaWaterMark property from the FaxServer object. | |
| Read-only |
The SizeHigh property is a value that specifies the high 32-bit value (in bytes) for the size of the archive of inbound fax messages. Note This property is not supported in Windows Vista, Windows Server 2008, and later versions of Windows. | |
| Read-only |
The SizeLow property is a value that specifies the low 32-bit value (in bytes) for the size of the archive of inbound fax messages. Note This property is not supported in Windows Vista, Windows Server 2008, and later versions of Windows. | |
| Read/write |
The SizeQuotaWarning property is a Boolean value that indicates whether the fax service issues a warning in the event log when the size of the inbound archive exceeds the limit defined by the HighQuotaWaterMark property. Note This property is not supported in Windows Vista, Windows Server 2008, and later versions of Windows. To access this property in Windows Vista, Windows Server 2008, and later versions of Windows, get the FaxConfiguration.SizeQuotaWarning property from the FaxServer object. | |
| Read/write |
The UseArchive property is a Boolean value that indicates whether the fax service archives inbound fax messages. If this property is equal to True, the fax service archives inbound fax messages. If this property is equal to False, the fax service does not archive inbound faxes. Note This property is not supported in Windows Vista, Windows Server 2008, and later versions of Windows. To access this property in Windows Vista, Windows Server 2008, and later versions of Windows, get the FaxConfiguration.UseArchive property from the FaxServer object. |
Requirements
|
Minimum supported client | Windows XP |
|---|---|
|
Minimum supported server | Windows Server 2003 |
|
DLL |
|
|
IID |
76062CC7-F714-4FBD-AA06-ED6E4A4B70F3 |
See also
Build date: 5/5/2012
