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

GetServiceRegistryStateKey

関数
サービス専用のレジストリ状態キーを取得する。
DLLapi-ms-win-service-core-l1-1-3.dll呼出規約winapi対応OSWindows 10 以降

シグネチャ

// api-ms-win-service-core-l1-1-3.dll
#include <windows.h>

DWORD GetServiceRegistryStateKey(
    SERVICE_STATUS_HANDLE ServiceStatusHandle,
    SERVICE_REGISTRY_STATE_TYPE StateType,
    DWORD AccessMask,
    HKEY* ServiceStateKey
);

パラメーター

名前方向説明
ServiceStatusHandleSERVICE_STATUS_HANDLEin現在のサービスの状態情報構造体へのハンドルです。このハンドルは RegisterServiceCtrlHandler 関数によって返されます。
StateTypeSERVICE_REGISTRY_STATE_TYPEinサービスレジストリキーを取得する対象の状態タイプを指定する SERVICE_REGISTRY_STATE_TYPE のメンバーです。
AccessMaskDWORDin状態キーを開く際に使用するアクセスマスクです。詳細については Registry Key Security and Access Rights を参照してください。
ServiceStateKeyHKEY*out出力されるレジストリキーハンドルを受け取ります。

戻り値の型: DWORD

公式ドキュメント

サービスが状態を読み取りおよび/または書き込むためのレジストリキーのハンドルを返します。

戻り値

すべての操作が正常に完了した場合は ERROR_SUCCESS を返します。それ以外の場合は Win32 エラーコードを返します。

解説(Remarks)

ServiceRegistryStatePersistent の場合、ディレクトリのセキュリティはローカルシステムアカウントとサービス SID にのみ書き込みアクセスを許可するように設定されます。この API を呼び出すサービスについては、サービス SID が有効になっていることを確認してください。詳細については SERVICE_SID_INFO を参照してください。

関連するプログラムと共有できるサービス状態を提供する同様の API については、GetSharedServiceRegistryStateKey を参照してください。

すべてのサービス状態レジストリキーは、サービスがアンインストールされると、サービス制御マネージャーによって削除されます。

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

各言語での呼び出し定義

// api-ms-win-service-core-l1-1-3.dll
#include <windows.h>

