Welcome to the Harris Geospatial product documentation center. Here you will find reference guides, help documents, and product libraries.


Harris Geospatial / Docs Center / IDL Reference / Programming and Control / IDL_IDLBridge::Cleanup

IDL_IDLBridge::Cleanup

IDL_IDLBridge::Cleanup

Syntax | Arguments | Keywords | Examples | Version History

The IDL_IDLBridge::Cleanup procedure method performs all cleanup when the bridge object is destroyed.

A program should ensure that a child process executing a command asynchronously has been completed or aborted before the associated IDL_IDLBridge object is destroyed. If you have started a process by calling the IDL_IDLBridge::Execute method with the NOWAIT keyword, you may want to wait for the process to become idle before destroying the bridge object.

When you call Cleanup, the following steps will occur:

Syntax


Obj->Cleanup

or

Obj->[IDL_IDLBridge::]Cleanup

or

OBJ_DESTROY, Obj

Arguments


None.

Keywords


None.

Examples


Ideally, a program should not destroy an IDL_IDLBridge object while an asynchronous command is busy. However, a cleanup method for child process that executes commands asynchronously should still include code to ensure an executing process is aborted or completed before it is destroyed.

For an IDL_IDLBridge object named oIDLBridge, use the following code to abort an executing process:

IF (oIDLBridge->Status() EQ 1)THEN oIDLBridge->Abort
OBJ_DESTROY, oIDLBridge

If you prefer to wait for the process to reach an idle state before destroying the bridge object, you can use code similar to the following:

WHILE (oIDLBridge->Status() NE 0) DO WAIT, 0.5
OBJ_DESTROY, oIDLBridge

Note: The IDL_IDLBridge::Status method returns status information for child processes executing commands asynchronously. A child process executing a command synchronously will only return a value of 0 (idle).

Version History


6.3

Introduced



© 2017 Exelis Visual Information Solutions, Inc. |  Legal
My Account    |    Buy    |    Contact Us