PGET_INTERFACE_INFO コールバック関数 (routprot.h)
GetInterfaceInfo 関数は、特定のインターフェイスのルーティング プロトコルによって保持される構成情報を取得します。
構文
PGET_INTERFACE_INFO PgetInterfaceInfo;
DWORD PgetInterfaceInfo(
[in] ULONG InterfaceIndex,
[in] PVOID InterfaceInfo,
[in, out] PULONG BufferSize,
[in] PULONG StructureVersion,
[in] PULONG StructureSize,
[in] PULONG StructureCount
)
{...}
パラメーター
[in] InterfaceIndex
ルータで設定されるインターフェイスのセットのインターフェイスを指定します。
[in] InterfaceInfo
インターフェイスに関連付けられているプロトコル定義の構成情報を受け取るバッファーへのポインター。 この情報は、ルーティング プロトコルに対してプライベートです。
[in, out] BufferSize
DWORD 変数へのポインター。
入力時: この変数は、構成情報を受信するために提供されるバッファーのサイズをバイト単位で指定します。
出力時: この変数は、バッファーに配置されたデータのサイズ (バイト単位) を受け取ります。 初期サイズが十分な大きさではなかった場合、この変数にはすべてのデータを保持するために必要なサイズが含まれます。
[in] StructureVersion
InterfaceInfo パラメーターによって指される情報構造体のバージョンを指定します。 場合によっては、これはルーティング プロトコルのバージョンと同じです。
[in] StructureSize
InterfaceInfo パラメーターによって指される各情報構造体のサイズを指定します。 一部の情報構造体には可変長メンバーが含まれているので、ルーティング プロトコルは必ずしもバージョンからの情報のサイズを決定できるとは限りません。
[in] StructureCount
InterfaceInfo パラメーターによって指される情報構造体の数を指定します。 このパラメーターは常に 1 つです。
戻り値
関数が成功した場合、戻り値はNO_ERROR。
関数が失敗した場合、戻り値は次のいずれかのエラー コードになります。
値 | 説明 |
---|---|
|
情報を取得できませんでした。 |
|
InterfaceIndex パラメーターが無効であるか (たとえば、そのインデックスにインターフェイスが存在しない)、InterfaceInfoSize パラメーターが NULL です。 |
|
指定された出力バッファーのサイズが、要求された情報を保持するのに十分な大きさではありません。 必要なサイズは、InterfaceInfoSize が指す DWORD 変数で返されます。 |
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | サポートなし |
サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
対象プラットフォーム | Windows |
ヘッダー | routprot.h |