PrlLoginResponse_GetRunningTaskByIndex Function

Obtains a handle of type PHT_RUNNING_TASK.

Syntax

PRL_RESULT PrlLoginResponse_GetRunningTaskByIndex(
    PRL_HANDLE hLoginResp, 
    PRL_UINT32 nIndex, 
    PRL_HANDLE_PTR phRunningTask
);

File

PrlApiDisp.h

Parameters

hLoginResp

A handle of type PHT_LOGIN_RESPONSE containing the login response info.

nIndex

An index of the task to obtain the handle for (starting at 0). To determine the total number of the available tasks, use the PrlLoginResponse_GetRunningTaskCount function.

phRunningTask

[out] A pointer to a variable that receives the handle of type PHT_RUNNING_TASK containing the task information.

Returns

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

If a previous session ID was passed to the corresponding login operation, the PHT_LOGIN_RESPONSE object will contain a list of the tasks that were initiated during the previous session and are still running (if any). A task ID (that can be retrieved using this function) can be passed to the PrlSrv_AttachToLostTask function to get a handle to the task, thus gaining control to it.

Links

PHT_LOGIN_RESPONSE