ホーム › Security › LookupPrivilegeNameA

LookupPrivilegeNameA

関数

特権を表すLUIDから特権名を取得する(ANSI版)。

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

シグネチャ

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

BOOL LookupPrivilegeNameA(
    LPCSTR lpSystemName,   // optional
    LUID* lpLuid,
    LPSTR lpName,   // optional
    DWORD* cchName
);

パラメーター

名前	型	方向	説明
lpSystemName	LPCSTR	inoptional	特権名を取得する対象のシステム名を指定する、null で終わる文字列へのポインターです。null 文字列が指定された場合、関数はローカルシステム上で特権名を見つけようとします。
lpLuid	LUID*	in	対象システム上で特権を識別する LUID へのポインターです。
lpName	LPSTR	outoptional	特権名を表す null で終わる文字列を受け取るバッファーへのポインターです。たとえば、この文字列は "SeSecurityPrivilege" のようになります。
cchName	DWORD*	inout	lpName バッファーのサイズを TCHAR 単位で指定する変数へのポインターです。関数が戻るとき、このパラメーターには終端の null 文字を含まない特権名の長さが格納されます。lpName パラメーターが指すバッファーが小さすぎる場合、この変数には必要なサイズが格納されます。

戻り値の型: BOOL

公式ドキュメント

指定されたシステム上で、特定のローカル一意識別子 (LUID) によって表される特権に対応する名前を取得します。(ANSI)

戻り値

関数が成功すると、関数は 0 以外の値を返します。

関数が失敗すると、0 を返します。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

LookupPrivilegeName 関数は、Winnt.h の Defined Privileges セクションで指定されている特権のみをサポートします。値の一覧については、Privilege Constants を参照してください。

メモ

winbase.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして LookupPrivilegeName を定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存ではないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不一致が生じる可能性があります。詳細については、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 LookupPrivilegeNameA(
    LPCSTR lpSystemName,   // optional
    LUID* lpLuid,
    LPSTR lpName,   // optional
    DWORD* cchName
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool LookupPrivilegeNameA(
    [MarshalAs(UnmanagedType.LPStr)] string lpSystemName,   // LPCSTR optional
    IntPtr lpLuid,   // LUID*
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpName,   // LPSTR optional, out
    ref uint cchName   // DWORD* in/out
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function LookupPrivilegeNameA(
    <MarshalAs(UnmanagedType.LPStr)> lpSystemName As String,   ' LPCSTR optional
    lpLuid As IntPtr,   ' LUID*
    <MarshalAs(UnmanagedType.LPStr)> lpName As System.Text.StringBuilder,   ' LPSTR optional, out
    ByRef cchName As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpSystemName : LPCSTR optional
' lpLuid : LUID*
' lpName : LPSTR optional, out
' cchName : DWORD* in/out
Declare PtrSafe Function LookupPrivilegeNameA Lib "advapi32" ( _
    ByVal lpSystemName As String, _
    ByVal lpLuid As LongPtr, _
    ByVal lpName As String, _
    ByRef cchName As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

LookupPrivilegeNameA = ctypes.windll.advapi32.LookupPrivilegeNameA
LookupPrivilegeNameA.restype = wintypes.BOOL
LookupPrivilegeNameA.argtypes = [
    wintypes.LPCSTR,  # lpSystemName : LPCSTR optional
    ctypes.c_void_p,  # lpLuid : LUID*
    wintypes.LPSTR,  # lpName : LPSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # cchName : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
LookupPrivilegeNameA = Fiddle::Function.new(
  lib['LookupPrivilegeNameA'],
  [
    Fiddle::TYPE_VOIDP,  # lpSystemName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # lpLuid : LUID*
    Fiddle::TYPE_VOIDP,  # lpName : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # cchName : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn LookupPrivilegeNameA(
        lpSystemName: *const u8,  // LPCSTR optional
        lpLuid: *mut LUID,  // LUID*
        lpName: *mut u8,  // LPSTR optional, out
        cchName: *mut u32  // DWORD* in/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 LookupPrivilegeNameA([MarshalAs(UnmanagedType.LPStr)] string lpSystemName, IntPtr lpLuid, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpName, ref uint cchName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_LookupPrivilegeNameA' -Namespace Win32 -PassThru
# $api::LookupPrivilegeNameA(lpSystemName, lpLuid, lpName, cchName)

#uselib "ADVAPI32.dll"
#func global LookupPrivilegeNameA "LookupPrivilegeNameA" sptr, sptr, sptr, sptr
; LookupPrivilegeNameA lpSystemName, varptr(lpLuid), varptr(lpName), varptr(cchName)   ; 戻り値は stat
; lpSystemName : LPCSTR optional -> "sptr"
; lpLuid : LUID* -> "sptr"
; lpName : LPSTR optional, out -> "sptr"
; cchName : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global LookupPrivilegeNameA "LookupPrivilegeNameA" str, var, var, var
; res = LookupPrivilegeNameA(lpSystemName, lpLuid, lpName, cchName)
; lpSystemName : LPCSTR optional -> "str"
; lpLuid : LUID* -> "var"
; lpName : LPSTR optional, out -> "var"
; cchName : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global LookupPrivilegeNameA "LookupPrivilegeNameA" str, sptr, sptr, sptr
; res = LookupPrivilegeNameA(lpSystemName, varptr(lpLuid), varptr(lpName), varptr(cchName))
; lpSystemName : LPCSTR optional -> "str"
; lpLuid : LUID* -> "sptr"
; lpName : LPSTR optional, out -> "sptr"
; cchName : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。