<!-- $XConsortium: SessionS.sgm /main/5 1996/08/30 13:12:37 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.XCSA.MAN52.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN52.rsml.1">]]>
<RefMeta>
<RefEntryTitle>DtSessionSavePath</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>DtSessionSavePath</Function></RefName>
<RefPurpose>get a pathname for saving application state information
</RefPurpose>
</RefNameDiv>
<!-- 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>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Dt/Session.h>
</FuncSynopsisInfo>
<FuncDef>Boolean <Function>DtSessionSavePath</Function></FuncDef>
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
<ParamDef>char **<Parameter>savePath</Parameter></ParamDef>
<ParamDef>char **<Parameter>saveFile</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>DtSessionSavePath</Function> function returns the pathname to be used by an application for
saving its state information.
The information is later used by the
application to restore its state.
</Para>
<Para>The
<Symbol Role="Variable">widget</Symbol> argument is
the application's top level widget.
The
<Emphasis>savePath</Emphasis> argument is the address of the character string to receive
the pathname of the state information file to be used by
the application for storing its state.
The
<Emphasis>saveFile</Emphasis> argument is the address of the character string to receive
the filename of the file to be used by the application for
storing its state.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>DtSessionSavePath</Function> function returns True;
otherwise, it returns False.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The application should add
<Literal>-session</Literal> <Emphasis>saveFile</Emphasis> when it updates its
<SystemItem Class="Constant">WM_COMMAND</SystemItem> property.
</Para>
<Para>The application must use
<Function>XtFree</Function>(3) to free data returned in *<Emphasis>savePath</Emphasis> and *<Emphasis>saveFile</Emphasis>.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Dt.Session.h;, &cdeman.DtSessionRestorePath;; <![ %CDE.C.CDE; [<Function>XtFree</Function>(3). ]]><![ %CDE.C.XO; [<Function>XtFree</Function>(3) in the &str-Zt;;
&str-Zi;.
]]></Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
