Reference

FFI Built-in Functions

• DTWF_APPEND
• DTWF_CLOSE
• DTWF_DELETE
• DTWF_INSERT
• DTWF_OPEN
• DTWF_READ
• DTWF_REMOVE
• DTWF_SEARCH
• DTWF_UPDATE
• DTWF_WRITE

DTWF_APPEND

Purpose

Writes the contents of a Net.Data table to the end of a text file.

Format

@DTWF_APPEND(filename, transform, delimiter, table, retry, rows)

@DTWF_APPEND(filename, transform, delimiter, table, retry)

@DTWF_APPEND(filename, transform, delimiter, table)

Parameters

Table 167. DTWF_APPEND Parameters

Return Codes

Table 168. DTWF_APPEND Return Codes

Usage Notes

The current contents of a file affect the results of using DTWF_APPEND, especially the contents of the last column of the last row. If a new-line character follows the last column value of the last row of the file, appended data is placed in a new row. Otherwise, appended data becomes part of the last row of the file.

Examples

Example 1:

%DEFINE {
  myFile = "c:/private/myfile"
  myTable = %TABLE
%}
@DTWF_APPEND(myFile, "DELIMITED", " ;", myTable)

Example 2:

%DEFINE {
  myFile = "c:/private/myfile"
  myTable = %TABLE
%}
@DTWF_APPEND(myFile, "ASCIITEXT", " ;", myTable)

Example 3:

%DEFINE {
  myFile = "c:/private/myfile"
  myTable = %TABLE
%}
@DTWF_APPEND(myFile, "ASCIITEXT", " ;", myTable, "0", "10")

DTWF_CLOSE

Purpose

Closes a file opened by DTWF_OPEN.

Format

@DTWF_CLOSE(filename, retry)

@DTWF_CLOSE(filename)

Parameters

Table 169. DTWF_CLOSE Parameters

Return Codes

Table 170. DTWF_CLOSE Return Codes

Examples

Example 1:

@DTWF_CLOSE(myFile, "5")

DTWF_DELETE

Purpose

Deletes lines from a text file.

Format

@DTWF_DELETE(filename, transform, delimiter, retry, rows, startrow)

@DTWF_DELETE(filename, transform, delimiter, retry, rows)

@DTWF_DELETE(filename, transform, delimiter, retry)

@DTWF_DELETE(filename, transform, delimiter)

Parameters

Table 171. DTW_DELETE Parameters

Return Codes

Table 172. DTWF_DELETE Return Codes

Examples

Example 1:

%DEFINE {
   myFile = "c:/private/myfile"
   myTable = %TABLE
   myWait = "5000"
   myRows = "2"
%}
@DTWF_DELETE(myFile, "Delimited", "|", myWait, myRows)

Example 2:

%DEFINE {
   myFile = "c:/private/myfile"
   myTable = %TABLE
   myStart = "1"
   myRows = "2"
%}
@DTWF_DELETE(myFile, "Asciitext", "|", "0", myRows, myStart)

DTWF_INSERT

Purpose

Inserts lines into a text file.

Format

@DTWF_INSERT(filename, transform, delimiter, table, retry, rows, startrow)

@DTWF_INSERT(filename, transform, delimiter, table, retry, rows)

@DTWF_INSERT(filename, transform, delimiter, table, retry)

@DTWF_INSERT(filename, transform, delimiter, table)

Parameters

Table 173. DTWF_INSERT Parameters

Return Codes

Table 174. DTWF_INSERT Return Codes

Examples

Example 1:

%DEFINE {
   myFile = "c:/private/myfile"
   myTable = %TABLE
   myWait = "3000"
%}
@DTWF_INSERT(myFile, "Delimited", "|", myTable, myWait)

Example 2:

%DEFINE {
   myFile = "c:/private/myfile"
   myTable = %TABLE
   myStart = "1"
   myRows = "2"
%}
@DTWF_INSERT(myFile, "Asciitext", "|", myTable, "0", myRows, myStart)

DTWF_OPEN

Purpose

Opens a text file.

Format

@DTWF_OPEN(filename, mode, retry)

@DTWF_OPEN(filename, mode)

Parameters

Table 175. DTWF_OPEN Parameters

Return Codes

Table 176. DTWF_OPEN Return Codes

Usage Notes

1. When the file does not exist, an absolute path for the filename should be specified, and the directory where the file is to be created must match a directory specified in FFI_PATH. If an absolute path is not used, the file will be opened in the current working directory.
2. DTWF_OPEN keeps the file open, otherwise, the file is closed after each flat file operation.
3. Use DTWF_OPEN to reduce the number of times a file is open. If DTWF_OPEN is not used, the file is closed after each flat file operation. The file is left open until it is closed using DTWF_CLOSE or macro processing ends.

Examples

Example 1:

%DEFINE {
  myFile = "c:/private/myfile"
  myMode = "r+"
%}
@DTWF_OPEN(myFile, myMode, "1000")

DTWF_READ

Purpose

Reads lines from a text file into a Net.Data table.

Format

@DTWF_READ(filename, transform, delimiter, table, retry, rows, startrow, columns)

@DTWF_READ(filename, transform, delimiter, table, retry, rows, startrow)

@DTWF_READ(filename, transform, delimiter, table, retry, rows)

@DTWF_READ(filename, transform, delimiter, table, retry)

@DTWF_READ(filename, transform, delimiter, table)

Parameters

Table 177. DTWF_READ Parameters

Return Codes

Table 178. DTWF_READ Return Codes

Examples

Example 1:

