3.1.4.2.14 FaxObs_Abort (Opnum 12)

  • Article

The FaxObs_Abort (Opnum 12) method is called by the client to abort the specified fax job on the server. The value for the JobId parameter can be obtained by calling the FaxObs_EnumJobs (section 3.1.4.2.9) or FaxObs_SendDocument (section 3.1.4.2.7) method.

In response, the server MUST validate that the job identifier specified by JobId is for a valid job. The server MUST validate that the client's fax user account has write access to the job. On success, the server MUST terminate the specified fax job that is queued or in progress.

 error_status_t FaxObs_Abort(
   [in] handle_t hBinding,
   [in] DWORD JobId
 );

hBinding: The RPC binding handle for this call. The client SHOULD reuse the RPC binding handle used as an input hBinding argument for the FaxObs_ConnectionRefCount (section 3.1.4.2.2) method call used to connect to the fax server.

JobId: A DWORD ([MS-DTYP] section 2.2.9) containing a unique number that identifies the fax job to terminate.

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. This error code is returned under any of the following conditions:

§ The client's fax user account does not have the FAX_ JOB_MANAGE access rights.

§ The client's fax user account is not the owner of the fax job identified by the JobId parameter.

ERROR_INVALID_PARAMETER

0x00000057

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

§ The fax job identified by the specified JobId cannot be found by the fax server.

§ The specified job has already been canceled or is in the process of being canceled.

§ The specified JobId represents the job for an outgoing broadcast message; aborting outgoing broadcast messages is not supported.

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