Istruzione Function (Visual Basic)

Dichiara il nome, i parametri e il codice che definiscono una Function routine.

Sintassi

[ <attributelist> ] [ accessmodifier ] [ proceduremodifiers ] [ Shared ] [ Shadows ] [ Async | Iterator ]
Function name [ (Of typeparamlist) ] [ (parameterlist) ] [ As returntype ] [ Implements implementslist | Handles eventlist ]
    [ statements ]
    [ Exit Function ]
    [ statements ]
End Function

Parti

  • attributelist

    facoltativo. Vedere Elenco attributi.

  • accessmodifier

    facoltativo. Può essere uno dei seguenti:

    Vedere Livelli di accesso in Visual Basic.

  • proceduremodifiers

    facoltativo. Può essere uno dei seguenti:

  • Shared

    facoltativo. Vedere Condiviso.

  • Shadows

    facoltativo. Vedere Ombreggiatura.

  • Async

    facoltativo. Vedere Async.

  • Iterator

    facoltativo. Vedere Iteratore.

  • name

    Obbligatorio. Nome della procedura. Vedere Declared Element Names.

  • typeparamlist

    facoltativo. Elenco di parametri di tipo per una procedura generica. Vedere Elenco tipi.

  • parameterlist

    facoltativo. Elenco dei nomi delle variabili locali che rappresentano i parametri di questa procedura. Vedere Elenco dei parametri.

  • returntype

    Obbligatorio se Option Strict è On. Tipo di dati del valore restituito da questa procedura.

  • Implements

    facoltativo. Indica che questa procedura implementa una o più Function procedure, ognuna definita in un'interfaccia implementata da questa procedura contenente classe o struttura. Vedere Implementazione dell'istruzione .

  • implementslist

    Necessario se si fornisce Implements. Elenco delle routine Function implementate.

    implementedprocedure [ , implementedprocedure ... ]

    Ogni implementedprocedure presenta la sintassi e le parti seguenti:

    interface.definedname

    Parte Descrizione
    interface Obbligatorio. Nome di un'interfaccia implementata da questa procedura contenente la classe o la struttura.
    definedname Obbligatorio. Nome mediante il quale la routine viene definita in interface.
  • Handles

    facoltativo. Indica che questa procedura può gestire uno o più eventi specifici. Vedere Handle.

  • eventlist

    Necessario se si fornisce Handles. Elenco degli eventi gestiti da questa procedura.

    eventspecifier [ , eventspecifier ... ]

    Ogni eventspecifier presenta la sintassi e le parti seguenti:

    eventvariable.event

    Parte Descrizione
    eventvariable Obbligatorio. Variabile oggetto dichiarata con il tipo di dati della classe o della struttura che genera l'evento.
    event Obbligatorio. Nome dell'evento gestito dalla routine.
  • statements

    facoltativo. Blocco di istruzioni da eseguire all'interno di questa procedura.

  • End Function

    Termina la definizione di questa procedura.

Commenti

Tutto il codice eseguibile deve trovarsi all'interno di una routine. Ogni routine, a sua volta, viene dichiarata all'interno di una classe, di una struttura o di un modulo denominato classe, struttura o modulo contenente.

Per restituire un valore al codice chiamante, usare una Function procedura; in caso contrario, usare una Sub procedura.

Definizione di una funzione

È possibile definire una Function routine solo a livello di modulo. Pertanto, il contesto di dichiarazione per una funzione deve essere una classe, una struttura, un modulo o un'interfaccia e non può essere un file di origine, uno spazio dei nomi, una routine o un blocco. Per altre informazioni, vedere Contesti delle dichiarazioni e livelli di accesso predefiniti.

Function procedure predefinite per l'accesso pubblico. È possibile modificare i livelli di accesso con i modificatori di accesso.

Una Function procedura può dichiarare il tipo di dati del valore restituito dalla routine. È possibile specificare qualsiasi tipo di dati o il nome di un'enumerazione, una struttura, una classe o un'interfaccia. Se non si specifica il returntype parametro, la procedura restituisce Object.

