Thread.TrySetApartmentState(ApartmentState) Méthode

Définition

Espace de noms:

System.Threading

Assemblys:

netstandard.dll, System.Threading.Thread.dll

Source:

Thread.cs

Définit l’état d’appartement d’un thread avant son démarrage.

public:
 bool TrySetApartmentState(System::Threading::ApartmentState state);

public bool TrySetApartmentState(System.Threading.ApartmentState state);

member this.TrySetApartmentState : System.Threading.ApartmentState -> bool

Public Function TrySetApartmentState (state As ApartmentState) As Boolean

Paramètres

state

ApartmentState

Le nouvel état de l’appartement.

Retours

Boolean

true si l’état de l’appartement est défini ; sinon, false.

Exceptions

PlatformNotSupportedException

.NET Core et .NET 5+ uniquement : dans tous les cas sur macOS et Linux.

ArgumentException

state n’est pas un état d’appartement valide.

ThreadStateException

Le thread a été démarré et s’est arrêté, ou l’appel n’est pas effectué à partir du contexte du thread pendant l’exécution du thread.

Exemples

L’exemple de code suivant illustre les méthodes et TrySetApartmentState les GetApartmentStateSetApartmentStateméthodes. L’exemple de code crée un thread. Avant le démarrage du thread, GetApartmentState affiche l’état initial ApartmentState.Unknown et SetApartmentState remplace l’état ApartmentState.STApar . La TrySetApartmentState méthode retourne false ensuite lors de la tentative de modification de l’état ApartmentState.MTA , car l’état de l’appartement est déjà défini. Si la même opération avait été tentée avec SetApartmentState, InvalidOperationException aurait été levée.

Une fois le thread démarré, la TrySetApartmentState méthode est utilisée à nouveau. Cette fois,il lève ThreadStateException parce que le thread a déjà été démarré.

using System;
using System.Threading;

class Example
{
    public static void Main()
    {
        Thread t = new Thread(ThreadProc);
        Console.WriteLine("Before setting apartment state: {0}",
            t.GetApartmentState());

        t.SetApartmentState(ApartmentState.STA);
        Console.WriteLine("After setting apartment state: {0}",
            t.GetApartmentState());

        bool result = t.TrySetApartmentState(ApartmentState.MTA);
        Console.WriteLine("Try to change state: {0}", result);

        t.Start();

        Thread.Sleep(500);

        try
        {
            t.TrySetApartmentState(ApartmentState.STA);
        }
        catch (ThreadStateException)
        {
            Console.WriteLine("ThreadStateException occurs " +
                "if apartment state is set after starting thread.");
        }

        t.Join();
    }

    public static void ThreadProc()
    {
        Thread.Sleep(2000);
    }
}

/* This code example produces the following output:

Before setting apartment state: Unknown
After setting apartment state: STA
Try to change state: False
ThreadStateException occurs if apartment state is set after starting thread.
 */

open System.Threading

let threadProc () = Thread.Sleep 2000

let t = Thread threadProc
printfn $"Before setting apartment state: {t.GetApartmentState()}"

t.SetApartmentState ApartmentState.STA
printfn $"After setting apartment state: {t.GetApartmentState()}"

let result = t.TrySetApartmentState ApartmentState.MTA
printfn $"Try to change state: {result}"

t.Start()

Thread.Sleep 500

try
    t.TrySetApartmentState ApartmentState.STA |> ignore
with :? ThreadStateException ->
    printfn "ThreadStateException occurs if apartment state is set after starting thread."

t.Join()

// This code example produces the following output:
//     Before setting apartment state: Unknown
//     After setting apartment state: STA
//     Try to change state: False
//     ThreadStateException occurs if apartment state is set after starting thread.

Imports System.Threading

Module Example

    Sub Main()
 
        Dim t As New Thread(AddressOf ThreadProc)
        Console.WriteLine("Before setting apartment state: {0}", _
            t.GetApartmentState())

        t.SetApartmentState(ApartmentState.STA)
        Console.WriteLine("After setting apartment state: {0}", _
            t.GetApartmentState())

        Dim result As Boolean = _
            t.TrySetApartmentState(ApartmentState.MTA)
        Console.WriteLine("Try to change state: {0}", result)

        t.Start()

        Thread.Sleep(500)

        Try
            t.TrySetApartmentState(ApartmentState.STA)
        Catch ex As ThreadStateException
            Console.WriteLine("ThreadStateException occurs " & _
                "if apartment state is set after starting thread.")
        End Try

        t.Join()
    End Sub

    Sub ThreadProc()
        Thread.Sleep(2000)
    End Sub
End Module

' This code example produces the following output:
'
'Before setting apartment state: Unknown
'After setting apartment state: STA
'Try to change state: False
'ThreadStateException occurs if apartment state is set after starting thread.

Remarques

Les nouveaux threads sont initialisés comme ApartmentState.MTA si leur état d’appartement n’a pas été défini avant qu’ils ne soient démarrés. L’état de l’appartement doit être défini avant le démarrage d’un thread.

Note

Le thread d’application principal est initialisé ApartmentState.MTA par défaut. La seule façon de définir l’état d’appartement du thread ApartmentState.STA d’application principal est d’appliquer l’attribut STAThreadAttribute à la méthode de point d’entrée.

La TrySetApartmentState méthode, ainsi que la GetApartmentState méthode et la SetApartmentState méthode, remplace la ApartmentState propriété.