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

<!-- $XConsortium: SaverGet.sgm /main/5 1996/08/30 13:12:14 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.MAN50.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN50.rsml.1">]]>
<RefMeta>
<RefEntryTitle>DtSaverGetWindows</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>DtSaverGetWindows</Function></RefName>
<RefPurpose>get the list of windows for drawing by a screen saver application
</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/Saver.h>
</FuncSynopsisInfo>
<FuncDef>Boolean <Function>DtSaverGetWindows</Function></FuncDef>
<ParamDef>Display *<Parameter>display</Parameter></ParamDef>
<ParamDef>Window **<Parameter>window</Parameter></ParamDef>
<ParamDef>int *<Parameter>count</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>DtSaverGetWindows</Function> function returns a list of windows on which a screen saver
application should draw when invoked by &str-XZ;.
</Para>
<Para>The
<Symbol Role="Variable">display</Symbol> argument is the X display.
The
<Symbol Role="Variable">window</Symbol> argument is the address of
a pointer to receive the pointer to a list of windows.
The
<Symbol Role="Variable">count</Symbol> argument is the address of an integer to receive the
number of elements in the list of windows returned in
<Symbol Role="Variable">window</Symbol>.</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>DtSaverGetWindows</Function> function returns True;
otherwise, it returns False.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>If the
<Function>DtSaverGetWindows</Function> function is not successful, failure may be due to a memory
allocation error or that the screen
saver application was not invoked from &str-XZ;.
</Para>
<Para>The application must use
<Function>XtFree</Function>(3) to free data returned in <Emphasis>*window</Emphasis>.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Dt.Saver.h;; <![ %CDE.C.CDE; [<Function>XtFree</Function>(3). ]]><![ %CDE.C.XO; [<Function>XtFree</Function>(3) in the &str-Zt;.
]]></Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->