In Section Instructions Examples Basics History Extra

Class documentation Device_dll

This chapter contains the following information:Public Enum

Class: Device

Class: Implement

Class: InfoToCreateVE

Class: Message

Class: MessagePack

In Section Instructions Examples Basics History Extra

Public Enum

This chapter contains the following information:Enum emLabelRunType

Enum uceSaveWireType

In Section Instructions Examples Basics History Extra

Enum emLabelRunType

Enum emLabelRunType

emcRunAsFirst = 0
' Calculating the label for the first time

emcRunAsNext = 1

' Calculating the label, use the old values

emcNotRun = 3

' Do not calculate label

In Section Instructions Examples Basics History Extra

Enum uceSaveWireType

This constant controls the following shortcut menu:

Interactive report, cable selection: "Cable > Disconnect / Disconnect (retain

wires) x / Disconnect (retain wires) y"

Enum uceSaveWireType

If a cable is placed on a connection line that is deleted, the user can decide via
the shortcut menu whether or not the cable information should remain at the
affected objects.

uccSaveWireNone = 0

The cable information is lost.

uccSaveWireOwn = 1

The wires and therefore the cable information is retained at its own connector.

uccSaveWirePartner = 2

The wires and therefore the cable information is retained at the partner connector.
If the wires are retained, the wire information is also visible in the terminal
strip editor and in the cable list.

In Section Instructions Examples Basics History Extra

Class: Device

This chapter contains the following information:Public Functions

Public Sub

Public Property

In Section Instructions Examples Basics History Extra

Public Functions

This chapter contains the following information:AImportXObjCreate

CDeviceChange

CheckByLocalCDevice

ConnectConnectors

ConnectionPossible

ContactFullName

ContactName

ControlTypeConverter

CopyObject

CreateDeviceObject
CreateDeviceObjectEx

CreateTemplate

CreateVE

DeleteConnectionForDevice

DeleteObject

DeviceNewByPrototype

DigitCountInName

DisconnectConnectors

DocumentAssume

DocumentsSearchAndAssume

ElementsCloseOrPaste

ElementsOrderByKoord

ElementsOrderByLabel

FirstNumberInString

GetCaptionForUnit

GetCDevicesByStructureGroup

GetCDevStruktCollection

GetChildsForNew

GetClassicTQBProgIdByControlType

GetComosObjectAcrossProjects

GetCObject

GetComosObject

GetConPossibleTable

GetControlType

GetDeviceByDocObj

GetDeviceLevel

GetIdentTextForComosObject

GetLabelWithVariable

GetMainDevice
GetStdControlType

GetTmpCollection

GetVlKpCollection

InheritCheckIn

IsControlTypeTopQueryBrowser

IsInheritCheckIn

IsMainDevice

IsImplementation

IsImplemented

IsObjectSystemRO

IsPropertyTranslatable

IsSetAllowed

IsSpecificationTranslatable

IsSpecInVisible

IsWriteAllowed

IsWriteAllowedByValue

LabelChangeStretch

LanguageDescription

LockedStatusText

MaxNumberInLabel

MaxNumberInLabels

MegaClass

NameMaske

NextForString

NextForStringLikeComos

NextNameForComosCollection

NextNameForDevice

NextNameLikeParameters

PasteObject

QueryXObjCreate
SearchDefaultCables

SearchOrIndexObject

SelectPointer

SetCableChannelForCable

SetImplementation

SetLabel

SetLocation

SetLock

SetName

SetObjectLabel

SetPointer

SetRunNumber

SetRunNumberForElement

SetSubObjbyCDevDesc

SetUnit

XObjInheritParent

In Section Instructions Examples Basics History Extra

AImportXObjCreate

Inactive

AImportXObjCreate ( ByVal XObjContainer as IComosBaseObject ) as Object

Only still contained in the dll for reasons of compatibility.

In Section Instructions Examples Basics History Extra

CDeviceChange

Switches the base object at an engineering object

CDeviceChange(ByVal Device As Object, ByVal CDevice As Object, Optional ByVal

RunType As emLabelRunType, Optional ByVal CheckMasks As Boolean = True) As Boolean

Parameter

Device

Is the engineering object for which the base object is switched.

CDevice

Is the new base object.

CheckMasks

Is optional and defines if the mask entries for name and label should be checked.

Return value

Boolean. Is "True" if the switch of the base object was successful.

In Section Instructions Examples Basics History Extra

CheckByLocalCDevice

Switches the base object at an engineering object

CheckByLocalCDevice ( ByVal CDevice as IComosDCDevice, ByVal ScreenMessages as
Boolean, ByVal CreateMessage as Boolean ) as IComosDCDevice

Parameter

CDevice (IComosDCDevice)

COMOS object of the system type CDevice

ScreenMessages (Boolean)

True: In case of an error the message is displayed in a MessageBox

False: In case of an error, a general output is effected, for example in DebugView

CreateMessage (Boolean)

True: In case of an error the message is entered in the COMOS error list The error
list is displayed by means of "Check" or "Object test".

False: No additional entry in the COMOS error list

Return value

Return is a base object from the @Local branch of the current object. The base
object must have a base object pointer to the specified base object.

Error case: If several base objects with a reference exist under @Local, the return
value is empty. Depending on the settings a message is output as a MessageBox or a
DebugView output for the end user.

In Section Instructions Examples Basics History Extra

ConnectConnectors

Connects two connectors with one another

ConnectConnectors(ByVal Connector1 As Object, ByVal Connector2 As Object, Optional
ByVal ScreenMessages As Boolean = True) As Boolean

Parameter

Connector1

Is the first connector.

Connector2

Is the second connector.

ScreenMessages

Defines if error messages are supposed to be displayed instantly or not.

Return value

Is "True" if both connectors were successfully connected with each other.

In Section Instructions Examples Basics History Extra

ConnectionPossible

Checks if two connectors can be connected with one another

ConnectionPossible(ByVal Connector1 As Object, ByVal Connector2 As Object, Optional

ByVal ScreenMessages As Boolean = True) As Integer

Parameter

Connector1

Is the first connector.

Connector2

Is the second connector.

ScreenMessages

Is optional and defines if error messages are to be displayed instantly or not.

Return value

If the connection is possible.

-1

If it is an undefined error.

If they are the same connections.

If the connections have different layers.

If the connections have different categories.

If the connections own differing wirings.

