PrlSrvCfgNet_GetDefaultGateway Function

Returns the default gateway address for the specified network adapter.

Syntax

PRL_RESULT PrlSrvCfgNet_GetDefaultGateway(
    PRL_HANDLE hNetAdapter, 
    PRL_STR sDefaultGateway, 
    PRL_UINT32_PTR pnDefaultGatewayBufLength
);

File

PrlApiDisp.h

Parameters

hNetAdapter

A valid handle of type PHT_HW_NET_ADAPTER identifying the network adapter.

sDefaultGateway

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

pnDefaultGatewayBufLength

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

Links

PHT_HW_NET_ADAPTER