MsgFieldValue

Syntax

MsgFieldValue(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

Returns the value of a field in the current block.

Returns

str_fieldval

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

Examples

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

Example 65

Returning the value of field #2 in the first instance of blkA.

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

$handle=MsgFrameOpen("*", 0);

$fieldValue=MsgFieldValue($handle, 2);

 

Example 66

Returning the value of field #2 in the 5:th instance of blkA.

The following Before Frame script returns the value of the second field in the 5:th instance of block blkA:

$handle=MsgFrameOpen("blkA:5", 0);

$fieldValue=MsgFieldValue($handle, 2);

 

Example 67

Returning the value of field #2 in the second instance of blkB in the first instance of blkA

The following Before Frame script returns the value of the second field in the second instance of block blkB in the first instance of block blkA:

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

$fieldValue=MsgFieldValue($handle, 2);