Thread.ApartmentState Vlastnost

Definice

Varování

Toto rozhraní API je teď zastaralé.

Získá nebo nastaví stav objektu Apartment tohoto vlákna.Gets or sets the apartment state of this thread.

public:
 property System::Threading::ApartmentState ApartmentState { System::Threading::ApartmentState get(); void set(System::Threading::ApartmentState value); };
[System.Obsolete("Deprecated in favor of GetApartmentState, SetApartmentState and TrySetApartmentState.")]
[System.Obsolete("The ApartmentState property has been deprecated.  Use GetApartmentState, SetApartmentState or TrySetApartmentState instead.", false)]
public System.Threading.ApartmentState ApartmentState { get; set; }
member this.ApartmentState : System.Threading.ApartmentState with get, set
Public Property ApartmentState As ApartmentState

Hodnota vlastnosti

Jedna z hodnot ApartmentState.One of the ApartmentState values. Počáteční hodnota je Unknown.The initial value is Unknown.

Atributy

Výjimky

Došlo k pokusu o nastavení této vlastnosti na stav, který není platným stavem objektu apartment (stav jiný než jeden podproces typu apartment (STA) nebo vícevláknový objekt Apartment (MTA)).An attempt is made to set this property to a state that is not a valid apartment state (a state other than single-threaded apartment (STA) or multithreaded apartment (MTA)).

Příklady

Následující příklad kódu ukazuje, jak nastavit stav objektu apartment vlákna.The following code example demonstrates how to set the apartment state of a 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.ApartmentState);

        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

Poznámky

Vlastnost ApartmentState je zastaralá.The ApartmentState property is obsolete. Nezastaralými alternativami jsou GetApartmentState metodu pro načtení stavu objektu apartment a metodu SetApartmentState pro nastavení stavu objektu apartment.The non-obsolete alternatives are the GetApartmentState method to retrieve the apartment state and the SetApartmentState method to set the apartment state.

Ve .NET Framework verzích 1,0 a 1,1 vlastnost ApartmentState označuje vlákno tak, aby označovalo, že se spustí v objektu apartment s jedním vláknem nebo s více vlákny.In the .NET Framework versions 1.0 and 1.1, the ApartmentState property marks a thread to indicate that it will execute in a single-threaded or multithreaded apartment. Tuto vlastnost lze nastavit, pokud je vlákno ve stavu vlákna Unstarted nebo Running; dá se ale pro vlákno nastavit jenom jednou.This property can be set when the thread is in the Unstarted or Running thread state; however, it can be set only once for a thread. Pokud vlastnost nebyla nastavena, vrátí Unknown.If the property has not been set, it returns Unknown.

Pokus o použití vlastnosti ApartmentState pro nastavení stavu objektu apartment vlákna, jehož stav objektu Apartment již byl nastaven, je ignorován.An attempt to use the ApartmentState property to set the apartment state of a thread whose apartment state has already been set is ignored. Nicméně metoda SetApartmentState vyvolá InvalidOperationException v tomto případě.However, the SetApartmentState method throws a InvalidOperationException in this case.

Důležité

V .NET Framework verze 2,0 jsou nová vlákna inicializována jako ApartmentState.MTA, pokud jejich stav objektu Apartment nebyl nastaven před jejich spuštěním.In the .NET Framework version 2.0, new threads are initialized as ApartmentState.MTA if their apartment state has not been set before they are started. Hlavní vlákno aplikace je inicializováno jako ApartmentState.MTA ve výchozím nastavení.The main application thread is initialized to ApartmentState.MTA by default. U hlavního vlákna aplikace již nelze nastavit ApartmentState.STA nastavením vlastnosti System.Threading.ApartmentState na prvním řádku kódu.You can no longer set the main application thread to ApartmentState.STA by setting the System.Threading.ApartmentState property on the first line of code. Místo toho použijte STAThreadAttribute.Use the STAThreadAttribute instead.

V .NET Framework verze 2,0 můžete zadat model vláken modelu COM pro C++ aplikaci pomocí možnosti linkeru /CLRTHREADATTRIBUTE (nastavit atribut vlákna CLR) .In the .NET Framework version 2.0, you can specify the COM threading model for a C++ application using the /CLRTHREADATTRIBUTE (Set CLR Thread Attribute) linker option.

Platí pro

Viz také