ホーム › Security.Authorization › ConvertSidToStringSidW

ConvertSidToStringSidW

関数

SIDを文字列形式のSIDに変換する。

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

シグネチャ

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

BOOL ConvertSidToStringSidW(
    PSID Sid,
    LPWSTR* StringSid
);

パラメーター

名前	型	方向	説明
Sid	PSID	in	変換する SID 構造体へのポインターです。
StringSid	LPWSTR*	out	null で終わる SID 文字列へのポインターを受け取る変数へのポインターです。返されたバッファーを解放するには、 LocalFree 関数を呼び出します。

戻り値の型: BOOL

公式ドキュメント

セキュリティ識別子 (SID) を、表示、保存、または送信に適した文字列形式に変換します。(Unicode)

戻り値

関数が成功した場合、戻り値は 0 以外になります。

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

戻り値	説明
ERROR_NOT_ENOUGH_MEMORY	メモリが不足しています。
ERROR_INVALID_SID	SID が無効です。
ERROR_INVALID_PARAMETER	いずれかのパラメーターに無効な値が含まれています。これは多くの場合、無効なポインターです。

解説(Remarks)

ConvertSidToStringSid 関数は、SID 文字列に標準の S-R-I-S-S… 形式を使用します。SID 文字列の表記の詳細については、 SID Components を参照してください。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 ConvertSidToStringSidW(
    PSID Sid,
    LPWSTR* StringSid
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool ConvertSidToStringSidW(
    IntPtr Sid,   // PSID
    IntPtr StringSid   // LPWSTR* out
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ConvertSidToStringSidW(
    Sid As IntPtr,   ' PSID
    StringSid As IntPtr   ' LPWSTR* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' Sid : PSID
' StringSid : LPWSTR* out
Declare PtrSafe Function ConvertSidToStringSidW Lib "advapi32" ( _
    ByVal Sid As LongPtr, _
    ByVal StringSid 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

ConvertSidToStringSidW = ctypes.windll.advapi32.ConvertSidToStringSidW
ConvertSidToStringSidW.restype = wintypes.BOOL
ConvertSidToStringSidW.argtypes = [
    wintypes.HANDLE,  # Sid : PSID
    ctypes.c_void_p,  # StringSid : LPWSTR* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
ConvertSidToStringSidW = Fiddle::Function.new(
  lib['ConvertSidToStringSidW'],
  [
    Fiddle::TYPE_VOIDP,  # Sid : PSID
    Fiddle::TYPE_VOIDP,  # StringSid : LPWSTR* out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "advapi32")]
extern "system" {
    fn ConvertSidToStringSidW(
        Sid: *mut core::ffi::c_void,  // PSID
        StringSid: *mut *mut u16  // LPWSTR* 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 ConvertSidToStringSidW(IntPtr Sid, IntPtr StringSid);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_ConvertSidToStringSidW' -Namespace Win32 -PassThru
# $api::ConvertSidToStringSidW(Sid, StringSid)

#uselib "ADVAPI32.dll"
#func global ConvertSidToStringSidW "ConvertSidToStringSidW" wptr, wptr
; ConvertSidToStringSidW Sid, varptr(StringSid)   ; 戻り値は stat
; Sid : PSID -> "wptr"
; StringSid : LPWSTR* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global ConvertSidToStringSidW "ConvertSidToStringSidW" sptr, var
; res = ConvertSidToStringSidW(Sid, StringSid)
; Sid : PSID -> "sptr"
; StringSid : LPWSTR* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global ConvertSidToStringSidW "ConvertSidToStringSidW" sptr, sptr
; res = ConvertSidToStringSidW(Sid, varptr(StringSid))
; Sid : PSID -> "sptr"
; StringSid : LPWSTR* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。