RtmGetDestInfo 関数 (rtmv2.h)
RtmGetDestInfo 関数は、変換先に関する情報を返します。
構文
DWORD RtmGetDestInfo(
[in] RTM_ENTITY_HANDLE RtmRegHandle,
[in] RTM_DEST_HANDLE DestHandle,
[in] ULONG ProtocolId,
[in] RTM_VIEW_SET TargetViews,
[out] PRTM_DEST_INFO DestInfo
);
パラメーター
[in] RtmRegHandle
RtmRegisterEntity の以前の呼び出しから取得したクライアントへのハンドル。
[in] DestHandle
情報を返す宛先を処理します。
[in] ProtocolId
プロトコル識別子を指定します。 ProtocolID は検索条件の一部ではありません。 ルーティング テーブル マネージャーは、この識別子を使用して、返すルート情報を決定します。 たとえば、クライアントが RIP プロトコル識別子を指定した場合、非 RIP ルートが宛先への最適なルートである場合でも、最適な RIP ルートが返されます。
ルートを所有するプロトコルに関係なく、ルートを返すRTM_BEST_PROTOCOLを指定します。 呼び出し元のプロトコルに最適なルートを返すには、RTM_THIS_PROTOCOLを指定します。
[in] TargetViews
情報を返すビューを指定します。 クライアントがRTM_VIEW_MASK_ANYを指定した場合は、すべてのビューから宛先情報が返されます。ただし、ビュー固有の情報は返されません。
[out] DestInfo
入力時、 DestInfo は RTM_DEST_INFO 構造体へのポインターです。
出力時に、 DestInfo には要求された宛先情報が入力されます。
戻り値
関数が成功した場合、戻り値はNO_ERROR。
関数が失敗した場合、戻り値は次のいずれかのエラー コードになります。
値 | 意味 |
---|---|
|
ハンドルが正しくありません。 |
注釈
DestInfo によって指される構造体は、可変サイズの構造体です。 クライアントが TargetViews を使用して複数のビューを指定する場合、 ビューごとに DestInfo のサイズが大きくなります。 この関数を呼び出す前に割り当てる DestInfo 構造体の大きさを確認するには、RTM_SIZE_OF_DEST_INFO マクロを使用します。 RTM_SIZE_OF_DEST_INFOするパラメーターとして TargetViews に指定された値を使用します。
DestInfo バッファーを解放するには、RtmReleaseDestInfo を使用します。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | サポートなし |
サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
対象プラットフォーム | Windows |
ヘッダー | rtmv2.h |
Library | Rtm.lib |
[DLL] | Rtm.dll |