ホーム › Security.ExtensibleAuthenticationProtocol › IEAPProviderConfig

IEAPProviderConfig

COM

📘 Microsoft Learn (日本語) · English

IID66a2db19-d706-11d0-a37b-00c04fc9da04継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

EAP プロバイダー用の UI です。

メソッド 5

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT Initialize(LPWSTR pszMachineName, DWORD dwEapTypeId, UINT_PTR* puConnectionParam)

システムは、指定したコンピューターとの EAP 構成セッションを初期化するために Initialize メソッドを呼び出します。

pszMachineName	LPWSTR	in	EAP を構成する対象のコンピューター名を含む、null で終わる文字列へのポインター。文字列長に制限はありません。
dwEapTypeId	DWORD	in	構成セッションを初期化する対象の EAP を指定します。
puConnectionParam	UINT_PTR*	out	符号なし整数型変数へのポインター。正常に復帰した場合、この変数の値がこの構成セッションを識別します。

戻り値

関数が成功した場合、戻り値は S_OK である必要があります。

関数が失敗した場合、戻り値は次のいずれかのコードである必要があります。

戻り値	説明
E_FAIL	特定されないエラーです。
E_INVALIDARG	引数のいずれかが無効です。
E_OUTOFMEMORY	必要なメモリを割り当てられなかったため、メソッドが失敗しました。
E_UNEXPECTED	予期しないエラーが発生しました。

解説(Remarks)

構成 UI では、リモートコンピューター上の EAP プロバイダーをユーザーが構成できるようにする必要があります。リモートコンピューターへの接続は、Initialize の呼び出し中に確立してください。

IEAPProviderConfig を実装する DLL は、複数の認証プロトコルをサポートできます。dwEapTypeId パラメーターは、構成セッションを初期化する対象の認証プロトコルを指定します。

vtbl 4 HRESULT Uninitialize(DWORD dwEapTypeId, UINT_PTR uConnectionParam)

システムは、指定した EAP 構成セッションをシャットダウンするために Uninitialize メソッドを呼び出します。

dwEapTypeId	DWORD	in	構成セッションをシャットダウンする対象の EAP を指定します。
uConnectionParam	UINT_PTR	in	シャットダウンする構成セッションを指定します。

戻り値

関数が成功した場合、戻り値は S_OK である必要があります。

関数が失敗した場合、戻り値は次のいずれかのコードである必要があります。

戻り値	説明
E_FAIL	特定されないエラーです。
E_INVALIDARG	引数のいずれかが無効です。
E_OUTOFMEMORY	必要なメモリを割り当てられなかったため、メソッドが失敗しました。
E_UNEXPECTED	予期しないエラーが発生しました。

解説(Remarks)

構成 UI では、リモートコンピューター上の EAP プロバイダーをユーザーが構成できるようにする必要があります。リモートコンピューターへの接続は、Uninitialize の呼び出し中に削除してください。

IEAPProviderConfig を実装する DLL は、複数の認証プロトコルをサポートする場合があります。dwEapTypeId パラメーターは、構成セッションをシャットダウンする対象の認証プロトコルを指定します。

vtbl 5 HRESULT ServerInvokeConfigUI(DWORD dwEapTypeId, UINT_PTR uConnectionParam, HWND hWnd, UINT_PTR uReserved1, UINT_PTR uReserved2)

システムは、リモートアクセスクライアントとサーバー間の EAP 認証に関する構成ユーザーインターフェイスを起動するために ServerInvokeConfigUI メソッドを呼び出します。

dwEapTypeId	DWORD	in	構成ユーザーインターフェイスを起動する対象の EAP を指定します。
uConnectionParam	UINT_PTR	in	ユーザーインターフェイスを起動する対象の構成セッションを指定します。
hWnd	HWND	in	構成ユーザーインターフェイスの親ウィンドウへのハンドル。
uReserved1	UINT_PTR	in	このパラメーターは予約されており、0 にする必要があります。
uReserved2	UINT_PTR	in	このパラメーターは予約されており、0 にする必要があります。

戻り値

関数が成功した場合、戻り値は S_OK である必要があります。

関数が失敗した場合、戻り値は次のいずれかのコードである必要があります。

戻り値	説明
E_FAIL	特定されないエラーです。
E_INVALIDARG	引数のいずれかが無効です。
E_OUTOFMEMORY	必要なメモリを割り当てられなかったため、メソッドが失敗しました。
E_UNEXPECTED	予期しないエラーが発生しました。

解説(Remarks)

IEAPProviderConfig を実装する DLL は、複数の認証プロトコルをサポートする場合があります。dwEapTypeId パラメーターは、構成ユーザーインターフェイスを起動する対象の認証プロトコルを指定します。

vtbl 6 HRESULT RouterInvokeConfigUI(DWORD dwEapTypeId, UINT_PTR uConnectionParam, HWND hwndParent, DWORD dwFlags, BYTE* pConnectionDataIn, DWORD dwSizeOfConnectionDataIn, BYTE** ppConnectionDataOut, DWORD* pdwSizeOfConnectionDataOut)

システムは、2 つのルーター間の EAP 認証に関する構成ユーザーインターフェイスを起動するために RouterInvokeConfigUI メソッドを呼び出します。

