3.1.4.1.36 FAX_GetConfiguration (Opnum 19)

The FAX_GetConfiguration (Opnum 19) method is called by the client to query the general configuration of the fax server that is described by the _FAX_CONFIGURATIONW (section 2.2.29) structure.

In response, the server MUST validate that the client's fax user account has access to query the configuration of the fax server. It MUST then allocate memory for the configuration information to be passed out and fill it with data.

To indicate success, the server MUST return the buffer that contains the configuration information, along with the buffer size. The client SHOULD free the buffer.

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

hBinding: 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 the address of a buffer to receive a _FAX_CONFIGURATIONW (section 2.2.29) structure. The structure contains the current configuration settings for the fax server.

BufferSize: A variable 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 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 the FAX_ACCESS_QUERY_CONFIG access rights required for this operation.

ERROR_NOT_ENOUGH_MEMORY

0x00000008

The server cannot allocate sufficient memory to hold the FAX_CONFIGURATION (section 2.2.28) data structure to be returned to the client.

ERROR_INVALID_PARAMETER

0x00000057

The buffer parameter is set to a NULL pointer value.<104>

ERROR_INTERNAL_ERROR

0x0000054F

The server failed to custom marshal the FAX_CONFIGURATION to be returned to the client.

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