GetItemTextAll Method (LISTVIEW)


9.0B, PLBCMP GUI Only

 

The GetItemTextAll method obtains a row from a LISTVIEW object in delimited format. The method uses the following format:

 

 

[label]

{object}.GetItemTextAll

[GIVING {return}]:

 

 

 

USING [*Index=]{index}[:

 

 

 

[*Delimiter=]{delim}]:

 

 

 

[*Options=]{options}]

 

Where:

label

Optional. A Program Execution Label.

object

Required. A LISTVIEW object that is accessed.

return

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

index

Required. A zero-based Numeric Variable or decimal number that specifies the the row to extract.

delim

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

options

Optional. A bit field value as described below.

Flags Affected: EOS, OVER, ZERO

Note the following:

  1. When a negative one (-1) is specified for the {index}, column data for the header is retrieved.

  2. If {return} is too small to contain the value, the EOS Condition Flag is set.

  3. The ZERO and OVER Condition Flags are always cleared.

  4. If not specified, {delim} defaults to a comma.

  5. {options} are bit definitions as follows:

 

Value

Constant

Meaning ...

0x1

$LV_GETITEM_QUOTED

The column data is returned in quoted format.

0x10

$LV_GETITEM_NOZEROWIDTH

Any LISTVIEW column with a zero width is skipped.

0x80

$LV_GETITEM_ORDERARRAY

Return the data using the current left-to-right column order. If this bit mask value is not specified, the default is to return the data using the column order as created. (9.4D)

 

 

See Also: Method Syntax, LISTVIEW Methods

 



PL/B Language Reference GetItemText Method (LISTVIEW) GetLastDropXY Method (LISTVIEW)