AssEquipParameters | Super Genie Functions

Cicode Programming Reference > Cicode Function Categories > Super Genie Functions > AssEquipParameters

AssEquipParameters

Associates a set of equipment parameters defined in Citect Studio System Model | Equipment | Runtime Parameters with a page. This association is only made for the next page you display (either in the current window or in a new window). You cannot create an association for a page that is already displayed.

Syntax

AssEquipParameters(hWin, sClusterName, sEquipmentName )

hWin:

The association will be created for the next page to display in the window specified here; enter the window number or:

-3 for the current window when the page is changed. The page can be changed by using the Page Cicode functions like PageDisplay, PageGoto, etc.
-2 for the next new window or page displayed.

sClusterName:

Specifies the name of the cluster in which the equipment resides. The cluster name is optional if you have one cluster or are resolving the tag via the page's current cluster context. The argument is enclosed in quotation marks "".

Resolution of the tag's cluster context occurs when the page is displayed. It is resolved to the page's cluster context, not the context in force when this function is called.

Note: The value field of the Equipment Runtime Parameters table can work like a tag reference when the Is Tag column is set to true or default.

It can contain Variable tag, or equipment and item name reference of a variable tag (using equipment.item notation) that will replace the Super Genie association. Partial tag names or equipment.item tag references can also be used.

The name of the tag can be prefixed by the name of the cluster for example, "ClusterName.Tag" or "ClusterName.Equipment.Item".

Return Value

0 (zero) if successful, otherwise an error code is returned.When using partial associations, an error 274 or 289 may be returned even though the association is successful, and can be ignored.

Related Functions

Ass, AssChain, AssMetadata, AssMetadataPage, AssMetadataPopup, AssMetadataWin, AssChainPage, AssChainPopUp, AssChainWin, AssChainWinFree, AssGetProperty, AssGetScale, AssInfo, AssInfoEx, AssPage, AssPopUp, AssScaleStr, AssTag, AssTitle, AssVarTags, AssWin

Example

// Associate equipment runtime parameters for equipment on Cluster1 called Pump1 with the next window

AssEquipParameters(-2, "Cluster1", "Pump1");