Auf Englisch lesen

Freigeben über


Thread.SetApartmentState(ApartmentState) Methode

Definition

Legt den Apartmentzustand eines Threads fest, bevor dieser gestartet wird.

C#
[System.Runtime.Versioning.SupportedOSPlatform("windows")]
public void SetApartmentState (System.Threading.ApartmentState state);
C#
public void SetApartmentState (System.Threading.ApartmentState state);

Parameter

state
ApartmentState

Der neue Apartmentzustand.

Attribute

Ausnahmen

Nur .NET Core und .NET 5+ : In allen Fällen unter macOS und Linux.

state ist kein gültiger Apartmentzustand.

Der Thread wurde bereits gestartet.

Der Apartmentzustand wurde bereits initialisiert.

Beispiele

Im folgenden Codebeispiel werden die GetApartmentState SetApartmentState Methoden , und TrySetApartmentState veranschaulicht. Im Codebeispiel wird ein Thread erstellt. Bevor der Thread gestartet wird, zeigt den Anfangszustand an GetApartmentState und ändert den Zustand in ApartmentState.Unknown SetApartmentState ApartmentState.STA . Die TrySetApartmentState -Methode gibt dann false zurück, wenn versucht wird, den Zustand in zu ApartmentState.MTA ändern, da der Apartmentzustand bereits festgelegt ist. Wenn der gleiche Vorgang mit versucht worden SetApartmentState InvalidOperationException wäre, wäre ausgelöst worden.

Nachdem der Thread gestartet wurde, wird die TrySetApartmentState -Methode erneut verwendet. Dieses Mal wird ThreadStateException ausgelöst, weil der Thread bereits gestartet wurde.

C#
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.
 */

Hinweise

Neue Threads werden initialisiert, als ApartmentState.MTA ob ihr Apartmentzustand nicht festgelegt wurde, bevor sie gestartet werden. Der Apartmentzustand muss festgelegt werden, bevor ein Thread gestartet wird.

Hinweis

Der Hauptanwendungsthread wird standardmäßig mit ApartmentState.MTA initialisiert. Die einzige Möglichkeit, den Apartmentzustand des Hauptanwendungsthreads auf ApartmentState.STA festzulegen, besteht darin, das STAThreadAttribute -Attribut auf die Einstiegspunktmethode anzuwenden.

Die SetApartmentState -Methode ersetzt zusammen mit der GetApartmentState -Methode und TrySetApartmentState der -Methode die ApartmentState -Eigenschaft.

Gilt für

Produkt Versionen
.NET Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8
.NET Standard 2.0, 2.1