RttcpipGetDevicePtr

RttcpipGetDevicePtr gets the network device pointer associated with ASCII network device name. RttcpipGetDevicePtr is normally called in the stack configuration routine to access network device structure from network device name.

Note: eRTOS applications must call this function to obtain the device network pointer to use an RTN API function that requires the device network pointer.

Syntax

VOID * RttcpipGetDevicePtr(
    VOID *pBuffer,
    RTN_DEVICE_QUERY eVal,
);

Parameters

pBuffer

A pointer to a buffer containing a zero-terminated ASCII network adapter friendly name or adapter MAC address.

eVal

The RTN_DEVICE_QUERY type specifying the pBuffer pointer is either RTN_DEVICE_QUERY_BY_NAME, a network adapter friendly name, or RTN_DEVICE_QUERY_BY_MAC adapter MAC address.

Return Value

If this function succeeds, it returns an opaque network device pointer. If this function fails, it returns NULL.

Requirements