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 是 UINT 值的指標,指定 RouteHandles 可接收的路由數目上限。
輸出時, NumRoutes 會接收 RouteHandles 所接收的實際路由數目。
[out] RouteHandles
在輸入時, RouteHandles 是 RTM_ROUTE_INFO 結構的指標。
在輸出中, RouteHandles 會收到路由的句柄陣列。
傳回值
如果函式成功,傳回值會NO_ERROR。
如果函式失敗,傳回值就是下列其中一個錯誤碼。
值 | 意義 |
---|---|
|
NumRoutes 所指向的值大於允許用戶端使用一個呼叫擷取的路由數目上限。 檢查 RTM_REGN_PROFILE 是否有允許用戶端使用一個呼叫擷取的路由數目上限。 |
|
沒有其他要列舉的路由。 |
|
記憶體不足,無法完成此作業。 |
備註
當不再需要路由時,請藉由呼叫 RtmReleaseRoutes 加以釋放。
如需使用此函式的範例程式代碼,請參閱 列舉所有路由。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | 都不支援 |
最低支援的伺服器 | Windows 2000 Server [僅限桌面應用程式] |
目標平台 | Windows |
標頭 | rtmv2.h |
程式庫 | Rtm.lib |
Dll | Rtm.dll |