Technical Reference > Graphics Builder Automation Interface > Library Object Functions > LibraryObjectPlaceEx

LibraryObjectPlaceEx

Places a library object (a symbol or genie) on the active CitectSCADA graphics page at the specified location. This function will not succeed if the specified object is not found.

Syntax

LibraryObjectPlaceEx(Project, Library, Object, GenieOrSymbol, Linked, Xposition, YPosition)

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 CitectSCADA graphics page.

Object:

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

GenieOrSymbol:

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

Linked:

If set to TRUE, the object will remain linked to the library it came from. (Select TRUE for Genies).

Xposition:

Absolute X position in pixels from the left hand side of the page.

YPosition:

Absolute Y position in pixels from the top of the page.

Return Value

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

Note: For details on handling return and error values, see Error Handling.

Related Functions

LibraryObjectFirstProperty, LibraryObjectNextProperty, LibraryObjectPutProperty, LibraryObjectName

Example

' Adds an object to the current graphics page at 200 pixels from the left and top
GraphicsBuilder.LibraryObjectPlaceEx "include", "agitator", "agit_1_Pos1_g", 2, True, 200, 200