CIP JavaScript documentation for module-level class "MpfcCOMGlobal"

Class MpfcCOMGlobal

Method Summary


`pfcSession`	`GetProESession`	`()`
	Retrieves an object representing the current Creo Parametric session.

`stringseq`	`GetProEArguments`	`()`
	This method returns the command line arguments passed by Creo Parametric to the J-Link application. These arguments are the ones starting with +, where is any alphabetic character (A-Z, a-z), or -#, where # is any capital alphabetic character (A-Z).

`string`	`GetProEBuildCode`	`()`
	This method returns the Creo Parametric build code (for example, "2000010") of the invoking application.

`string`	`GetProEVersion`	`()`
	Returns the Creo Parametric version (for example, "Wildfire") of Creo Parametric.

`pfcScript`	`GetScript`	`()`

Method Detail

pfcSession GetProESession ()

Retrieves an object representing the current Creo Parametric session.

Exceptions thrown (but not limited to):

<reference 4 to unknown entity pfcExceptions::XNotConnectedToProE> - Connection is not Obtained

Returns:: The session object, which is the top level object used to access information in Creo Parametric.

stringseq GetProEArguments ()

This method returns the command line arguments passed by Creo Parametric to the J-Link application. These arguments are the ones starting with +*, where * is any alphabetic character (A-Z, a-z), or -#, where # is any capital alphabetic character (A-Z).

The arguments may only be accessed in synchronous mode.

Exceptions thrown (but not limited to):

<reference 4 to unknown entity pfcExceptions::XNotConnectedToProE> - Connection is not Obtained

Returns:: The array of command-line arguments.

string GetProEBuildCode ()

This method returns the Creo Parametric build code (for example, "2000010") of the invoking application.

This data may only be accessed in synchronous mode.

Exceptions thrown (but not limited to):

<reference 4 to unknown entity pfcExceptions::XNotConnectedToProE> - Connection is not Obtained

Returns:: The build code

string GetProEVersion ()

Returns the Creo Parametric version (for example, "Wildfire") of Creo Parametric.

This data is only accessible in synchronous mode.

Exceptions thrown (but not limited to):

<reference 4 to unknown entity pfcExceptions::XNotConnectedToProE> - Connection is not Obtained

Returns:: The Creo Parametric version

pfcScript GetScript ()

Returns: