DtEditorSaveContentsToFile 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]

DtEditorSaveContentsToFile(library calDtEditorSaveContentsToFile(library call)

       DtEditorSaveContentsToFile  — save the contents of a DtEditor widget to
       a file

       #include <Dt/Editor.h>
       DtEditorErrorCode DtEditorSaveContentsToFile(
       Widget widget,
       char *fileName,
       Boolean overwriteIfExists,
       Boolean hardCarriageReturns,
       Boolean markContentsAsSaved);

       The DtEditorSaveContentsToFile function saves the  entire  contents  of
       the  DtEditor  widget  to  a file, optionally replacing soft line feeds
       (word wraps) with <newline>s. If the file does not exist and the direc‐
       tory  has  the  correct write permissions, the file is created.	If the
       file exists and the overwriteIfExists argument is set to True, the con‐
       tents  of  the file are overwritten.  If the file or its directory does
       not have the correct write permissions, an error is returned.

       The DtEditor widget tracks whether its contents have changed since they
       were  last  saved or retrieved.	If the markContentsAsSaved argument is
       set to False, a copy of the data is  saved  without  affecting  whether
       DtEditorCheckForUnsavedChanges(3)   reports   that  there  are  unsaved
       changes.	 This is useful if the application needs to save a copy of the
       contents to a temporary file.

       The widget argument specifies the DtEditor widget ID.

       The fileName argument is the pathname of the file relative to the local

       The overwriteIfExists argument, if set to True, causes DtEditorSaveCon‐
       tentsToFile  to save the widget contents even though the file specified
       by the fileName argument exists and has correct write permissions.   If
       this argument is set to False, DtEditorSaveContentsToFile returns DtED‐

       The hardCarriageReturns argument, if set to True,  indicates  that  the
       widget  should replace any soft line feeds (word wraps) with <newline>s
       when saving the data.  When this argument is set	 to  False,  any  line
       wrapped	because	 it  reaches the right edge of the window, is saved as
       one complete line.

       The markContentsAsSaved argument, when set to True, causes the DtEditor
       widget  to  mark	 that  all changes made to date have been saved.  When
       this argument is set to False, the DtEditor widget does not change  its
       status  regarding unsaved changes.  If an error arises during the save,
       the status does not change, regardless of the  value  of	 the  markCon‐
       tentsAsSaved argument.

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

       Upon successful	completion,  the  DtEditorSaveContentsToFile  function
       returns	DtEDITOR_NO_ERRORS;  otherwise,	 if it cannot save the data to
       the file, the function returns one of the following values:

		 No file was specified.

		 The application does not have write permission for  the  file
		 or directory.

		 The file is a device-special file.

		 The file is a block-mode device.

		 The file cannot be accessed.

		 The contents could not be saved for an unspecified reason.

		 The  named  files exist and the overwriteIfExists argument is
		 set to False.

       The following code segment saves the contents of a DtEditor  widget  to
       the  local  file, Foo, substituting <newline>s for soft line feeds.  It
       also indicates that all changes to the contents of the widget have been

       Widget		       editor;
       DtEditorErrorCode       status;
       char		       *fname = "Foo";
       Boolean		       overwrite = False,
			       hardReturns = True,
			       markContentsAsSaved = True;
       status = DtEditorSaveContentsToFile(editor, fname, overwrite,
					   hardReturns, markContentsAsSaved);
	       case DtEDITOR_NO_ERRORS:
		       printf("Save failed.  The file already exists.\n");
		       printf("Could not save contents.\n");

       The  application should use DtEditorGetContents(3) to retrieve the data
       in a memory buffer, rather than a disk file.

       Dt/Editor.h - DtEditor(5), DtEditor(3), DtEditorAppend(3),  DtEditorAp‐
       pendFromFile(3),	  DtEditorCheckForUnsavedChanges(3),   DtEditorGetCon‐
       tents(3),  DtEditorInsert(3),  DtEditorInsertFromFile(3),   DtEditorRe‐
       place(3),  DtEditorReplaceFromFile(3),  DtEditorSetContentsFromFile(3),

				      DtEditorSaveContentsToFile(library call)

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]
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