ET_Result

Overview

Type:

Enumeration

Available as of:

V1.0.8.0

Description

The enumeration ET_Result contains the possible values that indicate the result of operations executed by the POUs of this library.

Enumeration Elements

Name

Value (UDINT)

Description

Idle

0

The function block is ready to be executed.

Status information, indicated by q_etResult if q_xDone = TRUE

OK

1

The function block or method has been executed successfully.

Status information, indicated by q_etResult if q_xError = FALSE and q_xBusy = TRUE

CheckingInputs

10

The inputs are being verified.

Initializing

15

An internal resource is being initialized.

OpeningFile

17

The file is being opened.

AnalyzingFile

20

The file is being analyzed.

ReadingFile

24

The file is being read.

WritingFile

25

The file is being written.

ClosingFile

30

The file is being closed.

GetFileSize

35

The size of the file is being retrieved.

Error information, indicated by q_etResult if q_xError = TRUE

FilePathInvalid

100

The specified file path has an invalid syntax.

XPathExpressionInvalid

102

The specified XPath (XML Path language) expression has an invalid syntax or is not supported.

FileInvalid

103

The content of the specified file to be read is not supported.

Timeout

104

A timeout has expired during execution.

FileOpenFailed

110

An error has been detected while opening the file.

FileWriteFailed

111

An error has been detected while writing the file.

FileCloseFailed

112

An error has been detected while closing the file.

FileAlreadyExists

113

The specified file for the write operation already exists. It is not allowed to be overwritten.

FileNotExists

114

The specified file for the write operation does not exist. It is not possible to append data.

GetFileSizeFailed

115

An error has been detected while retrieving the size of the file.

NumOfParentsExceeded

120

The nesting depth of the XML structure is greater than specified by the parameter Gc_udiXmlMaxNumOfParents in the global parameter list.

BufferFull

140

The size of the buffer for storing the read items is insufficient.

AdditionalContentInvalid

150

The pointer pbyAdditionalContent is 0 while the value of udiNumBytesToWrite is > 0.

ElementNotFound

160

No element has been found that matches the XPath expression.

XmlStructureInconsistent

165

The parent-child relations between the elements in the array XmlItems are not consistent.

XmlItemTypeInvalid

167

The type of an item in the array XmlItems is invalid.

ParsingFailed

169

While parsing the file, an internal error has been detected.

FileInconsistent

170

The structure of the parsed XML file is inconsistent. It contains at least one tag which is not properly closed.

TableReadValuesInvalid

171

The dimensions provided for the table where the read values shall be stored are not valid.

Refer to ST_CsvTable.

TableWriteValuesInvalid

172

The dimensions provided for the table which contains the values that shall be written are not valid.

Refer to ST_CsvTable.

TableInvalid

175

The pointer pbyAdditionalContent to the buffer provided by the application must not be 0.

ReadParameterInvalid

181

The parameters to control the read operation are not valid.

Refer to ST_CsvReadParameter.

WriteParameterInvalid

182

The parameters to control write operation are not valid.

Refer to ST_CsvWriteParameter.

FileReadFailed

190

While reading the file, an internal error has been detected.

TableTooSmall

200

The table does not provide enough cells to store the number of values which shall be read from the file.

ValueNotFound

210

The value specified by the row and column does not exist in the CSV file.

FilePathTooLong

215

The specified file path without file extension characters is outside the valid range. It is not possible to add the default file extension.

The file path without file extension is limited to 255 characters minus length of the default file extension.

FilenameTooLong

216

The specified file name including the file extension exceeds the allowed length of 126 characters.

FilenameInvalid

217

The specified file name is invalid.

FirstItemNoElement

220

The first item in the array XmlItems is not of type element.

FirstItemInvalidParentIndex

221

The value for diParentIndex of the first item in the array XmlItems is not -1.

XpathRootElementDoesNotMatch

222

The name of the first element in the array XmlItems does not match the root element specified in the XPath expression.

XpathExpressionNotSupported

230

The specified XPath expression is not supported by this function.

DataTypeNotSupported

300

The data type of the variable assigned to the input of type ANY is not supported.

NoObjectOpen

301

There is no open object in the STRING that is being processed.

NoArrayOpen

302

There is no open ARRAY in the STRING that is being processed.

NameValuePairCannotBeAdded

303

A name/value pair cannot be added at the present position in the STRING that is being processed.

MaxLengthOfJsonStringReached

304

The maximum length of the JSON-formatted STRING that is being processed has been reached. The maximum length is specified by the parameter Gc_udiJsonMaxLengthOfString in the global parameter list.

BufferTooSmall

305

The size of the buffer is insufficient for copying the STRING that is being processed.

NumOfLevelsExceeded

306

The maximum number of levels is reached for the JSON-formatted STRING that is being processed. The maximum number of levels is specified by the parameter Gc_uiJsonMaxNumOfLevels in the global parameter list.

BufferInvalid

400

The pointer to the buffer is not valid.

BufferSizeInvalid

401

The size of the buffer must not be 0.

UnexpectedProgramBehaviour

999

An internal error has been detected. Contact your Schneider Electric support.

Used By

oFB_XmlRead

oFB_XmlWrite

oFB_CsvRead

oFB_CsvWrite

oFB_CreateJsonFormattedString

oFB_WriteFile