WindowsXP/windows/advcore/duser/docs/api/sendgadgetmessage.htm
2025-04-27 07:49:33 -04:00

124 lines
7.9 KiB
HTML
Raw Blame History

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
<meta name="GENERATOR" content="Microsoft FrontPage 4.0">
<meta name="ProgId" content="FrontPage.Editor.Document">
<link rel="stylesheet" type="text/css" href="api.css">
<title></title>
<meta name="Microsoft Theme" content="glacier 111, default"><meta name="Microsoft Border" content="tb, default"></head>
<body leftmargin="44" background="../_themes/glacier/glabkgnd.jpg" bgcolor="#CCFFFF" text="#000000" link="#339999" vlink="#999999" alink="#406666"><!--msnavigation--><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr><td><!--mstheme--><font face="arial, arial, helvetica">
<!--mstheme--></font></td></tr><!--msnavigation--></table><!--msnavigation--><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr><!--msnavigation--><td valign="top"><!--mstheme--><font face="arial, arial, helvetica"><!--mstheme--></font><table border="0" width="700" cellspacing="0" cellpadding="0">
<tr>
<td width="5%" valign="middle"><!--mstheme--><font face="arial, arial, helvetica"><img border="0" src="../images/Core.gif" width="32" height="32"><!--mstheme--></font></td>
<td width="95%" valign="middle"><!--mstheme--><font face="arial, arial, helvetica">
<h1><!--mstheme--><font face="verdana, arial, helvetica" color="#006666">SendGadgetMessage<!--mstheme--></font></h1>
<h2><!--mstheme--><font face="verdana, arial, helvetica" color="#006666">Core<!--mstheme--></font></h2>
<!--mstheme--></font></td>
</tr>
</table><!--mstheme--><font face="arial, arial, helvetica">
<dl>
<p><b>SendGadgetMessage</b> sends a message to the specified Gadget. The function calls the Gadget procedure and does not return until the Gadget has processed the message.</p>
</dl>
<!--mstheme--></font><pre>UINT <b>SendGadgetMessage</b>(
<b>GMSG</b> * pmsg, // Message to send
<b>UINT</b> nFlags // Optional flags to modifying sending
);</pre><!--mstheme--><font face="arial, arial, helvetica">
<h4><!--mstheme--><font face="verdana, arial, helvetica" color="#006666">Parameters<!--mstheme--></font></h4>
<dl>
<dt><i>pmsg</i></dt>
<dd>[in] Several members of the GMSG must be previously filled to correctly send the message to the specified Gadget.<br>
<br>
<!--mstheme--></font><table border="2" width="700" cellspacing="0" cellpadding="5" bordercolordark="#006666" bordercolorlight="#99CCCC">
<tr>
<td width="33%" bgcolor="#C0C0C0" valign="top"><!--mstheme--><font face="arial, arial, helvetica"><b>Field</b><!--mstheme--></font></td>
<td width="66%" bgcolor="#C0C0C0" valign="top"><!--mstheme--><font face="arial, arial, helvetica"><b>Description</b><!--mstheme--></font></td>
</tr>
<tr>
<td width="33%" valign="top"><!--mstheme--><font face="arial, arial, helvetica">cbSize<!--mstheme--></font></td>
<td width="66%" valign="top"><!--mstheme--><font face="arial, arial, helvetica">Size of the message being sent in bytes.<!--mstheme--></font></td>
</tr>
<tr>
<td width="33%" valign="top"><!--mstheme--><font face="arial, arial, helvetica">nMsg<!--mstheme--></font></td>
<td width="66%" valign="top"><!--mstheme--><font face="arial, arial, helvetica">ID of the message.<!--mstheme--></font></td>
</tr>
<tr>
<td width="33%" valign="top"><!--mstheme--><font face="arial, arial, helvetica">hgadMsg<!--mstheme--></font></td>
<td width="66%" valign="top"><!--mstheme--><font face="arial, arial, helvetica">Gadget that the message is being sent to.<!--mstheme--></font></td>
</tr>
<tr>
<td width="33%" valign="top"><!--mstheme--><font face="arial, arial, helvetica">result<!--mstheme--></font></td>
<td width="66%" valign="top"><!--mstheme--><font face="arial, arial, helvetica">Default result value.<!--mstheme--></font></td>
</tr>
</table><!--mstheme--><font face="arial, arial, helvetica">
</dd>
<dt><i>nFlags</i></dt>
<dd>[in] Specifies optional flags to modify how the message is sent to the Gadget.<br>
<br>
<!--mstheme--></font><table border="2" width="700" cellspacing="0" cellpadding="5" bordercolordark="#006666" bordercolorlight="#99CCCC">
<tr>
<td width="33%" bgcolor="#C0C0C0" valign="top"><!--mstheme--><font face="arial, arial, helvetica"><b>Value</b><!--mstheme--></font></td>
<td width="66%" bgcolor="#C0C0C0" valign="top"><!--mstheme--><font face="arial, arial, helvetica"><b>Action</b><!--mstheme--></font></td>
</tr>
<tr>
<td width="33%" valign="top"><!--mstheme--><font face="arial, arial, helvetica">SGM_BUBBLE<!--mstheme--></font></td>
<td width="66%" valign="top"><!--mstheme--><font face="arial, arial, helvetica">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.<!--mstheme--></font></td> </tr>
</table><!--mstheme--><font face="arial, arial, helvetica">
</dd>
</dl>
<h4><!--mstheme--><font face="verdana, arial, helvetica" color="#006666"><br>
Return Values<!--mstheme--></font></h4>
<dl>
<p>Return value specifying how message was handled:</p>
<!--mstheme--></font><table border="2" width="700" cellspacing="0" cellpadding="5" bordercolordark="#006666" bordercolorlight="#99CCCC">
<tr>
<td width="33%" bgcolor="#C0C0C0" valign="top"><!--mstheme--><font face="arial, arial, helvetica"><b>Value</b><!--mstheme--></font></td>
<td width="66%" bgcolor="#C0C0C0" valign="top"><!--mstheme--><font face="arial, arial, helvetica"><b>Action</b><!--mstheme--></font></td>
</tr>
<tr>
<td width="33%" valign="top"><!--mstheme--><font face="arial, arial, helvetica">GPR_COMPLETE<!--mstheme--></font></td>
<td width="66%" valign="top"><!--mstheme--><font face="arial, arial, helvetica">The message was completely handled by a Gadget in the processing loop.<!--mstheme--></font></td>
</tr>
<tr>
<td width="33%" valign="top"><!--mstheme--><font face="arial, arial, helvetica">GPR_PARTIAL<!--mstheme--></font></td>
<td width="66%" valign="top"><!--mstheme--><font face="arial, arial, helvetica">The message was partially handled by one or more Gadget in the processing loop, but was never completely handled.<!--mstheme--></font></td>
</tr>
<tr>
<td width="33%" valign="top"><!--mstheme--><font face="arial, arial, helvetica">GPR_NOTHANDLED<!--mstheme--></font></td>
<td width="66%" valign="top"><!--mstheme--><font face="arial, arial, helvetica">The message was never handled by any Gadgets in the processing loop.<!--mstheme--></font></td>
</tr>
</table><!--mstheme--><font face="arial, arial, helvetica">
</dl>
<h4><!--mstheme--><font face="verdana, arial, helvetica" color="#006666">See Also<!--mstheme--></font></h4>
<p> <b> <a href="AddGadgetMessageHandler.htm"> AddGadgetMessageHandler</a></b>,<b><a href="RegisterGadgetMessage.htm">RegisterGadgetMessage</a></b>, <b> <a href="RegisterGadgetMessageString.htm"> RegisterGadgetMessageString</a></b>,
<a href="RemoveGadgetMessageHandler.htm"><b> RemoveGadgetMessageHandler</b></a>, <b> <a href="UnregisterGadgetMessage.htm"> UnregisterGadgetMessage</a></b>,
<b> <a href="UnregisterGadgetMessageString.htm"> UnregisterGadgetMessageString</a></b>, GMSG, Overview of Gadget Messaging</p>
<!--mstheme--></font><!--msnavigation--></td></tr><!--msnavigation--></table><!--msnavigation--><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr><td><!--mstheme--><font face="arial, arial, helvetica">
<p align="center">&nbsp;
<p align="center" style="border-top-style: solid; border-top-width: 2"><b><font color="#FF0000" size="3"><br>
Internal Only</font></b><p align="center">Build on Friday, March 17, 2000
<br>
Copyright <20> 2000 by Microsoft Corporation.&nbsp; All rights reserved<br>
<a href="mailto:jstall">Send feedback </a>to Jeff Stall
<!--mstheme--></font></td></tr><!--msnavigation--></table></body>
</html>