IFaxAccountIncomingArchive::GetMessage method (faxcomex.h)

Returns a fax message from the archive of inbound faxes, for a particular fax account, by using the fax message ID.

Syntax

HRESULT GetMessage(
  [in] BSTR                bstrMessageId,
       IFaxIncomingMessage **pFaxIncomingMessage
);

Parameters

[in] bstrMessageId

Type: BSTR

Specifies a null-terminated string that contains the message ID of the fax to retrieve from the archive of inbound faxes.

pFaxIncomingMessage

Type: IFaxIncomingMessage**

An IFaxIncomingMessage 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 far2QUERY_ARCHIVES access right.

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 searches 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

IFaxAccountIncomingArchive