Launching a Creo TOOLKIT DLL
The methods described in this section enable a Creo Object TOOLKIT C++ user to register and launch a Creo TOOLKIT DLL from a Creo Object TOOLKIT C++ application.
Methods Introduced:
Use the method
pfcBaseSession::LoadProToolkitDll to register and start a
Creo TOOLKIT DLL. The input parameters of this method are similar to the fields of a registry file and are as follows:
• ApplicationName—The name of the application to initialize.
• DllPath—The full path to the DLL binary file.
• TextPath—The path to the application’s message and user interface text files.
• UserDisplay—Set this parameter to true to register the application in the Creo user interface and to see error messages if the application fails. If this parameter is false, the application will be invisible to the user.
The application's user_initialize() function is called when the application is started. The method returns a handle to the loaded Creo TOOLKIT DLL.
In order to register and start a legacy
Pro/TOOLKIT DLL that is not Unicode-compliant, use the method
pfcBaseSession::LoadProToolkitLegacyDll. This method conveys to
Creo+ that the loaded DLL application is not Unicode-compliant and built in the pre-
Wildfire 4.0 environment. It takes the same input parameters as the earlier method
pfcBaseSession::LoadProToolkitDll.
Use the method
pfcBaseSession::GetProToolkitDll to obtain a
Creo TOOLKIT DLL handle. Specify the
Application_Id, that is, the DLL’s identifier string as the input parameter of this method. The method returns the DLL object or null if the DLL was not in session. The
Application_Id can be determined as follows:
• Use the function ProToolkitDllIdGet() within the DLL application to get a string representation of the DLL application. Pass NULL to the first argument of ProToolkitDllIdGet() to get the string identifier for the calling application.
• Use the
Get method for the
Id attribute in the DLL interface. The method
pfcDll::GetId returns the DLL identifier string.
Use the method
pfcDll::ExecuteFunction to call a properly designated function in the
Creo TOOLKIT DLL library. The input parameters of this method are:
• FunctionName—Name of the function in the Creo TOOLKIT DLL application.
• InputArguments—Input arguments to be passed to the library function.
The method returns an object of interface pfcFunctionReturn. This interface contains data returned by a Creo TOOLKIT function call. The object contains the return value, as integer, of the executed function and the output arguments passed back from the function call.
The method
pfcDll::IsActive determines whether a
Creo TOOLKIT DLL previously loaded by the method
pfcBaseSession::LoadProToolkitDll is still active.
The method
pfcDll::Unload is used to shutdown a
Creo TOOLKIT DLL previously loaded by the method
pfcBaseSession::LoadProToolkitDll and the application's
user_terminate() function is called.