ホーム › Security.Credentials › CredUIParseUserNameA

CredUIParseUserNameA

関数

ユーザー名をユーザー部分とドメイン部分に分解する。

DLLcredui.dll文字セットANSI (-A)呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

WIN32_ERROR CredUIParseUserNameA(
    LPCSTR userName,
    LPSTR user,
    DWORD userBufferSize,
    LPSTR domain,
    DWORD domainBufferSize
);

パラメーター

名前	型	方向	説明
userName	LPCSTR	in	解析対象のユーザー名を含む null 終端文字列へのポインター。名前は UPN 形式、ダウンレベル形式、または証明書のいずれかである必要があります。通常、pszUserName は CredUIPromptForCredentials または CredUICmdLinePromptForCredentials から取得されます。
user	LPSTR	out	ユーザーアカウント名を受け取る null 終端文字列へのポインター。
userBufferSize	DWORD	in	pszUser 文字列に書き込む最大文字数(終端の null 文字を含む)。注意 CREDUI_MAX_USERNAME_LENGTH には終端の null 文字は含まれません。
domain	LPSTR	out	ドメイン名を受け取る null 終端文字列へのポインター。pszUserName が証明書を指定している場合、pszDomain は NULL になります。
domainBufferSize	DWORD	in	pszDomain 文字列に書き込む最大文字数(終端の null 文字を含む)。注意 CREDUI_MAX_DOMAIN_TARGET_LENGTH には終端の null 文字は含まれません。

戻り値の型: WIN32_ERROR

公式ドキュメント

CredUIParseUserName 関数は、完全修飾ユーザー名からドメインとユーザーアカウント名を抽出します。(ANSI)

戻り値

この関数は以下を返します。

NO_ERROR
ユーザー名が有効です。
ERROR_INVALID_ACCOUNT_NAME
ユーザー名が無効です。
ERROR_INSUFFICIENT_BUFFER
いずれかのバッファーが小さすぎます。
ERROR_INVALID_PARAMETER
- ulUserMaxChars または ulDomainMaxChars が 0 です。
- pszUserName、pszUser、または pszDomain が NULL です。

解説(Remarks)

この関数は、 CredUIPromptForCredentials および CredUICmdLinePromptForCredentials 関数が返すユーザー名情報を解析し、結果として得られる資格情報を、ユーザー名とドメインを別々の文字列として必要とする LogonUser などの関数に渡せるようにします。

次の形式がサポートされています。

<MarshalledCredentialReference>
CredIsMarshaledCredential で定義されるマーシャリングされた資格情報参照です。このような資格情報は User パラメーターで返されます。Domain パラメーターには空の文字列が設定されます。
<DomainName>\<UserName>
<UserName> が User パラメーターで返され、<DomainName> が Domain パラメーターで返されます。UserName にバックスラッシュ (\) が含まれる場合、名前はこの構文を持つと見なされます。
<UserName>@<DNSDomainName>
文字列全体が User パラメーターで返されます。Domain パラメーターには空の文字列が設定されます。この構文では、<UserName> に @ を含めることができる一方で <DNSDomainName> には含められないため、文字列内の最後の @ が使用されます。

メモ

wincred.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして CredUIParseUserName を定義します。エンコード非依存のエイリアスの使用と、エンコード非依存でないコードを混在させると、不一致が生じてコンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規則を参照してください。

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

各言語での呼び出し定義

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

WIN32_ERROR CredUIParseUserNameA(
    LPCSTR userName,
    LPSTR user,
    DWORD userBufferSize,
    LPSTR domain,
    DWORD domainBufferSize
);

[DllImport("credui.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint CredUIParseUserNameA(
    [MarshalAs(UnmanagedType.LPStr)] string userName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder user,   // LPSTR out
    uint userBufferSize,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder domain,   // LPSTR out
    uint domainBufferSize   // DWORD
);

<DllImport("credui.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function CredUIParseUserNameA(
    <MarshalAs(UnmanagedType.LPStr)> userName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> user As System.Text.StringBuilder,   ' LPSTR out
    userBufferSize As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> domain As System.Text.StringBuilder,   ' LPSTR out
    domainBufferSize As UInteger   ' DWORD
) As UInteger
End Function

' userName : LPCSTR
' user : LPSTR out
' userBufferSize : DWORD
' domain : LPSTR out
' domainBufferSize : DWORD
Declare PtrSafe Function CredUIParseUserNameA Lib "credui" ( _
    ByVal userName As String, _
    ByVal user As String, _
    ByVal userBufferSize As Long, _
    ByVal domain As String, _
    ByVal domainBufferSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CredUIParseUserNameA = ctypes.windll.credui.CredUIParseUserNameA
CredUIParseUserNameA.restype = wintypes.DWORD
CredUIParseUserNameA.argtypes = [
    wintypes.LPCSTR,  # userName : LPCSTR
    wintypes.LPSTR,  # user : LPSTR out
    wintypes.DWORD,  # userBufferSize : DWORD
    wintypes.LPSTR,  # domain : LPSTR out
    wintypes.DWORD,  # domainBufferSize : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('credui.dll')
CredUIParseUserNameA = Fiddle::Function.new(
  lib['CredUIParseUserNameA'],
  [
    Fiddle::TYPE_VOIDP,  # userName : LPCSTR
    Fiddle::TYPE_VOIDP,  # user : LPSTR out
    -Fiddle::TYPE_INT,  # userBufferSize : DWORD
    Fiddle::TYPE_VOIDP,  # domain : LPSTR out
    -Fiddle::TYPE_INT,  # domainBufferSize : DWORD
  ],
  -Fiddle::TYPE_INT)

#[link(name = "credui")]
extern "system" {
    fn CredUIParseUserNameA(
        userName: *const u8,  // LPCSTR
        user: *mut u8,  // LPSTR out
        userBufferSize: u32,  // DWORD
        domain: *mut u8,  // LPSTR out
        domainBufferSize: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("credui.dll", CharSet = CharSet.Ansi)]
public static extern uint CredUIParseUserNameA([MarshalAs(UnmanagedType.LPStr)] string userName, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder user, uint userBufferSize, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder domain, uint domainBufferSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'credui_CredUIParseUserNameA' -Namespace Win32 -PassThru
# $api::CredUIParseUserNameA(userName, user, userBufferSize, domain, domainBufferSize)

#uselib "credui.dll"
#func global CredUIParseUserNameA "CredUIParseUserNameA" sptr, sptr, sptr, sptr, sptr
; CredUIParseUserNameA userName, varptr(user), userBufferSize, varptr(domain), domainBufferSize   ; 戻り値は stat
; userName : LPCSTR -> "sptr"
; user : LPSTR out -> "sptr"
; userBufferSize : DWORD -> "sptr"
; domain : LPSTR out -> "sptr"
; domainBufferSize : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "credui.dll"
#cfunc global CredUIParseUserNameA "CredUIParseUserNameA" str, var, int, var, int
; res = CredUIParseUserNameA(userName, user, userBufferSize, domain, domainBufferSize)
; userName : LPCSTR -> "str"
; user : LPSTR out -> "var"
; userBufferSize : DWORD -> "int"
; domain : LPSTR out -> "var"
; domainBufferSize : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "credui.dll"
#cfunc global CredUIParseUserNameA "CredUIParseUserNameA" str, sptr, int, sptr, int
; res = CredUIParseUserNameA(userName, varptr(user), userBufferSize, varptr(domain), domainBufferSize)
; userName : LPCSTR -> "str"
; user : LPSTR out -> "sptr"
; userBufferSize : DWORD -> "int"
; domain : LPSTR out -> "sptr"
; domainBufferSize : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。