bdeGetBlockParameterTooltip

Returns a description of a parameter in a given block that is useful for understanding the parameters.

Syntax

paramTip = bdeGetBlockParameterTooltip(block, parameter)

Inputs

block
The block that the parameter is in.
Type: block
parameter
The parameter to get the description of.
Type: string

Outputs

paramTip
A description of the given parameter. Includes what the parameter is used for as well as options of what arguments can be used.
Type: string

Examples

Get a parameter's tooltip/useful information about the block's parameter's valid options: 

          diagram = bdeGetCurrentDiagram();
          block = bdeGetSelectedBlock(diagram);
          paramTip = bdeGetBlockParameterTooltip(block, 'overflow');
        

          
            paramTip = Defines the action in case of an overflow during the operation. Options are : "Nothing" (gives a normal, non satured result), "Saturate" (gives a saturated result), "Error" (gives an error message).