GetButton Method (TOOLBAR)


PLBCMP GUI Only

 

The GetButton method obtains a button from a TOOLBAR object. The method uses the following format:

 

[label]

{object}.GetButton

[GIVING {return}] USING [*Key=]{key}]

 

Where:

label

Optional. A Program Execution Label.

object

Required. A TOOLBAR object to which a button is added.

return

Optional. A TOOLBUTTON object that gets the return value.

key

Required. A Character String Variable or Numeric Variable that specifies the run-time name or zero-based position of the button.

Flags Affected: EOS, OVER, ZERO

Note the following:

  1. Use the TEST instruction on the {return} object to ensure a button was returned.

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

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

 

 

See Also: Method Syntax, TOOLBAR Methods

 



PL/B Language Reference AddButton Method (TOOLBAR) GetButtonByState (TOOLBAR)