rtmRegisterEntity 函式 (rtmv2.h)

發行項
08/25/2023

RtmRegisterEntity函式會針對特定位址系列向路由表管理員的實例註冊用戶端。路由表管理員會傳回註冊控制碼和實例的設定檔。設定檔包含呼叫其他函式時所使用的值清單。值包括單一呼叫在緩衝區中傳回的目的地數目上限。

註冊是用戶端應採取的第一個動作。

語法

DWORD RtmRegisterEntity(
  [in]  PRTM_ENTITY_INFO           RtmEntityInfo,
  [in]  PRTM_ENTITY_EXPORT_METHODS ExportMethods,
  [in]  RTM_EVENT_CALLBACK         EventCallback,
  [in]  BOOL                       ReserveOpaquePointer,
  [out] PRTM_REGN_PROFILE          RtmRegProfile,
  [out] PRTM_ENTITY_HANDLE         RtmRegHandle
);

參數

[in] RtmEntityInfo

RTM_ENTITY_INFO結構的指標。此結構包含可識別路由表管理員之用戶端的資訊，例如要註冊的路由表管理員實例和位址系列。

[in] ExportMethods

包含用戶端所匯出方法清單之RTM_ENTITY_EXPORT_METHODS 結構的指標。此參數是選擇性的，如果呼叫的用戶端沒有匯出的方法，則可以設定為 Null 。

[in] EventCallback

RTM_EVENT_CALLBACK結構，指定路由表管理員用來通知用戶端事件的回呼。事件是用戶端註冊和取消註冊、路由到期時，以及發生目的地最佳路由變更的時間。只有在用戶端呼叫 RtmRegisterForChangeNotification時，才指定這些變更。

[in] ReserveOpaquePointer

指定是否要在通訊協定實例的每個目的地中保留不透明指標。指定 TRUE 以保留每個目的地中的不透明指標。指定 FALSE 以略過此動作。這些不透明的指標可用來指向每個目的地的私人通訊協定特定內容。

[out] RtmRegProfile

在輸入時， RtmRegProfile 是 RTM_REGN_PROFILE 結構的指標。

在輸出中， RtmRegProfile 會填入要求的註冊設定檔結構。用戶端必須使用其他函式呼叫中傳回的資訊， (傳回的資訊包括相等成本下一個躍點的數目，以及列舉函式呼叫所傳回的專案數目上限) 。

[out] RtmRegHandle

接收用戶端的註冊控制碼。此控制碼必須用於路由表管理員的所有後續呼叫中。

傳回值

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

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

值	意義
ERROR_ALREADY_EXISTS	指定的用戶端已經向路由表管理員註冊。
ERROR_BAD_CONFIGURATION	路由表管理員的登錄資訊已損毀。
ERROR_FILE_NOT_FOUND	找不到路由表管理員的登錄資訊。
ERROR_INVALID_DATA	參數包含不正確的資訊。
ERROR_INVALID_PARAMETER	參數包含不正確的資訊。
ERROR_NO_SYSTEM_RESOURCES	沒有足夠的可用系統資源可完成此作業。
ERROR_NOT_ENOUGH_MEMORY	記憶體不足，無法完成此作業。

備註

如需使用此函式的範例程式碼，請參閱向路由表管理員註冊。

需求


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