bdeGetBlockShortDescription

Returns a short description of a given block, if it has one.

Syntax

description = bdeGetBlockShortDescription(block)

Inputs

block: The block to get the short description of.; Type: block

Outputs

description: A short description of block. Only will work if the block has a short description set.; Type: string

Examples

Get a short description of block:


          diagram = bdeGetCurrentDiagram();
          block = bdeGetSelectedBlock(diagram);
          description = bdeGetBlockShortDescription(block);


          
            description = TestDescription