MsgFieldId

Syntax

MsgFieldId(travhandl, num_index);

travhandl	The handle used to identify this specific traversing pass. The handle is specified using the MsgOpen, MsgFrameOpen, or MsgFrameOpen function.
num_index	The field index in the block.

Description

Retrieves the name of a field (not field value) in the current block.

Returns

str	The field name. If the field does not exist, or index is out of range, an empty string is returned.

Example

In this example, the Message contains the blocks blkA, blkB, and blkC structured as shown in the figure below.

The following Before Frame script in a PageOUT Process returns the name of the second field in the first instance of block blkB in the first instance of block blkA:

$handle=MsgFrameOpen("blkA:1/blkB:1", 0);

$numFields=MsgFieldId($handle, 2);