Index Click this button to go to the index for this section.


DtEditorInsertFromFile(3)

CDE

NAME

DtEditorInsertFromFile - insert data from a file into a DtEditor widget

SYNOPSIS

#include <Dt/Editor.h> DtEditorErrorCode DtEditorInsertFromFile(Widget widget, char *fileName)

DESCRIPTION

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 DtEditor3.

RETURN VALUE

Upon successful completion, the DtEditorInsertFromFile function returns one of the following values: The file is readable and writable. The file is read only. 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: The file does not exist. The file is a directory. The file is a character-special device. The file is a block-mode device. The file cannot be accessed. Not enough system memory is available to insert the file. The file is unreadable for an unspecified reason.

APPLICATION USAGE

If the data is in memory, rather than a disk file, the application should use DtEditorInsert3.

SEE ALSO

Dt/Editor.h5, DtEditor3, DtEditorAppend3, DtEditorAppendFromFile3, DtEditorGetContents3, DtEditorInsert3, DtEditorReplace3, DtEditorReplaceFromFile3, DtEditorSaveContentsToFile3, DtEditorSetContents3, DtEditorGetInsertionPosition3, DtEditorSetInsertionPosition3, DtEditorSetContentsFromFile3.