WNDOBJ_vSetConsumer function (winddi.h)

The WNDOBJ_vSetConsumer function sets a driver-defined value in the pvConsumer field of the specified WNDOBJ structure.

Syntax

ENGAPI VOID WNDOBJ_vSetConsumer(
  WNDOBJ *pwo,
  PVOID  pvConsumer
);

Parameters

pwo

Pointer to a WNDOBJ structure created by a prior call to EngCreateWnd.

pvConsumer

A driver-defined value for identifying this particular WNDOBJ structure. This value overrides the previous value stored in the WNDOBJ structure.

Return value

None

Remarks

WNDOBJ_vSetConsumer should be called only by the following functions:

  • Graphics DDI functions for which a WNDOBJ structure is provided.
  • The callback provided to GDI by a driver's call to EngCreateWnd.
  • The WNDOBJ_SETUP escape defined by DrvEscape after a new WNDOBJ structure is created.

Requirements

Requirement Value
Minimum supported client Available in Windows 2000 and later versions of the Windows operating systems.
Target Platform Universal
Header winddi.h (include Winddi.h)
Library Win32k.lib
DLL Win32k.sys

See also

DrvEscape

EngCreateWnd

WNDOBJ