Thread.TrySetApartmentState(ApartmentState) Methode

Definition

Namespace:

System.Threading

Assembly:

System.Threading.Thread.dll

Assembly:

netstandard.dll

Assembly:

mscorlib.dll

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

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

Parameter

state

ApartmentState

Der neue Apartmentzustand.

Gibt zurück

Boolean

true, wenn der Apartmentzustand festgelegt wurde, andernfalls false.

Ausnahmen

PlatformNotSupportedException

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

ArgumentException

state ist kein gültiger Apartmentzustand.

ThreadStateException

Der Thread wurde gestartet und beendet, oder der Aufruf erfolgt nicht aus dem Kontext des Threads, während der Thread ausgeführt wird.

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.

using namespace System;
using namespace System::Threading;

void ThreadProc()
{
    Thread::Sleep(2000);
};

void main()
{
    Thread^ t = gcnew Thread(gcnew ThreadStart(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();
}

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

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

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.

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 TrySetApartmentState -Methode ersetzt zusammen mit der GetApartmentState -Methode und SetApartmentState der -Methode die ApartmentState -Eigenschaft.