PrlVmDevHdPart_GetSysName Function

Returns the system name of the specified disk partition.

Syntax

PRL_RESULT PrlVmDevHdPart_GetSysName(
    PRL_HANDLE hPartition, 
    PRL_STR sSysName, 
    PRL_UINT32_PTR pnSysNameBufLength
);

File

PrlApiVm.h

Parameters

hPartition

A handle of type PHT_VIRTUAL_DEV_HD_PARTITION identifying the disk partition.

sSysName

[out] A pointer to a buffer that receives the name (a UTF-8 encoded, null-terminated string).

pnSysNameBufLength

[in] The size of the output buffer (in bytes). Set the buffer pointer to null and this 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 not large enough. The parameter that is used to specify the size will contain the required size.

PRL_ERR_SUCCESS - function completed successfully.