3.1.4.1.54 FAX_GetReceiptsConfiguration (Opnum 34)

The FAX_GetReceiptsConfiguration (Opnum 34) method is called by the client. On success, the server MUST return the receipt configuration information of the fax server.

 error_status_t FAX_GetReceiptsConfiguration(
   [in] handle_t hFaxHandle,
   [out, size_is(, *BufferSize)] LPBYTE* Buffer,
   [out, ref] LPDWORD BufferSize
 );

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.

Buffer: A pointer to a _FAX_RECEIPTS_CONFIGW (section 2.2.48) structure.

BufferSize: A pointer to a DWORD ([MS-DTYP] section 2.2.9) in which to return the size, in bytes, of the buffer.

Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise, it MUST return one of the following error codes, one of the fax-specific errors that are defined in section 2.2.52, or one of the other standard errors ([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 the FAX_ACCESS_QUERY_CONFIG access rights required for this operation.

ERROR_NOT_ENOUGH_MEMORY

0x00000008

Not enough storage is available to process this command. The fax server cannot allocate sufficient memory to hold the _FAX_RECEIPTS_CONFIGW to be returned to the client.

ERROR_INVALID_PARAMETER

0x00000057

The parameter is incorrect. The Buffer parameter is set to a NULL pointer value.<129>

ERROR_INTERNAL_ERROR

0x0000054F

The fax server failed to custom marshal the _FAX_RECEIPTS_CONFIGW to be returned to the client.

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