ShowArray Function

Format

i = showarray(ʃheading,ʅarray_nameʃ,row_countʅʃ,column_countʅʃ,title(text_list)ʅ);

Description

The showarray function, similar to the show and accept functions, displays items from an array in a grid. An optional string expression, heading, defines the title of the grid, which contains the items in array_name. The function is useful as a menu or simply as a way to show values that are relevant to data collection. If the optional numeric expressions row_count and column_count are not specified, then the function will parse the array, determining the size of the menu based on where the first blank alphanumeric element is found. If you want to override the column headings, you can specify them in with string expressions in text_title.

Return Value

The function returns the number of the item selected: 1 for the first item, 2 for the second item, etc. The value 0 is returned if the escape key (or back button) is pressed and none of the options is chosen.

Example 1

PROC GLOBAL

array string unitedNationsCountryCodes(5,3) =
"004", "Afghanistan", "AFG",
"248", "Åland Islands", "ALA",
"008", "Albania", "ALB",
"012", "Algeria", "DZA",
"016", "American Samoa", "ASM",
// ...
;

PROC EXAMPLE

numeric countrySelection = showarray("Select a Country",unitedNationsCountryCodes,
title("Numerical Code","Country or Area Name","ISO ALPHA-3 Code"));

Example 2

numeric countrySelection = showarray(unitedNationsCountryCodes,3,2);