ホーム › System.Services › GetSharedServiceDirectory

GetSharedServiceDirectory

関数

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

DLLapi-ms-win-service-core-l1-1-5.dll呼出規約winapi

シグネチャ

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

DWORD GetSharedServiceDirectory(
    SC_HANDLE ServiceHandle,
    SERVICE_SHARED_DIRECTORY_TYPE DirectoryType,
    LPWSTR PathBuffer,   // optional
    DWORD PathBufferLength,
    DWORD* RequiredBufferLength
);

パラメーター

名前	型	方向	説明
ServiceHandle	SC_HANDLE	in	サービスへのハンドル。このハンドルは OpenService 関数によって返されます。
DirectoryType	SERVICE_SHARED_DIRECTORY_TYPE	in	取得するサービスごとの共有ディレクトリパスの種類を識別する SERVICE_SHARED_DIRECTORY_TYPE 列挙体のメンバー。
PathBuffer	LPWSTR	outoptional	パス文字列のコピー先となる、呼び出し側が割り当てたバッファー。NULL の場合、関数呼び出しは ERROR_INSUFFICIENT_BUFFER で失敗し、必要なバッファー長を WCHAR 単位で RequiredBufferLength に返します。NULL でない場合は、バッファーの長さを PathBufferLength に指定してください。パスは書き込まれる場合、NULL で終端されます。
PathBufferLength	DWORD	in	PathBuffer で指定したバッファーの長さ(WCHAR 単位)。PathBuffer が NULL の場合、この引数は無視されます。
RequiredBufferLength	DWORD*	out	この値には、必要なバッファー長が WCHAR 単位で設定されます。この長さには終端の NULL 文字が含まれます。

戻り値の型: DWORD

公式ドキュメント

サービスおよび関連プログラムが状態を読み書きするための、サービスごとのファイルシステム上の場所のパスを返します。

戻り値

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

解説(Remarks)

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

サービス自身による使用専用にサービス状態を提供する類似の API については、GetServiceDirectory を参照してください。

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

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

DWORD GetSharedServiceDirectory(
    SC_HANDLE ServiceHandle,
    SERVICE_SHARED_DIRECTORY_TYPE DirectoryType,
    LPWSTR PathBuffer,   // optional
    DWORD PathBufferLength,
    DWORD* RequiredBufferLength
);

[DllImport("api-ms-win-service-core-l1-1-5.dll", ExactSpelling = true)]
static extern uint GetSharedServiceDirectory(
    IntPtr ServiceHandle,   // SC_HANDLE
    int DirectoryType,   // SERVICE_SHARED_DIRECTORY_TYPE
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder PathBuffer,   // LPWSTR optional, out
    uint PathBufferLength,   // DWORD
    out uint RequiredBufferLength   // DWORD* out
);

<DllImport("api-ms-win-service-core-l1-1-5.dll", ExactSpelling:=True)>
Public Shared Function GetSharedServiceDirectory(
    ServiceHandle As IntPtr,   ' SC_HANDLE
    DirectoryType As Integer,   ' SERVICE_SHARED_DIRECTORY_TYPE
    <MarshalAs(UnmanagedType.LPWStr)> PathBuffer As System.Text.StringBuilder,   ' LPWSTR optional, out
    PathBufferLength As UInteger,   ' DWORD
    <Out> ByRef RequiredBufferLength As UInteger   ' DWORD* out
) As UInteger
End Function

