共用方式為

RtmGetListEnumRoutes 函式 (rtmv2.h)

  • 發行項

RtmGetListEnumRoutes 函式會在指定的路由清單中列舉一組路由。

語法

DWORD RtmGetListEnumRoutes(
  [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 是 UINT 值的指標，指定 RouteHandles 可接收的路由數目上限。

輸出時， NumRoutes 會接收 RouteHandles 所接收的實際路由數目。

[out] RouteHandles

在輸入時， DestInfo 是 RTM_DEST_INFO 結構的陣列指標。

在輸出上， DestInfo 會填入要求的目的地資訊。

傳回值

如果函式成功，傳回值會NO_ERROR。

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

值 意義
ERROR_INVALID_PARAMETER
 NumRoutes 所指向的值大於用戶端允許使用一個呼叫擷取的路由數目上限。 檢查 RTM_REGN_PROFILE 客戶端允許使用一個呼叫擷取的路由數目上限。
 
 

備註

重複呼叫此函式以擷取所有路由。

當路由表管理員在 NumRoutes 中傳回零時，不會再列舉任何路由。

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

規格需求

需求 值
最低支援的用戶端 都不支援
最低支援的伺服器 Windows 2000 Server [僅限傳統型應用程式]
目標平台 Windows
標頭 rtmv2.h
程式庫 Rtm.lib
Dll Rtm.dll

另請參閱

RtmCreateRouteListEnum

RtmDeleteEnumHandle