@CHIP-RTOS C Library - TCP/IP API

Dev_Get_Handle_By_Name

Lookup a TCP/IP device driver by name. Obtain a handle to that device if found.

int Dev_Get_Handle_By_Name( const char * drivername,
                            DevUserIfaceHandle far * DevHandlePtr,
                            int *error);

Parameters

DevHandlePtr

Output parameter:   On success, the device's handle is put here.

drivername

Driver name e.g. "Lance0" (type RTOS command IPCFG)

error

Output parameter:  Failure code, 0 on success.

Return Value

0: success, DevHandlePtr contains the device handle pointer
-1: failed

Comments

The device handle is required as a parameter to some API functions e.g. Dev_Config_Iface().

The drivername match is done in a case sensitive manner.

RTOS API

This library function invokes a RTOS software interrupt. Refer to this RTOS API function's documentation for more details.

On SC1x3/SC2x (RTOS version >=1.13, CLIB version >=2.10) there's also a version of this function which uses dynamic linking instead of a software interrupt, which reduces the function's overhead and thus speeds up your application. This function's name is Dev_Get_Handle_By_Name_Dyn. You should however not use this function directly. Instead you should add the define TCPIP_DYN_LINK_DEV to your program before including the CLIB's header file(s):

#define TCPIP_DYN_LINK_DEV
#include <clib.h>

This will map the original function's name to the dynamic linking version. This way you can also easily switch existing programs to dynamic linking.

Related Topics

TCP/IP Device Driver overview

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.20	V1.20	V1.20	V1.05	V1.00

Supported by @CHIP-RTOS C Library since version

CLIB
V2.04