PrlVmToolsInfo_GetState Function

Returns the Parallels Tools package state information.

Syntax

PRL_RESULT PrlVmToolsInfo_GetState(
    PRL_HANDLE handle, 
    PRL_VM_TOOLS_STATE_PTR pVmToolsState
);

PrlApiVm.h

handle

A handle of type PHT_VM_TOOLS_INFO.

pVmToolsState

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

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_NO_DATA - the Parallels Tools package state information is not available.

PRL_ERR_SUCCESS - function completed successfully.