Se questa procedura usa la parola chiave, la classe o la struttura contenente deve avere anche un'istruzione ImplementsImplements che segue immediatamente la relativa Class istruzione o Structure . L'istruzione Implements deve includere ogni interfaccia specificata in implementslist. Tuttavia, il nome in base al quale un'interfaccia definisce l'oggetto Function (in ) non deve corrispondere al nome di questa procedura (in definednamename).

Nota

È possibile usare espressioni lambda per definire espressioni di funzione inline. Per altre informazioni, vedere Espressioni di funzione e espressioni lambda.

Restituzione da una funzione

Quando la Function procedura viene restituita al codice chiamante, l'esecuzione continua con l'istruzione che segue l'istruzione che ha chiamato la procedura.

Per restituire un valore da una funzione, è possibile assegnare il valore al nome della funzione o includerlo in un'istruzione Return .

L'istruzione Return assegna simultaneamente il valore restituito e chiude la funzione, come illustrato nell'esempio seguente.

Function MyFunction(ByVal j As Integer) As Double
    Return 3.87 * j
End Function

Nell'esempio seguente viene assegnato il valore restituito al nome myFunction della funzione e quindi viene usata l'istruzione Exit Function per restituire.

Function MyFunction(ByVal j As Integer) As Double
    MyFunction = 3.87 * j
    Exit Function
End Function

Le Exit Function istruzioni e Return causano un'uscita immediata da una Function routine. Qualsiasi numero di Exit Function istruzioni e Return può essere visualizzato ovunque nella procedura e è possibile combinare Exit Function e Return istruzioni.

Se si usa Exit Function senza assegnare un valore a name, la procedura restituisce il valore predefinito per il tipo di dati specificato in returntype. Se returntype non è specificato, la procedura restituisce Nothing, ovvero il valore predefinito per Object.

Chiamata di una funzione

Si chiama una Function routine usando il nome della routine, seguito dall'elenco di argomenti tra parentesi, in un'espressione. È possibile omettere le parentesi solo se non si specificano argomenti. Tuttavia, il codice è più leggibile se si includono sempre le parentesi.

Si chiama una Function routine allo stesso modo in cui si chiama qualsiasi funzione di libreria, Sqrtad esempio , Coso ChrW.

È anche possibile chiamare una funzione usando la Call parola chiave. In questo caso, il valore restituito viene ignorato. L'uso della Call parola chiave non è consigliato nella maggior parte dei casi. Per altre informazioni, vedere Istruzione call.

Visual Basic talvolta riorganizzare espressioni aritmetiche per aumentare l'efficienza interna. Per questo motivo, non è consigliabile usare una routine in un'espressione Function aritmetica quando la funzione modifica il valore delle variabili nella stessa espressione.

Funzioni asincrone

La funzionalità asincrona consente di richiamare funzioni asincrone senza usare callback espliciti o suddividere manualmente il codice tra più funzioni o espressioni lambda.

Se si contrassegna una funzione con il modificatore Async , è possibile usare l'operatore Await nella funzione. Quando il controllo raggiunge un'espressione Await nella Async funzione, il controllo restituisce al chiamante e lo stato della funzione viene sospeso fino al completamento dell'attività attesa. Al termine dell'attività, l'esecuzione può riprendere nella funzione.

Nota

Una Async routine restituisce al chiamante quando rileva il primo oggetto atteso non ancora completato oppure ottiene la fine della Async procedura, che si verifica prima.

Una Async funzione può avere un tipo restituito di Task<TResult> o Task. Di seguito è riportato un Async esempio di Task<TResult> funzione con un tipo restituito.

Una Async funzione non può dichiarare parametri ByRef .

Un'istruzione secondaria può essere contrassegnata anche con il Async modificatore. Viene usato principalmente per i gestori eventi, in cui non è possibile restituire un valore. Non è possibile attendere una AsyncSub procedura e il chiamante di una AsyncSub routine non può rilevare le eccezioni generate dalla Sub procedura.

