 |
SendGadgetMessage
Core
|
SendGadgetMessage sends a message to the specified Gadget. The function calls the Gadget procedure and does not return until the Gadget has processed the message.
UINT SendGadgetMessage(
GMSG * pmsg, // Message to send
UINT nFlags // Optional flags to modifying sending
);
Parameters
- pmsg
- [in] Several members of the GMSG must be previously filled to correctly send the message to the specified Gadget.
| Field |
Description |
| cbSize |
Size of the message being sent in bytes. |
| nMsg |
ID of the message. |
| hgadMsg |
Gadget that the message is being sent to. |
| result |
Default result value. |
nFlags
[in] Specifies optional flags to modify how the message is sent to the Gadget.
| Value |
Action |
| SGM_BUBBLE |
The message will be fully routed and bubbled inside the Gadget Tree. If this flag is not specified, the message will only be sent directly to the Gadget and any attached Message Handlers. |
Return Values
Return value specifying how message was handled:
| Value |
Action |
| GPR_COMPLETE |
The message was completely handled by a Gadget in the processing loop. |
| GPR_PARTIAL |
The message was partially handled by one or more Gadget in the processing loop, but was never completely handled. |
| GPR_NOTHANDLED |
The message was never handled by any Gadgets in the processing loop. |
See Also
AddGadgetMessageHandler,RegisterGadgetMessage, RegisterGadgetMessageString,
RemoveGadgetMessageHandler, UnregisterGadgetMessage,
UnregisterGadgetMessageString, GMSG, Overview of Gadget Messaging
|