3.1.4.1.27 FAX_EnumOutboundRules (Opnum 59)

The FAX_EnumOutboundRules (Opnum 59) method is called by the client to enumerate all the outbound routing rules that are present on the specified fax server.

In response, the server MUST validate whether the client's fax user account has access to enumerate the outbound routing rules.

On success, the server MUST use the lpData parameter to return information about all its outbound routing rules. It MUST also return the size of the returned information and the number of outbound routing rules for which it successfully enumerated information.

The client SHOULD free lpData.

 error_status_t FAX_EnumOutboundRules(
   [in] handle_t hFaxHandle,
   [out, size_is(, *lpdwDataSize)] 
     LPBYTE* ppData,
   [out, ref] LPDWORD lpdwDataSize,
   [out, ref] LPDWORD lpdwNumRules
 );

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.

ppData: A pointer to a buffer containing an array of _RPC_FAX_OUTBOUND_ROUTING_RULEW (section 2.2.42) structures.

lpdwDataSize: A pointer to a DWORD ([MS-DTYP] section 2.2.9) in which to return the size, in bytes, of the lpData buffer.

lpdwNumRules: A pointer to a DWORD value indicating the number of rules retrieved.

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 access rights (FAX_ACCESS_QUERY_CONFIG) required for this operation.
ERROR_INVALID_PARAMETER 0x00000057	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 3.1.4.1.10) does not support this error code.
FAX_ERR_NOT_SUPPORTED_ON_THIS_SKU 0x00001B63	The fax client module's API version (described in section 3.1.4.1.10) 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.<94>

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