Share via

RtmGetRegisteredEntities 函式 (rtmv2.h)

  • 發行項

RtmGetRegisteredEntities 函式會傳回所有已向路由表管理員和指定位址系列實例註冊之用戶端的相關信息。

語法

DWORD RtmGetRegisteredEntities(
  [in]      RTM_ENTITY_HANDLE  RtmRegHandle,
  [in, out] PUINT              NumEntities,
  [out]     PRTM_ENTITY_HANDLE EntityHandles,
  [out]     PRTM_ENTITY_INFO   EntityInfos
);

參數

[in] RtmRegHandle

從先前呼叫 RtmRegisterEntity 取得的用戶端句柄。

[in, out] NumEntities

輸入時， NumEntities 是 UINT 值的指標，指定 EntityInfos 可接收的用戶端數目上限。 輸出時， NumEntities 會接收 EntityInfos 所接收的實際客戶端數目。

[out] EntityHandles

如果必須傳回句柄：輸入時， EntityHandles 是 NULL 的指標。 在輸出時， EntityHandles 會收到實體句柄陣列的指標;否則 ，EntityHandles 會保持不變。

如果不需要傳回句柄：在輸入時， EntityHandles 為 NULL。

[out] EntityInfos

如果必須傳回指標：輸入時， EntityInfos 是 NULL 的指標。 在輸出時， EntityInfos 會接收 RTM_ENTITY_INFO 結構的陣列指標;否則 ，EntityInfos 會保持不變。

如果不需要傳回指標：在輸入時， EntityInfos 為 NULL。

傳回值

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

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

值 意義
ERROR_INSUFFICIENT_BUFFER
 提供的緩衝區不夠大，無法保存所有要求的資訊。

備註

如果傳回ERROR_INSUFFICIENT_BUFFER，EntityHandles 中可能會有一些數據。 NumEntities 參數會指定實際傳回的實體數目。

RtmGetRegisteredEntities 函式可供路由通訊協定使用，以驗證該位址系列和路由表管理員實例正在執行哪些其他通訊協定。 根據傳回的信息，客戶端接著可以執行通訊協定特定的處理。

RTMv2 API 僅支援路由表管理員的一個實例。

當不再需要實體時，請呼叫 RtmReleaseEntities 加以釋放。

如需使用此函式的範例程式代碼，請參閱 列舉已註冊的實體。

規格需求

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

另請參閱

RTM_ENTITY_INFO

RtmReleaseEntities