ホーム › NetworkManagement.Rras › RasGetEapUserIdentityA

RasGetEapUserIdentityA

関数

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

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

シグネチャ

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

DWORD RasGetEapUserIdentityA(
    LPCSTR pszPhonebook,   // optional
    LPCSTR pszEntry,
    DWORD dwFlags,
    HWND hwnd,
    RASEAPUSERIDENTITYA** ppRasEapUserIdentity
);

パラメーター

名前

型

方向

説明

pszPhonebook

LPCSTR

inoptional

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

pszEntry

LPCSTR

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

dwFlags

DWORD

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

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

hwnd

HWND

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

ppRasEapUserIdentity

RASEAPUSERIDENTITYA**

out

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

戻り値の型: DWORD

公式ドキュメント

RasGetEapUserIdentity 関数は、現在のユーザーの ID 情報を取得します。この情報は、拡張認証プロトコル (EAP) を必要とする電話帳エントリで RasDial を呼び出すときに使用します。(ANSI)

戻り値

関数が成功すると、戻り値は 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 であるものの、プロトコルが標準の Windows NT/Windows 2000 資格情報ダイアログを使用してユーザー ID 情報を取得します。いずれの場合も、呼び出し元は EAP の ID 情報を RasDial に渡す必要はありません。
ERROR_RASMAN_CANNOT_INITIALIZE	リモートアクセスサービスの初期化に失敗しました。
Other	返されたエラーコードに対応するシステムエラーメッセージを取得するには、 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 を定義します。エンコーディング中立のエイリアスを、エンコーディング中立でないコードと混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、関数プロトタイプの規則を参照してください。

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

各言語での呼び出し定義

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

DWORD RasGetEapUserIdentityA(
    LPCSTR pszPhonebook,   // optional
    LPCSTR pszEntry,
    DWORD dwFlags,
    HWND hwnd,
    RASEAPUSERIDENTITYA** ppRasEapUserIdentity
);

[DllImport("RASAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint RasGetEapUserIdentityA(
    [MarshalAs(UnmanagedType.LPStr)] string pszPhonebook,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string pszEntry,   // LPCSTR
    uint dwFlags,   // DWORD
    IntPtr hwnd,   // HWND
    IntPtr ppRasEapUserIdentity   // RASEAPUSERIDENTITYA** out
);

<DllImport("RASAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function RasGetEapUserIdentityA(
    <MarshalAs(UnmanagedType.LPStr)> pszPhonebook As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> pszEntry As String,   ' LPCSTR
    dwFlags As UInteger,   ' DWORD
    hwnd As IntPtr,   ' HWND
    ppRasEapUserIdentity As IntPtr   ' RASEAPUSERIDENTITYA** out
) As UInteger
End Function

' pszPhonebook : LPCSTR optional
' pszEntry : LPCSTR
' dwFlags : DWORD
' hwnd : HWND
' ppRasEapUserIdentity : RASEAPUSERIDENTITYA** out
Declare PtrSafe Function RasGetEapUserIdentityA Lib "rasapi32" ( _
    ByVal pszPhonebook As String, _
    ByVal pszEntry As String, _
    ByVal dwFlags As Long, _
    ByVal hwnd As LongPtr, _
    ByVal ppRasEapUserIdentity As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('RASAPI32.dll')
RasGetEapUserIdentityA = Fiddle::Function.new(
  lib['RasGetEapUserIdentityA'],
  [
    Fiddle::TYPE_VOIDP,  # pszPhonebook : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # pszEntry : LPCSTR
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # hwnd : HWND
    Fiddle::TYPE_VOIDP,  # ppRasEapUserIdentity : RASEAPUSERIDENTITYA** out
  ],
  -Fiddle::TYPE_INT)

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

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

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

出力引数:

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