PrlVm_PtmQuery Function

Query object properties .

Syntax

PRL_RESULT PrlVm_PtmQuery(
    PRL_HANDLE hVm, 
    PRL_CONST_STR szObject, 
    PRL_UINT32 * pPropertiesId, 
    PRL_UINT32 cProperties
);

File

PrlApiPtm.h

Parameters

hVm

[in] A handle of type PHT_DESKTOP_CONTROL .

szObject

[in] An object name in PTM namespace

pPropertiesId

[in] point to an array of UINT32 elements containing PropertyId's. Specified properties values will be retrieved and delivered to client within PRL_PTM_OBJECT structure by PET_PTM_EVT_PROPERTY_CHANGED event. cProperties [in] number of elements in array pointed by pPropertiesId Zero is valid argument. In this case routine queries for object existence. If object does exist, object name with no properties will be received.

Returns

PRL_RESULT . Possible values: PRL_ERR_INVALID_HANDLE - invalid handle passed PRL_ERR_INVALID_ARG - invalid argument(s) have been passed PRL_ERR_UNIMPLEMENTED - feature is not implemented for specified handle. PRL_ERR_FAILURE - failed to send command. PRL_ERR_SUCCESS - function completed successfully.

Links

PHT_VIRTUAL_MACHINE