ET_Result

Overview

Type:

Enumeration

Available as of:

V1.0.4.0

Description

The enumeration ET_Result contains the possible values that indicate the result of operations executed by the function block.

Enumeration Elements

Name

Data type

Value

Description

If q_xError of a function block, for example, FB_FtpClient is FALSE, one of the following status messages is shown.

Disabled

UDINT

0

The function block is disabled.

OperationSuccessful

UDINT

1

The last FTP command has been completed successfully.

NoCommandToExecute

UDINT

2

No command to execute.

ProcessingCommand

UDINT

3

The function block is executing an FTP command.

Initializing

UDINT

4

The function block is initializing.

Operational

UDINT

5

The function block is operational.

Disabling

UDINT

6

The function block is disabling.

If q_xError of a function block, for example, FB_FtpClient is TRUE, one of the following status messages is shown.

UnexpectedProgramBehavior

UDINT

100

An internal error has been detected.

InvalidIpAddress

UDINT

101

The given IP address is not valid.

Only IPv4 addresses are allowed.

UnsupportedFtpCommand

UDINT

102

The given FTP command is not supported.

Use the enumeration ET_FtpCommand.

UnableToMakeDirectory

UDINT

103

Unable to create directory on the external FTP server.

Verify whether the directory already exists.

UnableToRemoveDirectory

UDINT

104

Unable to remove directory on the external FTP server.

Verify whether the directory is empty since only empty directories can be deleted.

Verify whether the directory has already been deleted.

UnableToChangeDirectory

UDINT

105

Unable to change working directory on the external FTP server.

Verify whether the destination directory exists.

UnableToEstablishConnection

UDINT

106

Unable to establish an FTP connection.

Verify whether the external FTP server is reachable.

UnableToLogin

UDINT

107

Unable to log in to the external FTP server.

Verify whether the credentials are correct.

UnableToSetTransferMode

UDINT

108

Unable to set the transfer mode for the file transfer (TYPE I).

Verify whether the external FTP server is capable of binary data transfer.

UnableToEnterPassiveMode

UDINT

109

Unable to enter passive mode (PASV).

Verify whether the external FTP server has been configured accordingly.

UnableToPrintWorkingDirectory

UDINT

110

Unable to display the working directory of the external FTP server.

UnableToInitiateFileTransfer

UDINT

111

Unable to perform the file transfer.

Verify that i_sCommandArg1 and i_sCommandArg2 are not empty.

InconsistencyDuringFileTransfer

UDINT

112

An error has been detected during the file transfer. Verify whether the data has been corrupted.

UnableToListContent

UDINT

113

Unable to display the content of the directory on the external FTP server.

UnableToEstablishMutlipleConnections

UDINT

114

Unable to establish more FTP connections. Only one instance of FB_FtpClient is allowed to be active at a time.

UnableToDeleteFile

UDINT

115

Unable to delete file from external FTP server.

UnableToRenameElement

UDINT

116

Unable to rename element on external FTP server.

FilePathNameLengthInvalid

UDINT

117

Name for path and file exceeded the allowed length of 75 characters.

InitAsyncManagerFailed

UDINT

120

An internal error has been detected while initializing the async manager. The use of the async manager can be configured by the global variable GVL.G_xDisableAsyncExecFtpClient.

StartAsyncJobFailed

UDINT

121

An internal error has been detected while starting the async job. The use of the async manager can be configured by the global variable GVL.G_xDisableAsyncExecFtpClient.

UnableToSetProtP

UDINT

130

The external FTP server is unable to set the encrypted data transfer protocol (PROT P is not supported by the external FTP server).

UnableToOpenDataConnection

UDINT

131

The data connection to retrieve folder information cannot be established.

UnableToCloseDataConnection

UDINT

132

The data connection cannot be terminated.

UnableToReadServerData

UDINT

133

The external FTP server data cannot be read.

UnableToGetLastServerOutput

UDINT

134

The last output of the external FTP server was not processed.

UnableToRetrieveFile

UDINT

135

The selected file was not retrieved from the external FTP server.

UnableToStoreFile

UDINT

136

The selected file was not stored on the external FTP server.

CertFileNameBlank

UDINT

137

Verify that the certificate file name i_sCertFileName is not empty.

CertFileNameBlank

UDINT

138

Verify that the key file name i_sKeyFileName is not empty.

Used By

  • FB_FtpClient

  • FB_FtpSecureClient