%Studio.Global

class %Studio.Global extends %RegisteredObject

Provide interface to globals

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
12 2

Summary

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
GlobalListClose GlobalListExecute GlobalListFetch GlobalListFetchRows
Kill LocalListClose LocalListExecute LocalListFetch
LocalListFetchRows Set decode format

Methods

classmethod GlobalListClose(ByRef qHandle As %Binary) as %Status
classmethod GlobalListExecute(ByRef qHandle As %Binary, Node As %String, Pattern As %String = "", Format As %Boolean = 1) as %Status
classmethod GlobalListFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
classmethod GlobalListFetchRows(ByRef qHandle As %Binary, FetchCount As %Integer = 0, ByRef RowSet As %List, ByRef ReturnCount As %Integer, ByRef AtEnd As %Integer = 0) as %Status
classmethod Kill(Node As %String, KillSubs As %Boolean = 0) as %Status
Kill a global node. You pass it the name of the node and a flag to say if you want to kill subscripts or just this node and leave any subscripts.
classmethod LocalListClose(ByRef qHandle As %Binary) as %Status
classmethod LocalListExecute(ByRef qHandle As %Binary, Pid As %String, Node As %String, Pattern As %String = "", Format As %Boolean = 1) as %Status
classmethod LocalListFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
classmethod LocalListFetchRows(ByRef qHandle As %Binary, FetchCount As %Integer = 0, ByRef RowSet As %List, ByRef ReturnCount As %Integer, ByRef AtEnd As %Integer = 0) as %Status
classmethod Set(Node As %String, %Value As %String, ValFormat As %Integer) as %Status
Set a global node. You pass it the name of the node to set, along with the value to set and the values format and it sets this node.
classmethod decode(node As %String, ByRef output As %String) as %Integer
classmethod format(value As %String, ByRef output As %String, format As %Boolean = 1) as %Integer
Format the 'value' so it is readable and return the type of format we have used.

Queries

query GlobalList(Node As %String, Pattern As %String, Format As %Boolean = 1)
Selects Subscript As %String, Value As %String, Data As %Integer, ValueFormat As %Integer, SubscriptFormat As %Integer
Enumarate this global node and returning the $order items below this It takes the name of a global or local array to inspect including and initial subscripts. It returns the subscript name, the value and the $data of this node. Then it also returns the format of both the subscript and the data:
  • 1 - String format, this is the value of the value/subscript unaltered
  • 2 - ObjectScript format, the value has been converted into the ObjectScript representation for easy viewing, for example instead of showing the binary value a list is displayed as '$LB(1,"test")'
  • 3 - Not editable. Due to issues with the length of this data not all of it can be displayed so a portion is displayed
The Pattern parameter is supplied then it pattern matches on the data of each node and only display data that matches this pattern. The pattern match works the same as the Studio open dialog pattern matching and support both '*' which matches any number of characters and '?' which matches a single character operators. For example 'a*b' will match any string that starts with 'a' and ends with 'b'. If Format is 0 then do not format the resultset output.
query LocalList(Pid As %String, Node As %String, Pattern As %String = "", Format As %Boolean = 1)
Selects Subscript As %String, Value As %String, Data As %Integer, ValueFormat As %Integer, SubscriptFormat As %Integer
Copyright © 1997-2020 InterSystems Corporation, Cambridge, MA