DtEditorReplaceFromFile(library call)

NAME
DtEditorReplaceFromFile — replace a portion of the contents of a DtEditor widget with the contents of a file

SYNOPSIS

#include &<Dt/Editor.h>
DtEditorErrorCode DtEditorReplaceFromFile(
Widget widget,
XmTextPosition startPos,
XmTextPosition endPos,
char *fileName);

DESCRIPTION

The DtEditorReplaceFromFile function replaces part of the contents of a DtEditor widget with the contents of a file. All data following the start position and up to, but not including, the end position is replaced. If the start position and the end position are equal, the data is inserted after the end position. The character positions begin at zero and are numbered sequentially from the beginning of the text. After the replacement, the insertion cursor is positioned after the last character inserted.

The widget argument specifies the DtEditor widget ID.

The startPos argument specifies the starting character position of the portion to replace. The replacement begins at this character.

The endPos argument specifies the ending character position of the portion to replace. The replacement ends before this character.

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

Upon successful completion, the DtEditorReplaceFromFile 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, the function returns one of the following values:

DtEDITOR_INVALID_RANGE
    The startPos argument is greater than the endPos argument.

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.

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 replace the data.

DtEDITOR_UNREADABLE_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 DtEditorReplace(3).

SEE ALSO

Dt/Editor.h - DtEditor(5), DtEditor(3), DtEditorAppend(3), DtEditorAppendFromFile(3), DtEditorGetContents(3), DtEditorInsert(3), DtEditorInsertFromFile(3), DtEditorReplace(3), DtEditorSaveContentsToFile(3), DtEditorSetContents(3), DtEditorSetContentsFromFile(3).