QueryServiceStatus function

Retrieves the current status of the specified service.

This function has been superseded by the QueryServiceStatusEx function. QueryServiceStatusEx returns the same information QueryServiceStatus returns, with the addition of the process identifier and additional information for the service.

Syntax

BOOL QueryServiceStatus(
  SC_HANDLE        hService,
  LPSERVICE_STATUS lpServiceStatus
);

Parameters

hService

A handle to the service. This handle is returned by the OpenService or the CreateService function, and it must have the SERVICE_QUERY_STATUS access right. For more information, see Service Security and Access Rights.

lpServiceStatus

A pointer to a SERVICE_STATUS structure that receives the status information.

Return Value

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.

Return code Description
ERROR_ACCESS_DENIED
The handle does not have the SERVICE_QUERY_STATUS access right.
ERROR_INVALID_HANDLE
The handle is invalid.

Remarks

The QueryServiceStatus function returns the most recent service status information reported to the service control manager. If the service just changed its status, it may not have updated the service control manager yet.

Requirements

   
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header winsvc.h (include Windows.h)
Library Advapi32.lib
DLL Advapi32.dll

See Also

ControlService

CreateService

OpenService

QueryServiceStatusEx

SERVICE_STATUS

Service Functions

Service Startup

SetServiceStatus