3.1.4.1.87 FAX_SetOutboxConfiguration (Opnum 39)

  • Article

The fax client application calls the FAX_SetOutboxConfiguration (Opnum 39) method to set the current Outbox configuration such as the Discount Time.

In response, the server MUST validate whether the client's fax user account has access to set an outbound routing configuration. On success, the server MUST modify its outbound routing configuration as specified by the client.

 error_status_t FAX_SetOutboxConfiguration(
   [in] handle_t hFaxHandle,
   [in, ref] const PFAX_OUTBOX_CONFIG pOutboxCfg
 );

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.

pOutboxCfg: A pointer to an FAX_OUTBOX_CONFIG (section 2.2.16) object containing configuration information.

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_PARAMETER

0x00000057

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

§ The dwSizeOfStruct member of the structure pointed at by the pOutboxCfg parameter is not the correct size for the FAX_OUTBOX_CONFIG.

§ The dtDiscountStart or dtDiscountEnd members of the structure pointed to by pOutboxCfg contain one or more invalid Hour (value greater than 24) or Minute (value greater than 60) fields.

ERROR_REGISTRY_CORRUPT

0x000003F7

The registry is corrupted. The structure of one of the files containing registry data is corrupted, or the system's memory image of the file is corrupted, or the file could not be recovered because the alternate copy or log was absent or corrupted.

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