NetServiceGetInfo or Net32ServiceGetInfo

The NetServiceGetInfo API retrieves information about a particular network service that is started.

Restrictions

This API can be called from DLS and OS/2 workstations. This API does not have any access authority requirements.

#include <netcons.h>
#include <service.h>
 
NetServiceGetInfo(pszServername, service,
                  sLevel, buf, usBuflen,
                  pusBytesAvail);        /* 16 bit*/
 
Net32ServiceGetInfo(pszServername, service,
                  ulLevel, buf, ulBuflen,
                  pulBytesAvail);        /* 32 bit*/

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

service

(const unsigned char LSFAR *) points to an ASCIIZ string containing the name of the network service for which information is being requested.

sLevel

ulLevel

Service Information Data Structures

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_BAD_NETPATH Г 53 Г The network path cannot be found. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г ERROR_INVALID_LEVEL Г 124 Г The sLevel parameter is not valid. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г ERROR_MORE_DATA Г 234 Г Additional data is available, but the Г
Г Г Г buffer is too small. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_NetNotStarted Г 2102 Г The redirector NETWKSTA.200 has not Г
Г Г Г been started. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_BufTooSmall Г 2123 Г The buffer is too small for fixed- Г
Г Г Г length data. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_WkstaNotStarted Г 2138 Г The Requester service has not been Г
Г Г Г started. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г 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_ServiceTableLocked Г 2180 Г The service does not respond to Г
Г Г Г control actions. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_ServiceNotInstalled Г 2184 Г The service has not been started. Г
УФФФФФФФФФФФФФФФФФФФФФФФФФФФФФХФФФФФФФХФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФД
Г NERR_InvalidComputer Г 2351 Г The specified computer name is not Г
Г Г Г valid. Г
РФФФФФФФФФФФФФФФФФФФФФФФФФФФФФСФФФФФФФСФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФФй

Other codes could be returned from the following functions:

DosFsCtl
DosGetShrSeg

If you call this API with the buffer length parameter equal to zero, the API returns a value for total bytes available. This technique is useful if you do not know the exact buffer size required.

The NetServiceGetInfo API returns the NERR_Success code for services that are not started (SERVICE_UNINSTALLED). If a service is stopped, an application can examine the available data of a server using the NetServiceControl API.

The NetServiceGetInfo API is similar to the NetServiceControl API passed with the INTERROGATE opcode. The NetServiceGetInfo API, however, does not interrogate the service; it only retrieves the status that the service last posted.

For information about controlling the operations of a network service, see Services - NetServiceControl.

[Back]

[Next]