MsgFrameOpen

Syntax

MsgFrameOpen(str_block_address, num_traverse_level);

str_block_address

A string specifying the block where to start traversing the Message. Empty string If you specify an empty string (““), the Message traversing will start at the current location. Wildcards The following three examples illustrate how you can use wildcards in the block address string. Match the first block in the frame: * Match the first child block of the block blkA: blkA/* Match the 5:th instance of the block blkA: blkA:5

num_traverse_level

A number specifying the number of levels to traverse, starting from the specified block: 0 - Traverse the entire subtree. 1 - Include blocks at the same level as specified block. 2 - Same as 1, plus child blocks. 3 - Same as 2, plus child blocks of child blocks. etc.

Description

Defines where in the current frame to start traversing the Message. This function can only be used in PageOUT.

Returns

travhandl	A handle is returned if the frame was successfully traversed. The handle identifies this specific traversing pass.
-1	Failed to perform the traversing pass. Possible reasons include no block found, or that the function was called in the wrong context.

Example

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