3.1.4.1.56 FAX_GetRecipientsLimit (Opnum 84)

The FAX_GetRecipientsLimit (Opnum 84) method is called by the client to retrieve information about the recipient limit of a single broadcast job.

The server MUST validate that the client's fax user account has access to retrieve the recipient limit. On success, the server MUST return the maximum number of recipients to which a fax can be sent.

Protocol version FAX_API_VERSION_0 (0x00000000) and FAX_API_VERSION_1 (0x00010000) fax servers SHOULD NOT implement this call. The fax client MUST NOT call this method if the protocol version reported by the server is FAX_API_VERSION_0 (0x00000000) or FAX_API_VERSION_1 (0x00010000). For more information, see FAX_ConnectFaxServer (section 3.1.4.1.10).

 error_status_t FAX_GetRecipientsLimit(
   [in] handle_t hbinding,
   [out, ref] LPDWORD lpdwRecipientsLimit
 );

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

lpdwRecipientsLimit: A pointer to a DWORD ([MS-DTYP] section 2.2.9) value. This is set to the maximum number of recipients to which a fax can be sent.

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 following access rights: FAX_ACCESS_SUBMIT, FAX_ACCESS_SUBMIT_NORMAL, or FAX_ACCESS_SUBMIT_HIGH.

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