ホーム › System.Services › GetServiceDirectory

GetServiceDirectory

関数

サービス専用のディレクトリパスを取得する。

DLLapi-ms-win-service-core-l1-1-4.dll呼出規約winapi対応OSWindows 10 以降

シグネチャ

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

DWORD GetServiceDirectory(
    SERVICE_STATUS_HANDLE hServiceStatus,
    SERVICE_DIRECTORY_TYPE eDirectoryType,
    LPWSTR lpPathBuffer,   // optional
    DWORD cchPathBufferLength,
    DWORD* lpcchRequiredBufferLength
);

パラメーター

名前	型	方向	説明
hServiceStatus	SERVICE_STATUS_HANDLE	in	現在のサービスのステータス情報構造体へのハンドルです。このハンドルは RegisterServiceCtrlHandler 関数によって返されます。
eDirectoryType	SERVICE_DIRECTORY_TYPE	in	取得するサービスごとのディレクトリパスの種類を識別する、SERVICE_DIRECTORY_TYPE 列挙体のメンバーです。
lpPathBuffer	LPWSTR	outoptional	パス文字列のコピー先となる、呼び出し側が割り当てたバッファーです。NULL の場合、関数呼び出しは ERROR_INSUFFICIENT_BUFFER で失敗し、必要なバッファー長を WCHAR 単位で lpcchRequiredBufferLength に返します。NULL でない場合は、バッファーの長さを cchPathBufferLength に指定する必要があります。パスが書き込まれる場合、NULL で終端されます。
cchPathBufferLength	DWORD	in	lpPathBuffer に指定したバッファーの長さを WCHAR 単位で指定します。lpPathBuffer が NULL の場合、この引数は無視されます。
lpcchRequiredBufferLength	DWORD*	out	必要なバッファー長が WCHAR 単位で設定されます。この長さには終端の NULL 文字が含まれます。

戻り値の型: DWORD

公式ドキュメント

サービスが状態の読み取りおよび書き込みを行うための、サービスごとのファイルシステム上の場所へのパスを返します。

戻り値

すべての操作が正常に完了し、NULL 終端された状態パスが lpPathBuffer に書き込まれた場合、ERROR_SUCCESS を返します。lpPathBuffer が状態パスを格納するのに十分な大きさでなかった場合、または lpPathBuffer が NULL であった場合は、ERROR_INSUFFICIENT_BUFFER を返します。この場合、必要なバッファー長が WCHAR 単位で lpcchRequiredBufferLength を通じて返されます。その他の何らかの失敗が発生した場合は、Win32 エラーコードが返されます。

解説(Remarks)

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

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

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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-4.dll
#include <windows.h>

DWORD GetServiceDirectory(
    SERVICE_STATUS_HANDLE hServiceStatus,
    SERVICE_DIRECTORY_TYPE eDirectoryType,
    LPWSTR lpPathBuffer,   // optional
    DWORD cchPathBufferLength,
    DWORD* lpcchRequiredBufferLength
);

[DllImport("api-ms-win-service-core-l1-1-4.dll", ExactSpelling = true)]
static extern uint GetServiceDirectory(
    IntPtr hServiceStatus,   // SERVICE_STATUS_HANDLE
    int eDirectoryType,   // SERVICE_DIRECTORY_TYPE
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpPathBuffer,   // LPWSTR optional, out
    uint cchPathBufferLength,   // DWORD
    out uint lpcchRequiredBufferLength   // DWORD* out
);

<DllImport("api-ms-win-service-core-l1-1-4.dll", ExactSpelling:=True)>
Public Shared Function GetServiceDirectory(
    hServiceStatus As IntPtr,   ' SERVICE_STATUS_HANDLE
    eDirectoryType As Integer,   ' SERVICE_DIRECTORY_TYPE
    <MarshalAs(UnmanagedType.LPWStr)> lpPathBuffer As System.Text.StringBuilder,   ' LPWSTR optional, out
    cchPathBufferLength As UInteger,   ' DWORD
    <Out> ByRef lpcchRequiredBufferLength As UInteger   ' DWORD* out
) As UInteger
End Function