DWORD GetServiceRegistryStateKey(
    SERVICE_STATUS_HANDLE ServiceStatusHandle,
    SERVICE_REGISTRY_STATE_TYPE StateType,
    DWORD AccessMask,
    HKEY* ServiceStateKey
);
[DllImport("api-ms-win-service-core-l1-1-3.dll", ExactSpelling = true)]
static extern uint GetServiceRegistryStateKey(
    IntPtr ServiceStatusHandle,   // SERVICE_STATUS_HANDLE
    int StateType,   // SERVICE_REGISTRY_STATE_TYPE
    uint AccessMask,   // DWORD
    IntPtr ServiceStateKey   // HKEY* out
);
<DllImport("api-ms-win-service-core-l1-1-3.dll", ExactSpelling:=True)>
Public Shared Function GetServiceRegistryStateKey(
    ServiceStatusHandle As IntPtr,   ' SERVICE_STATUS_HANDLE
    StateType As Integer,   ' SERVICE_REGISTRY_STATE_TYPE
    AccessMask As UInteger,   ' DWORD
    ServiceStateKey As IntPtr   ' HKEY* out
) As UInteger
End Function
' ServiceStatusHandle : SERVICE_STATUS_HANDLE
' StateType : SERVICE_REGISTRY_STATE_TYPE
' AccessMask : DWORD
' ServiceStateKey : HKEY* out
Declare PtrSafe Function GetServiceRegistryStateKey Lib "api-ms-win-service-core-l1-1-3" ( _
    ByVal ServiceStatusHandle As LongPtr, _
    ByVal StateType As Long, _
    ByVal AccessMask As Long, _
    ByVal ServiceStateKey As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetServiceRegistryStateKey = ctypes.windll.LoadLibrary("api-ms-win-service-core-l1-1-3.dll").GetServiceRegistryStateKey
GetServiceRegistryStateKey.restype = wintypes.DWORD
GetServiceRegistryStateKey.argtypes = [
    wintypes.HANDLE,  # ServiceStatusHandle : SERVICE_STATUS_HANDLE
    ctypes.c_int,  # StateType : SERVICE_REGISTRY_STATE_TYPE
    wintypes.DWORD,  # AccessMask : DWORD
    ctypes.c_void_p,  # ServiceStateKey : HKEY* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('api-ms-win-service-core-l1-1-3.dll')
GetServiceRegistryStateKey = Fiddle::Function.new(
  lib['GetServiceRegistryStateKey'],
  [
    Fiddle::TYPE_VOIDP,  # ServiceStatusHandle : SERVICE_STATUS_HANDLE
    Fiddle::TYPE_INT,  # StateType : SERVICE_REGISTRY_STATE_TYPE
    -Fiddle::TYPE_INT,  # AccessMask : DWORD
    Fiddle::TYPE_VOIDP,  # ServiceStateKey : HKEY* out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "api-ms-win-service-core-l1-1-3")]
extern "system" {
    fn GetServiceRegistryStateKey(
        ServiceStatusHandle: *mut core::ffi::c_void,  // SERVICE_STATUS_HANDLE
        StateType: i32,  // SERVICE_REGISTRY_STATE_TYPE
        AccessMask: u32,  // DWORD
        ServiceStateKey: *mut *mut core::ffi::c_void  // HKEY* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("api-ms-win-service-core-l1-1-3.dll")]
public static extern uint GetServiceRegistryStateKey(IntPtr ServiceStatusHandle, int StateType, uint AccessMask, IntPtr ServiceStateKey);
"@
$api = Add-Type -MemberDefinition $sig -Name 'api-ms-win-service-core-l1-1-3_GetServiceRegistryStateKey' -Namespace Win32 -PassThru
# $api::GetServiceRegistryStateKey(ServiceStatusHandle, StateType, AccessMask, ServiceStateKey)
#uselib "api-ms-win-service-core-l1-1-3.dll"
#func global GetServiceRegistryStateKey "GetServiceRegistryStateKey" sptr, sptr, sptr, sptr
; GetServiceRegistryStateKey ServiceStatusHandle, StateType, AccessMask, ServiceStateKey   ; 戻り値は stat
; ServiceStatusHandle : SERVICE_STATUS_HANDLE -> "sptr"
; StateType : SERVICE_REGISTRY_STATE_TYPE -> "sptr"
; AccessMask : DWORD -> "sptr"
; ServiceStateKey : HKEY* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "api-ms-win-service-core-l1-1-3.dll"
#cfunc global GetServiceRegistryStateKey "GetServiceRegistryStateKey" sptr, int, int, sptr
; res = GetServiceRegistryStateKey(ServiceStatusHandle, StateType, AccessMask, ServiceStateKey)
; ServiceStatusHandle : SERVICE_STATUS_HANDLE -> "sptr"
; StateType : SERVICE_REGISTRY_STATE_TYPE -> "int"
; AccessMask : DWORD -> "int"
; ServiceStateKey : HKEY* out -> "sptr"
; DWORD GetServiceRegistryStateKey(SERVICE_STATUS_HANDLE ServiceStatusHandle, SERVICE_REGISTRY_STATE_TYPE StateType, DWORD AccessMask, HKEY* ServiceStateKey)
#uselib "api-ms-win-service-core-l1-1-3.dll"
#cfunc global GetServiceRegistryStateKey "GetServiceRegistryStateKey" intptr, int, int, intptr
; res = GetServiceRegistryStateKey(ServiceStatusHandle, StateType, AccessMask, ServiceStateKey)
; ServiceStatusHandle : SERVICE_STATUS_HANDLE -> "intptr"
; StateType : SERVICE_REGISTRY_STATE_TYPE -> "int"
; AccessMask : DWORD -> "int"
; ServiceStateKey : HKEY* out -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	api_ms_win_service_core_l1_1_3 = windows.NewLazySystemDLL("api-ms-win-service-core-l1-1-3.dll")
	procGetServiceRegistryStateKey = api_ms_win_service_core_l1_1_3.NewProc("GetServiceRegistryStateKey")
)

// ServiceStatusHandle (SERVICE_STATUS_HANDLE), StateType (SERVICE_REGISTRY_STATE_TYPE), AccessMask (DWORD), ServiceStateKey (HKEY* out)
r1, _, err := procGetServiceRegistryStateKey.Call(
	uintptr(ServiceStatusHandle),
	uintptr(StateType),
	uintptr(AccessMask),
	uintptr(ServiceStateKey),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function GetServiceRegistryStateKey(
  ServiceStatusHandle: THandle;   // SERVICE_STATUS_HANDLE
  StateType: Integer;   // SERVICE_REGISTRY_STATE_TYPE
  AccessMask: DWORD;   // DWORD
  ServiceStateKey: Pointer   // HKEY* out
): DWORD; stdcall;
  external 'api-ms-win-service-core-l1-1-3.dll' name 'GetServiceRegistryStateKey';
result := DllCall("api-ms-win-service-core-l1-1-3\GetServiceRegistryStateKey"
    , "Ptr", ServiceStatusHandle   ; SERVICE_STATUS_HANDLE
    , "Int", StateType   ; SERVICE_REGISTRY_STATE_TYPE
    , "UInt", AccessMask   ; DWORD
    , "Ptr", ServiceStateKey   ; HKEY* out
    , "UInt")   ; return: DWORD
●GetServiceRegistryStateKey(ServiceStatusHandle, StateType, AccessMask, ServiceStateKey) = DLL("api-ms-win-service-core-l1-1-3.dll", "dword GetServiceRegistryStateKey(void*, int, dword, void*)")
# 呼び出し: GetServiceRegistryStateKey(ServiceStatusHandle, StateType, AccessMask, ServiceStateKey)
# ServiceStatusHandle : SERVICE_STATUS_HANDLE -> "void*"
# StateType : SERVICE_REGISTRY_STATE_TYPE -> "int"
# AccessMask : DWORD -> "dword"
# ServiceStateKey : HKEY* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "api-ms-win-service-core-l1-1-3" fn GetServiceRegistryStateKey(
    ServiceStatusHandle: ?*anyopaque, // SERVICE_STATUS_HANDLE
    StateType: i32, // SERVICE_REGISTRY_STATE_TYPE
    AccessMask: u32, // DWORD
    ServiceStateKey: ?*anyopaque // HKEY* out
) callconv(std.os.windows.WINAPI) u32;
proc GetServiceRegistryStateKey(
    ServiceStatusHandle: pointer,  # SERVICE_STATUS_HANDLE
    StateType: int32,  # SERVICE_REGISTRY_STATE_TYPE
    AccessMask: uint32,  # DWORD
    ServiceStateKey: pointer  # HKEY* out
): uint32 {.importc: "GetServiceRegistryStateKey", stdcall, dynlib: "api-ms-win-service-core-l1-1-3.dll".}
pragma(lib, "api-ms-win-service-core-l1-1-3");
extern(Windows)
uint GetServiceRegistryStateKey(
    void* ServiceStatusHandle,   // SERVICE_STATUS_HANDLE
    int StateType,   // SERVICE_REGISTRY_STATE_TYPE
    uint AccessMask,   // DWORD
    void* ServiceStateKey   // HKEY* out
);
ccall((:GetServiceRegistryStateKey, "api-ms-win-service-core-l1-1-3.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Int32, UInt32, Ptr{Cvoid}),
      ServiceStatusHandle, StateType, AccessMask, ServiceStateKey)
# ServiceStatusHandle : SERVICE_STATUS_HANDLE -> Ptr{Cvoid}
# StateType : SERVICE_REGISTRY_STATE_TYPE -> Int32
# AccessMask : DWORD -> UInt32
# ServiceStateKey : HKEY* out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetServiceRegistryStateKey(
    void* ServiceStatusHandle,
    int32_t StateType,
    uint32_t AccessMask,
    void* ServiceStateKey);
]]
local api-ms-win-service-core-l1-1-3 = ffi.load("api-ms-win-service-core-l1-1-3")
-- api-ms-win-service-core-l1-1-3.GetServiceRegistryStateKey(ServiceStatusHandle, StateType, AccessMask, ServiceStateKey)
-- ServiceStatusHandle : SERVICE_STATUS_HANDLE
-- StateType : SERVICE_REGISTRY_STATE_TYPE
-- AccessMask : DWORD
-- ServiceStateKey : HKEY* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('api-ms-win-service-core-l1-1-3.dll');
const GetServiceRegistryStateKey = lib.func('__stdcall', 'GetServiceRegistryStateKey', 'uint32_t', ['void *', 'int32_t', 'uint32_t', 'void *']);
// GetServiceRegistryStateKey(ServiceStatusHandle, StateType, AccessMask, ServiceStateKey)
// ServiceStatusHandle : SERVICE_STATUS_HANDLE -> 'void *'
// StateType : SERVICE_REGISTRY_STATE_TYPE -> 'int32_t'
// AccessMask : DWORD -> 'uint32_t'
// ServiceStateKey : HKEY* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("api-ms-win-service-core-l1-1-3.dll", {
  GetServiceRegistryStateKey: { parameters: ["pointer", "i32", "u32", "pointer"], result: "u32" },
});
// lib.symbols.GetServiceRegistryStateKey(ServiceStatusHandle, StateType, AccessMask, ServiceStateKey)
// ServiceStatusHandle : SERVICE_STATUS_HANDLE -> "pointer"
// StateType : SERVICE_REGISTRY_STATE_TYPE -> "i32"
// AccessMask : DWORD -> "u32"
// ServiceStateKey : HKEY* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetServiceRegistryStateKey(
    void* ServiceStatusHandle,
    int32_t StateType,
    uint32_t AccessMask,
    void* ServiceStateKey);
