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

<!-- $XConsortium: EdGetIns.sgm /main/5 1996/08/30 12:59:32 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.MAN26.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN26.rsml.1">]]>
<RefMeta>
<RefEntryTitle>DtEditorGetInsertionPosition</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>DtEditorGetInsertionPosition</Function></RefName>
<RefPurpose>retrieve the position of the insert cursor 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>XmTextPosition <Function>DtEditorGetInsertionPosition</Function></FuncDef>
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>DtEditorGetInsertionPosition</Function> function accesses the current position of the insertion cursor in the DtEditor
widget.
The position is an integer number of characters from the
beginning of the widget's text buffer.
The first character position is zero.
The position of the insertion cursor can be set with
&cdeman.DtEditorSetInsertionPosition;.</Para>
<Para>The
<Symbol Role="Variable">widget</Symbol> argument specifies the DtEditor widget ID.
<![ %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>DtEditorGetInsertionPosition</Function> function returns an
<StructName Role="typedef">XmTextPosition</StructName> value that indicates the position of the insertion cursor in the text; otherwise,
it returns
<SystemItem Class="Constant">NULL</SystemItem>.</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Dt.Editor.h;, &cdeman.DtEditor;, &cdeman.DtEditorGetLastPosition;, &cdeman.DtEditorSetInsertionPosition;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->