GetItemText Method (LISTVIEW)


PLBCMP GUI Only

 

The GetItemText method retrieves the text for a specified item in a LISTVIEW object. The method uses the following format:

 

[label]

{object}.GetItemText

[GIVING {return}] USING [*Index=]{index}[:

 

 

[*Subitem=]{subitem}]

 

Where:

label

Optional. A Program Execution Label.

object

Required. A LISTVIEW object that is accessed.

return

Optional. A Character String Variable that returns the item's text.

index

Required. A zero-based decimal number or Numeric Variable that specifies the item or row accessed.

subitem

Optional. A zero-based decimal number or Numeric Variable that specifies the sub-item number.

Flags Affected: EOS, OVER, ZERO

Note the following:

  1. {sub-item} specifies that the text is to come from a child item (column) of {index}. If not given, zero is assumed and the text from the item label is returned.

  2. Upon completion, {return} will contain the specified item's text.

  3. If {return} is too small to contain the text string, the EOS Condition Flag is set.

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

 

 

See Also: Example Code, Method Syntax, LISTVIEW Methods

 



PL/B Language Reference GetItemState Method (LISTVIEW) GetItemTextAll Method (LISTVIEW)