Edit

IFaxIncomingMessageIterator::get_PrefetchSize method (faxcomex.h)

  • Article

The PrefetchSize property indicates the size of the prefetch (read-ahead) buffer.

This property is read/write.

Syntax

HRESULT get_PrefetchSize(
  long *plPrefetchSize
);

Parameters

plPrefetchSize

Return value

None

Remarks

The prefetch buffer contains messages and makes the iteration process more efficient because you iterate through the buffer rather than through a folder.

Changes you make to the size of the prefetch buffer take place immediately because FaxIncomingMessageIterator is a local object.

The value of the lPrefetchSize property determines how many fax messages the iterator object retrieves from the archive each time the object refreshes its contents. The default value is lDEFAULT_PREFETCH_SIZE.

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

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

See also

IFaxIncomingMessageIterator

PrefetchSize