Thread.SetApartmentState(ApartmentState) Método

Definição

Namespace:

System.Threading

Assembly:

System.Threading.Thread.dll

Origem:

Thread.cs

Define o estado do apartment de um thread antes que ele seja iniciado.

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

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

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

Public Sub SetApartmentState (state As ApartmentState)

Parâmetros

state

ApartmentState

O novo estado de apartment.

Atributos

SupportedOSPlatformAttribute

Exceções

PlatformNotSupportedException

Somente .NET Core e .NET 5+: em todos os casos no macOS e linux.

ArgumentException

state não é um estado de apartment válido.

ThreadStateException

O thread já foi iniciado.

InvalidOperationException

O estado de apartment já foi inicializado.

Exemplos

O exemplo de código a seguir demonstra os métodos GetApartmentState, SetApartmentState e TrySetApartmentState. O exemplo de código cria um thread. Antes de o thread ser iniciado, GetApartmentState exibe o estado inicial ApartmentState.Unknown e SetApartmentState altera o estado para ApartmentState.STA. Em TrySetApartmentState seguida, o método retorna false ao tentar alterar o estado para ApartmentState.MTA porque o estado do apartamento já está definido. Se a mesma operação tivesse sido tentada com SetApartmentState, InvalidOperationException teria sido lançada.

Depois que o thread é iniciado, o TrySetApartmentState método é usado novamente. Desta vez, ele é gerado ThreadStateException porque o thread já foi iniciado.

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

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.

Comentários

Novos threads são inicializados como ApartmentState.MTA se seu estado de apartamento não tivesse sido definido antes de serem iniciados. O estado do apartamento deve ser definido antes de um thread ser iniciado.

Observação

O thread do aplicativo principal é inicializado para ApartmentState.MTA por padrão. A única maneira de definir o estado do apartment do thread ApartmentState.STA de aplicativo principal é aplicar o STAThreadAttribute atributo ao método de ponto de entrada.

O SetApartmentState método , juntamente com o GetApartmentState método e o TrySetApartmentState método , substitui a ApartmentState propriedade .