DeviceWatcher クラス

定義

名前空間:

Windows.Devices.Enumeration

デバイスを動的に列挙し、初期列挙の完了後にデバイスが追加、削除、または変更された場合にアプリが通知を受け取るようにします。

public ref class DeviceWatcher sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class DeviceWatcher final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class DeviceWatcher

Public NotInheritable Class DeviceWatcher

継承

Object Platform::Object IInspectable DeviceWatcher

属性

ContractVersionAttribute MarshalingBehaviorAttribute

Windows の要件

デバイス ファミリ	Windows 10 (10.0.10240.0 で導入)
API contract	Windows.Foundation.UniversalApiContract (v1.0 で導入)

例

C# と C++ の完全な例については、デバイスの 列挙とペアリングのサンプルを参照してください。

注釈

アプリが Start を呼び出して、デバイスの検索を開始します。 この初期列挙の間、DeviceWatcher は、すべてのデバイスが見つかるまで、検出された各デバイスに 対して Added イベントを発生させます。 DeviceWatcher は、最初の列挙が完了したときに EnumerationCompleted イベントを発生させ、デバイスが追加、更新、または削除された場合でもイベントを発生させ続けます。

次の図は、DeviceWatcherStatus 列挙体によって表される状態の間で DeviceWatcher がどのように遷移するかを示しています。

Start メソッドは、DeviceWatcher が Created、Stopped、または Aborted 状態の場合にのみ呼び出すことができます。 Status プロパティは、DeviceWatcher の状態を示します。 ウォッチャーを再起動するときは、Start を呼び出す前に Stopped イベントを待機 します。

[停止] は、DeviceWatcher を 停止 状態に切り替え、すぐに完了します。 ウォッチャーは、既に発生中のすべてのイベントが完了すると、 停止 状態に遷移します。

DeviceWatcher が いつ停止したか を知る必要がある場合、アプリは Stopped イベントを待機することがあります。 呼び出し元は、Start を呼び出してウォッチャーを再起動する前に、Stopped イベントを待機する必要があります。 呼び出し元は、 Stop の後に追加のイベントを受信したくないが、 Stoped イベントを待機したくない場合は、イベントの登録を解除できます。

注意

デバイスの 追加、 削除、または更新があった場合に通知を受け取るために、アプリは追加、削除、更新 されたすべてのイベントを サブスクライブする必要があります。 アプリが 追加された イベントのみを処理する場合、最初のデバイス列挙が完了した後にデバイスがシステムに追加された場合、アプリは更新プログラムを受け取りません。

プロパティ

Status

DeviceWatcher の状態。

メソッド

GetBackgroundTrigger(IIterable<DeviceWatcherEventKind>)	デバイスの一覧に対する変更を監視する DeviceWatcherTrigger オブジェクトを取得します。
Start()	デバイスの検索を開始し、デバイス列挙イベントをサブスクライブします。
Stop()	列挙結果を追加、更新、および削除するイベントの発生を停止します。

イベント

Added	DeviceWatcher によって列挙されたコレクションにデバイスが追加されたときに発生するイベント。
EnumerationCompleted	デバイスの列挙が完了したときに発生するイベント。
Removed	列挙されたデバイスのコレクションからデバイスが削除されたときに発生するイベント。
Stopped	列挙操作が停止されたときに発生するイベント。
Updated	列挙されたデバイスのコレクションでデバイスが更新されたときに発生するイベント。

こちらもご覧ください

• デバイスの列挙とペアリングのサンプル