DtEditorAppend(3)

DtEditorAppend(3)      C LIBRARY FUNCTIONS	DtEditorAppend(3)

NAME
     DtEditorAppend - append data to a DtEditor	widget

SYNOPSIS
     #include <Dt/Editor.h>

     DtEditorErrorCode DtEditorAppend(Widget widget,
				      DtEditorContentRec *data);

DESCRIPTION
     The  DtEditorAppend()  function  appends  either	a   NULL-
     terminated	 string,  wide	character  string or sized buffer
     after the last character in a DtEditor widget.  The data  is
     transferred  to  the DtEditor widget using	a DtEditorConten-
     tRec, which indicates the type  of	 data  being  transferred
     along with	the actual data.  After	the data is appended, the
     insertion cursor is positioned at the new last character.

     The widget	argument specifies the DtEditor	widget ID.

     The data argument points to the  data  structure  containing
     the data to append.

     For a complete definition of the  DtEditor	 widget	 and  its
     associated	resources, see DtEditor(3).

     For  a  complete  definition  of	DtEditorContentRec,   see
     <Dt/Editor>.

RETURN VALUE
     Upon successful completion,  the  DtEditorAppend()	 function
     returns one of the	following values:

	DtEDITOR_NO_ERRORS
	      The data was appended sucessfully.

	DtEDITOR_NULLS_REMOVED
	      NULL characters were found  and  removed	from  the
	      data.

     Otherwise,	if the DtEditorAppend()	 function  cannot  append
     the  data	into  the  DtEditor widget, it returns one of the
     following values:

	DtEDITOR_INVALID_TYPE
	      The type field is	unrecognized.

	DtEDITOR_ILLEGAL_SIZE
	      The size of the buffer passed in is negative.

	DtEDITOR_NULL_ITEM
	      The buffer is NULL.

Unix System LaboratoLast change: 1 August 1995			1

DtEditorAppend(3)      C LIBRARY FUNCTIONS	DtEditorAppend(3)

	DtEDITOR_INSUFFICIENT_MEMORY
	      Not enough system	memory is available to append the
	      data.

EXAMPLES
     The following code	segment	sets the contents of  a	 DtEditor
     widget to ``The quick brown fox.''

	  Widget		  editor;
	  DtEditorContentRec	  cr;
	  DtEditorErrorCode	  status;
	  char			  *sampleString1="The quick",
				  *secondString2=" brown fox";

	  cr.type = DtEDITOR_TEXT;
	  cr.value.string = sampleString1;
	  status = DtEditorSetContents(editor, &cr);
	  if (status !=	DtEDITOR_NO_ERRORS && status !=	DtEDITOR_NULLS_REMOVED)	{
		  printf("Unable to set	the contents of	the widget\n");
	  } else {
		  cr.type = DtEDITOR_TEXT;
		  cr.value.string = sampleString2;
		  status = DtEditorAppend(editor, &cr);
		  if (status !=	DtEDITOR_NO_ERRORS)
			  printf("Unable to append to the contents of the widget\n");
	  }

APPLICATION USAGE
     If	the data is in a disk file, rather than	 in  memory,  the
     application should	use DtEditorAppendFromFile(3).

SEE ALSO
     DtEditor(5), DtEditor(3), DtEditorAppendFromFile(3), DtEdi-
     torGetContents(3),	DtEditorInsert(3), DtEditorInsertFrom-
     File(3), DtEditorReplace(3), DtEditorReplaceFromFile(3),
     DtEditorSaveContentsToFile(3), DtEditorSetContents(3),
     DtEditorSetContentsFromFile(3).

Unix System LaboratoLast change: 1 August 1995			2