Skip to content

Latest commit

 

History

History
122 lines (80 loc) · 4.04 KB

nc-winuser-propenumprocw.md

File metadata and controls

122 lines (80 loc) · 4.04 KB
Raw
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NC:winuser.PROPENUMPROCW
PROPENUMPROCW (winuser.h)
An application-defined callback function used with the EnumProps function. (Unicode)
PropEnumProc
PropEnumProc callback
PropEnumProc callback function [Windows and Messages]
PropEnumProcA
PropEnumProcW
_win32_PropEnumProc
_win32_propenumproc_cpp
winmsg.propenumproc
winui._win32_propenumproc
winuser/PropEnumProc
winuser/PropEnumProcA
winuser/PropEnumProcW
winmsg\propenumproc.htm
winmsg
VS|winui|~\winui\windowsuserinterface\windowing\windowproperties\windowpropertyreference\windowpropertyfunctions\propenumproc.htm
12/05/2018
PropEnumProc, PropEnumProc callback, PropEnumProc callback function [Windows and Messages], PropEnumProcA, PropEnumProcW, _win32_PropEnumProc, _win32_propenumproc_cpp, winmsg.propenumproc, winui._win32_propenumproc, winuser/PropEnumProc, winuser/PropEnumProcA, winuser/PropEnumProcW
winuser.h
Windows.h
Windows
Windows 2000 Professional [desktop apps only]
Windows 2000 Server [desktop apps only]
PropEnumProcW (Unicode) and PropEnumProcA (ANSI)
Windows
19H1
PROPENUMPROCW
winuser/PROPENUMPROCW
c++
APIRef
kbSyntax
UserDefined
Winuser.h
PropEnumProc
PropEnumProcA
PropEnumProcW

PROPENUMPROCW callback function

-description

An application-defined callback function used with the EnumProps function. The function receives property entries from a window's property list. The PROPENUMPROC type defines a pointer to this callback function. PropEnumProc is a placeholder for the application-defined function name.

-parameters

-param unnamedParam1

Type: HWND

A handle to the window whose property list is being enumerated.

-param unnamedParam2

Type: LPCTSTR

The string component of a property list entry. This is the string that was specified, along with a data handle, when the property was added to the window's property list via a call to the SetProp function.

-param unnamedParam3

Type: HANDLE

A handle to the data. This handle is the data component of a property list entry.

-returns

Type: BOOL

Return TRUE to continue the property list enumeration.

Return FALSE to stop the property list enumeration.

-remarks

The following restrictions apply to this callback function:

  • The callback function can call the RemoveProp function. However, RemoveProp can remove only the property passed to the callback function through the callback function's parameters.
  • The callback function should not attempt to add properties.

Note

The winuser.h header defines PROPENUMPROC as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

-see-also

Conceptual

EnumProps

Reference

RemoveProp

SetProp

Window Properties