bdeGetBlockParameterButtonDescription

Returns the value of buttonParameter in a given block.

Syntax

description = bdeGetBlockParameterButtonDescription(block, buttonParameter)

Inputs

block
The block that the parameter is in.
Type: block
buttonParameter
The name of the button parameter.
Type: string

Outputs

description
A description of the button parameter.
Type: string

Examples

Get a description of the button parameter of a block:

          diagram = bdeGetCurrentDiagram();
          block = bdeGetSelectedBlock(diagram);
          description = bdeGetBlockParameterButtonDescription(block, 'button1');
        

          
            description = This is a button used within the user created block