ホーム › Security.Authorization › ConvertSecurityDescriptorToStringSecurityDescriptorW

ConvertSecurityDescriptorToStringSecurityDescriptorW

関数

セキュリティ記述子をSDDL文字列に変換する。

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

シグネチャ

// ADVAPI32.dll  (Unicode / -W)
#include <windows.h>

BOOL ConvertSecurityDescriptorToStringSecurityDescriptorW(
    PSECURITY_DESCRIPTOR SecurityDescriptor,
    DWORD RequestedStringSDRevision,
    OBJECT_SECURITY_INFORMATION SecurityInformation,
    LPWSTR* StringSecurityDescriptor,
    DWORD* StringSecurityDescriptorLen   // optional
);

パラメーター

名前	型	方向	説明
SecurityDescriptor	PSECURITY_DESCRIPTOR	in	変換するセキュリティ記述子へのポインターです。セキュリティ記述子は絶対形式または自己相対形式のいずれでもかまいません。
RequestedStringSDRevision	DWORD	in	出力される StringSecurityDescriptor 文字列のリビジョンレベルを指定します。現在、この値は SDDL_REVISION_1 でなければなりません。
SecurityInformation	OBJECT_SECURITY_INFORMATION	in	出力文字列に含めるセキュリティ記述子の構成要素を示すために、 SECURITY_INFORMATION ビットフラグの組み合わせを指定します。 BACKUP_SECURITY_INFORMATION フラグはこの関数には適用されません。BACKUP_SECURITY_INFORMATION フラグが渡された場合、SecurityInformation パラメーターは TRUE を返し、文字列出力は null になります。
StringSecurityDescriptor	LPWSTR*	out	null で終わるセキュリティ記述子文字列へのポインターを受け取る変数へのポインターです。文字列形式の説明については、セキュリティ記述子文字列形式を参照してください。返されたバッファーを解放するには、 LocalFree 関数を呼び出します。
StringSecurityDescriptorLen	DWORD*	outoptional	StringSecurityDescriptor バッファーで返されるセキュリティ記述子文字列のサイズを TCHAR 単位で受け取る変数へのポインターです。サイズを取得する必要がない場合、このパラメーターは NULL でもかまいません。サイズは、文字列内の WCHAR 数ではなく、バッファーのサイズを WCHAR 単位で表します。

戻り値の型: BOOL

公式ドキュメント

セキュリティ記述子を文字列形式に変換します。この文字列形式は、セキュリティ記述子の保存や転送に使用できます。(Unicode)

戻り値

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

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。GetLastError 関数は、次のいずれかのエラーコードを返すことがあります。

戻りコード	説明
ERROR_INVALID_PARAMETER	パラメーターが無効です。
ERROR_UNKNOWN_REVISION	リビジョンレベルが無効です。
ERROR_NONE_MAPPED	入力セキュリティ記述子内のセキュリティ識別子 (SID) が、アカウント検索操作で見つかりませんでした。
ERROR_INVALID_ACL	アクセス制御リスト (ACL) が無効です。このエラーは、入力セキュリティ記述子で SE_DACL_PRESENT フラグが設定されているが、DACL が NULL である場合に返されます。

解説(Remarks)

DACL が NULL であり、かつ入力セキュリティ記述子で SE_DACL_PRESENT 制御ビットが設定されている場合、この関数は失敗します。

DACL が NULL であり、かつ入力セキュリティ記述子で SE_DACL_PRESENT 制御ビットが設定されていない場合、結果として得られるセキュリティ記述子文字列には D: コンポーネントが含まれません。詳細については、セキュリティ記述子文字列形式を参照してください。

メモ

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

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

各言語での呼び出し定義

// ADVAPI32.dll  (Unicode / -W)
#include <windows.h>

