PrlJob_GetOpCode Function

Returns the job operation code.

Syntax

PRL_RESULT PrlJob_GetOpCode(
    PRL_HANDLE hJob, 
    PRL_JOB_OPERATION_CODE_PTR pnOpCode
);

File

PrlApi.h

Parameters

handle

A handle of type PHT_JOB identifying the job.

phError

[out] A pointer to a variable that receives the result.

Returns

PRL_RESULT . Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

A job operation code can be used to identify the function that started the corresponding operation and to determine the type of the result the job object contains. Use this function in an event handler (callback function) when examining a received job object. For example, the operation code PJOC_SRV_LOGIN means that this job belongs to login operation ( PrlSrv_Login , PrlSrv_LoginLocal ); the PJOC_SRV_GET_VM_LIST code means that the job was started by the PrlSrv_GetVmList function call and contains a list of virtual machines, etc.

Links

PrlApi.h , PHT_JOB