IFaxOutgoingArchive::GetMessages method (faxcomex.h)

Article
02/22/2024

The IFaxOutgoingArchive::GetMessages method returns a new iterator (archive cursor) for the archive of outbound fax messages. For more information, see IFaxOutgoingMessageIterator.

Syntax

HRESULT GetMessages(
                long                        lPrefetchSize,
  [out, retval] IFaxOutgoingMessageIterator **pFaxOutgoingMessageIterator
);

Parameters

lPrefetchSize

Type: long

A long value that specifies 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] pFaxOutgoingMessageIterator

Type: IFaxOutgoingMessageIterator**

An address of a pointer that receives the IFaxOutgoingMessageIterator interface.

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 farSUBMIT_LOW or farQUERY_OUT_ARCHIVE access right. With the farSUBMIT_LOW access right, the user will be able to use this method only for his own faxes. With the farQUERY_OUT_ARCHIVE access right, he will be able to use this method for all of the faxes on the server.

Requirements

Requirement	Value
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