Función RtmGetDestInfo (rtmv2.h)

La función RtmGetDestInfo devuelve información sobre un destino.

Sintaxis

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

Parámetros

[in] RtmRegHandle

Identificador para el cliente obtenido de una llamada anterior a RtmRegisterEntity.

[in] DestHandle

Controle al destino para el que se va a devolver información.

[in] ProtocolId

Especifica el identificador de protocolo. ProtocolID no forma parte de los criterios de búsqueda. El administrador de tablas de enrutamiento usa este identificador para determinar qué información de ruta se va a devolver. Por ejemplo, si un cliente especifica el identificador del protocolo RIP, se devuelve la mejor ruta RIP, incluso si una ruta que no es RIP es la mejor ruta al destino.

Especifique RTM_BEST_PROTOCOL para devolver una ruta independientemente del protocolo que lo posee. Especifique RTM_THIS_PROTOCOL para devolver la mejor ruta para el protocolo de llamada.

[in] TargetViews

Especifica las vistas desde las que se va a devolver información. Si el cliente especifica RTM_VIEW_MASK_ANY, la información de destino se devuelve de todas las vistas; sin embargo, no se devuelve información específica de la vista.

[out] DestInfo

En la entrada, DestInfo es un puntero a una estructura de RTM_DEST_INFO .

En la salida, DestInfo se rellena con la información de destino solicitada.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es NO_ERROR.

Si se produce un error en la función, el valor devuelto es uno de los siguientes códigos de error.

Valor	Significado
ERROR_INVALID_HANDLE	El identificador no es válido.

 

 

Comentarios

La estructura a la que apunta DestInfo es una estructura de tamaño variable. Si el cliente especifica más de una vista con TargetViews, el tamaño de DestInfo aumenta para cada vista. Use la macro RTM_SIZE_OF_DEST_INFO para determinar el tamaño de una estructura DestInfo que se va a asignar antes de llamar a esta función. Use el valor especificado para TargetViews como parámetro para RTM_SIZE_OF_DEST_INFO.

Use RtmReleaseDestInfo para liberar el búfer DestInfo .

Requisitos

Requisito	Value
Cliente mínimo compatible	No se admite ninguno
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	rtmv2.h
Library	Rtm.lib
Archivo DLL	Rtm.dll

Consulte también

RTM_DEST_INFO

RtmReleaseDestInfo