API Documentation > Interface Classes > Class pfcDll
Class pfcDll

# include <pfcProToolkit.h>

class pfcDll
: public virtual pfcChild
{
xaideclare(pfcDll)
...
};


Description
This interface represents a Creo Parametric TOOLKIT DLL.
See Also:
Method Summary
CallFunction (xrstring FunctionName, pfcArguments_ptr InputArguments, pfcToolkitType UsedToolkit)
ExecuteFunction (xrstring FunctionName, pfcArguments_ptr InputArguments)
Causes Creo Parametric to call a function in a Creo Parametric TOOLKIT DLL application.
The DLL identifier string. Use pfcBaseSession::GetProToolkitDll(xrstring) to obtain a DLL handle using this string.
Helper method for determining if application that this pfcDll object has been unloaded.
void
Unloads a previously loaded DLL application.
Methods Inherited from Class pfcChild::
Method Detail
ExecuteFunction
(xrstring FunctionName, pfcArguments_ptr 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):
pfcXToolkitBadContext - application handle is valid but the app was not running.
pfcXToolkitUserAbort - The DLL function returned something besides correct value. Check pfcFunctionReturn values for more details.
pfcXToolkitNotFound - The function named could not be found and called.
pfcXToolkitInvalidPtr - One or more of the function argument arrays contain value data of type pfcARG_V_POINTER.
pfcXToolkitDllInactive - Application handle is not active
See Also:
Manual References:
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
(xrstring FunctionName, pfcArguments_ptr InputArguments, pfcToolkitType UsedToolkit)
Exceptions thrown (but not limited to):
pfcXToolkitBadContext - application handle is valid but the app was not running.
pfcXToolkitUserAbort - The DLL function returned something besides
pfcXToolkitNotFound - The function named could not be found and called.
pfcXToolkitInvalidPtr - 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:
void
Unload
()
Unloads a previously loaded DLL application.
You are only permitted to unload applications that you previously loaded with pfcBaseSession::LoadProToolkitDll(xrstring, xrstring, xrstring, xbool).
Manual References:
Returns:
IsActive
()
Helper method for determining if application that this pfcDll object has been unloaded.
Manual References:
Returns:
Whether or not the application has been unloaded.
GetId
()
The DLL identifier string. Use pfcBaseSession::GetProToolkitDll(xrstring) to obtain a DLL handle using this string.
Exceptions thrown (but not limited to):
pfcXToolkitBadContext - application handle is valid but application was not running.
Manual References:
Was this helpful?