ホーム › Security › LookupPrivilegeDisplayNameW

LookupPrivilegeDisplayNameW

関数

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

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

シグネチャ

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

BOOL LookupPrivilegeDisplayNameW(
    LPCWSTR lpSystemName,   // optional
    LPCWSTR lpName,
    LPWSTR lpDisplayName,   // optional
    DWORD* cchDisplayName,
    DWORD* lpLanguageId
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

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

メモ

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

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

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

' lpSystemName : LPCWSTR optional
' lpName : LPCWSTR
' lpDisplayName : LPWSTR optional, out
' cchDisplayName : DWORD* in/out
' lpLanguageId : DWORD* out
Declare PtrSafe Function LookupPrivilegeDisplayNameW Lib "advapi32" ( _
    ByVal lpSystemName As LongPtr, _
    ByVal lpName As LongPtr, _
    ByVal lpDisplayName As LongPtr, _
    ByRef cchDisplayName As Long, _
    ByRef lpLanguageId As Long) 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

LookupPrivilegeDisplayNameW = ctypes.windll.advapi32.LookupPrivilegeDisplayNameW
LookupPrivilegeDisplayNameW.restype = wintypes.BOOL
LookupPrivilegeDisplayNameW.argtypes = [
    wintypes.LPCWSTR,  # lpSystemName : LPCWSTR optional
    wintypes.LPCWSTR,  # lpName : LPCWSTR
    wintypes.LPWSTR,  # lpDisplayName : LPWSTR 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')
LookupPrivilegeDisplayNameW = Fiddle::Function.new(
  lib['LookupPrivilegeDisplayNameW'],
  [
    Fiddle::TYPE_VOIDP,  # lpSystemName : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # lpName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpDisplayName : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # cchDisplayName : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # lpLanguageId : DWORD* out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "advapi32")]
extern "system" {
    fn LookupPrivilegeDisplayNameW(
        lpSystemName: *const u16,  // LPCWSTR optional
        lpName: *const u16,  // LPCWSTR
        lpDisplayName: *mut u16,  // LPWSTR 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.Unicode, SetLastError = true)]
public static extern bool LookupPrivilegeDisplayNameW([MarshalAs(UnmanagedType.LPWStr)] string lpSystemName, [MarshalAs(UnmanagedType.LPWStr)] string lpName, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpDisplayName, ref uint cchDisplayName, out uint lpLanguageId);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_LookupPrivilegeDisplayNameW' -Namespace Win32 -PassThru
# $api::LookupPrivilegeDisplayNameW(lpSystemName, lpName, lpDisplayName, cchDisplayName, lpLanguageId)

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

出力引数:

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