com.simplifiedlogic.nitro.jlink.impl

Class DllHandler

java.lang.Object

com.simplifiedlogic.nitro.jlink.impl.DllHandler

public class DllHandler
extends java.lang.Object

Utility class for handling the execution of external Pro/TOOLKIT DLL functions.

The normal workflow would be:
1) Call dllLoad() to load the library
2) Call dllFuncExec() to execute one or more functions
3) Call dllUnload() to remove the library from memory

Constructor Summary

Constructors

Constructor and Description
DllHandler()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	dllFuncExec(java.lang.String sessionId, java.lang.String dllid, java.lang.String funcname, java.util.Map<java.lang.String,java.lang.Object> args) Execute an function in an external Pro/TOOLKIT DLL.
java.lang.String	dllLoad(java.lang.String sessionId, java.lang.String dllname, java.lang.String path, java.lang.String textpath, boolean userDisplay) Load an external Pro/TOOLKIT DLL into memory
boolean	dllLoaded(java.lang.String sessionId, java.lang.String dllid) Check whether a DLL is still in memory.
void	dllUnload(java.lang.String sessionId, java.lang.String dllid) Remove an external Pro/TOOLKIT DLL from memory

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DllHandler

public DllHandler()

Method Detail

dllLoad

public java.lang.String dllLoad(java.lang.String sessionId,
                       java.lang.String dllname,
                       java.lang.String path,
                       java.lang.String textpath,
                       boolean userDisplay)
                         throws JLIException,
                                java.lang.Exception

Load an external Pro/TOOLKIT DLL into memory

Parameters:

sessionId - The JShell session ID

dllname - The name of the DLL

path - The system path to the DLL

textpath - The path to the directory containing text, menu, and resource files needed by the DLL, if any

userDisplay - Whether to add the library to the "Auxiliary Applications" dialog in Creo

Returns:

The ID of the loaded library, which is needed for other functions.

Throws:

JLIException

java.lang.Exception

dllUnload

public void dllUnload(java.lang.String sessionId,
             java.lang.String dllid)
               throws JLIException,
                      java.lang.Exception

Remove an external Pro/TOOLKIT DLL from memory

Parameters:

sessionId - The JShell session ID

dllid - The DLL's ID, gotten when dllLoad() was called

Throws:

JLIException

java.lang.Exception

dllLoaded

public boolean dllLoaded(java.lang.String sessionId,
                java.lang.String dllid)
                  throws JLIException,
                         java.lang.Exception

Check whether a DLL is still in memory.

Parameters:

sessionId - The JShell session ID

dllid - The DLL's ID, gotten when dllLoad() was called

Returns:

Whether the DLL is still in memory

Throws:

JLIException

java.lang.Exception

dllFuncExec

public java.util.Map<java.lang.String,java.lang.Object> dllFuncExec(java.lang.String sessionId,
                                                           java.lang.String dllid,
                                                           java.lang.String funcname,
                                                           java.util.Map<java.lang.String,java.lang.Object> args)
                                                             throws JLIException,
                                                                    java.lang.Exception

Execute an function in an external Pro/TOOLKIT DLL.

Parameters:

sessionId - The JShell session ID

dllid - The DLL's ID, gotten when dllLoad() was called

funcname - The function name to execute

args - A set of named arguments to be passed to the function

Returns:

A set of return values that were returned by the function, as well as a "dll_return" value which contains the integer returned by Creo itself.

Throws:

JLIException

java.lang.Exception