IWDFDeviceInitialize::RetrieveDevicePropertyStore method

The RetrieveDevicePropertyStore method retrieves a device property store that clients can read and write device properties through.

Syntax


HRESULT RetrieveDevicePropertyStore(
  [in, optional]  PCWSTR                            pcwszServiceName,
  [in]            WDF_PROPERTY_STORE_RETRIEVE_FLAGS Flags,
  [out]           IWDFNamedPropertyStore            **ppPropStore,
  [out, optional] WDF_PROPERTY_STORE_DISPOSITION    *pDisposition
);

Parameters

pcwszServiceName [in, optional]

A pointer to a NULL-terminated string that represents the name of the device property store. This parameter is optional. The driver can pass NULL if the driver does not supply a name for a device property store.

Flags [in]

A WDF_PROPERTY_STORE_RETRIEVE_FLAGS-typed value that identifies how to retrieve the device property store.

ppPropStore [out]

A pointer to a buffer that receives a pointer to the IWDFNamedPropertyStore interface that is used to retrieve device properties.

pDisposition [out, optional]

A pointer to a variable that receives a WDF_PROPERTY_STORE_DISPOSITION-typed value that identifies whether the framework created the device property store or the device property store already existed. This parameter is optional. The driver can pass NULL if the driver does not require the disposition information.

Return value

RetrieveDevicePropertyStore returns S_OK if the operation succeeds. Otherwise, this method returns one of the error codes that are defined in Winerror.h.

Remarks

The caller should call the Release method of the IWDFNamedPropertyStore interface after finishing with the property store.

For more information, see Using the Registry in UMDF-based Drivers.

Requirements

Target platform

Desktop

End of support

Unavailable in UMDF 2.0 and later.

Minimum UMDF version

1.5

Header

Wudfddi.h (include Wudfddi.h)

DLL

WUDFx.dll

See also

IWDFDeviceInitialize
IWDFNamedPropertyStore
WDF_PROPERTY_STORE_DISPOSITION
WDF_PROPERTY_STORE_RETRIEVE_FLAGS

 

 

Send comments about this topic to Microsoft

Afficher:
© 2015 Microsoft