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


  >  Docs Center  >  IDL Reference  >  Programming and Control  >  IDL_IDLBridge::Status

IDL_IDLBridge::Status

IDL_IDLBridge::Status

The IDL_IDLBridge::Status function method queries the state of an IDL_IDLBridge object. When the NOWAIT keyword is used with the IDL_IDLBridge::Execute method to execute IDL commands asynchronously, IDL_IDLBridge::Status can track the state of the child process.

Syntax


Result = Obj->[IDL_IDLBridge::]Status([ERROR=ErrorString])

Return Value


Returns an integer value indicating the status of the bridge object’s corresponding child process. Descriptive error messages are returned in the variable specified by the ERROR keyword. Possible values are:

Return Value

Description

What ERROR Keyword Returns

0

Idle

Empty string

1

Executing command

Empty string

2

Completed command

Empty string

3

Error halted execution

Descriptive error string

4

Aborted execution (IDL_IDLBridge::Abort)

Abort message

Arguments


None

Keywords


ERROR

A named variable that will contain a string value corresponding to the error that occurred while executing the command in the child process, if any. As shown in the Return Value table above, if IDL_IDLBridge::Status returns an error state (3), the ERROR keyword returns a descriptive error string. If this method returns an aborted status (4), ERROR contains an abort message. If any other status is returned, the ERROR keyword sets its variable to an empty string.

Examples


See the example, idlbridge_demo_object.pro, which is located in the examples/doc/bridges subdirectory of the IDL distribution. This example uses a CASE statement to determine what action to take based on information returned by the Status method. Run the example procedure by entering idlbridge_demo_object at the IDL command prompt or view the file in an IDL Editor window by entering .EDIT idlbridge_demo_object.pro.

Note: For examples that use a callback procedure in addition to the Status method, see Examples.

Version History


6.3

Introduced



© 2018 Harris Geospatial Solutions, Inc. |  Privacy Policy
My Account    |    Store    |    Contact Us