Global List - Set Position

Sets the current position in a Global List.

Action ID:
Action Category:
Action List Syntax:

113
Global List
GlobalList[<<LISTNAME>>].SetPosition (<<SETTYPE>>)

Settings

Name:

The name of the Global List whose current position you wish to set.

Position

What you want to set the current position to in the specified Global List. Choose from:

First

-

Set the current position to the first item in the Global List.

Last

-

Set the current position to the last item in the Global List.

Next

-

Set the current position to the next item in the list (move the current position ahead by one). If the current position is already at the end of the list, move it to the first item in the Global List instead. In other words, the current position "wraps around" at the end of the Global List.

Previous

-

Set the current position to the previous item in the list (move the current position back by one). If the current position is already at the beginning of the list, move it to the last item in the Global List instead.

Specific Position

-

Set the current position to the position specified in the Index field below.

Index:

The zero-based index to set the current position to in the Global List.

Use -1 to point to the last item in the list, and 0 to point to the first item in the list.

This field is only available when the Specific Position option is selected above.

Error Codes

Value
(%LastErrorNum%)

Simple Message
(%LastErrorMsg%)

Verbose Message
(%LastErrorDetails%)

0 (OK)

 

 

1

MSG_ERR_GLOBAL_LIST_SET_POSITION

MSG_ERR_GLOBAL_LIST_SET_POSITION
MSG_ERR_OBJECT_NOT_FOUND
<<LISTNAME>>

2

MSG_ERR_GLOBAL_LIST_SET_POSITION

MSG_ERR_GLOBAL_LIST_SET_POSITION
MSG_ERR_GLOBAL_LIST_LARGE_INDEX
<<INDEX>>

3

MSG_ERR_GLOBAL_LIST_SET_POSITION

MSG_ERR_GLOBAL_LIST_SET_POSITION
MSG_ERR_GLOBAL_LIST_NEGATIVE_INDEX
<<INDEX>>

Examples

None