CIP JAVA documentation for class "com.ptc.pfc.pfcJLink.JLinkApplication"

Interface JLinkApplication

package com.ptc.pfc.pfcJLink; public interface JLinkApplication extends com.ptc.pfc.pfcObject.Object

Description

Method Summary
`Arguments`	`ExecuteTask (String TaskId, Arguments InputArguments)` Call a method in a J-Link application, with user-specified arguments.
`boolean`	`IsActive ()` Identifies if the application is currently running.
`void`	`Stop ()` Stop a previously loaded J-Link application. The application's stop method will be called.

Method Detail

ExecuteTask

Arguments ExecuteTask (String TaskId, Arguments InputArguments)

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

Exceptions thrown (but not limited to):

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

XToolkitNotFound - The task could not be found.

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

XJLinkApplicationInactive - The application is not active.

Manual References:: Task Based Application Libraries: Creating Creo Object TOOLKIT Java Task Libraries, Task Based Application Libraries: Creating Creo Object TOOLKIT Java Task Libraries

Parameters:

Stop

void Stop ()

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

Exceptions thrown (but not limited to):

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

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

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

XJLinkApplicationInactive - The application is not active.

Manual References:: Task Based Application Libraries: Creating Creo Object TOOLKIT Java Task Libraries

IsActive

boolean IsActive ()

Identifies if the application is currently running.

Manual References:: Task Based Application Libraries: Creating Creo Object TOOLKIT Java Task Libraries, Task Based Application Libraries: Creating Creo Object TOOLKIT Java Task Libraries