If one or both connections are already occupied.

6

If one or both connections are not part of the engineering object.

In Section Instructions Examples Basics History Extra

ContactFullName

Returns the AliasFullLabel of the connector

ContactFullName ( ByVal Connector as Object, Optional ByVal Device as Variant ) as

String

Parameter

Connector (Object)

The COMOS object of the Connector system class

Device (Object)

The owner object of the Connector object

Return

Returns the AliasFullLabel of the specified connector in the following format:

<Connector.AliasFullLabel>[ (<Owner_Object.Name>) ]

The part in brackets is optional and is only output under following basic
conditions:

User has Administrator rights

Owner objects have the Element class

The "owner" in this case is either the specified device or the logical owner.

In Section Instructions Examples Basics History Extra

ContactName

Returns the name of the connector

ContactName ( ByVal Connector as Object ) as String

Parameter

Connector (Object)

The COMOS object of the Connector system class

Return

Returns the name of the specified connector as it is shown in the connector list.

Evaluation sequence: Own identification, identification of the owner, description,

name. If the type is not IComosDConnector or the return value contains an @, the
return value is an empty string.

In Section Instructions Examples Basics History Extra

ControlTypeConverter

Internal

ControlTypeConverter ( ByVal progId as String ) as String

Allocation of component ID according to the old scheme to the component ID

according to the new scheme
In Section Instructions Examples Basics History Extra

CopyObject

Inactive

CopyObject ( ByVal ObjectToCopy as Object ) as Object

Only still contained in the dll for reasons of compatibility.

In Section Instructions Examples Basics History Extra

CreateDeviceObject

Creates an engineering object

CreateDeviceObject(ByVal Owner As Object, ByVal CDevice As IComosDCDevice, Optional

ByVal Name As String, Optional ByVal Class As String, Optional ByVal Unit As
IComosBaseObject, Optional ByVal Location As IComosBaseObject) As Object

Parameter

Owner

The owner of the object.

CDevice

Is the base object.

Name
Is optional and returns the name of the object.

Unit

Is optional and sets the possible unit pointer.

Location

Is optional and sets the possible location pointer.

Return value

The new engineering object.

In Section Instructions Examples Basics History Extra

CreateDeviceObjectEx

Creates an engineering object

CreateDeviceObjectEx(ByVal Owner As Object, ByVal CDevice As IComosDCDevice,

Optional ByVal Name As String, Optional ByVal Class As String, Optional ByVal Unit
As IComosBaseObject, Optional ByVal Location As IComosBaseObject, Optional ByVal
WithMsg As Boolean = True) As Object

Parameter

Owner

The owner of the object.

CDevice

Is the base object.

Name

Is optional and returns the name of the object.

Unit

Is optional and sets the possible unit pointer.

Location

Is optional and sets the possible location pointer.

WithMsg

Is optional and defines if an error message is to be displayed.

Return value

The new engineering object.

In Section Instructions Examples Basics History Extra

CreateTemplate

Copies an assembly group

CreateTemplate(ByVal Owner As IComosBaseObject, ByVal TemplateOwner As

IComosDDevice, Optional ByVal CDevice As IComosDCDevice = Nothing) As Collection

Parameter

Owner

The object underneath which the assembly group is inserted.

TemplateOwner

Imports the by the TemplateOwner stated assembly group.

CDevice

Is used in order to decide if the create option "Normal" or "Block" is used. This
parameter is only used if it is set.

Return value

A new collection with newly created root objects.

In Section Instructions Examples Basics History Extra

CreateVE

Internal

CreateVE ( ByVal CreateCount as Integer, ByVal MaxNumbers as _Collection, ByVal

ElementsOwner as IComosBaseObject, ByVal VEInfos as _Collection ) as _Collection

Internal.

In Section Instructions Examples Basics History Extra

DeleteConnectionForDevice

Dissolves the connection for the engineering object

DeleteConnectionForDevice(ByVal DeviceObject As Object, ByVal ConnectorsLayer As
String, Optional ByVal Side As String)

Parameter

DeviceObject

Is the engineering object.

ConnectorsLayer

The connector type that needs to be dissolved.

Side

Optional. Is the connection side: Input, Output or all ("I", "O", "").

Return value

No

In Section Instructions Examples Basics History Extra

DeleteObject

Deletes the specified object

DeleteObject ( ByVal ObjectToDelete as Object ) as Boolean

Parameter

ObjectToDelete (Object)

The COMOS object to be deleted

Supported types:

IComosDDevice

The device cannot be deleted in the following cases:

The device is placed on at least one document

or

The device possesses at least one element that is placed on at least one document.

IComosDDocObj

If the object exists and the rights are available, the DocObj is deleted.

A MessageBox with an error message is displayed for other types.

Return value

True: Object deleted

False: All other cases

In Section Instructions Examples Basics History Extra

DeviceNewByPrototype

Creates a new engineering object according to the structure of an already existing

engineering object

The new engineering object which is created has the same base object, the same unit
pointer, the same location pointer and the same specification values as the
prototype.
DeviceNewByPrototype(ByVal Prototype As IComosDDevice) As IComosDDevice

Parameter

Prototype

An existing engineering object.

Return value

A new engineering object.

In Section Instructions Examples Basics History Extra

DigitCountInName

Inactive

DigitCountInName ( ByVal ComosObject as Object ) as Integer

Only still contained in the dll for reasons of compatibility.

In Section Instructions Examples Basics History Extra

DisconnectConnectors

Dissolves the connection between two connectors

DisconnectConnectors(ByVal CurrentConnector As IComosDConnector, Optional ByVal

PartnerCon As IComosDConnector, Optional ByVal SaveWireType As uceSaveWireType =
uccSaveWireNone) As Boolean

Parameter

CurrentConnector

Is the connection.

PartnerCon

Optional. Is the second connector.

SaveWireType

Optional. Defines if also the wires that are part of the connection are supposed to
be dissolved.

See also section Enum uceSaveWireType.

Return value

Is "True" if the operation was successful.

In Section Instructions Examples Basics History Extra

DocumentAssume

Inactive

DocumentAssume ( ByVal OwnerObject as IComosBaseObject, ByVal Document as Object )

as Object

Parameter

OwnerObject (IComosBaseObject)

The owner of the document to be created

Document (Object)

The template of the document to be created

The following cases can occur when the document is created:

The document is to be created under a document.

Document packages

