Thread.TrySetApartmentState(ApartmentState) Метод

Определение

Пространство имен:

System.Threading

Сборки:

netstandard.dll, System.Threading.Thread.dll

Исходный код:

Thread.cs

Задает состояние квартиры потока перед началом работы.

public:
 bool TrySetApartmentState(System::Threading::ApartmentState state);

public bool TrySetApartmentState(System.Threading.ApartmentState state);

member this.TrySetApartmentState : System.Threading.ApartmentState -> bool

Public Function TrySetApartmentState (state As ApartmentState) As Boolean

Параметры

state

ApartmentState

Новое состояние квартиры.

Возвращаемое значение

Boolean

true Значение , если задано состояние квартиры; falseв противном случае .

Исключения

PlatformNotSupportedException

Только .NET Core и .NET 5+ : во всех случаях в macOS и Linux.

ArgumentException

state не является допустимым состоянием квартиры.

ThreadStateException

Поток был запущен и завершен, или вызов не выполняется из контекста потока во время выполнения потока.

Примеры

В следующем примере кода демонстрируются GetApartmentStateSetApartmentStateметоды и TrySetApartmentState методы. В примере кода создается поток. Перед запуском GetApartmentState потока отображает начальное ApartmentState.Unknown состояние и SetApartmentState изменяет состояние ApartmentState.STAна . Затем TrySetApartmentState метод возвращается false при попытке изменить состояние ApartmentState.MTA на то, что состояние квартиры уже задано. Если бы одна и та же операция была предпринята, SetApartmentStateInvalidOperationException была бы брошена.

После запуска TrySetApartmentState потока метод используется снова. На этот раз он выдает 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.

Комментарии

Новые потоки инициализированы, как ApartmentState.MTA если бы их состояние квартиры не было установлено до их запуска. Состояние квартиры должно быть задано перед началом потока.

Замечание

Основной поток приложения инициализируется ApartmentState.MTA по умолчанию. Единственный способ задать состояние квартиры основного потока ApartmentState.STA приложения — применить STAThreadAttribute атрибут к методу точки входа.

Метод TrySetApartmentState вместе с методом GetApartmentState и SetApartmentState методом заменяет ApartmentState свойство.