Thread.ApartmentState Свойство

Определение

Пространство имен:

System.Threading

Сборка:

System.Threading.Thread.dll

Сборка:

netstandard.dll

Сборка:

mscorlib.dll

Внимание!

The ApartmentState property has been deprecated. Use GetApartmentState, SetApartmentState or TrySetApartmentState instead.

Внимание!

The ApartmentState property has been deprecated. Use GetApartmentState, SetApartmentState or TrySetApartmentState instead.

Внимание!

Deprecated in favor of GetApartmentState, SetApartmentState and TrySetApartmentState.

Возвращает или задает модель "apartment" для данного потока.

public:
 property System::Threading::ApartmentState ApartmentState { System::Threading::ApartmentState get(); void set(System::Threading::ApartmentState value); };

[System.Obsolete("The ApartmentState property has been deprecated.  Use GetApartmentState, SetApartmentState or TrySetApartmentState instead.", false)]
public System.Threading.ApartmentState ApartmentState { get; set; }

[System.Obsolete("The ApartmentState property has been deprecated. Use GetApartmentState, SetApartmentState or TrySetApartmentState instead.")]
public System.Threading.ApartmentState ApartmentState { get; set; }

public System.Threading.ApartmentState ApartmentState { get; set; }

[System.Obsolete("Deprecated in favor of GetApartmentState, SetApartmentState and TrySetApartmentState.")]
public System.Threading.ApartmentState ApartmentState { get; set; }

[<System.Obsolete("The ApartmentState property has been deprecated.  Use GetApartmentState, SetApartmentState or TrySetApartmentState instead.", false)>]
member this.ApartmentState : System.Threading.ApartmentState with get, set

[<System.Obsolete("The ApartmentState property has been deprecated. Use GetApartmentState, SetApartmentState or TrySetApartmentState instead.")>]
member this.ApartmentState : System.Threading.ApartmentState with get, set

member this.ApartmentState : System.Threading.ApartmentState with get, set

[<System.Obsolete("Deprecated in favor of GetApartmentState, SetApartmentState and TrySetApartmentState.")>]
member this.ApartmentState : System.Threading.ApartmentState with get, set

Public Property ApartmentState As ApartmentState

Значение свойства

ApartmentState

Одно из значений перечисления ApartmentState. Начальное значение — Unknown.

Атрибуты

ObsoleteAttribute

Исключения

ArgumentException

Предпринята попытка задать в этом свойстве состояние, которое не является допустимым состоянием подразделения (состояние, отличное от однопотокового подразделения (STA) или многопотокового подразделения (MTA)).

Примеры

В следующем примере кода показано, как задать состояние подразделения потока.

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

Комментарии

ApartmentStateСвойство устарело. Неустаревшие альтернативы — GetApartmentState метод для получения состояния подразделения и SetApartmentState метод для задания состояния апартамента.

в платформа .NET Framework версиях 1,0 и 1,1 ApartmentState свойство помечает поток, чтобы указать, что он будет выполняться в однопотоковой или многопоточной подразделении. Это свойство может быть задано, когда поток находится в Unstarted Running состоянии потока или, однако его можно задать только один раз для потока. Если свойство не задано, возвращается значение Unknown .

Попытка использовать ApartmentState свойство для задания состояния подразделения потока, состояние апартамента которого уже задано, игнорируется. Однако SetApartmentState InvalidOperationException в этом случае метод создает исключение.

Важно!

в платформа .NET Framework версии 2,0 новые потоки инициализируются так, как ApartmentState.MTA если бы их состояние апартамента не было задано до запуска. Основной поток приложения инициализируется значением по ApartmentState.MTA умолчанию. Вы больше не можете задать для основного потока приложения ApartmentState.STA , задав System.Threading.ApartmentState свойство в первой строке кода. Используйте STAThreadAttribute вместо него.

в платформа .NET Framework версии 2,0 можно указать COM-потоковую модель для приложения C++ с помощью параметра компоновщика /CLRTHREADATTRIBUTE (установка атрибута потока CLR) .

См. также раздел

• ThreadState
• GetApartmentState()
• SetApartmentState(ApartmentState)