IWDFPropertyStoreFactory：：RetrieveDevicePropertyStore 方法 (wudfddi.h)

  • 發行項

[警告： UMDF 2 是最新版的 UMDF，並取代 UMDF 1。 所有新的 UMDF 驅動程式都應該使用 UMDF 2 來撰寫。 未將新功能新增至 UMDF 1，而且較新版本的 Windows 10 上不支援 UMDF 1。 通用 Windows 驅動程式必須使用 UMDF 2。 如需詳細資訊，請參閱使用 UMDF 使用者入門。]

RetrieveDevicePropertyStore 方法會擷取驅動程式可用來存取登錄的屬性存放區介面。

語法

HRESULT RetrieveDevicePropertyStore(
  [in]  PWDF_PROPERTY_STORE_ROOT          RootSpecifier,
  [in]  WDF_PROPERTY_STORE_RETRIEVE_FLAGS Flags,
  [in]  REGSAM                            DesiredAccess,
  [in]  PCWSTR                            SubkeyPath,
  [out] IWDFNamedPropertyStore2           **PropertyStore,
  [out] WDF_PROPERTY_STORE_DISPOSITION    *Disposition
);

參數

[in] RootSpecifier

驅動程式配置 WDF_PROPERTY_STORE_ROOT 結構的位址。 驅動程式會填入這個結構，以識別 RetrieveDevicePropertyStore 所擷取的屬性存放區。

[in] Flags

WDF_PROPERTY_STORE_RETRIEVE_FLAGS型別旗標，指定 UMDF 是否應該在不存在時建立指定的登錄專案，以及 Windows 重新啟動時是否應該刪除新專案。

[in] DesiredAccess

REGSAM 型別的位遮罩，指定您想要驅動程式擁有之登錄的存取類型。 REGSAM 類型定義於 Winreg.h 中，並在 REGSAM 的 Windows SDK 中描述。 位掩碼不得指定GENERIC_WRITE、KEY_CREATE_SUB_KEY或WRITE_DAC存取。 (雖然驅動程式無法指定KEY_CREATE_SUB_KEY，但其對 RetrieveDevicePropertyStore 的呼叫可以建立 subkey.)

[in] SubkeyPath

呼叫端提供的字元字串指標，代表 RootSpecifier 參數所指定登錄機碼下之子機碼的名稱。 此參數是選擇性的，可以是 NULL。 如需詳細資訊，請參閱。

[out] PropertyStore

接收 IWDFNamedPropertyStore2 介面指標的位置位址。 驅動程式會使用此介面來存取登錄中的值。

[out] Disposition

接收 WDF_PROPERTY_STORE_DISPOSITION型別值的位置位址。

傳回值

如果作業成功，RetrieveDevicePropertyStore 會傳回S_OK。 否則，方法可能會傳回下列其中一個值：

傳回碼 Description
E_INVALIDARG
 呼叫端提供無效的輸入自變數。
E_OUTOFMEMORY
 嘗試配置記憶體失敗。
 

這個方法可能會傳回 Winerror.h 包含的其他其中一個值

備註

您的驅動程式可以呼叫 RetrieveDevicePropertyStore ，以存取驅動程式的軟體密鑰、目前裝置的硬體金鑰、目前裝置支援的裝置介面密鑰，或 DEVICEMAP 金鑰。

如果您提供 SubkeyPath 參數，則必須使用唯一的名稱，例如驅動程式的服務名稱。 驅動程式可能會使用子機碼來儲存裝置特定資訊。

如需使用 RetrieveDevicePropertyStore 存取登錄的詳細資訊，請參閱 在 UMDF 型驅動程式中使用登錄。

範例

下列程式代碼範例會擷取指派給裝置硬體密鑰下 PortName 專案的值。

IWDFPropertyStoreFactory *pPropertyStoreFactory = NULL;
WDF_PROPERTY_STORE_ROOT RootSpecifier;
IWDFNamedPropertyStore2 * pHardwarePropertyStore2 = NULL;
PROPVARIANT comPortPV;
WCHAR portName[] = L"PortName";
HRESULT hr;
...
//
// Get the property store factory interface.
//
hr = m_FxDevice->QueryInterface(IID_PPV_ARGS(&pPropertyStoreFactory));
if (FAILED(hr))
{
    goto Exit;
}
//
//Initialize the WDF_PROPERTY_STORE_ROOT structure. We want to open the 
// \Device Parameters subkey under the device's hardware key.
//
RtlZeroMemory(&RootSpecifier,
              sizeof(WDF_PROPERTY_STORE_ROOT));
RootSpecifier.LengthCb = sizeof(WDF_PROPERTY_STORE_ROOT);
RootSpecifier.RootClass = WdfPropertyStoreRootClassHardwareKey;
RootSpecifier.Qualifier.HardwareKey.ServiceName = WDF_PROPERTY_STORE_HARDWARE_KEY_ROOT;

//
// Get the property store interface for the hardware key of the
// device that m_FxDevice represents.
//
hr = pPropertyStoreFactory->RetrieveDevicePropertyStore(
                                           &RootSpecifier,
                                           WdfPropertyStoreNormal,
                                           KEY_QUERY_VALUE,
                                           NULL,
                                           &pHardwarePropertyStore2,
                                           NULL
                                           );
if (FAILED(hr))
{
    goto Exit;
}

//
// Get the value of the "PortName" entry, which is stored under 
// the device's \Device Parameters subkey.
//
PropVariantInit(&comPortPV);
hr = pHardwarePropertyStore2->GetNamedValue(portName,
                                            &comPortPV);
if (FAILED(hr))
{
   goto Exit;
}
...
Exit:
    SAFE_RELEASE(pHardwarePropertyStore2);
    SAFE_RELEASE(pPropertyStoreFactory);
...

規格需求

需求 值
終止支援 UMDF 2.0 和更新版本中無法使用。
目標平台 桌面
最低UMDF版本 1.9
標頭 wudfddi.h (包括 Wudfddi.h)
Dll WUDFx.dll

另請參閱

IWDFDevice：：RetrieveDevicePropertyStore

IWDFDeviceInitialize：：RetrieveDevicePropertyStore

IWDFPropertyStoreFactory