DtEditorSetContents(3)

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

          For a complete definition of DtEditorContentRec, see
          <Dt/Editor>.

     RETURN VALUE
          Upon successful completion, the DtEditorSetContents()
          function returns one of the following values:

             DtEDITOR_NO_ERRORS
                   The data was loaded sucessfully.

             DtEDITOR_NULLS_REMOVED
                   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:

             DtEDITOR_INVALID_TYPE
                   The Type field is unrecognized.

             DtEDITOR_ILLEGAL_SIZE
                   The size of the buffer passed in is negative.

             DtEDITOR_NULL_ITEM
                   The buffer is NULL.
             DtEDITOR_INSUFFICIENT_MEMORY
                   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 DtEditorSetContentsFromFile(3).

     SEE ALSO
          DtEditor(5), DtEditor(3), DtEditorAppend(3),
          DtEditorAppendFromFile(3), DtEditorGetContents(3),
          DtEditorInsert(3), DtEditorInsertFromFile(3),
          DtEditorReplace(3), DtEditorReplaceFromFile(3),
          DtEditorSaveContentsToFile(3),
          DtEditorSetContentsFromFile(3).