Spis treści

# Instrukcja Function

Funkcja to blok kodu, który jest uruchamiany po wywołaniu. Funkcja jest zwykle wywoływana w wyrażeniu.

Do funkcji można przekazywać dane, zwane parametrami lub argumentami. Możesz przekazać parametr przez wartość lub przez odwołanie. Gdy przez odwołanie, modyfikacje zastosowane do parametru w funkcji zostaną odesłane z powrotem do kodu wywołującego.

Funkcja zwykle zwraca dane jako wynik.

### Składnia:

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

### Parametry:

scope: Domyślny zakres funkcji to Public. Zakres Private oznacza wewnętrzną procedurę modułu, która nie jest przeznaczona do użycia z innymi modułami.

name: Nazwa podprogramu, który ma zawierać wartość zwróconą przez funkcję.

arguments: Parametry, które mają zostać przekazane do podprogramu standardowego.

##### Fragment argumentu

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

##### Parametry

Optional: Argument nie jest obowiązkowy.

ByRef: Argument jest przekazywany przez odwołanie. Wartość domyślna to WgRef.

ByVal: Argument jest przekazywany przez wartość. Jego wartość może być modyfikowana przez wywoływaną procedurę.

char: Wpisz znak deklaracji.

typename: Pierwotna nazwa typu danych. Można również określić typy zdefiniowane w bibliotece lub module.

= expression: Określ domyślną wartość argumentu, odpowiadającą zadeklarowanemu typowi. Optional jest konieczne dla każdego argumentu określającego wartość domyślną.

ParamArray: Użyj ParamArray, gdy liczba parametrów jest nieokreślona. Typowym scenariuszem jest funkcja zdefiniowana przez użytkownika programu Calc. Użycie ParamArray powinno być ograniczone do ostatniego argumentu procedury.

Korzystanie z ParamArray lub = expression wymaga umieszczenia Option Compatible przed kodem programu wykonywalnego w module.

Podczas używania argumentów Option VBASupport 1, Optional bez wartości domyślnej (= expression) są inicjowane zgodnie z ich typem danych, z wyjątkiem sytuacji, gdy Variant.

##### Fragment TypeName

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

##### Fragment znaku

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

## Przykłady:

    Sub ExampleExit
    Dim sReturn As String
    Dim sListArray(10) As String
    Dim siStep As Single
        For siStep = 0 to 10 ' Wypełnienie tablicy danymi testowymi
            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
    ' Funkcja Linsearch poszukuje wyrażenia TextEntry w tablicy TextArray:sList():
    ' Wynikiem funkcji jest indeks wystąpienia wyrażenia lub wartość 0 (Null)
        For iCount=1 To Ubound( sList() )
            If sList( iCount ) = sItem Then
                Exit For ' Odnalezione wyrażenie sItem
            End If
        Next iCount
        If iCount = Ubound( sList() ) Then iCount = 0
        LinSearch = iCount
    End Function

Tematy pokrewne

Podstawy podprogramów

Korzystanie z procedur, funkcji i właściwości

Instrukcja Sub

Instrukcja Property