Thread.SetApartmentState(ApartmentState) Metod

Definition

Anger lägenhetstillståndet för en tråd innan den startas.

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)

Parametrar

state
ApartmentState

Det nya lägenhetstillståndet.

Attribut

Undantag

.NET Core och .NET endast 5+ : I alla fall på macOS och Linux.

state är inte ett giltigt lägenhetstillstånd.

Tråden har redan startats.

Lägenhetstillståndet har redan initierats.

Exempel

I följande kodexempel visas GetApartmentStatemetoderna , SetApartmentStateoch TrySetApartmentState . Kodexemplet skapar en tråd. Innan tråden startas GetApartmentState visar det inledande ApartmentState.Unknown tillståndet och SetApartmentState ändrar tillståndet till ApartmentState.STA. Metoden TrySetApartmentState returnerar false sedan när du försöker ändra tillståndet till ApartmentState.MTA eftersom lägenhetstillståndet redan har angetts. Om samma åtgärd hade försökts med SetApartmentState, InvalidOperationException skulle ha kastats.

När tråden har startats TrySetApartmentState används metoden igen. Den här gången genererar ThreadStateException den eftersom tråden redan har startats.

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.

Kommentarer

Nya trådar initieras som ApartmentState.MTA om deras lägenhetstillstånd inte har angetts innan de startas. Lägenhetstillstånd måste anges innan en tråd startas.

Note

Huvudprogramtråden initieras som ApartmentState.MTA standard. Det enda sättet att ange lägenhetstillståndet för huvudprogramtråden ApartmentState.STA är att tillämpa STAThreadAttribute attributet på startpunktsmetoden.

Metoden SetApartmentState , tillsammans med GetApartmentState metoden och TrySetApartmentState metoden, ersätter ApartmentState egenskapen.

Gäller för