PrlVmCfg_GetEnvId Function

Returns the Container id of the specified virtual machine.

Syntax

PRL_RESULT PrlVmCfg_GetEnvId(
    PRL_HANDLE hVmCfg, 
    PRL_UINT32_PTR pnEnvId
);

File

PrlApiDeprecated.h

Parameters

hVmCfg

A handle of type PHT_VM_CONFIGURATION identifying the virtual machine configuration.

pnEnvId

[out] Container id

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.

Links

PHT_VM_CONFIGURATION