PrlFoundVmInfo_GetName Function

Extracts the virtual machine name form the container.

Syntax

PRL_RESULT PrlFoundVmInfo_GetName(
    PRL_HANDLE handle, 
    PRL_STR sName, 
    PRL_UINT32_PTR pnNameBufLength
);

File

PrlApiVm.h

Parameters

handle

A handle of type PHT_FOUND_VM_INFO identifying the container.

sName

[out] A pointer to a buffer that receives the name. Pass a null pointer to determine the required buffer size.

pnNameBufLength

[in] The size of the buffer used to receive the output data (in bytes). [out] The required buffer size if the buffer parameter contains a null pointer or if the specified buffer size is not large enough.

Returns

PRL_RESULT . Possible values are:

PRL_ERR_INVALID_ARG - invalid handle.

PRL_ERR_BUFFER_OVERRUN - the size of the output buffer is not large enough. The parameter used to specify the size will contain the required size.

PRL_ERR_SUCCESS - function completed successfully.

Links

PHT_FOUND_VM_INFO