Function Statement

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

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.

A function usually returns data as a result.


Function Statement diagram

  [Private | Public] Function Name[char] (argument1 [As Type][, argument2[char][,...]]) [As typename]
      [Exit Function]
  End Function


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

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

arguments: Parameters to be passed to the subroutine.

fragment Argument

argument fragment

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

Optional: l'argument no és obligatori.

ByRef L'argument es passa per referència. ByRef és el predeterminat.

ByVal L'argument es passa per valor. El seu valor es pot modificar per la rutina anomenada.

char: caràcter de declaració del Tipus.

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

= expressió Especifiqueu un valor predeterminat per a l'argument que coincideix amb el seu tipus declarat. Opcional és necessari per a cada argument que especifiqui un valor predeterminat.

ParamArray Usa ParamArray quan el nombre de paràmetres no està determinat. Un escenari típic és el d'una funció definida per l'usuari del Calc. L'ús del ParamArray hauria de limitar-se a l'últim argument d'una rutina.


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


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

typename fragment

primitive data types fragment

char fragment

type declaration caràcters

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


Sub ExampleExit
Dim sReturn As String
Dim sListArray(10) As String
Dim siStep As Single
    For siStep = 0 to 10 ' Omple la matriu amb dades de prova
        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
' Linsearch cerca TextEntry en un TextArray:sList():
' El valor de retorn és l'índex de l'entrada o 0 (Null)
    For iCount=1 To Ubound( sList() )
        If sList( iCount ) = sItem Then
            Exit For ' sItem trobat
        End If
    Next iCount
    If iCount = Ubound( sList() ) Then iCount = 0
    LinSearch = iCount
End Function

Ens cal la vostra ajuda!