Win32 API 日本語リファレンス
ホームSystem.Services › LockServiceDatabase

LockServiceDatabase

関数
SCMデータベースをロックする。
DLLADVAPI32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// ADVAPI32.dll
#include <windows.h>

void* LockServiceDatabase(
    SC_HANDLE hSCManager
);

パラメーター

名前方向説明
hSCManagerSC_HANDLEinSCM データベースへのハンドル。このハンドルは OpenSCManager 関数によって返され、SC_MANAGER_LOCK アクセス権を持っている必要があります。詳細については、 Service Security and Access Rights を参照してください。

戻り値の型: void*

公式ドキュメント

サービス制御マネージャー (SCM) データベースのロックの所有権を要求します。任意の時点でロックを所有できるプロセスは 1 つだけです。

戻り値

関数が成功すると、戻り値は指定された SCM データベースに対するロックになります。

関数が失敗すると、戻り値は NULL になります。拡張エラー情報を取得するには、 GetLastError を呼び出します。

次のエラーコードが SCM によって設定される場合があります。これら以外のエラーコードは、SCM から呼び出されるレジストリ関数によって設定される場合があります。

戻りコード 説明
ERROR_ACCESS_DENIED
ハンドルが SC_MANAGER_LOCK アクセス権を持っていません。
ERROR_INVALID_HANDLE
指定されたハンドルが有効ではありません。
ERROR_SERVICE_DATABASE_LOCKED
データベースがロックされています。

解説(Remarks)

ロックは、セットアッププログラムや構成プログラムと SCM が、レジストリ内のサービスツリーへのアクセスを直列化するために使用するプロトコルです。SCM がロックの所有権を要求するのは、サービスを開始するときだけです。

SCM データベースのロックを取得したまま解放しないプログラムは、SCM が他のサービスを開始するのを妨げます。この問題の重大性のため、プロセスがデータベースをロックすることは現在では許可されていません。古いアプリケーションとの互換性のために、LockServiceDatabase 関数はロックを返しますが、それ以外の効果はありません。

Windows Server 2003 および Windows XP: SCM データベースのロックを取得すると、ロックが解放されるまで SCM はサービスを開始できなくなります。たとえば、関連する複数のサービスをいずれも開始する前に構成する必要があるプログラムは、最初のサービスを構成する前に LockServiceDatabase を呼び出すことができます。あるいは、構成が完了するまでいずれのサービスも開始されないようにすることもできます。

ロックされたデータベース内でサービスを開始するために StartService 関数を呼び出すと失敗します。ロックによって影響を受ける SCM 関数は他にはありません。

ロックは、後続の UnlockServiceDatabase 関数の呼び出しで SC_LOCK ハンドルが指定されるまで保持されます。ロックを所有するプロセスが終了した場合、SCM は自動的にクリーンアップを行い、ロックの所有権を解放します。

ロックを解放しないと、システムに問題が生じる可能性があります。ロックを取得したプロセスは、できるだけ早くそれを解放する必要があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// ADVAPI32.dll
#include <windows.h>

