PrlJob_GetDataPtr Function

The PrlJob_GetDataPtr function is used to obtain a pointer to a buffer containing the results of an asynchronous operation.

Syntax

PRL_RESULT PrlJob_GetDataPtr(
    PRL_HANDLE hJob, 
    PRL_VOID_PTR data_ptr, 
    PRL_UINT32_PTR data_size
);

File

PrlApiCore.h

Parameters

data_ptr

[out] A pointer to a buffer that receives the data. Pass a null pointer to determine the required buffer size.

data_size

[in] The size of the output buffer (in bytes). Set the buffer pointer to null and this parameter's value to zero to receive the required size. [out] The required output buffer size.

handle

A handle of type PHT_JOB identifying the job.

Returns

PRL_RESULT. Possible values are:

PRL_ERR_INVALID_ARG - invalid handle.

PRL_ERR_BUFFER_OVERRUN - the size of the output buffer is not large enough. The parameter used to specify the size will contain the required size.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

Different operations may or may not provide a data buffer as a result of their execution. This function should be used only when an operation results in a buffer populated with the data specific to that operation.

Links

PHT_JOB