PrlDispNet_GetName Function

Returns the name of the specified virtual network adapter.

Syntax

PRL_RESULT PrlDispNet_GetName(
    PRL_HANDLE hDispNet, 
    PRL_STR sDispNetName, 
    PRL_UINT32_PTR pnDispNetNameBufLength
);

File

PrlApiDeprecated.h

Parameters

hDispNet

A handle of type PHT_DISP_NET_ADAPTER identifying the network adapter.

sDispNetName

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

pnDispNetNameBufLength

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