RtmGetDestInfo 函式 (rtmv2.h)

RtmGetDestInfo 函式會傳回目的地的相關信息。

語法

DWORD RtmGetDestInfo(
  [in]  RTM_ENTITY_HANDLE RtmRegHandle,
  [in]  RTM_DEST_HANDLE   DestHandle,
  [in]  ULONG             ProtocolId,
  [in]  RTM_VIEW_SET      TargetViews,
  [out] PRTM_DEST_INFO    DestInfo
);

參數

[in] RtmRegHandle

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

[in] DestHandle

要傳回資訊的目的地句柄。

[in] ProtocolId

指定通訊協議標識碼。 ProtocolID 不是搜尋準則的一部分。 路由表管理員會使用此標識碼來判斷要傳回的路由資訊。 例如，如果用戶端指定 RIP 通訊協定標識符，則會傳回最佳的 RIP 路由，即使非 RIP 路由是目的地的最佳路由也一樣。

指定RTM_BEST_PROTOCOL傳迴路由，不論哪個通訊協議擁有路由。 指定RTM_THIS_PROTOCOL，以傳回呼叫通訊協定的最佳路由。

[in] TargetViews

指定要從中傳回信息的檢視。 如果用戶端指定RTM_VIEW_MASK_ANY，則會從所有檢視傳回目的地資訊;不過，不會傳回任何檢視特定資訊。

[out] DestInfo

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

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

傳回值

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

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

值	意義
ERROR_INVALID_HANDLE	控制代碼無效。

 

 

備註

DestInfo 所指向的結構是可變大小的結構。 如果用戶端使用 TargetViews 指定多個檢視， 則 DestInfo 的大小會針對每個檢視增加。 使用 RTM_SIZE_OF_DEST_INFO 宏來決定呼叫此函式之前， 要配置多少 DestInfo 結構。 使用針對 TargetViews 指定的值作為 參數來RTM_SIZE_OF_DEST_INFO。

使用 RtmReleaseDestInfo 釋放 DestInfo 緩衝區。

規格需求

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

另請參閱

RTM_DEST_INFO

RtmReleaseDestInfo