PrlStatIface_GetSystemName Function

Returns the network interface system name.

Syntax

PRL_RESULT PrlStatIface_GetSystemName(
    PRL_HANDLE hIfaceStat, 
    PRL_STR sSystemName, 
    PRL_UINT32_PTR pnSystemNameBufLength
);

File

PrlApiStat.h

Parameters

hIfaceStat

A handle of type of PHT_SYSTEM_STATISTICS_IFACE identifying the network interface.

sSystemName

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

pnSystemNameBufLength

[in] The size of the output buffer (in bytes). Set the buffer pointer to null and this parameter's 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.

Links

PHT_SYSTEM_STATISTICS_IFACE