rtmGetEnumDests 函式 (rtmv2.h)
RtmGetEnumDests 函式會擷取指定列舉中的下一組目的地。
語法
DWORD RtmGetEnumDests(
[in] RTM_ENTITY_HANDLE RtmRegHandle,
[in] RTM_ENUM_HANDLE EnumHandle,
[in, out] PUINT NumDests,
[out] PRTM_DEST_INFO DestInfos
);
參數
[in] RtmRegHandle
從 先前呼叫 RtmRegisterEntity取得的用戶端控制碼。
[in] EnumHandle
目的地列舉的控制碼。
[in, out] NumDests
在輸入時, NumDests 是 UINT 值的指標,指定 DestInfos可接收的目的地數目上限。 輸出時, NumDests 會接收 DestInfos所接收的實際目的地數目。
[out] DestInfos
在輸入時, DestInfos 是 RTM_DEST_INFO 結構的指標。
在輸出時, DestInfos 會收到目的地的控制碼陣列。
傳回值
如果函式成功,傳回值會NO_ERROR。
如果函式失敗,傳回值就是下列其中一個錯誤碼。
值 | 意義 |
---|---|
|
NumRoutes所指向的值大於允許用戶端使用一個呼叫擷取的路由數目上限。 檢查 RTM_REGN_PROFILE 是否有允許用戶端使用一個呼叫擷取的目的地數目上限。 |
|
沒有其他要列舉的目的地。 |
備註
DestInfos所指向的結構是可變大小的結構。 如果用戶端使用 TargetViews指定多個檢視, 則 DestInfos 的大小會針對每個檢視增加。 使用 RTM_SIZE_OF_DEST_INFO 宏來決定呼叫此函式之前, 要配置 DestInfos 結構的大小。 使用針對 TargetViews 指定的值作為 參數來RTM_SIZE_OF_DEST_INFO。
當不再需要目的地時,請呼叫 RtmReleaseDests加以釋放。
如需使用此函式的範例程式碼,請參閱 列舉所有目的地。
需求
最低支援的用戶端 | 都不支援 |
最低支援的伺服器 | Windows 2000 Server [僅限桌面應用程式] |
目標平台 | Windows |
標頭 | rtmv2.h |
程式庫 | Rtm.lib |
Dll | Rtm.dll |