3.1.4.2.10 FaxObs_GetJob (Opnum 8)

The FaxObs_GetJob (Opnum 8) method is called by the client to retrieve information regarding a specific job. The job is specified by the JobId parameter. The value for JobId 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 JobId is for a valid job. The server MUST validate that the client's fax user account has read access to the job.

On success, the server MUST return the job information of the specified queued or active job along with the size.

The client SHOULD free the returned buffer.

 error_status_t FaxObs_GetJob(
   [in] handle_t hBinding,
   [in] DWORD JobId,
   [in, out, unique, size_is(,*BufferSize)] 
     LPBYTE* Buffer,
   [in, out] LPDWORD BufferSize
 );

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 number that uniquely identifies a queued or active fax job on the server.

Buffer: A pointer to the address of the returned buffer containing a _FAX_JOB_ENTRY (section 2.2.6) structure.

BufferSize: A variable to return the size, in bytes, of the job information buffer.

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_JOB_QUERY access rights.
ERROR_NOT_ENOUGH_MEMORY 0x00000008	The fax server cannot allocate memory for the data to be returned to the client.

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