DVM documents

A new document is always created. The function is called recursively for the
documents under the new document.

All other cases

The document is created under the new owner by inserting the template.

In Section Instructions Examples Basics History Extra

DocumentsSearchAndAssume

Creates all predefined documents for a given engineering object

DocumentsSearchAndAssume(ByVal Device As Object)

Parameter

Device

Is the engineering object.

Return value

No

In Section Instructions Examples Basics History Extra

ElementsCloseOrPaste

Inactive

ElementsCloseOrPaste ( ByVal WType as String, ByVal MainDevice as Object, ByVal

Level as Integer, ByVal Class as String, Optional ByVal Number1 as Integer,
Optional ByVal Number2 as Integer ) as Variant

Only still contained in the dll for reasons of compatibility.

In Section Instructions Examples Basics History Extra

ElementsOrderByKoord

Sorts elements

ElementsOrderByKoord ( ByRef CurrentDevice as Object, ByRef SortType as String ) as

Variant

Parameter

CurrentDevice (Object)

The owner whose elements are examined

SortType (String)

Sorting procedure. Allowed values:

XY

YX

The function executes the following steps:

Acquisition of the placed elements of the CurrentDevice of the first level

Saving of the old names and identifiers

Sorting of the elements in accordance with the placement of the document

Sorting is effected in the XY-direction or the YX-direction depending on the

SortType

Reassignment of the names and identifiers in accordance with the old order of the
names

Gaps are not closed.

Application example: Terminal strip sorting.

In Section Instructions Examples Basics History Extra

ElementsOrderByLabel

Sorts elements

ElementsOrderByLabel ( ByVal CurrentDevice as Object ) as Variant

Parameter

CurrentDevice (Object)

The owner whose elements are examined

The function executes the following steps:

Acquisition of the placed elements of the CurrentDevice of the first level

Saving of the old names and identifiers

Sorting of the elements in accordance with the order of the identifiers

Reassignment of the names and identifiers in accordance with the old order

Gaps are not closed.

Application example: Terminal strip sorting.

In Section Instructions Examples Basics History Extra

FirstNumberInString

Returns the first number

FirstNumberInString ( ByVal CurrentString as String ) as Integer

Parameter

CurrentString (String)
The string to be examined

Returns the first number contained in a string.

In Section Instructions Examples Basics History Extra

GetCaptionForUnit

Returns the description of the unit

GetCaptionForUnit ( ByVal CurObject as IComosBaseObject ) as String

Parameter

CurObject (IComosBaseObject)

The object whose description is being searched for.

Supported types:

IComosDDevice

IComosDDocument

The function returns one of the two following cases:

Determines the GUnit-Pointer of the object specified through CurObject and returns
the description of its class from the class list.

Requirement:

The object found through GUnit has one of the following classes:

Position

Function
FunctionElement

Signal

Otherwise the return value is "Unit".

In Section Instructions Examples Basics History Extra

GetCDevicesByStructureGroup

Returns base objects

GetCDevicesByStructureGroup ( ByVal CDevice as IComosDCDevice, Optional ByVal

WithDeleted as Boolean = False ) as IComosDCollection

Parameter

CDevice (IComosDCDevice)

The object whose CDevices are being searched for.

WithDeleted (optional) (Boolean)

Controls whether deleted CDevices are included

Returns all base objects of the specified base object.

Requirement:

Base objects have the "Group" creation option

Base objects are not elements

Base objects of the dereferenced base objects are also included.

In Section Instructions Examples Basics History Extra

GetCDevStruktCollection

Internal

GetCDevStruktCollection ( ByVal Devs as IComosDCollection ) as _Collection

Internal

In Section Instructions Examples Basics History Extra

GetChildsForNew

Returns possible base objects for new objects

GetChildsForNew(ByVal Owner As Object, ByVal CDevice As IComosDCDevice, ByVal

WithSubsFromBlock As Boolean) As Collection

Parameter

Owner (Object)

Is the owner. Allowed types:

IComosDCDevice

VBA.Collection
IComosDCollection

CDevice

Only internally.

WithSubsFromBlock

Only internally. Defines if the elements of the create option "Block" are
considered.

IgnoreCheckTplLayer (optional)

Only internally.

Calls the GetChildsForNewOne routine for all specified objects. Finally the
function returns possible base objects for the creation of new objects underneath a
given owner

Return value

A list of base objects.

In Section Instructions Examples Basics History Extra

GetClassicTQBProgIdByControlType

Internal

GetClassicTQBProgIdByControlType ( ByVal ControlType as String ) as String

Processing of ProgIDs of queries for further use in XML connectors.

In Section Instructions Examples Basics History Extra

GetComosObjectAcrossProjects

Returns an object

GetComosObjectAcrossProjects ( ByVal WorkSet as IComosDWorkset, ByVal SystemUID as

String, ByVal SystemType as Long, ByVal PathFullName as String, ByVal
SearchAcrossProjects as Boolean ) as IComosBaseObject

Parameter

WorkSet (IComosDWorkset)

The current COMOS workset

SystemUID (String)

The SystemUID of the object searched for

SystemType (Long)

The SystemType of the object searched for

PathFullName (String)

The PathFullName of the object searched for

SearchAcrossProjects (Boolean)

Relevant only internally. Always use False

Returns a COMOS object by means of a SystemUID and SystemType.

The following applies additionally: If the object is not found in the current
project, it is searched for by using the PathFullName in the base project and
system project. Prerequisite is that the object has one of the following system
types:

CDevice

StandardTable

StandardValue

In Section Instructions Examples Basics History Extra

GetCObject

Returns the base object of a given object

GetCObject(ByVal ComosObject As IComosBaseObject) As IComosDCDevice

Parameter

ComosObject

Is a COMOS object. Following object types are considered:

SystemTypeDevice

SystemTypeUnit

SystemTypeLocation

SystemTypeCDevice

SystemTypeProject
SystemTypeDocument

Return value

Is the base object.

In Section Instructions Examples Basics History Extra

GetComosObject

Returns a COMOS object according to the stated parameters

GetComosObject(ByVal WorkSet As IComosDWorkset, ByVal SystemUID As String, ByVal

SystemType As Long, ByVal PathFullName As String) As IComosBaseObject

Parameter

WorkSet

Is the COMOS workset.

SystemUID

Is the SystemUID of the object.

SystemType

Is the system type of the object.

