NAIUA: OpenROAD SIG

tablefieldtofile

The procedure tablefieldtofile (3K) writes a TableField to a disk file.

The maximum supported length for a varchar-column is varchar(1000).

Note that the return value for "success" is int(1) and "failed" is int(-1), that's because if the procedure fails fatally (array index out of bounds for example) the return will be 0/ER_OK too. You can change it if you'd like.

Return-Values:

• success = 1
• failed = -1

Parameters:

• tab = TableField => Tablefield to write to file
• fname = StringObject => filename (optional / if null/'' it's setted by "filePopUp()")
• inclAttrNames = i1 not null default TRUE => include columnnames (optional default TRUE)
• inclInvisible = i1 not null default FALSE => include invisivle columns (optional default FALSE)
• delim = varchar(1) not null default ';' => column-delimiter (optional default ';' (.csv))

In most case you'll call it like this...
========================================

filename = StringObject;

IF tablefieldToFile ( tab = Field(myTable),
         fname = filename ) != 1 THEN
    message('failed');
    RESUME;
ENDIF;
message('Table successfully saved to ' + filename);