3.1.4.1.49 FAX_GetPersonalCoverPagesOption (Opnum 40)

  • Article

The FAX_GetPersonalCoverPagesOption (Opnum 40) method is called by the client to retrieve information about the supported personal cover-page options.

In response, the server MUST return the personal cover-page option that is supported by the server.

 error_status_t FAX_GetPersonalCoverPagesOption(
   [in] handle_t hFaxHandle,
   [out, ref] LPBOOL lpbPersonalCPAllowed
 );

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.

lpbPersonalCPAllowed: A pointer to a BOOL that receives the personal cover-pages option. If TRUE, the server allows sending personal cover pages. Otherwise, the server does not allow personal cover pages.

Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise, it MUST return the following error code, 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 any of the permissions covered by ALL_FAX_USER_ACCESS_RIGHTS (section 2.2.83).<121>

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