Category External tasks, Object ProJlink

Function ProJlinkApplicationStart


Description
Register and start a J-Link application.
Replacement in Object TOOLKIT: pfcBaseSession::StartJLinkApplication
Synopsis
#include <ProJlink.h>
ProErrorProJlinkApplicationStart(
ProName app_name
/* (In)
The application name.
*/
ProCharPath java_app_class
/* (In)
The application Java class.
*/
ProCharPath java_app_start
/* (In)
Static method used to intialize the application.
*/
ProCharPath java_app_stop
/* (In)
Static method used to terminate the application.
*/
ProCharPath java_app_add_classpath
/* (In)
Additional elements to be added to the front of the system CLASSPATH. Can be NULL. If more than one path is being added, they must be separated using the appropriate path separator (';' on Windows and ':' on UNIX).
*/
ProCharPath text_dir
/* (In)
The application text path for menus and messaging. If NULL, the function uses the current directory.
*/
ProBoolean user_display
/* (In)
PRO_B_TRUE to show application startup failure messages to the user, and to show the application in the Auxiliary Applications dialog.
*/
ProJlinkAppHandle* handle
/* (Out)
Handle to the Jlink application.
*/
char ** startup_exception
/* (Out)
If the application start method threw an exception, the exception description is stored here. Free this string using ProStringFree. Pass NULL if you are not interested in this information.
*/
)
Returns
PRO_TK_NO_ERRORInitialization succeeded.
PRO_TK_BAD_INPUTSOne or more arguments are invalid.
PRO_TK_USER_ABORTThe application failed to start properly. See the startup exception for more details.
PRO_TK_GENERAL_ERRORInitialization failed. See the startup exception for more details.
PRO_TK_E_AMBIGUOUSThe application class is already registered as another application, with different start and/or stop methods.
PRO_TK_E_IN_USEThe application with this configuration is already loaded, and may not be loaded again.
PRO_TK_CANT_WRITECreo Parametric will not accept any more auxiliary applications at this time.

Manual References:

  1. Task Based Application Libraries: Launching Synchronous J-Link Applications
  2. Task Based Application Libraries: Launching Synchronous J-Link Applications