NetStatisticsGet2 or Net32StatisticsGet2

The NetStatisticsGet2 API retrieves and optionally clears operating statistics for a service.

Note: The NetStatisticsGet2 API replaces both the NetStatisticsGet API and the NetStatisticsClear API, which are now obsolete.

Restrictions

This API can be called from DLS and OS/2 workstations, but DLS workstations can issue this call only to a remote LAN Server workstation. Administrator authority is required to call this API.

#include <netcons.h>
#include <netstats.h>
 
NetStatisticsGet2(pszServername, servicename, reserved,
                  sLevel, options, buf,
                  usBuflen, pusBytesAvail);   /* 16 bit */
 
Net32StatisticsGet2(pszServername, servicename, reserved,
                  ulLevel, options, buf,
                  ulBuflen, pulBytesAvail);   /* 32 bit */

See Common Parameter Definitions for descriptions of parameters not defined here.

servicename

Only SERVER and REQUESTER are allowed for servicename. Other names produce the ERROR_NOT_SUPPORTED error code. If the server statistics are requested and the server is not running, the error code returned is NERR_ServiceNotInstalled.

reserved

(unsigned long) must be 0.

sLevel

ulLevel

stat_workstation_0

stat_server_0

The valid values for sLevel depend on the value of servicename. The current valid value for REQUESTER or SERVER is 0.

options

The options parameter is bitmapped as follows: кФФФФФФФТФФФФФТФФФФФФФФФФФФФФФТФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФП
Г BIT Г MASKГ SYMBOL Г MEANING Г
УФФФФФФФХФФФФФХФФФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г 0 Г 0x1 Г STATSOPT_CLR Г Clear statistics after retrieval. Г
УФФФФФФФХФФФФФХФФФФФФФФФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г 1-31 Г Г Г Must be 0. Г
РФФФФФФФСФФФФФСФФФФФФФФФФФФФФФСФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФй

The option to clear the statistics allows automatic Get and Clear operations, which allows an application that is compiling cumulative numbers to make sure no data slips by in the time between the Get operation and the Clear operation.

buf

stat_workstation_0

stat_server_0

The following table lists the return codes most significant to this API. (See API Return Codes for a complete list of return codes.) кФФФФФФФФФФФФФФФФФФФФФФФФФФФФФТФФФФФФФТФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФПГSYMBOLICCONSTANT ГVALUEГMEANING Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_Success Г 0 Г No errors were encountered. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г ERROR_ACCESS_DENIED Г 5 Г Administrator privilege is required. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г ERROR_NOT_ENOUGH_MEMORY Г 8 Г Sufficient memory is not available. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г ERROR_NETWORK_ACCESS_DENIED Г 65 Г Network access is denied. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г ERROR_INVALID_PARAMETER Г 87 Г At least one parameter value is not Г
Г Г Г valid. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г ERROR_INVALID_LEVEL Г 124 Г The sLevel parameter is not valid. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_NetNotStarted Г 2102 Г The redirector NETWKSTA.200 has not Г
Г Г Г been started. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_ShareMem Г 2104 Г An internal error occurred-the network Г
Г Г Г cannot access a shared memory segment. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_ServerNotStarted Г 2114 Г The Server service has not been Г
Г Г Г started. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_BufTooSmall Г 2123 Г The buffer is too small for fixed- Г
Г Г Г length data. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_OS2IoctlError Г 2134 Г An internal error occurred when Г
Г Г Г calling the workstation driver. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_WkstaNotStarted Г 2138 Г The Requester service has not been Г
Г Г Г started. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_BrowserNotStarted Г 2139 Г The requested information is not Г
Г Г Г available. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_InternalError Г 2140 Г An internal error has occurred. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_BadTransactConfig Г 2141 Г The server is not configured for Г
Г Г Г transactions. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_InvalidAPI Г 2142 Г The requested API is not supported on Г
Г Г Г the remote server. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_ServiceNotInstalled Г 2184 Г The service has not been started. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_BadServiceName Г 2185 Г The service name is not valid. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_InvalidComputer Г 2351 Г The specified computer name is not Г
Г Г Г valid. Г
РФФФФФФФФФФФФФФФФФФФФФФФФФФФФФСФФФФФФФСФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФй

Other codes could be returned from the following functions:

DosFsCtl
DosGetShrSeg
DosSemClear

This API returns a full data structure. As with other GetInfo calls, the error NERR_BuffTooSmall is returned if the supplied buffer is too small for the required data.

If the service name specified is REQUESTER, then stat_workstation_0 is returned to buf. If the service name specified is SERVER, then stat_server is returned to buf.

[Back]

[Next]