DtEditorInsertFromFile(library call)   DtEditorInsertFromFile(library call)




 NAME    [Toc]    [Back]
      DtEditorInsertFromFile - insert data from a file into a DtEditor
      widget

 SYNOPSIS    [Toc]    [Back]
      #include <Dt/Editor.h>
      DtEditorErrorCode DtEditorInsertFromFile(
      Widget widget,
      char *fileName);

 DESCRIPTION    [Toc]    [Back]
      The DtEditorInsertFromFile function inserts data from a file to the
      insertion cursor position in a DtEditor widget.  After the data is
      inserted, the insertion cursor is positioned after the last character
      inserted.

      The widget argument specifies the DtEditor widget ID.

      The fileName argument is the pathname of the file relative to the
      local system.

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

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

      DtEDITOR_NO_ERRORS
                The file is readable and writable.

      DtEDITOR_READ_ONLY_FILE
                The file is read only.

      DtEDITOR_NULLS_REMOVED
                The file contained embedded NULL characters, which were
                removed.

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

      DtEDITOR_NONEXISTENT_FILE
                The file does not exist.

      DtEDITOR_DIRECTORY
                The file is a directory.

      DtEDITOR_CHAR_SPECIAL_FILE
                The file is a character-special device.





                                    - 1 -       Formatted:  January 24, 2005






 DtEditorInsertFromFile(library call)   DtEditorInsertFromFile(library call)




      DtEDITOR_BLOCK_MODE_FILE
                The file is a block-mode device.

      DtEDITOR_NO_FILE_ACCESS
                The file cannot be accessed.

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

      DtEDITOR_UNREADABLE_FILE
                The file is unreadable for an unspecified reason.

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

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


                                    - 2 -       Formatted:  January 24, 2005