3.1.4.1.55 FAX_GetReceiptsOptions (Opnum 36)

  • Article

The FAX_GetReceiptsOptions (Opnum 36) method is called by the client to retrieve the supported receipt options on the server.

The server MUST validate that the client's fax user account has the access to retrieve the receipt options. On success, the server MUST return the receipt options that are supported by the server.

 error_status_t FAX_GetReceiptsOptions(
   [in] handle_t hFaxHandle,
   [out, ref] LPDWORD lpdwReceiptsOptions
 );

hFaxHandle: The RPC binding handle for this call. The client SHOULD reuse the RPC binding handle used as an input hBinding argument for the FAX_ConnectFaxServer (section 3.1.4.1.10) or FAX_ConnectionRefCount (section 3.1.4.1.11) method call used to connect to the fax server.

lpdwReceiptsOptions: A pointer to the DWORD ([MS-DTYP] section 2.2.9) that receives the options.

Value/code

Meaning

DRT_EMAIL

1

Allow sending the receipt by email. The email address is the email address of the sender.

DRT_MSGBOX

4

Allow notification on the transmission result by sending a text message containing a character string to the sender's computer as described in Messenger Service Remote Protocol Specification [MS-MSRP] section 3.2.4.1.<130>

Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise, it MUST return the following error code, one of the fax-specific errors that are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF] section 2.2.

Return value/code

Description

ERROR_ACCESS_DENIED

0x00000005

Access is denied. The client's fax user account does not have any of the permissions covered by ALL_FAX_USER_ACCESS_RIGHTS (section 2.2.83).

Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying RPC protocol [MS-RPCE].