Previous

Next

Function xn_rt_add

Add a route to the routing table.

int xn_rt_add(const BYTE * dest, 
              const BYTE * mask, 
              const BYTE * gw, 
              DWORD        metric, 
              int          iface_no, 
              int          ttl);

Parameters

dest

Destination IP address (RT_DEFAULT for default gateway).

mask

Destination network mask.

gw

Gateway address if gateway or NULL if not a gateway.

metric

Distance metric (RT_USEIFACEMETRIC to use the metric defined for the interface).

iface_no

Interface number (returned by xn_interface_open, xn_interface_open_config or xn_attach).

ttl

Time to live in seconds (RT_INF is forever).

return value

Returns 0 if successful, otherwise SOCKET_ERROR. If an error occurred, call xn_getlasterror and xn_geterror_string to return the error value. Section Error Codes further describes each error.

Possible values for this function are:

This function installs a route to the routing table.

A destination address of RT_DEFAULT (all 0s), adds a default gateway entry. A metric greater than 0 specifies a gateway entry. The parameter mask is used to compare dest with the destination address when searching the routing table for an interface and IP address to use when sending a packet to a destination address. If the mask is 255.255.255.255, the entry is a network entry; otherwise, it is a host entry. An address needs to match a network entry exactly, whereas it needs to match a host entry after being anded with the mask.

xn_set_ip also adds an entry to the routing table (xn_rarp, xn_bootp, xn_bootp_res and possibly xn_lcp_open will call xn_set_ip).

Extended RTIP-32 API

Function xn_rarp

Function xn_rt_cycle_gw