DispatcherQueue.TryEnqueue メソッド

定義

名前空間:

Microsoft.UI.Dispatching

オーバーロード

TryEnqueue(DispatcherQueueHandler)	DispatcherQueue に関連付けられたスレッドで実行されるタスクを DispatcherQueue に追加します。
TryEnqueue(DispatcherQueuePriority, DispatcherQueueHandler)	指定した優先度の DispatcherQueue に関連付けられたスレッドで実行されるタスクを DispatcherQueue に追加します。

TryEnqueue(DispatcherQueueHandler)

DispatcherQueue に関連付けられたスレッドで実行されるタスクを DispatcherQueue に追加します。

public:
 virtual bool TryEnqueue(DispatcherQueueHandler ^ callback) = TryEnqueue;

[Windows.Foundation.Metadata.Overload("TryEnqueue")]
public bool TryEnqueue(DispatcherQueueHandler callback);

function tryEnqueue(callback)

Public Function TryEnqueue (callback As DispatcherQueueHandler) As Boolean

パラメーター

callback

DispatcherQueueHandler

実行するタスクへのデリゲート。

戻り値

Boolean

bool

タスクがキューに追加された場合は True。 それ以外の場合は、 falseです。

属性

OverloadAttribute

例

次の例では、新しいスレッドを作成し、 DispatcherQueueController を初期化し、それに対して DispatcherQueue イベント ループを実行する方法を示します。

// Create a new thread and initialize a DispatcherQueueController
// and run a DispatcherQueue event loop on it.
_queueController =
    DispatcherQueueController.CreateOnDedicatedThread();
_queue = _queueController.DispatcherQueue;

// This is the first TryEnqueue() after creating the DispatcherQueue. The
// first TryEnqueue task is guaranteed to be invoked first on the new
// thread.
bool isQueued = _queue.TryEnqueue(
        () =>
        {
            // task to perform on another thread.
        });

注釈

キューは コールバック を順次呼び出します。

ShutdownQueueAsync() が呼び出されると、キューは新しいタスクをキューに入れず、このメソッドは false を返します。

TryEnqueue(DispatcherQueuePriority, DispatcherQueueHandler)

指定した優先度の DispatcherQueue に関連付けられたスレッドで実行されるタスクを DispatcherQueue に追加します。

public:
 virtual bool TryEnqueue(DispatcherQueuePriority priority, DispatcherQueueHandler ^ callback) = TryEnqueue;

[Windows.Foundation.Metadata.Overload("TryEnqueueWithPriority")]
public bool TryEnqueue(DispatcherQueuePriority priority, DispatcherQueueHandler callback);

function tryEnqueue(priority, callback)

Public Function TryEnqueue (priority As DispatcherQueuePriority, callback As DispatcherQueueHandler) As Boolean

パラメーター

priority

DispatcherQueuePriority

タスクの優先度 (低、標準、高など)。

callback

DispatcherQueueHandler

実行するタスクへのデリゲート。

戻り値

Boolean

bool

タスクがキューに追加された場合は True。 それ以外の場合は、 falseです。

属性

OverloadAttribute

例

次の例では、新しいスレッドを作成し、 DispatcherQueueController を初期化し、それに対して DispatcherQueue イベント ループを実行する方法を示します。

// Create a new thread and initialize a DispatcherQueueController
// and run a DispatcherQueue event loop on it.
_queueController =
    DispatcherQueueController.CreateOnDedicatedThread();
_queue = _queueController.DispatcherQueue;

// This is the first TryEnqueue() after creating the DispatcherQueue. The
// first TryEnqueue task is guaranteed to be invoked first on the new
// thread, regardless of what priority it was enqueued at.
bool isQueued = _queue.TryEnqueue(Windows.System.DispatcherQueuePriority.High,
        () =>
        {
            // task to perform on another thread.
        });

注釈

キューは コールバック を順番に、優先順位で呼び出します。

ShutdownQueueAsync() が呼び出されると、キューは新しいタスクをキューに入れず、このメソッドは false を返します。