Thread.TrySetApartmentState(ApartmentState) Método

Definición

Espacio de nombres:

System.Threading

Ensamblados:

netstandard.dll, System.Threading.Thread.dll

Source:

Thread.cs

Establece el estado de apartamento de un subproceso antes de iniciarlo.

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

Parámetros

state

ApartmentState

El nuevo estado del apartamento.

Devoluciones

Boolean

true si se establece el estado del apartamento; de lo contrario, false.

Excepciones

PlatformNotSupportedException

Solo .NET Core y .NET 5+: en todos los casos en macOS y Linux.

ArgumentException

state no es un estado de apartamento válido.

ThreadStateException

El subproceso se inició y finalizó o la llamada no se realiza desde el contexto del subproceso mientras se ejecuta el subproceso.

Ejemplos

En el ejemplo de código siguiente se muestran los GetApartmentStatemétodos , SetApartmentStatey TrySetApartmentState . El ejemplo de código crea un subproceso. Antes de iniciar el subproceso, GetApartmentState muestra el estado inicial ApartmentState.Unknown y SetApartmentState cambia el estado a ApartmentState.STA. A continuación, el TrySetApartmentState método devuelve false al intentar cambiar el estado a ApartmentState.MTA porque el estado del apartamento ya está establecido. Si se hubiera intentado la misma operación con SetApartmentState, InvalidOperationException se habría producido .

Una vez iniciado el subproceso, se vuelve a usar el TrySetApartmentState método . Esta vez se produce porque el subproceso ThreadStateException ya se ha iniciado.

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.

Comentarios

Los nuevos subprocesos se inicializan como ApartmentState.MTA si no se hubiera establecido su estado de apartamento antes de que se inicien. El estado del apartamento debe establecerse antes de que se inicie un subproceso.

Nota:

El subproceso de aplicación principal se inicializa en ApartmentState.MTA de forma predeterminada. La única manera de establecer el estado de apartamento del subproceso ApartmentState.STA de aplicación principal en es aplicar el STAThreadAttribute atributo al método de punto de entrada.

El TrySetApartmentState método, junto con el GetApartmentState método y el SetApartmentState método , reemplaza la ApartmentState propiedad .