%DEFINE {
  myFile = "c:/private/myfile"
  myTable = %TABLE
  myWait = "1000"
%}
@DTWF_READ(myFile, "DELIMITED", ";", myTable, myWait)

Example 2:

%DEFINE {
  myFile = "c:/private/myfile"
  myTable = %TABLE
  myWait = "0"
  myRows = "0"
  myStartrow = "1"
  myColumns = ""
%}
@DTWF_READ(myFile, "DELIMITED", ";", myTable, myWait, myRows,
             myStartrow, myColumns)

Example 3:

%DEFINE {
  myFile = "c:/private/myfile"
  myTable = %TABLE
%}
@DTWF_READ(myFile, "ASCIITEXT", ";", myTable)
@DTW_TB_TABLE(myTable,"BORDER","")

DTWF_REMOVE

Purpose

Deletes an entire file.

Format

@DTWF_REMOVE(filename, retry)

@DTWF_REMOVE(filename)

Parameters

Table 179. DTW_REMOVE Parameters

Return Codes

Table 180. DTWF_REMOVE Return Codes

Examples

Example 1:

%DEFINE myFile = "c:/private/myfile"
@DTWF_REMOVE(myFile)

Example 2:

%DEFINE {
  myFile = "c:/private/myfile"
  myWait = "2000"
%}
@DTWF_REMOVE(myFile, myWait)

DTWF_SEARCH

Purpose

Searches a text file for a string, returning the results into a Net.Data table.

Format

@DTWF_SEARCH(filename, transform, delimiter, table, searchFor, retry, rows, startrow)

@DTWF_SEARCH(filename, transform, delimiter, table, searchFor, retry, rows)

@DTWF_SEARCH(filename, transform, delimiter, table, searchFor, retry)

@DTWF_SEARCH(filename, transform, delimiter, table, searchFor)

Parameters

Table 181. DTWF_SEARCH Parameters

Return Codes

Table 182. DTWF_SEARCH Return Codes

Usage Notes

1. The table that is returned for DTWF_SEARCH has three columns. The first two columns contain the row and the column number where the match is found; the last column contains the column value that contains the characters that are specified in the SearchFor parameter. For example, if the fourth row of the file contains matching characters in column three, the returned table has a row with the number 4 in the first column to indicate the row of the file that it came from; it has a number 3 in the second column to indicate which column of the file contains a match; and it has the complete column value in the third column.
2. The SearchFor parameter cannot include the contents of the delimiter parameter.

Examples

Example 1:

%DEFINE {
  myFile = "c:/private/myfile"
  myTable = %TABLE
  myWait = "1000"
  mySearch = "0123456789abcdef"
@DTWF_SEARCH(myFile, "DELIMITED", ";",
               myTable, mySearch, myWait)

Example 2:

%DEFINE {
  myFile = "c:/private/myfile"
  myTable = %TABLE
  mySearch = "answer:"
  myWait = "0"
  myRows = "0"
  myStartrow = "1"
%}
@DTWF_SEARCH(myFile, "DELIMITED", ";", myTable,
               mySearch, myWait, myRows, myStartrow)

DTWF_UPDATE

Purpose

Update lines in a text file with data from a Net.Data table.

Format

@DTWF_UPDATE(filename, transform, delimiter, table, retry, rows, startrow)

@DTWF_UPDATE(filename, transform, delimiter, table, retry, rows)

@DTWF_UPDATE(filename, transform, delimiter, table, retry)

@DTWF_UPDATE(filename, transform, delimiter, table)

Parameters

Table 183. DTWF_UPDATE Parameters

Return Codes

Table 184. DTWF_UPDATE Return Codes

Usage Notes

If the file does not exist, an absolute path for the filename should be specified, and the directory where the file is to be created must match a directory specified in FFI_PATH. If an absolute path is not used, the file will be opened in the current working directory.

Examples

Example 1:

%DEFINE {
   myFile = "c:/private/myfile"
   myTable = %TABLE
   myWait = "1500"
   myRows = "2"
%}
@DTWF_UPDATE(myFile, "Delimited", "|", myTable, myWait, myRows)

Example 2:

%DEFINE {
   myFile = "c:/private/myfile"
   myTable = %TABLE
   myStart = "1"
   myRows = "2"
%}
@DTWF_UPDATE(myFile, "Asciitext", "|", myTable, "0", myRows, myStart)

DTWF_WRITE

Purpose

Writes the contents of a Net.Data table to a text file.

Format

@DTWF_WRITE(filename, transform, delimiter, table, retry, rows, startrow)

@DTWF_WRITE(filename, transform, delimiter, table, retry, rows)

@DTWF_WRITE(filename, transform, delimiter, table, retry)

@DTWF_WRITE(filename, transform, delimiter, table)

Parameters

Table 185. DTWF_WRITE Parameters

Return Codes

Table 186. DTWF_WRITE Return Codes

Usage Notes

If the file does not exist, an absolute path for the filename should be specified, and the directory where the file is to be created must match a directory specified in FFI_PATH. If an absolute path is not used, the file will be opened in the current working directory.

Examples

Example 1:

%DEFINE {
  myFile = "c:/private/myfile"
  myTable = %TABLE
%}
@DTWF_WRITE(myFile, "DELIMITED", ";", myTable)

Example 2:

%DEFINE {
  myFile = "c:/private/myfile"
  myTable = %TABLE
%}
@DTWF_WRITE(myFile, "ASCIITEXT", ";", myTable, "5000")

Example 3:

%DEFINE {
  myFile = "c:/private/myfile"
  myTable = %TABLE
%}
@DTWF_WRITE(myFile, "ASCIITEXT", ";", myTable, "5000", "10", "50")