eda_type_to_index Function

Retrieves the type index for the specified string containing a block type.

Syntax

Function eda_type_to_index (NodeName, BlockType)

Properties

The eda_type_to_index function syntax has these parts:

Part

Description

object

An object expression that evaluates to an object in the Applies To list.

NodeName

String. Name of node on which the block is located.

BlockType

String. The block type whose block index is required.

Return Value

Integer. The database block type (a value between 1 and 150). Returns 0 if the type name is not recognized.

Remarks

The block index returned by this function should be used when adding blocks to the database via the eda_add_block function.