PathFullName

Is the PathFullName of the object, relative to the project.

Return value

The found COMOS object.

In Section Instructions Examples Basics History Extra

GetConPossibleTable

xxx

GetConPossibleTable ( ByVal Connector as IComosDConnector ) as IComosDStandardTable

Parameter

Connector (IComosDConnector)

In Section Instructions Examples Basics History Extra

GetControlType

Returns the ControlType (ProgID)

GetControlType ( ByVal ComosObj as IComosBaseObject ) as String

Parameter

ComosObj (IComosBaseObject)

The COMOS object

Supplies the ControlType (ProgID) for the specified COMOS object. The ControlType
is visible and can be changed in the properties of the base object. The types
IComosDDevice and IComosDCDevice are approved.

In Section Instructions Examples Basics History Extra

GetDeviceByDocObj

Returns the referenced engineering object of DocObj objects

GetDeviceByDocObj(ByVal DocObjObject As Object) As Object

Parameter

DocObjObject

Is the DocObj object.

In Section Instructions Examples Basics History Extra

GetDeviceLevel

States the relative level of an element in accordance with a main object

(MainDevice)

GetDeviceLevel(ByVal CurrentDevice As Object) As Integer

Parameter

CurrentDevice

Is the engineering object.

Return value

Is the level on which the element is located.

In Section Instructions Examples Basics History Extra

GetIdentTextForComosObject

Generates the standard display text for a COMOS object

GetIdentTextForComosObject(ByVal ComosObject As IComosBaseObject) As String

Parameter

ComosObject

Is the COMOS object for which the text is to be generated.

Return value

Is the display text.

In Section Instructions Examples Basics History Extra

GetLabelWithVariable

Inactive

GetLabelWithVariable ( ByVal DeviceObject as Object, ByVal x as Double, ByVal Y as

Double ) as String

Only still contained in the dll for reasons of compatibility.

In Section Instructions Examples Basics History Extra

GetMainDevice

Identical to the MainDevice function of the kernel. Exists due to compatibility

reasons. See also the kernel documentation "comos.dll".

GetMainDevice(ByVal CurrentDevice As Object) As Object

In Section Instructions Examples Basics History Extra

GetStdControlType

Internal

GetStdControlType ( Optional ByVal ComosObject as IComosBaseObject, Optional ByRef

Class as String, Optional ByRef SubClass as String ) as String

Allocation of component ID according to the old scheme to the component ID

according to the new scheme

In Section Instructions Examples Basics History Extra

GetTmpCollection
Converts the first parameter regardless of type into IComosDCollection

GetTmpCollection(ByVal ComosObjects As Object, Optional ByVal STypes As

VBA.Collection) As IComosDCollection

Parameter

ComosObjects

Can be one or more COMOS objects. Following types are supported: IComosBaseObject,
VBACollection, IComosDCollection.

STypes

Is optional and filters the object according to the stated types.

Return value

Listing of objects of the IComosDCollection type.

In Section Instructions Examples Basics History Extra

GetVlKpCollection

Inactive

GetVlKpCollection ( ByVal Knoten as Object ) as Collection

Only still contained in the dll for reasons of compatibility.

In Section Instructions Examples Basics History Extra

InheritCheckIn

Imports the object, if possible

InheritCheckIn(ByVal ComosObject As Object, ByVal ShowMessage As Boolean, ByVal

CreateMessage As Boolean) As Boolean

Parameter

ComosObject

Is the object on the engineering side which is to be imported.

ShowMessage

Displays error messages.

CreateMessage

Defines if error messages are written to an own message pack.

Return value

Is "True" if the operation was successful.

In Section Instructions Examples Basics History Extra

IsControlTypeTopQueryBrowser

Check for TopQBrowser

IsControlTypeTopQueryBrowser ( ByVal ComosObj as IComosBaseObject ) as Boolean

Parameter

ComosObj (IComosBaseObject)

The COMOS object.

Returns whether the ControlType (ProgID) of the COMOS object contains the
TopQBrowser type..

In Section Instructions Examples Basics History Extra

IsInheritCheckIn

Imports the object, if possible

IsInheritCheckIn(ByVal ComosObject As Object) As Boolean

Parameter

ComosObject

Is the object on the engineering side which is to be imported.

Return value

Is "True" if the operation was successful.

In Section Instructions Examples Basics History Extra

IsMainDevice
Checks if an entered object is a main object (MainDevice)

IsMainDevice(ByVal CurrentDevice As Object) As Boolean

Parameter

CurrentDevice

Is the engineering object.

Return value

Is "True" if the engineering object is a main object (MainDevice).

In Section Instructions Examples Basics History Extra

IsImplementation

Checks if a COMOS object is valid as an implementation pointer for the entered

request

IsImplementation(ByVal ComosObject As IComosBaseObject, ByVal Request As

IComosDDevice) As Boolean

Parameter

ComosObject

The checked engineering object.

Request

The entered request.

Return value

Is "True" if the checked object can be used as an implementation.

In Section Instructions Examples Basics History Extra

IsImplemented

Checks if the object has already been used as an implementation

IsImplemented(ByVal curObj As IComosDDevice) As Boolean

Parameter

curObj

Is the to be checked engineering object.

Return value

Is "True" if the object was used as an implementation.

In Section Instructions Examples Basics History Extra

IsObjectSystemRO

Checks if the object is write-protected

IsObjectSystemRO(ByVal ComosObject As Object) As Boolean

Parameter

ComosObject

Is the COMOS object for which the evaluation is to be conducted.

Return value

Is "True" if the object is write-protected.

In Section Instructions Examples Basics History Extra

IsPropertyTranslatable

Check for translatability

IsPropertyTranslatable ( ByVal ComosObject as IComosBaseObject, ByVal PropName as

String, ByVal PropParameter as Variant ) as String

Parameter

ComosObj (IComosBaseObject)

The COMOS object.

PropName (String)

The property to be examined

PropParameter (Variant)

Optional for properties with index

The function checks whether the specified property can be translated at the
specified COMOS object.

The function is called when texts are loaded in the Single translation or Bulk
translation. Functions only for attributes of the type Text.

Return values

Empty string

The property can be translated.

Error message

The property cannot be translated or is write-protected.

In Section Instructions Examples Basics History Extra

IsSetAllowed

Checks if a pointer can be set for an entered COMOS object

