Thread.SetApartmentState(ApartmentState) Metoda

Definicja

Przestrzeń nazw:

System.Threading

Zestaw:

System.Threading.Thread.dll

Zestaw:

netstandard.dll

Zestaw:

mscorlib.dll

Ustawia stan chłoniaka wątku przed jego rozpoczęciem.

public:
 void SetApartmentState(System::Threading::ApartmentState state);

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

public void SetApartmentState (System.Threading.ApartmentState state);

[<System.Runtime.Versioning.SupportedOSPlatform("windows")>]
member this.SetApartmentState : System.Threading.ApartmentState -> unit

member this.SetApartmentState : System.Threading.ApartmentState -> unit

Public Sub SetApartmentState (state As ApartmentState)

Parametry

state

ApartmentState

Nowy stan województwa.

Atrybuty

SupportedOSPlatformAttribute

Wyjątki

PlatformNotSupportedException

Tylko .NET Core i .NET 5+: we wszystkich przypadkach w systemach macOS i Linux.

ArgumentException

state nie jest prawidłowym stanem tyg.

ThreadStateException

Wątek został już uruchomiony.

InvalidOperationException

Stan chłoniaka został już zainicjowany.

Przykłady

W poniższym przykładzie kodu przedstawiono GetApartmentState metody SetApartmentState , i TrySetApartmentState . Przykładowy kod tworzy wątek. Przed rozpoczęciem wątku program GetApartmentState wyświetla stan początkowy i zmienia stan na ApartmentState.Unknown SetApartmentState ApartmentState.STA . Następnie metoda zwraca wartość podczas próby zmiany stanu na , ponieważ TrySetApartmentState false stan ApartmentState.MTA uwierzytelniania jest już ustawiony. Gdyby ta sama operacja zostałaby podjęto próbę SetApartmentState z , InvalidOperationException zostałby zgłoszony.

Po zakończeniu wątku ponownie TrySetApartmentState używana jest metoda . Tym razem zgłasza ThreadStateException wyjątek, ponieważ wątek został już uruchomiony.

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.

Uwagi

Nowe wątki są inicjowane tak, jakby ich ApartmentState.MTA stan węzła nie został ustawiony przed rozpoczęciem. Przed rozpoczęciem wątku należy ustawić stan chłoniaka.

Uwaga

Główny wątek aplikacji jest domyślnie ApartmentState.MTA inicjowany w programie . Jedynym sposobem ustawienia stanu chłoniaka głównego wątku aplikacji jest zastosowanie atrybutu ApartmentState.STA STAThreadAttribute do metody punktu wejścia.

Metoda SetApartmentState , wraz z metodą i metodą , zastępuje właściwość GetApartmentState TrySetApartmentState ApartmentState .