3.1.4.2.19 FaxObs_EnableRoutingMethod (Opnum 17)

  • Article

The FaxObs_EnableRoutingMethod (Opnum 17) method is called by the client to enable or disable a routing method for a fax port (device).

The client MUST set the FaxPortHandle parameter to a valid fax port handle value returned by the FaxObs_OpenPort (section 3.1.4.2.5) method. In response, the server MUST validate that the client's fax user account has access to enable or disable routing methods. The client MUST set the RoutingGUID parameter to point to a valid routing method.

On success, the server MUST enable or disable a fax routing method for the specified fax port (device).

 error_status_t FaxObs_EnableRoutingMethod(
   [in] RPC_FAX_PORT_HANDLE FaxPortHandle,
   [in, string, unique] LPCWSTR RoutingGuid,
   [in] BOOL Enabled
 );

FaxPortHandle: An RPC context handle that references a fax port.

RoutingGuid: A curly braced GUID string that uniquely identifies the fax routing method on which to act. For more information about routing methods, see [MSDN-FRM]. The routing methods and their curly braced GUID string values that can be used for this parameter are discoverable by calling FaxObs_EnumRoutingMethods (section 3.1.4.2.18). Included in this list are the default routing methods described in section 2.2.87.

Enabled: A Boolean variable that indicates whether the client request is to enable (when set to TRUE) or disable (when set to FALSE) the fax routing method specified by RoutingGuid.

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 FAX_PORT_SET access rights.

ERROR_INVALID_DATA

0x0000000D

The data is invalid. This error code is returned when any of the following conditions are met:

§ The FaxPortHandle argument is not a valid handle obtained using FaxObs_OpenPort.<204>

§ The GUID specified by the RoutingGuid parameter is not a routing method GUID.

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