DtEditorInsert(library call)                   DtEditorInsert(library call)




 NAME    [Toc]    [Back]
      DtEditorInsert - insert data into a DtEditor widget

 SYNOPSIS    [Toc]    [Back]
      #include <Dt/Editor.h>
      DtEditorErrorCode DtEditorInsert(
      Widget widget,
      DtEditorContentRec *data);

 DESCRIPTION    [Toc]    [Back]
      The DtEditorInsert function inserts either a string, wide character
      string or sized buffer at the insertion cursor position in a DtEditor
      widget.  The data is transferred to the DtEditor widget using a
      DtEditorContentRec, which indicates the type of data being transferred
      along with the actual data.  After the data is appended, the insertion
      cursor is positioned after the last character inserted.

      The widget argument specifies the DtEditor widget ID.

      The data argument is a pointer to a data structure containing the data
      to insert.

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

      For a complete definition of DtEditorContentRec, see Dt/Editor.h -
      DtEditor(5).

 RETURN VALUE    [Toc]    [Back]
      Upon successful completion, the DtEditorInsert function returns one of
      the following values:

      DtEDITOR_NO_ERRORS
                The data was inserted sucessfully.

      DtEDITOR_NULLS_REMOVED
                NULL characters were found and removed from the data.

      Otherwise, if the DtEditorInsert function cannot insert the data into
      the DtEditor widget, it returns one of the following values:

      DtEDITOR_INVALID_TYPE
                The Type field is not recognized.

      DtEDITOR_ILLEGAL_SIZE
                The size of the buffer passed in is negative.

      DtEDITOR_NULL_ITEM
                The buffer is NULL.





                                    - 1 -       Formatted:  January 24, 2005






 DtEditorInsert(library call)                   DtEditorInsert(library call)




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

 EXAMPLES    [Toc]    [Back]
      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 brown fox",
                              *sampleString2=" quick";
      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 contents of the widget\n");
      } else {
        /*
         * Move the insertion cursor so it is after the
         * letter 'e' in "The".
         */
              DtEditorSetInsertionCursorPosition(editor, 2);
              cr.type = DtEDITOR_TEXT;
              cr.data.string = sampleString2;
              status = DtEditorInsert(editor, &cr);
              if (status != DtEDITOR_NO_ERRORS)
                printf("Unable to insert into the contents of the widget\n");
      }

 APPLICATION USAGE    [Toc]    [Back]
      If the data is in a disk file, rather than in memory, the application
      should use DtEditorInsertFromFile(3).

 SEE ALSO    [Toc]    [Back]
      Dt/Editor.h - DtEditor(5), DtEditor(3), DtEditorAppend(3),
      DtEditorAppendFromFile(3), DtEditorGetContents(3),
      DtEditorInsertFromFile(3), DtEditorReplace(3),
      DtEditorReplaceFromFile(3), DtEditorSaveContentsToFile(3),
      DtEditorSetContents(3), DtEditorGetInsertionPosition(3),
      DtEditorSetInsertionPosition(3), DtEditorSetContentsFromFile(3).


                                    - 2 -       Formatted:  January 24, 2005