LookupPrivilegeDisplayNameA 関数 (winbase.h)
LookupPrivilegeDisplayName 関数は、指定された特権を表す表示名を取得します。
構文
BOOL LookupPrivilegeDisplayNameA(
[in, optional] LPCSTR lpSystemName,
[in] LPCSTR lpName,
[out, optional] LPSTR lpDisplayName,
[in, out] LPDWORD cchDisplayName,
[out] LPDWORD lpLanguageId
);
パラメーター
[in, optional] lpSystemName
特権名を取得するシステムの名前を指定する null で終わる文字列へのポインター。 null 文字列が指定されている場合、関数はローカル システムで表示名の検索を試みます。
[in] lpName
Winnt.h で定義されている特権の名前を指定する null で終わる文字列へのポインター。 たとえば、このパラメーターでは、定数、SE_REMOTE_SHUTDOWN_NAME、またはその対応する文字列 "SeRemoteShutdownPrivilege" を指定できます。 値の一覧については、「 特権定数」を参照してください。
[out, optional] lpDisplayName
特権表示名を指定する null で終わる文字列を受け取るバッファーへのポインター。 たとえば、 lpName パラメーターがSE_REMOTE_SHUTDOWN_NAMEの場合、特権表示名は "リモート システムから強制的にシャットダウン" になります。
[in, out] cchDisplayName
lpDisplayName バッファーのサイズを TCHAR単位で指定する変数へのポインター。 関数が戻るときに、このパラメーターには特権表示名の長さが含まれます。終端の null 文字は含まれません。 lpDisplayName パラメーターが指すバッファーが小さすぎる場合、この変数には必要なサイズが含まれます。
[out] lpLanguageId
返された表示名の言語識別子を受け取る変数へのポインター。
戻り値
関数が成功すると、戻り値は 0 以外になります。
関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。
解説
LookupPrivilegeDisplayName 関数は、Winnt.h の [定義済み特権] セクションで指定された特権の表示名のみを取得します。
注意
winbase.h ヘッダーは、LookupPrivilegeDisplayName をエイリアスとして定義し、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
| サポートされている最小のクライアント | Windows XP [デスクトップ アプリ | UWP アプリ] |
| サポートされている最小のサーバー | Windows Server 2003 [デスクトップ アプリのみ | UWP アプリ] |
| 対象プラットフォーム | Windows |
| ヘッダー | winbase.h (Windows.h を含む) |
| Library | Advapi32.lib |
| [DLL] | Advapi32.dll |