ホーム › System.Services › QueryServiceLockStatusA

QueryServiceLockStatusA

関数

SCMデータベースのロック状態を取得する。

DLLADVAPI32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

BOOL QueryServiceLockStatusA(
    SC_HANDLE hSCManager,
    QUERY_SERVICE_LOCK_STATUSA* lpLockStatus,   // optional
    DWORD cbBufSize,
    DWORD* pcbBytesNeeded
);

パラメーター

名前	型	方向	説明
hSCManager	SC_HANDLE	in	サービス制御マネージャーデータベースへのハンドル。このハンドルは OpenSCManager 関数によって返され、SC_MANAGER_QUERY_LOCK_STATUS アクセス権を持っている必要があります。詳細については、 Service Security and Access Rights を参照してください。
lpLockStatus	QUERY_SERVICE_LOCK_STATUSA*	outoptional	指定したデータベースのロック状態と、そのメンバーが指す文字列を受け取る QUERY_SERVICE_LOCK_STATUS 構造体へのポインター。
cbBufSize	DWORD	in	lpLockStatus パラメーターが指すバッファーのサイズ(バイト単位)。
pcbBytesNeeded	DWORD*	out	関数が失敗した場合に、すべてのロック状態情報を返すために必要なバイト数を受け取る変数へのポインター。

戻り値の型: BOOL

公式ドキュメント

指定したサービス制御マネージャーデータベースのロック状態を取得します。(ANSI)

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

次のエラーコードは、サービス制御マネージャーによって設定されることがあります。その他のエラーコードは、サービス制御マネージャーから呼び出されるレジストリ関数によって設定されることがあります。

戻りコード	説明
ERROR_ACCESS_DENIED	ハンドルが SC_MANAGER_QUERY_LOCK_STATUS アクセス権を持っていません。
ERROR_INSUFFICIENT_BUFFER	ロック状態情報が lpLockStatus バッファーに収まる量を超えています。すべての情報を取得するために必要なバイト数は、pcbBytesNeeded パラメーターに返されます。lpLockStatus には何も書き込まれません。
ERROR_INVALID_HANDLE	指定したハンドルが無効です。

解説(Remarks)

QueryServiceLockStatus 関数は、指定したデータベースがロックされているかどうかを示す QUERY_SERVICE_LOCK_STATUS 構造体を返します。データベースがロックされている場合、この構造体はロックを所有するユーザーのアカウント名と、ロックが保持されている時間の長さを提供します。

プロセスは、サービス制御マネージャーデータベースのロックの所有権を取得するために LockServiceDatabase 関数を呼び出し、ロックを解放するために UnlockServiceDatabase 関数を呼び出します。

メモ

winsvc.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして QueryServiceLockStatus を定義します。エンコーディング中立なエイリアスの使用を、エンコーディング中立でないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不整合につながる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

BOOL QueryServiceLockStatusA(
    SC_HANDLE hSCManager,
    QUERY_SERVICE_LOCK_STATUSA* lpLockStatus,   // optional
    DWORD cbBufSize,
    DWORD* pcbBytesNeeded
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool QueryServiceLockStatusA(
    IntPtr hSCManager,   // SC_HANDLE
    IntPtr lpLockStatus,   // QUERY_SERVICE_LOCK_STATUSA* optional, out
    uint cbBufSize,   // DWORD
    out uint pcbBytesNeeded   // DWORD* out
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function QueryServiceLockStatusA(
    hSCManager As IntPtr,   ' SC_HANDLE
    lpLockStatus As IntPtr,   ' QUERY_SERVICE_LOCK_STATUSA* optional, out
    cbBufSize As UInteger,   ' DWORD
    <Out> ByRef pcbBytesNeeded As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hSCManager : SC_HANDLE
' lpLockStatus : QUERY_SERVICE_LOCK_STATUSA* optional, out
' cbBufSize : DWORD
' pcbBytesNeeded : DWORD* out
Declare PtrSafe Function QueryServiceLockStatusA Lib "advapi32" ( _
    ByVal hSCManager As LongPtr, _
    ByVal lpLockStatus As LongPtr, _
    ByVal cbBufSize As Long, _
    ByRef pcbBytesNeeded As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

QueryServiceLockStatusA = ctypes.windll.advapi32.QueryServiceLockStatusA
QueryServiceLockStatusA.restype = wintypes.BOOL
QueryServiceLockStatusA.argtypes = [
    wintypes.HANDLE,  # hSCManager : SC_HANDLE
    ctypes.c_void_p,  # lpLockStatus : QUERY_SERVICE_LOCK_STATUSA* optional, out
    wintypes.DWORD,  # cbBufSize : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcbBytesNeeded : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
QueryServiceLockStatusA = Fiddle::Function.new(
  lib['QueryServiceLockStatusA'],
  [
    Fiddle::TYPE_VOIDP,  # hSCManager : SC_HANDLE
    Fiddle::TYPE_VOIDP,  # lpLockStatus : QUERY_SERVICE_LOCK_STATUSA* optional, out
    -Fiddle::TYPE_INT,  # cbBufSize : DWORD
    Fiddle::TYPE_VOIDP,  # pcbBytesNeeded : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn QueryServiceLockStatusA(
        hSCManager: *mut core::ffi::c_void,  // SC_HANDLE
        lpLockStatus: *mut QUERY_SERVICE_LOCK_STATUSA,  // QUERY_SERVICE_LOCK_STATUSA* optional, out
        cbBufSize: u32,  // DWORD
        pcbBytesNeeded: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool QueryServiceLockStatusA(IntPtr hSCManager, IntPtr lpLockStatus, uint cbBufSize, out uint pcbBytesNeeded);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_QueryServiceLockStatusA' -Namespace Win32 -PassThru
# $api::QueryServiceLockStatusA(hSCManager, lpLockStatus, cbBufSize, pcbBytesNeeded)

#uselib "ADVAPI32.dll"
#func global QueryServiceLockStatusA "QueryServiceLockStatusA" sptr, sptr, sptr, sptr
; QueryServiceLockStatusA hSCManager, varptr(lpLockStatus), cbBufSize, varptr(pcbBytesNeeded)   ; 戻り値は stat
; hSCManager : SC_HANDLE -> "sptr"
; lpLockStatus : QUERY_SERVICE_LOCK_STATUSA* optional, out -> "sptr"
; cbBufSize : DWORD -> "sptr"
; pcbBytesNeeded : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global QueryServiceLockStatusA "QueryServiceLockStatusA" sptr, var, int, var
; res = QueryServiceLockStatusA(hSCManager, lpLockStatus, cbBufSize, pcbBytesNeeded)
; hSCManager : SC_HANDLE -> "sptr"
; lpLockStatus : QUERY_SERVICE_LOCK_STATUSA* optional, out -> "var"
; cbBufSize : DWORD -> "int"
; pcbBytesNeeded : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global QueryServiceLockStatusA "QueryServiceLockStatusA" sptr, sptr, int, sptr
; res = QueryServiceLockStatusA(hSCManager, varptr(lpLockStatus), cbBufSize, varptr(pcbBytesNeeded))
; hSCManager : SC_HANDLE -> "sptr"
; lpLockStatus : QUERY_SERVICE_LOCK_STATUSA* optional, out -> "sptr"
; cbBufSize : DWORD -> "int"
; pcbBytesNeeded : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。