Share via

FaxIncomingArchive object

  • Article

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.

faxfolders, faxincomingarchive, and subordinate objects to faxincomingarchive

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](-mfax-faxincomingarchive-getmessage-vb.md) The [GetMessage](-mfax-faxincomingarchive-getmessage-vb.md) method gets a fax message from the archive of inbound faxes by using the fax message ID.
[GetMessages](-mfax-faxincomingarchive-getmessages-vb.md) The [GetMessages](-mfax-faxincomingarchive-getmessages-vb.md) method gets a new iterator (archive cursor) for the archive of inbound fax messages.
[Refresh](-mfax-faxincomingarchive-refresh-vb.md) The [Refresh](-mfax-faxincomingarchive-refresh-vb.md) method refreshes FaxIncomingArchive object information from the fax server. When the Refresh method is called, any configuration changes made after the last [Save](-mfax-faxincomingarchive-save-vb.md) 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](-mfax-faxincomingarchive-save-vb.md) 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
[AgeLimit](-mfax-faxincomingarchive-agelimit-vb.md)
 Read/write
 The [AgeLimit](-mfax-faxincomingarchive-agelimit-vb.md) 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](-mfax-faxconfiguration-archiveagelimit-vb.md) property from the [FaxServer](-mfax-faxserver.md) object.

[ArchiveFolder](-mfax-faxincomingarchive-archivefolder-vb.md)
 Read/write
 The [ArchiveFolder](-mfax-faxincomingarchive-archivefolder-vb.md) 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](-mfax-faxconfiguration-archivelocation-vb.md) property from the [FaxServer](-mfax-faxserver.md) object.

[HighQuotaWaterMark](-mfax-faxincomingarchive-highquotawatermark-vb.md)
 Read/write
 The [HighQuotaWaterMark](-mfax-faxincomingarchive-highquotawatermark-vb.md) 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](-mfax-faxincomingarchive-sizequotawarning-vb.md) 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](-mfax-faxconfiguration-highquotawatermark-vb.md) property from the [FaxServer](-mfax-faxserver.md) object.

[LowQuotaWaterMark](-mfax-faxincomingarchive-lowquotawatermark-vb.md)
 Read/write
 The [LowQuotaWaterMark](-mfax-faxincomingarchive-lowquotawatermark-vb.md) 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](-mfax-faxconfiguration-lowquotawatermark-vb.md) property from the [FaxServer](-mfax-faxserver.md) object.

[SizeHigh](-mfax-faxincomingarchive-sizehigh-vb.md)
 Read-only
 The [SizeHigh](-mfax-faxincomingarchive-sizehigh-vb.md) 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.

[SizeLow](-mfax-faxincomingarchive-sizelow-vb.md)
 Read-only
 The [SizeLow](-mfax-faxincomingarchive-sizelow-vb.md) 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.

[SizeQuotaWarning](-mfax-faxincomingarchive-sizequotawarning-vb.md)
 Read/write
 The [SizeQuotaWarning](-mfax-faxincomingarchive-sizequotawarning-vb.md) 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](-mfax-faxincomingarchive-highquotawatermark-vb.md) 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](-mfax-faxconfiguration-sizequotawarning-vb.md) property from the [FaxServer](-mfax-faxserver.md) object.

[UseArchive](-mfax-faxincomingarchive-usearchive-vb.md)
 Read/write
 The [UseArchive](-mfax-faxincomingarchive-usearchive-vb.md) 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](-mfax-faxconfiguration-usearchive-vb.md) property from the [FaxServer](-mfax-faxserver.md) object.

 

Requirements
Minimum supported client
 Windows XP [desktop apps only]
Minimum supported server
 Windows Server 2003 [desktop apps only]
Header
Faxcomex.h
DLL
Fxscomex.dll
IID
 76062CC7-F714-4FBD-AA06-ED6E4A4B70F3

See also

Fax Service object hierarchy

IFaxIncomingArchive