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。

如果函式失敗，傳回值就是下列其中一個錯誤碼。

備註

當不再需要列舉句柄時，請呼叫 RtmDeleteEnumHandle 來釋放它。

如需使用此函式的範例程式代碼，請參閱 使用 Client-Specific 路由清單。

規格需求

另請參閱

RtmDeleteEnumHandle

RtmGetListEnumRoutes