Thread.SetApartmentState(ApartmentState) Yöntem

Tanım

Ad Alanı:

System.Threading

Bütünleştirilmiş Kodlar:

netstandard.dll, System.Threading.Thread.dll

Kaynak:

Thread.cs

Bir iş parçacığı başlatılmadan önce daire durumunu ayarlar.

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

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

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

Public Sub SetApartmentState (state As ApartmentState)

Parametreler

state

ApartmentState

Yeni apartman dairesi.

Öznitelikler

SupportedOSPlatformAttribute

Özel durumlar

PlatformNotSupportedException

Yalnızca .NET Core ve .NET 5+ : MacOS ve Linux'ta her durumda.

ArgumentException

state geçerli bir apartman durumu değil.

ThreadStateException

İş parçacığı zaten başlatıldı.

InvalidOperationException

Apartman durumu zaten başlatıldı.

Örnekler

Aşağıdaki kod örneği , SetApartmentStateve TrySetApartmentState yöntemlerini gösterirGetApartmentState. Kod örneği bir iş parçacığı oluşturur. İş parçacığı başlatılmadan önce ilk GetApartmentStateApartmentState.Unknown durumu görüntüler ve SetApartmentState durumu olarak ApartmentState.STAdeğiştirir. Yöntemi TrySetApartmentState daha sonra, apartman durumu zaten ayarlanmış olduğundan durumu ApartmentState.MTA olarak değiştirmeye çalışırken döndürürfalse. ile aynı işlem denenmiş SetApartmentStateInvalidOperationException olsaydı, oluşturulurdu.

İş parçacığı başlatıldıktan TrySetApartmentState sonra yöntemi yeniden kullanılır. Bu kez, iş parçacığı zaten başlatılmış olduğundan oluşturur ThreadStateException .

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.
 */

open System.Threading

let threadProc () = Thread.Sleep 2000

let t = Thread threadProc
printfn $"Before setting apartment state: {t.GetApartmentState()}"

t.SetApartmentState ApartmentState.STA
printfn $"After setting apartment state: {t.GetApartmentState()}"

let result = t.TrySetApartmentState ApartmentState.MTA
printfn $"Try to change state: {result}"

t.Start()

Thread.Sleep 500

try
    t.TrySetApartmentState ApartmentState.STA |> ignore
with :? ThreadStateException ->
    printfn "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.

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.

Açıklamalar

Yeni iş parçacıkları, başlatılmadan önce daire durumları ayarlanmamış gibi ApartmentState.MTA başlatılır. Bir iş parçacığı başlatılmadan önce apartman durumu ayarlanmalıdır.

Uyarı

Ana uygulama iş parçacığı varsayılan olarak olarak olarak ApartmentState.MTA başlatılır. Ana uygulama iş parçacığının ApartmentState.STA apartman durumunu olarak ayarlamanın tek yolu, özniteliğini STAThreadAttribute giriş noktası yöntemine uygulamaktır.

SetApartmentState yöntemi ve TrySetApartmentState yöntemi ile GetApartmentState birlikte özelliğinin yerini alırApartmentState.