LibraryObjectPlace

Places a library object (a symbol or genie) on the active Citect SCADA graphics page at the default location (top left corner). This function will not succeed if the specified object is not found.

Syntax

LibraryObjectPlace(Project, Library, Object, GenieOrSymbol, Linked)

Project:

The name of the project that contains the object library you would like to source.

Library:

Specifies the library that contains the symbol or genie you would like to place on the active Citect SCADA graphics page.

Object:

The name of the symbol or genie you would like to place on the active Citect SCADA graphics page.

GenieOrSymbol:

Indicates whether the object you want to use is a symbol of a genie.

• 0 = Library type unknown (will automatically select genie or symbol)
• 1 = Genie
• 2 = Symbol

Linked:

If set to TRUE, the object will remain linked to the library it came from. (select TRUE for Genies). Can only be set to FALSE if GenieOrSymbol is set to 2 (Symbol).

Return Value

0 (zero) if successful, otherwise an error is returned.

Related Functions

LibraryObjectFirstProperty, LibraryObjectNextProperty, LibraryObjectPutProperty, LibraryObjectName

Example

' Adds an object to the current Citect SCADA graphics page
GraphicsBuilder.LibraryObjectPlace "include", "agitator", "agit_1_Pos1_g", 2, True
GraphicsBuilder.PositionAt 200, 200

Published June 2018