' hServiceStatus : SERVICE_STATUS_HANDLE
' eDirectoryType : SERVICE_DIRECTORY_TYPE
' lpPathBuffer : LPWSTR optional, out
' cchPathBufferLength : DWORD
' lpcchRequiredBufferLength : DWORD* out
Declare PtrSafe Function GetServiceDirectory Lib "api-ms-win-service-core-l1-1-4" ( _
    ByVal hServiceStatus As LongPtr, _
    ByVal eDirectoryType As Long, _
    ByVal lpPathBuffer As LongPtr, _
    ByVal cchPathBufferLength As Long, _
    ByRef lpcchRequiredBufferLength As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetServiceDirectory = ctypes.windll.LoadLibrary("api-ms-win-service-core-l1-1-4.dll").GetServiceDirectory
GetServiceDirectory.restype = wintypes.DWORD
GetServiceDirectory.argtypes = [
    wintypes.HANDLE,  # hServiceStatus : SERVICE_STATUS_HANDLE
    ctypes.c_int,  # eDirectoryType : SERVICE_DIRECTORY_TYPE
    wintypes.LPWSTR,  # lpPathBuffer : LPWSTR optional, out
    wintypes.DWORD,  # cchPathBufferLength : DWORD
    ctypes.POINTER(wintypes.DWORD),  # lpcchRequiredBufferLength : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('api-ms-win-service-core-l1-1-4.dll')
GetServiceDirectory = Fiddle::Function.new(
  lib['GetServiceDirectory'],
  [
    Fiddle::TYPE_VOIDP,  # hServiceStatus : SERVICE_STATUS_HANDLE
    Fiddle::TYPE_INT,  # eDirectoryType : SERVICE_DIRECTORY_TYPE
    Fiddle::TYPE_VOIDP,  # lpPathBuffer : LPWSTR optional, out
    -Fiddle::TYPE_INT,  # cchPathBufferLength : DWORD
    Fiddle::TYPE_VOIDP,  # lpcchRequiredBufferLength : DWORD* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "api-ms-win-service-core-l1-1-4")]
extern "system" {
    fn GetServiceDirectory(
        hServiceStatus: *mut core::ffi::c_void,  // SERVICE_STATUS_HANDLE
        eDirectoryType: i32,  // SERVICE_DIRECTORY_TYPE
        lpPathBuffer: *mut u16,  // LPWSTR optional, out
        cchPathBufferLength: u32,  // DWORD
        lpcchRequiredBufferLength: *mut u32  // DWORD* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("api-ms-win-service-core-l1-1-4.dll")]
public static extern uint GetServiceDirectory(IntPtr hServiceStatus, int eDirectoryType, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpPathBuffer, uint cchPathBufferLength, out uint lpcchRequiredBufferLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'api-ms-win-service-core-l1-1-4_GetServiceDirectory' -Namespace Win32 -PassThru
# $api::GetServiceDirectory(hServiceStatus, eDirectoryType, lpPathBuffer, cchPathBufferLength, lpcchRequiredBufferLength)

#uselib "api-ms-win-service-core-l1-1-4.dll"
#func global GetServiceDirectory "GetServiceDirectory" sptr, sptr, sptr, sptr, sptr
; GetServiceDirectory hServiceStatus, eDirectoryType, varptr(lpPathBuffer), cchPathBufferLength, varptr(lpcchRequiredBufferLength)   ; 戻り値は stat
; hServiceStatus : SERVICE_STATUS_HANDLE -> "sptr"
; eDirectoryType : SERVICE_DIRECTORY_TYPE -> "sptr"
; lpPathBuffer : LPWSTR optional, out -> "sptr"
; cchPathBufferLength : DWORD -> "sptr"
; lpcchRequiredBufferLength : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "api-ms-win-service-core-l1-1-4.dll"
#cfunc global GetServiceDirectory "GetServiceDirectory" sptr, int, var, int, var
; res = GetServiceDirectory(hServiceStatus, eDirectoryType, lpPathBuffer, cchPathBufferLength, lpcchRequiredBufferLength)
; hServiceStatus : SERVICE_STATUS_HANDLE -> "sptr"
; eDirectoryType : SERVICE_DIRECTORY_TYPE -> "int"
; lpPathBuffer : LPWSTR optional, out -> "var"
; cchPathBufferLength : DWORD -> "int"
; lpcchRequiredBufferLength : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "api-ms-win-service-core-l1-1-4.dll"
#cfunc global GetServiceDirectory "GetServiceDirectory" sptr, int, sptr, int, sptr
; res = GetServiceDirectory(hServiceStatus, eDirectoryType, varptr(lpPathBuffer), cchPathBufferLength, varptr(lpcchRequiredBufferLength))
; hServiceStatus : SERVICE_STATUS_HANDLE -> "sptr"
; eDirectoryType : SERVICE_DIRECTORY_TYPE -> "int"
; lpPathBuffer : LPWSTR optional, out -> "sptr"
; cchPathBufferLength : DWORD -> "int"
; lpcchRequiredBufferLength : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。