PropEnumProc
A PropEnumProc
function is an application-defined callback function that receives property
entries from a window s property list. A PropEnumProc function is called
as a result of a call to the EnumProps function. A value of type PROPENUMPROC
is a pointer to a PropEnumProc function.
BOOL CALLBACK PropEnumProc(
|
HWND hwnd, |
// handle to window
whose property list is being enumerated |
|
LPCTSTR lpszString, |
// string component
of property |
|
HANDLE hData |
// data handle
component of property |
|
); |
|
Parameters
hwnd
Handle to the
window whose property list is being enumerated.
lpszString
Pointer to a
null-terminated string. This string is 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.
hData
Handle to
data. This handle is the data component of a property list entry.
Return Values
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 must not
yield control or do anything that might yield control to other tasks.
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.
PropEnumProc is a placeholder for the application-defined function
name.
See Also