CDE/cde/doc/C/guides/man/man4/Save.sgm

<!-- $XConsortium: Save.sgm /main/5 1996/08/30 14:57:38 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->

<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN305.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN305.rsml.1">]]>
<RefMeta>
<RefEntryTitle>Save</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Symbol Role="Message">Save</Symbol></RefName>
<RefPurpose>save any modifications to an entity
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: Save.sgm /main/5 1996/08/30 14:57:38 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<Synopsis>[<Symbol Role="Variable">file</Symbol>] Save(in <Emphasis>type ID</Emphasis>);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Symbol Role="Message">Save</Symbol> notice
asks that any pending, unsaved modifications to a
persistent entity (such as a file) be saved.
</Para>
<Para>The
<Emphasis>ID</Emphasis> argument is the identity of the entity to save.
When its
<Symbol Role="Variable">type</Symbol> is
<Literal>File</Literal>, then the
<Emphasis>ID</Emphasis> argument is unset (in other words, has a
value of
<Literal>(char *)0</Literal>), and it refers to the file or directory
named in the message's file attribute.
</Para>
</RefSect1>
<RefSect1>
<Title>ERRORS</Title>
<Para>The ToolTalk service may return one of the following errors
in processing the
<Symbol Role="Message">Save</Symbol> notice:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_DESKTOP_UNMODIFIED</Term>
<ListItem>
<Para>The entity had no pending, unsaved modifications.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_DESKTOP_ENOENT</Term>
<ListItem>
<Para>The file to save/revert does not exist.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.ttdt.file.join;, function can be used to register for,
and help process, the
<Symbol Role="Message">Save</Symbol> request.
</Para>
<Para>The
<Symbol Role="Message">Save</Symbol> request can be sent with
&cdeman.ttdt.file.request;. Also,
&cdeman.ttdt.Save;, can send the relevant message and block on the reply.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.ttdt.Save;, &cdeman.ttdt.file.join;, &cdeman.ttdt.file.request;; <Symbol Role="Message">Revert</Symbol> notice.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->