Text Documents (Writer)
HTML Documents (Writer Web)
Spreadsheets (Calc)
Presentations (Impress)
Drawings (Draw)
Database Functionality (Base)
Formulae (Math)
Charts and Diagrams
Macros and Scripting
Office Installation
Common Help Topics
OneOffice Logo

Choose Function

Returns a selected value from a list of arguments.

Syntax:


  Choose (Index As Integer, Expression1[, Expression2, ... [, Expression-n]]) As Variant

Return value:

Variant. A value inferred from the Index parameter.

Parameters:

Index: Any numeric expression rounded to a whole number. Index accepts integer values starting at 1 that specify which of the possible choices to return.

Expression1, Expression2, …, Expression-n: Expressions representing each of the possible choices.

The Choose function returns a value from the list of expressions based on the index value. If Index = 1, the function returns the first expression in the list, if Index = 2, it returns the second expression, and so on.

If the index value is less than 1 or greater than the number of expressions listed, the function returns a Null value.

Error #5 occurs when parameters are omitted. Error #13 occurs if Index equals Null.

Error codes:

5 Invalid procedure call

13 Data type mismatch

Example:

The following example uses the or Choose function to select a string from several strings that form a menu:


Sub ExampleChoose
    Print ChooseMenu(2) ' "Save Format"
    MsgBox Choose(index :=  -5, 9, "Basic", PI) ' Null
    MsgBox Choose(index := 3.14, 9, "Basic", PI) ' PI
End Sub
 
Function ChooseMenu(Index As Integer)
    ChooseMenu = Choose(Index, "Quick Format", "Save Format", "System Format")
End Function