RtmCreateRouteListEnum 関数 (rtmv2.h)

RtmCreateRouteListEnum 関数は、指定されたルート リストにルートの列挙を作成します。

構文

DWORD RtmCreateRouteListEnum(
  [in]  RTM_ENTITY_HANDLE     RtmRegHandle,
  [in]  RTM_ROUTE_LIST_HANDLE RouteListHandle,
  [out] PRTM_ENUM_HANDLE      RtmEnumHandle
);

パラメーター

[in] RtmRegHandle

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

[in] RouteListHandle

RtmCreateRouteList の以前の呼び出しから取得したを列挙するルート リストを処理します。

[out] RtmEnumHandle

入力時、 RtmEnumHandle は NULL へのポインターです。

出力時に、 RtmEnumHandle は列挙へのハンドルへのポインターを受け取ります。 ルートの一覧を列挙する関数に対する後続のすべての呼び出しで、このハンドルを使用します。

戻り値

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

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

値	意味
ERROR_NOT_ENOUGH_MEMORY	この操作を完了するのに十分なメモリがありません。

 

 

注釈

列挙ハンドルが不要になったら、 RtmDeleteEnumHandle を呼び出して解放します。

この関数を使用するサンプル コードについては、「 Client-Specific ルート リストを使用する」を参照してください。

要件

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

こちらもご覧ください

RtmDeleteEnumHandle

RtmGetListEnumRoutes