dwEapTypeId	DWORD	in	構成ユーザーインターフェイスを起動する対象の EAP を指定します。
uConnectionParam	UINT_PTR	in	ユーザーインターフェイスを起動する対象の構成セッションを指定します。
hwndParent	HWND	in	構成ユーザーインターフェイスの親ウィンドウへのハンドル。
dwFlags	DWORD	in	RAS_EAP_FLAG_ROUTER フラグを指定します。このパラメーターに有効なフラグはこれのみです。認証が 2 つのルーター間で行われることを示します。このパラメーターには常にこのフラグが含まれます。
pConnectionDataIn	BYTE*	in	インターフェイスの現在の構成データへのポインター。
dwSizeOfConnectionDataIn	DWORD	in	pConnectionDataIn パラメーターが指す現在の構成データのサイズを指定します。
ppConnectionDataOut	BYTE**	out	インターフェイスの新しい構成データを格納するバッファーへのポインターへのポインター。
pdwSizeOfConnectionDataOut	DWORD*	out	新しい構成データのサイズを受け取る DWORD 型変数へのポインター。

戻り値

関数が成功した場合、戻り値は S_OK である必要があります。

関数が失敗した場合、戻り値は次のいずれかのコードである必要があります。

戻り値	説明
E_FAIL	特定されないエラーです。
E_INVALIDARG	引数のいずれかが無効です。
E_OUTOFMEMORY	必要なメモリを割り当てられなかったため、メソッドが失敗しました。
E_UNEXPECTED	予期しないエラーが発生しました。

vtbl 7 HRESULT RouterInvokeCredentialsUI(DWORD dwEapTypeId, UINT_PTR uConnectionParam, HWND hwndParent, DWORD dwFlags, BYTE* pConnectionDataIn, DWORD dwSizeOfConnectionDataIn, BYTE* pUserDataIn, DWORD dwSizeOfUserDataIn, BYTE** ppUserDataOut, DWORD* pdwSizeOfUserDataOut)

システムは、2 つのルーター間の EAP 認証に関する資格情報ユーザーインターフェイスを起動するために RouterInvokeCredentialsUI メソッドを呼び出します。

dwEapTypeId	DWORD	in	構成ユーザーインターフェイスを起動する対象の EAP を指定します。
uConnectionParam	UINT_PTR	in	ユーザーインターフェイスを起動する対象の構成セッションを指定します。
hwndParent	HWND	in	構成ユーザーインターフェイスの親ウィンドウへのハンドル。
dwFlags	DWORD	in	RAS_EAP_FLAG_ROUTER フラグを指定します。このパラメーターに有効なフラグはこれのみです。認証が 2 つのルーター間で行われることを示します。このパラメーターには常にこのフラグが含まれます。
pConnectionDataIn	BYTE*	in	インターフェイスの現在の構成データへのポインター。
dwSizeOfConnectionDataIn	DWORD	in	pConnectionDataIn パラメーターが指す現在の構成データのサイズを指定します。
pUserDataIn	BYTE*	in	インターフェイスの現在の資格情報データへのポインター。
dwSizeOfUserDataIn	DWORD	in	現在の資格情報データのサイズを指定します。
ppUserDataOut	BYTE**	out	インターフェイスの新しい資格情報データを受け取るバッファーへのポインターへのポインター。
pdwSizeOfUserDataOut	DWORD*	out	新しい資格情報データのサイズを受け取る DWORD 型変数へのポインター。

戻り値

関数が成功した場合、戻り値は S_OK である必要があります。

関数が失敗した場合、戻り値は次のいずれかのコードである必要があります。

戻り値	説明
E_FAIL	特定されないエラーです。
E_INVALIDARG	引数のいずれかが無効です。
E_OUTOFMEMORY	必要なメモリを割り当てられなかったため、メソッドが失敗しました。
E_UNEXPECTED	予期しないエラーが発生しました。

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

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数:

#define global IID_IEAPProviderConfig "{66A2DB19-D706-11D0-A37B-00C04FC9DA04}"
#usecom global IEAPProviderConfig IID_IEAPProviderConfig "{}"
#comfunc global IEAPProviderConfig_Initialize                 3 wstr,int,var
#comfunc global IEAPProviderConfig_Uninitialize               4 int,sptr
#comfunc global IEAPProviderConfig_ServerInvokeConfigUI       5 int,sptr,sptr,sptr,sptr
#comfunc global IEAPProviderConfig_RouterInvokeConfigUI       6 int,sptr,sptr,int,var,int,var,var
#comfunc global IEAPProviderConfig_RouterInvokeCredentialsUI  7 int,sptr,sptr,int,var,int,var,int,var,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IEAPProviderConfig "{66A2DB19-D706-11D0-A37B-00C04FC9DA04}"
#usecom global IEAPProviderConfig IID_IEAPProviderConfig "{}"
#comfunc global IEAPProviderConfig_Initialize                 3 wstr,int,sptr
#comfunc global IEAPProviderConfig_Uninitialize               4 int,sptr
#comfunc global IEAPProviderConfig_ServerInvokeConfigUI       5 int,sptr,sptr,sptr,sptr
#comfunc global IEAPProviderConfig_RouterInvokeConfigUI       6 int,sptr,sptr,int,sptr,int,sptr,sptr
#comfunc global IEAPProviderConfig_RouterInvokeCredentialsUI  7 int,sptr,sptr,int,sptr,int,sptr,int,sptr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。