BOOL ConvertSecurityDescriptorToStringSecurityDescriptorW(
    PSECURITY_DESCRIPTOR SecurityDescriptor,
    DWORD RequestedStringSDRevision,
    OBJECT_SECURITY_INFORMATION SecurityInformation,
    LPWSTR* StringSecurityDescriptor,
    DWORD* StringSecurityDescriptorLen   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool ConvertSecurityDescriptorToStringSecurityDescriptorW(
    IntPtr SecurityDescriptor,   // PSECURITY_DESCRIPTOR
    uint RequestedStringSDRevision,   // DWORD
    uint SecurityInformation,   // OBJECT_SECURITY_INFORMATION
    IntPtr StringSecurityDescriptor,   // LPWSTR* out
    IntPtr StringSecurityDescriptorLen   // DWORD* optional, out
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ConvertSecurityDescriptorToStringSecurityDescriptorW(
    SecurityDescriptor As IntPtr,   ' PSECURITY_DESCRIPTOR
    RequestedStringSDRevision As UInteger,   ' DWORD
    SecurityInformation As UInteger,   ' OBJECT_SECURITY_INFORMATION
    StringSecurityDescriptor As IntPtr,   ' LPWSTR* out
    StringSecurityDescriptorLen As IntPtr   ' DWORD* optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' SecurityDescriptor : PSECURITY_DESCRIPTOR
' RequestedStringSDRevision : DWORD
' SecurityInformation : OBJECT_SECURITY_INFORMATION
' StringSecurityDescriptor : LPWSTR* out
' StringSecurityDescriptorLen : DWORD* optional, out
Declare PtrSafe Function ConvertSecurityDescriptorToStringSecurityDescriptorW Lib "advapi32" ( _
    ByVal SecurityDescriptor As LongPtr, _
    ByVal RequestedStringSDRevision As Long, _
    ByVal SecurityInformation As Long, _
    ByVal StringSecurityDescriptor As LongPtr, _
    ByVal StringSecurityDescriptorLen As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ConvertSecurityDescriptorToStringSecurityDescriptorW = ctypes.windll.advapi32.ConvertSecurityDescriptorToStringSecurityDescriptorW
ConvertSecurityDescriptorToStringSecurityDescriptorW.restype = wintypes.BOOL
ConvertSecurityDescriptorToStringSecurityDescriptorW.argtypes = [
    wintypes.HANDLE,  # SecurityDescriptor : PSECURITY_DESCRIPTOR
    wintypes.DWORD,  # RequestedStringSDRevision : DWORD
    wintypes.DWORD,  # SecurityInformation : OBJECT_SECURITY_INFORMATION
    ctypes.c_void_p,  # StringSecurityDescriptor : LPWSTR* out
    ctypes.POINTER(wintypes.DWORD),  # StringSecurityDescriptorLen : DWORD* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
ConvertSecurityDescriptorToStringSecurityDescriptorW = Fiddle::Function.new(
  lib['ConvertSecurityDescriptorToStringSecurityDescriptorW'],
  [
    Fiddle::TYPE_VOIDP,  # SecurityDescriptor : PSECURITY_DESCRIPTOR
    -Fiddle::TYPE_INT,  # RequestedStringSDRevision : DWORD
    -Fiddle::TYPE_INT,  # SecurityInformation : OBJECT_SECURITY_INFORMATION
    Fiddle::TYPE_VOIDP,  # StringSecurityDescriptor : LPWSTR* out
    Fiddle::TYPE_VOIDP,  # StringSecurityDescriptorLen : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "advapi32")]
extern "system" {
    fn ConvertSecurityDescriptorToStringSecurityDescriptorW(
        SecurityDescriptor: *mut core::ffi::c_void,  // PSECURITY_DESCRIPTOR
        RequestedStringSDRevision: u32,  // DWORD
        SecurityInformation: u32,  // OBJECT_SECURITY_INFORMATION
        StringSecurityDescriptor: *mut *mut u16,  // LPWSTR* out
        StringSecurityDescriptorLen: *mut u32  // DWORD* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool ConvertSecurityDescriptorToStringSecurityDescriptorW(IntPtr SecurityDescriptor, uint RequestedStringSDRevision, uint SecurityInformation, IntPtr StringSecurityDescriptor, IntPtr StringSecurityDescriptorLen);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_ConvertSecurityDescriptorToStringSecurityDescriptorW' -Namespace Win32 -PassThru
# $api::ConvertSecurityDescriptorToStringSecurityDescriptorW(SecurityDescriptor, RequestedStringSDRevision, SecurityInformation, StringSecurityDescriptor, StringSecurityDescriptorLen)

#uselib "ADVAPI32.dll"
#func global ConvertSecurityDescriptorToStringSecurityDescriptorW "ConvertSecurityDescriptorToStringSecurityDescriptorW" wptr, wptr, wptr, wptr, wptr
; ConvertSecurityDescriptorToStringSecurityDescriptorW SecurityDescriptor, RequestedStringSDRevision, SecurityInformation, varptr(StringSecurityDescriptor), varptr(StringSecurityDescriptorLen)   ; 戻り値は stat
; SecurityDescriptor : PSECURITY_DESCRIPTOR -> "wptr"
; RequestedStringSDRevision : DWORD -> "wptr"
; SecurityInformation : OBJECT_SECURITY_INFORMATION -> "wptr"
; StringSecurityDescriptor : LPWSTR* out -> "wptr"
; StringSecurityDescriptorLen : DWORD* optional, out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global ConvertSecurityDescriptorToStringSecurityDescriptorW "ConvertSecurityDescriptorToStringSecurityDescriptorW" sptr, int, int, var, var
; res = ConvertSecurityDescriptorToStringSecurityDescriptorW(SecurityDescriptor, RequestedStringSDRevision, SecurityInformation, StringSecurityDescriptor, StringSecurityDescriptorLen)
; SecurityDescriptor : PSECURITY_DESCRIPTOR -> "sptr"
; RequestedStringSDRevision : DWORD -> "int"
; SecurityInformation : OBJECT_SECURITY_INFORMATION -> "int"
; StringSecurityDescriptor : LPWSTR* out -> "var"
; StringSecurityDescriptorLen : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global ConvertSecurityDescriptorToStringSecurityDescriptorW "ConvertSecurityDescriptorToStringSecurityDescriptorW" sptr, int, int, sptr, sptr
; res = ConvertSecurityDescriptorToStringSecurityDescriptorW(SecurityDescriptor, RequestedStringSDRevision, SecurityInformation, varptr(StringSecurityDescriptor), varptr(StringSecurityDescriptorLen))
; SecurityDescriptor : PSECURITY_DESCRIPTOR -> "sptr"
; RequestedStringSDRevision : DWORD -> "int"
; SecurityInformation : OBJECT_SECURITY_INFORMATION -> "int"
; StringSecurityDescriptor : LPWSTR* out -> "sptr"
; StringSecurityDescriptorLen : DWORD* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。