PrlDisk_GetUserParameter Function

Retrieves user-defined parameter values stored on a virtual disk.

Syntax

PRL_RESULT PrlDisk_GetUserParameter(
    const PRL_HANDLE Handle, 
    PRL_CONST_STR pParameterName, 
    PRL_CHAR_PTR pParameterValue, 
    PRL_UINT32_PTR BufferSize
);

File

PrlDisk.h

Parameters

Handle

A handle of type PHT_VIRTUAL_DISK identifying the virtual disk.

pParameterName

Parameter name in UTF-8 format.

pParameterValue

[out] A pointer to a buffer that receives the specified parameter value.

BufferSize

[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:

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 values are stored using the PrlDisk_SetUserParameter function. Other users cannot access this data.