RtmGetRouteInfo 関数 (rtmv2.h)
RtmGetRouteInfo 関数は、指定されたルートの情報を返します。
構文
DWORD RtmGetRouteInfo(
[in] RTM_ENTITY_HANDLE RtmRegHandle,
[in] RTM_ROUTE_HANDLE RouteHandle,
[out] PRTM_ROUTE_INFO RouteInfo,
[out] PRTM_NET_ADDRESS DestAddress
);
パラメーター
[in] RtmRegHandle
RtmRegisterEntity の以前の呼び出しから取得したクライアントへのハンドル。
[in] RouteHandle
検索するルートを処理します。
[out] RouteInfo
ポインターを返す必要がある場合: 入力時、 RouteInfo は NULL へのポインターです。 出力時に、 RouteInfo はルートへのポインターを受け取ります。それ以外の場合、 RouteInfo は変更されません。
ポインターを返す必要がない場合: 入力時、 RouteInfo は NULL です。
[out] DestAddress
ポインターを返す必要がある場合: 入力時、 DestAddress は NULL へのポインターです。 出力時に、 DestAddress は宛先の RTM_NET_ADDRESS 構造体へのポインターを受け取ります。それ以外の場合、 DestAddress は変更されません。
ポインターを返す必要がない場合: 入力時、 DestAddress は NULL です。
戻り値
関数が成功した場合、戻り値はNO_ERROR。
関数が失敗した場合、戻り値は次のいずれかのエラー コードになります。
| 値 | 意味 |
|---|---|
|
ハンドルが正しくありません。 |
注釈
ルートが不要になったら、 RtmReleaseRouteInfo を呼び出して解放します。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | サポートなし |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | rtmv2.h |
| Library | Rtm.lib |
| [DLL] | Rtm.dll |