Thread.SetApartmentState(ApartmentState) Metode

Definisi

Ruang nama:

System.Threading

Rakitan:

netstandard.dll, System.Threading.Thread.dll

Sumber:

Thread.cs

Menetapkan status apartemen utas sebelum dimulai.

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)

Parameter

state

ApartmentState

Negara apartemen baru.

Atribut

SupportedOSPlatformAttribute

Pengecualian

PlatformNotSupportedException

.NET Core dan .NET 5+ saja: Dalam semua kasus di macOS dan Linux.

ArgumentException

state bukan status apartemen yang valid.

ThreadStateException

Utas sudah dimulai.

InvalidOperationException

Status apartemen telah diinisialisasi.

Contoh

Contoh kode berikut menunjukkan GetApartmentStatemetode , , SetApartmentStatedan TrySetApartmentState . Contoh kode membuat utas. Sebelum utas dimulai, GetApartmentState menampilkan status awal ApartmentState.Unknown dan SetApartmentState mengubah status menjadi ApartmentState.STA. Metode TrySetApartmentState kemudian kembali false ketika mencoba mengubah status menjadi ApartmentState.MTA karena status apartemen sudah ditetapkan. Jika operasi yang sama telah dicoba dengan SetApartmentState, InvalidOperationException akan dilemparkan.

Setelah utas dimulai, TrySetApartmentState metode digunakan lagi. Kali ini melempar karena utas ThreadStateException sudah dimulai.

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.

Keterangan

Utas baru diinisialisasi seolah-olah ApartmentState.MTA status apartemen mereka belum ditetapkan sebelum dimulai. Status apartemen harus ditetapkan sebelum utas dimulai.

Nota

Utas aplikasi utama diinisialisasi secara ApartmentState.MTA default. Satu-satunya cara untuk mengatur status apartemen utas ApartmentState.STA aplikasi utama adalah dengan menerapkan STAThreadAttribute atribut ke metode titik masuk.

Metode ini SetApartmentState , bersama dengan GetApartmentState metode dan TrySetApartmentState metode , menggantikan ApartmentState properti .