ApartmentState Enumeração

Definição

Namespace:

System.Threading

Assembly:

System.Threading.Thread.dll

Assembly:

mscorlib.dll

Assembly:

netstandard.dll

Especifica o estado de apartment de um Thread.

public enum class ApartmentState

public enum ApartmentState

[System.Serializable]
public enum ApartmentState

[System.Serializable]
[System.Runtime.InteropServices.ComVisible(true)]
public enum ApartmentState

type ApartmentState = 

[<System.Serializable>]
type ApartmentState = 

[<System.Serializable>]
[<System.Runtime.InteropServices.ComVisible(true)>]
type ApartmentState = 

Public Enum ApartmentState

Herança

Object

ValueType

Enum

ApartmentState

Atributos

SerializableAttribute ComVisibleAttribute

Campos

MTA	1	O Thread vai criar e inserir um Multi-Threaded Apartment.
STA	0	O Thread vai criar e inserir um Single-Threaded Apartment.
Unknown	2	A propriedade ApartmentState não foi definida.

Exemplos

O exemplo de código a seguir demonstra como definir o estado do apartamento de um thread.

using namespace System;
using namespace System::Threading;
ref class ApartmentTest
{
public:
   static void ThreadMethod()
   {
      Thread::Sleep( 1000 );
   }

};

int main()
{
   Thread^ newThread = gcnew Thread( gcnew ThreadStart( &ApartmentTest::ThreadMethod ) );
   newThread->SetApartmentState(ApartmentState::MTA);
   
   Console::WriteLine( "ThreadState: {0}, ApartmentState: {1}", newThread->ThreadState.ToString(), newThread->GetApartmentState().ToString() );
   newThread->Start();
   
   // Wait for newThread to start and go to sleep.
   Thread::Sleep( 300 );
   try
   {
      
      // This causes an exception since newThread is sleeping.
      newThread->SetApartmentState(ApartmentState::STA);
   }
   catch ( ThreadStateException^ stateException ) 
   {
      Console::WriteLine( "\n{0} caught:\n"
      "Thread is not in the Unstarted or Running state.", stateException->GetType()->Name );
      Console::WriteLine( "ThreadState: {0}, ApartmentState: {1}", newThread->ThreadState.ToString(), newThread->GetApartmentState().ToString() );
   }

}

using System;
using System.Threading;

class ApartmentTest
{
    static void Main()
    {
        Thread newThread = 
            new Thread(new ThreadStart(ThreadMethod));
        newThread.SetApartmentState(ApartmentState.MTA);

        Console.WriteLine("ThreadState: {0}, ApartmentState: {1}", 
            newThread.ThreadState, newThread.GetApartmentState());

        newThread.Start();

        // Wait for newThread to start and go to sleep.
        Thread.Sleep(300);
        try
        {
            // This causes an exception since newThread is sleeping.
            newThread.SetApartmentState(ApartmentState.STA);
        }
        catch(ThreadStateException stateException)
        {
            Console.WriteLine("\n{0} caught:\n" +
                "Thread is not in the Unstarted or Running state.", 
                stateException.GetType().Name);
            Console.WriteLine("ThreadState: {0}, ApartmentState: {1}",
                newThread.ThreadState, newThread.GetApartmentState());
        }
    }

    static void ThreadMethod()
    {
        Thread.Sleep(1000);
    }
}

Imports System.Threading

Public Class ApartmentTest

    <MTAThread> _
    Shared Sub Main()
    
        Dim newThread As Thread = New Thread(AddressOf ThreadMethod)
        newThread.SetApartmentState(ApartmentState.MTA)

        Console.WriteLine("ThreadState: {0}, ApartmentState: {1}", _
            newThread.ThreadState, newThread.GetApartmentState())

        newThread.Start()

        ' Wait for newThread to start and go to sleep.
        Thread.Sleep(300)
        Try
            ' This causes an exception since newThread is sleeping.
            newThread.SetApartmentState(ApartmentState.STA)
        Catch stateException As ThreadStateException
            Console.WriteLine(vbCrLf & "{0} caught:" & vbCrLf & _
                "Thread is not In the Unstarted or Running state.", _
                stateException.GetType().Name)
            Console.WriteLine("ThreadState: {0}, ApartmentState: " & _
                "{1}", newThread.ThreadState, newThread.GetApartmentState())
        End Try

    End Sub

    Shared Sub ThreadMethod()
        Thread.Sleep(1000)
    End Sub

End Class

Comentários

Um apartamento é um contêiner lógico dentro de um processo para objetos que compartilham os mesmos requisitos de acesso de thread. Todos os objetos no mesmo apartamento podem receber chamadas de qualquer thread no apartamento. O .NET Framework não usa apartamentos e os objetos gerenciados são responsáveis por usar todos os recursos compartilhados de maneira thread-safe.

Como as classes COM usam apartamentos, o common language runtime precisa criar e inicializar um apartamento ao chamar um objeto COM em uma situação de interoperabilidade COM. Um thread gerenciado pode criar e inserir um STA (apartamento de thread único) que permite apenas um thread ou um MTA (apartamento multithreaded) que contém um ou mais threads. Você pode controlar o tipo de apartamento criado definindo a ApartmentState propriedade do thread como um dos valores da ApartmentState enumeração. Como um determinado thread só pode inicializar um apartamento COM uma vez, você não pode alterar o tipo de apartamento após a primeira chamada para o código não gerenciado.

Para obter mais informações, consulte Thread, Threading Gerenciado e Não Gerenciado e Interoperabilidade COM Avançada.

Confira também

• Thread