bdeGetBlockParameterDescription

Returns a short description of a parameter in a given block.

Syntax

paramDescription = bdeGetBlockParameterDescription(block, parameter)

Inputs

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

Outputs

paramDescription: A short description of the given parameter.; Type: string

Examples

Get a parameter's short description:


          diagram = bdeGetCurrentDiagram();
          block = bdeGetSelectedBlock(diagram);
          paramDescription = bdeGetBlockParameterDescription(block, 'overflow');


          
            paramDescription = Do on overflow