Declaração de função
Uma função é um bloco de código que é executado quando é chamado. Normalmente, uma função é chamada numa expressão.
É possível passar dados, conhecidos como parâmetros ou argumentos, para uma função. Pode-se passar um parâmetro por valor ou por referência. Quando se passa por referência, as alterações aplicadas ao parâmetro na função serão devolvidas ao código que a chamou.
Uma função normalmente devolve dados como resultado.
[Private | Public] Function Name[char] (argument1 [As Type][, argument2[char][,...]]) [As typename]
declarações
[Exit Function]
declarações
End Function
âmbito: O âmbito predefinido de uma função é Público. Um âmbito Privado indica uma rotina interna do módulo, que não se destina a ser utilizada a partir de outros módulos.
nome: Nome da sub-rotina que irá conter o valor devolvido pela função.
argumentos: Parâmetros a passar à sub-rotina.
argument fragment
{[Optional [ByRef|ByVal]]|ParamArray} argument {{As typename|char}[ = expression]|[()]As Variant}
Parameters
Optional: The argument is not mandatory.
ByRef: The argument is passed by reference. ByRef is the default.
ByVal: The argument is passed by value. Its value can be modified by the called routine.
char: Type declaration character.
typename: Primitive data type name. Library or module defined types can also be specified.
= expression: Specify a default value for the argument, matching its declared type. Optional is necessary for each argument specifying a default value.
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.
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.
Exemplos:
Sub ExampleExit
Dim sReturn As String
Dim sListArray(10) As String
Dim siStep As Single
For siStep = 0 To 10 ' Preencher matriz com dados de teste
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 procura uma TextArray:sList() para TextEntry:
' O valor devolvido é o índice da entrada ou 0 (Null)
For iCount=1 To Ubound( sList() )
If sList( iCount ) = sItem Then
Encontrado Exit For ' sItem
End If
Next iCount
If iCount = Ubound( sList() ) Then iCount = 0
LinSearch = iCount
End Function
