Class Reference
Cache for UNIX 2018.1.3
InterSystems: The power behind what matters   
Documentation  Search
Private  Storage  

class Config.CommonSingleMethods extends Config.CommonMethods

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

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
12


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
Get GetList Modify Open
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType

Subclasses
Config.Cluster Config.ConfigFile Config.Conversions Config.ECP
Config.IO Config.Journal Config.MirrorMember Config.Miscellaneous
Config.Monitor Config.SQL Config.Startup Config.Telnet
Config.config

Methods

• classmethod Get(ByRef Properties As %String, ByRef CPFFile As %String = "", Flags As %Integer = $$$CPFSave+$$$CPFWrite+$$$CPFActivate) as %Status
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
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
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
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.


Copyright © 1997-2020, InterSystems Corporation