CDE/cde/doc/C/guides/man/m3_Dt/EdGetMes.sgm

<!-- $XConsortium: EdGetMes.sgm /main/4 1996/08/30 12:59:52 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->

<RefEntry Id="CDEMX.MAN50.rsml.1">
<RefMeta>
<RefEntryTitle>DtEditorGetMessageTextFieldID</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>DtEditorGetMessageTextFieldID</Function></RefName>
<RefPurpose>retrieve the widget ID of the message text field in the DtEditor status line
<IndexTerm>
<Primary>DtEditorGetMessageTextFieldID</Primary>
</IndexTerm><IndexTerm>
<Primary>DtEditor functions</Primary>
<Secondary>DtEditorGetMessageTextFieldID</Secondary>
</IndexTerm></RefPurpose>
</RefNameDiv>
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- *************************************************************************-->
<!-- **  (c) Copyright 1993, 1994 Hewlett-Packard Company-->
<!-- **  (c) Copyright 1993, 1994 International Business Machines Corp.-->
<!-- **  (c) Copyright 1993, 1994 Sun Microsystems, Inc.-->
<!-- **  (c) Copyright 1993, 1994 Novell, Inc.-->
<!-- *************************************************************************-->
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Dt/Editor.h>
</FuncSynopsisInfo>
<FuncDef>Widget <Function>DtEditorGetMessageTextFieldID</Function></FuncDef>
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>DtEditorGetMessageTextFieldID</Function> function returns the widget ID of the Motif Text Field located in the
status area of a DtEditor widget.
By setting the
<SystemItem Class="Resource">XmNvalue</SystemItem> or
<SystemItem Class="Resource">XmNvalueWcs</SystemItem> resource of this widget, an application can
display feedback messages for the user.
If the application does not use the message field,
the message field can be unmanaged by calling
<Function>XtUnmanageWidget</Function>(3) with this widget ID.
</Para>
<Para>The
<Symbol Role="Variable">widget</Symbol> argument specifies the DtEditor widget ID.
</Para>
<Para>For a complete definition of the DtEditor widget and its associated resources, see
&cdeman.DtEditor;.</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>DtEditorGetMessageTextFieldID</Function> function returns the ID of the text field widget; otherwise, it returns
<SystemItem Class="Constant">NULL</SystemItem>.</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;, &cdeman.XmTextField;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->