IFaxOutgoingArchive::GetMessage method (faxcomex.h)

Article
02/22/2024

The IFaxOutgoingArchive::GetMessage method returns a fax message from the archive of outbound faxes by using the fax message ID.

Syntax

HRESULT GetMessage(
                BSTR                bstrMessageId,
  [out, retval] IFaxOutgoingMessage **pFaxOutgoingMessage
);

Parameters

bstrMessageId

Type: BSTR

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

[out, retval] pFaxOutgoingMessage

Type: IFaxOutgoingMessage**

Address of a pointer that receives a IFaxOutgoingMessage 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