Platform SDK: DLLs, Processes, and Threads

QueryServiceConfig

The QueryServiceConfig function retrieves the configuration parameters of the specified service. Optional configuration parameters are available using the QueryServiceConfig2 function.

BOOL QueryServiceConfig(
  SC_HANDLE hService,                     // handle to service
  LPQUERY_SERVICE_CONFIG lpServiceConfig, // buffer
  DWORD cbBufSize,                        // size of buffer
  LPDWORD pcbBytesNeeded                  // bytes needed
);

Parameters

hService: [in] Handle to the service. This handle is returned by the OpenService or CreateService function, and it must have SERVICE_QUERY_CONFIG access.
lpServiceConfig: [out] Pointer to a buffer that receives the service configuration information. The format of the data is a QUERY_SERVICE_CONFIG structure.
cbBufSize: [in] Specifies the size, in bytes, of the buffer pointed to by the lpServiceConfig parameter.
pcbBytesNeeded: [out] Pointer to a variable that receives the number of bytes needed to return all the configuration information if the function fails with the error ERROR_INSUFFICIENT_BUFFER.

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. Others 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 SERVICE_QUERY_CONFIG access.
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 the lpServiceConfig buffer.
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.

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.

QueryServiceConfig

Parameters

Return Values

Remarks

Requirements

See Also