IsSetAllowed(ByVal ComosObject As IComosBaseObject, ByVal PointerObj As Object,

ByVal PropName As String, ByVal WithMsg As Boolean, Optional ByVal CreateMessage As
Boolean = True) As Boolean

Parameter

ComosObject

Is the COMOS object for which the evaluation is to be conducted.

PointerObj

The pointer which is to be set.

PropName
The name of the property. Following properties are supported:

CDevice

Cobject

Location

Unit

Alias

Implementation

Link.Object

StandardTable

Signal

Potential

Connected with

Wire

WithMsg

Defines if an error message is to be displayed.

CreateMessage

Is optional and defines that the error message are written in an own message pack.

Return value

Is "True" if you are allowed to set the pointer.

In Section Instructions Examples Basics History Extra

IsSpecificationTranslatable

Inactive

IsSpecificationTranslatable ( ByRef SpecObj as IComosBaseObject ) as Boolean

Only still contained in the dll for reasons of compatibility.

In Section Instructions Examples Basics History Extra

IsSpecInVisible

Check for visibility

IsSpecInVisible ( ByVal ComosObj as Variant ) as Boolean

Parameter

ComosObj (Variant)

The COMOS object.

The function checks the editing mode and the function rights of the user and
returns whether the attribute below the logical owner is visible for the user.

Return values

True

The object is visible.

False

The object is not visible or the system class of the checked object is not
IComosDSpecification.

In Section Instructions Examples Basics History Extra

IsWriteAllowed

Checks if you can change value type properties for a COMOS object

IsWriteAllowed(ByVal ComosObject As IComosBaseObject, Optional ByVal WithMsg As

Boolean = False, Optional ByVal PropName As String, Optional ByVal PropParameter As
Variant) As Boolean

Parameter

ComosObject

Is the COMOS object for which the evaluation is to be conducted.

WithMsg

Defines if an error message is to be displayed.

PropName

Optional. The name of the property.

PropParameter

Optional. Is the parameter of the property.

Return value

Is "True" if the property can be changed.

In Section Instructions Examples Basics History Extra

IsWriteAllowedByValue

Check for write rights for the property

IsWriteAllowedByValue ( ByVal ComosObject as IComosBaseObject, Optional ByVal

WithMsg as Boolean = False, Optional ByVal PropName as String, Optional ByVal
PropParameter as Variant, Optional ByVal vNewValue as Variant ) as Boolean

Parameter

ComosObject

Is the COMOS object for which the evaluation is to be conducted.

WithMsg (optional)

Defines if an error message is to be displayed.

PropName (optional)

The name of the property.

PropParameter (optional)

Optional for properties with index. Is the index of the property.

vNewValue (optional)

Optional. Is the value which is to be set.

Checks whether the specified property of the specified COMOS object can be edited
and returns an error message in case of a negative result. In the check for write
protection the following reasons are considered:

Rights of the user

Function rights

Belonging to the current project or to a different project

Status for the object states "Object locking" and "System object"

Supported system types: IComosDDevice, IComosDCDevice, IComosDSpecification,

IComosDDocument, IComosDConnector, IComosDUser.

Return value

Is "True" if the property can be changed.

The error message is output via LockedStatusText.

In Section Instructions Examples Basics History Extra

LabelChangeStretch

Internal
LabelChangeStretch ( ByVal CurElement as Object, ByVal NewLabel as String ) as
Variant

Internal processing of connector identifiers

In Section Instructions Examples Basics History Extra

LanguageDescription

Provides the description of the language

LanguageDescription(ByVal Language As IComosDLanguage, Optional Index As Integer =

-1) As String

Parameter

Language

Is the COMOS language object.

Index

Optional. Is the index of the language in the COMOS collection which is to be

translated.

Return value

Is the text in the selected language.

In Section Instructions Examples Basics History Extra

LockedStatusText
Returns a text which states why the property of an object is protected

LockedStatusText(ByVal ComosObject As IComosBaseObject, ByVal PropName As String,

ByVal PropParameter As Variant) As String

Parameter

Output function for the calculation of IsWriteAllowedByValue.

ComosObject

Is the COMOS object for which the property is write protected.

PropName

The name of the property which is write protected.

PropParameter

Parameter of the property which is write protected.

Return value

The status text which is displayed in the status bar of the application.

In Section Instructions Examples Basics History Extra

MaxNumberInLabel

Inactive

MaxNumberInLabel ( ByVal MainDevice as Object, ByVal Class as String, Optional

ByVal SearchLevelsCount as Integer ) as Collection

Only still contained in the dll for reasons of compatibility.

In Section Instructions Examples Basics History Extra

MaxNumberInLabels

Inactive

MaxNumberInLabels ( ByVal ComosObjects as Object, ByVal Class as String ) as Long

Only still contained in the dll for reasons of compatibility.

In Section Instructions Examples Basics History Extra

MegaClass

Internal

MegaClass ( ByVal ComosObject as Object ) as String

Allocation of types according to the old scheme to classes according to the new
scheme.

In Section Instructions Examples Basics History Extra

NameMaske

Internal

NameMaske ( ByVal OrigString as String ) as String

Internal calculation of name masks.

In Section Instructions Examples Basics History Extra

NextForString

Internal

NextForString ( ByVal LastName as String ) as String

Internal calculation of name masks.

In Section Instructions Examples Basics History Extra

NextForStringLikeComos

Internal

NextForStringLikeComos ( ByVal LastName as String ) as String

Internal calculation of name masks.

In Section Instructions Examples Basics History Extra

NextNameForComosCollection

Internal
NextNameForComosCollection ( ByVal ComosCollection as Object, ByVal OrigName as
String, Optional ByVal IsStart as Boolean, Optional ByVal ComosObject as Object )
as String

Internal calculation of name masks at elements.

In Section Instructions Examples Basics History Extra

NextNameForDevice

Name calculation

NextNameForDevice ( ByVal Device as IComosDDevice, Optional ByVal Prefix as String,

Optional ByVal SourceCDevice as IComosDCDevice ) as String

Parameter

Device (IComosDDevice)

The COMOS object

Prefix (optional) (String)

Controls whether messages are output in the MessagePack function

SourceCDevice (optional) (IComosDCDevice)

Desired base object

Calculates the new name for the specified device object. The name calculation
considers the following specifications:

Name masks at the base object

Name masks at the optionally specified SourceCDevice

The "Virtual" setting

