QueryServiceLockStatusA function (winsvc.h)
[This function has no effect as of Windows Vista.]
Retrieves the lock status of the specified service control manager database.
Syntax
BOOL QueryServiceLockStatusA(
[in] SC_HANDLE hSCManager,
[out, optional] LPQUERY_SERVICE_LOCK_STATUSA lpLockStatus,
[in] DWORD cbBufSize,
[out] LPDWORD pcbBytesNeeded
);
Parameters
[in] hSCManager
A handle to the service control manager database. The OpenSCManager function returns this handle, which must have the SC_MANAGER_QUERY_LOCK_STATUS access right. For more information, see Service Security and Access Rights.
[out, optional] lpLockStatus
A pointer to a QUERY_SERVICE_LOCK_STATUS structure that receives the lock status of the specified database is returned, plus the strings to which its members point.
[in] cbBufSize
The size of the buffer pointed to by the lpLockStatus parameter, in bytes.
[out] pcbBytesNeeded
A pointer to a variable that receives the number of bytes needed to return all the lock status information, if the function fails.
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 |
|---|---|
|
The handle does not have the SC_MANAGER_QUERY_LOCK_STATUS access right. |
|
There is more lock status information than would fit into the lpLockStatus buffer. The number of bytes required to get all the information is returned in the pcbBytesNeeded parameter. Nothing is written to lpLockStatus. |
|
The specified handle is invalid. |
Remarks
The QueryServiceLockStatus function returns a QUERY_SERVICE_LOCK_STATUS structure that indicates whether the specified database is locked. If the database is locked, the structure provides the account name of the user that owns the lock and the length of time that the lock has been held.
A process calls the LockServiceDatabase function to acquire ownership of a service control manager database lock and the UnlockServiceDatabase function to release the lock.
Note
The winsvc.h header defines QueryServiceLockStatus as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.
Requirements
| Requirement | Value |
|---|---|
| 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 |