LockServiceDatabase

The LockServiceDatabase function locks the specified service control manager database.

SC_LOCK LockServiceDatabase(
  SC_HANDLE hSCManager   // handle of service control manager 
                         // database
);
 

Parameters

hSCManager
Handle to the service control manager database. The OpenSCManager function returns this handle, which must have SC_MANAGER_LOCK access.

Return Values

If the function succeeds, the return value is a lock to the specified service control manager database.

If the function fails, the return value is NULL. To get extended error information, call GetLastError.

Errors

The following error code can be set by the service control manager. Other error codes can be set by registry functions that are called by the service control manager.

Value Meaning
ERROR_ACCESS_DENIED The specified handle was not opened with SC_MANAGER_LOCK access.
ERROR_INVALID_HANDLE The specified handle is invalid.
ERROR_SERVICE_DATABASE_LOCKED The database is locked.

Remarks

The LockServiceDatabase function tries to request ownership of the service control manager database lock. Only one process at a time can own a lock at any given time.

A lock is a protocol used by setup and configuration programs and the service control manager to serialize access to the service tree in the registry. The only time the service control manager requests ownership of the lock is when it is starting a service. Setup and configuration programs are expected to acquire ownership of a lock before using the ChangeServiceConfig or SetServiceObjectSecurity function to reconfigure a service. They should also acquire ownership of a lock before using the registry functions to reconfigure a service. The lock prevents the service control manager from starting a service while it is being reconfigured.

A call to the StartService function to start a service in a locked database fails. No other service control manager functions are affected by a lock.

The lock is held until the SC_LOCK handle is specified in a subsequent call to the UnlockServiceDatabase function. If a process that owns a lock terminates, the service control manager automatically cleans up and releases ownership of the lock.

QuickInfo

  Windows NT: Requires version 3.1 or later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in winsvc.h.
  Import Library: Use advapi32.lib.

See Also

Services Overview, Service Functions, ChangeServiceConfig, OpenSCManager, QueryServiceLockStatus, SetServiceObjectSecurity, StartService, UnlockServiceDatabase