QueryServiceConfig info  Overview  Group

The QueryServiceConfig function retrieves the configuration parameters of the specified service.

BOOL QueryServiceConfig(

SC_HANDLE hService,	// handle of service
LPQUERY_SERVICE_CONFIG lpServiceConfig,	// address of service config. structure
DWORD cbBufSize,	// size of service configuration buffer
LPDWORD pcbBytesNeeded	// address of variable for bytes needed
);

Parameters

hService

Identifies the service. This handle is returned by the OpenService or CreateService function, and it must have SERVICE_QUERY_CONFIG access.

lpServiceConfig

Points to a buffer that receives the QUERY_SERVICE_CONFIG structure in which the service configuration information is returned, plus the strings to which its members point.

cbBufSize

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

pcbBytesNeeded

Points to a variable that receives the number of bytes needed to return all the configuration information if the function fails.

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.

Errors

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.

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

See Also

ChangeServiceConfig, CreateService, OpenService, QUERY_SERVICE_CONFIG, QueryServiceObjectSecurity, QueryServiceStatus