Per altre informazioni sulle Async funzioni, vedere Programmazione asincrona con Async e Await, Controllo Flow in Programmi asincroni e Tipi restituiti asincroni.

Funzioni iteratore

Una funzione iteratore esegue un'iterazione personalizzata su una raccolta, ad esempio un elenco o una matrice. Una funzione iteratore usa l'istruzione Yield per restituire ogni elemento uno alla volta. Quando viene raggiunta un'istruzione Yield , viene ricordata la posizione corrente nel codice. L'esecuzione viene riavviata a partire da quella posizione la volta successiva che viene chiamata la funzione iteratore.

Si chiama un iteratore dal codice client usando un oggetto For Each... Istruzione successiva .

Il tipo restituito di una funzione iteratore può essere IEnumerable, , IEnumerable<T>IEnumeratoro IEnumerator<T>.

Per altre informazioni, vedere Iteratori.

Esempio 1

Nell'esempio seguente viene usata l'istruzione Function per dichiarare il nome, i parametri e il codice che formano il corpo di una Function routine. Il ParamArray modificatore consente alla funzione di accettare un numero variabile di argomenti.

Public Function CalcSum(ByVal ParamArray args() As Double) As Double
    CalcSum = 0
    If args.Length <= 0 Then Exit Function
    For i As Integer = 0 To UBound(args, 1)
        CalcSum += args(i)
    Next i
End Function

Esempio 2

Nell'esempio seguente viene richiamata la funzione dichiarata nell'esempio precedente.

Module Module1

    Sub Main()
        ' In the following function call, CalcSum's local variables 
        ' are assigned the following values: args(0) = 4, args(1) = 3, 
        ' and so on. The displayed sum is 10.
        Dim returnedValue As Double = CalcSum(4, 3, 2, 1)
        Console.WriteLine("Sum: " & returnedValue)
        ' Parameter args accepts zero or more arguments. The sum 
        ' displayed by the following statements is 0.
        returnedValue = CalcSum()
        Console.WriteLine("Sum: " & returnedValue)
    End Sub

    Public Function CalcSum(ByVal ParamArray args() As Double) As Double
        CalcSum = 0
        If args.Length <= 0 Then Exit Function
        For i As Integer = 0 To UBound(args, 1)
            CalcSum += args(i)
        Next i
    End Function

End Module

Esempio 3

Nell'esempio seguente è DelayAsync un oggetto AsyncFunction con un tipo restituito di Task<TResult>. DelayAsync ha un'istruzione Return che restituisce un numero intero. Pertanto, la dichiarazione di funzione di DelayAsync deve avere un tipo restituito di Task(Of Integer). Poiché il tipo restituito è Task(Of Integer), la valutazione dell'espressione Await in DoSomethingAsync produce un intero. Questa istruzione è illustrata in questa istruzione: Dim result As Integer = Await delayTask.

La startButton_Click procedura è un esempio di Async Sub una routine. Poiché DoSomethingAsync è una Async funzione, l'attività da DoSomethingAsync attendere per la chiamata deve essere attesa, come illustrato nell'istruzione seguente: Await DoSomethingAsync(). La startButton_Clickprocedura deve essere definita con il modificatore perché ha un'espressione AsyncAwait.Sub

' Imports System.Diagnostics
' Imports System.Threading.Tasks

' This Click event is marked with the Async modifier.
Private Async Sub startButton_Click(sender As Object, e As RoutedEventArgs) Handles startButton.Click
    Await DoSomethingAsync()
End Sub

Private Async Function DoSomethingAsync() As Task
    Dim delayTask As Task(Of Integer) = DelayAsync()
    Dim result As Integer = Await delayTask

    ' The previous two statements may be combined into
    ' the following statement.
    ' Dim result As Integer = Await DelayAsync()

    Debug.WriteLine("Result: " & result)
End Function

Private Async Function DelayAsync() As Task(Of Integer)
    Await Task.Delay(100)
    Return 5
End Function

'  Output:
'   Result: 5

Vedi anche