C, "api-ms-win-service-core-l1-1-3.dll");
// $ffi->GetServiceRegistryStateKey(ServiceStatusHandle, StateType, AccessMask, ServiceStateKey);
// ServiceStatusHandle : SERVICE_STATUS_HANDLE
// StateType : SERVICE_REGISTRY_STATE_TYPE
// AccessMask : DWORD
// ServiceStateKey : HKEY* out
// 構造体/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 Api-ms-win-service-core-l1-1-3 extends StdCallLibrary {
    Api-ms-win-service-core-l1-1-3 INSTANCE = Native.load("api-ms-win-service-core-l1-1-3", Api-ms-win-service-core-l1-1-3.class);
    int GetServiceRegistryStateKey(
        Pointer ServiceStatusHandle,   // SERVICE_STATUS_HANDLE
        int StateType,   // SERVICE_REGISTRY_STATE_TYPE
        int AccessMask,   // DWORD
        Pointer ServiceStateKey   // HKEY* out
    );
}
@[Link("api-ms-win-service-core-l1-1-3")]
lib Libapi-ms-win-service-core-l1-1-3
  fun GetServiceRegistryStateKey = GetServiceRegistryStateKey(
    ServiceStatusHandle : Void*,   # SERVICE_STATUS_HANDLE
    StateType : Int32,   # SERVICE_REGISTRY_STATE_TYPE
    AccessMask : UInt32,   # DWORD
    ServiceStateKey : Void*   # HKEY* out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetServiceRegistryStateKeyNative = Uint32 Function(Pointer<Void>, Int32, Uint32, Pointer<Void>);
typedef GetServiceRegistryStateKeyDart = int Function(Pointer<Void>, int, int, Pointer<Void>);
final GetServiceRegistryStateKey = DynamicLibrary.open('api-ms-win-service-core-l1-1-3.dll')
    .lookupFunction<GetServiceRegistryStateKeyNative, GetServiceRegistryStateKeyDart>('GetServiceRegistryStateKey');
// ServiceStatusHandle : SERVICE_STATUS_HANDLE -> Pointer<Void>
// StateType : SERVICE_REGISTRY_STATE_TYPE -> Int32
// AccessMask : DWORD -> Uint32
// ServiceStateKey : HKEY* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetServiceRegistryStateKey(
  ServiceStatusHandle: THandle;   // SERVICE_STATUS_HANDLE
  StateType: Integer;   // SERVICE_REGISTRY_STATE_TYPE
  AccessMask: DWORD;   // DWORD
  ServiceStateKey: Pointer   // HKEY* out
): DWORD; stdcall;
  external 'api-ms-win-service-core-l1-1-3.dll' name 'GetServiceRegistryStateKey';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetServiceRegistryStateKey"
  c_GetServiceRegistryStateKey :: Ptr () -> Int32 -> Word32 -> Ptr () -> IO Word32
