DtWsmSetCurrentWorkspace(3)

NAME

DtWsmSetCurrentWorkspace − set the current workspace

SYNOPSIS

#include <Dt/Wsm.h>
Status DtWsmSetCurrentWorkspace(Widget widget,
Atom aWorkspace);

DESCRIPTION

The DtWsmSetCurrentWorkspace() function works with the CDE workspace manager, dtwm(1), and sets the current workspace. Applications can use this function to switch from the current workspace to another workspace.

The widget argument is a realized widget on the screen of interest.

The aWorkspace argument is the name (in X atom form) of the workspace to be made current.

RETURN VALUE

Upon successful completion, the DtWsmSetCurrentWorkspace() function returns Success; otherwise, it returns a value not equal to Success.

APPLICATION USAGE

If the DtWsmSetCurrentWorkspace() function is not successful, the most likely reason for failure is that the CDE workspace manager, dtwm(1), is not running. The DtWsmSetCurrentWorkspace() function requires a widget. A gadget is not acceptable for the widget argument.

DtWsmSetCurrentWorkspace() sends a message to the CDE workspace manager, dtwm(1), to switch workspaces. If the workspace name is not valid, no action is taken and the workspace manager reports no error.

Museum