IWDFObject::RetrieveContext 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 RetrieveContext method retrieves a context that was previously registered through the IWDFObject::AssignContext method.

Syntax

HRESULT RetrieveContext(
  [out] void **ppvContext
);

Parameters

[out] ppvContext

A pointer to a buffer that receives a pointer to the previously registered context.

Return value

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

Remarks

Because the context is not a Component Object Model (COM) interface, the driver must not treat the context as such. For example, the driver cannot call the AddRef method on the context.

Examples

For a code example of how to use the RetrieveContext method, see IWDFIoQueue::GetDevice.

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