PrlDisk_SetUserParameter Function

Stores user-defined parameter values on a virtual disk.

Syntax

PRL_RESULT PrlDisk_SetUserParameter(
    const PRL_HANDLE Handle, 
    PRL_CONST_STR pParameterName, 
    PRL_CONST_STR pParameterValue
);

File

PrlDisk.h

Parameters

Handle

A handle of type PHT_VIRTUAL_DISK identifying the virtual disk.

pParameterName

Parameter name in UTF-8 format.

pParameterValue

Parameter value.

Returns

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid argument values.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

A user can store arbitrary data on the disk in the parameter/value form. Both the parameter name and the value are user-defined and don't have any specific requirements. The parameters and their values can be retrieved by the user using the PrlDisk_GetUserParameter function. Other users cannot access this data.