<!-- $XConsortium: GetCurWs.sgm /main/7 1996/09/23 14:36:27 cdedoc $ -->
<!-- (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.MAN63.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN63.rsml.1">]]>
<RefMeta>
<RefEntryTitle>DtWsmGetCurrentWorkspace</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>DtWsmGetCurrentWorkspace</Function></RefName>
<RefPurpose>get the current workspace
</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/Wsm.h>
</FuncSynopsisInfo>
<FuncDef>int <Function>DtWsmGetCurrentWorkspace</Function></FuncDef>
<ParamDef>Display *<Parameter>display</Parameter></ParamDef>
<ParamDef>Window <Parameter>root</Parameter></ParamDef>
<ParamDef>Atom *<Parameter>paWorkspace</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>DtWsmGetCurrentWorkspace</Function> function works with the
<![ %CDE.C.XO; [workspace manager
]]><![ %CDE.C.CDE; [&str-XZ;
workspace manager,
&cdeman.dtwm;, ]]>and returns the name of the current workspace
(converted to an X atom).
</Para>
<Para>The
<Symbol Role="Variable">display</Symbol> argument is the X display.
</Para>
<Para>The
<Symbol Role="Variable">root</Symbol> argument is the root window of the screen of interest.
</Para>
<Para>The
<Emphasis>paWorkspace</Emphasis> argument is the address of an atom to receive the
current workspace identifier.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>DtWsmGetCurrentWorkspace</Function> function returns Success and the atom
identifying the current workspace is returned in
<Emphasis>paWorkspace</Emphasis>; otherwise,
it returns a value not equal to Success.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>If the
<Function>DtWsmGetCurrentWorkspace</Function> function is not successful, the most likely reason for failure is that the
<![ %CDE.C.XO; [workspace manager
]]><![ %CDE.C.CDE; [&str-XZ;
workspace manager,
&cdeman.dtwm;, ]]>is not running.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para><![ %CDE.C.CDE; [&cdeman.dtwm;, ]]>&cdeman.Dt.Wsm.h;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
