IPC@CHIP® RTOS-PPC – API Documentation

Header image

Main page


int AddDefaultGatewayEx ( IP_INTERFACE  which_interface,
const unsigned long *  Gateway,
void *  userIfaceHandle,
int *  error 
)

This function is used to add the system default gateway for all interfaces (Extended).

Parameters:
[in] which_interface Specifies the device entry of the gateway.
[in] Gateway Pointer to gateway IP address in network byte order.
[in] userIfaceHandle If which_interface==3 Device handle to specify the interface (retrievable by Dev_Find_Iface_By_Name()).
[out] error Error code on failure, 0 on success.
Returns:
-1: Error, see reported error code
0: Success
Since:
SC2x3 V1.00 - CLIB V1.00
Note:
If this function is used, the Gateway entry in the CHIP.INI becomes invalidated, but unchanged.
GetDefaultGateway() returns the current gateway IP address.
If the PPP server or PPP client is specified by the which_interface parameter, then the gateway is set to the remote peer IP address.
Deprecated:
This legacy function can be replaced by SetDefaultGateway() and is only left for backward compatibility.
See also:
RemoveDefaultGateway()





Top of page | Main page

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