When the name is calculated two cases exist:

If a mask is defined, it takes priority. The new name is determined by the mask.

If no mask exists, the name is formed on the basis of the "Virtual" setting:

The "Virtual" setting is off: The name is calculated by means of the

NextNameLikeParameters method.

The "Virtual" setting is on: As many ? are entered in the name as the number of
positions in the "Virtual" setting. This case is rare.

In Section Instructions Examples Basics History Extra

NextNameLikeParameters

Name calculation

NextNameLikeParameters ( ByVal ComosObject as Object, Optional ByVal Prefix as

String ) as String

Returns NextName and in the process takes the setting from Project.Parameters into
consideration. Amongst other points Project.Parameters specifies how many digits
are contained in the name.

In Section Instructions Examples Basics History Extra

PasteObject
Inactive

PasteObject ( ByVal OwnerObject as Object, ByVal DeviceObject as Object ) as Object

Parameter

OwnerObject (Object)

COMOS object that becomes the new owner

DeviceObject (Object)

The inserted COMOS object

Creates a copy of the specified object under the owner and returns the newly
created object.

Similar function: Paste in the comos.dll.

In Section Instructions Examples Basics History Extra

QueryXObjCreate

Inactive

QueryXObjCreate ( ByVal XObjContainer as IComosBaseObject ) as Object

Only still contained in the dll for reasons of compatibility.

In Section Instructions Examples Basics History Extra

SearchDefaultCables
xxx

SearchDefaultCables ( ByVal CurrentDevice as IComosDDevice ) as Variant

In Section Instructions Examples Basics History Extra

SearchOrIndexObject

Differentiation between the search object and index object

SearchOrIndexObject ( ByVal CurrentObject as IComosBaseObject ) as Integer

Parameter

CurrentObject (IComosBaseObject)

The COMOS object

Checks whether the specified object is a search object or an index object.

Requirement: Object of the IComosDDevice system class.

Return values

1: Object is a search object.

2: Object is an index object.

0: In all other cases.

In Section Instructions Examples Basics History Extra

SelectPointer

Opens a window for the reference selection

SelectPointer(ByVal ComosObject As IComosBaseObject, ByVal PropName As String,

Optional ByVal WithMsg As Boolean = False, Optional ByRef Cancel As Boolean =
False) As IComosBaseObject

Parameter

ComosObject

Is the document or the specification.

PropName

Only two properties are supported: CDocument and LinkObject.

WithMsg

Is optional and defines if an error message is to be displayed.

Cancel

Is optional. For reference Cancel = True, when the action is aborted.

Return value

The selected COMOS object.

In Section Instructions Examples Basics History Extra

SetCableChannelForCable
xxx

SetCableChannelForCable ( ByVal Cable as IComosDDevice, ByVal CableChannel as

IComosDDevice ) as Variant

In Section Instructions Examples Basics History Extra

SetImplementation

Implements the request

SetImplementation(ByVal Request As IComosDDevice, ByVal Implementation As

IComosDDevice, Optional ByVal WithMsgByReplace As Boolean = False) As Integer

Parameter

Request

Is the request object which is to be implemented.

Implementation

Is the implementation object.

WithMsgByReplace

Is optional and defines if an error message is to be displayed.

Return value

Is 0 if the implementation was successful.

In Section Instructions Examples Basics History Extra

SetLabel

Sets a label for a COMOS object

SetLabel(ByVal ComosObject As IComosBaseObject, ByVal NewLabel As String, Optional

ByVal WithMsg As Boolean = False) As Boolean

Parameter

ComosObject

The COMOS object for the label is to be set.

NewLabel

The new name.

WithMsg

Is optional and defines if an error message is to be displayed.

Return value

Is "True" if the operation was successful.

In Section Instructions Examples Basics History Extra

SetLocation

Sets the location pointer for a COMOS object

SetLocation(ByVal ComosObject As IComosBaseObject, ByVal PointerObj As Object,
Optional ByVal WithMsg As Boolean = False) As Boolean

Parameter

ComosObject

The COMOS object for which the location pointer is to be set.

PointerObj

The location pointer which is to be set.

WithMsg

Is optional and defines if an error message is to be displayed.

Return value

Is "True" if the operation was successful.

In Section Instructions Examples Basics History Extra

SetLock

Blocks or releases an engineering object

SetLock(ByVal ComosObj As Object, ByVal vNewValue As Boolean, ByVal Recursive As

Integer, ByVal WithMsg As Boolean) As Boolean

Parameter

ComosObj
Is a engineering object or a document.

vNewValue

Is either "True" or "False".

Recursive

Defines if the child objects should also be blocked or released.

There are the following values:

Non-recursive

Recursive

With a query, for a recursive or non-recursive procedure.

WithMsg

Defines if an error message is to be displayed.

In Section Instructions Examples Basics History Extra

SetName

Sets a new name for a COMOS object

SetName(ByVal ComosObject As IComosBaseObject, ByVal NewName As String, Optional

ByVal WithMsg As Boolean = False) As Boolean

Parameter

ComosObject

The COMOS object for which a name is to be set.

NewName

The new name.

WithMsg

Is optional and defines if an error message is to be displayed.

Return value

Is "True" if the operation was successful.

In Section Instructions Examples Basics History Extra

SetObjectLabel

Inactive

SetObjectLabel ( ByVal DocObjObject as Object ) as Boolean

Only still contained in the dll for reasons of compatibility.

In Section Instructions Examples Basics History Extra

SetPointer
Checks if a pointer can be set and sets the pointer if the check was successful

SetPointer(ByVal ComosObject As IComosBaseObject, ByVal PointerObj As Object, ByVal

PropName As String, Optional ByVal WithMsg As Boolean = False) As Boolean

Parameter

ComosObject

The COMOS object for which the pointer can be set.

PointerObj

The to be set pointer object.

PropName

The name of the property. Following properties are supported:

CDevice

CObject

CDocument

Location

Unit

Alias

Implementation

Link.Object
StandardTable

Signal

Potential

ConnectedWith

Wire

Cable

WithMsg

Is optional and defines if an error message is to be displayed.

Return value

Is "True" if the operation was successful.

In Section Instructions Examples Basics History Extra

SetRunNumber

Internal

SetRunNumber ( ByVal Element as Object, ByVal RunNumber as Long, Optional ByVal

Mode as String ) as Long
Internal calculation of name masks.

In Section Instructions Examples Basics History Extra

SetRunNumberForElement

Obsolete

SetRunNumberForElement ( ByVal Element as Object, ByVal RunNumbers as _Collection,

Optional ByVal Mode as String, Optional ByVal MainDevice as Object, Optional ByVal
SearchLevelsCount as Integer ) as Collection

Calculation of identifiers.

In Section Instructions Examples Basics History Extra

SetSubObjbyCDevDesc

Creating an element or changing it by means of a base object pointer

SetSubObjbyCDevDesc ( ByVal DeviceOwner as IComosBaseObject, ByVal DeviceName as

String, ByVal CDeviceOwnerFullname as String, ByVal CDeviceDescription as String )
as Variant

Parameter

DeviceOwner (IComosBaseObject)

The COMOS object

DeviceName (String)

The element name

CDeviceOwnerFullname (String)

The SystemFullName of the base object

CDeviceDescription (String)

Description of the base object

The function passes through the following steps:

A search is carried out for an element called DeviceName below the DeviceOwner
object.

DeviceOwner must have the IComosDDevice system class.

Element does not exist: Element is created

Element exists: Base holder pointer is processed as described in the following step

A search is carried out for a base object in the base data in accordance with
CDeviceOwnerFullname and CDeviceDescription.

The base object element is set as a base object pointer.

In Section Instructions Examples Basics History Extra

SetUnit

Sets the unit pointer for a COMOS object

SetUnit(ByVal ComosObject As IComosBaseObject, ByVal PointerObj As Object, Optional

ByVal WithMsg As Boolean = False) As Boolean
Parameter

ComosObject

The COMOS object for which the unit pointer is to be set.

PointerObj

The unit pointer which is to be set.

WithMsg

Is optional and defines if an error message is to be displayed.

Return value

Is "True" if the operation was successful.

In Section Instructions Examples Basics History Extra

XObjInheritParent

Calculation of the XObject source

XObjInheritParent ( ByVal XObjContainer as IComosBaseObject ) as IComosDCDevice

Parameter

XObjContainer (IComosBaseObject)

The COMOS object

Determines the base object that is the inherit source of XObject for the specified
COMOS object. Supported types: IComosDCDevice, IComosDDevice.
In Section Instructions Examples Basics History Extra

Public Sub

This chapter contains the following information:CheckElementsAfterCDeviceChange

CheckDocumntsAfterCDeviceChange

In Section Instructions Examples Basics History Extra

CheckElementsAfterCDeviceChange

Base object exchange at the elements

CheckElementsAfterCDeviceChange ( ByVal Device as IComosDDevice, ByVal CDeviceOld

as IComosDCDevice )

Parameter

Device (IComosDDevice)

The COMOS object of the Device system type whose base object was changed

CDeviceOld (IComosDCDevice)

The old base object

The routine carries out a base object change for each old element of the device to
the respectively new element base object. In the process dereferenced elements
(last stage of referencing) are also taken into consideration at the new elements
provided the dereferencing setting is set at the element.
Exception: A change does not take place at elements with the Block, Group and
Structure creation mode. Here, the project option "Behavior of elements at base
object exchange" is evaluated. There are two cases depending on this project
option:

Element is deleted immediately

Element is imported from the old base object if identical names exist and it is not
a virtual element.

In Section Instructions Examples Basics History Extra

CheckDocumntsAfterCDeviceChange

Check for deleting of documents

CheckDocumntsAfterCDeviceChange ( ByVal Device as IComosDDevice, ByVal CDeviceOld

as IComosDCDevice )

Parameter

Device (IComosDDevice)

The COMOS object of the Documennt system type whose base object was changed

CDeviceOld (IComosDCDevice)

The old base object

After a base object exchange the routine check the status for each document of the
device.

Name of the document is the same at the old and new base object: The document is
retained.

All other documents: The documents are entered in the ErrorObjects list. The user
decides what is to happen with the documents in the error list.
In Section Instructions Examples Basics History Extra

Public Property

This chapter contains the following information:AllowMultipleRequests

ITC_SYSCATEGORIE

ITC_SYSSHIELD

CurrentMessagePack

MaxRunLevels

In Section Instructions Examples Basics History Extra

AllowMultipleRequests

Controlling of multiple implementation

AllowMultipleRequests ( ) as Boolean

The property controls whether several requests can be set at the implementation
pointer of a device.

In Section Instructions Examples Basics History Extra

ITC_SYSCATEGORIE
Internal

ITC_SYSCATEGORIE ( ) as String

Internal constant.

In Section Instructions Examples Basics History Extra

ITC_SYSSHIELD

Internal

ITC_SYSSHIELD ( ) as String

Internal constant.

In Section Instructions Examples Basics History Extra

CurrentMessagePack

Belonging to the MessagePack

CurrentMessagePack ( ) as Object

Returns the current MessagePack member variable.

In Section Instructions Examples Basics History Extra

MaxRunLevels
Internal

MaxRunLevels ( ) as Integer

Internal.

In Section Instructions Examples Basics History Extra

Class: Implement

This chapter contains the following information:Implement Properties

Public Functions

Public Subs

In Section Instructions Examples Basics History Extra

Implement Properties

ITC_RequestInfo

ITC_RequestInfo ( ) as String

Internal.

In Section Instructions Examples Basics History Extra

Public Functions
This chapter contains the following information:CheckConnectors

CheckSpecificationsValue

DisconnectOldRequest

EnableRestore

InfoText

IsEnabledRestoreRequest

IsUsedAsImplementation

IsUsedAsRequest

In Section Instructions Examples Basics History Extra

CheckConnectors

Checks connectors according to their names, types and subtypes

CheckConnectors(ByVal DeviceFrom As IComosDDevice, ByVal DeviceTo As IComosDDevice,

ByVal ConnectorType As String) As Integer

Parameter

DeviceFrom

Is a base engineering object whose connections are supposed to be checked with

another engineering object.

DeviceTo

Is the engineering object which is to be checked.

ConnectorType

The connector type which is checked.

Return value

Check is OK.

The engineering objects have different connections.

The connections have different types.

The connections have different subtypes.

In Section Instructions Examples Basics History Extra

CheckSpecificationsValue

Checks the attributes of engineering objects with regard to their content

CheckSpecificationsValue(ByVal DeviceFrom As IComosDDevice, ByVal DeviceTo As

IComosDDevice, ByVal SpecNestedName As String) As Integer

