GetRowTextAll Method (DATATABLE)


10.5, PLBCMP GUI Only

 

The GetRowTextAll method returns all text from a row in a DATATABLE in delimited format. The method uses the following format:

 

[label]

{object}.GetRowTextAll

[GIVING {return}]:

 

 

USING [*Row=]{row}[:

 

 

[*Delimiter=]{delim}[:

 

 

[*Options=]{options}]

 

Where:

label

Optional. A Program Execution Label.

object

Required. A DATATABLE object.

return

Optional. A Character String Variable that contains the data from the row.

row

Required. A Numeric Variable that specifies the zero-based row accessed.

delim

Optional. A Character String Variable or literal that specifies the delimiter character.

options

Optional. A decimal number or Numeric Variable that has a bit mask value described below.

Flags Affected: EOS, OVER, ZERO

Note the following:

  1. The EOS flag is set if the {return} variable is too small and the return data must be truncated.

  2. The ZERO and OVER flag are always cleared.

  3. If the {delim} parameter is not used, the default delimiter character is a comma.

  4. The {options} bit mask definitions as follows:

  5.  

    Value

    Constant

    Meaning

    0x1

    TBL_CSVWR_QUOTED

    The column data is returned in quoted format.

    0x10

    TBL_CSVWR_NOZEROWIDTH

    Any DATATABLE column with a zero width is skipped.

    0x80

    TBL_CSVWR_BYORDERARRAY

    Return the data using the current column array order. If this bit mask value is not specified, the default is to return the data using the column order as created.

 

 

See Also: Method Syntax, DATATABLE Methods

 



PL/B Language Reference GetRowText Method (DATATABLE) HtmlBind Method (DATATABLE)