User`s guide

KwikNet Low Level Services

DAK

159

kn_ifinfo kn_ifinfo

Purpose Fetch Information About a Network Interface

Used by

n Task o ISP o Timer Procedure o Restart Procedure n Exit Procedure

Setup Prototype is in file KN_API.H.

#include "KN_LIB.H"

int kn_ifinfo(KN_NETDP netdp, struct knx_ifinfo *infop);

Description Netdp is a network descriptor pointer, the KwikNet handle used to identify

the network interface of interest.

Infop is a pointer to a structure into which a summary of the network's

current operating characteristics will be stored. Structure knx_ifinfo

is defined in file KN_API.H as follows:

struct knx_ifinfo {

char xif_tag[KN_TAGSIZE]; /* Network tag string */

int xif_num; /* Interface number */

int xif_type; /* Interface type */

int xif_state; /* Interface state */

/* (see KN_NIFS_xxxx flags) */

#if (integers are less than 32 bits)

int xif_rsv1; /* Reserved for alignment */

#endif

unsigned long xif_duration; /* Time in current state */

/* (measured in seconds) */

struct in_addr xif_ipaddr; /* IPv4 address */

struct in_addr xif_snmask; /* Subnet mask */

};

Returns If successful, a value of 0 is returned.

On failure, one of the following error status codes is returned:

KN_ERPARAM Parameter netdp does not refer to a valid network or

parameter

infop is NULL.

On failure, the storage at *infop is unaltered.