PrlVmDevNet_GetVirtualNetworkId Function

Obtains the virtual network ID assigned to a virtual network adapter in a virtual machine.

Syntax

PRL_RESULT PrlVmDevNet_GetVirtualNetworkId(
    PRL_HANDLE hVmDev, 
    PRL_STR sVirtualNetworkId, 
    PRL_UINT32_PTR pnVirtualNetworkIdBufLength
);

File

PrlApiVm.h

Parameters

hVmDev

A handle of type PHT_VIRTUAL_DEV_NET_ADAPTER identifying the virtual network adapter.

sVirtualNetworkId

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

pnVirtNetIdBufLength

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