Utility Functions : List of Utility Functions : stm_str_list_previous_element

stm_str_list_previous_element

Function type: STRING

Description
Returns the previous item in the specified list of strings.
Note that “previous” refers to the item physically located before the current item in the list of strings. The “current” item is determined using the utility function stm_str_list_last_element.
Syntax
stm_str_list_previous_element (list, status)
Arguments
 

 

Status Codes
Example
Assume you have a list of strings S1, S2, S3, and S4 assigned to the variable str_list. You locate the string S4 by calling stm_str_list_last_element. S4 becomes the current item. Your template should contain the following statements:

VARIABLE
LIST OF STRING str_list;
STRING str;
INTEGER status;
.
.
str := stm_str_list_last_element (str_list, status);
WRITE (’\n The last string in the list is: ’, str);
str := stm_str_list_previous_element (str_list, status);
WRITE (’\n The third string in the list is: ’, str);
.
.

This function is often used in loop statements.