DeleteString Method (COMBOBOX / DATALIST)


PLBCMP GUI Only

 

The DeleteString method removes a string from a DATALIST or COMBOBOX object. The method uses the following format:

 

[label]

{object}.DeleteString

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

 

Where:

label

Optional. A Program Execution Label.

object

Required. A DATALIST or COMBOBOX object from which a string is deleted.

return

Optional. A Numeric Variable that returns the number of strings left in the list.

index

Required. A zero-based decimal number or Numeric Variable that indicates the string to delete.

Flags Affected: EOS, OVER, ZERO

Note the following:

  1. Upon completion, {return} will contain the number of items left in the list.

  2. If the value returned is zero, the ZERO Condition Flag is set.

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

  4. The EOS Condition Flag is always cleared.

  5. For improved performance in the Application Server environment, do not specify the optional return value unless needed.

 

 

See Also: Method Syntax, DATALIST Methods, COMBOBOX Methods

 



PL/B Language Reference AllowEmptyTab (DATALIST) Dir Method (COMBOBOX / DATALIST)