Category Windchill servers, Object ProServer

Function ProServerWorkspaceDelete


Description
Deletes a workspace.
Replacement in Object TOOLKIT: pfcServerLocation::DeleteWorkspace
Synopsis
#include <ProWTUtils.h>
ProErrorProServerWorkspaceDelete(
wchar_t* server
/* (In)
The server on which the workspace to be deleted exists. Pass NULL to use the active server. This can be a alias or a server URL. Note: To delete any non-active WS: just delete it with this API. To delete a currently active WS:
  • set the other workspace as active and delete the first workspace or
  • unregister the primary server and delete the workspace using the server URL instead of alias
*/
wchar_t* ws_name
/* (In)
The workspace name.
*/
ProServerDeleteConflicts* conflicts
/* (Out)
The workspace could not be deleted. NULL if the error return != PRO_TK_CHECKOUT_CONFLICT. Pass NULL if not interested in conflicts details.
*/
)
Returns
PRO_TK_NO_ERRORThe function succeeded.
PRO_TK_BAD_INPUTSOne or more inputs was invalid.
PRO_TK_E_NOT_FOUNDThe server is not registered.
PRO_TK_INVALID_DIRThe workspace does not exist.
PRO_TK_CHECKOUT_CONFLICTThe workspace cannot be deleted due to checked out objects in its contents.
PRO_TK_E_IN_USEThe workspace is active

Manual References:

  1. Data Management: Windchill Operations: Creating and Modifying the Workspace
  2. Data Management: Windchill Operations: Conflicts During Server Operations
  3. Data Management: Windchill Operations: Sample Batch Workflow