AFUFq‖Function Statement

Contents
PrsjV‖

# kny6X‖Function Statement

i3BLj‖A function is a block of code which runs when it is called. A function is usually called in an expression.

fLBaF‖You can pass data, known as parameters or arguments, into a function. You may pass a parameter by value or by reference. When by reference, modifications applied to the parameter in the function will be sent back to the calling code.

9wMCM‖A function usually returns data as a result.

### FVEx2‖Syntax:

ihGud‖

      [Private | Public] Function Name[char] (argument1 [As Type][, argument2[char][,...]]) [As typename]
      JWmQH‖        statements
          [Exit Function]
      2RYwG‖        statements
      End Function

### WADQ4‖Parameters:

NiCPE‖ scope: Function default scope is Public. A Private scope denotes a module internal routine, not intended to be used from other modules.

ZaLxD‖ name: Name of the subroutine to contain the value returned by the function.

W9Yah‖ arguments: Parameters to be passed to the subroutine.

##### aZXf3‖argument fragment

pfHq8‖

          {[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.

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

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‖

          {Boolean|Byte|Currency|Date|Double|Integer|Long|Object|Single|String|Variant}

##### BSD4e‖char fragment

JFwPg‖

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

## 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

Related Topics

YSmVG‖Subroutines basics

Using Procedures, Functions and Properties

Sub Statement

Property Statement

Please support us!