PrlVm_TisGetRecord Function

Obtains a handle of type PHT_TIS_RECORD containing a record from the Tools Information Service database.

Syntax

PRL_RESULT PrlVm_TisGetRecord(
    PRL_HANDLE hVm, 
    PRL_CONST_STR sUid, 
    PRL_HANDLE_PTR phRecord
);

hVm

A handle of type PHT_VIRTUAL_MACHINE identifying the virtual machine.

sUid

TIS database record identifier. The list of identifiers can be retrieved from the TIS database with PrlVm_TisGetIdentifiers .

phRecord

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

PRL_RESULT . Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_OUT_OF_MEMORY - not enough memory to create PHT_TIS_RECORD object.

PRL_ERR_TIS_INVALID_UID - specified record not found.

PRL_ERR_SUCCESS - function completed successfully.