RmUtilProcessMessage.h File Reference

Go to the source code of this file.

Classes
struct	RmMessageHandlerStruct
Typedefs
typedef LRESULT	RmHandleMessageProc (RmMessageHandlerStruct *pRmMessageHandlerStruct)
Functions
RMUTIL_API void	RmInitializeProcessMessage ()
RMUTIL_API void	RmUninitializeProcessMessage ()
RMUTIL_API void	RmBlockMessage (HWND hSourceWnd, UINT uSourceMsg)
RMUTIL_API void	RmInterceptMessage (HWND hDestinationWnd, HWND hSourceWnd, UINT uSourceMsg)
RMUTIL_API void	RmForwardMessage (HWND hDestinationWnd, HWND hSourceWnd, UINT uSourceMsg)
RMUTIL_API void	RmHandleMessage (HWND hDestinationWnd, UINT uDestinationMsg, void *pUserData, HWND hSourceWnd, UINT uSourceMsg)
RMUTIL_API void	RmHandleMessage (RmHandleMessageProc *pRmHandleMessageProc, void *pUserData, HWND hSourceWnd, UINT uSourceMsg)
RMUTIL_API void	RmResumeDefaultMessageHandling (HWND hSourceWnd, UINT uSourceMsg)

---

Detailed Description

This set of functions enable windows to add special message

---

Typedef Documentation

RmHandleMessageProc

Function declaration for directly processing a message through the RmHandleMessage utility

---

Function Documentation

RMUTIL_API void RmBlockMessage (  HWND  hSourceWnd, UINT  uSourceMsg )

Utility function to enable a window to block a particular message. The caller provides the source window handle and the source message ID which is to be blocked Parameters: hSourceWnd  Source window uSourceMsg  Message Returns: None

RMUTIL_API void RmForwardMessage (  HWND  hDestinationWnd, HWND  hSourceWnd, UINT  uSourceMsg )

Utility function to enable a window to forward a particular message. The caller provides the source window handle, the source window message ID, and a destination window handle, where the message will be sent The source window message handler will be called afterwards Parameters: hDestinationWnd  Destination window hSourceWnd  Source window uSourceMsg  Message Returns: None

RMUTIL_API void RmHandleMessage (  RmHandleMessageProc *  pRmHandleMessageProc, void *  pUserData, HWND  hSourceWnd, UINT  uSourceMsg )

Utility function to define a function to handle a particular message. The caller provides the source window handle, the source window message ID, and provides a function pointer that will handle the message. The function will contain a pointer to a RmMessageHandlerStruct, detailing the message to be handled. The user can also provide user data that will be returned in the struct. Parameters: pRmHandleMessageProc  Message handler See also: RmHandleMessageProc Parameters: pUserData  User data hSourceWnd  Source window uSourceMsg  Source message Returns: None

RMUTIL_API void RmHandleMessage (  HWND  hDestinationWnd, UINT  uDestinationMsg, void *  pUserData, HWND  hSourceWnd, UINT  uSourceMsg )

Utility function to enable a window to handle a particular message. The caller provides the source window handle, the source window message ID, and provides a destination window handle and message ID. The destination window message ID should be a WM_USER based message which will not conflict with existing message ID's. The WPARAM of the destination message will contain a pointer to a RmMessageHandlerStruct, detailing the message to be handled. The user can also provide user data that will be returned in the struct. Parameters: hDestinationWnd  Destination window uDestinationMsg  Destination message pUserData  User data hSourceWnd  Source window uSourceMsg  Source message Returns: None

RMUTIL_API void RmInitializeProcessMessage (   )

Initialize Message Processing Utilities Returns: None

RMUTIL_API void RmInterceptMessage (  HWND  hDestinationWnd, HWND  hSourceWnd, UINT  uSourceMsg )

Utility function to enable a window to intercept a particular message. The caller provides the source window handle, the source window message ID, and a destination window handle, where the message will be sent. The source window message handler will not be called for intercepted messages Parameters: hDestinationWnd  Destination window hSourceWnd  Source window uSourceMsg  Message Returns: None

RMUTIL_API void RmResumeDefaultMessageHandling (  HWND  hSourceWnd, UINT  uSourceMsg )

Utility function to remove any of the above message hooks. The caller provides the source window handle and the source window message ID, and the appropriate hook will be removed Parameters: hSourceWnd  Source window uSourceMsg  Source message Returns: None

RMUTIL_API void RmUninitializeProcessMessage (   )

Uninitialize Message Processing Utilities Returns: None

---