' ServiceHandle : SC_HANDLE
' DirectoryType : SERVICE_SHARED_DIRECTORY_TYPE
' PathBuffer : LPWSTR optional, out
' PathBufferLength : DWORD
' RequiredBufferLength : DWORD* out
Declare PtrSafe Function GetSharedServiceDirectory Lib "api-ms-win-service-core-l1-1-5" ( _
    ByVal ServiceHandle As LongPtr, _
    ByVal DirectoryType As Long, _
    ByVal PathBuffer As LongPtr, _
    ByVal PathBufferLength As Long, _
    ByRef RequiredBufferLength As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetSharedServiceDirectory = ctypes.windll.LoadLibrary("api-ms-win-service-core-l1-1-5.dll").GetSharedServiceDirectory
GetSharedServiceDirectory.restype = wintypes.DWORD
GetSharedServiceDirectory.argtypes = [
    wintypes.HANDLE,  # ServiceHandle : SC_HANDLE
    ctypes.c_int,  # DirectoryType : SERVICE_SHARED_DIRECTORY_TYPE
    wintypes.LPWSTR,  # PathBuffer : LPWSTR optional, out
    wintypes.DWORD,  # PathBufferLength : DWORD
    ctypes.POINTER(wintypes.DWORD),  # RequiredBufferLength : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('api-ms-win-service-core-l1-1-5.dll')
GetSharedServiceDirectory = Fiddle::Function.new(
  lib['GetSharedServiceDirectory'],
  [
    Fiddle::TYPE_VOIDP,  # ServiceHandle : SC_HANDLE
    Fiddle::TYPE_INT,  # DirectoryType : SERVICE_SHARED_DIRECTORY_TYPE
    Fiddle::TYPE_VOIDP,  # PathBuffer : LPWSTR optional, out
    -Fiddle::TYPE_INT,  # PathBufferLength : DWORD
    Fiddle::TYPE_VOIDP,  # RequiredBufferLength : DWORD* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "api-ms-win-service-core-l1-1-5")]
extern "system" {
    fn GetSharedServiceDirectory(
        ServiceHandle: *mut core::ffi::c_void,  // SC_HANDLE
        DirectoryType: i32,  // SERVICE_SHARED_DIRECTORY_TYPE
        PathBuffer: *mut u16,  // LPWSTR optional, out
        PathBufferLength: u32,  // DWORD
        RequiredBufferLength: *mut u32  // DWORD* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("api-ms-win-service-core-l1-1-5.dll")]
public static extern uint GetSharedServiceDirectory(IntPtr ServiceHandle, int DirectoryType, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder PathBuffer, uint PathBufferLength, out uint RequiredBufferLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'api-ms-win-service-core-l1-1-5_GetSharedServiceDirectory' -Namespace Win32 -PassThru
# $api::GetSharedServiceDirectory(ServiceHandle, DirectoryType, PathBuffer, PathBufferLength, RequiredBufferLength)

#uselib "api-ms-win-service-core-l1-1-5.dll"
#func global GetSharedServiceDirectory "GetSharedServiceDirectory" sptr, sptr, sptr, sptr, sptr
; GetSharedServiceDirectory ServiceHandle, DirectoryType, varptr(PathBuffer), PathBufferLength, varptr(RequiredBufferLength)   ; 戻り値は stat
; ServiceHandle : SC_HANDLE -> "sptr"
; DirectoryType : SERVICE_SHARED_DIRECTORY_TYPE -> "sptr"
; PathBuffer : LPWSTR optional, out -> "sptr"
; PathBufferLength : DWORD -> "sptr"
; RequiredBufferLength : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "api-ms-win-service-core-l1-1-5.dll"
#cfunc global GetSharedServiceDirectory "GetSharedServiceDirectory" sptr, int, var, int, var
; res = GetSharedServiceDirectory(ServiceHandle, DirectoryType, PathBuffer, PathBufferLength, RequiredBufferLength)
; ServiceHandle : SC_HANDLE -> "sptr"
; DirectoryType : SERVICE_SHARED_DIRECTORY_TYPE -> "int"
; PathBuffer : LPWSTR optional, out -> "var"
; PathBufferLength : DWORD -> "int"
; RequiredBufferLength : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "api-ms-win-service-core-l1-1-5.dll"
#cfunc global GetSharedServiceDirectory "GetSharedServiceDirectory" sptr, int, sptr, int, sptr
; res = GetSharedServiceDirectory(ServiceHandle, DirectoryType, varptr(PathBuffer), PathBufferLength, varptr(RequiredBufferLength))
; ServiceHandle : SC_HANDLE -> "sptr"
; DirectoryType : SERVICE_SHARED_DIRECTORY_TYPE -> "int"
; PathBuffer : LPWSTR optional, out -> "sptr"
; PathBufferLength : DWORD -> "int"
; RequiredBufferLength : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。