FB_FtpClient

Descripción general

Tipo:

Bloque de funciones

Disponible desde:

V1.0.4.0

Tarea

El bloque de funciones FB_FtpClient está diseñado para conexiones FTP no seguras. Incluye las funcionalidades de FTP relacionadas para operaciones con archivos y directorios. Cada instancia gestiona una conexión FTP no segura. En caso de que intente establecer una segunda transferencia, el bloque de funciones responde con ET_Result.UnableToEstablishMutlipleConnections.

Descripción de funciones

El bloque de funciones FB_FtpClient constituye la interfaz de usuario para interactuar con el servidor FTP externo a través de una conexión no segura.

Una vez habilitado el bloque de funciones, se establece una conexión FTP no segura con las credenciales de usuario que se envían mediante iq_stCredentials. En cuanto se establece la conexión no segura, el bloque de funciones es capaz de procesar comandos enviados por i_etCommand y un flanco ascendente detectado en i_xExecute.

Mientras los comandos se están ejecutando, la salida q_xBusy se establece en TRUE. Cuando un comando se ha completado correctamente, q_xDone se establece en TRUE.

Los mensajes de estado y la información de diagnóstico se proporcionan usando las salidas q_xError (TRUE si se ha detectado un error), q_etResult y q_etResultMsg.

Para confirmar los errores detectados, deshabilite y vuelva a habilitar el bloque de funciones para que sea capaz de enviar un comando.

Cuando se deshabilita el bloque de funciones (i_xEnable = FALSE), este debe invocarse mientras q_xActive = TRUE para completar las rutinas de limpieza interna. Seguidamente, se puede volver a habilitar.

Si se rebasa el tiempo de espera después de establecerse la conexión, la ejecución del siguiente comando FTP (ET_FtpCommand) se detecta como un error. Para evitar este comportamiento, habilite el bloque de funciones justo antes de realizar las operaciones relacionadas y deshabilítelo después.

Interfaz

Entrada

Tipo de datos

Descripción

i_xEnable

BOOL

Activación e inicialización del bloque de funciones.

Consulte Comportamiento de los bloques de funciones con la entrada i_xEnable y i_xExecute.

i_xExecute

BOOL

El comando especificado con la entrada i_etCommand se ejecuta en el flanco ascendente de esta entrada.

Consulte Comportamiento de los bloques de funciones con la entrada i_xEnable y i_xExecute.

i_etCommand

ET_FtpCommand

El comando FTP que se ejecuta si la entrada i_xExecute es TRUE.

Entrada/salida

Tipo de datos

Descripción

iq_stCredentials

ST_Credentials

Se utiliza para pasar la estructura que contiene los ajustes de usuario, como el nombre de usuario o la contraseña.

iq_stContent

ST_Content

Se utiliza para pasar el directorio de trabajo y, si procede, la cantidad y los nombres de los archivos de este directorio.

Salida

Tipo de datos

Descripción

q_xActive

BOOL

Si el bloque de funciones está activo, la salida se establece en TRUE.

q_xReady

BOOL

Si la inicialización es correcta, la salida se establece en TRUE mientras el bloque de funciones sea capaz de aceptar entradas.

q_xBusy

BOOL

Si esta salida se establece en TRUE, el bloque de funciones ejecuta el comando especificado en i_etCommand.

q_xDone

BOOL

Si esta salida se establece en TRUE, el bloque de funciones ha completado correctamente el comando especificado en i_etCommand.

q_xError

BOOL

Si esta salida se establece en TRUE, se ha detectado un error. Para obtener información detallada, consulte q_etResult y q_etResultMsg.

q_etResult

ET_Result

Proporciona información de estado y diagnóstico.

q_sResultMsg

STRING[255]

Proporciona información adicional de estado y diagnóstico.