[ library(instrument) | Reference Manual | Alphabetic Index ]

get_callsite_data(+SiteId, ?UserData)

Retrieve data associated with an instrumentation callsite from its non-logical store.
Valid Prolog term


Each code instrumentation point within a file is uniquely identified by its callsite identifier. The callsite identifier is a monotonically increasing integer incrementing from the initial value of 0 for a new module.

The predicate retrieves the data (a valid Prolog term) that has been associated with the specified instrumentation callsite within a module or file.

The data is stored in a non-logical store and can be stored using instrument:set_callsite_data/2.

The predicate is a tool and data for a callsite of a module other than the current calling module context can be retrieved by invoking get_callsite_data(SiteId, UserData)@Module.


This predicate is sensitive to its module context (tool predicate, see @/2).

Fail Conditions

Data has not been stored for callsite identifier SiteId.




(4) instantiation fault
SiteId is not instantiated.
(5) type error
SiteId is not an integer.

See Also

file_callsites / 3, instrument / 2, instrument / 3, library(instrument), module_callsites / 2, set_callsite_data / 2, struct(itemplate), defined_modules / 2