PrlVmToolsInfo_GetVersion Function

Returns version information of the Parallels Tools package installed in a given virtual machine.

Syntax

PRL_RESULT PrlVmToolsInfo_GetVersion(
    PRL_HANDLE handle, 
    PRL_STR sName, 
    PRL_UINT32_PTR pnNameBufLength
);

File

PrlApiVm.h

Parameters

handle

A handle of type PHT_VM_TOOLS_INFO.

sName

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

pnNameBufLength

[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_NO_DATA - the Parallels Tools package version information is not available.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

Before calling this function, make sure that the Parallels Tools package is installed in the virtual machine by calling the PrlVmToolsInfo_GetState function.

Links

PHT_VM_TOOLS_INFO