InterSystems IRIS Data Platform 2020.4 > Class Reference > %SYS namespace > Config.CommonSingleMethods

Config.CommonSingleMethods

persistent class Config.CommonSingleMethods extends %Library.Persistent, Config.CommonMethods

SQL Table Name: Config.CommonSingleMethods

This class contains methods which are inherited by other config classes.

Method Inventory (Including Private)

Methods (Including Private)

classmethod Get(ByRef Properties As %String, ByRef CPFFile As %String = "", Flags As %Integer = $$$CPFSave+$$$CPFWrite+$$$CPFActivate) as %Status [ Language = objectscript ]
Get a sections properties from a CPF file.

Parameters:
CPFFile (byref) - Name of the CPF file to use, Default=current active CPF file. The file must have a .CPF file extension if specified.

Return values:
Properties (byref) - List of the properties in Properties(Name)=Value format. See the subclass for a list of valid properties.
CPFFile (byref) - Name of the CPF file the modification was made in.
classmethod GetList(ByRef CPFFile As %String = "", Flags As %Integer = $$$CPFSave+$$$CPFWrite+$$$CPFActivate) as %Status [ Language = objectscript ]
Returns the properties from a section in a CPF file by value in $list format

Parameters:
CPFFile (byref) - Name of the CPF file to use, Default=current active CPF file. The file must have a .CPF file extension if specified.

Return value:
      $lb(%Status,Result)
      where Result=$LB($LB(property name,value),...) for each property in the section
classmethod Modify(ByRef Properties As %String, ByRef CPFFile As %String = "", Flags As %Integer = $$$CPFSave+$$$CPFWrite+$$$CPFActivate) as %Status [ Language = objectscript ]
Modify a sections properties in a CPF file.

Parameters:
Properties (byref) - List of the properties to modify in Properties(Name)=Value format. See the subclass for a list of valid properties. If a specific property is not passed in the properties array, the value is not modified.
CPFFile (byref) - Name of the CPF file to use, Default=current active CPF file. The file must have a .CPF file extension if specified.
Flags - Bit string of options to perform if the object is later saved with the %Save() method. See the Open() method for values.

Return values:
CPFFile (byref) - Name of the CPF file the modification was made in.
classmethod Open(ByRef CPFFile As %String = "", concurrency As %Integer = -1, ByRef Status As %Status, Flags As %Integer = $$$CPFSave+$$$CPFWrite+$$$CPFActivate) as %ObjectHandle [ Language = objectscript ]
Open an instance of an section object in a CPF file.

Parameters:
CPFFile (byref) - Name of the CPF file to use, Default=current active CPF file. The file must have a .CPF file extension if specified.
Flags - (From %syConfig.inc) Bit string of options to perform if the object is later saved with the %Save() method.
Bit $$$CPFSave - Save - Save data to config database.
Bit $$$CPFWrite - Write - Write config database to CPF file.
Bit $$$CPFActivate - Activate - Copy changes to ^CONFIG global, and make active on system.
By default, all these bits are set, and you should normally not pass this parameter. If you are modifying a CPF file which is not the active CPF file, Bit $$$CPFActivate is ignored.


Return Values:
CPFFile (byref) - Name of the CPF file the modification was made in.

Inherited Members

Inherited Methods (Including Private)

Storage

Storage Model: Storage (Config.CommonSingleMethods)

^Config.CommonSingleMethodsD(ID)
=
%%CLASSNAME

Subclasses

Feedback