Instrução Function

Conteúdo

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

### Sintaxe:

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

### Parâmetros:

â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.

##### <variável id="argumenth2">fragmento de argumento</variável>

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

##### Parâmetros

Opcional: O argumento não é obrigatório.

ByRef: O argumento é passado por referência. ByRef é o valor predefinido.

ByVal: O argumento é passado por valor. O seu valor pode ser alterado pela rotina chamada.

char: Carácter de declaração de tipo.

typename: Nome do tipo de dados primitivo. Também é possível especificar tipos definidos por bibliotecas ou módulos.

= expressão: Especifique um valor por defeito para o argumento, de acordo com o seu tipo declarado. Opcional é necessário para cada argumento ao especificar um valor por defeito.

ParamArray: Utilize ParamArray quando o número de parâmetros for indeterminado. Um cenário típico é o de uma função definida pelo utilizador no Calc. A utilização de ParamArray deve limitar-se ao último argumento de uma rotina.

A utilização de ParamArray ou = expressão requer que a Opção Compatible seja colocada antes do código executável do programa num módulo.

Ao utilizar Option VBASupport 1, os argumentos Opcionais sem valor predefinido (= expressão) são inicializados de acordo com o seu tipo de dados, exceto se forem do tipo Variant.

##### fragmento typename

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

##### fragmento de caractere

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

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

Tópicos relacionados

Noções básicas sobre sub-rotinas

Utilização de procedimentos, funções e propriedades

Sub-instrução

Declaração de Propriedade

Necessitamos da sua ajuda!