<!-- $XConsortium: AddWs.sgm /main/2 1996/09/19 13:37:32 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="CDE.WSM.addworkspace">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.WSM.addworkspace">]]>

<RefMeta>
<RefEntryTitle>DtWsmAddWorkspace</RefEntryTitle>
<ManVolNum>API</ManVolNum>
</RefMeta>

<RefNameDiv>
<RefName><Function>DtWsmAddWorkspace</Function></RefName>
<RefPurpose>add a workspace
</RefPurpose>
</RefNameDiv>

<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Dt/Wsm.h>
</FuncSynopsisInfo>
<FuncDef>int <Function>DtWsmAddWorkspace</Function></FuncDef>
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
<ParamDef>char <Parameter>*title</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>

<RefSect1>
<Title>DESCRIPTION</Title>

<Para>The <Function>DtWsmAddWorkspace()</Function>
function works with the CDE workspace manager, <command>dtwm(1)</command>, and adds a
new workspace. Applications can use this function to implement an interface to the workspace
manager.
</Para>
<Para>
If the <Function>DtWsmAddWorkspace()</Function> function is not successful, the most likely reason for failure is that the
CDE workspace manager, <command>dtwm(1)</command>, is not running.
</Para>
<Para>
<Function>DtWsmAddWorkspace()</Function> sends a message to the CDE workspace manager, <command>dtwm(1)</command>, to add the
workspace.
</Para>
</RefSect1>

<refsect1>
<Title>ARGUMENTS</Title>
<VariableList>
<VarListEntry>
<Term><symbol role="Variable">widget</symbol></Term>
<ListItem>
<Para>
a realized widget
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><symbol role="Variable">title</symbol></Term>
<ListItem>
<Para>
a user visible title for the new workspace
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>

<RefSect1>
<Title>RETURN VALUE</Title>
<Para>
The function returns Success (0) when it succeeds, and non-zero upon failure.
</Para>
</RefSect1>

<RefSect1>
<Title>SEE ALSO</Title>
<para>
<literal>DtWsm(5)</literal>
</para>
<para>
"Communicating with the Workspace Manager" section in the <citetitle>CDE Programmer's Guide</citetitle>
</para>
<para>
"Workspace Manager" section in the <citetitle>CDE Programmer's Overview</citetitle>
</para>
</RefSect1>

</RefEntry>
