Class Reference
IRIS for UNIX 2019.1
InterSystems: The power behind what matters   
Documentation  Search
  [%SYS] >  [Config] >  [ComPorts]
Private  Storage   

persistent class Config.ComPorts extends %Persistent, Config.CommonMultipleMethods, Config.CommonProperties, %SYSTEM.Help

This class allows you to modify and view the [ComPorts] 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 (Create/Get/Modify/Delete) to modify the properties by passing in the correct parameters, or use Object sytax to open and directly manipulate the config objects (Open() and Exists()). Most objects created here need only to specify the Name of the object, and 1 or 2 properties since the the defaults are what are commonly used for most cases.

EXAMPLE:

; Use class methods to create an instance
%SYS>s Name="COM5:"
%SYS>s Properties("BaudRate")=9600
%SYS>s Status=##Class(Config.ComPorts).Create(Name,.Properties)
%SYS>i 'Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status)
; Use class methods to modify properties
%SYS>s Status=##Class(Config.ComPorts).Get(Name,.Properties)
%SYS>i 'Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status)
%SYS>zw Properties("BaudRate")
Properties("BaudRate")=9600
%SYS>s Properties("BaudRate")=19200
%SYS>s Status=##Class(Config.ComPorts).Modify(Name,.Properties)
%SYS>i 'Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status)
; Now use Objects to modify properties
%SYS>s Obj=##Class(Config.ComPorts).Open(Name)
; We could have used i ##Class(Config.ComPorts).Exists(Name,.Obj) instead of Open()
%SYS>w Obj.BaudRate
19200
%SYS>s Obj.BaudRate=38400
%SYS>s Status=Obj.%Save()
%SYS>i 'Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status)
; Now delete the object we just created
%SYS>s Status=##Class(Config.ComPorts).Delete(Name)
%SYS>i 'Status w !,"Error="_$SYSTEM.Status.GetErrorText(Status)

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 8 1 1


Summary

Properties
BaudRate CPFFile Comments DTR DataBits
Flags FlowControl ModemControl Name Parity
StopBits ZAError

Methods
%AddToSaveSet %AddToSyncSet %BMEBuilt %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 %OnDetermineClass
%Open %OpenId %OriginalNamespace %PackageName
%PhysicalAddress %PurgeIndices %Reload %RemoveFromSaveSet
%ResolveConcurrencyConflict %RollBack %Save %SaveDirect
%SaveIndices %SerializeObject %SetModified %SortBegin
%SortEnd %SyncObjectIn %SyncTransport %UnlockExtent
%UnlockId %ValidateIndices %ValidateObject Create
Delete Exists Get GetList
Help Modify Open XMLDTD
XMLExport XMLExportToStream XMLExportToString XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType


Parameters

• parameter CAPITALNAME = 1;
Determines if the Name specified in the index should be capitalized.

Properties

• property BaudRate as %Integer [ InitialExpression = 19200,Required ];
Baud rate the comm port is set to.
110
300
600
1200
2400
4800
9600
14400
19200
38400
56000
57600
115200
128000
256000
• property DTR as %String(MAXLEN=1,MINLEN=1) [ InitialExpression = " ",Required ];
"0" - Disabled
"1" - Enabled
" " - Use Windows Setting
• property DataBits as %String(MAXLEN=1,MINLEN=1) [ InitialExpression = "8",Required ];
"5" - 5 Data Bits
"6" - 6 Data Bits
"7" - 7 Data Bits
"8" - 8 Data Bits< " " - Use Windows Setting
• property FlowControl as %String(MAXLEN=1,MINLEN=1) [ InitialExpression = " ",Required ];
"X" - Xon-Xoff
"C" - CTS-RTS
"D" - DSR-DTR
" " - Use Windows Setting
• property ModemControl as %String(MAXLEN=1,MINLEN=1) [ InitialExpression = " ",Required ];
"0" - Disabled
"1" - Enabled
" " - Use Windows Setting
• property Parity as %String(MAXLEN=1,MINLEN=1) [ InitialExpression = " ",Required ];
"0" - No Parity
"1" - Odd Parity
"2" - Even Parity
"3" - Mark Parity
"4" - Space Parity
" " - Use Windows Setting
• property StopBits as %String(MAXLEN=1,MINLEN=1) [ InitialExpression = " ",Required ];
"1" - 1 Stop Bit
"2" - 2 Stop Bits
"3" - 1.5 Stop Bits
" " - Use Windows Setting
• property ZAError as %String(MAXLEN=1,MINLEN=1) [ InitialExpression = " ",Required ];
"0" - Disabled
"1" - Enabled
" " - Windows Settings

Queries

• query List(Names As %String, CPFFile As %String = "", Flags As %Integer = 0, Format As %Integer = 0)
Selects Name As %String, ModemControl As %String, DataBits As %String, Parity As %String, StopBits As %String, FlowControl As %String, DTR As %String, ZAError As %String, BaudRate As %Integer
List ComPorts in a CPF file.

Parameters:
Names - Comma separated list of ComPort names
"*" - All records match
"String,String1" - Any records matching one of these elements
"String*" - Any record starting with "String"
"String,String1*,String2" - Any record matching one of these elements, or starting with "String1"
CPFFile - Name of the CPF file to use. A null string means use the active CPF file.
Flags - Currently ignored.
Format
0 - Standard report list format
1 - ^CONFIG global format
2 - CPF file format format
Note: This query may change in future versions

Indices

•index (CPFNameSectionHeaderName on CPFName,SectionHeader,Name) [IdKey,Unique];


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.