MsgFrameGetValue

Syntax

MsgFrameGetValue(field);

field

A string specifying the name of a field in the current frame.

Description

Retrieves the value of a specified field in the current frame.

Returns

str_fieldval

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

Examples

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

Example 71

Returning the value of field idType in the second instance of blkA.

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

$fieldValue=MsgFrameGetValue("blkA:2/idType");

 

Example 72

Returning the value of field idType in the second instance of blkB in the first instance of blkA.

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

$fieldValue=MsgFrameGetValue("blkA:1/blkB:2/idType");

 

Example 73

Returning the value of field idType in the second instance of blkB in the N:th instance of blkA.

The following script sample includes a counter to specify the N:th instance of block blkA:

...

$counter = 1;

$fieldValue=MsgFrameGetValue("blkA:" + $counter +"/blkB:2/idType");

$counter++;

...