Library | File

Class pfcJLinkApplication

# include <pfcJLink.h>

class pfcJLinkApplication
 : public virtual pfcObject
{
    xaideclare(pfcJLinkApplication)
    ...
};



Description

 
Manual References:
Task Based Application Libraries: Launching Tasks from Creo Object TOOLKIT C++ Task Libraries



Method Summary

pfcArguments_ptrExecuteTask (xrstring TaskId, pfcArguments_ptr InputArguments)
Call a method in a J-Link application, with user-specified arguments.
xboolIsActive ()
Identifies if the application is currently running.
voidStop ()
Stop a previously loaded J-Link application. The application's stop method will be called.



Method Detail

pfcArguments_ptrExecuteTask (xrstring TaskId, pfcArguments_ptr InputArguments)

Call a method in a J-Link application, with user-specified arguments.

Exceptions thrown (but not limited to):

pfcXToolkitUserAbort - The application threw an exception. See the exception output argument for more details.

pfcXToolkitNotFound - The task could not be found.

pfcXToolkitBadContext - The handle is valid but the application is not active.

pfcXJLinkApplicationInactive - The application is not active.


Manual References:
Task Based Application Libraries: Launching Tasks from Creo Object TOOLKIT C++ Task Libraries, Task Based Application Libraries: Launching Tasks from Creo Object TOOLKIT C++ Task Libraries
Parameters:
TaskId
The string identifier for the task.
InputArguments
The input arguments for the method.
Returns:
The output arguments from the method.



voidStop ()

Stop a previously loaded J-Link application. The application's stop method will be called.

Exceptions thrown (but not limited to):

pfcXToolkitUserAbort - The application failed to shutdown properly. See the output exception for more details.

pfcXToolkitBusy - The application has menus or UI components active in the UI.

pfcXToolkitBadContext - The handle is valid but the application is not active.

pfcXJLinkApplicationInactive - The application is not active.


Manual References:
Task Based Application Libraries: Launching Tasks from Creo Object TOOLKIT C++ Task Libraries
Returns:



xboolIsActive ()

Identifies if the application is currently running.
Manual References:
Task Based Application Libraries: Launching Tasks from Creo Object TOOLKIT C++ Task Libraries, Task Based Application Libraries: Launching Tasks from Creo Object TOOLKIT C++ Task Libraries
Returns:
true if its running, false otherwise.