RtmFindNextHop 関数 (rtmv2.h)

[アーティクル]
08/25/2023

RtmFindNextHop 関数は、クライアントのネクストホップリストで特定のネクストホップを検索します。

構文

DWORD RtmFindNextHop(
  [in]  RTM_ENTITY_HANDLE   RtmRegHandle,
  [in]  PRTM_NEXTHOP_INFO   NextHopInfo,
  [out] PRTM_NEXTHOP_HANDLE NextHopHandle,
  [out] PRTM_NEXTHOP_INFO   *NextHopPointer
);

パラメーター

[in] RtmRegHandle

RtmRegisterEntity の以前の呼び出しから取得したクライアントを処理します。

[in] NextHopInfo

検索する次ホップを識別する情報を含むRTM_NEXTHOP_INFO構造体へのポインター。 NextHopAddress メンバーと InterfaceIndex メンバーを使用して、検索する次ホップを識別します。

[out] NextHopHandle

ハンドルを返す必要がある場合: 入力時、 NextHopPointer は NULL へのポインターです。出力時に、クライアントが次ホップを所有している場合、 NextHopPointer は 次ホップハンドルへのポインターを受け取ります。それ以外の場合、 NextHopPointer は変更されません。

ハンドルを返す必要がない場合: 入力時、 NextHopPointer は NULL です。

[out] NextHopPointer

ポインターを返す必要がある場合: 入力時、 NextHopPointer は NULL へのポインターです。出力時に、クライアントが次ホップを所有している場合、 NextHopPointer は 次ホップへのポインターを受け取ります。それ以外の場合、 NextHopPointer は変更されません。

ポインターを返す必要がない場合: 入力時、 NextHopPointer は NULL です。

戻り値

関数が成功した場合、戻り値はNO_ERROR。

関数が失敗した場合、戻り値は次のいずれかのエラーコードになります。

値	意味
ERROR_ACCESS_DENIED	呼び出し元のクライアントは、この次ホップを所有していません。
ERROR_NOT_FOUND	指定された次ホップが見つかりませんでした。

注釈

NextHopPointer は、クライアントが NextHopHandle を解放していない限り有効です。

要件

要件	値
サポートされている最小のクライアント	サポートなし
サポートされている最小のサーバー	Windows 2000 Server [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	rtmv2.h
Library	Rtm.lib
[DLL]	Rtm.dll