PrlDisk_GetUserParameter Function

Get user parameter for 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] Pointer to parameter value buffer.

BufferSize

[in] [out] Pointer to parameter value buffer size, if specified size is lower than needed, here will be returned corrected size.

Returns

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid argument values.

PRL_ERR_SUCCESS - function completed successfully.

Links

PrlDisk.h, PHT_VIRTUAL_DISK