PRL_DISK_CALLBACK Type

Define type of user's callback function

PRL_DISK_CALLBACK is a function prototype for implementing callback functions for use in PHT_VIRTUAL_DISK calls.

Syntax

typedef PRL_BOOL (PRL_CALL *PRL_DISK_CALLBACK)(PRL_INT32 iComplete, PRL_INT32 iTotal, PRL_VOID_PTR pParam);

File

PrlDisk.h

Parameters

iComplete

An integer value indicating the state of the disk operation completion. Values range from 0 to the value contained in the iTotal parameter. A value greater than 0 and less than iTotal indicates that the operation is still in progress and can be used to determine the state (percentage) of completion. A value greater than iTotal indicates that the operation completed successfully. A negative value indicates an error.

iTotal

An integer value indicating the upper bound of the disk operation completion range.

pParam

A pointer to a buffer containing user-defined data.

Remarks

A pointer to a callback function can be passed to another function that accepts it as a parameter. The operation initiated by that function will be performed in the background thread, which will call the callback function (possibly more than once) passing to it intermediate results or the final result of the operation.

Links

Callback Prototypes