FC_GetPeerScanData - Descripción funcional

Descripción general

Tipo:	Función
Disponible desde:	V1.0.0.0
Hereda de:	–
Implementa:	–

Descripción de funciones

La función FC_GetPeerScanData se utiliza para recuperar información del dispositivo especificado de la base de datos interna que contiene los dispositivos detectados durante la última exploración.

NOTA:

Aunque FC_ClearScanList ya se haya ejecutado anteriormente, la base de datos interna de dispositivos conectados puede contener datos, ya que el controlador añade cualquier dispositivo que envíe un mensaje de identificación (que podría provenir de la actividad de otros dispositivos de la red).
Tras una nueva exploración de la red (FC_Scan), espere de 1 a 5 s (en función del número de dispositivos conectados) antes de leer la base de datos interna con unos ajustes de filtro distintos.
La base de datos interna de dispositivos detectados se almacena en la memoria del controlador, por lo que no está visible (accesible). Por consiguiente, no podrá exportar datos internos ni acceder a ellos con otros mecanismos de archivos.

Interfaz

Entrada	Tipo de datos	Descripción
i_udiSearchUniqueID	UDINT	ID exclusivo desde el que se inicia la búsqueda. Utilice 0 para la primera llamada de esta función tras ejecutar FC_ClearScanList. Si ha recibido información de respuesta del dispositivo especificado, podrá utilizar ST_PeerDeviceInfo.i_udiPeerUniqueID como entrada para la siguiente ejecución de esta función a fin de comprobar si hay otro dispositivo conectado con los mismos ajustes de filtro.
i_etSearchTypeFilter	ET_SearchTypeFilter	Enumeración que describe el campo en el que se centra la búsqueda. Consulte también ET_SearchTypeFilter.
i_sSearchTypeValue	STRING[64]	Cadena con la que se realiza la comparación con los datos del interlocutor. Ejemplo: `i_udiSearchUID = 0` `i_etSearchTypeFilter = ModelName` `i_sSearchTypeValue = TM2` Devuelve el primer interlocutor que contiene TM2 en su ModelName (podría ser TM241, TM251 y así sucesivamente).

Entrada

Tipo de datos

Descripción

i_udiSearchUniqueID

UDINT

ID exclusivo desde el que se inicia la búsqueda. Utilice 0 para la primera llamada de esta función tras ejecutar FC_ClearScanList.

Si ha recibido información de respuesta del dispositivo especificado, podrá utilizar ST_PeerDeviceInfo.i_udiPeerUniqueID como entrada para la siguiente ejecución de esta función a fin de comprobar si hay otro dispositivo conectado con los mismos ajustes de filtro.

i_etSearchTypeFilter

ET_SearchTypeFilter

Enumeración que describe el campo en el que se centra la búsqueda. Consulte también ET_SearchTypeFilter.

i_sSearchTypeValue

STRING[64]

Cadena con la que se realiza la comparación con los datos del interlocutor.

Ejemplo:

i_udiSearchUID = 0
i_etSearchTypeFilter = ModelName
i_sSearchTypeValue = TM2

Devuelve el primer interlocutor que contiene TM2 en su ModelName (podría ser TM241, TM251 y así sucesivamente).

Entrada/salida	Tipo de datos	Descripción
iq_stPeerDeviceInfo	ST_PeerDeviceInfo	Si se detecta un interlocutor, los datos se copiarán a la estructura ST_PeerDeviceInfo.

Salida	Tipo de datos	Descripción
q_etResult	ET_Result	Proporciona información de diagnóstico y estado en forma de valor numérico.
q_sResultMsg	STRING[80]	Proporciona información adicional de diagnóstico y estado en forma de mensaje de texto.

Valor de retorno

Tipo de datos	Descripción
BOOL	TRUE: La función se ha ejecutado correctamente. FALSE: Consulte la información de diagnóstico.

Ejemplos

Para obtener ejemplos, consulte las Prácticas recomendadas.