Función RtmRegisterEntity (rtmv2.h)

Artículo
03/15/2023

La función RtmRegisterEntity registra un cliente con una instancia del administrador de tablas de enrutamiento para una familia de direcciones específica. El administrador de tablas de enrutamiento devuelve un identificador de registro y un perfil de la instancia. El perfil contiene una lista de valores que se usan al llamar a otras funciones. Los valores incluyen el número máximo de destinos devueltos en un búfer por una sola llamada.

El registro es la primera acción que debe realizar un cliente.

Sintaxis

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

Parámetros

[in] RtmEntityInfo

Puntero a una estructura de RTM_ENTITY_INFO . Esta estructura contiene información que identifica al cliente al administrador de tablas de enrutamiento, como la instancia del administrador de tablas de enrutamiento y la familia de direcciones con la que se va a registrar.

[in] ExportMethods

Puntero a una estructura de RTM_ENTITY_EXPORT_METHODS que contiene una lista de métodos exportados por el cliente. Este parámetro es opcional y se puede establecer en NULL si el cliente que realiza la llamada no tiene métodos para exportar.

[in] EventCallback

Estructura RTM_EVENT_CALLBACK que especifica la devolución de llamada que usa el administrador de tablas de enrutamiento para notificar al cliente de eventos. Los eventos son cuando un cliente registra y anula el registro, cuando las rutas expiran y cuándo se han producido cambios en la mejor ruta a un destino. Solo los cambios especificados cuando el cliente llamó a RtmRegisterForChangeNotification.

[in] ReserveOpaquePointer

Especifica si se va a reservar un puntero opaco en cada destino para esta instancia del protocolo. Especifique TRUE para reservar un puntero opaco en cada destino. Especifique FALSE para omitir esta acción. Estos punteros opacos se pueden usar para apuntar a un contexto privado específico del protocolo para cada destino.

[out] RtmRegProfile

En la entrada, RtmRegProfile es un puntero a una estructura de RTM_REGN_PROFILE .

En la salida, RtmRegProfile se rellena con la estructura de perfil de registro solicitada. El cliente debe usar la información devuelta en otras llamadas de función (la información devuelta incluye el número de próximo saltos de igual costo y el número máximo de elementos devueltos por una llamada de función de enumeración).

[out] RtmRegHandle

Recibe un identificador de registro para el cliente. Este identificador se debe usar en todas las llamadas posteriores al administrador de tablas de enrutamiento.

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_ALREADY_EXISTS	El cliente especificado ya se ha registrado con el administrador de tablas de enrutamiento.
ERROR_BAD_CONFIGURATION	La información del Registro para el administrador de tablas de enrutamiento está dañada.
ERROR_FILE_NOT_FOUND	No se encontró información del Registro para el administrador de tablas de enrutamiento.
ERROR_INVALID_DATA	Un parámetro contiene información incorrecta.
ERROR_INVALID_PARAMETER	Un parámetro contiene información incorrecta.
ERROR_NO_SYSTEM_RESOURCES	No hay suficientes recursos del sistema disponibles para completar esta operación.
ERROR_NOT_ENOUGH_MEMORY	No hay suficiente memoria para completar esta operación.

Comentarios

Para obtener código de ejemplo con esta función, consulte Register With the Routing Table Manager.

Requisitos


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