CIP JAVA documentation for class "com.ptc.pfc.pfcProToolkit.Dll"

Interface Dll

package com.ptc.pfc.pfcProToolkit; public interface Dll extends com.ptc.pfc.pfcObject.Child

Description

This interface represents a Creo Parametric TOOLKIT DLL.

See Also:: BaseSession.GetProToolkitDll(String), BaseSession.LoadProToolkitDll(String, String, String, boolean)

Method Summary
`FunctionReturn`	`CallFunction (String FunctionName, Arguments InputArguments, ToolkitType UsedToolkit)`
`FunctionReturn`	`ExecuteFunction (String FunctionName, Arguments InputArguments)` Causes Creo Parametric to call a function in a Creo Parametric TOOLKIT DLL application.
`String`	`GetId ()` Get method for attribute "Id" The DLL identifier string. Use `BaseSession.GetProToolkitDll(String)` to obtain a DLL handle using this string.
`boolean`	`IsActive ()` Helper method for determining if application that this `Dll` object has been unloaded.
`void`	`Unload ()` Unloads a previously loaded DLL application.

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Child`
`GetDBParent`, `GetOId`

Method Detail

ExecuteFunction

FunctionReturn ExecuteFunction (String FunctionName, Arguments InputArguments)

Causes Creo Parametric to call a function in a Creo Parametric TOOLKIT DLL application.

The function must have a signature matching ProTkdllFunction in ProToolkitDll.h. The function must be exported using the proper macros, functions, and linker options that allow Creo Parametric to call the function. See the Creo Parametric TOOLKIT User's Guide and ProToolkitDll.h for more details.

Exceptions thrown (but not limited to):

XToolkitBadContext - application handle is valid but the app was not running.

XToolkitUserAbort - The DLL function returned something besides correct value. Check pfcFunctionReturn values for more details.

XToolkitNotFound - The function named could not be found and called.

XToolkitInvalidPtr - One or more of the function argument arrays contain value data of type pfcARG_V_POINTER.

XToolkitDllInactive - Application handle is not active

See Also:: BaseSession.LoadProToolkitDll(String, String, String, boolean), pfcArgument.Argument_Create(String, ArgValue)

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

Parameters:

FunctionName: The function name.
InputArguments: Sequence of input argument name-value pairs to be passed to the function.

Returns:: The function return value, as integer, and the output arguments passed back from the function call.

CallFunction

FunctionReturn CallFunction (String FunctionName, Arguments InputArguments, ToolkitType UsedToolkit)

Exceptions thrown (but not limited to):

XToolkitBadContext - application handle is valid but the app was not running.

XToolkitUserAbort - The DLL function returned something besides

XToolkitNotFound - The function named could not be found and called.

XToolkitInvalidPtr - One or more of the function argument arrays contain value data of type pfcARG_V_POINTER. These structures cannot be transferred.

Parameters:

FunctionName
InputArguments
UsedToolkit

Returns:

Unload

void Unload ()

Unloads a previously loaded DLL application.

You are only permitted to unload applications that you previously loaded with BaseSession.LoadProToolkitDll(String, String, String, boolean).

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

Returns:

IsActive

boolean IsActive ()

Helper method for determining if application that this Dll object has been unloaded.

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

Returns:: Whether or not the application has been unloaded.

GetId

String GetId ()

The DLL identifier string. Use BaseSession.GetProToolkitDll(String) to obtain a DLL handle using this string.

Exceptions thrown (but not limited to):

XToolkitBadContext - application handle is valid but application was not running.

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