| Library | Module | Frames | Expand |
| /* readonly */ string | 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. | ||
| /* readonly */ /* optional */ pfcModel | CurrentModel | |
| The current Creo Parametric object, or null, if there is no current object | ||
| /* optional */ pfcWindow | CurrentWindow | |
| The current Creo Parametric window | ||
| pfcDimDisplayMode | DimensionDisplayMode | |
| The current dimension display setting. | ||
| 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 (pfcModelDescriptors Objects, string WSName, boolean AsLink, pfcRelCriterion 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. | ||
| pfcAssembly | CreateAssembly (string Name) | |
| Creates an empty assembly. | ||
| pfcDrawing | CreateDrawingFromTemplate (string Name, string Template, pfcModelDescriptor DrawingModel, pfcDrawingCreateOptions Options) | |
| Creates a drawing from a template. | ||
| pfcWindow | CreateModelWindow (pfcModel Mdl) | |
| Creates or retrieves a window for a specified model. | ||
| pfcPart | CreatePart (string Name) | |
| Creates a new empty part. | ||
| void | EraseUndisplayedModels () | |
| Erases models which are not used in any Creo Parametric windows. | ||
| pfcModelCheckResults | ExecuteModelCheck (pfcModel Model, /* optional */ pfcModelCheckInstructions Instructions) | |
| Execute ModelCheck from an external application. | ||
| void | ExportCurrentRasterImage (string ImageFileName, pfcRasterImageExportInstructions Instructions) | |
| Outputs a standard Creo Parametric raster output file (for current Window). | ||
| void | ExportDirectVRML (pfcVRMLDirectExportInstructions ExportData) | |
| Exports a Creo Parametric object from disk into VRML format. | ||
| pfcWSImportExportMessages | ExportFromCurrentWS (stringseq FileNames, string TargetLocation, pfcRelCriterion 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 */ pfcModel | GetActiveModel () | |
| Retrieves the handle to the active model. | ||
| /* optional */ pfcServer | GetActiveServer () | |
| Gets the active server handle . | ||
| string | GetAliasFromAliasedUrl (string AliasedUrl) | |
| Returns server alias from aliased URL. | ||
| /* optional */ pfcModel | GetByRelationId (number 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 | GetCurrentDirectory () | |
| Gets the absolute path name of the current working directory for Creo Parametric. | ||
| /* optional */ string | GetCurrentWS () | |
| Returns the name of the Workspace currently registered in Creo Parametric. | ||
| /* optional */ string | GetEnvironmentVariable (string Name) | |
| Returns the value a system environment variable. | ||
| pfcModelType | GetImportSourceType (string FileToImport, pfcNewModelImportType 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 */ pfcModel | GetModel (string Name, pfcModelType Type) | |
| Finds a model in the Creo Parametric session, given the model name and type. | ||
| /* optional */ pfcModel | GetModelFromDescr (pfcModelDescriptor MdlDescr) | |
| Finds a model in the Creo Parametric session, given the model descriptor. | ||
| /* optional */ pfcModel | GetModelFromFileName (string FileName) | |
| Locates and returns a model handle given its file name. | ||
| string | GetModelNameFromAliasedUrl (string AliasedUrl) | |
| Returns model name from aliased URL. | ||
| /* optional */ pfcWindow | GetModelWindow (pfcModel Mdl) | |
| Returns the window where a Creo Parametric model is displayed. | ||
| pfcPrintMdlOption | GetPrintMdlOptions (pfcModel model) | |
| Get model options for a specified model. | ||
| pfcPrinterPCFOptions | GetPrintPCFOptions (string filename, pfcModel model) | |
| Get the print options from a specified PCF file. | ||
| pfcPrintPlacementOption | GetPrintPlacementOptions () | |
| Get the current print placement options. | ||
| pfcPrintPrinterOption | GetPrintPrinterOptions (string printer_type) | |
| Get printer options for a specified printer. | ||
| /* optional */ pfcDll | GetProToolkitDll (string ApplicationId) | |
| Finds a Creo Parametric TOOLKIT DLL, given its identifer string. | ||
| pfcColorRGB | GetRGBFromStdColor (pfcStdColor StdClr) | |
| Retrieves the RGB values for the specified color. | ||
| /* optional */ pfcServer | GetServerByAlias (string Alias) | |
| Gets the server handle for a given server alias. | ||
| /* optional */ pfcServer | GetServerByUrl (string Url, /* optional */ string WorkspaceName) | |
| Gets the server handle for a given server url and workspace name. | ||
| pfcServerLocation | 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 */ pfcWindow | GetWindow (number Id) | |
| Retrieves the window object by its identifier. | ||
| pfcModel | Import2DModel (string NewModelName, pfcModelType Type, string FilePath, pfcImport2DInstructions Instructions) | |
| Creates a two-dimensional model from a geometry file. | ||
| pfcModel | ImportNewModel (string FileToImport, pfcNewModelImportType NewModelType, pfcModelType Type, string NewModelName, /* optional */ pfcLayerImportFilter Filter) | |
| Imports a 3D format file as a new model. | ||
| pfcWSImportExportMessages | ImportToCurrentWS (stringseq Filepaths, pfcRelCriterion 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 (pfcExportType Type, pfcAssemblyConfiguration Configuration) | |
| Identifies if an assembly configuration is supported for a particular export type. | ||
| boolean | IsGeometryRepSupported (pfcExportType Type, pfcGeometryFlags Flags) | |
| Identifies if a combination of geometry flags are supported for export to a certain format. | ||
| stringseq | ListFiles (string Filter, pfcFileListOpt Version, /* optional */ string Path) | |
| Returns a list of the files in the designated directory. | ||
| pfcModels | ListModels () | |
| Retrieves the list of objects in the Creo Parametric session. | ||
| pfcModels | ListModelsByType (pfcModelType Type) | |
| Returns all of the models of a particular type in the Creo Parametric session. | ||
| /* optional */ pfcServers | ListServers () | |
| Sequence of servers , or null if server was not found | ||
| stringseq | ListSubdirectories ( /* optional */ string Path) | |
| Lists the subdirectories in a given directory location. | ||
| pfcWindows | ListWindows () | |
| Lists all the Creo Parametric windows. | ||
| void | LoadConfigFile (string ConfigFileName) | |
| Reads a configuration file into Creo Parametric. | ||
| pfcDll | LoadProToolkitDll (string ApplicationName, string DllPath, string TextPath, boolean UserDisplay) | |
| Causes Creo Parametric to load a Creo Parametric TOOLKIT DLL application. | ||
| pfcDll | LoadProToolkitLegacyDll (string ApplicationName, string DllPath, string TextPath, boolean UserDisplay) | |
| Causes Creo Parametric to load a Creo Parametric TOOLKIT DLL non-Unicode application. | ||
| pfcWindow | OpenFile (pfcModelDescriptor MdlDescr) | |
| Retrieves the specified model and displays it in a window. | ||
| string | PLMSInitialize (string request) | |
| /* optional */ pfcSelections | QueryFeatureEdit () | |
| Find the list of features being displayed for modification, as is done in 'Edit' on a feature. | ||
| pfcServer | RegisterServer (string Alias, string Location, string WorkspaceName) | |
| Registers a server in the session given its root location and an alias. | ||
| pfcAssembly | RetrieveAssemSimpRep (string AssemName, /* optional */ pfcSimpRepInstructions Instructions) | |
| Retrieves the specified simplified representation. | ||
| pfcPart | RetrieveGeometryPartRep (string PartName) | |
| Retrieves the specified part's geometric simplified representation. | ||
| pfcAssembly | RetrieveGeomSimpRep (string AssemName) | |
| Retrieves the geometry simplified representation of an assembly. | ||
| pfcPart | RetrieveGraphicsPartRep (string PartName) | |
| Retrieves the specified part's graphic simplified representation. | ||
| pfcAssembly | RetrieveGraphicsSimpRep (string AssemName) | |
| Retrieves the graphics simplified representation of an assembly. | ||
| pfcModel | RetrieveModel (pfcModelDescriptor MdlDescr) | |
| Retrieves the specified model into the Creo Parametric session from standard directory. | ||
| pfcModel | RetrieveModelWithOpts (pfcModelDescriptor MdlDescr, pfcRetrieveModelOptions Opts) | |
| Retrieves the specified model into the Creo Parametric session based on the path specified in the model descriptor. | ||
| pfcPart | RetrievePartSimpRep (string PartName, string RepName) | |
| Retrieves the specified part's user-defined simplified representation. | ||
| pfcPart | RetrieveSymbolicPartRep (string PartName) | |
| Retrieves the specified part's symbolic simplified representation. | ||
| pfcAssembly | RetrieveSymbolicSimpRep (string AssemName) | |
| Retrieves the symbolic simplified representation of an assembly. | ||
| void | RunMacro (string Macro) | |
| Runs the specified macro. | ||
| /* optional */ pfcSelections | Select (pfcSelectionOptions Options, /* optional */ pfcSelections 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 | 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. | ||
| pfcStdLineStyle | SetLineStyle (pfcStdLineStyle NewStyle) | |
| Sets the line style. | ||
| void | SetStdColorFromRGB (pfcStdColor StdClr, pfcColorRGB Color) | |
| Enables you to set the values of the three color components for a standard color in Creo Parametric. | ||
| pfcStdColor | SetTextColor (pfcStdColor NewColor) | |
| Enables you to change the text color so any subsequent graphics window text is drawn in the specified color. | ||
| void | SetWSExportOptions (pfcWSExportOptions Options) | |
| Sets the option controlling whether or not to export secondary contents during a call to pfcBaseSession.ExportFromCurrentWS() | ||
| pfcJLinkApplication | 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 | WLBInitialize (boolean val) | |
| /* readonly */ string | 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. Exceptions thrown (but not limited to): pfcXToolkitNotFound - Communications are not correctly established for this session of Creo Parametric, and asynchronous connection is not possible. |
| /* readonly */ /* optional */ pfcModel | CurrentModel |
|
The current Creo Parametric object, or null, if there is no current object Exceptions thrown (but not limited to): pfcXToolkitBadContext - The current Creo Parametric object is not set. |
| /* optional */ pfcWindow | CurrentWindow |
|
The current Creo Parametric window |
| pfcDimDisplayMode | DimensionDisplayMode |
|
The current dimension display setting. |
| 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 pfcBaseSession.AllowDuplicateModelItems() 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.
|
| 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. Exceptions thrown (but not limited to): pfcXToolkitCantAccess - You are unable to access the specified directory. pfcXToolkitInvalidName - You specified an invalid name.
|
| void | CheckoutToWS | (pfcModelDescriptors Objects, string WSName, boolean AsLink, pfcRelCriterion 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 pfcServer.CheckoutObjects() or pfcServer.CheckoutMultipleObjects() instead. This method has limited options; PTC recommends using Pro/INTRALINK Toolkit for more complex checkout operartions. Exceptions thrown (but not limited to): pfcXToolkitNotFound - The specified objects were not found in the Commonspace; or the Pro/INTRALINK Client is not in the latest frame when attempting the checkout. pfcXToolkitCommError - 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.) pfcXToolkitNotImplemented - Initially, some of the options above might not be implemented.
|
| void | CopyFileFromWS | (string SourceFile, string TargetDirectory) |
|
Copies a file from a Windchill workspace to a disk location. Exceptions thrown (but not limited to): pfcXToolkitInvalidFile - The input file was not found or improper. pfcXToolkitInvalidDir - The output location was not found. pfcXToolkitCantAccess - No permission to read the input file, or to write to the target directory.
|
| 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): pfcXToolkitInvalidFile - An input file was not found or improper. pfcXToolkitBadContext - There was a problem setting primary_content. pfcXToolkitCantWrite - The workspace file is not writable.
|
| pfcAssembly | CreateAssembly | (string Name) |
|
Creates an empty assembly. Exceptions thrown (but not limited to): pfcXToolkitFound - An object of the specified name and type already exists. pfcXToolkitLineTooLong - Name length of the new object is more than 31 chars.
|
| pfcDrawing | CreateDrawingFromTemplate | (string Name, string Template, pfcModelDescriptor DrawingModel, pfcDrawingCreateOptions Options) |
|
Creates a drawing from a template.
|
| pfcWindow | CreateModelWindow | (pfcModel 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 pfcModel.Display(). Exceptions thrown (but not limited to): pfcXToolkitInvalidType - You specified an invalid object type. pfcXToolkitDeadLock - 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). pfcXToolkitNotFound - 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.
|
| pfcPart | CreatePart | (string Name) |
|
Creates a new empty part. Exceptions thrown (but not limited to): pfcXToolkitFound - An object of the specified name and type already exists. pfcXToolkitLineTooLong - Name length of the new object is more than 31 chars.
|
| void | EraseUndisplayedModels | () |
|
Erases models which are not used in any Creo Parametric windows. Exceptions thrown (but not limited to): pfcXToolkitBusy - Creo Parametric is in a state where erase isn't allowed.
|
| pfcModelCheckResults | ExecuteModelCheck | (pfcModel Model, /* optional */ pfcModelCheckInstructions Instructions) |
|
Execute ModelCheck from an external application. Exceptions thrown (but not limited to): pfcXToolkitNotFound - The function failed to find config directoy specified. pfcXToolkitNoLicense - Creo Parametric is missing the license to execute ModelCheck.
|
| void | ExportCurrentRasterImage | (string ImageFileName, pfcRasterImageExportInstructions Instructions) |
|
Outputs a standard Creo Parametric raster output file (for current Window). Exceptions thrown (but not limited to): pfcXToolkitNoPermission - The function does not have permission to operate on this model. pfcXToolkitBadContext - The function is not available in Design Test Mode.
|
| void | ExportDirectVRML | (pfcVRMLDirectExportInstructions ExportData) |
|
Exports a Creo Parametric object from disk into VRML format. This function does not retrieve the model. See pfcVRMLExportInstructions for a description of the files produced by the export. Exceptions thrown (but not limited to): pfcXToolkitBadContext - The function is not available in Design Test Mode.
|
| pfcWSImportExportMessages | ExportFromCurrentWS | (stringseq FileNames, string TargetLocation, pfcRelCriterion 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): pfcXToolkitBusy - cannot export because there are objects in Creo Parametric session pfcXToolkitNotFound - no workspace registered as current (or non linked session) pfcXToolkitInvalidDir - bad or inaccessible target_path
|
| void | ExportProfileLoad | (string ProfileFile) |
|
Loads profile for export. Exceptions thrown (but not limited to): <reference 4 to unknown entity pfcExceptions::pfcXEmptyString> - This means NULL or empty profile file path.
|
| 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. |
| /* optional */ pfcModel | GetActiveModel | () |
|
Retrieves the handle to the active model. Exceptions thrown (but not limited to): pfcXToolkitBadContext - The active Creo Parametric object is not set.
|
| /* optional */ pfcServer | GetActiveServer | () |
|
Gets the active server handle . Exceptions thrown (but not limited to): pfcXToolkitNotFound - There is no active aliased server (Local Dir is active).
|
| string | GetAliasFromAliasedUrl | (string AliasedUrl) |
|
Returns server alias from aliased URL. Exceptions thrown (but not limited to): pfcXToolkitNotFound - The object was not found.
|
| /* optional */ pfcModel | GetByRelationId | (number Id) |
|
Returns the model, given its relation identifier.
|
| /* 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 pfcBaseSession.GetConfigOptionValues(). Exceptions thrown (but not limited to): pfcXToolkitNotFound - The specified option was not found. pfcXToolkitLineTooLong - The function returned the option value, but the option is longer than the maximum string length 81.
|
| /* optional */ stringseq | GetConfigOptionValues | (string Name) |
|
Retrieves the current value(s) for the specified configuration file option. Exceptions thrown (but not limited to): pfcXToolkitNotFound - The specified option was not found. pfcXToolkitLineTooLong - The function returned the option value, but the option is longer than the maximum string length 260.
|
| string | GetCurrentDirectory | () |
|
Gets the absolute path name of the current working directory for Creo Parametric. Exceptions thrown (but not limited to): pfcXToolkitNotFound - The function was unable to find current working directory.
|
| /* 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 pfcServer.ActiveWorkspace instead. Exceptions thrown (but not limited to): pfcXToolkitNotFound - There was no Workspace registered.
|
| /* optional */ string | GetEnvironmentVariable | (string Name) |
|
Returns the value a system environment variable.
|
| pfcModelType | GetImportSourceType | (string FileToImport, pfcNewModelImportType 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): pfcXToolkitInvalidType - This function is not supported for this import type.
|
| 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): pfcXToolkitNotFound - The specified message file was not found. pfcXToolkitCantOpen - The system could not read the message file. pfcXToolkitMsgNotFound - The specified message was not found in the message file. pfcXToolkitMsgNoTrans - The message text (in the current language of the user interface) was not found. pfcXToolkitMsgFmtError - There was a format error in the message text. pfcXToolkitMsgTooLong - The message was longer than 259 characters and has been truncated to fit. pfcXToolkitFound - 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.
|
| 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): pfcXToolkitNotFound - The specified message file was not found. pfcXToolkitCantOpen - The system could not read the message file. pfcXToolkitMsgNotFound - The specified message was not found in the message file. pfcXToolkitMsgNoTrans - The message text (in the current language of the user interface) was not found. pfcXToolkitMsgFmtError - There was a format error in the message text. pfcXToolkitMsgTooLong - The message was longer than 80 characters and has been truncated to fit. pfcXToolkitFound - 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.
|
| /* optional */ pfcModel | GetModel | (string Name, pfcModelType Type) |
|
Finds a model in the Creo Parametric session, given the model name and type. Exceptions thrown (but not limited to): pfcXToolkitNotFound - Unable to find the required model.
|
| /* optional */ pfcModel | GetModelFromDescr | (pfcModelDescriptor MdlDescr) |
|
Finds a model in the Creo Parametric session, given the model descriptor. Exceptions thrown (but not limited to): pfcXToolkitNotFound - Unable to find the required model.
|
| /* optional */ pfcModel | 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): pfcXToolkitNotFound - Unable to find the required model. pfcXInvalidFileName - Invalid file name.
|
| string | GetModelNameFromAliasedUrl | (string AliasedUrl) |
|
Returns model name from aliased URL. Exceptions thrown (but not limited to): pfcXToolkitNotFound - The object was not found.
|
| /* optional */ pfcWindow | GetModelWindow | (pfcModel Mdl) |
|
Returns the window where a Creo Parametric model is displayed. Exceptions thrown (but not limited to): pfcXToolkitNotFound - The function was not able to find the window.
|
| pfcPrintMdlOption | GetPrintMdlOptions | (pfcModel model) |
|
Get model options for a specified model.
|
| pfcPrinterPCFOptions | GetPrintPCFOptions | (string filename, pfcModel model) |
|
Get the print options from a specified PCF file. Exceptions thrown (but not limited to): pfcXToolkitNotFound - The PCF file does not exist.
|
| pfcPrintPlacementOption | GetPrintPlacementOptions | () |
|
Get the current print placement options.
|
| pfcPrintPrinterOption | GetPrintPrinterOptions | (string printer_type) |
|
Get printer options for a specified printer. Exceptions thrown (but not limited to): pfcXToolkitNotFound - The printer type was not recognized.
|
| /* optional */ pfcDll | GetProToolkitDll | (string ApplicationId) |
|
Finds a Creo Parametric TOOLKIT DLL, given its identifer string. Exceptions thrown (but not limited to): pfcXToolkitNotFound - Application could not be found. pfcXToolkitBadContext - Application was not active
|
| pfcColorRGB | GetRGBFromStdColor | (pfcStdColor StdClr) |
|
Retrieves the RGB values for the specified color.
|
| /* optional */ pfcServer | GetServerByAlias | (string Alias) |
|
Gets the server handle for a given server alias. Exceptions thrown (but not limited to): pfcXToolkitNotFound - The server was not registered.
|
| /* optional */ pfcServer | GetServerByUrl | (string Url, /* optional */ string WorkspaceName) |
|
Gets the server handle for a given server url and workspace name. Exceptions thrown (but not limited to): pfcXToolkitNotFound - The server was not registered.
|
| pfcServerLocation | GetServerLocation | (string Url) |
|
Gets the server location handle for a given server url. Exceptions thrown (but not limited to): pfcXToolkitNotFound - The server was not registered.
|
| 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): pfcXToolkitNotFound - The server listed in the given aliased URL is not registered in session. pfcXToolkitCantAccess - If the server is in offline mode.
|
| /* optional */ pfcWindow | GetWindow | (number Id) |
|
Retrieves the window object by its identifier.
|
| pfcModel | Import2DModel | (string NewModelName, pfcModelType Type, string FilePath, pfcImport2DInstructions Instructions) |
|
Creates a two-dimensional model from a geometry file. Exceptions thrown (but not limited to): pfcXToolkitInvalidFile - The input file could not be found, or contained unrecoverable errors. pfcXToolkitNoLicense - There is no license for this import option. pfcXToolkitCantOpen - Failed to create drawing. pfcXToolkitObsoleteFunc - The file format selected is no longer supported on this platform.
|
| pfcModel | ImportNewModel | (string FileToImport, pfcNewModelImportType NewModelType, pfcModelType Type, string NewModelName, /* optional */ pfcLayerImportFilter Filter) |
|
Imports a 3D format file as a new model. Exceptions thrown (but not limited to): pfcXToolkitCantOpen - import_file can't be opened. pfcXToolkitUnsupported - Creo Parametric does not support import of the indicated file. pfcXToolkitNotExist - No profile found. pfcXToolkitInvalidFile - profile is not readable. pfcXToolkitInvalidType - This combination of arguments is invalid. pfcXToolkitLineTooLong - Name length of new model is more than 31 chars. pfcXToolkitFound - Already a model with same name exists in the Creo session.
|
| pfcWSImportExportMessages | ImportToCurrentWS | (stringseq Filepaths, pfcRelCriterion 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): pfcXToolkitBusy - cannot import because there are objects in Creo Parametric session pfcXToolkitNotFound - no workspace registered as current (or non linked session)
|
| boolean | IsConfigurationSupported | (pfcExportType Type, pfcAssemblyConfiguration Configuration) |
|
Identifies if an assembly configuration is supported for a particular export type. Exceptions thrown (but not limited to): pfcXToolkitNotImplemented - file_type interface is currently not supported. pfcXToolkitInvalidType - invalid file_type.
|
| boolean | IsGeometryRepSupported | (pfcExportType Type, pfcGeometryFlags Flags) |
|
Identifies if a combination of geometry flags are supported for export to a certain format. Exceptions thrown (but not limited to): pfcXToolkitNotImplemented - file_type interface is currently not supported. pfcXToolkitInvalidType - invalid file_type.
|
| stringseq | ListFiles | (string Filter, pfcFileListOpt Version, /* optional */ string Path) |
|
Returns a list of the files in the designated directory. Exceptions thrown (but not limited to): pfcXToolkitInvalidDir - Invalid directory.
|
| pfcModels | ListModels | () |
|
Retrieves the list of objects in the Creo Parametric session. Exceptions thrown (but not limited to): pfcXToolkitNotFound - No objects were found in the workspace.
|
| pfcModels | ListModelsByType | (pfcModelType Type) |
|
Returns all of the models of a particular type in the Creo Parametric session. Exceptions thrown (but not limited to): pfcXToolkitNotFound - No objects were found in the workspace.
|
| /* optional */ pfcServers | ListServers | () |
|
Sequence of servers , or null if server was not found Exceptions thrown (but not limited to): pfcXToolkitNotFound - No servers are currently registered.
|
| stringseq | ListSubdirectories | ( /* optional */ string Path) |
|
Lists the subdirectories in a given directory location. Exceptions thrown (but not limited to): pfcXToolkitInvalidDir - Invalid directory.
|
| pfcWindows | ListWindows | () |
|
Lists all the Creo Parametric windows.
|
| void | LoadConfigFile | (string ConfigFileName) |
|
Reads a configuration file into Creo Parametric. Exceptions thrown (but not limited to): pfcXToolkitLineTooLong - The input filename length is too long for this import file type. pfcXToolkitObsoleteFunc - The file format selected is no longer supported on this platform.
|
| pfcDll | 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): pfcXToolkitUserAbort - 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. pfcXToolkitCantAccess - The file specified could not be read. pfcXToolkitInvalidFile - The file specified is not a proper DLL. pfcXToolkitInUse - The specified DLL is already loaded and may not be loaded again. pfcXToolkitNotFound - exec_file did not exist or was not readable pfcXToolkitCantWrite - Creo Parametric will not accept any more external applications registered at this time. pfcXToolkitBadContext - The DLL was already registered and failed to start or stop cleanly the last time it was loaded/unloaded. pfcXToolkitNeedsUnlock - The DLL requires the Creo Parametric TOOLKIT Development License, but it is not available in the Creo Parametric session. pfcXToolkitDllInitializeFailed - The DLL was not initialized
|
| pfcDll | 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 pfcBaseSession.LoadProToolkitDll(). 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): pfcXToolkitUserAbort - 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. pfcXToolkitCantAccess - The file specified could not be read. pfcXToolkitInvalidFile - The file specified is not a proper DLL. pfcXToolkitInUse - The specified DLL is already loaded and may not be loaded again. pfcXToolkitNotFound - exec_file did not exist or was not readable pfcXToolkitCantWrite - Creo Parametric will not accept any more external applications registered at this time. pfcXToolkitBadContext - The DLL was already registered and failed to start or stop cleanly the last time it was loaded/unloaded. pfcXToolkitNeedsUnlock - The DLL requires the Creo Parametric TOOLKIT Development License, but it is not available in the Creo Parametric session.
|
| pfcWindow | OpenFile | (pfcModelDescriptor MdlDescr) |
|
Retrieves the specified model and displays it in a window. This method is equivalent to calling pfcBaseSession.RetrieveModel() , pfcBaseSession.CreateModelWindow() , and pfcModel.Display() . Exceptions thrown (but not limited to): pfcXToolkitNotFound - This means either:
pfcXToolkitNoPermission - The function does not have permission to operate on this model. pfcXToolkitInvalidType - You specified an invalid object type. pfcXToolkitDeadLock - 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).
|
| string | PLMSInitialize | (string request) |
|
| /* optional */ pfcSelections | QueryFeatureEdit | () |
|
Find the list of features being displayed for modification, as is done in 'Edit' on a feature.
|
| pfcServer | 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): pfcXToolkitFound - A server with this alias or location/workspace is already registered. pfcXToolkitNotFound - The server couldn't be found at the given location. pfcXToolkitInvalidName - Authentication failed. pfcXToolkitInvalidDir - The workspace couldn't be found or created. pfcXToolkitNoLicense - There is no license to work with the server. pfcXToolkitInvalidType - The server version is not supported.
|
| pfcAssembly | RetrieveAssemSimpRep | (string AssemName, /* optional */ pfcSimpRepInstructions 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): pfcXToolkitNoPermission - The function does not have permission to operate on this assembly. pfcXToolkitNotFound - The function did not find the simplified representation in the solid.
|
| pfcPart | RetrieveGeometryPartRep | (string PartName) |
|
Retrieves the specified part's geometric simplified representation. Exceptions thrown (but not limited to): pfcXToolkitNotFound - The Part was not found. pfcXToolkitInvalidName - The specified user defined rep was not found. pfcXToolkitNoPermission - The function does not have permission to operate on this assembly.
|
| pfcAssembly | 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): pfcXToolkitNoPermission - The function does not have permission to operate on this assembly.
|
| pfcPart | RetrieveGraphicsPartRep | (string PartName) |
|
Retrieves the specified part's graphic simplified representation. Exceptions thrown (but not limited to): pfcXToolkitNotFound - The Part was not found. pfcXToolkitInvalidName - The specified user defined rep was not found. pfcXToolkitNoPermission - The function does not have permission to operate on this assembly.
|
| pfcAssembly | 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): pfcXToolkitNoPermission - The function does not have permission to operate on this assembly.
|
| pfcModel | RetrieveModel | (pfcModelDescriptor 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): pfcXToolkitNotFound - The model was not found in the current directory. pfcXToolkitNoPermission - The function does not have permission to operate on this model.
|
| pfcModel | RetrieveModelWithOpts | (pfcModelDescriptor MdlDescr, pfcRetrieveModelOptions 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): pfcXToolkitCantOpen - The model exists but is not readable. pfcXToolkitNotFound - The model does not exist, or was not found pfcXToolkitInvalidFile - The model is not a Creo Parametric model. pfcXToolkitInvalidName - The model name is too long. pfcXToolkitNoPermission - The function does not have permission to operate on this model.
|
| pfcPart | RetrievePartSimpRep | (string PartName, string RepName) |
|
Retrieves the specified part's user-defined simplified representation. Exceptions thrown (but not limited to): pfcXToolkitNotFound - The Part was not found. pfcXToolkitInvalidName - The specified user defined rep was not found. pfcXToolkitNoPermission - The function does not have permission to operate on this assembly.
|
| pfcPart | RetrieveSymbolicPartRep | (string PartName) |
|
Retrieves the specified part's symbolic simplified representation. Exceptions thrown (but not limited to): pfcXToolkitNotFound - The Part was not found. pfcXToolkitInvalidName - The specified user defined rep was not found. pfcXToolkitNoPermission - The function does not have permission to operate on this assembly.
|
| pfcAssembly | 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): pfcXToolkitNoPermission - The function does not have permission to operate on this assembly.
|
| 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.
|
| /* optional */ pfcSelections | Select | (pfcSelectionOptions Options, /* optional */ pfcSelections InitialSels) |
|
Allows interactive selection of objects in Creo Parametric. Exceptions thrown (but not limited to): pfcXToolkitUserAbort - The user chose Quit. pfcXToolkitPickAbove - Selection was interrupted by a user's pick on any button from above menus. pfcXToolkitDeadLock - 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).
|
| void | SetConfigOption | (string Name, string Value) |
|
Sets the value of the specified configuration file option. Exceptions thrown (but not limited to): pfcXToolkitNotFound - The specified option was not found.
|
| 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 pfcServer.ActiveWorkspace instead. Exceptions thrown (but not limited to): pfcXToolkitBusy - When another workspace is already registered, cannot de-register because there are objects in Creo Parametric session.
|
| pfcStdLineStyle | SetLineStyle | (pfcStdLineStyle NewStyle) |
|
Sets the line style. Exceptions thrown (but not limited to): pfcXToolkitNoChange - The new line style is the same as the old line style.
|
| void | SetStdColorFromRGB | (pfcStdColor StdClr, pfcColorRGB Color) |
|
Enables you to set the values of the three color components for a standard color in Creo Parametric.
|
| pfcStdColor | SetTextColor | (pfcStdColor 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): pfcXToolkitNoChange - The current color is the same as the new color.
|
| void | SetWSExportOptions | (pfcWSExportOptions Options) |
|
Sets the option controlling whether or not to export secondary contents during a call to pfcBaseSession.ExportFromCurrentWS()
|
| pfcJLinkApplication | 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. Exceptions thrown (but not limited to): pfcXToolkitUserAbort - The application failed to start properly. See the startup exception for more details. pfcXToolkitAmbiguous - The application class is already registered as another application, with different start and/or stop methods. pfcXToolkitInUse - The application with this configuration is already loaded, and may not be loaded again. pfcXToolkitCantWrite - Creo Parametric will not accept any more auxiliary applications at this time.
|
| void | WLBInitialize | (boolean val) |
|