DtEditorAppend(3) — Subroutines

NAME

DtEditorAppend − append data to a DtEditor widget

SYNOPSIS

#include <Dt/Editor.h>
DtEditorErrorCode DtEditorAppend(Widget widget,
DtEditorContentRec ∗data);

DESCRIPTION

The DtEditorAppend() function appends either a NULL-terminated string, wide character string or sized buffer after the last character in a DtEditor widget. The data is transfered to the DtEditor widget using a DtEditorContentRec, which indicates the type of data being transfered along with the actual data. After the data is appended, the insertion cursor is positioned at the new last character.

The widget argument specifies the DtEditor widget ID.

The data argument points to a data structure containing the data to append.

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

For a complete definition of DtEditorContentRec, see <DtEditor>.

RETURN VALUE

Upon successful completion, the DtEditorAppend() function returns DtEDITOR_NO_ERRORS; otherwise, if type is unrecognized, the function returns DtEDITOR_INVALID_TYPE. If the size of the buffer passed in is negative, DtEDITOR_ILLEGAL_SIZE is returned.

EXAMPLES

The following code segment sets the contents of a DtEditor widget to "The quick brown fox."

Widgeteditor;
DtEditorContentReccr;
DtEditorErrorCodestatus;
char∗sampleString1="The quick",
∗secondString2=" brown fox";
cr.type = DtEDITOR_TEXT;
cr.value.string = sampleString1;
status = DtEditorSetContents ( editor, &cr );
if (status != DtEDITOR_NO_ERRORS) {
printf("Unable to set the contents of the widget\n");
}
else {
cr.type = DtEDITOR_TEXT;
cr.value.string = sampleString2;
status = DtEditorAppend ( editor, &cr );
if (status != DtEDITOR_NO_ERRORS)
printf("Unable to append to the contents of the widget\n");
}

APPLICATION USAGE

If the data is in a disk file, rather than in memory, the application should use DtEditorAppendFromFile(3).

Museum

Related Articles