RtmGetDestInfo-Funktion (rtmv2.h)

  • Artikel

Die RtmGetDestInfo-Funktion gibt Informationen zu einem Ziel zurück.

Syntax

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
);

Parameter

[in] RtmRegHandle

Handle an den Client, der von einem vorherigen Aufruf von RtmRegisterEntity abgerufen wurde.

[in] DestHandle

Handle an das Ziel, für das Informationen zurückgegeben werden sollen.

[in] ProtocolId

Gibt den Protokollbezeichner an. Die ProtocolID ist nicht Teil der Suchkriterien. Der Routingtabellen-Manager verwendet diesen Bezeichner, um zu bestimmen, welche Routeninformationen zurückgegeben werden sollen. Wenn beispielsweise ein Client den RIP-Protokollbezeichner angibt, wird die beste RIP-Route zurückgegeben, auch wenn eine Nicht-RIP-Route die beste Route zum Ziel ist.

Geben Sie RTM_BEST_PROTOCOL an, um eine Route zurückzugeben, unabhängig davon, welches Protokoll sie besitzt. Geben Sie RTM_THIS_PROTOCOL an, um die beste Route für das Anrufprotokoll zurückzugeben.

[in] TargetViews

Gibt die Ansichten an, aus denen Informationen zurückgegeben werden sollen. Wenn der Client RTM_VIEW_MASK_ANY angibt, werden Zielinformationen aus allen Ansichten zurückgegeben. es werden jedoch keine ansichtsspezifischen Informationen zurückgegeben.

[out] DestInfo

Bei der Eingabe ist DestInfo ein Zeiger auf eine RTM_DEST_INFO-Struktur .

Bei der Ausgabe wird DestInfo mit den angeforderten Zielinformationen gefüllt.

Rückgabewert

Wenn die Funktion erfolgreich ist, wird der Rückgabewert NO_ERROR.

Wenn die Funktion fehlschlägt, ist der Rückgabewert einer der folgenden Fehlercodes.

Wert Bedeutung
ERROR_INVALID_HANDLE
 Das Handle ist ungültig.
 
 

Hinweise

Die Struktur, auf die von DestInfo verwiesen wird, ist eine Struktur mit variabler Größe. Wenn der Client mehrere Ansichten mit TargetViews angibt, erhöht sich die Größe von DestInfo für jede Ansicht. Verwenden Sie das Makro RTM_SIZE_OF_DEST_INFO , um zu bestimmen, wie groß eine DestInfo-Struktur zugeordnet werden soll, bevor Sie diese Funktion aufrufen. Verwenden Sie den für TargetViews angegebenen Wert als Parameter, um RTM_SIZE_OF_DEST_INFO.

Verwenden Sie RtmReleaseDestInfo , um den DestInfo-Puffer freizugeben.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Nicht unterstützt
Unterstützte Mindestversion (Server) Windows 2000 Server [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile rtmv2.h
Bibliothek Rtm.lib
DLL Rtm.dll

Weitere Informationen

RTM_DEST_INFO

RtmReleaseDestInfo