CallWndRetProc callback function (Windows)

Applies to: desktop apps only

An application-defined or library-defined callback function used with the SetWindowsHookEx function. The system calls this function after the SendMessage function is called. The hook procedure can examine the message; it cannot modify it.

The HOOKPROC type defines a pointer to this callback function. CallWndRetProc is a placeholder for the application-defined or library-defined function name.

Syntax

LRESULT CALLBACK CallWndRetProc(
  __in  int nCode,
  __in  WPARAM wParam,
  __in  LPARAM lParam
);

Parameters

nCode [in]

Type: int

Specifies whether the hook procedure must process the message. If nCode is HC_ACTION, the hook procedure must process the message. If nCode is less than zero, the hook procedure must pass the message to the CallNextHookEx function without further processing and should return the value returned by CallNextHookEx.

wParam [in]

Type: WPARAM

Specifies whether the message is sent by the current process. If the message is sent by the current process, it is nonzero; otherwise, it is NULL.

lParam [in]

Type: LPARAM

A pointer to a CWPRETSTRUCT structure that contains details about the message.

Return value

Type:

Type: LRESULT

If nCode is less than zero, the hook procedure must return the value returned by CallNextHookEx.

If nCode is greater than or equal to zero, it is highly recommended that you call CallNextHookEx and return the value it returns; otherwise, other applications that have installed WH_CALLWNDPROCRET hooks will not receive hook notifications and may behave incorrectly as a result. If the hook procedure does not call CallNextHookEx, the return value should be zero.

Remarks

An application installs the hook procedure by specifying the WH_CALLWNDPROCRET hook type and a pointer to the hook procedure in a call to the SetWindowsHookEx function.

Requirements

See also

Reference

CallNextHookEx

CallWndProc

CWPRETSTRUCT

SendMessage

SetWindowsHookEx

Conceptual

Hooks

Send comments about this topic to Microsoft

Build date: 2/3/2012