CIP C++ documentation for class "pfcServerLocation"

Class pfcServerLocation

# include <pfcServer.h> class pfcServerLocation : public virtual pfcChild { xaideclare(pfcServerLocation) ... };

Description

This class describes server location.

Direct Known Subclasses:: pfcNonRegisteredServer, pfcServer

Method Summary


`pfcWorkspaceDefinitions_ptr`	`CollectWorkspaces ()`
	This method is enabled for Creo Direct. Gets the list of the workspaces .

`void`	`DeleteWorkspace (xrstring WorkspaceName)`
	This method is enabled for Creo Direct. Deletes a workspace.

`xstring`	`GetClass ()`
	This method is enabled for Creo Direct. Specifies the class of the server . The values of the server class are "Windchill" and "ProjectLink." "Windchill" denotes either a Windchill Classic PDM or a Windchill PDMLink server, while "ProjectLink" denotes Windchill ProjectLink type of servers.

`xstring`	`GetLocation ()`
	This method is enabled for Creo Direct. Specifies the codebase URL .

`xstring`	`GetVersion ()`
	This method is enabled for Creo Direct. Specifies the version of Windchill that is configured on the server, for example, "7.0" or "8.0."

`xstringsequence_ptr`	`ListContexts ()`
	This method is enabled for Creo Direct. Gets the list of the contexts

Methods Inherited from Class pfcChild:: GetDBParent, GetOId

Method Detail

xstring GetLocation ()

This method is enabled for Creo Direct.

Specifies the codebase URL .

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The server was not registered.

Manual References:: Windchill Connectivity APIs: Accessing Information Before Registering a Server, Windchill Connectivity APIs: Accessing Information Before Registering a Server

xstring GetVersion ()

This method is enabled for Creo Direct.

Specifies the version of Windchill that is configured on the server, for example, "7.0" or "8.0."

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The server couldn't be found at the given location.

pfcXToolkitUnsupported - The server is not a Windchill server

Manual References:: Windchill Connectivity APIs: Accessing Information Before Registering a Server, Windchill Connectivity APIs: Accessing Information Before Registering a Server

xstring GetClass ()

This method is enabled for Creo Direct.

Specifies the class of the server . The values of the server class are "Windchill" and "ProjectLink." "Windchill" denotes either a Windchill Classic PDM or a Windchill PDMLink server, while "ProjectLink" denotes Windchill ProjectLink type of servers.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The server couldn't be found at the given location.

Manual References:: Windchill Connectivity APIs: Accessing Information Before Registering a Server, Windchill Connectivity APIs: Accessing Information Before Registering a Server

pfcWorkspaceDefinitions_ptr CollectWorkspaces ()

This method is enabled for Creo Direct.

Gets the list of the workspaces .

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - This means either:

No context was found (the server was from WC 6.2.6), OR
The server was not registered or couldn't be found at the given location.

pfcXToolkitEmpty - The server does not have any workspaces

pfcXToolkitCantAccess - Server communication error, or user lacks permission to view workspaces on this server.

pfcXToolkitInvalidType - The server version is not supported

Manual References:: Windchill Connectivity APIs: Accessing Information Before Registering a Server, Windchill Connectivity APIs: Accessing Workspaces, Windchill Connectivity APIs: To Register a Server with an Existing Workspace

Returns:: Sequence of pfcWorkspaceDefinitions objects

void DeleteWorkspace (xrstring WorkspaceName)

This method is enabled for Creo Direct.

Deletes a workspace.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The server is not registered.

pfcXToolkitInvalidDir - The workspace does not exist.

pfcXToolkitCheckoutConflict - The workspace cannot be deleted due to checked out objects in its contents.

pfcXToolkitInUse - The workspace is active

See Also:: pfcXToolkitCheckoutConflict

Manual References:: Windchill Connectivity APIs: Creating and Modifying the Workspace, Windchill Connectivity APIs: Conflicts During Server Operations

Parameters:

WorkspaceName: The workspace name.

Returns:

xstringsequence_ptr ListContexts ()

This method is enabled for Creo Direct.

Gets the list of the contexts

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The server was not registered or couldn't be found at the given location.

pfcXToolkitEmpty - The server does not have any contexts.

pfcXToolkitCantAccess - Server communication error, or user lacks permission to view workspaces on this server.

pfcXToolkitInvalidType - The server version is not supported

Manual References:: Windchill Connectivity APIs: Accessing Information Before Registering a Server, Windchill Connectivity APIs: Accessing Information Before Registering a Server, Windchill Connectivity APIs: To Register a Server with a New Workspace

Returns:: Sequence of context strings