ホーム › Security › LookupPrivilegeDisplayNameA

LookupPrivilegeDisplayNameA

関数

特権名から人間可読の表示名を取得する(ANSI版)。

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

シグネチャ

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

BOOL LookupPrivilegeDisplayNameA(
    LPCSTR lpSystemName,   // optional
    LPCSTR lpName,
    LPSTR lpDisplayName,   // optional
    DWORD* cchDisplayName,
    DWORD* lpLanguageId
);

パラメーター

名前	型	方向	説明
lpSystemName	LPCSTR	inoptional	特権名を取得する対象システムの名前を指定する、null 終端文字列へのポインターです。null 文字列を指定した場合、関数はローカルシステム上で表示名を検索しようとします。
lpName	LPCSTR	in	Winnt.h で定義されている特権の名前を指定する、null 終端文字列へのポインターです。たとえば、このパラメーターには定数 SE_REMOTE_SHUTDOWN_NAME、またはそれに対応する文字列 "SeRemoteShutdownPrivilege" を指定できます。値の一覧については、Privilege Constants を参照してください。
lpDisplayName	LPSTR	outoptional	特権の表示名を表す null 終端文字列を受け取るバッファーへのポインターです。たとえば、lpName パラメーターが SE_REMOTE_SHUTDOWN_NAME の場合、特権の表示名は "Force shutdown from a remote system." になります。
cchDisplayName	DWORD*	inout	lpDisplayName バッファーのサイズを TCHAR 単位で指定する変数へのポインターです。関数が戻るとき、このパラメーターには終端の null 文字を含まない特権表示名の長さが格納されます。lpDisplayName パラメーターが指すバッファーが小さすぎる場合、この変数には必要なサイズが格納されます。
lpLanguageId	DWORD*	out	返される表示名の言語識別子を受け取る変数へのポインターです。

戻り値の型: BOOL

公式ドキュメント

指定された特権を表す表示名を取得します。(ANSI)

戻り値

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

関数が失敗した場合、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

LookupPrivilegeDisplayName 関数は、Winnt.h の Defined Privileges セクションで指定されている特権についてのみ表示名を取得します。

メモ

winbase.h ヘッダーは、LookupPrivilegeDisplayName を、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  (ANSI / -A)
#include <windows.h>

BOOL LookupPrivilegeDisplayNameA(
    LPCSTR lpSystemName,   // optional
    LPCSTR lpName,
    LPSTR lpDisplayName,   // optional
    DWORD* cchDisplayName,
    DWORD* lpLanguageId
);

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

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

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

import ctypes
from ctypes import wintypes

LookupPrivilegeDisplayNameA = ctypes.windll.advapi32.LookupPrivilegeDisplayNameA
LookupPrivilegeDisplayNameA.restype = wintypes.BOOL
LookupPrivilegeDisplayNameA.argtypes = [
    wintypes.LPCSTR,  # lpSystemName : LPCSTR optional
    wintypes.LPCSTR,  # lpName : LPCSTR
    wintypes.LPSTR,  # lpDisplayName : LPSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # cchDisplayName : DWORD* in/out
    ctypes.POINTER(wintypes.DWORD),  # lpLanguageId : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
LookupPrivilegeDisplayNameA = Fiddle::Function.new(
  lib['LookupPrivilegeDisplayNameA'],
  [
    Fiddle::TYPE_VOIDP,  # lpSystemName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # lpName : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpDisplayName : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # cchDisplayName : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # lpLanguageId : DWORD* out
  ],
  Fiddle::TYPE_INT)

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

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

出力引数:

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