void* LockServiceDatabase(
    SC_HANDLE hSCManager
);
[DllImport("ADVAPI32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr LockServiceDatabase(
    IntPtr hSCManager   // SC_HANDLE
);
<DllImport("ADVAPI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function LockServiceDatabase(
    hSCManager As IntPtr   ' SC_HANDLE
) As IntPtr
End Function
' hSCManager : SC_HANDLE
Declare PtrSafe Function LockServiceDatabase Lib "advapi32" ( _
    ByVal hSCManager As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

LockServiceDatabase = ctypes.windll.advapi32.LockServiceDatabase
LockServiceDatabase.restype = ctypes.c_void_p
LockServiceDatabase.argtypes = [
    wintypes.HANDLE,  # hSCManager : SC_HANDLE
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
LockServiceDatabase = Fiddle::Function.new(
  lib['LockServiceDatabase'],
  [
    Fiddle::TYPE_VOIDP,  # hSCManager : SC_HANDLE
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "advapi32")]
extern "system" {
    fn LockServiceDatabase(
        hSCManager: *mut core::ffi::c_void  // SC_HANDLE
    ) -> *mut ();
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("ADVAPI32.dll", SetLastError = true)]
public static extern IntPtr LockServiceDatabase(IntPtr hSCManager);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_LockServiceDatabase' -Namespace Win32 -PassThru
# $api::LockServiceDatabase(hSCManager)
#uselib "ADVAPI32.dll"
#func global LockServiceDatabase "LockServiceDatabase" sptr
; LockServiceDatabase hSCManager   ; 戻り値は stat
; hSCManager : SC_HANDLE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "ADVAPI32.dll"
#cfunc global LockServiceDatabase "LockServiceDatabase" sptr
; res = LockServiceDatabase(hSCManager)
; hSCManager : SC_HANDLE -> "sptr"
; void* LockServiceDatabase(SC_HANDLE hSCManager)
#uselib "ADVAPI32.dll"
#cfunc global LockServiceDatabase "LockServiceDatabase" intptr
; res = LockServiceDatabase(hSCManager)
; hSCManager : SC_HANDLE -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procLockServiceDatabase = advapi32.NewProc("LockServiceDatabase")
)

// hSCManager (SC_HANDLE)
r1, _, err := procLockServiceDatabase.Call(
	uintptr(hSCManager),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // void*
function LockServiceDatabase(
  hSCManager: THandle   // SC_HANDLE
): Pointer; stdcall;
  external 'ADVAPI32.dll' name 'LockServiceDatabase';
result := DllCall("ADVAPI32\LockServiceDatabase"
    , "Ptr", hSCManager   ; SC_HANDLE
    , "Ptr")   ; return: void*
●LockServiceDatabase(hSCManager) = DLL("ADVAPI32.dll", "void* LockServiceDatabase(void*)")
# 呼び出し: LockServiceDatabase(hSCManager)
# hSCManager : SC_HANDLE -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "advapi32" fn LockServiceDatabase(
    hSCManager: ?*anyopaque // SC_HANDLE
) callconv(std.os.windows.WINAPI) ?*anyopaque;
proc LockServiceDatabase(
    hSCManager: pointer  # SC_HANDLE
): pointer {.importc: "LockServiceDatabase", stdcall, dynlib: "ADVAPI32.dll".}
pragma(lib, "advapi32");
extern(Windows)
void* LockServiceDatabase(
    void* hSCManager   // SC_HANDLE
);
ccall((:LockServiceDatabase, "ADVAPI32.dll"), stdcall, Ptr{Cvoid},
      (Ptr{Cvoid},),
      hSCManager)
# hSCManager : SC_HANDLE -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void* LockServiceDatabase(
    void* hSCManager);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.LockServiceDatabase(hSCManager)
-- hSCManager : SC_HANDLE
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const LockServiceDatabase = lib.func('__stdcall', 'LockServiceDatabase', 'void *', ['void *']);
// LockServiceDatabase(hSCManager)
// hSCManager : SC_HANDLE -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ADVAPI32.dll", {
  LockServiceDatabase: { parameters: ["pointer"], result: "pointer" },
});
// lib.symbols.LockServiceDatabase(hSCManager)
// hSCManager : SC_HANDLE -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* LockServiceDatabase(
    void* hSCManager);
C, "ADVAPI32.dll");
// $ffi->LockServiceDatabase(hSCManager);
// hSCManager : SC_HANDLE
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Advapi32 extends StdCallLibrary {
    Advapi32 INSTANCE = Native.load("advapi32", Advapi32.class);
    Pointer LockServiceDatabase(
        Pointer hSCManager   // SC_HANDLE
    );
}
@[Link("advapi32")]
lib LibADVAPI32
  fun LockServiceDatabase = LockServiceDatabase(
    hSCManager : Void*   # SC_HANDLE
  ) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef LockServiceDatabaseNative = Pointer<Void> Function(Pointer<Void>);
typedef LockServiceDatabaseDart = Pointer<Void> Function(Pointer<Void>);
final LockServiceDatabase = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<LockServiceDatabaseNative, LockServiceDatabaseDart>('LockServiceDatabase');
// hSCManager : SC_HANDLE -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function LockServiceDatabase(
  hSCManager: THandle   // SC_HANDLE
): Pointer; stdcall;
  external 'ADVAPI32.dll' name 'LockServiceDatabase';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "LockServiceDatabase"
  c_LockServiceDatabase :: Ptr () -> IO (Ptr ())
-- hSCManager : SC_HANDLE -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let lockservicedatabase =
  foreign "LockServiceDatabase"
    ((ptr void) @-> returning (ptr void))
(* hSCManager : SC_HANDLE -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("LockServiceDatabase" lock-service-database :convention :stdcall) :pointer
  (h-scmanager :pointer))   ; SC_HANDLE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $LockServiceDatabase = Win32::API::More->new('ADVAPI32',
    'LPVOID LockServiceDatabase(HANDLE hSCManager)');
# my $ret = $LockServiceDatabase->Call($hSCManager);
# hSCManager : SC_HANDLE -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目