<!-- $XConsortium: SetCurWs.sgm /main/6 1996/09/23 14:36:38 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.MAN70.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN70.rsml.1">]]>
<RefMeta>
<RefEntryTitle>DtWsmSetCurrentWorkspace</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>DtWsmSetCurrentWorkspace</Function></RefName>
<RefPurpose>set 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>DtWsmSetCurrentWorkspace</Function></FuncDef>
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
<ParamDef>Atom <Parameter>aWorkspace</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>DtWsmSetCurrentWorkspace</Function> function works with the
<![ %CDE.C.XO; [workspace manager
]]><![ %CDE.C.CDE; [&str-XZ;
workspace manager,
&cdeman.dtwm;, ]]>and sets the current workspace.
Applications can use this function to switch from the current
workspace to another workspace.
</Para>
<Para>The
<Symbol Role="Variable">widget</Symbol> argument is a realized widget on the screen of interest.
</Para>
<Para>The
<Emphasis>aWorkspace</Emphasis> argument is the name (in X atom form) of the workspace
to be made current.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>DtWsmSetCurrentWorkspace</Function> function returns Success; otherwise, it returns a value not equal to Success.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>If the
<Function>DtWsmSetCurrentWorkspace</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.
The
<Function>DtWsmSetCurrentWorkspace</Function> function requires a
widget.
A gadget is not acceptable for the
<Symbol Role="Variable">widget</Symbol> argument.
</Para>
<Para><Function>DtWsmSetCurrentWorkspace</Function> sends a message to the
<![ %CDE.C.XO; [workspace manager
]]><![ %CDE.C.CDE; [&str-XZ;
workspace manager,
&cdeman.dtwm;, ]]>to switch workspaces.
If the workspace name is not valid, no action is taken and the workspace
manager reports no error.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Dt.Wsm.h;, <![ %CDE.C.CDE; [&cdeman.dtwm;, ]]>&cdeman.DtWsmGetCurrentWorkspace;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
