dteditorsetcontentsfromfile(3) [hpux man page]

DtEditorSetContentsFromFile(library call)								 DtEditorSetContentsFromFile(library call)

NAME

       DtEditorSetContentsFromFile -- load data from a file into a DtEditor widget

SYNOPSIS

       #include <Dt/Editor.h>
       DtEditorErrorCode DtEditorSetContentsFromFile(
       Widget widget,
       char *fileName);

DESCRIPTION

       The DtEditorSetContentsFromFile function loads the contents of a file into a DtEditor widget.  Any data currently in the DtEditor widget is
       lost.  After the data is loaded, the insertion cursor is positioned at the first character.

       The widget argument specifies the DtEditor widget ID.

       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 DtEditorSetContentsFromFile function returns one of the following values when  it  successfully	loads  the
       data into the DtEditor widget:

       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 load the data into the DtEditor widget, the function returns one of the following values:

       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 load the file.

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

SEE ALSO

       Dt/Editor.h  -  DtEditor(5),  DtEditor(3),  DtEditorAppend(3), DtEditorAppendFromFile(3), DtEditorGetContents(3), DtEditorInsert(3), DtEdi-
       torInsertFromFile(3), DtEditorReplace(3), DtEditorReplaceFromFile(3), DtEditorSaveContentsToFile(3), DtEditorSetContents(3).

													 DtEditorSetContentsFromFile(library call)

DtEditorSetContents(library call)										 DtEditorSetContents(library call)

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

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
");

APPLICATION USAGE

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

SEE ALSO

       Dt/Editor.h - DtEditor(5), DtEditor(3), DtEditorAppend(3),  DtEditorAppendFromFile(3),  DtEditorGetContents(3),	DtEditorInsert(3),  DtEdi-
       torInsertFromFile(3), DtEditorReplace(3), DtEditorReplaceFromFile(3), DtEditorSaveContentsToFile(3), DtEditorSetContentsFromFile(3).

														 DtEditorSetContents(library call)