Frame Class: _getArglist

Frame Class: _getArglist

Gets an SCL list containing arguments passed to the frame

Syntax
Details

Syntax

objectName._getArglist( argumentsList );

Argument Type Use Description

argumentsList Numeric Update specifies the identifier of a list that when returned is filled with the parameters that were passed to the frame (via CALL DISPLAY)

Argument	Type	Use	Description
argumentsList	Numeric	Update	specifies the identifier of a list that when returned is filled with the parameters that were passed to the frame (via CALL DISPLAY)

Details

The _getArglist method specifies the identifier of an SCL list that will contain the actual parameters that were passed to the frame (via CALL DISPLAY). If no parameters were passed, argList is a missing value. The primary purpose of this method is to allow you access to the argument list during a FRAME _init method. The _init method runs before the INIT: section, so the ENTRY statement has not been processed. Use this method also to process parameters for FRAME entries that do not have associated SCL source code.

This method is normally called from the _init method. It cannot be used in the INIT section of the frame unless the ENTRY statement of the frame contains an ARGLIST= or REST= specification.

The list identified by argList is created automatically when the method is called and deleted automatically when the FRAME entry ends. The list has the same semantics as the ARGLIST= list. In fact, if the FRAME ENTRY statement contains an ARGLIST=L2, the list identifiers for argList and L2 are the same. The ENTRY statement, if any, must match the incoming parameters. Otherwise, the method fails, causing a program halt. If the frame does not contain a program, all actual parameters are placed in argList.

If you use the REST= option on the ENTRY statement, _getArglist returns the list identifier for the REST= list. This list may not contain all the arguments. See Example 3.

If _getArglist is invoked from the frame's _init method, you can modify the values of the items on the list. When the INIT section of the frame runs, the ENTRY statement receives the new values. See Example 2.

The TYPE of items in argList (that is, the values returned from ITEMTYPE) is always either 'C' or 'N'. If a list is passed as an argument (as in Example 1), the list identifier of that list is inserted into argList as a numeric item (ITEMTYPE of 'N') rather than as a list (ITEMTYPE of 'L').

Chapter Contents
Previous
Next
Top of Page