IFaxAccountIncomingArchive::GetMessages method (faxcomex.h)

Returns a new iterator (archive cursor) for the archive of inbound fax messages for a particular fax account.

Syntax

HRESULT GetMessages(
  [in] long                        lPrefetchSize,
       IFaxIncomingMessageIterator **pFaxIncomingMessageIterator
);

Parameters

[in] lPrefetchSize

Type: long

long value that indicates the size of the prefetch buffer. This value determines how many fax messages the iterator object retrieves from the fax server when the object needs to refresh its contents. The default value is lDEFAULT_PREFETCH_SIZE.

pFaxIncomingMessageIterator

Type: IFaxIncomingMessageIterator**

A FaxIncomingMessageIterator object.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

If the setting 'All incoming faxes are viewable by everyone' is true (see IncomingFaxesArePublic) or if far2MANAGE_RECEIVE_FOLDER access rights, then the fax service enumerates all faxes in the Incoming archive of the Fax Server Receive Folder.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header faxcomex.h
DLL Fxscomex.dll

See also

FaxAccountIncomingArchive

FaxIncomingMessageIterator

IFaxAccountIncomingArchive