QueryServiceStatus

The 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.

BOOL QueryServiceStatus(  SC_HANDLE hService,  LPSERVICE_STATUS lpServiceStatus);

Parameters

hService

[in] 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

[out] Pointer to a SERVICE_STATUS structure that receives the status information.

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.

Return codeDescriptionERROR_ACCESS_DENIEDThe handle does not have the SERVICE_QUERY_STATUS access right.ERROR_INVALID_HANDLEThe 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. Applications can find out the current service status by interrogating the service directly using the ControlService function with the SERVICE_CONTROL_INTERROGATE control code.

Example Code

For an example, see Starting a Service.

Requirements

ClientRequires Windows XP, Windows 2000 Professional, or Windows NT Workstation.ServerRequires Windows Server 2003, Windows 2000 Server, or Windows NT Server.Header

Declared in Winsvc.h; include Windows.h.

Library

Link to Advapi32.lib.

DLLRequires Advapi32.dll.