ApartmentState 列挙体

Thread のアパートメント状態を指定します。

<Serializable>
Public Enum ApartmentState
[C#]
[Serializable]
public enum ApartmentState
[C++]
[Serializable]
__value public enum ApartmentState
[JScript]
public
   Serializable
enum ApartmentState

解説

アパートメントとは、同じスレッド アクセス要件を共有するオブジェクトのプロセス内の論理コンテナです。同じアパートメント内のオブジェクトはすべて、そのアパートメント内のどのスレッドからの呼び出しも受け取ることができます。.NET Framework はアパートメントを使用せず、マネージ オブジェクトはスレッド セーフな方法ですべての共有リソースを独自に使用します。

COM クラスはアパートメントを使用するため、共通言語ランタイムでは、COM 相互運用状況で COM オブジェクトを呼び出すときにアパートメントを作成および初期化する必要があります。マネージ スレッドでは、1 つのスレッドだけを格納できるシングルスレッド アパートメント (STA: single-threaded apartment)、または 1 つ以上のスレッドを格納するマルチスレッド アパートメント (MTA: multithreaded apartment) を作成および入力できます。作成するアパートメントの種類を制御するには、スレッドの ApartmentState プロパティを ApartmentState 列挙体の値の 1 つに設定します。1 つのスレッドでは COM アパートメントを一度しか初期化できないため、アンマネージ コードを一度呼び出すと、アパートメントの種類は変更できません。

詳細については、 Thread のトピックと「 マネージ スレッドとアンマネージ スレッド 」および「 高度な COM 相互運用機能 」を参照してください。

メンバ

使用例

[Visual Basic, C#, C++] スレッドのアパートメントの状態を設定する方法の例を次に示します。

 
Imports Microsoft.VisualBasic
Imports System
Imports System.Threading

Public Class ApartmentTest

    Shared Sub Main()
    
        Dim newThread As Thread = New Thread(AddressOf ThreadMethod)
        newThread.ApartmentState = ApartmentState.MTA

        ' The following line is ignored since 
        ' ApartmentState can only be set once.
        newThread.ApartmentState = 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.ApartmentState = 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.ApartmentState)
        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.ApartmentState = ApartmentState.MTA;

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

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

[C++] 
#using <mscorlib.dll>
using namespace System;
using namespace System::Threading;

__gc class ApartmentTest
{
public :
    static void ThreadMethod()
    {
        Thread::Sleep(1000);
    }
};

void main()
{
    Thread* newThread = 
        new Thread(new ThreadStart(0, &ApartmentTest::ThreadMethod));
        newThread->ApartmentState = ApartmentState::MTA;

        // The following line is ignored since 
        // ApartmentState can only be set once.
        newThread->ApartmentState = ApartmentState::STA;

        Console::WriteLine(S"ThreadState: {0}, ApartmentState: {1}", 
            __box(newThread->ThreadState)->ToString(),
            __box(newThread->ApartmentState)->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->ApartmentState = ApartmentState::STA;
    }
    catch(ThreadStateException* stateException)
    {
        Console::WriteLine(S"\n{0} caught:\n"
            S"Thread is not in the Unstarted or Running state.",
            stateException->GetType()->Name);
        Console::WriteLine(S"ThreadState: {0}, ApartmentState: {1}", 
            __box(newThread->ThreadState)->ToString(),
            __box(newThread->ApartmentState)->ToString());
    }
}

[JScript] JScript のサンプルはありません。Visual Basic、C#、および C++ のサンプルを表示するには、このページの左上隅にある言語のフィルタ ボタン をクリックします。

必要条件

名前空間: System.Threading

プラットフォーム: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 ファミリ

アセンブリ: Mscorlib (Mscorlib.dll 内)

参照

System.Threading 名前空間 | Thread | マネージ スレッドとアンマネージ スレッド | 高度な COM 相互運用機能