Skip to content

Latest commit

 

History

History
111 lines (75 loc) · 3.46 KB

nf-winuser-enumpropsa.md

File metadata and controls

111 lines (75 loc) · 3.46 KB
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
NF:winuser.EnumPropsA
EnumPropsA function (winuser.h)
Enumerates all entries in the property list of a window by passing them, one by one, to the specified callback function. EnumProps continues until the last entry is enumerated or the callback function returns FALSE. (ANSI)
EnumPropsA
winuser/EnumPropsA
winmsg\enumprops.htm
winmsg
VS|winui|~\winui\windowsuserinterface\windowing\windowproperties\windowpropertyreference\windowpropertyfunctions\enumprops.htm
12/05/2018
EnumProps, EnumProps function [Windows and Messages], EnumPropsA, EnumPropsW, _win32_EnumProps, _win32_enumprops_cpp, winmsg.enumprops, winui._win32_enumprops, winuser/EnumProps, winuser/EnumPropsA, winuser/EnumPropsW
winuser.h
Windows.h
Windows
Windows 2000 Professional [desktop apps only]
Windows 2000 Server [desktop apps only]
EnumPropsW (Unicode) and EnumPropsA (ANSI)
User32.lib
User32.dll
Windows
19H1
EnumPropsA
winuser/EnumPropsA
c++
APIRef
kbSyntax
DllExport
User32.dll
API-MS-Win-RTCore-NTUser-Window-l1-1-0.dll
minuser.dll
Ext-MS-Win-RTCore-NTUser-Window-Ext-l1-1-0.dll
EnumProps
EnumPropsA
EnumPropsW

EnumPropsA function

-description

Enumerates all entries in the property list of a window by passing them, one by one, to the specified callback function. EnumProps continues until the last entry is enumerated or the callback function returns FALSE.

To pass application-defined data to the callback function, use EnumPropsEx function.

-parameters

-param hWnd [in]

Type: HWND

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

-param lpEnumFunc [in]

Type: PROPENUMPROC

A pointer to the callback function. For more information about the callback function, see the PropEnumProc function.

-returns

Type: int

The return value specifies the last value returned by the callback function. It is -1 if the function did not find a property for enumeration.

-remarks

An application can remove only those properties it has added. It must not remove properties added by other applications or by the system itself.

Note

The winuser.h header defines EnumProps 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

EnumPropsEx

PropEnumProc

Reference

Window Properties