Export (0) Print
Expand All

QueryServiceConfig function

Retrieves the configuration parameters of the specified service. Optional configuration parameters are available using the QueryServiceConfig2 function.

Syntax


BOOL WINAPI QueryServiceConfig(
  _In_       SC_HANDLE hService,
  _Out_opt_  LPQUERY_SERVICE_CONFIG lpServiceConfig,
  _In_       DWORD cbBufSize,
  _Out_      LPDWORD pcbBytesNeeded
);

Parameters

hService [in]

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

lpServiceConfig [out, optional]

A pointer to a buffer that receives the service configuration information. The format of the data is a QUERY_SERVICE_CONFIG structure.

The maximum size of this array is 8K bytes. To determine the required size, specify NULL for this parameter and 0 for the cbBufSize parameter. The function will fail and GetLastError will return ERROR_INSUFFICIENT_BUFFER. The pcbBytesNeeded parameter will receive the required size.

cbBufSize [in]

The size of the buffer pointed to by the lpServiceConfig parameter, in bytes.

pcbBytesNeeded [out]

A pointer to a variable that receives the number of bytes needed to store all the configuration information, if the function fails with ERROR_INSUFFICIENT_BUFFER.

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. Others can be set by the registry functions that are called by the service control manager.

Return codeDescription
ERROR_ACCESS_DENIED

The handle does not have the SERVICE_QUERY_CONFIG access right.

ERROR_INSUFFICIENT_BUFFER

There is more service configuration information than would fit into the lpServiceConfig buffer. The number of bytes required to get all the information is returned in the pcbBytesNeeded parameter. Nothing is written to lpServiceConfig.

ERROR_INVALID_HANDLE

The specified handle is invalid.

 

Remarks

The QueryServiceConfig function returns the service configuration information kept in the registry for a particular service. This configuration information is first set by a service control program using the CreateService function. This information may have been updated by a service configuration program using the ChangeServiceConfig function.

If the service was running when the configuration information was last changed, the information returned by QueryServiceConfig will not reflect the current configuration of the service. Instead, it will reflect the configuration of the service when it is next run. The DisplayName key is an exception to this. When the DisplayName key is changed, it takes effect immediately, regardless of whether the service is running.

Examples

For an example, see Querying a Service's Configuration.

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Winsvc.h (include Windows.h)

Library

Advapi32.lib

DLL

Advapi32.dll

Unicode and ANSI names

QueryServiceConfigW (Unicode) and QueryServiceConfigA (ANSI)

See also

ChangeServiceConfig
CreateService
OpenService
QueryServiceConfig2
QueryServiceDynamicInformation
QueryServiceObjectSecurity
Service Configuration
Service Functions
QUERY_SERVICE_CONFIG

 

 

Community Additions

ADD
Show:
© 2014 Microsoft