IWDFNamedPropertyStore2::DeleteNamedValue method (wudfddi.h)

Article
02/22/2024

[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 DeleteNamedValue method deletes a value name from the registry.

Syntax

HRESULT DeleteNamedValue(
  [in] LPCWSTR pwszName
);

Parameters

[in] pwszName

A pointer to a null-terminated string that contains a registry value name.

Return value

DeleteNamedValue returns S_OK if the operation succeeds. Otherwise, the method might return the following value:

Return code	Description
E_INVALIDARG	The caller provided an invalid input argument.

This method might return one of the other values that Winerror.h contains.

Remarks

Before a driver calls DeleteNamedValue, it must call IWDFPropertyStoreFactory::RetrieveDevicePropertyStore to obtain the IWDFNamedPropertyStore2 interface.

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

Examples

The following code example is an IObjectCleanup::OnCleanup callback function for a device object. If the driver had previously added a value to the registry's DEVICEMAP key, the callback function deletes the value.

VOID 
CMyDevice::OnCleanup(
 IWDFObject*  pWdfObject
)
{
    UNREFERENCED_PARAMETER(pWdfObject);
 
    if ((m_CreatedLegacyHardwareKey == TRUE) && 
        (m_LegacyHardwarePropertyStore != NULL))
    {
        m_LegacyHardwarePropertyStore->DeleteNamedValue(m_PdoName);
        SAFE_RELEASE(m_LegacyHardwarePropertyStore);
        delete[] m_PdoName;
    }    
}

Requirements

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

Share via