Table of contents
TOC
Collapse the table of content
Expand the table of content

About the Parameter Types

Last Updated: 1/24/2017

You should understand how the sensor class extension uses some data types as method parameters. The following table describes these data types.

TypeParameter namesMeaning

IWDFFile

pClientFile

This UMDF COM interface represents a file object that the platform associates with a client application. Although sensor method calls always supply this type as a valid interface pointer, it is intended to be used as an ID for the application. The address that the pointer contains is a unique number that can identify the client application. Be aware that this value is distinct from the address of the pointer itself. Do not use the address-of operator (&) to retrieve an ID. Use the pointer itself.

If you choose to use this pointer to access the underlying object, remember to call AddRef through the pointer initially, and to call Release when you have finished.

LPWSTR

pwszSensorID

This string is a unique ID that is provided by the driver for a particular sensor. This ID must be unique for each sensor on a particular device.

IPortableDeviceValues

ppDataValues

ppPropertyValues

pPropertiesToSet

ppResults

This WPD interface provides a convenient way to create a property bag of name/value pairs. PROPERTYKEYs represent names and PROPVARIANTs represent values. The DDI uses this interface both to set and retrieve sets of values, or for a single value.

You can retrieve this interface from a method or, if a new object is required, by calling CoCreateInstance with CLSID_PortableDeviceValues.

IPortableDeviceValuesCollection

pEventCollection

ppSensorObjectCollection

This WPD interface contains a collection of IPortableDeviceValues objects. DDI methods that use this interface enable you to provide several sets of data at the same time, such as multiple events or information about multiple sensors.

You can retrieve this interface from a method or, if a new object is required, by calling CoCreateInstance with CLSID_PortableDeviceValuesCollection.

IPortableDeviceKeyCollection

pDataFields

pProperties

ppSupportedDataFields

ppSupportedProperties

This WPD interface contains a collection of PROPERTYKEYs. These keys represent property names that can be stored by IPortableDeviceValues. The DDI uses this collection object both for setting and retrieving sets of property names, or a single name.

You can retrieve this interface from a method or, if a new object is required, by calling CoCreateInstance with CLSID_PortableDeviceKeyCollection.


Send comments about this topic to Microsoft

© 2017 Microsoft