PnpObjectWatcher
PnpObjectWatcher
PnpObjectWatcher
PnpObjectWatcher
PnpObjectWatcher
Class
Definition
public : sealed class PnpObjectWatcher : IPnpObjectWatcher
struct winrt::Windows::Devices::Enumeration::Pnp::PnpObjectWatcher : IPnpObjectWatcher
public sealed class PnpObjectWatcher : IPnpObjectWatcher
Public NotInheritable Class PnpObjectWatcher Implements IPnpObjectWatcher
// This class does not provide a public constructor.
- Attributes
Device family |
Windows 10 (introduced v10.0.10240.0)
|
API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Remarks
An app calls Start to begin the search for devices. During this intial enumeration, the PnpObjectWatcher raises an Added event for each device that's found, until all devices are found. The PnpObjectWatcher raises an EnumerationCompleted event when the initial enumeration is complete, and continues to raise events if a device is added, updated, or removed.
The following diagram shows how the PnpObjectWatcher transitions between the states represented by DeviceWatcherStatus enumeration.
The Start method can only be called when the PnpObjectWatcher is in the Created, Stopped or Aborted state. The Status property indicates the PnpObjectWatcher state. When re-starting the watcher, wait for the Stopped event before calling Start.
A call to Stop transitions the PnpObjectWatcher to the Stopping state and completes immediately. The watcher will transition to the Stopped state once all events that are already in the process of being raised have completed.
After calling Stop, apps may wait for the Stopped event if they need to know when the PnpObjectWatcher has stopped. Callers must wait for the Stopped event before they can call Start to restart the watcher. Callers may unsubscribe from events if they do not want to receive any additional events after Stop but do not want to wait for the Stopped event.
Properties
Status Status Status Status Status |
The status associated with the asynchronous operation. |
Methods
Start() Start() Start() Start() Start() |
Starts raising the events to inform the client that a PnpObject has been added, updated, or removed. |
Stop() Stop() Stop() Stop() Stop() |
Stops raising the events to inform the client that a PnpObject has been added, updated, or removed. |
Events
Added Added Added Added Added |
Occurs when a PnpObject is added to the collection enumerated by the PnpObjectWatcher. |
EnumerationCompleted EnumerationCompleted EnumerationCompleted EnumerationCompleted EnumerationCompleted |
Occurs when the enumeration of Pnp device objects has been completed. |
Removed Removed Removed Removed Removed |
Occurs when a PnpObject is removed from the collection enumerated by the PnpObjectWatcher. |
Stopped Stopped Stopped Stopped Stopped |
Occurs when the PnpObjectWatcher has stopped monitoring changes to the collection of Pnp device objects. |
Updated Updated Updated Updated Updated |
Occurs when the properties of a PnpObject in the collection enumerated by the PnpObjectWatcher are updated. |