PrlRunningTask_GetTaskUuid Function

Returns the task UUID (universally unique ID).

Syntax

PRL_RESULT PrlRunningTask_GetTaskUuid(
    PRL_HANDLE hRunningTask, 
    PRL_STR sTaskUuid, 
    PRL_UINT32_PTR pnTaskUuidBufLength
);

File

PrlApiDisp.h

Parameters

hRunningTask

A handle of type PHT_RUNNING_TASK identifying the task.

sTaskUuid

[out] A pointer to a buffer that receives the task UUID (a UTF-8 encoded, null-terminated string).

pnTaskUuidBufLength

[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.

Returns

PRL_RESULT . Possible values are:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

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

PRL_ERR_SUCCESS - function completed successfully.

Links

PHT_RUNNING_TASK