Freigeben über


Thread.TrySetApartmentState(ApartmentState) Methode

Definition

Legt den Apartmentzustand eines Threads fest, bevor er 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 Wohnungszustand.

Gibt zurück

truewenn der Wohnungszustand festgelegt ist; andernfalls . false

Ausnahmen

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

state ist kein gültiger Apartmentzustand.

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

Beispiele

Im folgenden Codebeispiel werden die GetApartmentStateMethoden , SetApartmentState, und TrySetApartmentState dies veranschaulicht. Im Codebeispiel wird ein Thread erstellt. Zeigt vor dem Start GetApartmentState des Threads den Anfangszustand ApartmentState.Unknown an und SetApartmentState ändert den Zustand in ApartmentState.STA. Die TrySetApartmentState Methode gibt dann zurück false , wenn Sie versuchen, den Zustand zu ändern, da der Wohnungszustand ApartmentState.MTA bereits festgelegt ist. Wenn derselbe Vorgang versucht worden wäre, SetApartmentStateInvalidOperationException wäre es ausgelöst worden.

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

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.

Hinweise

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

Hinweis

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

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

Gilt für: