--- projects/libstatgrab/docs/libstatgrab/sg_get_network_iface_stats.xml 2004/05/02 09:35:15 1.4 +++ projects/libstatgrab/docs/libstatgrab/sg_get_network_iface_stats.xml 2004/05/02 17:21:35 1.5 @@ -3,82 +3,82 @@ - + - $Date: 2004/05/02 09:35:15 $ - $Id: sg_get_network_iface_stats.xml,v 1.4 2004/05/02 09:35:15 tdb Exp $ + $Date: 2004/05/02 17:21:35 $ + $Id: sg_get_network_iface_stats.xml,v 1.5 2004/05/02 17:21:35 tdb Exp $ - + - get_network_iface_stats + sg_get_network_iface_stats 3 i-scream - + - get_network_iface_stats + sg_get_network_iface_stats get network interface statistics - + #include <statgrab.h> - network_iface_stat_t *get_network_iface_stats + sg_network_iface_stats *sg_get_network_iface_stats int *entries - + Description - The get_network_iface_stats function + The sg_get_network_iface_stats function takes a pointer to an int, entries, which is filled with the number of network interfaces the machine has. This is needed to know how many - network_iface_stat_t structures have + sg_network_iface_stats structures have been returned. A pointer is returned to the first - network_iface_stat_t. + sg_network_iface_stats. - get_network_iface_stats returns statistics + sg_get_network_iface_stats returns statistics about the network interfaces in the machine. Specifically, it returns the speed of the interface, the duplex state, and whether it is currently up. - + Return Values - The get_network_iface_stats returns a + The sg_get_network_iface_stats returns a pointer to a structure of type - network_iface_stat_t. + sg_network_iface_stats. typedef enum{ - FULL_DUPLEX, - HALF_DUPLEX, - UNKNOWN_DUPLEX -}statgrab_duplex; + SG_IFACE_DUPLEX_FULL, + SG_IFACE_DUPLEX_HALF, + SG_IFACE_DUPLEX_UNKNOWN +}sg_iface_duplex; - Note: The UNKNOWN_DUPLEX value could mean - that duplex hasn't been negotiated yet. + Note: The SG_IFACE_DUPLEX_UNKNOWN + value could mean that duplex hasn't been negotiated yet. typedef struct{ char *interface_name; int speed; - statgrab_duplex dup; + sg_iface_duplex dup; int up; -}network_iface_stat_t; +}sg_network_iface_stats; @@ -109,8 +109,8 @@ typedef struct{ - The duplex state the interface is in. See statgrab_duplex - for permitted values. + The duplex state the interface is in. See sg_iface_duplex + for permitted values. @@ -139,10 +139,10 @@ typedef struct{ - + Website - +