FAX_SetReceiptsConfiguration (Opnum 35)

The FAX_SetReceiptsConfiguration (Opnum 35) method is called by the client. On success, the server MUST set the receipt configuration information that is used by the fax server to send delivery receipts for fax transmissions.<169>

 error_status_t FAX_SetReceiptsConfiguration(
   [in] handle_t hFaxHandle,
   [in, ref] const PFAX_RECEIPTS_CONFIGW pReceipts

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 or FAX_ConnectionRefCount (section method call used to connect to the fax server.

pReceipts: A pointer to a FAX_RECEIPTS_CONFIGW (section 2.2.47) object.

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




Access is denied. The client's fax user account does not have the required FAX_ACCESS_MANAGE_CONFIG authorization for this operation.



The dwAllowedReceipts member of the pReceipts parameter contains the DRT_MSGBOX flag value (described in FAX_ENUM_DELIVERY_REPORT_TYPES), and the fax server does not support this type of fax receipts.<170>



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

§ The dwSizeOfStruct member of pReceipts is not equal to the correct size, in bytes, for the FAX_RECEIPTS_CONFIGW.

§ The dwAllowedReceipts member of pReceipts contains one or more invalid flag values (not defined for the FAX_ENUM_DELIVERY_REPORT_TYPES (section 2.2.76) enumeration).

§ The following member values are set in the submitted pReceipts: the DRT_EMAIL flag is set within the dwAllowedReceipts member, the bIsToUseForMSRouteThroughEmailMethod member is set to FALSE, and the lpwstrSMTPPasswordmember is set to a non-NULL pointer value.

§ In the submitted pReceipts, the DRT_EMAIL flag is set within the dwAllowedReceipts member or the bIsToUseForMSRouteThroughEmailMethod member is set to TRUE and the SMTPAuthOption member is set to a value lower than FAX_SMTP_AUTH_ANONYMOUS or greater than FAX_SMTP_AUTH_NTLM.

§ The fax server tried to return FAX_ERR_NOT_SUPPORTED_ON_THIS_SKU but the client fax API version (FAX_API_VERSION_0, described in section does not support this error code.



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.



The fax client module API version (described in section is FAX_API_VERSION_1 or above, and the fax server is running on a version of the operating system that does not support the requested operation.<171>

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