Files
cdesktop/cde/doc/C/guides/man/m3_Dt/TermDisp.sgm

78 lines
2.8 KiB
Plaintext

<!-- $XConsortium: TermDisp.sgm /main/6 1996/10/08 20:41: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.MAN54.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN54.rsml.1">]]>
<RefMeta>
<RefEntryTitle>DtTermDisplaySend</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>DtTermDisplaySend</Function></RefName>
<RefPurpose>send data to a DtTerm widget's display
</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/Term.h>
</FuncSynopsisInfo>
<FuncDef>void <Function>DtTermDisplaySend</Function></FuncDef>
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
<ParamDef>unsigned char <Parameter>*buffer</Parameter></ParamDef>
<ParamDef>int <Parameter>length</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>DtTermDisplaySend</Function> function sends data to a DtTerm widget's display.
</Para>
<Para>The
<Symbol Role="Variable">widget</Symbol> argument specifies the DtTerm widget ID.
</Para>
<Para>The
<Symbol Role="Variable">buffer</Symbol> argument specifies the string (single- or multi-byte depending on the locale)
to be sent to the display.
The string may contain
<SystemItem Class="Constant">NULL</SystemItem> bytes.
</Para>
<Para>The
<Symbol Role="Variable">length</Symbol> argument specifies the length of
<Symbol Role="Variable">buffer</Symbol> in bytes.
</Para>
<Para>The
<Function>DtTermDisplaySend</Function> function
allows the program to write text directly to the
DtTerm widget's text display.
The text is handled in the same
manner as text received from the child process.
Before the text is written in the window,
the DtTerm widget's input parser processes it.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUES</Title>
<Para>The
<Function>DtTermDisplaySend</Function> function returns no value.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Dt.Term.h;, &cdeman.DtTerm;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->