3.1.4.2.25 FaxObs_SetConfiguration (Opnum 23)

The client calls the FaxObs_SetConfiguration (Opnum 23) method to change the fax server configuration.

In response, the server MUST validate that the client's fax user account has access to change the fax server configuration. On success, the server MUST set the specified configuration parameters.

 error_status_t FaxObs_SetConfiguration(
   [in] handle_t hBinding,
   [in] const FAX_CONFIGURATIONW* FaxConfig
 );

hBinding: The RPC binding handle for this call. The client SHOULD reuse the RPC binding handle used as an input hBinding argument for the FaxObs_ConnectionRefCount (section 3.1.4.2.2) method call used to connect to the fax server.

FaxConfig: A pointer to a FAX_CONFIGURATIONW (section 2.2.28) structure. If the Branding structure member is TRUE, the fax server SHOULD generate a brand that contains transmission-related information, such as the transmitting subscriber identifier, date, time, and page count. If the UseDeviceTsid structure member is TRUE, the server SHOULD use the device's transmitting subscriber identifier. If the ServerCp structure member is TRUE, the client SHOULD use a common cover page stored on the fax server; if this member is FALSE, the client SHOULD use a personal cover page template. If the PauseServerQueue structure member is TRUE, the server SHOULD pause the outgoing fax queue. If the ArchiveOutgoingFaxes structure member is TRUE, the server SHOULD archive transmissions in the directory specified by the ArchiveDirectory member. The fax server SHOULD ignore the ArchiveDirectory structure member if the ArchiveOutgoingFaxes member is FALSE. The fax server SHOULD retain the discount time period submitted by the client with the StartCheapTime and StopCheapTime structure members. <209>

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_CONFIG_SET access rights.
ERROR_INVALID_DATA 0x0000000D	The fax server failed to add (apply) the new MAPI profile specified by the Reserved member of the FaxConfig structure.
ERROR_INVALID_PARAMETER 0x00000057	The parameter is incorrect. This error code is returned under any of the following conditions: § The pointer specified with the FaxConfig argument is NULL. § The dwSizeOfStruct member of the FAX_CONFIGURATIONW specified by the FaxConfig parameter is set to an incorrect value. § The ArchiveOutgoingFaxes member of the FaxConfig structure is set to TRUE and the ArchiveDirectory member of this same structure is set to a NULL pointer value.

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