aFEZS‖

eRCuT‖Sub Statement

YELg8‖Defines a subroutine.

FVEx2‖Syntax:

eTB6g‖ Sub Statement diagram


[Private | Public] Sub name[(argument1 [As typename][, argument2[char][,...]])]
CUBak‖    ' statements
    [Exit Sub]
  AAbLp‖  ' statements
End Sub

WADQ4‖Parameters:

AraEB‖ name: Name of the subroutine.

G5FAW‖ arguments: Optional parameters that you want to pass to the subroutine.

aZXf3‖argument fragment

pfHq8‖argument fragment


      {[Optional [ByRef|ByVal]]|ParamArray} argument {{As typename|char}[ = expression]|[()]As Variant}
    
zqKwG‖Parameters

E7GXy‖Optional: The argument is not mandatory.

FEs39‖ByRef: The argument is passed by reference. ByRef is the default.

WuCPC‖ByVal: The argument is passed by value. Its value can be modified by the called routine.

GrfMS‖char: Type declaration character.

Naxwg‖typename: Primitive data type name. Library or module defined types can also be specified.

KwsyR‖= expression: Specify a default value for the argument, matching its declared type. Optional is necessary for each argument specifying a default value.

4Atx8‖ParamArray: Use ParamArray when the number of parameters is undetermined. A typical scenario is that of a Calc user-defined function. Using ParamArray should be limited to the last argument of a routine.

tip

VBQVA‖UsingParamArray or = expression require Option Compatible to be placed before the executable program code in a module.


warning

X2WBz‖When using Option VBASupport 1, Optional arguments with no default value (= expression) are initialized according to their data type, except if Variant.


E9UTU‖typename fragment

AqfYj‖primitive data types fragment


      {Boolean|Byte|Currency|Date|Double|Integer|Long|Object|Single|String|Variant}
    
BSD4e‖char fragment

JFwPg‖type declaration characters


      { % | & | ! | # | $ | @ }
    

LGVjB‖Examples:


Sub ExampleExit
Dim sReturn As String
Dim sListArray(10) As String
Dim siStep As Single
HAoVj‖    For siStep = 0 To 10 ' Fill array with test data
        sListArray(siStep) = chr$(siStep + 65)
        MsgBox sListArray(siStep)
    Next siStep
    sReturn = LinSearch(sListArray(), "B")
    Print sReturn
End Sub
 
Function LinSearch( sList(), sItem As String ) As Integer
Dim iCount As Integer
yBFND‖' Linsearch searches a TextArray:sList() for a TextEntry:
aVKdf‖' Return value Is the index of the entry Or 0 (Null)
    For iCount=1 To Ubound( sList() )
        If sList( iCount ) = sItem Then
f8HNy‖            Exit For ' sItem found
        End If
    Next iCount
    If iCount = Ubound( sList() ) Then iCount = 0
    LinSearch = iCount
End Function