Thread.ApartmentState プロパティ

.NET Framework クラス ライブラリ リファレンス

Thread.ApartmentState プロパティ

メモ : このプロパティは、互換性のために残されています。 旧式でない代替が必要な場合は、GetApartmentStateSetApartmentState を使用してください。

このスレッドのアパートメント状態を取得または設定します。

名前空間: System.Threading
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

<ObsoleteAttribute("The ApartmentState property has been deprecated.
  Use GetApartmentState, SetApartmentState or TrySetApartmentState instead.",
 False)> _
Public Property ApartmentState As
 ApartmentState

Visual Basic (使用法)

Dim instance As Thread
Dim value As ApartmentState

value = instance.ApartmentState

instance.ApartmentState = value

C#

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

C++

[ObsoleteAttribute(L"The ApartmentState property has been deprecated.  Use GetApartmentState,
 SetApartmentState or TrySetApartmentState instead.", false)]
 
public:
property ApartmentState ApartmentState {
    ApartmentState get ();
    void set (ApartmentState value);
}

J#

/** @property */
public ApartmentState get_ApartmentState ()

/** @property */
public void set_ApartmentState (ApartmentState
 value)

JScript

public function get ApartmentState
 () : ApartmentState

public function set ApartmentState
 (value : ApartmentState)

プロパティ値
ApartmentState 値の 1 つ。初期値は Unknown です。

例外

例外の種類	条件
ArgumentException	このプロパティを、無効なアパートメント状態 (つまりシングルスレッド アパートメント (STA) またはマルチスレッド アパートメント (MTA) 以外のアパートメント状態) に設定しようとしました。

解説

.NET Framework Version 1.0 および 1.1 では、ApartmentState プロパティは、スレッドがシングルスレッド アパートメントとマルチスレッド アパートメントのどちらで実行されるかを示します。このプロパティは、スレッドが Unstarted スレッド状態または Running スレッド状態であるときに設定できます。ただし、このプロパティは、1 つのスレッドに対して一度しか設定できません。プロパティが設定されていない場合は、Unknown を返します。

重要 :
.NET Framework Version 2.0 では、新しいスレッドが開始される前にスレッドのアパートメント状態が設定されていない場合、新しいスレッドは ApartmentState.MTA として初期化されます。メイン アプリケーション スレッドは、既定で、ApartmentState.MTA に初期化されます。先頭のコード行で System.Threading.ApartmentState プロパティを設定しても、メイン アプリケーション スレッドを ApartmentState.STA に設定できません。代わりに STAThreadAttribute を使用します。

.NET Framework Version 2.0 では、/CLRTHREADATTRIBUTE (CLR スレッド属性の設定)リンカ オプションを使用して C++ アプリケーション用の COM スレッド処理モデルを指定できます。

メモ
このプロパティに適用される HostProtectionAttribute 属性の Resources プロパティの値は、Synchronization または SelfAffectingThreading です。HostProtectionAttribute は、デスクトップ アプリケーション (一般的には、アイコンをダブルクリック、コマンドを入力、またはブラウザに URL を入力して起動するアプリケーション) には影響しません。詳細については、HostProtectionAttribute クラスのトピックまたは「SQL Server プログラミングとホスト保護属性」を参照してください。

使用例

スレッドのアパートメントの状態を設定する方法の例を次に示します。

Visual Basic

Imports Microsoft.VisualBasic
Imports System
Imports System.Threading

Public Class ApartmentTest

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

        ' The following line is ignored since 
        ' ApartmentState can only be set once.
        newThread.SetApartmentState(ApartmentState.STA)

        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

C#

using System;
using System.Threading;

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

        // The following line is ignored since 
        // ApartmentState can only be set once.
        newThread.SetApartmentState(ApartmentState.STA);

        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);
    }
}

C++

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);
   
   // The following line is ignored since 
   // ApartmentState can only be set once.
   newThread->SetApartmentState(ApartmentState::STA);
   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() );
   }

}

J#

import System.*;
import System.Threading.*;
import System.Threading.Thread;    

class ApartmentTest
{
    public static void main(String[]
 args)
    {
        Thread newThread = new Thread(new ThreadStart(ThreadMethod));

        newThread.set_ApartmentState(ApartmentState.MTA);

        // The following line is ignored since 
        // ApartmentState can only be set once.
        newThread.set_ApartmentState(ApartmentState.STA);
        Console.WriteLine("ThreadState: {0}, ApartmentState: {1}",
                        newThread.get_ThreadState(),
                        newThread.get_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.set_ApartmentState(ApartmentState.STA);
        }
        catch (ThreadStateException stateException) {
            Console.WriteLine("\n{0} caught:\n" + 
                "Thread is not in the Unstarted or Running
 state.", 
                stateException.GetType().get_Name());
            Console.WriteLine("ThreadState: {0}, ApartmentState: {1}",
                newThread.get_ThreadState(),newThread.get_ApartmentState());
        }
    } //main

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

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 1.0、1.1
2.0 では、互換性のために残されています (コンパイル時に警告)

参照

関連項目
Thread クラス
Thread メンバ
System.Threading 名前空間
ThreadState