Config.IO

persistent class Config.IO extends %Library.Persistent, Config.CommonSingleMethods, Config.CommonProperties, %SYSTEM.Help [ Final ]

SQL Table Name: Config.IO

This class allows you to modify and view the [IO] section of the CPF file through programatic APIs. While properties are usually modified through the System Management portal, there may be some occasion where modifying them through the API's is best for your system. In all the Config methods, if you do not specify the CPFFile parameter, the currently active CPF file is used. If you wish to modify a CPF file which is not the currently active one, then specify the CPFFile you wish to modify in the method call.
The Flags parameter does not normally need to be specified; the defaults are usually sufficient for most cases.
You can use either the provided API's (Get/Modify) to modify the properties by passing in the correct parameters, or use Object syntax to open and directly manipulate the config objects.

EXAMPLE:

; Use class methods to modify properties
%SYS>s Status=##Class(Config.IO).Get(.Properties)
%SYS>i 'Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status)
%SYS>zw Properties
Properties("File")="^%X364"
Properties("MagTape")="^%XMAG"
Properties("Other")="^%X364"
Properties("Terminal")="^%X364"
%STS>s Properties("Terminal")="^%XMYROUTINE"
%SYS>s Status=##Class(Config.IO).Modify(.Properties)
%SYS>i 'Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status)
; Now use Objects to modify properties
%SYS>s Obj=##Class(Config.IO).Open()
%SYS>w Obj.Terminal
^%XMYROUTINE
%SYS>s Obj.Terminal=^%ZMYROUTINE
%SYS>s Status=Obj.%Save()
%SYS>i 'Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status)

Property Inventory

• File
• MagTape
• Other
• Terminal

Properties

property File as %String (MAXLEN = 32, MINLEN = 1) [ InitialExpression = "^%X364" , Required ];

Routine to use in WRITE commands for sequential files.

Property methods: FileDisplayToLogical(), FileGet(), FileGetStored(), FileIsValid(), FileLogicalToDisplay(), FileLogicalToOdbc(), FileNormalize(), FileSet()

property MagTape as %String (MAXLEN = 32, MINLEN = 1) [ InitialExpression = "^%XMAG" , Required ];

Routine to use in WRITE commands for magnetic tapes.

Property methods: MagTapeDisplayToLogical(), MagTapeGet(), MagTapeGetStored(), MagTapeIsValid(), MagTapeLogicalToDisplay(), MagTapeLogicalToOdbc(), MagTapeNormalize(), MagTapeSet()

property Other as %String (MAXLEN = 32, MINLEN = 1) [ InitialExpression = "^%X364" , Required ];

Routine to use in WRITE commands for Other devices.

Property methods: OtherDisplayToLogical(), OtherGet(), OtherGetStored(), OtherIsValid(), OtherLogicalToDisplay(), OtherLogicalToOdbc(), OtherNormalize(), OtherSet()

property Terminal as %String (MAXLEN = 32, MINLEN = 1) [ InitialExpression = "^%X364" , Required ];

Routine to use in WRITE commands for terminals.

Property methods: TerminalDisplayToLogical(), TerminalGet(), TerminalGetStored(), TerminalIsValid(), TerminalLogicalToDisplay(), TerminalLogicalToOdbc(), TerminalNormalize(), TerminalSet()

Indexes

index (CPFNameSectionHeaderName on CPFName,SectionHeader,Name) [IdKey, Type = key, Unique];

Index methods: CPFNameSectionHeaderNameCheck(), CPFNameSectionHeaderNameDelete(), CPFNameSectionHeaderNameExists(), CPFNameSectionHeaderNameOpen(), CPFNameSectionHeaderNameSQLCheckUnique(), CPFNameSectionHeaderNameSQLExists(), CPFNameSectionHeaderNameSQLFindPKeyByConstraint(), CPFNameSectionHeaderNameSQLFindRowIDByConstraint()

Inherited Members

Inherited Properties

• CPFFile
• Comments
• Flags
• Name

Inherited Methods

• %%CLASSNAMELogicalToStorage()
• %%CLASSNAMEStorageToLogical()
• %AddToSaveSet()
• %AddToSyncSet()
• %BMEBuilt()
• %BuildIndicesAsync()
• %BuildIndicesAsyncResponse()
• %CheckConstraints()
• %CheckConstraintsForExtent()
• %ClassIsLatestVersion()
• %ClassName()
• %ComposeOid()
• %ConstructClone()
• %Delete()
• %DeleteExtent()
• %DeleteId()
• %DispatchClassMethod()
• %DispatchGetModified()
• %DispatchGetProperty()
• %DispatchMethod()
• %DispatchSetModified()
• %DispatchSetMultidimProperty()
• %DispatchSetProperty()
• %Exists()
• %ExistsId()
• %Extends()
• %GUID()
• %GUIDSet()
• %GetLock()
• %GetParameter()
• %GetSwizzleObject()
• %Id()
• %InsertBatch()
• %IsA()
• %IsModified()
• %IsNull()
• %KillExtent()
• %KillExtentData()
• %LoadFromMemory()
• %LockExtent()
• %LockId()
• %New()
• %NormalizeObject()
• %ObjectIsNull()
• %ObjectModified()
• %Oid()
• %OnBeforeAddToSync()
• %OnDeleteFinally()
• %OnDetermineClass()
• %OnOpenFinally()
• %OnSaveFinally()
• %Open()
• %OpenId()
• %OriginalNamespace()
• %PackageName()
• %PhysicalAddress()
• %PurgeIndices()
• %Reload()
• %RemoveFromSaveSet()
• %ResolveConcurrencyConflict()
• %RollBack()
• %Save()
• %SaveDirect()
• %SaveIndices()
• %SerializeObject()
• %SetModified()
• %SortBegin()
• %SortEnd()
• %SyncObjectIn()
• %SyncTransport()
• %UnlockExtent()
• %UnlockId()
• %ValidateIndices()
• %ValidateObject()
• %ValidateTable()
• Get()
• GetList()
• Help()
• Modify()
• Open()
• XMLDTD()
• XMLExport()
• XMLExportToStream()
• XMLExportToString()
• XMLNew()
• XMLSchema()
• XMLSchemaNamespace()
• XMLSchemaType()

Storage

Storage Model: Storage (Config.IO)

^|"^^"_$ZU(12)|SYS("CONFIG")(ID)

=

%%CLASSNAME Comments File MagTape Other Terminal