ホーム › NetworkManagement.Rras › RasGetEapUserIdentityW

RasGetEapUserIdentityW

関数

EAP認証で使用するユーザーIDを取得する(Unicode版)。

DLLRASAPI32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD RasGetEapUserIdentityW(
    LPCWSTR pszPhonebook,   // optional
    LPCWSTR pszEntry,
    DWORD dwFlags,
    HWND hwnd,
    RASEAPUSERIDENTITYW** ppRasEapUserIdentity
);

パラメーター

名前

型

方向

説明

pszPhonebook

LPCWSTR

inoptional

電話帳 (PBK) ファイルの完全パスを指定する null 終端文字列へのポインター。このパラメーターが NULL の場合、関数はシステム電話帳を使用します。

pszEntry

LPCWSTR

既存のエントリ名を指定する null 終端文字列へのポインター。

dwFlags

DWORD

認証処理を限定する次のフラグを 0 個以上指定します。

フラグ	意味
RASEAPF_NonInteractive	認証プロトコルがグラフィカルユーザーインターフェイスを表示しないように指定します。このフラグが指定されていない場合、プロトコルはユーザーインターフェイスを表示してもかまいません。
RASEAPF_Logon	ユーザーデータを WinLogon から取得することを指定します。
RASEAPF_Preview	ダイヤルする前に、ユーザーに ID 情報の入力を求めることを指定します。

hwnd

HWND

UI ダイアログの親ウィンドウへのハンドル。fInvokeUI パラメーターが FALSE の場合、hwnd は NULL にする必要があります。

ppRasEapUserIdentity

RASEAPUSERIDENTITYW**

out

呼び出しが成功して戻ったときに、EAP ユーザー ID 情報を格納する RASEAPUSERIDENTITY 構造体のアドレスを受け取るポインターへのポインター。 RasGetEapUserIdentity は RASEAPUSERIDENTITY 構造体用のメモリバッファーを割り当てます。このメモリは RasFreeEapUserIdentity を呼び出して解放してください。

戻り値の型: DWORD

公式ドキュメント

RasGetEapUserIdentity 関数は、現在のユーザーの ID 情報を取得します。この情報は、Extensible Authentication Protocol (EAP) を必要とする電話帳エントリを指定して RasDial を呼び出すときに使用します。(Unicode)

戻り値

関数が成功した場合、戻り値は ERROR_SUCCESS です。

関数が失敗した場合、戻り値は次のいずれかのエラーコード、または Routing and Remote Access Error Codes もしくは Winerror.h の値です。

値	意味
E_INVALID_ARG	pcbEapUserIdentity パラメーターが NULL です。
ERROR_INTERACTIVE_MODE	関数が RASEAPF_NonInteractive フラグを指定して呼び出されました。しかし、必要な ID 情報をユーザーから取得するために、認証プロトコルは UI を表示する必要があります。
ERROR_INVALID_FUNCTION_FOR_ENTRY	この電話帳エントリの認証方法が EAP ではないか、認証方法は EAP であるものの、プロトコルがユーザー ID 情報の取得に標準の Windows NT/Windows 2000 資格情報ダイアログを使用しています。いずれの場合も、呼び出し元は EAP ID 情報を RasDial に渡す必要はありません。
ERROR_RASMAN_CANNOT_INITIALIZE	リモートアクセスサービスを正しく初期化できませんでした。
その他	返されたエラーコードに対応するシステムエラーメッセージを取得するには、 FormatMessage を使用します。

解説(Remarks)

RasGetEapUserIdentity は、RAS 関数の RasGetEapUserData と EAP 関数の RasEapGetIdentity を呼び出します。RasEapGetIdentity は認証プロトコルによって実装されます。

関数が成功した場合、つまり戻り値が NO_ERROR の場合、呼び出し元は ppRasEapUserIdentity パラメーターが指す RASEAPUSERIDENTITY 構造体から EAP ID 情報を、 RasDial の呼び出しで使用する RASDIALPARAMS 構造体および RASDIALEXTENSIONS 構造体にコピーする必要があります。

開発中のリモートアクセスアプリケーションがグラフィカルユーザーインターフェイスを持つ場合、 RasGetEapUserIdentity の呼び出し元は RASEAPF_NonInteractive フラグを指定しないでください。アプリケーションがコマンドラインユーザーインターフェイスの場合は、認証プロトコルによるグラフィカルユーザーインターフェイスの表示を防ぐために、呼び出し元が RASEAPF_NonInteractive フラグを指定するとよい場合があります。

メモ

ras.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして RasGetEapUserIdentity を定義します。エンコーディング中立のエイリアスを、エンコーディング中立でないコードと混在させて使用すると、不一致が生じてコンパイルエラーまたは実行時エラーの原因となることがあります。詳細については、「Conventions for Function Prototypes」を参照してください。

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

各言語での呼び出し定義

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

DWORD RasGetEapUserIdentityW(
    LPCWSTR pszPhonebook,   // optional
    LPCWSTR pszEntry,
    DWORD dwFlags,
    HWND hwnd,
    RASEAPUSERIDENTITYW** ppRasEapUserIdentity
);

