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

<!-- $XConsortium: ActionDe.sgm /main/6 1996/08/30 12:53:02 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.XCDI.MAN9.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN9.rsml.1">]]>
<RefMeta>
<RefEntryTitle>DtActionDescription</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>DtActionDescription</Function></RefName>
<RefPurpose>obtain the descriptive text for a given action
</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/Action.h>
</FuncSynopsisInfo>
<FuncDef>char <Function>*DtActionDescription</Function></FuncDef>
<ParamDef>char *<Parameter>actionName</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>DtActionDescription</Function> function looks up and returns the descriptive text associated
with the
<Emphasis>actionName</Emphasis> action.
The
<Emphasis>actionName</Emphasis> argument is the name of the action.
If there are multiple
<Emphasis>actionName</Emphasis> actions,
the string returned is the description of the most general.
The most general action is the one with the lowest precedence,
as described in
<![ %CDE.C.CDE; [&cdeman.dtactionfile; (``Action Selection'').
]]><![ %CDE.C.XO; [<XRef Linkend="XCDI.M4DTA.anch.1" Role="4">. ]]></Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>DtActionDescription</Function> function returns a newly allocated copy of the description string
associated with the action; otherwise, it returns
<SystemItem Class="Constant">NULL</SystemItem>.</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
<Function>DtActionDescription</Function> function is useful for applications that wish to present information
to the user about a particular action.
</Para>
<Para>The application should use
<Function>XtFree</Function>(3) to free the description string returned by
<Function>DtActionDescription</Function>.</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Dt.Action.h;, <![ %CDE.C.CDE; [<Function>XtFree</Function>(3), &cdeman.dtactionfile;, &cdeman.dtdtfile;. ]]><![ %CDE.C.XO; [<Function>XtFree</Function>(3) in the &str-Zt;;
<XRef Linkend="XCDI.ACTI.anch.3" Role="2">, <XRef Linkend="XCDI.M4DTS.anch.1" Role="3">. ]]></Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->