3.1.4.1.81 FAX_SetGlobalRoutingInfo (Opnum 18)

The fax client application calls the FAX_SetGlobalRoutingInfo (Opnum 18) method to set global routing properties such as the routing method priority.

In response, the server MUST validate that the client's fax user account has access to set the global routing information on the server. On success, the server MUST modify its fax routing method data, such as routing priority, that applies globally.

 error_status_t FAX_SetGlobalRoutingInfo(
   [in] handle_t hBinding,
   [in] const FAX_GLOBAL_ROUTING_INFOW* RoutingInfo
 );

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.

RoutingInfo: A pointer to a buffer that contains a FAX_GLOBAL_ROUTING_INFOW (section 2.2.32) structure.

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 required FAX_ACCESS_MANAGE_CONFIG authorization for this operation.

ERROR_INVALID_DATA

0x0000000D

The fax server cannot find the routing method specified by the Guid structure field of the RoutingInfo parameter.

ERROR_INVALID_PARAMETER

0x00000057

The parameter is incorrect. This error code is returned if any of the following conditions are met:

§ The RoutingInfo parameter is set to a NULL pointer value.

§ The SizeOfStruct structure field of RoutingInfo is not set to the correct size, in bytes, for the FAX_GLOBAL_ROUTING_INFOW structure.

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