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

<!-- $XConsortium: CreHelpD.sgm /main/6 1996/08/30 12:55:16 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. -->

<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN10.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN10.rsml.1">]]>
<RefMeta>
<RefEntryTitle>DtCreateHelpDialog</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>DtCreateHelpDialog</Function></RefName>
<RefPurpose>create a general DtHelpDialog widget
</RefPurpose>
</RefNameDiv>
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- *************************************************************************-->
<!-- **  (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- **  (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- **  (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- **  (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<!-- *************************************************************************-->
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Dt/HelpDialog.h>
</FuncSynopsisInfo>
<FuncDef>Widget <Function>DtCreateHelpDialog</Function></FuncDef>
<ParamDef>Widget <Parameter>parent</Parameter></ParamDef>
<ParamDef>String <Parameter>name</Parameter></ParamDef>
<ParamDef>ArgList <Parameter>arglist</Parameter></ParamDef>
<ParamDef>Cardinal <Parameter>argcount</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>DtCreateHelpDialog</Function> function is a convenience function that creates a
DtHelpDialog
widget.
</Para>
<Para>The
<Symbol Role="Variable">parent</Symbol> argument specifies the parent widget ID.
</Para>
<Para>The
<Symbol Role="Variable">name</Symbol> argument specifies the name of the created widget.
</Para>
<Para>The
<Symbol Role="Variable">arglist</Symbol> argument specifies the argument list.
</Para>
<Para>The
<Symbol Role="Variable">argcount</Symbol> argument specifies the number of attribute and value pairs in
the argument list
(<Symbol Role="Variable">arglist</Symbol>).</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>DtCreateHelpDialog</Function> function returns an
XmBulletinBoard
widget whose parent is a dialog shell widget; otherwise, it returns
an undefined widget value.
The dialog shell is the
DtHelpDialog
widget's top level.
<![ %CDE.C.CDE; [Refer to the
Motif documentation for more information on the dialog shell widget and
applicable resources.
]]></Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Dt.HelpDialog.h;, &cdeman.Dt.Help.h;, &cdeman.DtCreateHelpQuickDialog;, &cdeman.DtHelpSetCatalogName;, <![ %CDE.C.CDE; [&cdeman.XmBulletinBoard;. ]]><![ %CDE.C.XO; [<Classname>XmBulletinBoard</Classname> in the &str-ZM;.
]]></Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->