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

<!-- $XConsortium: EdFind.sgm /main/5 1996/08/30 12:59:03 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.MAN23.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN23.rsml.1">]]>
<RefMeta>
<RefEntryTitle>DtEditorFind</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>DtEditorFind</Function></RefName>
<RefPurpose>search for the next occurrence of a string in a DtEditor 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/Editor.h>
</FuncSynopsisInfo>
<FuncDef>Boolean <Function>DtEditorFind</Function></FuncDef>
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
<ParamDef>char *<Parameter>find</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>DtEditorFind</Function> function searches for the next occurrence (relative to the
insertion cursor) of a string.
The string is either
the last find string value specified in the
Find/Change dialog (see
&cdeman.DtEditorInvokeFindChangeDialog;) or is passed in as an argument.
</Para>
<Para>The
<Symbol Role="Variable">widget</Symbol> argument specifies the DtEditor widget ID.
</Para>
<Para>The
<Emphasis>find</Emphasis> argument specifies the string to search for.
If
<Emphasis>find</Emphasis> is
<SystemItem Class="Constant">NULL</SystemItem>, <Function>DtEditorFind</Function> uses the last string specified in the Find field of the
Find/Change dialog.
If the string is not found by the time the end of the document is reached,
the search continues at the beginning of the document,
stopping at the character before the insertion cursor.
<![ %CDE.C.CDE; [</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>DtEditorFind</Function> function returns
True
if the search string was found;
otherwise, it returns
False.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;, &cdeman.DtEditorChange;, &cdeman.DtEditorInvokeFindChangeDialog;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->