Parameter

DeviceFrom

Is a base engineering object whose attributes are supposed to be checked with

another engineering object.
DeviceTo

Is the engineering object which is to be checked.

SpecNestedName

Is the name of the attribute which is to be checked.

Return value

The check was successful.

11

Different attributes are existent.

12

The attributes have different values.

In Section Instructions Examples Basics History Extra

DisconnectOldRequest

Dissolves an implementation

DisconnectOldRequest(ByVal Implementation As IComosDDevice) As IComosDDevice

Parameter

Implementation

Is an engineering object.
Return value

Is the engineering object which is the dissolved request.

In Section Instructions Examples Basics History Extra

EnableRestore

Informs if the implementation can be dissolved

EnableRestore(ByVal Implementation As IComosDDevice, ByVal Request As

IComosDDevice) As Boolean

Parameter

Implementation

Is the manufacturer device which was implemented.

Request

Is the request that was implemented.

Return value

Is "True" if the operation was successful.

In Section Instructions Examples Basics History Extra

InfoText

Returns information regarding the result number

InfoText(ByVal NumberCode As Integer) As String

Parameter

NumberCode

Is the result number.

Return value

Information text.

In Section Instructions Examples Basics History Extra

IsEnabledRestoreRequest

States if an engineering object owns the information to restore a request

IsEnabledRestoreRequest(ByVal Implementation As IComosDDevice) As Boolean

Parameter

Implementation

Is the engineering object which functions as a manufacturer device.

Return value
Is "True" if the operation was successful.

In Section Instructions Examples Basics History Extra

IsUsedAsImplementation

Checks it the object is already set as an implementation on another object

IsUsedAsImplementation(ByVal Device As IComosDDevice) As Boolean

Parameter

Device

The engineering object to be evaluated.

Return value

Is "True" if the operation was successful.

In Section Instructions Examples Basics History Extra

IsUsedAsRequest

Checks if an object owns an implementation

IsUsedAsRequest(ByVal Device As IComosDDevice) As Boolean

Parameter

Device

The engineering object to be evaluated.

Return value

Is "True" if the operation was successful.

In Section Instructions Examples Basics History Extra

Public Subs

This chapter contains the following information:CopySpecificationsValue

MoveConnectorsInfo

MoveDocObjs

MoveSpecificationLinks

SetUnit

In Section Instructions Examples Basics History Extra

CopySpecificationsValue

Copies the attributes OwnValue, GetOwnXValue, OwnUnit and OwnLinkObject

CopySpecificationsValue(ByVal DeviceFrom As IComosDDevice, ByVal DeviceTo As

IComosDDevice, ByVal SpecNestedName As String, ByVal Prio As Integer)
Parameter

DeviceFrom

Is the engineering object from which is copied.

DeviceTo

Is the engineering object in which is copied to.

SpecNestedName

Is the name of the attribute which is to be copied.

Prio

Is a number which states if the value of the to be replaced attribute is to be

overwritten if it already exists

In Section Instructions Examples Basics History Extra

MoveConnectorsInfo

Moves the connection values of an engineering object to another engineering object

MoveConnectorsInfo(ByVal DeviceFrom As IComosDDevice, ByVal DeviceTo As

IComosDDevice, ByVal ConnectorType As String, ByVal Prio As Integer, ByVal
Recursive As Boolean)

Parameter

DeviceFrom

The engineering object from which the values are taken.

DeviceTo
The engineering object to which the values are passed to.

ConnectorType

Is the connection type which is to be moved.

Prio

Is a number which defines if the value of the connection to be replaced is to be

overwritten if it already exists.

Recursive

Defines if the new values should also be applied to the connected connections.

In Section Instructions Examples Basics History Extra

MoveDocObjs

Moves DocObjs from one engineering object to another

MoveDocObjs(ByVal DeviceFrom As IComosDDevice, ByVal DeviceTo As IComosDDevice,

ByVal DocumentTypeName As String, ByVal SymbolType As String)

Parameter

DeviceFrom

Is the engineering object from which the objects are moved.

DeviceTo

Is the engineering object to which the objects are moved to.

DocumentTypeName
The name of the document type.

SymbolType

The symbol type of the document.

In Section Instructions Examples Basics History Extra

MoveSpecificationLinks

Moves links of attributes from an engineering object to another

MoveSpecificationLinks(ByVal DeviceFrom As IComosDDevice, ByVal DeviceTo As

IComosDDevice)

Parameter

DeviceFrom

The engineering object from which the links are moved.

DeviceTo

The engineering object to which the links are moved to.

In Section Instructions Examples Basics History Extra

SetUnit

Sets the unit pointer from one object to another

SetUnit(ByVal DeviceFrom As IComosDDevice, ByVal DeviceTo As IComosDDevice)

Parameter

DeviceFrom

Is the object from which the pointers derive.

DeviceTo

Is the object on which the pointer is set.

In Section Instructions Examples Basics History Extra

Class: InfoToCreateVE

Internal

Management class for virtual elements. This class controls whether the elements are
also automatically created when a new device is created or not.

In Section Instructions Examples Basics History Extra

Class: Message

Overview

This class creates objects of the type "Message". These objects are used by the
class MessagePack. See chapter Class: MessagePack.

The properties of this class are displayed later in the object test.
In Section Instructions Examples Basics History Extra

Class: MessagePack

Overview

If errors are found in COMOS, two procedures are available to report these errors
to the user:

A MessageBox is generated when the error occurs

This procedure functions irrespective of the MessagePack class

or

The errors are collected and displayed as an error package after the procedure is
finished.

You use the MessagePack class for this method.

The errors in the error package can, for example, be listed in a table or displayed
in the object test. This procedure is recommended for mass operations.

The class MessagePack collects objects of the type Message.

Since different GUIs generate diffferent messages, each GUI has to generate, fill
out and subsequently display its own MessagePack.

Example 1

The end user carries out a base object exchange via the properties mask. Since this
operation is only carried out once, the properties mask does not require the
MessagePack technique an can display a MessageBox directly in case of an error.

Example 2

The end use carries out a base object exchange for several objects simultaneously
via the query user interface. Since the base object exchange is carried out several
times in this case, the QueryBrowser decides in the case of an error to collect all
the messages and display them a single time at the end. To this purpose it uses the
MessagePacks of the Device.dll.