EnumServicesStatus

The EnumServicesStatus function enumerates services in the specified service control manager database. The name and status of each service are provided.

BOOL EnumServicesStatus(
  SC_HANDLE hSCManager, // handle to service control manager database
  DWORD dwServiceType,     // type of services to enumerate
  DWORD dwServiceState,    // state of services to enumerate
  LPENUM_SERVICE_STATUS lpServices,
                           // pointer to service status buffer
  DWORD cbBufSize,         // size of service status buffer
  LPDWORD pcbBytesNeeded,  // pointer to variable for bytes needed
  LPDWORD lpServicesReturned,
                           // pointer to variable for number returned
  LPDWORD lpResumeHandle   // pointer to variable for next entry
);
 

Parameters

hSCManager

Handle to the service control manager database. The OpenSCManager function returns this handle, which must have SC_MANAGER_ENUMERATE_SERVICE access.

dwServiceType

Specifies the type of services to enumerate. It must be one or both of the following values:

Value	Meaning
SERVICE_WIN32	Enumerates services of type SERVICE_WIN32_OWN_PROCESS and SERVICE_WIN32_SHARE_PROCESS.
SERVICE_DRIVER	Enumerates services of type SERVICE_KERNEL_DRIVER and SERVICE_FILE_SYSTEM_DRIVER.

dwServiceState

Specifies the services to enumerate based on their running state. It must be one or both of the following values:

Value	Meaning
SERVICE_ACTIVE	Enumerates services that are in the following states: SERVICE_START_PENDING, SERVICE_STOP_PENDING, SERVICE_RUNNING, SERVICE_CONTINUE_PENDING, SERVICE_PAUSE_PENDING, and SERVICE_PAUSED.
SERVICE_INACTIVE	Enumerates services that are in the SERVICE_STOPPED state.
SERVICE_STATE_ALL	Combines the following states: SERVICE_ACTIVE and SERVICE_INACTIVE.

lpServices

Pointer to an array of ENUM_SERVICE_STATUS structures in which the name and service status information for each service in the database is returned. The buffer must be large enough to hold the structures, plus the strings to which their members point.

cbBufSize

Specifies the size, in bytes, of the buffer pointed to by the lpServices parameter.

pcbBytesNeeded

Pointer to a variable that receives the number of bytes needed to return the remaining service entries.

lpServicesReturned

Pointer to a variable that receives the number of service entries returned.

lpResumeHandle

Pointer to a DWORD variable that is used for both input and output. On input, this value specifies the starting point of enumeration. You must set this value to zero the first time this function is called. On output, this value is zero if the function succeeds. However, if the function returns zero and the GetLastError function returns ERROR_MORE_DATA, this value is used to indicate the next service entry to be read when the function is called to retrieve the additional data.

Return Values

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Errors

The following error codes can be set by the service control manager. Other error codes can be set by the registry functions that are called by the service control manager.

QuickInfo

  Windows NT: Requires version 3.1 or later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in winsvc.h.
  Import Library: Use advapi32.lib.
  Unicode: Implemented as Unicode and ANSI versions on Windows NT.

See Also

Services Overview, Service Functions, EnumDependentServices, ENUM_SERVICE_STATUS, OpenSCManager