ホーム › Security.Authorization › ConvertSidToStringSidA

ConvertSidToStringSidA

関数

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

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

シグネチャ

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

BOOL ConvertSidToStringSidA(
    PSID Sid,
    LPSTR* StringSid
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

関数が成功した場合、戻り値は 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 ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして ConvertSidToStringSid を定義します。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在して使用すると、不一致が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

BOOL ConvertSidToStringSidA(
    PSID Sid,
    LPSTR* StringSid
);

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

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

' Sid : PSID
' StringSid : LPSTR* out
Declare PtrSafe Function ConvertSidToStringSidA Lib "advapi32" ( _
    ByVal Sid As LongPtr, _
    ByVal StringSid As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
ConvertSidToStringSidA = Fiddle::Function.new(
  lib['ConvertSidToStringSidA'],
  [
    Fiddle::TYPE_VOIDP,  # Sid : PSID
    Fiddle::TYPE_VOIDP,  # StringSid : LPSTR* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn ConvertSidToStringSidA(
        Sid: *mut core::ffi::c_void,  // PSID
        StringSid: *mut *mut u8  // LPSTR* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool ConvertSidToStringSidA(IntPtr Sid, IntPtr StringSid);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_ConvertSidToStringSidA' -Namespace Win32 -PassThru
# $api::ConvertSidToStringSidA(Sid, StringSid)

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

出力引数:

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