DtEditorReplaceFromFile(library call) DtEditorReplaceFromFile(library call)
NAME [Toc] [Back]
DtEditorReplaceFromFile - replace a portion of the contents of a
DtEditor widget with the contents of a file
SYNOPSIS [Toc] [Back]
DESCRIPTION [Toc] [Back]
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
For a complete definition of the DtEditor widget and its associated
resources, see DtEditor(3).
RETURN VALUE [Toc] [Back]
Upon successful completion, the DtEditorReplaceFromFile 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
- 1 - Formatted: January 24, 2005
DtEditorReplaceFromFile(library call) DtEditorReplaceFromFile(library call) [Toc] [Back]
Otherwise, if it cannot insert the data into the DtEditor widget, the
function returns one of the following values:
The startPos argument is greater than the endPos argument.
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 replace the data.
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 DtEditorReplace(3).
SEE ALSO [Toc] [Back]
Dt/Editor.h - DtEditor(5), DtEditor(3), DtEditorAppend(3),
DtEditorAppendFromFile(3), DtEditorGetContents(3), DtEditorInsert(3),
- 2 - Formatted: January 24, 2005 [ Back ]