out (référence C#)

Utilisez le out mot clé dans deux contextes :

• En tant que modificateur de paramètre, que vous utilisez pour passer un argument à une méthode par référence plutôt que par valeur.
• Dans les déclarations de paramètre de type générique pour les interfaces et les délégués, que vous utilisez pour spécifier qu’un paramètre de type est covariant.

La documentation de référence du langage C# décrit la version la plus récente du langage C#. Il contient également la documentation initiale des fonctionnalités dans les préversions publiques pour la prochaine version du langage.

La documentation identifie toute fonctionnalité introduite en premier dans les trois dernières versions de la langue ou dans les préversions publiques actuelles.

Conseil / Astuce

Pour savoir quand une fonctionnalité a été introduite en C#, consultez l’article sur l’historique des versions du langage C#.

Le modificateur de out paramètre est particulièrement utile lorsqu’une méthode doit retourner plusieurs valeurs, car vous pouvez utiliser plusieurs out paramètres. Par exemple,

    public void Main()
    {
        double radiusValue = 3.92781;
        //Calculate the circumference and area of a circle, returning the results to Main().
        CalculateCircumferenceAndArea(radiusValue, out double circumferenceResult, out var areaResult);
        System.Console.WriteLine($"Circumference of a circle with a radius of {radiusValue} is {circumferenceResult}.");
        System.Console.WriteLine($"Area of a circle with a radius of {radiusValue} is {areaResult}.");
        Console.ReadLine();
    }

    //The calculation worker method.
    public static void CalculateCircumferenceAndArea(double radius, out double circumference, out double area)
    {
        circumference = 2 * Math.PI * radius;
        area = Math.PI * (radius * radius);
    }

Les limitations suivantes s’appliquent à l’utilisation du out mot clé :

• Vous ne pouvez pas utiliser out de paramètres dans les méthodes asynchrones.
• Vous ne pouvez pas utiliser out de paramètres dans les méthodes d’itérateur.
• Vous ne pouvez pas passer les propriétés en tant que out paramètres.