IPC@CHIP® RTOS-PPC – API Documentation

Header image

Main page


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

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

The drivername match is done in a case sensitive manner.

The internal device driver names are:
     "FEC" : Ethernet device
     "PPPCLI" : PPP client
     "PPPSRV" : PPP server

Users may add further devices with the Dev_Open_Interface() API.

Parameters:
[in] drivername - Drivers assigned ASCII name (zero terminated string).
[out] DevHandlePtr - Handle will be put here by this API.
[out] error -1 on failure, 0 on success.
Returns:
-1: Device not found
0: Success , Location in user memory referenced by DevHandlePtr contains the device's handle.
Since:
SC2x3 V1.00 - CLIB V1.00
Note:
The device handle is required as a parameter to some API functions e.g. SetDefaultGateway().
A list of all installed device drivers is retrievable with the Dev_Get_IfaceEntries() API.
Deprecated:
This legacy function can be replaced by Dev_Find_Iface_By_Name() and is only left for backward compatibility.





Top of page | Main page

Copyright © 2017 Beck IPC GmbH
Generated on Thu Jan 26 16:21:39 2017 by Doxygen 1.6.1