CIP JAVA documentation for class "com.ptc.pfc.pfcSession.BaseSession"

Interface BaseSession

package com.ptc.pfc.pfcSession; public interface BaseSession extends com.ptc.pfc.pfcBase.ActionSource, com.ptc.pfc.pfcDisplay.Display, com.ptc.pfc.pfcObject.Parent

Description

This class defines the information about a Creo Parametric session.

Direct Known Subclasses:: Session, WBaseSession

Method Summary
`void`	`AllowDuplicateModelItems (boolean val)` Turns on/off the control of creating duplicate model items.
`void`	`AuthenticateBrowser (String Username, String Password)` Preset username and password to allow automatic login into HTTP servers that require authentication.
`void`	`ChangeDirectory (String Path)` Changes Creo Parametric to another working directory.
`void`	`CheckoutToWS (ModelDescriptors Objects, String WSName, boolean AsLink, RelCriterion RelCriterion)` Checks out a model from Pro/INTRALINK into the workspace.
`void`	`CopyFileFromWS (String SourceFile, String TargetDirectory)` Copies a file from a Windchill workspace to a disk location.
`void`	`CopyFileToWS (String SourceFile, String TargetWorkspace, /optional/ String PrimaryContent)` Copies a file from local disk to a Windchill workspace; either as a primary document or as secondary content of an existing document in the workspace.
`Assembly`	`CreateAssembly (String Name)` Creates an empty assembly.
`Drawing`	`CreateDrawingFromTemplate (String Name, String Template, ModelDescriptor DrawingModel, DrawingCreateOptions Options)` Creates a drawing from a template.
`Window`	`CreateModelWindow (Model Mdl)` Creates or retrieves a window for a specified model.
`Part`	`CreatePart (String Name)` Creates a new empty part.
`void`	`EndSession ()`
`void`	`EraseUndisplayedModels ()` Erases models which are not used in any Creo Parametric windows.
`ModelCheckResults`	`ExecuteModelCheck (Model Model, /optional/ ModelCheckInstructions Instructions)` Execute ModelCheck from an external application.
`void`	`ExportCurrentRasterImage (String ImageFileName, RasterImageExportInstructions Instructions)` Outputs a standard Creo Parametric raster output file (for current Window).
`void`	`ExportDirectVRML (VRMLDirectExportInstructions ExportData)` Exports a Creo Parametric object from disk into VRML format.
`WSImportExportMessages`	`ExportFromCurrentWS (stringseq FileNames, String TargetLocation, RelCriterion Dependency)` Export specified objects from the current workspace to a disk in a linked session of Creo Parametric. Can be called only when there are no objects in session . The specified objects may be exported along with all or required by Creo Parametric dependents (recursively), according to a specified dependency criterion. All problems (warnings, conflicts or errors) of processing individual objects are logged in proimpex.errors file created in the Creo Parametric run directory.
`void`	`ExportProfileLoad (String ProfileFile)` Loads profile for export.
`void`	`FlushCurrentWindow ()` Forces the flush of pending display commands on the current window.
`/optional/ Model`	`GetActiveModel ()` Retrieves the handle to the active model.
`/optional/ Server`	`GetActiveServer ()` Gets the active server handle .
`String`	`GetAliasFromAliasedUrl (String AliasedUrl)` Returns server alias from aliased URL.
`/optional/ Model`	`GetByRelationId (int Id)` Returns the model, given its relation identifier.
`/optional/ String`	`GetConfigOption (String Name)` Retrieves the current value for the specified configuration file option.
`/optional/ stringseq`	`GetConfigOptionValues (String Name)` Retrieves the current value(s) for the specified configuration file option.
`String`	`GetConnectionId ()` Get method for attribute "ConnectionId" Returns the connection id for the Creo Parametric session that this application is connected to. The identification string can be passed to external asynchronous applications to allow them to connect to this Creo Parametric session.
`String`	`GetCurrentDirectory ()` Gets the absolute path name of the current working directory for Creo Parametric.
`/optional/ Model`	`GetCurrentModel ()` Get method for attribute "CurrentModel" The current Creo Parametric object, or `null`, if there is no current object
`/optional/ Window`	`GetCurrentWindow ()` Get method for attribute "CurrentWindow" The current Creo Parametric window
`/optional/ String`	`GetCurrentWS ()` Returns the name of the Workspace currently registered in Creo Parametric.
`DimDisplayMode`	`GetDimensionDisplayMode ()` Get method for attribute "DimensionDisplayMode" The current dimension display setting.
`/optional/ String`	`GetEnvironmentVariable (String Name)` Returns the value a system environment variable.
`ModelType`	`GetImportSourceType (String FileToImport, NewModelImportType NewModelType)` Returns the type of model that can be created from a 3D format file. Note: does not support all types of 3D formats.
`String`	`GetLocalizedMessageContents (String MsgFile, String Format, /optional/ stringseq MessageTexts)` Writes a text message to a buffer string.
`String`	`GetMessageContents (String MsgFile, String Format, /optional/ stringseq MessageTexts)` Writes a text message to a buffer string.
`/optional/ Model`	`GetModel (String Name, ModelType Type)` Finds a model in the Creo Parametric session, given the model name and type.
`/optional/ Model`	`GetModelFromDescr (ModelDescriptor MdlDescr)` Finds a model in the Creo Parametric session, given the model descriptor.
`/optional/ Model`	`GetModelFromFileName (String FileName)` Locates and returns a model handle given its file name.
`String`	`GetModelNameFromAliasedUrl (String AliasedUrl)` Returns model name from aliased URL.
`/optional/ Window`	`GetModelWindow (Model Mdl)` Returns the window where a Creo Parametric model is displayed.
`PrintMdlOption`	`GetPrintMdlOptions (Model model)` Get model options for a specified model.
`PrinterPCFOptions`	`GetPrintPCFOptions (String filename, Model model)` Get the print options from a specified PCF file.
`PrintPlacementOption`	`GetPrintPlacementOptions ()` Get the current print placement options.
`PrintPrinterOption`	`GetPrintPrinterOptions (String printer_type)` Get printer options for a specified printer.
`/optional/ Dll`	`GetProToolkitDll (String ApplicationId)` Finds a Creo Parametric TOOLKIT DLL, given its identifer string.
`ColorRGB`	`GetRGBFromStdColor (StdColor StdClr)` Retrieves the RGB values for the specified color.
`/optional/ Server`	`GetServerByAlias (String Alias)` Gets the server handle for a given server alias.
`/optional/ Server`	`GetServerByUrl (String Url, /optional/ String WorkspaceName)` Gets the server handle for a given server url and workspace name.
`ServerLocation`	`GetServerLocation (String Url)` Gets the server location handle for a given server url.
`String`	`GetUrlFromAliasedUrl (String AliasedUrl)` Converts an an aliased url (wtpub://alias/etc/p.prt) suitable for use in functions like ProMdlLoad to an unaliased URL (http://windchillserver.ptc.com/etc).
`/optional/ Window`	`GetWindow (int Id)` Retrieves the window object by its identifier.
`Model`	`Import2DModel (String NewModelName, ModelType Type, String FilePath, Import2DInstructions Instructions)` Creates a two-dimensional model from a geometry file.
`Model`	`ImportNewModel (String FileToImport, NewModelImportType NewModelType, ModelType Type, String NewModelName, /optional/ LayerImportFilter Filter)` Imports a 3D format file as a new model.
`WSImportExportMessages`	`ImportToCurrentWS (stringseq Filepaths, RelCriterion Dependency)` Import specified objects from a disk to the current workspace in a linked session of Creo Parametric. Can be called only when there are no objects in session . The specified objects may be imported along with all or required by Creo Parametric dependents (recursively), according to a specified dependency criterion. All problems (warnings, conflicts or errors) of processing individual objects are logged in proimpex.errors file created in the Creo Parametric run directory.
`boolean`	`IsConfigurationSupported (ExportType Type, AssemblyConfiguration Configuration)` Identifies if an assembly configuration is supported for a particular export type.
`boolean`	`IsGeometryRepSupported (ExportType Type, GeometryFlags Flags)` Identifies if a combination of geometry flags are supported for export to a certain format.
`stringseq`	`ListFiles (String Filter, FileListOpt Version, /optional/ String Path)` Returns a list of the files in the designated directory.
`Models`	`ListModels ()` Retrieves the list of objects in the Creo Parametric session.
`Models`	`ListModelsByType (ModelType Type)` Returns all of the models of a particular type in the Creo Parametric session.
`/optional/ Servers`	`ListServers ()` Sequence of servers , or `null` if server was not found
`stringseq`	`ListSubdirectories ( /optional/ String Path)` Lists the subdirectories in a given directory location.
`Windows`	`ListWindows ()` Lists all the Creo Parametric windows.
`void`	`LoadConfigFile (String ConfigFileName)` Reads a configuration file into Creo Parametric.
`Dll`	`LoadProToolkitDll (String ApplicationName, String DllPath, String TextPath, boolean UserDisplay)` Causes Creo Parametric to load a Creo Parametric TOOLKIT DLL application.
`Dll`	`LoadProToolkitLegacyDll (String ApplicationName, String DllPath, String TextPath, boolean UserDisplay)` Causes Creo Parametric to load a Creo Parametric TOOLKIT DLL non-Unicode application.
`Window`	`OpenFile (ModelDescriptor MdlDescr)` Retrieves the specified model and displays it in a window.
`String`	`PLMSInitialize (String request)`
`/optional/ Selections`	`QueryFeatureEdit ()` Find the list of features being displayed for modification, as is done in 'Edit' on a feature.
`void`	`RegisterCustomModelCheck (CustomCheckInstructions Instructions)` Registers an custom check that can be included in any ModelCheck execution.
`void`	`RegisterRelationFunction (String Name, RelationFunctionListener Listener, /optional/ RelationFunctionOptions Options)` Register an external function which can be included in relations.
`Server`	`RegisterServer (String Alias, String Location, String WorkspaceName)` Registers a server in the session given its root location and an alias.
`void`	`RegisterTask (String TaskId, JLinkTaskListener Listener)` Register a listener as a task usable by another Creo Parametric auxiliary application.
`Assembly`	`RetrieveAssemSimpRep (String AssemName, /optional/ SimpRepInstructions Instructions)` Retrieves the specified simplified representation.
`Part`	`RetrieveGeometryPartRep (String PartName)` Retrieves the specified part's geometric simplified representation.
`Assembly`	`RetrieveGeomSimpRep (String AssemName)` Retrieves the geometry simplified representation of an assembly.
`Part`	`RetrieveGraphicsPartRep (String PartName)` Retrieves the specified part's graphic simplified representation.
`Assembly`	`RetrieveGraphicsSimpRep (String AssemName)` Retrieves the graphics simplified representation of an assembly.
`Model`	`RetrieveModel (ModelDescriptor MdlDescr)` Retrieves the specified model into the Creo Parametric session from standard directory.
`Model`	`RetrieveModelWithOpts (ModelDescriptor MdlDescr, RetrieveModelOptions Opts)` Retrieves the specified model into the Creo Parametric session based on the path specified in the model descriptor.
`Part`	`RetrievePartSimpRep (String PartName, String RepName)` Retrieves the specified part's user-defined simplified representation.
`Part`	`RetrieveSymbolicPartRep (String PartName)` Retrieves the specified part's symbolic simplified representation.
`Assembly`	`RetrieveSymbolicSimpRep (String AssemName)` Retrieves the symbolic simplified representation of an assembly.
`void`	`RunMacro (String Macro)` Runs the specified macro.
`/optional/ Selections`	`Select (SelectionOptions Options, /optional/ Selections InitialSels)` Allows interactive selection of objects in Creo Parametric.
`void`	`SetConfigOption (String Name, String Value)` Sets the value of the specified configuration file option.
`void`	`SetCurrentWindow ( /optional/ Window value)` Set method for attribute "CurrentWindow" The current Creo Parametric window
`void`	`SetCurrentWS (String NewWSName)` Registers a Workspace in Creo Parametric. Only one is allowed at a time, so if one is already registered, the new one will substitute the current one, but only if there are no objects in session.
`void`	`SetDimensionDisplayMode (DimDisplayMode value)` Set method for attribute "DimensionDisplayMode" The current dimension display setting.
`StdLineStyle`	`SetLineStyle (StdLineStyle NewStyle)` Sets the line style.
`void`	`SetStdColorFromRGB (StdColor StdClr, ColorRGB Color)` Enables you to set the values of the three color components for a standard color in Creo Parametric.
`StdColor`	`SetTextColor (StdColor NewColor)` Enables you to change the text color so any subsequent graphics window text is drawn in the specified color.
`void`	`SetWSExportOptions (WSExportOptions Options)` Sets the option controlling whether or not to export secondary contents during a call to `BaseSession.ExportFromCurrentWS(stringseq, String, RelCriterion)`
`JLinkApplication`	`StartJLinkApplication (String ApplicationName, String ClassName, String StartMethod, String StopMethod, /optional/ String AdditionalClassPath, /optional/ String TextPath, boolean UserDisplay)` Register and start a synchronous J-Link application.
`void`	`UIRegisterFileOpen (FileOpenRegisterOptions Options, FileOpenRegisterListener Listener)` Register a file type in File Open Dialog.
`void`	`UIRegisterFileSave (FileSaveRegisterOptions Options, FileSaveRegisterListener Listener)` Register a file type in File 'Save a Copy' Dialog.
`void`	`UnregisterTask (String TaskId)` Unregister a listener as a task callable by another Creo Parametric auxiliary application.
`void`	`WLBInitialize (boolean val)`

Methods Inherited from Interface `com.ptc.pfc.pfcBase.ActionSource`
`AddActionListener`, `RemoveActionListener`, `AddActionListenerWithType`

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Parent`
`GetChild`

Methods Inherited from Interface `com.ptc.pfc.pfcDisplay.Display`
`CreateDisplayList2D`, `Invalidate`, `DrawArc2D`, `DrawPolygon2D`, `DrawText2D`, `CreateDisplayList3D`, `DrawCircle`, `DrawLine`, `SetPenPosition`, `DrawPolyline`, `GetDefaultFont`, `GetCurrentFont`, `SetCurrentFont`, `GetFontById`, `GetFontByName`, `GetTextHeight`, `SetTextHeight`, `GetRotationAngle`, `SetRotationAngle`, `GetSlantAngle`, `SetSlantAngle`, `GetWidthFactor`, `SetWidthFactor`, `ResetTextAttributes`, `GetCurrentGraphicsMode`, `SetCurrentGraphicsMode`, `GetCurrentGraphicsColor`, `SetCurrentGraphicsColor`

Methods Inherited from Interface com.ptc.pfc.pfcDisplay.Display

CreateDisplayList2D, Invalidate, DrawArc2D, DrawPolygon2D, DrawText2D, CreateDisplayList3D, DrawCircle, DrawLine, SetPenPosition, DrawPolyline, GetDefaultFont, GetCurrentFont, SetCurrentFont, GetFontById, GetFontByName, GetTextHeight, SetTextHeight, GetRotationAngle, SetRotationAngle, GetSlantAngle, SetSlantAngle, GetWidthFactor, SetWidthFactor, ResetTextAttributes, GetCurrentGraphicsMode, SetCurrentGraphicsMode, GetCurrentGraphicsColor, SetCurrentGraphicsColor

Method Detail

CopyFileFromWS

void CopyFileFromWS (String SourceFile, String TargetDirectory)

Copies a file from a Windchill workspace to a disk location.

Exceptions thrown (but not limited to):

XToolkitInvalidFile - The input file was not found or improper.

XToolkitInvalidDir - The output location was not found.

XToolkitCantAccess - No permission to read the input file, or to write to the target directory.

Manual References:: Windchill Connectivity APIs: File Copy

Parameters:

SourceFile: The path to the file.This must begin with wtws://.
TargetDirectory: The location on the local disk indicating where to copy the file.

Returns:

CopyFileToWS

void CopyFileToWS (String SourceFile, String TargetWorkspace, /*optional*/ String PrimaryContent)

Copies a file from local disk to a Windchill workspace; either as a primary document or as secondary content of an existing document in the workspace.

Exceptions thrown (but not limited to):

XToolkitInvalidFile - An input file was not found or improper.

XToolkitBadContext - There was a problem setting primary_content.

XToolkitCantWrite - The workspace file is not writable.

Manual References:: Windchill Connectivity APIs: File Copy, Windchill Connectivity APIs: File Copy

Parameters:

SourceFile: The path to the file
TargetWorkspace: The destination workspace.
PrimaryContent: The document which the copy will be attached to,"box7.prt" for example.Pass null to simply copy the file to the workspace.

Returns:

GetCurrentWindow/SetCurrentWindow

`/optional/ Window`	`GetCurrentWindow`	`()`
`void`	`SetCurrentWindow`	`( /optional/ Window value)`

The current Creo Parametric window

Manual References:: Windows and Views: Getting a Window Object, Windows and Views: Getting a Window Object

CreateModelWindow

Window CreateModelWindow (Model Mdl)

Creates or retrieves a window for a specified model.

If the window is already open with the model attached, the function returns the window object. If there is an empty window open, the function attaches the object to it. Otherwise, the function creates a new window and attaches the model to it.

Note that if the function creates a new window for an object, it does not automatically display the object in the window. To display the model, you must explicitly call the function Model.Display().

Exceptions thrown (but not limited to):

XToolkitInvalidType - You specified an invalid object type.

XToolkitDeadLock - The Creo Parametric user interface is not prepared to handle this request (because it is blocked by another process such as an OLE container activation).

XToolkitNotFound - The application is trying to open an embedded model (that is, a model representing a single body of a multi-body foreign object) in a separate window. This operation is not supported.

Manual References:: Windows and Views: Getting a Window Object, Windows and Views: Getting a Window Object

Parameters:

Mdl: The model that will be displayed in (or associated with) the window.

Returns:: The new or retrieved window

GetModelWindow

/*optional*/ Window GetModelWindow (Model Mdl)

Returns the window where a Creo Parametric model is displayed.

Exceptions thrown (but not limited to):

XToolkitNotFound - The function was not able to find the window.

Manual References:: Windows and Views: Getting a Window Object

Parameters:

Mdl: The model.

Returns:: The window, or null, if the model is not displayed.

OpenFile

Window OpenFile (ModelDescriptor MdlDescr)

Retrieves the specified model and displays it in a window.

This method is equivalent to calling BaseSession.RetrieveModel(ModelDescriptor) , BaseSession.CreateModelWindow(Model) , and Model.Display() .

Exceptions thrown (but not limited to):

XToolkitNotFound - This means either:

The model was not found in the current directory, OR
The function was not able to find the window, OR
The application is trying to open an embedded model (that is, a model representing a single body of a multi-body foreign object) in a separate window. This operation is not supported.

XToolkitNoPermission - The function does not have permission to operate on this model.

XToolkitInvalidType - You specified an invalid object type.

XToolkitDeadLock - The Creo Parametric user interface is not prepared to handle this request (because it is blocked by another process such as an OLE container activation).

Manual References:: Models: Retrieving Models, Models: Retrieving Models, Windows and Views: Getting a Window Object, Windows and Views: Getting a Window Object, Windchill Connectivity APIs: Retrieval

Parameters:

MdlDescr: The model to retrieve

Returns:: The new window

ListWindows

Windows ListWindows ()

Lists all the Creo Parametric windows.

Manual References:: Windows and Views: Getting a Window Object, Windows and Views: Getting a Window Object

Returns:: The list of windows

GetWindow

/*optional*/ Window GetWindow (int Id)

Retrieves the window object by its identifier.

Manual References:: Windows and Views: Getting a Window Object, Windows and Views: Getting a Window Object

Parameters:

Id: The identifier of the window

Returns:: The window that corresponds to the given identifier

FlushCurrentWindow

void FlushCurrentWindow ()

Forces the flush of pending display commands on the current window.

IMPORTANT: Excessive use of this method will cause major slow down on systems running Vista or Windows 7. It is recommended to call this method only after completing all display operations.

Manual References:: Windows and Views: Window Operations

Returns:

ListModels

Models ListModels ()

Retrieves the list of objects in the Creo Parametric session.

Exceptions thrown (but not limited to):

XToolkitNotFound - No objects were found in the workspace.

Manual References:: Models: Getting a Model Object, Models: Getting a Model Object, Drawings: Obtaining Drawing Models, Drawings: Obtaining Drawing Models

Returns:: The list of models

ListModelsByType

Models ListModelsByType (ModelType Type)

Returns all of the models of a particular type in the Creo Parametric session.

Exceptions thrown (but not limited to):

XToolkitNotFound - No objects were found in the workspace.

Manual References:: Drawings: Obtaining Drawing Models

Parameters:

Type: The type of model to locate.

Returns:: Sequence of model objects.

GetCurrentModel

/*optional*/ Model GetCurrentModel ()

The current Creo Parametric object, or null, if there is no current object

Exceptions thrown (but not limited to):

XToolkitBadContext - The current Creo Parametric object is not set.

Manual References:: Models: Getting a Model Object, Models: Getting a Model Object

GetActiveModel

/*optional*/ Model GetActiveModel ()

Retrieves the handle to the active model.

Exceptions thrown (but not limited to):

XToolkitBadContext - The active Creo Parametric object is not set.

Manual References:: Models: Getting a Model Object, Models: Getting a Model Object

Returns:: The active model

CreatePart

Part CreatePart (String Name)

Creates a new empty part.

Exceptions thrown (but not limited to):

XToolkitFound - An object of the specified name and type already exists.

XToolkitLineTooLong - Name length of the new object is more than 31 chars.

Manual References:: Solid: Getting a Solid Object, Solid: Getting a Solid Object

Parameters:

Name: The name of the part

Returns:: The new part

CreateAssembly

Assembly CreateAssembly (String Name)

Creates an empty assembly.

Exceptions thrown (but not limited to):

XToolkitFound - An object of the specified name and type already exists.

XToolkitLineTooLong - Name length of the new object is more than 31 chars.

Manual References:: Solid: Getting a Solid Object, Solid: Getting a Solid Object

Parameters:

Name: The name of the assembly to create

Returns:: The new assembly

CreateDrawingFromTemplate

Drawing CreateDrawingFromTemplate (String Name, String Template, ModelDescriptor DrawingModel, DrawingCreateOptions Options)

Creates a drawing from a template.

See Also:: XToolkitDrawingCreateErrors, DrawingCreateOption

Manual References:: Drawings: Creating Drawings from Templates

Parameters:

Name: The new drawing name.
Template: The template drawing name. This should be located in the search path or the system template directory.
DrawingModel: The name and type of the solid model to use while populating template views.
Options: Sequence of options to use while creating the drawing.

Returns:: The created drawing.

Import2DModel

Model Import2DModel (String NewModelName, ModelType Type, String FilePath, Import2DInstructions Instructions)

Creates a two-dimensional model from a geometry file.

Exceptions thrown (but not limited to):

XToolkitInvalidFile - The input file could not be found, or contained unrecoverable errors.

XToolkitNoLicense - There is no license for this import option.

XToolkitCantOpen - Failed to create drawing.

XToolkitObsoleteFunc - The file format selected is no longer supported on this platform.

See Also:: STEPImport2DInstructions, IGESImport2DInstructions, DXFImport2DInstructions, DWGImport2DInstructions

Manual References:: Interface: Importing 2D Models

Parameters:

NewModelName: The new model name.
Type: The new model type.
FilePath: The full path to the file to import.
Instructions: Instructions for importing the file.

Returns:: The newly created two dimensional model.

GetByRelationId

/*optional*/ Model GetByRelationId (int Id)

Returns the model, given its relation identifier.

Manual References:: Models: Getting a Model Object, Models: Getting a Model Object

Parameters:

Id: The identifier

Returns:: The model

RetrieveModel

Model RetrieveModel (ModelDescriptor MdlDescr)

Retrieves the specified model into the Creo Parametric session from standard directory.

The method does not create a window for the model or display it anywhere. The model can be retrieved only from standard directory. Path argument in model descriptor is ignored by this api.

Exceptions thrown (but not limited to):

XToolkitNotFound - The model was not found in the current directory.

XToolkitNoPermission - The function does not have permission to operate on this model.

See Also:: BaseSession.GetModel(String, ModelType), BaseSession.GetModelFromDescr(ModelDescriptor)

Manual References:: Models: Retrieving Models, Models: Retrieving Models, Drawings: Obtaining Drawing Models, Drawings: Obtaining Drawing Models, Windchill Connectivity APIs: Retrieval, Windchill Connectivity APIs: Retrieval

Parameters:

MdlDescr: The information about the model to retrieve

Returns:: The retrieved model

RetrieveModelWithOpts

Model RetrieveModelWithOpts (ModelDescriptor MdlDescr, RetrieveModelOptions Opts)

Retrieves the specified model into the Creo Parametric session based on the path specified in the model descriptor.

The method does not create a window for the model or display it anywhere.

Exceptions thrown (but not limited to):

XToolkitCantOpen - The model exists but is not readable.

XToolkitNotFound - The model does not exist, or was not found

XToolkitInvalidFile - The model is not a Creo Parametric model.

XToolkitInvalidName - The model name is too long.

XToolkitNoPermission - The function does not have permission to operate on this model.

Manual References:: Models: Retrieving Models, Models: Retrieving Models, Windchill Connectivity APIs: Retrieval, Windchill Connectivity APIs: Retrieval

Parameters:

MdlDescr: The information about the model to retrieve
Opts: Options for retrieval

Returns:: The retrieved model

GetModel

/*optional*/ Model GetModel (String Name, ModelType Type)

Finds a model in the Creo Parametric session, given the model name and type.

Exceptions thrown (but not limited to):

XToolkitNotFound - Unable to find the required model.

See Also:: BaseSession.RetrieveModel(ModelDescriptor), BaseSession.GetModelFromDescr(ModelDescriptor)

Manual References:: Models: Getting a Model Object, Models: Getting a Model Object, Drawings: Obtaining Drawing Models, Drawings: Obtaining Drawing Models

Parameters:

Name: The name of the model
Type: The model type

Returns:: The requested model or null, if no model with the specified parameters has been found in session

GetModelFromDescr

/*optional*/ Model GetModelFromDescr (ModelDescriptor MdlDescr)

Finds a model in the Creo Parametric session, given the model descriptor.

Exceptions thrown (but not limited to):

XToolkitNotFound - Unable to find the required model.

See Also:: BaseSession.RetrieveModel(ModelDescriptor), BaseSession.GetModel(String, ModelType)

Manual References:: Drawings: Obtaining Drawing Models, Drawings: Obtaining Drawing Models

Parameters:

MdlDescr: The model descriptor

Returns:: The requested model or null, if no model with the specified parameters has been found in session

GetModelFromFileName

/*optional*/ Model GetModelFromFileName (String FileName)

Locates and returns a model handle given its file name.

File name format should be of the form <model name>.<extension>, without a path.

Exceptions thrown (but not limited to):

XToolkitNotFound - Unable to find the required model.

XInvalidFileName - Invalid file name.

Parameters:

FileName: The Creo Parametric model file name.

Returns:: The model handle, or null, if the model was not found.

EraseUndisplayedModels

void EraseUndisplayedModels ()

Erases models which are not used in any Creo Parametric windows.

Exceptions thrown (but not limited to):

XToolkitBusy - Creo Parametric is in a state where erase isn't allowed.

See Also:: Model.Erase(), Model.EraseWithDependencies()

Returns:

Select

/*optional*/ Selections Select (SelectionOptions Options, /*optional*/ Selections InitialSels)

Allows interactive selection of objects in Creo Parametric.

Exceptions thrown (but not limited to):

XToolkitUserAbort - The user chose Quit.

XToolkitPickAbove - Selection was interrupted by a user's pick on any button from above menus.

XToolkitDeadLock - The Creo Parametric user interface is not prepared to handle this request (because it is blocked by another process such as an OLE container activation).

Manual References:: External Data: Selecting the Node from the External Application Tree, Selection: Interactive Selection, Selection: Interactive Selection, Drawings: Selecting Drawing Tables and Cells, Drawings: Selecting Drawing Tables and Cells

Parameters:

Options: The selection options, including the option keywords and maximum number ofselections allowed
InitialSels: A list of initial selections, which will be included in the return.

Returns:: A list of selected objects

QueryFeatureEdit

/*optional*/ Selections QueryFeatureEdit ()

Find the list of features being displayed for modification, as is done in 'Edit' on a feature.

Manual References:: Features: Access to Features

Returns:: A list of features being displayed for modification.

SetConfigOption

void SetConfigOption (String Name, String Value)

Sets the value of the specified configuration file option.

Exceptions thrown (but not limited to):

XToolkitNotFound - The specified option was not found.

See Also:: BaseSession.GetConfigOptionValues(String), BaseSession.GetConfigOption(String)

Manual References:: Session Objects: Configuration Options, Session Objects: Configuration Options

Parameters:

Name: The name of the configuration file option. This string can include uppercase and lowercase letters.
Value: The value of the option, as it must appear in the configuration file. If the option is a multivalued option,such as a path, this will add a new value to the array of values that already exist.

Returns:

GetConfigOption

/*optional*/ String GetConfigOption (String Name)

Retrieves the current value for the specified configuration file option.

The maximum length of a configuration option value returned by this function is 80 characters. For access to larger values, use BaseSession.GetConfigOptionValues(String).

Exceptions thrown (but not limited to):

XToolkitNotFound - The specified option was not found.

XToolkitLineTooLong - The function returned the option value, but the option is longer than the maximum string length 81.

See Also:: BaseSession.GetConfigOptionValues(String), BaseSession.SetConfigOption(String, String)

Parameters:

Name: The name of the configuration file option whose value you want. Thisstring can contain uppercase and lowercase letters.

Returns:: The value

GetConfigOptionValues

/*optional*/ stringseq GetConfigOptionValues (String Name)

Retrieves the current value(s) for the specified configuration file option.

Exceptions thrown (but not limited to):

XToolkitNotFound - The specified option was not found.

XToolkitLineTooLong - The function returned the option value, but the option is longer than the maximum string length 260.

See Also:: BaseSession.GetConfigOption(String), BaseSession.SetConfigOption(String, String)

Manual References:: Session Objects: Configuration Options, Session Objects: Configuration Options

Parameters:

Name: The name of the configuration file option whose value you want. Thisstring can contain uppercase and lowercase letters.

Returns:: The sequence of values. This may contain one value, if the option is not a multi-valued option.

RunMacro

void RunMacro (String Macro)

Runs the specified macro.

Macros may only run when control is returned to Creo Parametric. If control is maintained by a J-Link program, the macro will be stored for later running.

Manual References:: Session Objects: Macros, Session Objects: Macros, Session Objects: Macros

Parameters:

Macro: The macro to run

Returns:

SetTextColor

StdColor SetTextColor (StdColor NewColor)

Enables you to change the text color so any subsequent graphics window text is drawn in the specified color.

Exceptions thrown (but not limited to):

XToolkitNoChange - The current color is the same as the new color.

Manual References:: Session Objects: Colors and Line Styles, Session Objects: Colors and Line Styles

Parameters:

NewColor: The new color to be used for text

Returns:: The previous text color

GetRGBFromStdColor

ColorRGB GetRGBFromStdColor (StdColor StdClr)

Retrieves the RGB values for the specified color.

Manual References:: Session Objects: Colors and Line Styles

Parameters:

StdClr: The color type

Returns:: The RGB values

SetStdColorFromRGB

void SetStdColorFromRGB (StdColor StdClr, ColorRGB Color)

Enables you to set the values of the three color components for a standard color in Creo Parametric.

Manual References:: Graphics: Displaying Graphics, Session Objects: Colors and Line Styles, Session Objects: Colors and Line Styles

Parameters:

StdClr: The RGB values
Color: The color type

Returns:

SetLineStyle

StdLineStyle SetLineStyle (StdLineStyle NewStyle)

Sets the line style.

Exceptions thrown (but not limited to):

XToolkitNoChange - The new line style is the same as the old line style.

Manual References:: Graphics: Displaying Graphics, Session Objects: Colors and Line Styles

Parameters:

NewStyle: The new line style

Returns:: The previous line style

ExportDirectVRML

void ExportDirectVRML (VRMLDirectExportInstructions ExportData)

Exports a Creo Parametric object from disk into VRML format.

This function does not retrieve the model. See VRMLExportInstructions for a description of the files produced by the export.

Exceptions thrown (but not limited to):

XToolkitBadContext - The function is not available in Design Test Mode.

Manual References:: Interface: Export Instructions

Parameters:

ExportData: pfcVRMLDirectExportInstructions

Returns:

LoadConfigFile

void LoadConfigFile (String ConfigFileName)

Reads a configuration file into Creo Parametric.

Exceptions thrown (but not limited to):

XToolkitLineTooLong - The input filename length is too long for this import file type.

XToolkitObsoleteFunc - The file format selected is no longer supported on this platform.

Manual References:: Session Objects: Configuration Options

Parameters:

ConfigFileName: The output file name, including the extension.

Returns:

GetCurrentDirectory

String GetCurrentDirectory ()

Gets the absolute path name of the current working directory for Creo Parametric.

Exceptions thrown (but not limited to):

XToolkitNotFound - The function was unable to find current working directory.

Manual References:: Session Objects: Directories, Session Objects: Directories

Returns:: The absolute path

ChangeDirectory

void ChangeDirectory (String Path)

Changes Creo Parametric to another working directory.

Exceptions thrown (but not limited to):

XToolkitCantAccess - You are unable to access the specified directory.

XToolkitInvalidName - You specified an invalid name.

Manual References:: Session Objects: Directories

Parameters:

Path: The path to the new directory (relative or absolute).

Returns:

ListFiles

stringseq ListFiles (String Filter, FileListOpt Version, /*optional*/ String Path)

Returns a list of the files in the designated directory.

Exceptions thrown (but not limited to):

XToolkitInvalidDir - Invalid directory.

See Also:: BaseSession.ListSubdirectories(/*optional*/ String)

Manual References:: Session Objects: File Handling, Session Objects: File Handling

Parameters:

Filter: A filename filter, such as "*.prt"
Version: Flag indicating if all versions, or the latest versions should be found. Also allows alphatical sorting of the returned list.
Path: The directory

Returns:: Sequence of files found, including the full path name.

ListSubdirectories

stringseq ListSubdirectories ( /*optional*/ String Path)

Lists the subdirectories in a given directory location.

Exceptions thrown (but not limited to):

XToolkitInvalidDir - Invalid directory.

Manual References:: Session Objects: File Handling, Session Objects: File Handling

Parameters:

Path: The directory.

Returns:: Sequence of subdirectories.

GetEnvironmentVariable

/*optional*/ String GetEnvironmentVariable (String Name)

Returns the value a system environment variable.

Parameters:

Name: The name of the variable.

Returns:: The value, or null if the variable is not set.

CheckoutToWS

void CheckoutToWS (ModelDescriptors Objects, String WSName, boolean AsLink, RelCriterion RelCriterion)

Checks out a model from Pro/INTRALINK into the workspace.

NOTE: This method is deprecated. Pro/INTRALINK 3.4 is not supported. Please use Pro/INTRALINK 10.0 method Server.CheckoutObjects(/*optional*/ Model, /*optional*/ String, boolean, /*optional*/ CheckoutOptions) or Server.CheckoutMultipleObjects(stringseq, boolean, /*optional*/ CheckoutOptions) instead.

This method has limited options; PTC recommends using Pro/INTRALINK Toolkit for more complex checkout operartions.

Exceptions thrown (but not limited to):

XToolkitNotFound - The specified objects were not found in the Commonspace; or the Pro/INTRALINK Client is not in the latest frame when attempting the checkout.

XToolkitCommError - A Pro/INTRALINK Client is not available, and the Creo Parametric user has not registered Pro/INTRALINK as a server. (This function will work if the Pro/INTRALINK client has been authenticated previously through the Creo Parametric dialog.)

XToolkitNotImplemented - Initially, some of the options above might not be implemented.

Parameters:

Objects: Files to check out (name and type are required fields).
WSName: The workspace name.
AsLink: true to check out as a link, false to check out as a copy.
RelCriterion: Instructions about how to checkout dependencies.

Returns:

ExportFromCurrentWS

WSImportExportMessages ExportFromCurrentWS (stringseq FileNames, String TargetLocation, RelCriterion Dependency)

Export specified objects from the current workspace to a disk in a linked session of Creo Parametric. Can be called only when there are no objects in session . The specified objects may be exported along with all or required by Creo Parametric dependents (recursively), according to a specified dependency criterion. All problems (warnings, conflicts or errors) of processing individual objects are logged in proimpex.errors file created in the Creo Parametric run directory.

Exceptions thrown (but not limited to):

XToolkitBusy - cannot export because there are objects in Creo Parametric session

XToolkitNotFound - no workspace registered as current (or non linked session)

XToolkitInvalidDir - bad or inaccessible target_path

Manual References:: Windchill Connectivity APIs: Import and Export, Windchill Connectivity APIs: Import and Export, Windchill Connectivity APIs: File Copy

Parameters:

FileNames: A sequence of strings (file names ) to export.
TargetLocation: The export target directory.
Dependency: Instructions about how to export dependencies

Returns:: Import/export messages.

ImportToCurrentWS

WSImportExportMessages ImportToCurrentWS (stringseq Filepaths, RelCriterion Dependency)

Import specified objects from a disk to the current workspace in a linked session of Creo Parametric. Can be called only when there are no objects in session . The specified objects may be imported along with all or required by Creo Parametric dependents (recursively), according to a specified dependency criterion. All problems (warnings, conflicts or errors) of processing individual objects are logged in proimpex.errors file created in the Creo Parametric run directory.

Exceptions thrown (but not limited to):

XToolkitBusy - cannot import because there are objects in Creo Parametric session

XToolkitNotFound - no workspace registered as current (or non linked session)

Manual References:: Windchill Connectivity APIs: Upload, Windchill Connectivity APIs: Import and Export, Windchill Connectivity APIs: Import and Export, Windchill Connectivity APIs: File Copy

Parameters:

Filepaths: A sequence of strings - file paths (absolute or relative to current working directory) to objects to import.
Dependency: Instructions about how to import dependencies

Returns:: Import/export messages.

SetWSExportOptions

void SetWSExportOptions (WSExportOptions Options)

Sets the option controlling whether or not to export secondary contents during a call to BaseSession.ExportFromCurrentWS(stringseq, String, RelCriterion)

Manual References:: Windchill Connectivity APIs: Import and Export, Windchill Connectivity APIs: Import and Export

Parameters:

Options: Export options object of type WSExportOptions.

Returns:

ExportCurrentRasterImage

void ExportCurrentRasterImage (String ImageFileName, RasterImageExportInstructions Instructions)

Outputs a standard Creo Parametric raster output file (for current Window).

Exceptions thrown (but not limited to):

XToolkitNoPermission - The function does not have permission to operate on this model.

XToolkitBadContext - The function is not available in Design Test Mode.

Parameters:

ImageFileName: An output filename, including the extension
Instructions: An Raster-Export-Instructions object that controls the Raster-Image export operation. All of these objects inherit from RasterImageExportInstructions .

Returns:

RetrieveAssemSimpRep

Assembly RetrieveAssemSimpRep (String AssemName, /*optional*/ SimpRepInstructions Instructions)

Retrieves the specified simplified representation.

This method does not support Multi-CAD models. Object Toolkit users can use RetrieveAssemblySimpRep under wfcSession module as a superseding method.

Exceptions thrown (but not limited to):

XToolkitNoPermission - The function does not have permission to operate on this assembly.

XToolkitNotFound - The function did not find the simplified representation in the solid.

Manual References:: Simplified Representations: Retrieving Simplified Representations, Simplified Representations: Retrieving Simplified Representations

Parameters:

AssemName: The name of the assembly to retrieve.
Instructions: The simplified representation Instructions - the internal data required to define a simplified representation.

Returns:: The handle to the assembly.

RetrieveGraphicsSimpRep

Assembly RetrieveGraphicsSimpRep (String AssemName)

Retrieves the graphics simplified representation of an assembly.

This method supports Multi-CAD approach only for Object Toolkit (OTK) users. Outside of OTK (for instance in J-Link), this method will throw the XToolkitUnsupported exception if called on models originated through Multi-CAD.

For OTK users this method is a shortcut for wfcSession::WSession::RetrieveSimpRep.

Exceptions thrown (but not limited to):

XToolkitNoPermission - The function does not have permission to operate on this assembly.

Manual References:: Simplified Representations: Retrieving Simplified Representations, Simplified Representations: Retrieving Simplified Representations

Parameters:

AssemName: The name of the assembly to retrieve.

Returns:: The handle to the assembly.

RetrieveSymbolicSimpRep

Assembly RetrieveSymbolicSimpRep (String AssemName)

Retrieves the symbolic simplified representation of an assembly.

This method supports Multi-CAD approach only for Object Toolkit (OTK) users. Outside of OTK (for instance in J-Link), this method will throw the XToolkitUnsupported exception if called on models originated through Multi-CAD.

For OTK users this method is a shortcut for wfcSession::WSession::RetrieveSimpRep.

Exceptions thrown (but not limited to):

XToolkitNoPermission - The function does not have permission to operate on this assembly.

Manual References:: Simplified Representations: Retrieving Simplified Representations, Simplified Representations: Retrieving Simplified Representations

Parameters:

AssemName: The name of the assembly to retrieve.

Returns:: The handle to the assembly.

RetrieveGeomSimpRep

Assembly RetrieveGeomSimpRep (String AssemName)

Retrieves the geometry simplified representation of an assembly.

This method supports Multi-CAD approach only for Object Toolkit (OTK) users. Outside of OTK (for instance in J-Link), this method will throw the XToolkitUnsupported exception if called on models originated through Multi-CAD.

For OTK users this method is a shortcut for wfcSession::WSession::RetrieveSimpRep.

Exceptions thrown (but not limited to):

XToolkitNoPermission - The function does not have permission to operate on this assembly.

Manual References:: Simplified Representations: Retrieving Simplified Representations, Simplified Representations: Retrieving Simplified Representations

Parameters:

AssemName: The name of the assembly to retrieve.

Returns:: The handle to the assembly.

RetrievePartSimpRep

Part RetrievePartSimpRep (String PartName, String RepName)

Retrieves the specified part's user-defined simplified representation.

Exceptions thrown (but not limited to):

XToolkitNotFound - The Part was not found.

XToolkitInvalidName - The specified user defined rep was not found.

XToolkitNoPermission - The function does not have permission to operate on this assembly.

Parameters:

PartName: The name of the part to retrieve.
RepName: The name of the user-defined simplified representation.

Returns:: The handle to the part.

RetrieveGraphicsPartRep

Part RetrieveGraphicsPartRep (String PartName)

Retrieves the specified part's graphic simplified representation.

Exceptions thrown (but not limited to):

XToolkitNotFound - The Part was not found.

XToolkitInvalidName - The specified user defined rep was not found.

XToolkitNoPermission - The function does not have permission to operate on this assembly.

Parameters:

PartName: The name of the part to retrieve.

Returns:: The handle to the part.

RetrieveGeometryPartRep

Part RetrieveGeometryPartRep (String PartName)

Retrieves the specified part's geometric simplified representation.

Exceptions thrown (but not limited to):

XToolkitNotFound - The Part was not found.

XToolkitInvalidName - The specified user defined rep was not found.

XToolkitNoPermission - The function does not have permission to operate on this assembly.

Parameters:

PartName: The name of the part to retrieve.

Returns:: The handle to the part.

RetrieveSymbolicPartRep

Part RetrieveSymbolicPartRep (String PartName)

Retrieves the specified part's symbolic simplified representation.

Exceptions thrown (but not limited to):

XToolkitNotFound - The Part was not found.

XToolkitInvalidName - The specified user defined rep was not found.

XToolkitNoPermission - The function does not have permission to operate on this assembly.

Parameters:

PartName: The name of the part to retrieve.

Returns:: The handle to the part.

GetCurrentWS

/*optional*/ String GetCurrentWS ()

Returns the name of the Workspace currently registered in Creo Parametric.

NOTE: This method is deprecated. Pro/INTRALINK 3.4 is not supported. Please use Pro/INTRALINK 10.0 method Server.GetActiveWorkspace() instead.

Exceptions thrown (but not limited to):

XToolkitNotFound - There was no Workspace registered.

Returns:

SetCurrentWS

void SetCurrentWS (String NewWSName)

Registers a Workspace in Creo Parametric. Only one is allowed at a time, so if one is already registered, the new one will substitute the current one, but only if there are no objects in session.

NOTE: This method is deprecated. Pro/INTRALINK 3.4 is not supported. Use Pro/INTRALINK 10.0 method Server.SetActiveWorkspace(String) instead.

Exceptions thrown (but not limited to):

XToolkitBusy - When another workspace is already registered, cannot de-register because there are objects in Creo Parametric session.

Parameters:

NewWSName: The name of the Workspace.

Returns:

GetImportSourceType

ModelType GetImportSourceType (String FileToImport, NewModelImportType NewModelType)

Returns the type of model that can be created from a 3D format file. Note: does not support all types of 3D formats.

Exceptions thrown (but not limited to):

XToolkitInvalidType - This function is not supported for this import type.

Manual References:: Interface: Importing 3D Geometry, Interface: Importing 3D Geometry

Parameters:

FileToImport: The name of the file.
NewModelType: The type of information contained in the file.

Returns:: The type of file that can be created from the geometry file.

ImportNewModel

Model ImportNewModel (String FileToImport, NewModelImportType NewModelType, ModelType Type, String NewModelName, /*optional*/ LayerImportFilter Filter)

Imports a 3D format file as a new model.

Exceptions thrown (but not limited to):

XToolkitCantOpen - import_file can't be opened.

XToolkitUnsupported - Creo Parametric does not support import of the indicated file.

XToolkitNotExist - No profile found.

XToolkitInvalidFile - profile is not readable.

XToolkitInvalidType - This combination of arguments is invalid.

XToolkitLineTooLong - Name length of new model is more than 31 chars.

XToolkitFound - Already a model with same name exists in the Creo session.

Manual References:: Interface: Importing 3D Geometry, Interface: Importing 3D Geometry

Parameters:

FileToImport: Full path to the file to be imported.
NewModelType: The type of model to be imported. Use the method BaseSession.GetImportSourceType(String, NewModelImportType) to automatically determine the model type for some format types.
Type: The type of file being imported.
NewModelName: New name for the created model.
Filter: Optional filter for layer import. Pass null to use the default layer import actions.

Returns:: The newly imported part or assembly, drawing.

LoadProToolkitDll

Dll LoadProToolkitDll (String ApplicationName, String DllPath, String TextPath, boolean UserDisplay)

Causes Creo Parametric to load a Creo Parametric TOOLKIT DLL application.

The application's user_initialize() function will be called as the application starts.

Exceptions thrown (but not limited to):

XToolkitUserAbort - The DLL's user_initialize function returned an error and the DLL was not initialized. Check the values of GetUserInitializeReturn and GetUserInitializeMessage for more details.

XToolkitCantAccess - The file specified could not be read.

XToolkitInvalidFile - The file specified is not a proper DLL.

XToolkitInUse - The specified DLL is already loaded and may not be loaded again.

XToolkitNotFound - exec_file did not exist or was not readable

XToolkitCantWrite - Creo Parametric will not accept any more external applications registered at this time.

XToolkitBadContext - The DLL was already registered and failed to start or stop cleanly the last time it was loaded/unloaded.

XToolkitNeedsUnlock - The DLL requires the Creo Parametric TOOLKIT Development License, but it is not available in the Creo Parametric session.

XToolkitDllInitializeFailed - The DLL was not initialized

Manual References:: Task Based Application Libraries: Launching a Creo TOOLKIT DLL, Task Based Application Libraries: Launching a Creo TOOLKIT DLL

Parameters:

ApplicationName: The name of the application. Application names must be unique within the Creo Parametric session.
DllPath: The full path to the DLL binary file.
TextPath: The full path to the directory containing the DLL text, menu and resource files.
UserDisplay: If true, the application will be visible from the Auxiliary Applications dialog box, and the user will be allowed to stop it. If errors occur on startup, those errors will be presented to the user. If false, the application will be invisible to the user.

Returns:: The Creo Parametric TOOLKIT DLL handle.

LoadProToolkitLegacyDll

Dll LoadProToolkitLegacyDll (String ApplicationName, String DllPath, String TextPath, boolean UserDisplay)

Causes Creo Parametric to load a Creo Parametric TOOLKIT DLL non-Unicode application.

This API is similar to BaseSession.LoadProToolkitDll(String, String, String, boolean). Its purpose is to communicate to Creo Parametric that the loaded dll should be treated as a non-Unicode (pre-Wildfire 4.0) application. WARNING: this API should be used only by a pre-Wildfire 4.0 application to load a pre-Wildfire 4.0 dll.

Exceptions thrown (but not limited to):

XToolkitUserAbort - The DLL's user_initialize function returned an error and the DLL was not initialized. Check the values of user_error_ret and user_string_ret for more details.

XToolkitCantAccess - The file specified could not be read.

XToolkitInvalidFile - The file specified is not a proper DLL.

XToolkitInUse - The specified DLL is already loaded and may not be loaded again.

XToolkitNotFound - exec_file did not exist or was not readable

XToolkitCantWrite - Creo Parametric will not accept any more external applications registered at this time.

XToolkitBadContext - The DLL was already registered and failed to start or stop cleanly the last time it was loaded/unloaded.

XToolkitNeedsUnlock - The DLL requires the Creo Parametric TOOLKIT Development License, but it is not available in the Creo Parametric session.

Manual References:: Task Based Application Libraries: Launching a Creo TOOLKIT DLL, Task Based Application Libraries: Launching a Creo TOOLKIT DLL

Parameters:

ApplicationName: The name of the application. Application names must be unique within the Creo Parametric session.
DllPath: The full path to the DLL binary file.
TextPath: The full path to the directory containing the DLL text, menu and resource files.
UserDisplay: If true, the application will be visible from the Auxiliary Applications dialog box, and the user will be allowed to stop it. If errors occur on startup, those errors will be presented to the user. If false, the application will be invisible to the user.

Returns:: The Creo Parametric TOOLKIT DLL handle.

GetProToolkitDll

/*optional*/ Dll GetProToolkitDll (String ApplicationId)

Finds a Creo Parametric TOOLKIT DLL, given its identifer string.

Exceptions thrown (but not limited to):

XToolkitNotFound - Application could not be found.

XToolkitBadContext - Application was not active

Manual References:: Task Based Application Libraries: Launching a Creo TOOLKIT DLL, Task Based Application Libraries: Launching a Creo TOOLKIT DLL

Parameters:

ApplicationId

The DLL's identifier string, acquired from either:

A call to ProToolkitDllIdGet within the DLL application
The Id attribute in the Dll interface.

Returns:: The DLL object, or null if the DLL was not found in session.

EndSession

void EndSession ()

Returns:

StartJLinkApplication

JLinkApplication StartJLinkApplication (String ApplicationName, String ClassName, String StartMethod, String StopMethod, /*optional*/ String AdditionalClassPath, /*optional*/ String TextPath, boolean UserDisplay)

Exceptions thrown (but not limited to):

XToolkitUserAbort - The application failed to start properly. See the startup exception for more details.

XToolkitAmbiguous - The application class is already registered as another application, with different start and/or stop methods.

XToolkitInUse - The application with this configuration is already loaded, and may not be loaded again.

XToolkitCantWrite - Creo Parametric will not accept any more auxiliary applications at this time.

See Also:: JLinkApplication.ExecuteTask(String, Arguments), JLinkApplication.Stop()

Manual References:: Task Based Application Libraries: Creating Creo Object TOOLKIT Java Task Libraries, Task Based Application Libraries: Creating Creo Object TOOLKIT Java Task Libraries

Parameters:

ApplicationName: The application name.
ClassName: The application Java class.
StartMethod: Static method used to intialize the application.
StopMethod: Static method used to terminate the application.
AdditionalClassPath: Additional elements to be added to the front of the system CLASSPATH. Can be null. If more than one path is being added, they must be separated using the appropriate path separator (';' on Windows and ':' on UNIX).
TextPath: The application text path for menus and messaging. If null, the function uses the current directory.
UserDisplay: true to show application startup failure messages to the user, and to show the application in the Auxiliary Applications dialog.

Returns:: The J-Link application handle.

RegisterTask

void RegisterTask (String TaskId, JLinkTaskListener Listener)

Exceptions thrown (but not limited to):

XCannotAccess - Tasks in asynchronous mode

Manual References:: Task Based Application Libraries: Creating Creo Object TOOLKIT Java Task Libraries, Task Based Application Libraries: Creating Creo Object TOOLKIT Java Task Libraries

Parameters:

TaskId: String identifier for the task.
Listener: Listener object whose JLinkTaskListener.OnExecute(Arguments) method will be called when the application requests the task to be run.

Returns:

UnregisterTask

void UnregisterTask (String TaskId)

Unregister a listener as a task callable by another Creo Parametric auxiliary application.

Exceptions thrown (but not limited to):

XCannotAccess - Tasks in asynchronous mode

Manual References:: Task Based Application Libraries: Creating Creo Object TOOLKIT Java Task Libraries

Parameters:

TaskId: String identifier for the task.

Returns:

IsConfigurationSupported

boolean IsConfigurationSupported (ExportType Type, AssemblyConfiguration Configuration)

Identifies if an assembly configuration is supported for a particular export type.

Exceptions thrown (but not limited to):

XToolkitNotImplemented - file_type interface is currently not supported.

XToolkitInvalidType - invalid file_type.

See Also:: Model.Export(String, ExportInstructions), BaseSession.IsGeometryRepSupported(ExportType, GeometryFlags)

Manual References:: Interface: Export Utilities, Interface: Export Utilities

Parameters:

Type: The format of the export.
Configuration: The configuration type.

Returns:: true if this type is supported, false if not.

IsGeometryRepSupported

boolean IsGeometryRepSupported (ExportType Type, GeometryFlags Flags)

Identifies if a combination of geometry flags are supported for export to a certain format.

Exceptions thrown (but not limited to):

XToolkitNotImplemented - file_type interface is currently not supported.

XToolkitInvalidType - invalid file_type.

See Also:: Model.Export(String, ExportInstructions), BaseSession.IsConfigurationSupported(ExportType, AssemblyConfiguration), pfcExport.GeometryFlags_Create()

Manual References:: Interface: Export Utilities

Parameters:

Type: The format of the export.
Flags: The geometry flags.

Returns:: true if the format supports these flags, false if the flags cannot be used with this format.

GetDimensionDisplayMode/SetDimensionDisplayMode

`DimDisplayMode`	`GetDimensionDisplayMode`	`()`
`void`	`SetDimensionDisplayMode`	`(DimDisplayMode value)`

The current dimension display setting.

AuthenticateBrowser

void AuthenticateBrowser (String Username, String Password)

Preset username and password to allow automatic login into HTTP servers that require authentication.

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

Parameters:

Username: The name of user to be used.
Password: The password of the user to be used.

Returns:

RegisterServer

Server RegisterServer (String Alias, String Location, String WorkspaceName)

Registers a server in the session given its root location and an alias.

To automate registration of servers in interactive mode, use the standard config.fld setup to preregister the servers. To ensure that the servers are not preregistered when running Creo Parametric in batch non-graphics mode, set the environment variable PTC_WF_ROOT to an empty directory before starting Creo Parametric.

Exceptions thrown (but not limited to):

XToolkitFound - A server with this alias or location/workspace is already registered.

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

XToolkitInvalidName - Authentication failed.

XToolkitInvalidDir - The workspace couldn't be found or created.

XToolkitNoLicense - There is no license to work with the server.

XToolkitInvalidType - The server version is not supported.

Manual References:: Windchill Connectivity APIs: Registering and Activating a Server, Windchill Connectivity APIs: Registering and Activating a Server, Windchill Connectivity APIs: To Register a Server with an Existing Workspace

Parameters:

Alias: The name used by Creo Parametric to refer to this server.
Location: The root location for the server.
WorkspaceName: The name of the workspace to use.

Returns:: The registered server handle.

ListServers

/*optional*/ Servers ListServers ()

Sequence of servers , or null if server was not found

Exceptions thrown (but not limited to):

XToolkitNotFound - No servers are currently registered.

Manual References:: Windchill Connectivity APIs: Information on Servers in Session

Returns:

GetServerByAlias

/*optional*/ Server GetServerByAlias (String Alias)

Gets the server handle for a given server alias.

Exceptions thrown (but not limited to):

XToolkitNotFound - The server was not registered.

Manual References:: Windchill Connectivity APIs: Information on Servers in Session, Windchill Connectivity APIs: Information on Servers in Session

Parameters:

Alias: The name used by Creo Parametric to refer to this server.

Returns:: The server handle , or null if server with input alias was not found

GetServerByUrl

/*optional*/ Server GetServerByUrl (String Url, /*optional*/ String WorkspaceName)

Gets the server handle for a given server url and workspace name.

Exceptions thrown (but not limited to):

XToolkitNotFound - The server was not registered.

Manual References:: Windchill Connectivity APIs: Information on Servers in Session, Windchill Connectivity APIs: Information on Servers in Session

Parameters:

Url: The url of server.
WorkspaceName: The workspace name on the server.Can be null. If null, and more then one server with the url is registered, then function returns one of the registered servers.

Returns:: The server handle , or null if server with input url was not found

GetServerLocation

ServerLocation GetServerLocation (String Url)

Gets the server location handle for a given server url.

Exceptions thrown (but not limited to):

XToolkitNotFound - The server was not registered.

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

Parameters:

Url: The url of server.

Returns:: The server location handle.

GetActiveServer

/*optional*/ Server GetActiveServer ()

Gets the active server handle .

Exceptions thrown (but not limited to):

XToolkitNotFound - There is no active aliased server (Local Dir is active).

Manual References:: Windchill Connectivity APIs: Information on Servers in Session, Windchill Connectivity APIs: Information on Servers in Session

Returns:: The server handle, or null if active server was not found

GetUrlFromAliasedUrl

String GetUrlFromAliasedUrl (String AliasedUrl)

Converts an an aliased url (wtpub://alias/etc/p.prt) suitable for use in functions like ProMdlLoad to an unaliased URL (http://windchillserver.ptc.com/etc).

Exceptions thrown (but not limited to):

XToolkitNotFound - The server listed in the given aliased URL is not registered in session.

XToolkitCantAccess - If the server is in offline mode.

Manual References:: Windchill Connectivity APIs: Utility APIs

Parameters:

AliasedUrl: The aliased URL.

Returns:: The unaliased URL.

GetAliasFromAliasedUrl

String GetAliasFromAliasedUrl (String AliasedUrl)

Returns server alias from aliased URL.

Exceptions thrown (but not limited to):

XToolkitNotFound - The object was not found.

Manual References:: Windchill Connectivity APIs: Utility APIs, Windchill Connectivity APIs: Utility APIs

Parameters:

AliasedUrl: The aliased URL.

Returns:: The server alias.

GetModelNameFromAliasedUrl

String GetModelNameFromAliasedUrl (String AliasedUrl)

Returns model name from aliased URL.

Exceptions thrown (but not limited to):

XToolkitNotFound - The object was not found.

Manual References:: Windchill Connectivity APIs: Utility APIs, Windchill Connectivity APIs: Utility APIs

Parameters:

AliasedUrl: The aliased URL.

Returns:: The model name.

GetConnectionId

String GetConnectionId ()

Returns the connection id for the Creo Parametric session that this application is connected to. The identification string can be passed to external asynchronous applications to allow them to connect to this Creo Parametric session.

Exceptions thrown (but not limited to):

XToolkitNotFound - Communications are not correctly established for this session of Creo Parametric, and asynchronous connection is not possible.

Manual References:: Running J-Link Applications in Asynchronous Mode: Connecting Via Connection ID, Running J-Link Applications in Asynchronous Mode: Connecting Via Connection ID

ExecuteModelCheck

ModelCheckResults ExecuteModelCheck (Model Model, /*optional*/ ModelCheckInstructions Instructions)

Execute ModelCheck from an external application.

Exceptions thrown (but not limited to):

XToolkitNotFound - The function failed to find config directoy specified.

XToolkitNoLicense - Creo Parametric is missing the license to execute ModelCheck.

Manual References:: Models: Running Creo ModelCHECK, Models: Running Creo ModelCHECK

Parameters:

Model: The model.
Instructions: The ModelCheck instructions.

Returns:: A summary of the results of the ModelCheck run.

RegisterCustomModelCheck

void RegisterCustomModelCheck (CustomCheckInstructions Instructions)

Registers an custom check that can be included in any ModelCheck execution.

Exceptions thrown (but not limited to):

XToolkitFound - Check with this name already exists.

XToolkitBadContext - ModelCheck is not enabled in session.

Manual References:: Models: Custom Checks, Models: Custom Checks, Models: Custom Checks

Parameters:

Instructions: The custom check instructions.

Returns:

RegisterRelationFunction

void RegisterRelationFunction (String Name, RelationFunctionListener Listener, /*optional*/ RelationFunctionOptions Options)

Exceptions thrown (but not limited to):

XToolkitFound - Function with the given name was already found.

Manual References:: Relations: Adding a Customized Function to the Relations Dialog Box

Parameters:

Name: The name of the external function.
Listener: The listener for the external relation function methods.
Options: The relation function options indicating enabled/disabled attributes.

Returns:

GetMessageContents

String GetMessageContents (String MsgFile, String Format, /*optional*/ stringseq MessageTexts)

Writes a text message to a buffer string.

This method supports only ASCII character strings as texts.

Exceptions thrown (but not limited to):

XToolkitNotFound - The specified message file was not found.

XToolkitCantOpen - The system could not read the message file.

XToolkitMsgNotFound - The specified message was not found in the message file.

XToolkitMsgNoTrans - The message text (in the current language of the user interface) was not found.

XToolkitMsgFmtError - There was a format error in the message text.

XToolkitMsgTooLong - The message was longer than 80 characters and has been truncated to fit.

XToolkitFound - The specified message was not found in memory and the message file was read previously. This may indicate that there are two different message files with the same name; avoid this problem by including the application name in the file name.

Manual References:: Session Objects: Accessing the Message Window, Session Objects: Accessing the Message Window

Parameters:

MsgFile: The name of the message file containing the format
Format: The format of the message: the first line of the section of the message file that uniquely identifies the message
MessageTexts: A sequence of strings which will replace any occurrences of %#s in the message format, where '#' is the numerical identifier of the replacement. This method does not support formats using %#w.

Returns:: The buffer string.

GetLocalizedMessageContents

String GetLocalizedMessageContents (String MsgFile, String Format, /*optional*/ stringseq MessageTexts)

Writes a text message to a buffer string.

This method supports non-ASCII character strings as messages.

Exceptions thrown (but not limited to):

XToolkitNotFound - The specified message file was not found.

XToolkitCantOpen - The system could not read the message file.

XToolkitMsgNotFound - The specified message was not found in the message file.

XToolkitMsgNoTrans - The message text (in the current language of the user interface) was not found.

XToolkitMsgFmtError - There was a format error in the message text.

XToolkitMsgTooLong - The message was longer than 259 characters and has been truncated to fit.

Manual References:: Session Objects: Accessing the Message Window

Parameters:

MsgFile: The name of the message file containing the format.
Format: The format of the message: the first line of the section of the message file that uniquely identifies the message.
MessageTexts: A sequence of strings which will replace any occurrences of %#w in the message file, where '#' is the numerical identifier of the replacement. This method does not support formats using %#s.

Returns:: The buffer string.

UIRegisterFileSave

void UIRegisterFileSave (FileSaveRegisterOptions Options, FileSaveRegisterListener Listener)

Exceptions thrown (but not limited to):

XToolkitOutOfMemory - Couldn't allocate memory for new type.

XToolkitInUse - Already registered by this app.

XToolkitBadContext - The function is not available in Design Test Mode.

Manual References:: Session Objects: File Dialogs, Session Objects: File Dialogs

Parameters:

Options: The options for file type and description for save operation.
Listener: The listener for the file save operation.

Returns:

UIRegisterFileOpen

void UIRegisterFileOpen (FileOpenRegisterOptions Options, FileOpenRegisterListener Listener)

Exceptions thrown (but not limited to):

XToolkitOutOfMemory - Couldn't allocate memory for new type.

XToolkitInUse - Already registered by this app.

Manual References:: Session Objects: File Dialogs, Session Objects: File Dialogs

Parameters:

Options: The options for file type and description for open operation.
Listener: The listener for the file open operation.

Returns:

GetPrintPlacementOptions

PrintPlacementOption GetPrintPlacementOptions ()

Get the current print placement options.

Manual References:: Interface: Placement Options, Interface: Placement Options

Returns:

GetPrintPrinterOptions

PrintPrinterOption GetPrintPrinterOptions (String printer_type)

Get printer options for a specified printer.

Exceptions thrown (but not limited to):

XToolkitNotFound - The printer type was not recognized.

Manual References:: Interface: Printer Options, Interface: Printer Options

Parameters:

printer_type: Name of the printer type.

Returns:

GetPrintMdlOptions

PrintMdlOption GetPrintMdlOptions (Model model)

Get model options for a specified model.

Manual References:: Interface: Model Options, Interface: Model Options

Parameters:

model: The model.

Returns:

GetPrintPCFOptions

PrinterPCFOptions GetPrintPCFOptions (String filename, Model model)

Get the print options from a specified PCF file.

Exceptions thrown (but not limited to):

XToolkitNotFound - The PCF file does not exist.

Parameters:

filename: The name of the PCF file.
model: Model to be printed.

Returns:

PLMSInitialize

String PLMSInitialize (String request)

Parameters:

request

Returns:

AllowDuplicateModelItems

void AllowDuplicateModelItems (boolean val)

Turns on/off the control of creating duplicate model items.

Applications have an option to prevent creating ModelItems more than twice for the same Creo Parametric item. Howerever, this may cause memory corruption if not handled properly on the application side. Therefore, this behavior is turned off by default. Calling BaseSession.AllowDuplicateModelItems(boolean) for Boolean.FALSE turns it on. Although there is no restriction of turning this control off/on at any time and multiple times, it is recommended doing it not more than once and right after the session is obtained.

Manual References:: ModelItem: Duplicating ModelItems

Parameters:

val

Returns:

WLBInitialize

void WLBInitialize (boolean val)

Parameters:

val

Returns:

ExportProfileLoad

void ExportProfileLoad (String ProfileFile)

Loads profile for export.

Exceptions thrown (but not limited to):

<reference 6 to unknown entity pfcExceptions::pfcXEmptyString> - This means NULL or empty profile file path.

Manual References:: Interface: Export Instructions, Interface: Export Instructions

Parameters:

ProfileFile: Profile full path along with profile name and extension.

Returns: