Cicode Programming Reference > Cicode Function Categories > Tag Functions > TagResolve

TagResolve

This function can be used to increment a reference count on a tag to keep it resolved, making it readily available to a client.

If a tag is held in a resolved state, it will not be evicted from the client even if it is not being used. This means a client does not need to locate the tag's associated I/O server when a read or write is required.

While this allows faster access to a tag, it should be only utilised for priority tags, as a large number of resolved tags will increase the amount of memory used.

You can use the function TagUnresolve to decrement the reference count.

Syntax

TagResolve(STRING TagName)

TagName:

The name of the tag or the equipment and item name (using equipment.item notation) associated with that tag to resolve (in the format "clusterName.tagName" or "clusterName.equipment.item" if you need to specify a cluster).

Note: If the tag name exceeds the length limit of 254 characters the hardware alarm "Tag name exceed length limit" will be raised.

Return Value

The returned integer is a handle to the tag that has been resolved, or -1 if an error occurred.

The specific error code is accessible by calling IsError().

Related Functions

TagUnresolve

See Also

Published June 2018