[DllImport("RASAPI32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint RasGetEapUserIdentityW(
    [MarshalAs(UnmanagedType.LPWStr)] string pszPhonebook,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string pszEntry,   // LPCWSTR
    uint dwFlags,   // DWORD
    IntPtr hwnd,   // HWND
    IntPtr ppRasEapUserIdentity   // RASEAPUSERIDENTITYW** out
);

<DllImport("RASAPI32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function RasGetEapUserIdentityW(
    <MarshalAs(UnmanagedType.LPWStr)> pszPhonebook As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> pszEntry As String,   ' LPCWSTR
    dwFlags As UInteger,   ' DWORD
    hwnd As IntPtr,   ' HWND
    ppRasEapUserIdentity As IntPtr   ' RASEAPUSERIDENTITYW** out
) As UInteger
End Function

' pszPhonebook : LPCWSTR optional
' pszEntry : LPCWSTR
' dwFlags : DWORD
' hwnd : HWND
' ppRasEapUserIdentity : RASEAPUSERIDENTITYW** out
Declare PtrSafe Function RasGetEapUserIdentityW Lib "rasapi32" ( _
    ByVal pszPhonebook As LongPtr, _
    ByVal pszEntry As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal hwnd As LongPtr, _
    ByVal ppRasEapUserIdentity As LongPtr) 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

RasGetEapUserIdentityW = ctypes.windll.rasapi32.RasGetEapUserIdentityW
RasGetEapUserIdentityW.restype = wintypes.DWORD
RasGetEapUserIdentityW.argtypes = [
    wintypes.LPCWSTR,  # pszPhonebook : LPCWSTR optional
    wintypes.LPCWSTR,  # pszEntry : LPCWSTR
    wintypes.DWORD,  # dwFlags : DWORD
    wintypes.HANDLE,  # hwnd : HWND
    ctypes.c_void_p,  # ppRasEapUserIdentity : RASEAPUSERIDENTITYW** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('RASAPI32.dll')
RasGetEapUserIdentityW = Fiddle::Function.new(
  lib['RasGetEapUserIdentityW'],
  [
    Fiddle::TYPE_VOIDP,  # pszPhonebook : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # pszEntry : LPCWSTR
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # hwnd : HWND
    Fiddle::TYPE_VOIDP,  # ppRasEapUserIdentity : RASEAPUSERIDENTITYW** out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "rasapi32")]
extern "system" {
    fn RasGetEapUserIdentityW(
        pszPhonebook: *const u16,  // LPCWSTR optional
        pszEntry: *const u16,  // LPCWSTR
        dwFlags: u32,  // DWORD
        hwnd: *mut core::ffi::c_void,  // HWND
        ppRasEapUserIdentity: *mut *mut RASEAPUSERIDENTITYW  // RASEAPUSERIDENTITYW** out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("RASAPI32.dll", CharSet = CharSet.Unicode)]
public static extern uint RasGetEapUserIdentityW([MarshalAs(UnmanagedType.LPWStr)] string pszPhonebook, [MarshalAs(UnmanagedType.LPWStr)] string pszEntry, uint dwFlags, IntPtr hwnd, IntPtr ppRasEapUserIdentity);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RASAPI32_RasGetEapUserIdentityW' -Namespace Win32 -PassThru
# $api::RasGetEapUserIdentityW(pszPhonebook, pszEntry, dwFlags, hwnd, ppRasEapUserIdentity)

#uselib "RASAPI32.dll"
#func global RasGetEapUserIdentityW "RasGetEapUserIdentityW" wptr, wptr, wptr, wptr, wptr
; RasGetEapUserIdentityW pszPhonebook, pszEntry, dwFlags, hwnd, varptr(ppRasEapUserIdentity)   ; 戻り値は stat
; pszPhonebook : LPCWSTR optional -> "wptr"
; pszEntry : LPCWSTR -> "wptr"
; dwFlags : DWORD -> "wptr"
; hwnd : HWND -> "wptr"
; ppRasEapUserIdentity : RASEAPUSERIDENTITYW** out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "RASAPI32.dll"
#cfunc global RasGetEapUserIdentityW "RasGetEapUserIdentityW" wstr, wstr, int, sptr, var
; res = RasGetEapUserIdentityW(pszPhonebook, pszEntry, dwFlags, hwnd, ppRasEapUserIdentity)
; pszPhonebook : LPCWSTR optional -> "wstr"
; pszEntry : LPCWSTR -> "wstr"
; dwFlags : DWORD -> "int"
; hwnd : HWND -> "sptr"
; ppRasEapUserIdentity : RASEAPUSERIDENTITYW** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "RASAPI32.dll"
#cfunc global RasGetEapUserIdentityW "RasGetEapUserIdentityW" wstr, wstr, int, sptr, sptr
; res = RasGetEapUserIdentityW(pszPhonebook, pszEntry, dwFlags, hwnd, varptr(ppRasEapUserIdentity))
; pszPhonebook : LPCWSTR optional -> "wstr"
; pszEntry : LPCWSTR -> "wstr"
; dwFlags : DWORD -> "int"
; hwnd : HWND -> "sptr"
; ppRasEapUserIdentity : RASEAPUSERIDENTITYW** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。