PrlVmDevNet_GetMacAddressCanonical Function

Returns the MAC address of a virtual network adapter inside a virtual machine (in human-friendly format xx:xx:xx:xx:xx:xx).

Syntax

PRL_RESULT PrlVmDevNet_GetMacAddressCanonical(
    PRL_HANDLE hVmDev, 
    PRL_STR sMacAddress, 
    PRL_UINT32_PTR pnMacAddressBufLength
);

File

PrlApiVm.h

Parameters

hVmDev

A handle of type PHT_VIRTUAL_DEV_NET_ADAPTER identifying the virtual network adapter.

sMacAddress

[out] Pointer to a buffer that receives the MAC address (a UTF-8 encoded, null-terminated string).

pnMacAddressBufLength

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