Thread.ApartmentState 屬性

參考

定義

命名空間:: System.Threading

組件:: System.Threading.Thread.dll

組件:: netstandard.dll

組件:: mscorlib.dll

重要

部分資訊涉及發行前產品，在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊，不做任何明確或隱含的瑕疵擔保。

警告

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

已嘗試將此屬性狀態設定為無效 Apartment 狀態 (單一執行緒 Apartment (STA) 或多執行緒 Apartment (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 版中，您可以使用/CLRTHREADATTRIBUTE (Set CLR Thread Attribute) 連結器選項，來指定 c + + 應用程式的 COM 執行緒模型。

適用於

Thread.ApartmentState 屬性

定義

屬性值

例外狀況

範例

備註

適用於

另請參閱

其他資源