PrlVmCfg_GetCustomProperty Function

Returns the virtual machine custom property information.

Syntax

PRL_RESULT PrlVmCfg_GetCustomProperty(
    PRL_HANDLE hVmCfg, 
    PRL_STR sVmCustomProperty, 
    PRL_UINT32_PTR pnVmCustomPropertyBufLength
);

File

PrlApi.h

Parameters

hVmCfg

A handle of type PHT_VM_CONFIGURATION identifying the virtual machine configuration.

sVmCustomProperty

[out] A pointer to a buffer that receives the result (a UTF-8 encoded, null-terminated string). The custom property information is stored in CDATA format.

pnVmCustomPropertyBufLength

[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 too small. The parameter that is used to specify the size will contain the required size.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

If you have some custom data which relates to a virtual machine in some way, you can save it in the virtual machine configuration for future retrieval. This can be any data that your client application requires. The data is stored in CDATA format.