次の方法で共有

RtmGetEnumRoutes 関数 (rtmv2.h)

  • [アーティクル]

RtmGetEnumRoutes 関数は、指定された列挙体内の次のルート セットを取得します。

構文

DWORD RtmGetEnumRoutes(
  [in]      RTM_ENTITY_HANDLE RtmRegHandle,
  [in]      RTM_ENUM_HANDLE   EnumHandle,
  [in, out] PUINT             NumRoutes,
  [out]     PRTM_ROUTE_HANDLE RouteHandles
);

パラメーター

[in] RtmRegHandle

RtmRegisterEntity の以前の呼び出しから取得したクライアントへのハンドル。

[in] EnumHandle

ルート列挙を処理します。

[in, out] NumRoutes

入力時に、NumRoutes は、RouteHandles で受信できるルートの最大数を指定する UINT 値へのポインターです。

出力時に、 NumRoutes はRouteHandles によって受信されたルートの実際の数を受け取ります。

[out] RouteHandles

入力時、 RouteHandles は RTM_ROUTE_INFO 構造体へのポインターです。

出力時に、 RouteHandles はルートへのハンドルの配列を受け取ります。

戻り値

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

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

値 意味
ERROR_INVALID_PARAMETER
 NumRoutes が指す値が、クライアントが 1 回の呼び出しで取得できるルートの最大数を超えています。 RTM_REGN_PROFILE、クライアントが 1 回の呼び出しで取得できるルートの最大数を確認します。
ERROR_NO_MORE_ITEMS
 列挙するルートはこれ以上ありません。
ERROR_NOT_ENOUGH_MEMORY
 この操作を完了するのに十分なメモリがありません。
 
 

注釈

ルートが不要になったら、 RtmReleaseRoutes を呼び出して解放します。

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

要件

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

こちらもご覧ください

RtmCreateRouteEnum

RtmDeleteEnumHandle

RtmReleaseRoutes