-- ServiceStatusHandle : SERVICE_STATUS_HANDLE -> Ptr ()
-- StateType : SERVICE_REGISTRY_STATE_TYPE -> Int32
-- AccessMask : DWORD -> Word32
-- ServiceStateKey : HKEY* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getserviceregistrystatekey =
  foreign "GetServiceRegistryStateKey"
    ((ptr void) @-> int32_t @-> uint32_t @-> (ptr void) @-> returning uint32_t)
(* ServiceStatusHandle : SERVICE_STATUS_HANDLE -> (ptr void) *)
(* StateType : SERVICE_REGISTRY_STATE_TYPE -> int32_t *)
(* AccessMask : DWORD -> uint32_t *)
(* ServiceStateKey : HKEY* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library api-ms-win-service-core-l1-1-3 (t "api-ms-win-service-core-l1-1-3.dll"))
(cffi:use-foreign-library api-ms-win-service-core-l1-1-3)

(cffi:defcfun ("GetServiceRegistryStateKey" get-service-registry-state-key :convention :stdcall) :uint32
  (service-status-handle :pointer)   ; SERVICE_STATUS_HANDLE
  (state-type :int32)   ; SERVICE_REGISTRY_STATE_TYPE
  (access-mask :uint32)   ; DWORD
  (service-state-key :pointer))   ; HKEY* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetServiceRegistryStateKey = Win32::API::More->new('api-ms-win-service-core-l1-1-3',
    'DWORD GetServiceRegistryStateKey(HANDLE ServiceStatusHandle, int StateType, DWORD AccessMask, HANDLE ServiceStateKey)');
# my $ret = $GetServiceRegistryStateKey->Call($ServiceStatusHandle, $StateType, $AccessMask, $ServiceStateKey);
# ServiceStatusHandle : SERVICE_STATUS_HANDLE -> HANDLE
# StateType : SERVICE_REGISTRY_STATE_TYPE -> int
# AccessMask : DWORD -> DWORD
# ServiceStateKey : HKEY* out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型