IFaxIncomingArchive::GetMessages method (faxcomex.h)

The GetMessages method returns a new iterator (archive cursor) for the archive of inbound fax messages.

Syntax

HRESULT GetMessages(
  [in]          long                        lPrefetchSize,
  [out, retval] 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.

[out, retval] 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

To use this method, a user must have the farQUERY_IN_ARCHIVE access right.

Requirements

   
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header faxcomex.h
DLL Fxscomex.dll

See also

FaxIncomingArchive

FaxIncomingMessageIterator

IFaxIncomingArchive

Visual Basic Example