Thread.SetApartmentState(ApartmentState) Methode

Definition

Legt den Apartmentzustand eines Threads fest, bevor dieser gestartet wird.Sets the apartment state of a thread before it is started.

public:
 void SetApartmentState(System::Threading::ApartmentState state);
public void SetApartmentState (System.Threading.ApartmentState state);
member this.SetApartmentState : System.Threading.ApartmentState -> unit
Public Sub SetApartmentState (state As ApartmentState)

Parameter

state
ApartmentState

Der neue Apartmentzustand.The new apartment state.

Ausnahmen

.NET 5.0 und höher sowie .NET Core: in allen Fällen unter macOS und Linux..NET 5.0 and later and .NET Core: In all cases on macOS and Linux.

state ist kein gültiger Apartmentzustand.state is not a valid apartment state.

Der Thread wurde bereits gestartet.The thread has already been started.

Der Apartmentzustand wurde bereits initialisiert.The apartment state has already been initialized.

Beispiele

Im folgenden Codebeispiel werden die GetApartmentState SetApartmentState Methoden, und veranschaulicht TrySetApartmentState .The following code example demonstrates the GetApartmentState, SetApartmentState, and TrySetApartmentState methods. Im Codebeispiel wird ein Thread erstellt.The code example creates a thread. Bevor der Thread gestartet wird, wird GetApartmentState der Anfangs ApartmentState.Unknown Zustand angezeigt, und SetApartmentState der Status wird in geändert ApartmentState.STA .Before the thread is started, GetApartmentState displays the initial ApartmentState.Unknown state and SetApartmentState changes the state to ApartmentState.STA. Die- TrySetApartmentState Methode gibt dann zurück false , wenn versucht wird, den Zustand in zu ändern, ApartmentState.MTA da der Apartment Zustand bereits festgelegt ist.The TrySetApartmentState method then returns false when attempting to change the state to ApartmentState.MTA because the apartment state is already set. Wenn der gleiche Vorgang mit versucht wurde, hätte ausgelöst SetApartmentState InvalidOperationException .If the same operation had been attempted with SetApartmentState, InvalidOperationException would have been thrown.

Nachdem der Thread gestartet wurde, wird die- TrySetApartmentState Methode erneut verwendet.After the thread is started, the TrySetApartmentState method is used again. Dieses Mal wird eine Ausnahme ThreadStateException ausgelöst, da der Thread bereits gestartet wurde.This time it throws ThreadStateException because the thread has already been started.

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 der Apartment Zustand nicht festgelegt wurde, bevor Sie gestartet werden.New threads are initialized as ApartmentState.MTA if their apartment state has not been set before they are started. Der Apartment Zustand muss festgelegt werden, bevor ein Thread gestartet wird.Apartment state must be set before a thread is started.

Hinweis

Der Hauptanwendungs Thread wird standardmäßig auf initialisiert ApartmentState.MTA .The main application thread is initialized to ApartmentState.MTA by default. Die einzige Möglichkeit, den Apartment Zustand des Hauptanwendungs Threads auf festzulegen, ApartmentState.STA ist das Anwenden des- STAThreadAttribute Attributs auf die Einstiegspunkt Methode.The only way to set the apartment state of the main application thread to ApartmentState.STA is to apply the STAThreadAttribute attribute to the entry point method.

Die SetApartmentState -Methode wird zusammen mit der GetApartmentState -Methode und der-Methode durch die- TrySetApartmentState ApartmentState Eigenschaft ersetzt.The SetApartmentState method, along with the GetApartmentState method and the TrySetApartmentState method, replaces the ApartmentState property.

Gilt für: