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

<!-- $XConsortium: ActionEx.sgm /main/6 1996/08/30 12:53:11 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.MAN10.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN10.rsml.1">]]>
<RefMeta>
<RefEntryTitle>DtActionExists</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>DtActionExists</Function></RefName>
<RefPurpose>determine if a string corresponds to an action name
</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>Boolean <Function>DtActionExists</Function></FuncDef>
<ParamDef>char *<Parameter>name</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>DtActionExists</Function> function checks whether a given name corresponds to an action name.
The
<Symbol Role="Variable">name</Symbol> argument is the name of the action.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>DtActionExists</Function> function returns
True
if
<Symbol Role="Variable">name</Symbol> corresponds to an existing action name;
otherwise, it returns
<SystemItem Class="Constant">False</SystemItem>.</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
<Function>DtActionExists</Function> function is useful for applications that need to verify that an
action name is valid before attempting to invoke it.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Dt.Action.h;, <![ %CDE.C.CDE; [&cdeman.dtactionfile;, &cdeman.dtdtfile;. ]]><![ %CDE.C.XO; [<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-->