PrlVmCfg_SetCustomProperty Function

Sets the virtual machine custom property information.

Syntax

PRL_RESULT PrlVmCfg_SetCustomProperty(
    PRL_HANDLE hVmCfg, 
    PRL_CONST_STR sNewVmCustomProperty
);

File

PrlApiVm.h

Parameters

hVmCfg

A handle of type PHT_VM_CONFIGURATION identifying the virtual machine configuration.

sNewVmCustomProperty

A pointer to a buffer containing the custom information. The data must be in CDATA format.

Returns

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

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.

Links

PHT_VM_CONFIGURATION