LocateObject Subroutine

Searches a Picture for the specified object and selects the object.

Syntax

LocateObjectLinkName, bRelative, [intErrorMode]

Properties

The LocateObject subroutine syntax has these parts:

Part

Description

LinkName

String. The name of the object for which you want to search.

 

bRelative

Boolean. If True, the current picture is searched; if False, all open pictures are searched.

intErrorMode

Integer. (Optional). The error mode.
0 (default) – Allows the subroutines to provide the error messages. Errors are displayed in the form of a message box. If no entry is made for the intErrorMode parameter, the default is used.

2 – Allows the user to handle the error messages. Errors in the subroutines are passed back to the calling routine for handling.

3 – Writes errors to all destinations. No error messages display. Instead, the errors are written to all iFIX destinations, including the Alarm History window destinations using SendOperatorMessage.

 

Example