Event Properties
.gif)
| Previous | Next |
Event Properties
Windows Portable Devices supports the following event properties.
| Property | VarType | Description |
| WPD_EVENT_OPTION_IS_AUTOPLAY_EVENT | VT_BOOL | Reserved for future use. |
| WPD_EVENT_OPTION_IS_BROADCAST_EVENT | VT_BOOL | A Boolean value that specifies whether the event is broadcast to all clients.
Clients can receive this event by registering their callback with IPortableDevice::Advise. |
| WPD_EVENT_PARAMETER_CHILD_HIERARCHY_CHANGED | VT_BOOL | A Boolean value that specifies whether the child hierarchy for the object has changed.
This parameter is used to notify the caller that some children for the specified object have been added or removed. (The hierarchy change is typically initiated on the device side.) Clients may need to re-enumerate this folder's children in order to keep their views up to date. |
| WPD_EVENT_PARAMETER_EVENT_ID | VT_CLSID | A value that identifies an event. |
| WPD_EVENT_PARAMETER_OBJECT_CREATION_COOKIE | VT_LPWSTR | This is the cookie handed back to a client when it requests an object creation by calling the IPortableDeviceContent::CreateObjectWithPropertiesAndData method.
This parameter is added as a convenience to help the caller tie an object-added event to the request it sent to create the object. The driver handed this cookie back as the WPD_PROPERTY_OBJECT_MANAGEMENT_CONTEXT return value when processing the WPD_COMMAND_OBJECT_MANAGEMENT_CREATE_OBJECT_WITH_PROPERTIES_AND_DATA command. |
| WPD_EVENT_PARAMETER_OBJECT_PARENT_PERSISTENT_UNIQUE_ID | VT_LPWSTR | Uniquely identifies the parent object; this property is similar to WPD_OBJECT_PARENT_ID, but this ID will not change between sessions. |
| WPD_EVENT_PARAMETER_OPERATION_PROGRESS | VT_UI4 | A value that specifies the progress of a currently executing operation. The value of this property can range from 0 to 100, with 100 indicating that the operation is complete. |
| WPD_EVENT_PARAMETER_OPERATION_STATE | VT_UI4 | Indicates the current state of the operation (for instance, started, running, stopped, and so on).
This parameter's possible values are from the WPD_OPERATION_STATES enumeration defined in PortableDevice.h. Possible values are: WPD_OPERATION_STATE_UNSPECIFIED WPD_OPERATION_STATE_STARTED WPD_OPERATION_STATE_RUNNING WPD_OPERATION_STATE_PAUSED WPD_OPERATION_STATE_CANCELLED WPD_OPERATION_STATE_FINISHED WPD_OPERATION_STATE_ABORTED |
| WPD_EVENT_PARAMETER_PNP_DEVICE_ID | VT_LPWSTR | A value that specifies the device that originated the event.
This is the interface name of the device given by the Plug-and-Play (PnP) system, and is the same string used in IPortableDevice::Open. |
Requirements
Header: Defined in PortableDevice.h
See Also
| Previous | Next |