IWDFDevice::RetrieveDevicePropertyStore method (wudfddi.h)

Article
10/21/2021

[Warning: UMDF 2 is the latest version of UMDF and supersedes UMDF 1. All new UMDF drivers should be written using UMDF 2. No new features are being added to UMDF 1 and there is limited support for UMDF 1 on newer versions of Windows 10. Universal Windows drivers must use UMDF 2. For more info, see Getting Started with UMDF.]

The RetrieveDevicePropertyStore method retrieves a property store interface that drivers can use to access the registry.

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

[in, optional] pcwszServiceName

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.

[in] Flags

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

[out] ppPropStore

A pointer to a buffer that receives a pointer to the IWDFNamedPropertyStore interface. The driver uses this interface to access values in the registry.

[out, optional] pDisposition

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

Requirement	Value
End of support	Unavailable in UMDF 2.0 and later.
Target Platform	Desktop
Minimum UMDF version	1.5
Header	wudfddi.h (include Wudfddi.h)
DLL	WUDFx.dll