CDE/cde/doc/C/guides/man/m3_Dt/SessionR.sgm

<!-- $XConsortium: SessionR.sgm /main/5 1996/08/30 13:12:25 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.MAN51.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN51.rsml.1">]]>
<RefMeta>
<RefEntryTitle>DtSessionRestorePath</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>DtSessionRestorePath</Function></RefName>
<RefPurpose>get a pathname for the application's state information file
</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>DtSessionRestorePath</Function></FuncDef>
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
<ParamDef>char **<Parameter>restorePath</Parameter></ParamDef>
<ParamDef>char *<Parameter>restoreFile</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>DtSessionRestorePath</Function> function returns a pathname to an
application's state information.
</Para>
<Para>The
<Symbol Role="Variable">widget</Symbol> argument is
the application's top level widget.
The
<Emphasis>restorePath</Emphasis> argument is the address of the character string to receive
the pathname of the application's state information file.
The
<Emphasis>restoreFile</Emphasis> argument is the filename of the file containing the application
state information.
This is the filename specified with the
<Literal>&minus;session</Literal> option at application invocation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>DtSessionRestorePath</Function> function returns True;
otherwise, it returns False.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The application must support the
<Literal>&minus;session</Literal> command-line option.
</Para>
<Para>The application must use
<Function>XtFree</Function>(3) to free data returned in *<Emphasis>restorePath</Emphasis>.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Dt.Session.h;, &cdeman.DtSessionSavePath;; <![ %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-->