Función RtmGetRegisteredEntities (rtmv2.h)
La función RtmGetRegisteredEntities devuelve información sobre todos los clientes que se han registrado con la instancia especificada del administrador de tablas de enrutamiento y la familia de direcciones especificada.
Sintaxis
DWORD RtmGetRegisteredEntities(
[in] RTM_ENTITY_HANDLE RtmRegHandle,
[in, out] PUINT NumEntities,
[out] PRTM_ENTITY_HANDLE EntityHandles,
[out] PRTM_ENTITY_INFO EntityInfos
);
Parámetros
[in] RtmRegHandle
Identificador del cliente obtenido de una llamada anterior a RtmRegisterEntity.
[in, out] NumEntities
En la entrada, NumEntities es un puntero a un valor UINT , que especifica el número máximo de clientes que EntityInfos puede recibir. En la salida, NumEntities recibe el número real de clientes recibidos por EntityInfos.
[out] EntityHandles
Si se deben devolver identificadores: en la entrada, EntityHandles es un puntero a NULL. En la salida, EntityHandles recibe un puntero a una matriz de identificadores de entidad; De lo contrario, EntityHandles permanece sin cambios.
Si no es necesario devolver identificadores: En la entrada, EntityHandles es NULL.
[out] EntityInfos
Si se debe devolver un puntero: en la entrada, EntityInfos es un puntero a NULL. En la salida, EntityInfos recibe un puntero a una matriz de estructuras de RTM_ENTITY_INFO ; de lo contrario, EntityInfos permanece sin cambios.
Si no es necesario devolver un puntero: en la entrada, EntityInfos es NULL.
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 |
---|---|
|
El búfer proporcionado no es lo suficientemente grande como para contener toda la información solicitada. |
Comentarios
Si se devuelve ERROR_INSUFFICIENT_BUFFER , puede haber algunos datos en EntityHandles. El parámetro NumEntities especifica cuántas entidades se devolvieron realmente.
La función RtmGetRegisteredEntities se puede usar mediante el enrutamiento de protocolos para comprobar qué otros protocolos se ejecutan para esa familia de direcciones y la instancia del administrador de tablas de enrutamiento. En función de la información devuelta, un cliente puede realizar un procesamiento específico del protocolo.
La API RTMv2 solo admite una instancia del administrador de tablas de enrutamiento.
Cuando las entidades ya no sean necesarias, ábralas llamando a RtmReleaseEntities.
Para obtener código de ejemplo con esta función, vea Enumerar las entidades registradas.
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 |