FaxOutgoingArchive object

The FaxOutgoingArchive configuration object is used by a fax client application to access and configure the archive of outbound fax messages transmitted successfully by the fax service. You can also use the FaxOutgoingArchive object to retrieve a message from the archive using its message ID.

Members

The FaxOutgoingArchive object has these types of members:

• Methods
• Properties

Methods

The FaxOutgoingArchive object has these methods.

Method	Description
[GetMessage](-mfax-faxoutgoingarchive-getmessage.md)	The [GetMessage](-mfax-faxoutgoingarchive-getmessage.md) method returns a fax message from the archive of outbound faxes by using the fax message ID.
[GetMessages](-mfax-faxoutgoingarchive-getmessages.md)	The [GetMessages](-mfax-faxoutgoingarchive-getmessages.md) method returns a new iterator (archive cursor) for the archive of outbound fax messages. For more information, see [FaxOutgoingMessageIterator](-mfax-faxoutgoingmessageiterator.md).
[Refresh](-mfax-faxoutgoingarchive-refresh-vb.md)	The [Refresh](-mfax-faxoutgoingarchive-refresh-vb.md) method refreshes FaxOutgoingArchive object information from the fax server. When the Refresh method is called, any configuration changes made after the last [Save](-mfax-faxoutgoingarchive-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-faxoutgoingarchive-save-vb.md)	The [Save](-mfax-faxoutgoingarchive-save-vb.md) method saves the FaxOutgoingArchive object data. [!Note] In Windows Vista, Windows Server 2008, and later versions of Windows, this method is not supported and returns an error.

 

Properties

The FaxOutgoingArchive object has these properties.

Property	Access type	Description
[AgeLimit](-mfax-faxoutgoingarchive-agelimit-vb.md)	Read/write	The [AgeLimit](-mfax-faxoutgoingarchive-agelimit-vb.md) property is a value that indicates the number of days that the fax service retains fax messages in the archive of outbound faxes. The fax service deletes messages from the outbound 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-faxoutgoingarchive-archivefolder-vb.md)	Read-only	The [ArchiveFolder](-mfax-faxoutgoingarchive-archivefolder-vb.md) property is a null-terminated string that specifies the folder location on the fax server for archived outbound 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-faxoutgoingarchive-highquotawatermark-vb.md)	Read/write	The [HighQuotaWaterMark](-mfax-faxoutgoingarchive-highquotawatermark-vb.md) property is a value that specifies the upper threshold for the size of the archive of inbound fax messages, in megabytes. If the archived fax messages in the archive exceed this value, and the [SizeQuotaWarning](-mfax-faxoutgoingarchive-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-faxoutgoingarchive-lowquotawatermark-vb.md)	Read/write	The [LowQuotaWaterMark](-mfax-faxoutgoingarchive-lowquotawatermark-vb.md) property is a value that specifies the lower threshold for the archive of outbound 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 outbound 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-faxoutgoingarchive-sizehigh-vb.md)	Read-only	The [SizeHigh](-mfax-faxoutgoingarchive-sizehigh-vb.md) property is a value that specifies the high 32-bit value (in bytes) for the size of the archive of outgoing fax messages. [!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.ArchiveSizeHigh](-mfax-faxconfiguration-archivesizehigh-vb.md) property from the [FaxServer](-mfax-faxserver.md) object.
[SizeLow](-mfax-faxoutgoingarchive-sizelow-vb.md)	Read-only	The [SizeLow](-mfax-faxoutgoingarchive-sizelow-vb.md) property is a value that specifies the low 32-bit value (in bytes) for the size of the archive of outgoing fax messages. [!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.ArchiveSizeLow](-mfax-faxconfiguration-archivesizelow-vb.md) property from the [FaxServer](-mfax-faxserver.md) object.
[SizeQuotaWarning](-mfax-faxoutgoingarchive-sizequotawarning-vb.md)	Read/write	The [SizeQuotaWarning](-mfax-faxoutgoingarchive-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 outbound archive exceeds the limit defined by the [HighQuotaWaterMark](-mfax-faxoutgoingarchive-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-faxoutgoingarchive-usearchive-vb.md)	Read/write	The [UseArchive](-mfax-faxoutgoingarchive-usearchive-vb.md) property is a Boolean value that indicates whether the fax service archives outbound fax messages. If this parameter is equal to True, the fax service archives outbound fax messages. If this parameter is equal to False, the fax service does not archive outbound 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.

 

Remarks

A FaxOutgoingArchive object is accessed through a FaxFolders object.

To create a FaxOutgoingArchive object in Microsoft Visual Basic, retrieve the OutgoingArchive property of the FaxFolders object.

To create a FaxOutgoingArchive object in C++, call the OutgoingArchive method.

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	CLSID_FaxOutgoingArchive