DtEditorInsert man page on HP-UX

Man page or keyword search:  
man Server   10987 pages
apropos Keyword Search (all sections)
Output format
HP-UX logo
[printable version]

DtEditorInsert(library call)			  DtEditorInsert(library call)

NAME
       DtEditorInsert — insert data into a DtEditor widget

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

DESCRIPTION
       The  DtEditorInsert  function  inserts  either a string, wide character
       string or sized buffer at the insertion cursor position in  a  DtEditor
       widget.	 The data is transferred to the DtEditor widget using a DtEdi‐
       torContentRec, which indicates the type of data being transferred along
       with the actual data.  After the data is appended, the insertion cursor
       is positioned after the last character inserted.

       The widget argument specifies the DtEditor widget ID.

       The data argument is a pointer to a data structure containing the  data
       to insert.

       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 - DtE‐
       ditor(5).

RETURN VALUE
       Upon  successful completion, the DtEditorInsert function returns one of
       the following values:

       DtEDITOR_NO_ERRORS
		 The data was inserted sucessfully.

       DtEDITOR_NULLS_REMOVED
		 NULL characters were found and removed from the data.

       Otherwise, if the DtEditorInsert function cannot insert the  data  into
       the DtEditor widget, it returns one of the following values:

       DtEDITOR_INVALID_TYPE
		 The Type field is not recognized.

       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 insert 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		       *sampleString1="The brown fox",
			       *sampleString2=" quick";
       cr.type = DtEDITOR_TEXT;
       cr.value.string = sampleString1;
       status = DtEditorSetContents(editor, &cr);
       if (status != DtEDITOR_NO_ERRORS && status != DtEDITOR_NULLS_REMOVED) {
	       printf("Unable to set contents of the widget\n");
       } else {
	 /*
	  * Move the insertion cursor so it is after the
	  * letter 'e' in "The".
	  */
	       DtEditorSetInsertionCursorPosition(editor, 2);
	       cr.type = DtEDITOR_TEXT;
	       cr.data.string = sampleString2;
	       status = DtEditorInsert(editor, &cr);
	       if (status != DtEDITOR_NO_ERRORS)
		 printf("Unable to insert into the contents of the widget\n");
       }

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

SEE ALSO
       Dt/Editor.h  - DtEditor(5), DtEditor(3), DtEditorAppend(3), DtEditorAp‐
       pendFromFile(3),	  DtEditorGetContents(3),   DtEditorInsertFromFile(3),
       DtEditorReplace(3),     DtEditorReplaceFromFile(3),    DtEditorSaveCon‐
       tentsToFile(3),	  DtEditorSetContents(3),    DtEditorGetInsertionPosi‐
       tion(3),	   DtEditorSetInsertionPosition(3),   DtEditorSetContentsFrom‐
       File(3).

						  DtEditorInsert(library call)
[top]

List of man pages available for HP-UX

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net