clear a counter

C Specification

NLBoolean nlClear(NLenum name)



[in]Specifies the name of the counter that is to be cleared.


nlClear clears the HawkNL counter specified by name. It can be one of the following:

NL_PACKETS_SENT : The total packets sent on all sockets.

NL_BYTES_SENT : The total bytes sent on all sockets.

NL_AVE_BYTES_SENT : The average bytes sent per second for the last 8 seconds on all sockets.

NL_HIGH_BYTES_SENT : The highest bytes per second ever sent on all sockets.

NL_PACKETS_RECEIVED : The total packets received on all sockets.

NL_BYTES_RECEIVED : The total bytes received on all sockets.

NL_AVE_BYTES_RECEIVED : The average bytes received per second for the last 8 seconds on all sockets.

NL_HIGH_BYTES_RECEIVED : The highest bytes per second ever received on all sockets.

NL_ALL_STATS : Clears all the above.

Return values

NL_TRUE if no error occurs, otherwise NL_FALSE, and the specific error code can be retrieved by calling nlGetError

Error codes

NL_INVALID_ENUM : The name is not valid.

See also


Back to the HawkNL index page

Go directly to the main HawkNL page at Hawk Software

© 2000-2002 Phil Frisbie.

Valid XHTML 1.0!