Platform SDK: DLLs, Processes, and Threads

EnumServicesStatus

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

This function has been superseded by the EnumServicesStatusEx function. It returns the same information EnumServicesStatus returns, plus the process identifier and additional flags for the service. In addition, EnumServicesStatusEx enables you to enumerate services that belong to a specified group.

BOOL EnumServicesStatus(
  SC_HANDLE hSCManager,             // handle to SCM database
  DWORD dwServiceType,              // service type
  DWORD dwServiceState,             // service state
  LPENUM_SERVICE_STATUS lpServices, // status buffer
  DWORD cbBufSize,                  // size of status buffer
  LPDWORD pcbBytesNeeded,           // buffer size needed
  LPDWORD lpServicesReturned,       // number of entries returned
  LPDWORD lpResumeHandle            // next entry
);

Parameters

hSCManager
[in] Handle to the service control manager database. The OpenSCManager function returns this handle, which must have SC_MANAGER_ENUMERATE_SERVICE access.
dwServiceType
[in] Specifies the type of services to enumerate. This parameter can be one or more 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
[in] Specifies the services to enumerate based on their state. This parameter must be one 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
[out] Pointer to a buffer that contains an array of ENUM_SERVICE_STATUS structures that receive the name and service status information for each service in the database. The buffer must be large enough to hold the structures, plus the strings to which their members point.
cbBufSize
[in] Specifies the size, in bytes, of the buffer pointed to by the lpServices parameter.
pcbBytesNeeded
[out] Pointer to a variable that receives the number of bytes needed to return the remaining service entries.
lpServicesReturned
[out] Pointer to a variable that receives the number of service entries returned.
lpResumeHandle
[in/out] Pointer to a variable that, on input, 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.

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.

Error code Meaning
ERROR_ACCESS_DENIED The specified handle was not opened with SC_MANAGER_ENUMERATE_SERVICE access.
ERROR_INVALID_HANDLE The specified handle is invalid.
ERROR_INVALID_PARAMETER A parameter that was specified is invalid.
ERROR_MORE_DATA There are more service entries than would fit into the lpServices buffer. The actual number of service entries written to lpServices is returned in the lpServicesReturned parameter. The number of bytes required to get the remaining entries is returned in the pcbBytesNeeded parameter. The remaining services can be enumerated by additional calls to EnumServicesStatus with the lpResumeHandle parameter indicating the next service to read.

Requirements

  Windows NT/2000: Requires Windows NT 3.1 or later.
  Header: Declared in Winsvc.h; include Windows.h.
  Library: Use Advapi32.lib.
  Unicode: Implemented as Unicode and ANSI versions on Windows NT/2000.

See Also

Services Overview, Service Functions, EnumDependentServices, EnumServicesStatusEx, ENUM_SERVICE_STATUS, OpenSCManager