Function-uttrykket

Definerer ein subrutine som kan nyttast som eit uttrykk for Ă„ bestemma return-typen.

note

Sub, Function or Property statements are similar methods, without distinction. They receive parameters by reference allowing them to be modified in return. LibreOffice Basic compiler accepts their respective argument syntax to be used interchangeably.


Syntaks:

Diagram over uttrykket Function


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

Parametrar:

scope: «Function» sitt omfang er Public. Eit Private omfang er ein intern rutine i ein modul, ikkje tenkt brukt frÄ andre modular.

Namn: Namnet pÄ subrutiinen som inneheld verdien som vert returnert av funksjonen.

arguments Parameter som skal sendast til subrutinen.

argument fragment

argumentfragment


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

Optional: Argumentet er ikkje obligatorisk.

ByRef: Argumentet vert overfĂžrt ved referanse. ByRef er standard.

ByVal: Argumentet vert overfĂžrt ved verdi. Verdien kan endrast av den oppkalla rutinen.

char: Typedeklareringsteikn.

typename: Primitivt datatypenamn. OgsÄ bibliotek eller moduldefinerte typar kan spesifiserast.

= expression: Oppgjev ein standardverdi for argumentet som samsvarar med den deklarerte typen. Optional er nĂždvendig for kvart argument som er ein standardverdi.

ParamArray: Bruk ParamArray nÄr talet pÄ parametrar ikkje er fastsett. Eit typiske scenario er ein brukardefinert funksjon i Calc. Bruken av ParamArray mÄ avgrensast til det siste argumentet i ein rutine.

tip

Bruk av ParamArray eller = expression krev at Option Compatible er sett inn i ein modul framfĂžre programkoden som skal utfĂžrast.


warning

NÄr du brukar Option VBASupport 1, vert argumenta Optional brukte utan standardverdi (= expression) initialiserte ut frÄ datatypen, bortsett frÄ Variant.


typename fragment

fragment av primitive datatypar


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

typedeklareringsteikn


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

Eksempel:


Sub ExampleExit
Dim sReturn As String
Dim sListArray(10) As String
Dim siStep As Single
    For siStep = 0 To 10 ' Fyll tabellen med testdata
        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 sĂžkjer ei TextArray:sList() etter eit TextEntry:
' Returverdien er indeksen for oppfĂžringa eller 0 (Null)
    For iCount=1 To Ubound( sList() )
        If sList( iCount ) = sItem Then
            Exit For ' sItem funne
        End If
    Next iCount
    If iCount = Ubound( sList() ) Then iCount = 0
    LinSearch = iCount
End Function