Skip to main content

%Studio.General

Class %Studio.General [ System = 3 ]

Collection of ClassMethods used by Studio

Methods​

GetStudioInfo​

ClassMethod GetStudioInfo() As %String

return $c(1) delimetered string p1 - %SYSTEM.Version.GetNumber() p2 - Is MVB installed p3 - Is Ensamble installed p4 - Is Activate available p5 - Is Other Enabled p6 - Feetback URL p7 - _$SYSTEM.Version.Format(4) p8 - ^%SYS("Studio","NoXecute") p9 - U2 Enabled. Bit 30

CheckDeveloperRole​

ClassMethod CheckDeveloperRole() As %Status

FeatureBits​

ClassMethod FeatureBits(bit As %Integer = "") As %Binary

ConstructCSPSession​

ClassMethod ConstructCSPSession(page As %String = "") As %String [ CodeMode = expression ]

Internal method to construct a CSP session with current security permissions and return the session id

ReturnCSPSessionId​

ClassMethod ReturnCSPSessionId(id As %String) As %String [ CodeMode = expression, Deprecated ]

Deprecated internal method to return the CSP session id of the session constructed with ConstructCSPSession. This is no longer needed as ConstructCSPSession returns the CSP sessionId directly now.

GetWebServerPort​

ClassMethod GetWebServerPort(ByRef port As %Integer, ByRef server As %String, ByRef urlprefix As %String, ByRef url As %String) As %Status

Return the port the InterSystems IRIS web server is running on or 0 if the web server is not active. Also returns the server name which is useful if the web server is running on a different machine. It can also return a urlprefix which is added to the url to goto at the start and is required if one web server is serving multiple InterSystems IRIS instances to differential between these versions. It also returns url which is the constructed url as a string, you just need to append the page you are going to request to this.

ServerIP​

ClassMethod ServerIP() As %String [ Private ]

Try to return the current servers IP address/name

KillProcess​

ClassMethod KillProcess(pid As %String) As %Status [ Internal ]

Execute​

ClassMethod Execute(%cmd As %String) [ ProcedureBlock = 0 ]

DumpObjectExecute​

ClassMethod DumpObjectExecute(ByRef qHandle As %Binary, oref As %String) As %Status

DumpObjectSlot​

ClassMethod DumpObjectSlot(ByRef qHandle As %String, oref As %String, ivar As %String, slot As %Integer)

DumpObjectClose​

ClassMethod DumpObjectClose(ByRef qHandle As %Binary) As %Status [ PlaceAfter = DumpObjectExecute ]

DumpObjectFetch​

ClassMethod DumpObjectFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) As %Status [ PlaceAfter = DumpObjectExecute ]

AnalyzeObjectPropertiesExecute​

ClassMethod AnalyzeObjectPropertiesExecute(ByRef qHandle As %Binary, oref As %String) As %Status

For each property of oref, return its name, value, $DATA(value), $ISOBJECT(value), $CLASSNAME(value) and if the property is calculated

AnalyzeObjectProperty​

ClassMethod AnalyzeObjectProperty(ByRef qHandle As %Binary, oref As %String, ivar As %String, pd As %String, type As %Integer)

AnalyzeObjectPropertyValues​

ClassMethod AnalyzeObjectPropertyValues(ByRef qHandle As %Binary, oref As %String, ivar As %String, slot As %Integer, refprop As %Boolean, type As %Integer)

AnalyzeObjectPropertiesClose​

ClassMethod AnalyzeObjectPropertiesClose(ByRef qHandle As %Binary) As %Status [ PlaceAfter = AnalyzeObjectPropertiesExecute ]

AnalyzeObjectPropertiesFetch​

ClassMethod AnalyzeObjectPropertiesFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) As %Status [ PlaceAfter = AnalyzeObjectPropertiesExecute ]

GetFileDateModified​

ClassMethod GetFileDateModified(filename As %String, utc As %Boolean = 0) As %String

Return the date last modified of file filename in %Timestamp format. By default this is local time, if you pass utc as true it returns it in UTC time

DecomposeStatus​

ClassMethod DecomposeStatus(status As %String) As %Status