Thread.SetApartmentState(ApartmentState) メソッド

定義

名前空間:

System.Threading

アセンブリ:

System.Threading.Thread.dll

アセンブリ:

netstandard.dll

アセンブリ:

mscorlib.dll

スレッドを開始する前にそのアパートメント状態を設定します。

public:
 void SetApartmentState(System::Threading::ApartmentState state);

[System.Runtime.Versioning.SupportedOSPlatform("windows")]
public void SetApartmentState (System.Threading.ApartmentState state);

public void SetApartmentState (System.Threading.ApartmentState state);

[<System.Runtime.Versioning.SupportedOSPlatform("windows")>]
member this.SetApartmentState : System.Threading.ApartmentState -> unit

member this.SetApartmentState : System.Threading.ApartmentState -> unit

Public Sub SetApartmentState (state As ApartmentState)

パラメーター

state

ApartmentState

新しいアパートメント状態。

属性

SupportedOSPlatformAttribute

例外

PlatformNotSupportedException

.NET Core と .NET 5 + のみ: macOS と Linux 上のすべての場合。

ArgumentException

state は有効なアパートメント状態ではありません。

ThreadStateException

スレッドが既に開始されています。

InvalidOperationException

アパートメント状態は、すでに初期化されています。

例

次のコード例は GetApartmentState 、、、およびの各メソッドを示して SetApartmentState TrySetApartmentState います。 このコード例では、スレッドを作成します。 スレッドが開始される前に、によって GetApartmentState 初期状態が表示され、 ApartmentState.Unknown SetApartmentState 状態がに変わり ApartmentState.STA ます。 この TrySetApartmentState メソッドは、 false ApartmentState.MTA アパートメント状態が既に設定されているために状態をに変更しようとすると、を返します。 同じ操作がによって試行された場合 SetApartmentState 、 InvalidOperationException がスローされます。

スレッドが開始されると、 TrySetApartmentState メソッドが再び使用されます。 今回は ThreadStateException 、スレッドが既に開始されているためにスローします。

using namespace System;
using namespace System::Threading;

void ThreadProc()
{
    Thread::Sleep(2000);
};

void main()
{
    Thread^ t = gcnew Thread(gcnew ThreadStart(ThreadProc));
    Console::WriteLine("Before setting apartment state: {0}", 
            t->GetApartmentState());

    t->SetApartmentState(ApartmentState::STA);
    Console::WriteLine("After setting apartment state: {0}", 
        t->GetApartmentState());

    bool result = t->TrySetApartmentState(ApartmentState::MTA);
    Console::WriteLine("Try to change state: {0}", result);

    t->Start();

    Thread::Sleep(500);

    try
    {
        t->TrySetApartmentState(ApartmentState::STA);
    }
    catch (ThreadStateException^)
    {
        Console::WriteLine("ThreadStateException occurs " +
            "if apartment state is set after starting thread.");
    }

    t->Join();
}

/* This code example produces the following output:

Before setting apartment state: Unknown
After setting apartment state: STA
Try to change state: False
ThreadStateException occurs if apartment state is set after starting thread.
 */

using System;
using System.Threading;

class Example
{
    public static void Main()
    {
        Thread t = new Thread(ThreadProc);
        Console.WriteLine("Before setting apartment state: {0}",
            t.GetApartmentState());

        t.SetApartmentState(ApartmentState.STA);
        Console.WriteLine("After setting apartment state: {0}",
            t.GetApartmentState());

        bool result = t.TrySetApartmentState(ApartmentState.MTA);
        Console.WriteLine("Try to change state: {0}", result);

        t.Start();

        Thread.Sleep(500);

        try
        {
            t.TrySetApartmentState(ApartmentState.STA);
        }
        catch (ThreadStateException)
        {
            Console.WriteLine("ThreadStateException occurs " +
                "if apartment state is set after starting thread.");
        }

        t.Join();
    }

    public static void ThreadProc()
    {
        Thread.Sleep(2000);
    }
}

/* This code example produces the following output:

Before setting apartment state: Unknown
After setting apartment state: STA
Try to change state: False
ThreadStateException occurs if apartment state is set after starting thread.
 */

Imports System.Threading

Module Example

    Sub Main()
 
        Dim t As New Thread(AddressOf ThreadProc)
        Console.WriteLine("Before setting apartment state: {0}", _
            t.GetApartmentState())

        t.SetApartmentState(ApartmentState.STA)
        Console.WriteLine("After setting apartment state: {0}", _
            t.GetApartmentState())

        Dim result As Boolean = _
            t.TrySetApartmentState(ApartmentState.MTA)
        Console.WriteLine("Try to change state: {0}", result)

        t.Start()

        Thread.Sleep(500)

        Try
            t.TrySetApartmentState(ApartmentState.STA)
        Catch ex As ThreadStateException
            Console.WriteLine("ThreadStateException occurs " & _
                "if apartment state is set after starting thread.")
        End Try

        t.Join()
    End Sub

    Sub ThreadProc()
        Thread.Sleep(2000)
    End Sub
End Module

' This code example produces the following output:
'
'Before setting apartment state: Unknown
'After setting apartment state: STA
'Try to change state: False
'ThreadStateException occurs if apartment state is set after starting thread.

注釈

新しいスレッドは ApartmentState.MTA 、アパートメント状態が開始前に設定されていないかのように初期化されます。 アパートメント状態は、スレッドを開始する前に設定する必要があります。

注意

メインアプリケーションスレッドは、既定でに初期化され ApartmentState.MTA ます。 メインアプリケーションスレッドのアパートメント状態をに設定する唯一の方法は、 ApartmentState.STA STAThreadAttribute エントリポイントメソッドに属性を適用することです。

メソッドとメソッドおよびメソッドを使用して、 SetApartmentState GetApartmentState プロパティを TrySetApartmentState 置き換え ApartmentState ます。