Index for Section 3

Alphabetical listing for D

DtEditorSetContents(3)
CDE


NAME
  DtEditorSetContents - place data into a DtEditor widget

SYNOPSIS
  #include <Dt/Editor.h>
  DtEditorErrorCode DtEditorSetContents(Widget widget,
					DtEditorContentRec *data);

DESCRIPTION
  The DtEditorSetContents function places a NULL-terminated string, wide
  character string or sized buffer into a DtEditor widget.  Any data
  currently in the DtEditor widget is lost.  The data is transferred to the
  DtEditor widget using a DtEditorContentRec, which indicates the type of
  data being transferred along with the actual data.  After the data is
  placed into the DtEditor widget, the insertion cursor is positioned at the
  first character.

  The widget argument specifies the DtEditor widget ID.

  The data argument is a pointer to a data structure containing the new
  contents of widget.

  For a complete definition of the DtEditor widget and its associated
  resources, see DtEditor3.

  For a complete definition of DtEditorContentRec, see Dt/Editor5.

RETURN VALUE
  Upon successful completion, the DtEditorSetContents function returns
  DtEDITOR_NO_ERRORS; otherwise, it returns one of the following values: Upon
  successful completion, the DtEditorSetContents function returns one of the
  following values:
  The data was loaded sucessfully.
  NULL characters were found and removed from the data.

  Otherwise, if the DtEditorSetContents function cannot load the data in the
  DtEditor widget, it returns one of the following values:
  The Type field is unrecognized.
  The size of the buffer passed in is negative.
  The buffer is NULL.
  Not enough system memory is available to load the data.

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


       Widget		       editor;
       DtEditorContentRec      cr;
       DtEditorErrorCode       status;
       char		       *sampleString="The quick brown fox";
       cr.type = DtEDITOR_TEXT;
       cr.value.string = sampleString;
       status = DtEditorSetContents(editor, &cr);
       if (status != DtEDITOR_NO_ERRORS && status != DtEDITOR_NULLS_REMOVED) {
	       printf("Unable to set contents of the widget\n");

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

SEE ALSO
  Dt/Editor.h5, DtEditor3, DtEditorAppend3, DtEditorAppendFromFile3,
  DtEditorGetContents3, DtEditorInsert3, DtEditorInsertFromFile3,
  DtEditorReplace3, DtEditorReplaceFromFile3, DtEditorSaveContentsToFile3,
  DtEditorSetContentsFromFile3.