In Section Instructions Examples Basics History Extra

Class documentation COMOS_dll

This chapter contains the following information:Notes on this document

Change list

Objects and object structures in Comos

Base object instances

Hierarchy Objects

Administration objects (independent classes)

Interface without classes

Object model graphics (Object hierarchy)

COMOS constants

In Section Instructions Examples Basics History Extra

Notes on this document

Structure of the class documentation

The classification "Sub", "Function" and "Property" is VB-specific and is required

for a Com interface. This classification is not used in the class documentation.

In Section Instructions Examples Basics History Extra

Change list
This chapter contains the following information:Base object instances

Hierarchy objects

Administration objects (independent classes)

Interface without classes

COMOS constants

In Section Instructions Examples Basics History Extra

Base object instances

The following topics are new or have been changed.

In Section Instructions Examples Basics History Extra

Hierarchy objects

The following topics are new or have been changed.

In Section Instructions Examples Basics History Extra

Administration objects (independent classes)

The following topics are new or have been changed.

In Section Instructions Examples Basics History Extra

Interface without classes

The following topics are new or have been changed.

In Section Instructions Examples Basics History Extra

COMOS constants

The following topics are new or have been changed.

In Section Instructions Examples Basics History Extra

Objects and object structures in Comos

This chapter contains the following information:General object concept

COMOS objects

Navigating/New objects

In Section Instructions Examples Basics History Extra

General object concept

Three characteristics of an object

Objects own properties and methods and react to events.

Properties describe the state of an object.

Methods determine the behavior of the object and influence the properties. The
state of an object is a static characteristic. As opposed to the properties,
methods determine the dynamic object behavior.

Events are messages that are received by an object and start the execution of
previously defined program code. They represent the actual interface to Windows.
Thus, for example, clicking on a control element with the mouse initiates an
OnClick event. Events are managed and processed in so-called Event Handlers.

Inheritance

An important feature of objects is the fact that they inherit information from
classes. The class hierarchy is designed beforehand by the developer. It is fixed.
Truly efficient working / programming is only possible through inheritance.

Templates for objects / creating objects

Objects are created from classes. Therefore, an object is also referred to as being
an "instance" of a class. The class itself is not an object but a template.

Thus you cannot work with classes, you require objects to do so. If you want to
create an object that you can work with, you would generally search for a suitable
class with the ProgID, call "CreateNew", and then you would already have an object.

Using objects

Objects communicate with other objects exclusively through interfaces. This

concealment of the inner structure is called encapsulation. Internal data and
private methods are thus not accessible from outside and are protected against
unauthorized access. There are two interfaces:

Public methods (= function or sub)

Public properties

In Section Instructions Examples Basics History Extra

COMOS objects

Scripts instead of events

COMOS objects own methods and properties. However, COMOS objects do not react to
events.

Of course, COMOS itself reacts to events, otherwise it would not be possible to

have object-oriented software. However, the events are intercepted and handled in
COMOS. Specific events – but not all – are then made available in the form of
scripts that are appended at the objects.

It is thus not possible to view a list of events made available by the operating
system and then to react to these events by controlling the objects accordingly.

Instead, scripts are made available. Some of these scripts have names similar to
those of operating system events. For example, there is a script block called
"OnClick" on the specifications, which sounds similar to an operating system event
such as "DoubleClick", for example.

Such similarities of names arise because the scripts themselves react to operating
system events, and the names of the scripts already explain which events trigger
the script blocks. However, the similarity of names does not change the following
statement: you cannot react to events within COMOS objects. Instead, scripts are
made available.

You can find more information on this topic in the "COMOS Platform Administration"
manual, keyword "Reference of the script blocks at attributes and base objects".

Inheritance

COMOS uses the inheritance in classes. Therefore the classes are divided into two
groups:

Independent classes

Classes that are so special that no inheritance is required. The instances of these
classes are also called "administration objects".

See Administration objects (independent classes)

Base object instances

All other classes are collected from a root class, the "IComosBaseObject" class.
That way, all the methods and properties that are of general use need only be
defined once, and all subclasses of BaseObject inherit these details.

See Base object instances

Right at the beginning of this section, there is IComosBaseObject. All methods

(functions and subs) and all properties described in that section are passed on to
all the subclasses. These functions, subs and properties are not even listed in the
subclasses. You must know BaseObject to be able to control its other subclasses.

Templates for objects / creating objects (CreateNew)

In COMOS there is only one object that is allowed to be created directly out of a
class: workset. And this object may only be created exactly once (per session).

CreateNew is not permitted in all the other classes.

Instead, you must exactly specify where the new object is to be created, find the
(future) owner, and then call a method at the owner that creates the new object.

In other words, you first need to control the object model used in COMOS. With the
help of this object model you can see which objects are allowed and where. You then
write a code in which you navigate to a specific location in the database (the
object must exist already) and then create a new child object in one of the
collections of this object.

Therefore, in COMOS, it is not permissible to just create objects without a

hierarchy for sorting them afterwards. In COMOS, objects must be created at the
right location.

In Section Instructions Examples Basics History Extra

Navigating/New objects

As already stated above, you are not allowed to "freely" create objects within
Comos. Instead you must find an existing object, i.e. navigate to an object. At
this object you can then create the permitted objects.

Navigation in Comos is done solely with the help of the OwnCollections. An

OwnCollection contains all objects of the next hierarchy level that actually exist.
Here it is referred to the class hierarchy, not the tree structure that can be seen
in the Navigator, for example. The Navigator gives a user view of the data and this
can be a view of the software-related data structure that has be changed with
various methods.

The starting point of the hierarchy is the workset, see IComosDWorkset. Underneath
the workset there are three classes: the projects, the users and the UserGroups.
The users and user groups are located underneath the workset because they are
intended to be able to operate across projects. For that reason you cannot append
the users and user groups underneath the project.

The associated OwnCollections are:

GetAllProjects

GetAllUserGroups

GetAllUsers

You can find the subsequent class hierarchy in section 6.1: OwnCollections.

Example: the fact that base objects (CDevices), engineering objects (devices) and
documents are located underneath the project is not surprising. However, the
graphic also shows that run cases (Cases) are located directly underneath the
project. If you want to insert or delete a run case, you must then call up the
project object, detect the collection of run cases there, and then edit this
collection.

In IComosDCollection and IComosDOwnCollection you can see which commands are

allowed for collections. Both sections should be considered, since
IComosDOwnCollection is an instance of IComosDCollection and inherits its
functions, properties and subs.

In Section Instructions Examples Basics History Extra

Base object instances

This chapter contains the following information:Old interfaces

Case-sensitive/ Case-insensitive

IComosBaseObject

IComosDCase
IComosDCDevice

IComosDCLink

IComosDConnector

IComosDConnectorAttributeItem

IComosDCSpecificationSet

IComosDDevice

IComosDDevSymbol

IComosDDocObj

IComosDDocument

IComosDDocumentType

IComosDLanguage

IComosDLocation

IComosDNumberRangeGenerator

IComosDObjectHistoryEntries

IComosDObjectHistoryEntry

IComosDObjectRevision

IComosDPhysUnit

IComosDPhysUnitGroup

IComosDProgressBarHider

IComosDProject

IComosDRight

IComosDSpecification

IComosDSpecificationSet

IComosDStandardTable

IComosDStandardValue

IComosDTimestamp

IComosDUnit

IComosDUser

IComosDUserGroup
IComosDWorkingOverlay

IPLTBinObjectArchive

IPLTPickList

IPLTPickListEntrys

IPLTVarstorage

IPLTXValueArrayEntry

In Section Instructions Examples Basics History Extra

Old interfaces

IPLTBinObjectArchive, IPLTPickList, IPLTPickListEntrys, IPLTVarstorage and

IPLTXValueArrayEntry are only available in the IPLT version.

Several additional interfaces are available in the IPLT version as well as in the
IComosD version. These interfaces are only documented in the IComosD version.

In Section Instructions Examples Basics History Extra

Case-sensitive/ Case-insensitive

The work inside the core is conducted as case-sensitive, except it is explicitly

stated elsewhere. Currently following areas are working case-insensitive:

Access to external file names; see IComosDFileProperties

Storing global variables Globals

In Section Instructions Examples Basics History Extra

IComosBaseObject

This chapter contains the following information:IComosBaseObject

AcceptUpdateData

AddToErrorObjects

AliasFullLabel

AliasFullLabelWithoutFolder

AliasRelativLabel

AliasRelativeLabelWithoutFolder

AliasSignedLabel

AllBackPointerSpecificationsWithLinkObject)

AllBackPointerSpecificationsWithLinkObjectAndName

AllowWritingWhileSecurityLocked

Assign

AssignIgnoreReferences

BackPointerSpecificationsWithLinkObject

BackPointerSpecificationsWithLinkObjectAndName

Backup

CalculateLinkedSpecifications

Check

CheckAll

CheckAndCorrectObjects

CheckDelete

CheckForPaste

CheckLayer

CheckLinkedSpecifications

CheckMerge
CheckObject

CopyAll

CopyFromMode

CopyInOtherProject

CrossProjectCopy

CS

DeleteAll

DeleteErrorObjects

Description

DiscardUpdateData

Dispatch

ForcedRelease

FullLabel

FullLabelWithoutFolder

FullName

GetBackPointerRightsWithReference

GetDeleteFlag

GetHashCode

GetInternationalDescription

GetInternationalLabel

GetNextTextFromNumberRangeGenerator

GetObjectByPathFullName

GetObjectOverlayBehavior

GetObjectRights

GetOwnInternationalDescription

GetSavedAndDeleted

GetScriptEngine

GetShadowCollection

GetSoftDeleteFlag
GetStatusBase

GetSystemStatus

GetUserRights

HexAddress

Histories

InfoText

InheritCheckIn

InheritMode

InheritParent

InheritStatus

Invalid

IsAdminLocked

IsAlias

IsChanged

IsChangedAll

IsExpandable

IsFolder

IsInheritCheckInEnabled

IsLocked

IsOwnAdminLocked

IsOwnExpandable

IsOwnSysLocked

IsOwnSystemRelevant

IsSameCheckedInObject

IsSaved

IsShadowObject

IsSysLocked

IsSystemRelevant

IsVirtual

IsXObjLoaded
Label

LoadAll

LoggedDeleteAll

MatchScan

Merge

Name

ObjectCanBeCopiedOrMovedToNewOwnerWithNRG

ObjectHistoryEntries

Owner

OwnerByClass

OwnerByClassificationKey

OwnerCollection

OwnXMLString

OwnXObjExist

Paste

Paste2

PathFullName

Project

RecalculateHierarchyInformation

RelativLabel

RelativLabel2

RelativLabelWithoutFolder

RemoveFromWorkingOverlay

Restore

RestoreFromHigherWorkingOverlay

RS

Save

SaveAll

ScanDevices
ScanDevicesWithCObject

ScanDevicesWithCObjectX

ScanDevicesWithDeleted

ScanDevicesX

ScanDocuments

ScanObjects

ScanObjectsByClass

ScriptEngine

SetAdminLocked

SetChanged

SetExpandable

SetInternationalDescription

SetInvisibleOnMerge

SetObjectOverlayBehavior

SetOwnInternationalDescription

SetSysLocked

SetSystemRelevant

ShutDownXObj

SignedLabel

SingleCheckDelete

Spec

Specs

SystemFullName

SystemRefCount

SystemRO

SystemTemporary

SystemType

SystemTypeName

SystemUID

TextIsProvidedByNumberRangeGenerator
ThisObj

Undo

UndoAll

UndoDelete

Workset

XMLGet

XMLSet

XMLString

XObj

XObjEquals

XObjExist

In Section Instructions Examples Basics History Extra

IComosBaseObject

The basic and most primary COMOS object class, from which almost all other classes
inherit methods and properties.

Exceptions

See also Chapter Administration objects (independent classes).

In Section Instructions Examples Basics History Extra

AcceptUpdateData
AcceptUpdateData ( ByVal Recursive as Boolean )

Parameter Recursive as boolean

True: All objects below the current object are applied

False: In all other cases.

Method is used as part of a database update.

The method specifies:

Always: The status is applied in the update layer for the current object. The
status in the customer layer is overwritten.

In addition, if recursive = true: The status is applied in the update layer for all
child objects.

In Section Instructions Examples Basics History Extra

AddToErrorObjects

AddToErrorObjects(errorcode As Long, desc As String)

Adds the referenced object to the project error list.

In Section Instructions Examples Basics History Extra

AliasFullLabel

AliasFullLabel() As String
Returns the label of the object, including all owners, both in its own branch and
in the alias branch. Only superior folder objects are not considered. The alias
evaluation is only carried out if WorkSet.UseAliasForLabelFunctions is set to True.

In Section Instructions Examples Basics History Extra

AliasFullLabelWithoutFolder

AliasFullLabelWithoutFolder() As String

Returns the Label of the object, including all owners, both in its own branch and
in the alias branch. No folder objects are considered. The alias evaluation is only
carried out if WorkSet.UseAliasForLabelFunctions is set to True.

In Section Instructions Examples Basics History Extra

AliasRelativLabel

AliasRelativLabel(Val as Object) as String

The same as for RelativLabel, including the alias branch. The alias evaluation is
only carried out if WorkSet.UseAliasForLabelFunctions is set to True.

In Section Instructions Examples Basics History Extra

AliasRelativeLabelWithoutFolder

AliasRelativLabelWithoutFolder(Val As Object) As String

Returns the RelativLabel of the object, including all owners, both in its own
branch and in the alias branch. No folder objects are considered. The alias
evaluation is only carried out if WorkSet.UseAliasForLabelFunctions is set to True.

In Section Instructions Examples Basics History Extra

AliasSignedLabel

AliasSignedLabel() as String

The same as for SignedLabel, including the alias branch. The alias evaluation is
only carried out if WorkSet.UseAliasForLabelFunctions is set to True.

In Section Instructions Examples Basics History Extra

AllBackPointerSpecificationsWithLinkObject)

AllBackPointerSpecificationsWithLinkObject() As IComosDCollection

Function that is similar to BackpointerSpecificationsWithLinkObject, only from all

projects.

Note This function can take a great deal of time, depending on the size of the
database, and should be used with caution.

In Section Instructions Examples Basics History Extra

AllBackPointerSpecificationsWithLinkObjectAndName
AllBackPointerSpecificationsWithLinkObjectAndName(ByVal Name as String) as
IComosDCollection

Like BackPointerSpecificationsWithLinkObjectAndName, but objects from all projects.

In Section Instructions Examples Basics History Extra

AllowWritingWhileSecurityLocked

AllowWritingWhileSecurityLocked ( ) as Boolean

Return value: Boolean

True: The write rights are only missing at the current object due to the
"AdminLock" or "SysLock" flag.

False: All other cases

Auxiliary method for rights queries of user interface.

If the write rights at an object are only missing due to the "AdminLock" or
"SysLock" flag, this method supplies "true". In all other cases, "false" is
supplied. If write rights exist at the current object, the result of this method
has no meaning.

There are exceptions when an object can be changed even if the "AdminLock" or
"SysLock" flag is set. Example: Change only affects the property "Description". If
there is such an exception and the method "AllowWritingWhileSecurityLocked"
indicates that no other reasons are present for write protection, the change is
saved.

In Section Instructions Examples Basics History Extra

Assign
Assign(source_obj as Object, newrootobjects as Object, otherprojectpointer as
Boolean)

Special function for object matcher.

In Section Instructions Examples Basics History Extra

AssignIgnoreReferences

void AssignIgnoreReferences(IComosBaseObject source, IComosDCollection

newRootObjects, bool otherProjectPointer)

Copies the transferred source object (parameter source) via the current object
(this). New root objects that are created during the copy process are pasted into
the transferred TempCollection newRootObjects. Unlike the Assign method, in this
case references which point from the current one are ignored.

Parameter source: Source object to be copied.

Parameter newRootObjects: Empty TempCollection, filled with newly-created root

objects by this method.

Parameter otherProjectPointer is no longer used (no function).

In Section Instructions Examples Basics History Extra

BackPointerSpecificationsWithLinkObject
BackPointerSpecificationsWithLinkObject() As IComosDCollection

Groups objects of the IComosDSpecification class from the current project, the
LinkObject pointer of which refers to the current object in a collection.

Note This function can take a great deal of time, depending on the size of the
database, and should be used with caution.

In Section Instructions Examples Basics History Extra

BackPointerSpecificationsWithLinkObjectAndName

BackPointerSpecificationsWithLinkObjectAndName(ByVal Name as String) as

IComosDCollection

Returns a BackPointerCollection of specification objects filtered by name, which

point to the current object with the LinkObject (see
IComosBaseObject.BackPointerSpecificationsWithLinkObject). You can also state the
"*" and "?" wildcards for the name. At the moment, there is no Escape character, so
the asterisk and question mark are always interpreted as wildcards and cannot be
used as part of a string. Only returns objects from the current project.

In Section Instructions Examples Basics History Extra

Backup

Backup() as Object

Backup creates a temporary copy of an object that can be written back to the object
later by using Restore (it is better to use Save and Undo).

In Section Instructions Examples Basics History Extra

CalculateLinkedSpecifications

CalculateLinkedSpecifications()

Calculates the static links for all subordinate attributes.

In Section Instructions Examples Basics History Extra

Check

Check() as Long

Checks the object structure for new or changed objects.

Return values

no error

no set name

Name is not unique (an object with the name already exists

No current project set

4
No set owner (object is not located in any structure)

only read access permitted

not in current project

Object is virtual

200

Object is located in another project

201

Device is already being used

202

Object is already being used

Application example

If ObjectCheck= 0 then

ObjectSave

else

Msgbox: Error in object structure

Endif

In Section Instructions Examples Basics History Extra

CheckAll

CheckAll() as Long

Checks the object structure of the relevant object and all secondary objects in the
hierarchy, in the case of objects that are new or have been changed.

Return values and application example: See also Chapter Check.

In Section Instructions Examples Basics History Extra

CheckAndCorrectObjects

CheckAndCorrectObjects() as Long

Checks the object and all secondary objects in the hierarchy for errors in their
structure and corrects them as much as possible. Defective objects are entered into
the error list of the project.

In Section Instructions Examples Basics History Extra

CheckDelete

CheckDelete() as Long

Checks whether it is permissible to delete the object. (Application similar to

CheckAll). Deleting is permitted if the result is 0.

This function reacts to the script block CheckDelete on the CDevice. If the script
block CheckDelete does not return an empty string, the result 8
(PROPERTY_ERROR_ON_CHECK) is returned, and the return value string from the script
is set on the workset as LastErrorText.
In Section Instructions Examples Basics History Extra

CheckForPaste

CheckForPaste(Val As Object) As Long

This function is used to check whether it is permissible to paste the selected

objects. Pasting is permitted if the result is "0". This function should always be
executed before pasting objects if the clipboard functionality is not used!

In Section Instructions Examples Basics History Extra

CheckLayer

CheckLayer(ByVal Val as String) as Boolean

Checks the layers (defined working areas) of the object against the specified ones
and those of the user.

In Section Instructions Examples Basics History Extra

CheckLinkedSpecifications

CheckLinkedSpecifications() as IComosDCollection

Returns a list with all the specifications of the object that would be changed by
static linking.
Static linking:

Linking of values for attributes only through an instruction (updating of linked

specification values through a user instruction).

Dynamic linking:

Online linking of values in the case of attributes (automatic updating if there is

a change in the starting value).

See also Chapter ComosDLinkInfo and Chapter IComosDSpecification.

In Section Instructions Examples Basics History Extra

CheckMerge

CheckMerge(slaveObject as IComosBaseObject, fastCheck as Boolean, mergeMethod as

Long) as IComosDObjectCollection

This method checks if two objects may be merged with each other via Merge():

Checking the write rights and delete rights for the respective objects or
subobjects

Checking for identical object types

See section Merge.

Parameters

slaveObject as IComosBaseObject

Pointer to the slave object to be merged with the master object.

mergeMethod as Long

Counterpart to the mergeMode parameter.

Controls the processing of properties and subobjects.

See section Merge.

fastCheck as Boolean

Determines whether the check is stopped at the first problem, or whether all
problems are identified.

See section Merge.

In Section Instructions Examples Basics History Extra

CheckObject

CheckObject() as Long

Same as Check, but also for objects that have not been changed.

In Section Instructions Examples Basics History Extra

CopyAll

CopyAll() as Object

Copies the object with the entire hierarchical substructure. A IComosBaseObject is

returned.

In Section Instructions Examples Basics History Extra

CopyFromMode

CopyFromMode() as Boolean

Only for objects from the Copy-Tree (Copy structure). New Reference := False

In Section Instructions Examples Basics History Extra

CopyInOtherProject

CopyInOtherProject(destproject as Object, newrootobjects as Object) as Object

Special function for object matcher and cross-project copying. Subsequently brings
references into the target project.

In Section Instructions Examples Basics History Extra

CrossProjectCopy

IComosBaseObject CrossProjectCopy([in] IComosBaseObject destinationOwner, [in]

IComosDCollection newRootObjects)

This method can be used to copy the current object (this) to another project. The
new, copied object is added below the transferred owner. If the copy operation
creates additional new root objects (e.g. as a result of references), then these
are inserted in the transferred collection newRootObjects.

Return value: The copied object

Parameter destinationOwner: The owner under which the copied object is inserted.

Parameter newRootObjects: TempCollection, which may accept newly-created root

objects.

In Section Instructions Examples Basics History Extra

CS

CS() as IComosDTimestamp

Returns the timestamp (creation stamp) at the time of the first save action.

In Section Instructions Examples Basics History Extra

DeleteAll

DeleteAll() as Long

Deletes objects including their hierarchical substructure. Does not delete any data
in the database; instead, only sets the DeleteFlag of the objects to True. Before
DeleteAll, CheckDelete must be called.

In Section Instructions Examples Basics History Extra

DeleteErrorObjects
DeleteErrorObjects() as IComosDObjectCollection

Returns objects for which CheckDelete has a value <>0.

In Section Instructions Examples Basics History Extra

Description

Description() as String

Object description text; display depends on the language currently set.

In Section Instructions Examples Basics History Extra

DiscardUpdateData

DiscardUpdateData ( ByVal Recursive as Boolean )

Parameter Recursive as boolean

True: All objects below the current object are discarded in the consolidation
layer.

False: In all other cases.

Method is used as part of a database update.

The method specifies:

Always: The status is discarded in the update layer for the current object. The
status in the customer layer is retained.
In addition, if recursive = true: The status is retained in the customer layer for
all child objects.

In Section Instructions Examples Basics History Extra

Dispatch

Dispatch() as Object

Returns the Dispatch interface, necessary to achieve Late-Binding .

In Section Instructions Examples Basics History Extra

ForcedRelease

ForcedRelease() as Boolean

Sets a flag at the object which, in the case of True, allows the object to be
deleted from the cache by means of ReleaseObjects, as a matter of priority.

See also Chapter ReleaseObjects.

In Section Instructions Examples Basics History Extra

FullLabel

FullLabel() as String
Returns the Label of the object including all owners. Superior folder objects are
not considered.

Note Point to note in the case of Connector.FullLabel:

Background information: Connector.FullLabel

In Section Instructions Examples Basics History Extra

FullLabelWithoutFolder

FullLabelWithoutFolder() as String

Returns the Label of the object including all owners. Folder objects are not
considered.

In Section Instructions Examples Basics History Extra

FullName

FullName() as String

Name of the object including all owners. Superior folder objects are not
considered.

In Section Instructions Examples Basics History Extra

GetBackPointerRightsWithReference
IComosDOwnCollection GetBackPointerRightsWithReference()

Returns a collection with all rights objects which use the current object (this) as
a reference.

Return value: Collection with rights objects (type IComosDRight) which point to the
current object.

In Section Instructions Examples Basics History Extra

GetDeleteFlag

GetDeleteFlag() as Boolean

Boolean value for DeleteFlag of the object. True in the case of deleted objects.

In Section Instructions Examples Basics History Extra

GetHashCode

long GetHashCode()

Returns a 32-bit hash value that uniquely identifies the current object. The
special feature of this method is that it can be used even if the object has
already been deleted.

Return value: 32-bit integer value which uniquely identifies the current object.
In Section Instructions Examples Basics History Extra

GetInternationalDescription

string GetInternationalDescription(long languageIndex)

Returns the description of the current object (this) in the language specified by
the index.

Return value: Description in the specified language or empty string if no

description exists for the specified language yet.

Parameter languageIndex: Specifies the language in which the description is to be

provided. 1 corresponds to the first language that is defined in the project, 2 to
the second, etc.

In Section Instructions Examples Basics History Extra

GetInternationalLabel

GetInternationalLabel(Index As Long) As String

Localized (foreign-language) text for the label. The number in the index of the
project languages is used as the parameter. As of COMOS version 8.1, only the label
of physical units is translated.

In Section Instructions Examples Basics History Extra

GetNextTextFromNumberRangeGenerator

GetNextTextFromNumberRangeGenerator ( ByVal property as Long ) as String

Parameter property as long

Property for which the next text is to be supplied

NumberRangeGeneratorSelectedPropertyName

NumberRangeGeneratorSelectedPropertyLabel

This method may only be used when the method "TextIsProvidedByNumberRangeGenerator"

was used before to check that a relevant NumberRangeGenerator exists for the
current object.

The method provides the next text supplied by the NumberRangeGenerator for the
specified property. If the permitted range in the NumberRangeGenerator is
exhausted, an empty string is supplied.

In Section Instructions Examples Basics History Extra

GetObjectByPathFullName

GetObjectByPathFullName(Val as String) as Object

Searches the object for the stated PathFullName (see there).

In Section Instructions Examples Basics History Extra

GetObjectOverlayBehavior

GetObjectOverlayBehaviour(Type as Long) as Boolean

Method from the working layer environment. States the behavior of an object in the
working layer environment:

Type ObjectOverlayBehaviour_Release
Response in case of release: Should this object be released? Default = yes.

Type ObjectOverlayBehaviour_Relevant

Should this object be included in a layer in the event of a change? Default = yes.

See also SetObjectOverlayBehaviour.

In Section Instructions Examples Basics History Extra

GetObjectRights

GetObjectRights() As Long

The effective COMOS rights of the object for the current user. Rights: Read, Write,
Create, Delete, Revision rights (3x), Rights allocation.

See also Chapter Rights.

In Section Instructions Examples Basics History Extra

GetOwnInternationalDescription

GetOwnInternationalDescription(Val as Long) As String

The object’s own description text in the language specified by the parameter.

In Section Instructions Examples Basics History Extra

GetSavedAndDeleted

GetSavedAndDeleted() As Boolean

If GetSavedAndDeleted = True, then the relevant object is marked as deleted in the

database.

See also Chapter Deleted.

In Section Instructions Examples Basics History Extra

GetScriptEngine

GetScriptEngine(block As Long) As Object

See ScriptEngine, also evaluates the specified ScriptBlock. A ScriptEngine is only

returned if a function exists in this or the global block.

In Section Instructions Examples Basics History Extra

GetShadowCollection

GetShadowCollection ( ByVal Location as Long, ByVal collectionType as String ) as

IComosDCollection

Parameter Location as integer

Selection of the working layer

1: Update collection layer

2: Delta layer

Parameter collectionType as string

Method name of the method used to form the collection

OwnSpecifications

OwnConnectors

OwnCConnectors

OwnDevSymbols

CLinks

DocObjects

Forms a collection of objects. The collection is visible when you are logged in the
respective working layer. The GetShadowCollection method is an auxiliary method in
connection with the database update.

In Section Instructions Examples Basics History Extra

GetSoftDeleteFlag

GetSoftDeleteFlag() As Boolean

Method from the working layer environment. Shows if an object was deleted in a
layer. These are not removed from the object model, but instead are marked as
deleted with the SoftDelete-Flag. The objects exist in the object model, depending
on the SoftDeleteFilter (see Workset.SoftDeleteFilter). Objects with SoftDelete-
Flag are Read-Only.

In Section Instructions Examples Basics History Extra

GetStatusBase

GetStatusBase(long index, [out, retval]long* retVal)

Returns the status of the object specified via the index parameter. There are 13
different statuses, meaning that index may be in the range between 1 and 13. The
result of the method is a value between 0 and 3. The special feature of this method
is that all system types except for Device use the new query-based status
maintenance feature (provided this is activated on the current project).

In Section Instructions Examples Basics History Extra

GetSystemStatus

GetSystemStatus(ByVal type as long) as long

Determines various items of status information for the object regarding working
layers. This information is called in the working layers and history display or for
the object status on the interfaces, for example. The following constants can be
used for type :

System_Status_Overlay (100)

Returns the status for the working layer display on the interface. This status is
determined from the individual statuses listed below.

System_Status_ObjectRevision (101)

Returns the change status of the object for the comparison time, which is set with
Workset.SetCompareTimestamp . This status is used for the history display in the
interface.
System_Status_Overlay_Object (102)

Returns the processing status of the object in the layer: [unchanged, new, changed,
deleted in the layer, contained in another layer].

System_Status_Overlay_Structure (103)

The return value states whether there is at least one secondary object in the layer
that is new or has been changed.

System_Status_Overlay_SubObjects (104)

The return value states whether there is at least one mapped object in the layer
that is new or has been changed.

System_Status_Overlay_Collision (105)

The return value states whether a collision was noted at the object.

System_Status_Overlay_Collision_In_SubObjects (106)

The return value states whether there is at least one changed or newly-mapped
object with a collision in the layer.

System_Status_Overlay_Collision_In_Structure (107)

The return value states whether there is at least one changed or newly-secondary
object with a collision in the layer.

System_Status_Overlay_Collision_Delete_In_SubObjects (108)

The return value states whether there is at least one deleted mapped object with a
collision in the layer (hard delete from the released area).

System_Status_Overlay_Collision_Delete_In_Structure (109)

The return value states whether there is at least one deleted secondary object with
a collision in the layer (hard delete from the released area).

System_Status_Overlay_SoftDelete_In_Structure (110)
The return value states whether there is at least one deleted secondary object in
the layer.

System_Status_Overlay_SoftDelete_In_SubObjects (111)

The return value states whether there is at least one deleted mapped object in the
layer.

System_Status_Overlay_Collision_SoftDelete_In_Structure (112)

The return value states whether there is at least one deleted secondary object with
a collision in the layer.

System_Status_Overlay_Collision_SoftDelete_In_SubObjects (113)

The return value states whether there is at least one deleted mapped object with a
collision in the layer.

System_Status_Overlay_Do_Not_Release_Object (114)

The return value states whether the object is not to be taken into consideration in
the case of a release.

System_Status_Overlay_Object_Not_OverlayRelevant (115)

The return value states whether the object is not layer-relevant.

System_Status_Overlay_ID (116)

The return value is the ID of the layer from which the object currently originates.

In Section Instructions Examples Basics History Extra

GetUserRights

GetUserRights(Val as Object) as Long

The effective COMOS rights of the object for the specified user. Rights: Read,
Write, Create, Delete, Revision rights (3x), Rights allocation.

See also Chapter Rights.

In Section Instructions Examples Basics History Extra

HexAddress

HexAddress() As String

Returns a unique identifier for a COMOS object. This ID remains constant for each
COMOS session. By contrast, the COMOS SystemUID for inherited objects, or for
objects that have been checked into working layers, does not remain constant for
each session.

However, the HexAddress may not be saved in archives or similar, since the COMOS
object will be given a different HexAddress in the next COMOS session.

In Section Instructions Examples Basics History Extra

Histories

Historys() As IComosDHistorys

Returns a set of IComosDHistory entries for an object. These contain the values
that this object previously had in the released area (object history).

In Section Instructions Examples Basics History Extra

InfoText
InfoText() As String

Name, Label, Description, Class, Owner, etc. of the object as a string.

In Section Instructions Examples Basics History Extra

InheritCheckIn

InheritCheckIn()

Checks in the inherited object.

Example

3 attributes are assigned to a CDevice, and a Device related to it inherits these 3

attributes. The following also apply to this Device:

Dev.Specifications.Count = 3

Dev.OwnSpecifications.Count = 0

These 3 specifications are SystemTemporary (i.e. read-only) and they first have to
be checked in before they can be edited. This is carried out using the
InheritCheckIn instruction. (Sp1.InheritCheckIn)

Dev.Specifications.Count = 3

Dev.OwnSpecifications.Count = 1

The IsInheritCheckInEnabled method shows whether it is possible to check them in.

In Section Instructions Examples Basics History Extra

InheritMode

InheritMode() As Long

Mode for the behavior of this object when inheriting. There are currently three
modes (and three constants of the InheritMode).

active

inactive

inactive in the base object tree

In Section Instructions Examples Basics History Extra

InheritParent

InheritParent() As Object

Object from which properties are inherited. The inherited information is calculated
when a property at the object is queried for the first time.

In Section Instructions Examples Basics History Extra

InheritStatus
InheritStatus() As String

" " Object only in OwnCollection

This object was not inherited at any time.

"P" object was checked in

This object was initially inherited and then checked in. By checking in, the object
was also added to the OwnCollection.

Display: the icon is supplemented by a white arrow.

"E" object is inherited

Display: the icon is supplemented by a filled arrow.

It is quicker to use SystemTemporary to distinguish between inherited and non-

inherited objects. This is output in some list windows, for example.

In Section Instructions Examples Basics History Extra

Invalid

Invalid ( ) as Boolean

True: The current object is invalid or outdated and must be reloaded. Examples why
an object can be invalid:

Working layer was changed

Object was changed on another workstation

False: In all other cases.

In Section Instructions Examples Basics History Extra

IsAdminLocked

IsAdminLocked ( ) as Boolean

True: Object is locked with AdminLock

False: All other cases

Returns the status of the "AdminLock" flag.

In Section Instructions Examples Basics History Extra

IsAlias

IsAlias() As Boolean

Checks whether an object is in the Alias tree; i.e. in the unit view or location
view under @Alias.

In Section Instructions Examples Basics History Extra

IsChanged
IsChanged() As Boolean

Checks whether the object has been changed since the last save.

In Section Instructions Examples Basics History Extra

IsChangedAll

IsChanged() As Boolean

Checks whether the object has been changed since the last save.

In Section Instructions Examples Basics History Extra

IsExpandable

IsExpandable ( ) as Boolean

True: Object is locked with "AdminLock" or "SysLock" and child objects may be
created.

False: All other cases

Returns the status of the "Expandable" flag. The "Expandable" flag specifies if
additional objects can be created below an object locked with "AdminLock" or
"SysLock". This flag has no meaning for unlocked objects.
In Section Instructions Examples Basics History Extra

IsFolder

IsFolder() As Boolean

Folder property; the Boolean value is evaluated for FullName, FullLabel, etc.

In Section Instructions Examples Basics History Extra

IsInheritCheckInEnabled

IsInheritCheckInEnabled() As Boolean

Checks whether the InheritCheckIn method can be called successfully.

In Section Instructions Examples Basics History Extra

IsLocked

IsLocked() As Boolean

Displays whether the object was locked with the aid of the Properties Lock or
SystemLock in order to prevent changes. (Lock = True, SystemLock > 0)

In Section Instructions Examples Basics History Extra

IsOwnAdminLocked

IsOwnAdminLocked ( ) as Long

Return value: long

0: Object is not locked (off)

1: Object is locked (on)

2: Undefined, use inheritance

Returns the status of the "AdminLock" flag set at the object.

Difference to "IsAdminLocked" flag: The "IsAdminLocked" flag returns the status set
at the object as well as an inherited status.

In Section Instructions Examples Basics History Extra

IsOwnExpandable

IsOwnExpandable ( ) as Long

Return value: long

0: Object is not expandable (off)

1: Object is expandable (on)

2: Undefined, use inheritance

Returns the status of the "Expandable" flag set at the object. Difference to
"IsExpandable" flag: The "IsExpandable" flag returns the status set at the object
as well as an inherited status.

In Section Instructions Examples Basics History Extra

IsOwnSysLocked

IsOwnSysLocked ( ) as Long

Return value: long

0: Object is not locked (off)

1: Object is locked (on)

2: Undefined, use inheritance

Returns the status of the "SysLock" flag set at the object. Difference to
"IsSysLocked" flag: The "IsSysLocked" flag returns the status set at the object as
well as an inherited status.

In Section Instructions Examples Basics History Extra

IsOwnSystemRelevant

IsOwnSystemRelevant ( ) as Long
Return value: long

0: Object is not system relevant (off)

1: Object is system relevant (on)

2: Undefined, use inheritance

Returns the status of the "SystemRelevant" flag set at the object. Difference to
"IsSystemRelevant" flag: The "IsSystemRelevant" flag returns the status set at the
object as well as an inherited status.

In Section Instructions Examples Basics History Extra

IsSameCheckedInObject

IsSameCheckedInObject(Val as Object) as Boolean

Checks whether both objects would produce the same object on checking in (no longer
necessary with the current inheritance mechanism).

In Section Instructions Examples Basics History Extra

IsSaved

IsSaved() As Boolean

Checks for the existence of the object in the database.

In Section Instructions Examples Basics History Extra

IsShadowObject

IsShadowObject ( ) as Boolean

True: The current object is a shadow object.

False: In all other cases.

In Section Instructions Examples Basics History Extra

IsSysLocked

IsSysLocked ( ) as Boolean

True: Object is locked with "SysLock"

False: All other cases

Returns the status of the "SysLock" flag.

In Section Instructions Examples Basics History Extra

IsSystemRelevant
IsSystemRelevant ( ) as Boolean

True: Object is important for COMOS functionality.

False: All other cases

In Section Instructions Examples Basics History Extra

IsVirtual

IsVirtual() As Boolean

Checks whether the object is a virtual unit or location. (Old NameSystem

technology). No connection to CDevice.Virtual!

In Section Instructions Examples Basics History Extra

IsXObjLoaded

IsXObjLoaded([out, retval] VARIANT_BOOL* retVal)

Returns TRUE if the current COMOS object owns an XObject and this has already been
loaded in the memory. FALSE is returned for COMOS objects that do not own an
XObject or whose XObject has not yet been loaded in the memory.

In Section Instructions Examples Basics History Extra

Label

Label() As String

Label, generally available for objects of the classes: CDevice, Device, Document,
PhysUnit, PhysUnitGroup. Also available for all others in read-only status; instead
returns the name of the object.

In Section Instructions Examples Basics History Extra

LoadAll

LoadAll()

Loads objects together with their substructure (as with copying) and, at the end,
shows a message containing the number of objects found and the time required.

In Section Instructions Examples Basics History Extra

LoggedDeleteAll

LoggedDeleteAll([out, retval] long* retVal)

This method cannot be used any more for technical reasons and may be removed in a
future version. A warning will be displayed if it is called.

In Section Instructions Examples Basics History Extra

MatchScan
MatchScan(Val as Object) as Boolean

Checks whether the object matches the search carried out via Workset.Scan. In the
same way as for the function pair in ScanDevices in connection with
MatchScanDevices, but in this case without any object restriction (not only for
device).

In Section Instructions Examples Basics History Extra

Merge

Merge(slaveObject as IComosBaseObject, mergeMode as Long)

Merges two objects of the same object type. CheckMerge is performed prior to the
merge operation to check the preconditions. See section CheckMerge.

Supported object types

You can find additional information on this topic in the "COMOS Platform
Administration" manual, section "Merging objects", keyword "Methods in the
COMOS.dll".

Parameters

slaveObject as IComosBaseObject

Pointer to the slave object to be merged with the master object.

mergeMode as Long

Controls the processing of properties and subobjects.

In Section Instructions Examples Basics History Extra

Name
Name() as String

The object name must be unique throughout the collection of the owner. However, for
Devices the OwnerCollection has to be unique in addition to the FullName.

In Section Instructions Examples Basics History Extra

ObjectCanBeCopiedOrMovedToNewOwnerWithNRG

ObjectCanBeCopiedOrMovedToNewOwnerWithNRG ( ByVal newOwner as Object, ByVal

checkCopy as Boolean ) as Boolean

Parameter newOwner as object

The target object under which the object is to be moved or copied.

Parameter checkCopy as boolean

True: Object is copied

False: Object is moved

Auxiliary method for the NumberRangeGenerator.

This method checks if it is permitted to copy or move an object under another

object. It is not permitted to copy or move the object if:

A NumberRangeGenerator is active at the target object

The NumberRangeGenerator were also responsible for the object to be copied or moved

The number range of the NumberRangeGenerator is exhausted

In Section Instructions Examples Basics History Extra

ObjectHistoryEntries

ObjectHistoryEntries

ObjectHistoryEntries(WithRecursion as Boolean, WithStackUp as Boolean) as

IComosDObjectHistoryEntries

Returns the history entries of an object. The history entries of an object are
sorted by layer (the released area first) and in ascending order by the period of
validity.

WithRecursion

WithRecursion = FALSE

Only history entries of the object itself are determined.

WithRecursion = TRUE

The history entries of the object and all objects located below it are determined.

Note With this variation, all objects of the layer must be checked. The runtime is
therefore proportional to number of objects in the layer.

WithStackUp

WithStackUp = FALSE

Only history entries of the current layer of the object are determined.

WithStackUp = TRUE

The history entries of all layers that are part of the overlay are determined.
Superordinate layers come first in the collection.
In Section Instructions Examples Basics History Extra

Owner

Owner() as Object

Returns the hierarchically superordinate object.

In Section Instructions Examples Basics History Extra

OwnerByClass

OwnerByClass(Val As String) As Object

Returns the first superordinate object of the hierarchy from one of the stated
classes.

If the class passed as parameter is identical to the class of the object at which
the function is called: Returns the object.

In Section Instructions Examples Basics History Extra

OwnerByClassificationKey

OwnerByClassificationKey ( ByVal searchKey as Long, ByVal searchClassification as

String ) as Object

Parameter searchKey

Index of classification type in which search is to take place. Constants see Module
ClassificationTypes or keyword "classificationIndex".

Notice

searchKey begins with 0

Due to software requirements, the searchKey begins with 0 and not 1. A

classification type which is called in ClassificationExists with the index 1, must
be called here with the index 0.

Parameter searchClassification

Searched classification

0 - Hierarchical classification

1 - Functional classification

2 - User-specific functional classification

3 - User-specific hierarchical classification

This method searches the chain of owners starting at the current object.

Abort conditions:

An object with the specified classification is found

The end of the object hierarchy has been reached (no additional child object
exists). NULL is returned in this case.

Example:

Set xyz = a.OwnerByClassificationKey(1, ".AB.")

0: Classification type "Functional classification". (Here the index 0 is for

"functional classification" because the searchKey begins with 0)
This means there is a check at object "a" to see if the functional classification
includes the string ".AB.". If this is the case, then xyz is set to a. If not, then
the owner is checked by a.

Separator

The separator is the period. The separator is specified as follows in the

searchString:

Parameter 0 - hierarchical classification: If a classification needs to be searched

for that covers several layers, the individual layers need to separated by a
period.

Example: Hierarchical classification level 1: "M21", hierarchical classification

level 2: "A050". The searchString is: "M21.A050"

Parameter 1 - functional classification: If a classification needs to be searched

for that can be located anywhere, the enclosing periods can be omitted.

Example: Functional classification 1: "O4", functional classification 2: "A870":

The searchString "A870" is permitted.

In Section Instructions Examples Basics History Extra

OwnerCollection

OwnerCollection() as Object

The collection of the hierarchically-superior object in which the current object is

located. This function offers a straightforward option of accessing other objects
of this collection without the need for a detour via the owner. Each object is
located in exactly one OwnerCollection.

In Section Instructions Examples Basics History Extra

OwnXMLString
OwnXMLString() as String

Own-Property to IComosBaseObject.XMLString.

In Section Instructions Examples Basics History Extra

OwnXObjExist

OwnXObjExist(in_db As Boolean) As Boolean

Specifies whether an own XObj exists at this object.

See also Chapter XObjExist.

In Section Instructions Examples Basics History Extra

Paste

Paste(Val As Object, newobject As Object, Save As Boolean) As Long

Instruction to paste the specified objects underneath the current object and to
save them if required. The first parameter can be either a IComosBaseObject or a
IComosDCollection (TempCollection), depending on whether one or more objects are to
be pasted.

The new owner is the current object at which the function was called.

The Save parameter defines whether saving should be carried out immediately after
executing the function.

Save should be set to FALSE in cases where the option to undo or cancel is
required, since otherwise the database will be directly updated when the function
is run. The Paste function already includes a call for the CheckForPaste function,
meaning that a prior CheckForPaste function call is only required in cases that
require interaction and/or a separate evaluation of the result of the CheckForPaste
action.
In Section Instructions Examples Basics History Extra

Paste2

Paste2(val as Object) as Long

Same as Paste(). See also Chapter (Paste).

Paste2() owns a restricted parameter list that allows the function to be used in
scripts.

Only the quantity of objects to be copied is transferred as a parameter in this

case (IComosDCollection; may also be a IComosBaseObject).

When the Paste() function is executed and the save parameter is used to specify
whether to save immediately after executing the function, saving will not be
carried out immediately in the case of Paste2().

In Section Instructions Examples Basics History Extra

PathFullName

PathFullName(Val as Object) as String

Unique FullName (includes the names and classes of the owner objects) relative to
the specified object.

In Section Instructions Examples Basics History Extra

Project
Project ( ) as IComosDProject

Returns the project in which the object is located.

In Section Instructions Examples Basics History Extra

RecalculateHierarchyInformation

void RecalculateHierarchyInformation()

Recalculates the working layer display, starting at the current object (this),
including all subobjects.

In Section Instructions Examples Basics History Extra

RelativLabel

RelativLabel(Val as Object) as String

Searches the shared owner of the object and the parameter object and outputs the
labels from this point up to the object.

Example:

With Device_B.RelativeLabel (document), the following is returned:

Label(Unit2)|Label(Device_B) .

Note There is a character between Label(Unit2)|Label (Device_B)! This involves the

delimiter that is set in the project options (a pipe character in this case).
Background:

A prefix and a delimiter can be set in the project options.

With FullLabel, the entire path name is output as one item, so that no prefix is
used. With RelativLabel, only parts of the path name are output. If you were to
"assemble" a FullLabel from multiple RelativLabel , then in theory the setting of
the prefix would have an effect.

However, if the prefix and delimiter were to be set differently, then a

hierarchical RelativLabel assembly would differ from a FullLabel.

Definition

The addition of the hierarchical RelativLabel must result in the same text as a
FullLabel . For that reason, the prefix is not evaluated in RelativLabel and only
the delimiter is used.

Note The prefix is used, however, in SignedLabel, ULFullName, ULFullLabel and

NestedLabel.

In Section Instructions Examples Basics History Extra

RelativLabel2

RelativLabel2(ByRef val1 as Object, ByVal consideralias as Boolean, ByVal

withoutfolder as Boolean) as String

Similar to RelativLabel(). See also Chapter RelativLabel.

Checks whether the object transferred as parameter val1 is the direct owner of the
object for which the method is called.

If yes, the labels are concatenated up to that object, with the exception of the
val1 label.

If no, the FullLabel of the object is returned.

Parameter consideralias:

Responsible for the Alias variant. (AliasRelativLabel)

Parameter withoutfolder:

Responsible for the WithoutFolder variant (compare AliasRelativeLabelWithoutFolder,

RelativLabelWithoutFolder).

In Section Instructions Examples Basics History Extra

RelativLabelWithoutFolder

RelativLabelWithoutFolder(Val as Object) as String

Returns the RelativLabel of the object including all owners. No folder objects are
considered.

In Section Instructions Examples Basics History Extra

RemoveFromWorkingOverlay

RemoveFromWorkingOverlay(ByVal Recursive as boolean) as IComosDCollection

Method from the working layer environment.

Removes the current object and (as an option) all objects located underneath it
(recursive = TRUE) from the current working layer.

If the permissions for removal from the working layer are missing for one or more
objects in the set to be removed, then no object is removed. All objects for which
there are no permissions are listed in the returned IComosDCollection.

In Section Instructions Examples Basics History Extra

Restore
Restore(Val as Object)

Restore restores an object to the state created during the backup process (it is
better to use Save and Undo).

In Section Instructions Examples Basics History Extra

RestoreFromHigherWorkingOverlay

RestoreFromHigherWorkingOverlay() as Boolean

Method from the working layer environment. Removes the object from the current
layer. This function only restores the object on which the function was called.
Caution: This is not a COMOS delete action. When deleting is carried out in COMOS,
the SoftDeleteFlag is set (see IcomosBaseObject.GetSoftDeleteFlag).

In Section Instructions Examples Basics History Extra

RS

RS() as IComosDTimestamp

Revision stamp, gets the timestamp from the save action.

In Section Instructions Examples Basics History Extra

Save
Save() as Long

Saves the current object. Use this in conjunction with Check! Example: see Check

In Section Instructions Examples Basics History Extra

SaveAll

SaveAll() as Long

Saves the current object, including the complete substructure; use this in
conjunction with CheckAll! Example: see CheckAll

In Section Instructions Examples Basics History Extra

ScanDevices

ScanDevices(Val as String) as IComosDCollection

Searches the subordinate structure for objects of the specified classes and
collects them in a list, also inherited objects. Parameter: Classes to be searched
(DeviceClass).

Empty string: All classes. In other words, all Device in the collection are
returned.

As soon as a single class is specified, only the explicitly-specified classes are

returned. If a class is missing in the string, then this class is not returned.

N* : Search and return objects of class N and continue to search and return below.

N : Search and return objects of class N and then stop. (Children of the Device
with class N are not searched anymore).
<String>: With the exception of the classes referred to in the string.

Note The inversion "-" cannot be used alone or mixed with other parameters (e.g.
"*"). It is only possible to invert the entire string with "-".

However, the workset currently provides a better function: Scan.

This function replaces all ScanDevices functions, i.e.

ScanDevices

ScanDevicesWithCObject

ScanDevicesWithCObjectX

ScanDevicesX

Main advantages

Scan is faster and provides more control options. All ScanDevices functions
continue to be supported, however.

See also section Scan.

In Section Instructions Examples Basics History Extra

ScanDevicesWithCObject

ScanDevicesWithCObject(Val1 as String, Val2 as Object) as IComosDCollection

In a similar way to ScanDevices, searches the structure for objects of the
specified classes; checks for inheritance from the specified CDevice; and collects
relevant objects in a list. (Parameter1 the classes to be searched, Parameter2
CDevice). Permissible parameters: DeviceClass.

However, the workset currently provides a better function: Scan.

This function replaces all ScanDevices functions, i.e.

ScanDevices

ScanDevicesWithCObject

ScanDevicesWithCObjectX

ScanDevicesX

Main advantages:

Scan is faster and provides more control options. All ScanDevices functions
continue to be supported, however.

See also Chapter Scan.

In Section Instructions Examples Basics History Extra

ScanDevicesWithCObjectX

ScanDevicesWithCObjectX(Val1 as String, Val2 as Object, Val3 as String) as

IComosDCollection

In a similar way to ScanDevices, searches the structure for objects of the

specified classes, but not underneath the classes identified in parameter 3.

Val1: Search classes

List of classes that are to be output; see also the explanation provided for
ScanDevices.
Val2: CDevice

Limiting the search set: Val2 checks for inheritance from the specified CDevice and
collects the corresponding objects in a list. Without this parameter this function
is processed like ScanDevicesX.

Val3: Stop classes

You can use Val3 to specify the classes where the search is terminated. If any
objects of the specified classes are found, then no further searching is carried
out in the relevant hierarchical substructure. The classes are specified in string
form, in accordance with DeviceClass. It is possible to specify multiple classes
simultaneously. No class delimiter is required for this purpose (classes can be
written one after the other directly, without inserting a space character).

Optional: "#" for Val3

"#" = ScanDevicesStopDocobj

Terminates the search when DocObj is reached.

Technical background:

DocObj references are also retraced during the search. If the search moves
underneath a document and a position is placed on this document, for example, then
a DocObj for this position is located underneath the document. The search finds the
DocObj and then searches for the corresponding system type Device of class
Position.

The "#" option above means that the references will not be retraced and the placed
position will not, therefore, be found.

However, the workset currently provides a better function: Scan.

This function replaces all ScanDevices functions, i.e:

ScanDevices

ScanDevicesWithCObject

ScanDevicesWithCObjectX

ScanDevicesX
Main advantages:

Scan is faster and provides more control options. All ScanDevices functions
continue to be supported, however.

See also Chapter Scan.

In Section Instructions Examples Basics History Extra

ScanDevicesWithDeleted

ScanDevicesWithDeleted(Val as String) as IComosDCollection

Similar to ScanDevices, but also returns objects with GetSavedAndDeleted = True

from the selected class.

In Section Instructions Examples Basics History Extra

ScanDevicesX

ScanDevicesX(Val1 as String, Val2 as String) as IComosDCollection

In a similar way to ScanDevices, searches the structure for objects of the

specified classes, but not underneath classes identified with Val2 . This class
restriction enables shorter scan times.

Val1 : List of classes that are to be output; see also the explanation provided for
ScanDevices.

Val2 specifies classes at which the search terminates. If any objects of the
specified classes are found, then no further searching is carried out in the
relevant hierarchical substructure. The classes are specified in string form, in
accordance with DeviceClass. It is possible to specify multiple classes
simultaneously. No class delimiter is required for this purpose (classes can be
written one after the other directly, without inserting a space character).
However, the workset currently provides a better function: Scan.

This function replaces all ScanDevices functions, i.e.

ScanDevices

ScanDevicesWithCObject

ScanDevicesWithCObjectX

ScanDevicesX

Main advantages:

Scan is faster and provides more control options. All ScanDevices functions
continue to be supported, however. See also Chapter Scan.

Optional: "#" for Val2

"#" = ScanDevicesStopDocobj

Terminates the search when DocObjs is reached.

Technical background: DocObj references are also retraced during the search. If the
search moves underneath a document and a position is placed on this document, for
example, then a DocObj for this position is located underneath the document. The
search finds the DocObj and then searches for the corresponding system type Device
of class Position.

The "#" option above means that the references will not be retraced and the placed
position will not, therefore, be found.

In Section Instructions Examples Basics History Extra

ScanDocuments

ScanDocuments(Val as Long) as IComosDCollection

Returns the documents in a collection below the object, depending on the
parameters:

0: no documents below documents

1: no TIFF documents

2: all

In Section Instructions Examples Basics History Extra

ScanObjects

ScanObjects(Val as String) as IComosDCollection

All subordinate objects of the specified class in a collection. Parameter: Classes

in string form. Performance advantages by restricting to the hierarchical
substructure without inherited objects.

Example

ScanObjects("Connector|Specification")

In Section Instructions Examples Basics History Extra

ScanObjectsByClass

IComosDCollection ScanObjectsByClass([in] string objectType)

Specialized Scan method which searches for all objects of the specified type,
starting from the current object (this).

Return value: A collection of type IComosDCollection which contains all the objects
found.
Parameter objectType: Specifies which object types will be searched for. The
following values are supported:

CDevice

Device

Document

All other values will produce an error message.

In Section Instructions Examples Basics History Extra

ScriptEngine

ScriptEngine() as Object

Microsoft script engine with object properties as global script variables.

Example

Name="..." means Object.Name="..."

In Section Instructions Examples Basics History Extra

SetAdminLocked
SetAdminLocked ( ByVal adminLocked as Long )

Parameter adminLocked as long

0: Object is not locked (off)

1: Object is locked (on)

2: Undefined, use inheritance

In this case the inheritance source specifies if the object is locked. If there is
no preceding object in the inheritance chain, the default value applies: off.

Sets the status of the "AdminLock" flag. Only users with the "Administrator" status
may changes this value.

In Section Instructions Examples Basics History Extra

SetChanged

SetChanged()

Sets the Changed flag at the object.

In Section Instructions Examples Basics History Extra

SetExpandable

SetExpandable ( ByVal expandable as Long )

Parameter expandable as long

0: Object is not expandable (off)

1: Object is expandable (on)

2: Undefined, use inheritance

In this case the inheritance source specifies if the object is expandable. If there
is no preceding object in the inheritance chain, the default value applies: off.

Sets the status of the "Expandable" flag. The flag specifies if additional objects
can be created below an object locked with "AdminLock" or "SysLock". The
"Expandable" flag cannot be changed for unlocked objects.

In Section Instructions Examples Basics History Extra

SetInternationalDescription

SetInternationalDescription(Val1 as Long, Val2 as String)

Sets the object's own description text (parameter 2) for the specified object to
the language specified by parameter 1.

In Section Instructions Examples Basics History Extra

SetInvisibleOnMerge

SetInvisibleOnMerge ( )

For internal use.

The method prevents that objects are deleted in case of merge. The objects receive
an identification instead which makes them invisible to the outside.

In Section Instructions Examples Basics History Extra

SetObjectOverlayBehavior

SetObjectOverlayBehaviour(Type as Long, On as Boolean)

Member of: Plt.IComosBaseObject

method SetObjectOverlayBehaviour

Allows you to set the behavior of an object in the working layer environment:

Type ObjectOverlayBehaviour_Release

Response in case of release: should this object be released (default = yes).

Type ObjectOverlayBehaviour_Relevant Is this object to be accepted into a layer

when a change is made (default = yes).

See also Chapter GetObjectOverlayBehavior.

In Section Instructions Examples Basics History Extra

SetOwnInternationalDescription

SetOwnInternationalDescription(Val1 as Long,Val2 as String)

Sets the object's own description text (parameter 2) for the specified object to
the language specified by parameter 1.
In Section Instructions Examples Basics History Extra

SetSysLocked

SetSysLocked ( ByVal sysLocked as Long )

Parameter sysLocked as long

0: Object is not locked (off)

1: Object is locked (on)

2: Undefined, use inheritance

In this case the inheritance source specifies if the object is locked. If there is
no preceding object in the inheritance chain, the default value applies: off.

Sets the status of the "SysLock" flag. Only users with the "Administrator" status
may changes this value.

In Section Instructions Examples Basics History Extra

SetSystemRelevant

SetSystemRelevant ( ByVal systemRelevant as Long )

Parameter systemRelevant as long

0: Object is not system relevant (off)

1: Object is system relevant (on)

2: Undefined, use inheritance

In this case the inheritance source specifies if the object is system relevant. If
there is no preceding object in the inheritance chain, the default value applies:
off.

Sets the status of the "SystemRelevant" flag. The flag classifies the object as
"Important for the functionality of the COMOS system". Only users with the
"Administrator" right and the "System" license can edit this flag.

In Section Instructions Examples Basics History Extra

ShutDownXObj

ShutDownXObj()

Calls ShutDown for theXObj and then sets XObj to ZERO.

In Section Instructions Examples Basics History Extra

SignedLabel

SignedLabel() as String

Label with prefix.

In Section Instructions Examples Basics History Extra

SingleCheckDelete

SingleCheckDelete() As Long

Similar function to CheckDelete. However, it only checks the root object and not
those lying underneath it. This is a special function that can be used, for
example, to quickly disable the "DELETE" popup menu item.

In Section Instructions Examples Basics History Extra

Spec

Spec(Val as String) as IComosDSpecification

Attribute with the specified name: Chapter name. Attribute name.

Example

Obj.Spec("x.y") Abbreviation for:

Specifications.Item("x").Specifications.Item("y")

In Section Instructions Examples Basics History Extra

Specs

Specs() as Object

To be used in the same way as Spec, is just an abbreviated form. Syntax:

Specs.chaptername.attributename
In Section Instructions Examples Basics History Extra

SystemFullName

SystemFullName() as String

Full object name including all owners; pipe characters used as separators ( | ).

In Section Instructions Examples Basics History Extra

SystemRefCount

SystemRefCount() as Long

Integer value for the number of references for the relevant object.

In Section Instructions Examples Basics History Extra

SystemRO

SystemRO() as Boolean

Read-only flag, Boolean value. Possible reasons:

No current project set

Object not in the current project

No write rights

Object inherited

In Section Instructions Examples Basics History Extra

SystemTemporary

SystemTemporary() as Boolean

Boolean value. True for inherited objects

In Section Instructions Examples Basics History Extra

SystemType

SystemType() as Long

Returns the class of the relevant object. Possible values: see SystemType

In Section Instructions Examples Basics History Extra

SystemTypeName
SystemTypeName() as String

Similar to SystemType; an old variant and slower than SystemType due to the string
operations.

In Section Instructions Examples Basics History Extra

SystemUID

SystemUID() as String

The return value is the COMOS UID as a string.

In Section Instructions Examples Basics History Extra

TextIsProvidedByNumberRangeGenerator

TextIsProvidedByNumberRangeGenerator ( ByVal property as Long, out string text ) as

Boolean

Parameter property as long

Specifies the property to be checked.

1: Name

2: Label

Parameter text as string

Output value
If the return value is true: transfers the current value of the
NumberRangeGenerator

Return value boolean

True: A NumberRangeGenerator exists for the current object and the specified
property.

False: In all other cases.

This method checks if a NumberRangeGenerator is responsible for the current object

and the text of the specified property.

Example: The property "Name" is checked for the current object. COMOS then checks:

A NumberRangeGenerator exists for the current objects which sets the name.

A matching base object exists for the current project.

The method "TextIsProvidedByNumberRangeGenerator" returns "true".

If the method returns "true", the text provided by the NumberRangeGenerator is

returned in the "text" output parameter. If the method returns "false", the "text"
parameter is not changed.

If a value is generated simultaneously for the name and the label by means of the
number range, the same number is generated for both properties.

In Section Instructions Examples Basics History Extra

ThisObj
ThisObj() as Object

Pointer to the referenced object. Used when passing parameters in scripts.

In Section Instructions Examples Basics History Extra

Undo

Undo()

Returns objects to the state when they were last saved:

Changed objects: Last saved state

Deleted objects: are restored

New objects: are deleted

In Section Instructions Examples Basics History Extra

UndoAll

UndoAll()

Returns objects to the state when they were last saved, including the complete
substructure.

Changed object: Last saved state

Deleted objects: are restored

New objects: are deleted

In Section Instructions Examples Basics History Extra

UndoDelete

UndoDelete()

Restores deleted objects.

In Section Instructions Examples Basics History Extra

Workset

Workset() as IComosDWorkset

Returns the current Workset.

See also Chapter IComosDWorkset.

In Section Instructions Examples Basics History Extra

XMLGet

XMLGet([in] BSTR xPath, [out, retval] BSTR* retVal)

Reads a XML property or a section according to XML conventions. The property or the
section is stated via xPath and the value/content is returned.
In Section Instructions Examples Basics History Extra

XMLSet

XMLSet([in] BSTR xPath, BSTR value, [out, retval] VARIANT_BOOL* retVal)

Sets an XML Property or section according to XML conventions. The Property or

section is specified by xPath. Value contains the value of the Property or the
content of the section. Returns True or False depending on the outcome.

In Section Instructions Examples Basics History Extra

XMLString

XMLString() as String

Property that can accept XML information.

Structure of the Property:

Root node: COMOS

Subnode:

System (for COMOS entries)

User (for free user entries) underneath always a node per subject.

Note Depending on the object, this Property can also be used by the system for
filing important information. So that you do not lose this information, you may
only work in your own node (e.g. .../COMOS/User/MyNode).
The other areas of the XML string must not be changed or deleted; in particular,
everything under .../COMOS/System.

In Section Instructions Examples Basics History Extra

XObj

XObj() as Object

Extended Binary object. Binary object for user-specific extensions. Used for
queries, for example.

In Section Instructions Examples Basics History Extra

XObjEquals

XObjEquals([in] IComosBaseObject* other, [out, retval] VARIANT_BOOL* retVal)

Conducts a binary comparison of two XObjects. The XObject of the current COMOS
object and the XObject of the transferred COMOS object (parameter 'other') are
compared. If both XObjects are identical according to binary standards, the method
returns TRUE; otherwise, it returns FALSE. If neither COMOS object owns an
XObject , then TRUE is also returned in this case. If only one COMOS object owns an
XObject, then FALSE is returned.

In Section Instructions Examples Basics History Extra

XObjExist
XObjExist() as Boolean

Shows whether an object owns an XObj without loading it immediately. This allows a
significant improvement in performance to be achieved when carrying out checks for
the presence of ( ..if XObj is not nothing ..) in the script.

In Section Instructions Examples Basics History Extra

IComosDCase

This chapter contains the following information:IComosDCase

Type

In Section Instructions Examples Basics History Extra

IComosDCase

COMOS object for the management of cases.

In Section Instructions Examples Basics History Extra

Type

Type() as Long

Differentiation between a case for a project or a Device.

In Section Instructions Examples Basics History Extra

IComosDCDevice

This chapter contains the following information:IComosDCDevice

Active

AllBackPointerDevices

AllBackPointerObjects

AllCConnectors

AllCDevices

AllDeletedBackPointerObjects

AllRealCDevices

AllSpecifications

BackPointerCDevices

BackPointerCLinks

BackPointerDevices

BackPointerObjects

CConnectors

CDeviceConnectString

CDevice

CDevices

CheckCDevice

Class

ClearStatus

CLinks

CObject

CompOrderNr
CompOrderText

ControlProperties

ControlType

CreateOption

DeletedBackPointerObjects

Dereference

DescriptionBlocked

DescriptionBlockedInherited

DescriptionGenerator

DescriptionGeneratorWithIndex

DetailClass

DetailType

DeviceCreateMode

DeviceGroup

DevSymbols

Documents

Elements

EnObs

GetBackpointerBehaviour

GetChildForCDevice

GetClassification

GetElementsByClassification

GetElementsByClassifications

GetFirstElementByClassification

GetFirstElementByClassifications

GetFreeProperty

GetGRSpec

GetImplementationBehaviour

GetOwnBackpointerBehaviour

GetOwnClassification
GetOwnImplementationBehaviour

GetOwnProductRequestBehaviour

GetOwnReferenceBehaviour

GetOwnScriptBlock

GetOwnStatus

GetProductRequestBehaviour

GetReferenceBehaviour

GetScriptBlock

GetStatus

GRSpecCount

GRSpecsInherited

IconFileName

InheritCDevices

IsElement

IsInheritSuccessorFrom

IsRequest

IsRequestInherited

IsSuccessorFrom

LabelBlocked

LabelBlockedInherited

LabelGenerator

LabelGeneratorWithIndex

Layers

Level

NameBlocked

NameBlockedInherited

NameGenerator

NameGeneratorWithIndex

Number
OrderNr

OrderText

OwnActive

OwnCConnectors

OwnClass

OwnControlProperties

OwnControlType

OwnCreateOption

OwnDescription

OwnDetailClass

OwnDeviceCreateMode

OwnDeviceGroup

OwnDevSymbols

OwnDocuments

OwnElements

OwnIconFileName

OwnLabel

OwnLayers

OwnNumber

OwnOrderNr

OwnOrderText

OwnRevisionType

OwnRIClass

OwnScript

OwnSpecifications

OwnVirtual

Prefix

ProjectDevices

ProjectInstance

RealCDevices
RealElements

RegisterForReleaseStaticCollections

RemoveFreeProperty

ResetOwnUniqueLabel

RevisionType

RIClass

RIType

Script

SetBackpointerBehaviour

SetClassification

SetFreeProperty

SetGRSpec

SetImplementationBehaviour

SetOwnClassification

SetOwnScriptBlock

SetProductRequestBehaviour

SetReferenceBehaviour

SetScriptBlock

SetStatus

Specifications

UniqueLabel

UniqueLabelInherited

UniqueLabelIsOwn

UseCases

Virtual

VirtualElements

Visible
In Section Instructions Examples Basics History Extra

IComosDCDevice

COMOS base object (catalog device).

In Section Instructions Examples Basics History Extra

Active

Active() as Long

Constants:

Active_Mode_Normal

Active_Mode_Inactive

If Active_Mode_Inactive: This base object is no longer displayed in any base object

selections but can still be used.

In Section Instructions Examples Basics History Extra

AllBackPointerDevices

AllBackPointerDevices() as IComosDCollection

Collects all objects of class Device that have a Pointer to the current object,
from all the projects in the database in a collection. Caution: Depending on the
size of the database, this function may take a great deal of time and should be
used with caution.
In Section Instructions Examples Basics History Extra

AllBackPointerObjects

AllBackPointerObjects(Val as Long) as IComosDCollection

Collection of all objects of the system type specified in the parameter, from all
projects that have a Pointer to the current object.

In Section Instructions Examples Basics History Extra

AllCConnectors

AllCConnectors() as IComosDCollection

Returns a collection of CConnectoren of the current object, possibly including any

inherited ones, and the CConnectoren of all own elements (only the 1st structural
level).

In Section Instructions Examples Basics History Extra

AllCDevices

AllCDevices() as IComosDCollection

Complete collection of all subordinate CDevices (recursive, no elements) and all

CDevices linked by CLinks (recursive).
In Section Instructions Examples Basics History Extra

AllDeletedBackPointerObjects

AllDeletedBackPointerObjects(Val as Long) as IComosDCollection

Same as AllBackPointerObjects, but in this case only those with GetSavedAndDeleted-

Flag "True".

See also Chapter AllBackPointerObjects.

In Section Instructions Examples Basics History Extra

AllRealCDevices

AllRealCDevices() as IComosDCollection

Collection of all subordinate CDevices (recursive, no elements). Unlike

AllCDevices, CDevices linked by CLinks are not considered.

In Section Instructions Examples Basics History Extra

AllSpecifications

AllSpecifications() as IComosDCollection

Collection of own attributes, possibly including any inherited ones, and the
attributes of the own elements.
In Section Instructions Examples Basics History Extra

BackPointerCDevices

BackPointerCDevices() as IComosDOwnCollection

Returns a BackPointer collection of CDevice objects that have a pointer to the

current object.

In Section Instructions Examples Basics History Extra

BackPointerCLinks

BackPointerCLinks() as IComosDOwnCollection

Returns a set of CLinks that have a Pointer to the current object.

In Section Instructions Examples Basics History Extra

BackPointerDevices

BackPointerDevices() as IComosDCollection

As with AllBackPointerDevices, a database-supported collection of objects of class

Device, but restricted to the current project.
In Section Instructions Examples Basics History Extra

BackPointerObjects

BackPointerObjects(Val as Long) as IComosDCollection

Collection of all objects of the system type specified with the parameter that own
pointers to the current object. Restricted to the current project.

See also AllBackPointerObjects.

In Section Instructions Examples Basics History Extra

CConnectors

CConnectors() as IComosDCollection

Collection of own and inherited connectors.

In Section Instructions Examples Basics History Extra

CDeviceConnectString

CDeviceConnectString() as String

A string containing former Pointer information to the CDevice reference, is created

when the project is connected or disconnected.
In Section Instructions Examples Basics History Extra

CDevice

CDevice() as IComosDCDevice

CDevice-PointerInheritance takes place by means of this.

In Section Instructions Examples Basics History Extra

CDevices

CDevices() as IComosDOwnCollection

Set of hierarchically-subordinate CDevices of the first hierarchy level.

In Section Instructions Examples Basics History Extra

CheckCDevice

CheckCDevice(cdev as Object) as Boolean

Checks whether the pointer specified by the parameter is a valid CDevice-Pointer

for the current object. True = valid

In Section Instructions Examples Basics History Extra

Class

Class() as String

Class of the CDevice for internal differentiation. Valid parameters DeviceClass.

In Section Instructions Examples Basics History Extra

ClearStatus

ClearStatus()

Sets the status information to inherited.

In Section Instructions Examples Basics History Extra

CLinks

CLinks() as IComosDOwnCollection

The object's own set of hierarchically-subordinate CLinks.

In Section Instructions Examples Basics History Extra

CObject
CObject() as IComosDCDevice

Corresponds to the CDevice function. See also Chapter CDevice.

In Section Instructions Examples Basics History Extra

CompOrderNr

CompOrderNr() as String

Assembled order number made up of the object and all its owners.

In Section Instructions Examples Basics History Extra

CompOrderText

CompOrderText() as String

Assembled order text made up of the object and all its owners

In Section Instructions Examples Basics History Extra

ControlProperties

ControlProperties() as String

The configuration data for the engineering object properties mask is managed in
this Property. On the user interface, the data is changed on the "Configuration"
tab.

In Section Instructions Examples Basics History Extra

ControlType

ControlType() as String

ProgId of the control that is to be used for the properties mask of engineering
objects.

In Section Instructions Examples Basics History Extra

CreateOption

CreateOption() as Long

Creation option (Normal, Block, Group). See also Chapter CDevice.

In Section Instructions Examples Basics History Extra

DeletedBackPointerObjects

DeletedBackPointerObjects(Val as Long) as IComosDCollection

Same as BackPointerObjects, but in this case only those with GetSavedAndDeleted-

Flag "True".

See also Chapter BackPointerObjects.

In Section Instructions Examples Basics History Extra

Dereference

Dereference() as Boolean

If Dereference = True then the CDevice Pointer is set to another CDevice, and this
results in the referenced CDevice being used when creating an object with the
current CDevice. (Functionality for structuring within a user-defined labeling
system)

In Section Instructions Examples Basics History Extra

DescriptionBlocked

DescriptionBlocked() as Boolean

Shows whether it is permitted to overwrite the description in the Device view.

(True = blocked).

In Section Instructions Examples Basics History Extra

DescriptionBlockedInherited

DescriptionBlockedInherited() as Boolean

Read:
displays if DescriptionBlocked was inherited. (True = inherited)

Write:

sets DescritionBlocked to inherited.

In Section Instructions Examples Basics History Extra

DescriptionGenerator

DescriptionGenerator() as Object

TextGenerator to generate the description.

In Section Instructions Examples Basics History Extra

DescriptionGeneratorWithIndex

IComosDTextGenerator DescriptionGeneratorWithIndex([in] long schemaIndex)

Returns the TextGenerator of the current base object, which is responsible for the
description and the naming scheme specified by schemaIndex.

Return value: Object of type IComosDTextGenerator

Parameter schemaIndex: 0 to use the default scheme, otherwise an index > 0 which
specifies the desired naming scheme.

In Section Instructions Examples Basics History Extra

DetailClass

DetailClass() as String

Further detail classification, for COMOS constants. See also Chapter DetailClass.

In Section Instructions Examples Basics History Extra

DetailType

DetailType() as String

Returns the detail type of the CDevice; the DetailType of the owner is specified
for a DeviceClassElement without its own CDevice. An old functionality for further
distinction in the Detail area. It is better to use Detail-Class than Property.

In Section Instructions Examples Basics History Extra

DeviceCreateMode

DeviceCreateMode() as Long

Object create mode, for COMOS constants DeviceCreateMode

In Section Instructions Examples Basics History Extra

DeviceGroup

DeviceGroup() as IComosDDevice

Pointer to a Device (assembly) within an own project. This is used for the
preconfiguration of complete Device units. These are then created instead of the
base object.

In Section Instructions Examples Basics History Extra

DevSymbols

DevSymbols() as IComosDCollection

Collection of own and inherited DevSymbols.

In Section Instructions Examples Basics History Extra

Documents

Documents() as IComosDCollection

Set of own documents and inherited documents.

In Section Instructions Examples Basics History Extra

Elements
Elements() as IComosDCollection

Set of own and inherited elements of type CDevice.

In Section Instructions Examples Basics History Extra

EnObs

EnObs(Val as String) as IComosDCollection

Filters the elements collection for objects of the classes specified in the
parameter. See DeviceClass for valid parameter values.

Examples

EnObs("ED") returns elements of the class Device or element

EnObs("-R") returns objects of all classes up to revision (R).

In Section Instructions Examples Basics History Extra

GetBackpointerBehaviour

GetBackpointerBehaviour() as Long

Returns the property as to whether backpointers are to be considered in the

Navigator display. Further information is provided at SetBackpointerBehaviour.

In Section Instructions Examples Basics History Extra

GetChildForCDevice

GetChildForCDevice(Val as Object) as IComosDCDevice

Checks whether the object is under the CDevice specified as the parameter (this
also takes Clinks into consideration).

In Section Instructions Examples Basics History Extra

GetClassification

GetClassification([in] long index, [out, retval] BSTR* classification)

Internal. Is part of the "Classification of devices" function.

In Section Instructions Examples Basics History Extra

GetElementsByClassification

GetElementsByClassification ( ByVal Index as Long, ByVal classification as String )

as IComosDCollection

Parameter Index as long

Index of classification type in which search is to take place. Constants see Module
ClassificationTypes or keyword "classificationIndex".

Parameter classification as string

Classification that is set as filter.

Filters the elements below the current CDevices and returns only those elements
that match the specified classification.

In Section Instructions Examples Basics History Extra

GetElementsByClassifications

GetElementsByClassifications ( ByVal classifications as Variant ) as

IComosDCollection

Parameter classifications as variant

Array with the strings of all classification types.

The classification index must be entered for each classification to be checked.

An empty string must be entered for each classification that is not to be checked.

The order of the classifications is determined by the associated classification

index.

Filters the elements below the current CDevices and returns only those elements
that match the specified classification.

Constants see Module ClassificationTypes or keyword "classificationIndex".

In Section Instructions Examples Basics History Extra

GetFirstElementByClassification

GetFirstElementByClassification ( ByVal Index as Long, ByVal classification as

String ) as IComosDCDevice

Parameter Index as long

Index of classification type in which search is to take place. Constants see Module
ClassificationTypes or keyword "classificationIndex".

Parameter classification as string

Classification that is set as search criterion.

Returns the first element below the current CDevices which matches the specified
classification.

In Section Instructions Examples Basics History Extra

GetFirstElementByClassifications

GetFirstElementByClassifications ( ByVal classifications as Variant ) as

IComosDCDevice

Parameter classifications as variant

Array with the strings of all classification types.

The classification index must be entered for each classification to be checked.

An empty string must be entered for each classification that is not to be checked.

The order of the classifications is determined by the associated classification

index.

Returns the first element below the current CDevices which matches one of the
specified classifications.

Constants see Module ClassificationTypes or keyword "classificationIndex".

In Section Instructions Examples Basics History Extra

GetFreeProperty

VARIANT GetFreeProperty([in] string propertyName)

Returns the FreeProperty value for the current object (this), which is specified by
the name that is transferred.

Return value: Value of the FreeProperty as VARIANT. If no FreeProperty with the

specified name exists, the returned variant will contain VT_EMPTY.

Parameter propertyName: Specifies the FreeProperty from which the value should be
returned. The name must always consist of two parts: the name of the FreeProperty
group (which is also reflected in the table name: FP_<GroupName>) and the name of
the Property itself (in the column name database). The two parts must be separated
by a dot. Example: OPTIONS.PROP1 activates access to table FP_OPTIONS and column
PROP1.

In Section Instructions Examples Basics History Extra

GetGRSpec

GetGRSpec(Val as Long) as IComosDSpecification

Returns the attribute with graphical relevance specified in the parameter.

In Section Instructions Examples Basics History Extra

GetImplementationBehaviour

GetImplementationBehaviour() as Long

Returns the "Implement request" property. Further information is provided at

SetImplementationBehaviour.

In Section Instructions Examples Basics History Extra

GetOwnBackpointerBehaviour

GetOwnBackpointerBehaviour() as Long

Returns the property indicating whether back pointers are to be considered in the
Navigator display, as an own Property. Further information is provided at
SetBackpointerBehaviour.

In Section Instructions Examples Basics History Extra

GetOwnClassification

GetOwnClassification([in] long index, [out, retval] BSTR* classification)

Internal. Is part of the "Classification of devices" function.

In Section Instructions Examples Basics History Extra

GetOwnImplementationBehaviour

GetOwnImplementationBehaviour() as Long

Returns the "Implement requests" property as an own Property. See also Chapter
SetImplementationBehaviour.

In Section Instructions Examples Basics History Extra

GetOwnProductRequestBehaviour

GetOwnProductRequestBehaviour() as Long

Returns the "Product data: comparison method" property as an own Property. See also
Chapter SetProductRequestBehaviour.

In Section Instructions Examples Basics History Extra

GetOwnReferenceBehaviour

GetOwnReferenceBehaviour(Index as Long) as Long

Returns the "Allowed links" property as an own Property. See also Chapter
SetReferenceBehaviour.
In Section Instructions Examples Basics History Extra

GetOwnScriptBlock

GetOwnScriptBlock(Val as Long) as String

Returns the object's own script block specified by the parameter. Currently only
Block(0) is used. See also ScriptBlock functions.

In Section Instructions Examples Basics History Extra

GetOwnStatus

GetOwnStatus(Index as Long) as Long

Please note that all statuses are inherited together.

In Section Instructions Examples Basics History Extra

GetProductRequestBehaviour

GetProductRequestBehaviour() as Long

Returns the "Product data: comparison method" property. See also Chapter
SetProductRequestBehaviour.
In Section Instructions Examples Basics History Extra

GetReferenceBehaviour

GetReferenceBehaviour(Index as Long) as Long

Returns the "Allowed links" property. See also Chapter SetReferenceBehaviour.

In Section Instructions Examples Basics History Extra

GetScriptBlock

GetScriptBlock(Val as Long) as String

Returns the object’s own or inherited script block as specified with the parameter.
Currently only Block(0) is used. See also Chapter ScriptBlock.

In Section Instructions Examples Basics History Extra

GetStatus

GetStatus(Index as Long) as Long

Gets the value of the status specified by the index. There are 13 different
statuses each having values of 0 - 3.

In Section Instructions Examples Basics History Extra

GRSpecCount

GRSpecCount() as Long

Returns the number of attributes with graphical relevance.

In Section Instructions Examples Basics History Extra

GRSpecsInherited

GRSpecsInherited() as Boolean

Shows whether the graphically relevant specification is its own or inherited. True
= inherited!

In Section Instructions Examples Basics History Extra

IconFileName

IconFileName() as String

Path to an icon that is then used for this base object.

In Section Instructions Examples Basics History Extra

InheritCDevices
InheritCDevices(withclinks as Boolean) as IComosDCollection

Set of all CDevices that inherit from the current CDevice.

Boolean = False: CDevices from the OwnCollection without own CDevicePointer and
BackpointerCDevices

Boolean = True: As above, but also all that are referenced by CLink.

In Section Instructions Examples Basics History Extra

IsElement

IsElement() as Boolean

Shows whether the current CDevice can be found in the OwnElements collection of its
owner.

In Section Instructions Examples Basics History Extra

IsInheritSuccessorFrom

IsInheritSuccessorFrom(Val as Object) as Boolean

Shows whether the current CDevice inherits from the specified CDevice. This
considers all possible inheritance routes (owners, CDevice pointers, back pointer
CLinks).

In Section Instructions Examples Basics History Extra

IsRequest

IsRequest() as Boolean

Request (only objects whose IsRequest = True is set can be implemented).

In Section Instructions Examples Basics History Extra

IsRequestInherited

IsRequestInherited() as Boolean

Specifies whether IsRequest Boolean was defined at this object or whether it is

inherited.

In Section Instructions Examples Basics History Extra

IsSuccessorFrom

IsSuccessorFrom(Val as Object) as Boolean

Checks whether the current object in the hierarchy is located underneath the object
specified by the parameter; BackPointerClinks is considered as part of this. True =
underneath.

In Section Instructions Examples Basics History Extra

LabelBlocked

LabelBlocked() as Boolean

Similar to DescriptionBlocked, only for Label. See also Chapter DescriptionBlocked.

In Section Instructions Examples Basics History Extra

LabelBlockedInherited

LabelBlockedInherited() as Boolean

Similar to DescriptionBlockedInherited, only for Label. See also Chapter

DescriptionBlockedInherited.

In Section Instructions Examples Basics History Extra

LabelGenerator

LabelGenerator() as Object

Text generator to generate labels.

In Section Instructions Examples Basics History Extra

LabelGeneratorWithIndex
IComosDTextGenerator LabelGeneratorWithIndex([in] long schemaIndex)

Returns the TextGenerator of the current base object, which is responsible for the
label and the naming scheme specified by schemaIndex.

Return value: Object of type IComosDTextGenerator

Parameter schemaIndex: 0 to use the default scheme, otherwise an index > 0 which
specifies the desired naming scheme.

In Section Instructions Examples Basics History Extra

Layers

Layers() as String

Determination of the working area on the object side

See also

Device (Layers),

Document (Layers),

Specification (Layers),

User (Layers).

In Section Instructions Examples Basics History Extra

Level

Level() as Long

Hierarchy level in which the current object is located.

In Section Instructions Examples Basics History Extra

NameBlocked

NameBlocked() as Boolean

Similar to DescriptionBlocked, only for Name. See also Chapter DescriptionBlocked.

In Section Instructions Examples Basics History Extra

NameBlockedInherited

NameBlockedInherited() as Boolean

Similar to DescriptionBlockedInherited, only for Name. See also Chapter

DescriptionBlockedInherited.

In Section Instructions Examples Basics History Extra

NameGenerator
NameGenerator() as Object

COMOS text generator for generating names (see Masks).

In Section Instructions Examples Basics History Extra

NameGeneratorWithIndex

IComosDTextGenerator NameGeneratorWithIndex([in] long schemaIndex)

Returns the TextGenerator of the current base object, which is responsible for the
name and the naming scheme specified by schemaIndex.

Return value: Object of type IComosDTextGenerator

Parameter schemaIndex: 0 to use the default scheme, otherwise an index > 0 which
specifies the desired naming scheme.

In Section Instructions Examples Basics History Extra

Number

Number() as Double

Integer value for the number, quantity of the object. (e.g. for DeviceClass "Cost"
or "Time")

In Section Instructions Examples Basics History Extra

OrderNr

OrderNr() as String

Order number of the object.

In Section Instructions Examples Basics History Extra

OrderText

OrderText() as String

Order text of the object.

In Section Instructions Examples Basics History Extra

OwnActive

OwnActive As Long

See also Chapter Active. Here, the own Property.

In Section Instructions Examples Basics History Extra

OwnCConnectors
OwnCConnectors() as IComosDOwnCollection

The object’s own set of hierarchically subordinate connectors.

In Section Instructions Examples Basics History Extra

OwnClass

OwnClass() as String

The object’s own class. See also Chapter DeviceClass.

In Section Instructions Examples Basics History Extra

OwnControlProperties

OwnControlProperties() as String

See ControlProperties. Here, the own Property.

In Section Instructions Examples Basics History Extra

OwnControlType

OwnControlType() as String
The object's own ProgId of the control that is to be used for the properties mask
for the Device.

In Section Instructions Examples Basics History Extra

OwnCreateOption

OwnCreateOption() as Long

The object’s own creation option. See also Chapter CreateOption.

In Section Instructions Examples Basics History Extra

OwnDescription

OwnDescription() as String

The object’s own description.

In Section Instructions Examples Basics History Extra

OwnDetailClass

OwnDetailClass() as String

The object’s own detail classification. See also Chapter DetailClass.

In Section Instructions Examples Basics History Extra

OwnDeviceCreateMode

OwnDeviceCreateMode() as Long

The object's own creation mode, COMOS constants. See also Chapter DeviceCreateMode.

In Section Instructions Examples Basics History Extra

OwnDeviceGroup

OwnDeviceGroup() as IComosDDevice

The object’s own DeviceGroup. See also Chapter DeviceGroup.

In Section Instructions Examples Basics History Extra

OwnDevSymbols

OwnDevSymbols() as IComosDOwnCollection

The object's own set of hierarchically-subordinate DevSymbols.

In Section Instructions Examples Basics History Extra

OwnDocuments

OwnDocuments() as IComosDOwnCollection

The object's own set of hierarchically-subordinate documents.

In Section Instructions Examples Basics History Extra

OwnElements

OwnElements() as IComosDOwnCollection

The object's own set of hierarchically-subordinate elements, type CDevice.

In Section Instructions Examples Basics History Extra

OwnIconFileName

OwnIconFileName() as String

Object's own IconFileName. See also Chapter IconFileName.

In Section Instructions Examples Basics History Extra

OwnLabel
OwnLabel() as String

The object’s own label.

In Section Instructions Examples Basics History Extra

OwnLayers

OwnLayers() as String

The object’s own working areas permit rights administration at the object level.

In Section Instructions Examples Basics History Extra

OwnNumber

OwnNumber() as Double

The object’s own number, set.

In Section Instructions Examples Basics History Extra

OwnOrderNr

OwnOrderNr() as String

The object’s own order number.

In Section Instructions Examples Basics History Extra

OwnOrderText

OwnOrderText() as String

The object’s own order text.

In Section Instructions Examples Basics History Extra

OwnRevisionType

OwnRevisionType() as String

The object’s own setting for allocation to a revision cycle. This setting
determines which base object is to be used for carrying out a revision on the
document or a document group. The name of the base object located under "A50
Revision" is evaluated.

In Section Instructions Examples Basics History Extra

OwnRIClass

OwnRIClass() as String

The object’s own P&ID classification.

In Section Instructions Examples Basics History Extra

OwnScript

OwnScript() as String

The object’s own script text.

In Section Instructions Examples Basics History Extra

OwnSpecifications

OwnSpecifications() as IComosDOwnCollection

The object's own set of hierarchically-subordinate attributes.

In Section Instructions Examples Basics History Extra

OwnVirtual

OwnVirtual() as Long

The object’s own functionality for the creation of elements.

In Section Instructions Examples Basics History Extra

Prefix

Prefix() as String

Function for the allocation of names in the case of Devices.

In Section Instructions Examples Basics History Extra

ProjectDevices

ProjectDevices() as IComosDCollection

The same functionality as BackPointerDevices; database-supported only in the

current project.

In Section Instructions Examples Basics History Extra

ProjectInstance

ProjectInstance() as Boolean

Toggles the setup of instances, True = on.

In Section Instructions Examples Basics History Extra

RealCDevices
RealCDevices() as IComosDCollection

Collection of all subordinate CDevices (recursive) located in the CDevices

collection (i.e. IsElement = FALSE).

In Section Instructions Examples Basics History Extra

RealElements

RealElements() as IComosDCollection

Returns the non-virtual elements of the Elements collection.

In Section Instructions Examples Basics History Extra

RegisterForReleaseStaticCollections

RegisterForReleaseStaticCollections(Mode As Long) As Boolean

Method that logs base objects in/out for the updating of static Collections (see
also ReleaseStaticCollections). After logging in the kernel monitors whether
actions occur that require an updating.

Mode/system constants of Mode:

RegisterForReleaseStaticCollectionsModeRegister: Login

RegisterForReleaseStaticCollectionsModeExecute: Execute

(with previous changes taken into account)

RegisterForReleaseStaticCollectionsModeRemove: Log out

In Section Instructions Examples Basics History Extra

RemoveFreeProperty

void RemoveFreeProperty([in] string propertyName)

Removes the specified FreeProperty at the current object (this). Any subsequent
instances of accessing the specified FreeProperty will now only return the result
VT_EMPTY.

Parameter propertyName: Specifies which FreeProperty should be deleted. For the

naming convention, see the description of GetFreeProperty.

In Section Instructions Examples Basics History Extra

ResetOwnUniqueLabel

ResetOwnUniqueLabel()

Sets the UniqueLabel to inherited.

In Section Instructions Examples Basics History Extra

RevisionType
RevisionType() as String

Allocation to a revision cycle. This setting determines which base object is to be

used for carrying out a revision on the document or a document group. The name of
the base object located under "A50 Revision" is evaluated.

In Section Instructions Examples Basics History Extra

RIClass

RIClass() as String

No longer a Property, only read access is possible. See also Chapter RIClass.

In Section Instructions Examples Basics History Extra

RIType

RIType() as String

Old variation for the further P&ID classification. It is better to use the P&ID
class!

In Section Instructions Examples Basics History Extra

Script

Script() as String
Read:

Display of all script blocks.

Write:

Sets ScriptBlock(..)

In Section Instructions Examples Basics History Extra

SetBackpointerBehaviour

SetBackpointerBehaviour(newVal as Long)

Sets the property as to whether backpointers should be considered in the Navigator

display (in the interface: CDevice, "Configuration" tab, "Navigator: Extended
display" field)

The following constants exist for the value:

BackPointer_Behaviour_Not_Relevant

BackPointer_Behaviour_Show

In Section Instructions Examples Basics History Extra

SetClassification

SetClassification([in] long index, [in] BSTR newClassification)

Internal. Is part of the "Classification of devices" function.

In Section Instructions Examples Basics History Extra

SetFreeProperty

void SetFreeProperty([in] string propertyName, [in] VARIANT propertyValue)

Sets the value of a FreeProperty of the current object (this).

Parameter propertyName: Specifies which FreeProperty should be changed. For the

naming convention, see the description of GetFreeProperty.

Parameter propertyValue: The new value of the FreeProperty as Variant. The type in
Variant must match the column in the database; otherwise, you can expect an error
message from the database when the current object is saved.

In Section Instructions Examples Basics History Extra

SetGRSpec

SetGRSpec(Val1 as Long, Val2 as Object)

Sets the attribute with graphical relevance specified by Parameter 1 to Parameter

2.

In Section Instructions Examples Basics History Extra

SetImplementationBehaviour
SetImplementationBehaviour(newVal as Long)

Sets the "Implement request" property, i.e., the mode for the implementation.

The following constants exist for the value:

Implementation_Behaviour_Replace

Implementation_Behaviour_No_Replace

Implementation_Behaviour_Use_Project_Settings

In Section Instructions Examples Basics History Extra

SetOwnClassification

SetOwnClassification([in] long index, [in] BSTR newClassification)

Internal. Is part of the "Classification of devices" function.

In Section Instructions Examples Basics History Extra

SetOwnScriptBlock

SetOwnScriptBlock(Val1 as Long, Val2 as String)

Sets the object’s own ScriptBlock specified with Parameter 1 to Parameter 2.

In Section Instructions Examples Basics History Extra

SetProductRequestBehaviour

SetProductRequestBehaviour(newVal as Long)

Sets the "Product data: comparison method" property, in other words, the mode for
the search procedure in the case of product data (recursive / not recursive).

The following constants exist for the value:

ProductRequest_Behaviour_Normal

ProductRequest_Behaviour_Recursive

In Section Instructions Examples Basics History Extra

SetReferenceBehaviour

SetReferenceBehaviour(Index as Long, newVal as Long)

Sets the "Permitted references" property. The first parameter specifies which
reference is involved (unit, location, implementation); the second parameter
specifies whether or not references are permitted.

There are following constants for this:

Input:

Reference_Behaviour_For_Unit ,

Reference_Behaviour_For_Location ,

Reference_Behaviour_For_Implementation

Returned values:
Reference_Behaviour_No_Pointer_Valid ,

Reference_Behaviour_Some_Pointer_Valid

In Section Instructions Examples Basics History Extra

SetScriptBlock

SetScriptBlock(Val1 as Long, Val2 as String)

Sets the ScriptBlock specified with parameter 1 to parameter 2.

In Section Instructions Examples Basics History Extra

SetStatus

SetStatus(Index as Long, newVal as Long)

Sets the status specified with the index to the value newVal.

IComosDCLink

Comos-Verweisobjekt

IComosDCLink: Property

In Section Instructions Examples Basics History Extra

Specifications

Specifications() as IComosDCollection

Set of inherited attributes and the object's own attributes.

In Section Instructions Examples Basics History Extra

UniqueLabel

UniqueLabel() as Boolean

If UniqueLabel is set to True, the label must be unique on the Device side.

In Section Instructions Examples Basics History Extra

UniqueLabelInherited

UniqueLabelInherited() As Boolean

Shows whether "UniqueLabel" at the current CDevice is defined or inherited. A TRUE

setting means that UniqueLabel is inherited.

In Section Instructions Examples Basics History Extra

UniqueLabelIsOwn
UniqueLabelIsOwn() as Boolean

Shows whether the UniqueLabel of the current object is its own or inherited. True =
own.

In Section Instructions Examples Basics History Extra

UseCases

UseCases() as Boolean

Use of run settings if True.

In Section Instructions Examples Basics History Extra

Virtual

Virtual() as Long

Functionality for elements. Virtual elements are not inherited but instead can be
generated in the creation modes "Create", "Create N" or "Default".

"Create"

Integer value that defines the number of elements to be created.

"Default"

COMOS constant DefaultVirtual

"Create N"
COMOS constant InfiniteVirtuals

In Section Instructions Examples Basics History Extra

VirtualElements

VirtualElements() as IComosDCollection

Set of virtual elements from the elements collection.

In Section Instructions Examples Basics History Extra

Visible

Visible() as Boolean

Shows whether this object is to be visible to non-administrators (this Property is

not inherited!)

In Section Instructions Examples Basics History Extra

IComosDCLink

This chapter contains the following information:IComosDCLink

Reference

UseForInheritance
In Section Instructions Examples Basics History Extra

IComosDCLink

COMOS link object.

In Section Instructions Examples Basics History Extra

Reference

Reference() as Object

Pointer to any COMOS object.

In Section Instructions Examples Basics History Extra

UseForInheritance

UseForInheritance() as Boolean

Shows whether inheritance is to be carried out in the base object tree by means of
this Clink.

In Section Instructions Examples Basics History Extra

IComosDConnector

This chapter contains the following information:IComosDConnector

BackPointerCLinks

BackPointerDocObjs

Cable

CableIndex

Category

CConnector

CheckForSameSignal

CheckWire

CLinks

Colour

Connect

ConnectedCategory

ConnectedWith

ConnectionLength

Connectors

ConnectorAttributesCount

CrossSection

Disconnect

Document

GetConnectorAttribute

GetConnectorAttributeItem

GetLabelMode

GetNetConnectors

GetOwnConnectorAttribute
GetOwnConnectorAttributeItemByIndex

GetOwnConnectorAttributeItemByName

GetOwnLabelMode

InternalConnection

InternalConnectionAsConnector

IO

IOInfo

IsConnected

IsConnectorConsistent

IsIntrinsicalSafety

Layer

Number

OwnCable

OwnCableIndex

OwnCategorie

OwnColour

OwnConnectionLength

OwnConnectorAttributesCount

OwnCrossSection

OwnDescription

OwnInternalConnection

OwnIO

OwnLabel

OwnLayer

OwnNumber

OwnPotential

OwnSignal

OwnSignalMode

OwnType

OwnTypeInfo
OwnWire

Potential

SetConnectorAttribute

SetConnectorAttributeStandardTable

SetLabelMode

Signal

SignalMode

SignalNot

SignalNotInherited

Type

TypeInfo

Wire

In Section Instructions Examples Basics History Extra

IComosDConnector

COMOS connector object.

Background information: Connector.FullLabel

The following option is available in the connector properties: "Label by owner"

If this option is set, the following applies:

All owners of the Element class are skipped.

In Section Instructions Examples Basics History Extra

BackPointerCLinks
BackPointerCLinks() as IComosDOwnCollection

Not to be used any longer from COMOS version 5.3!

In Section Instructions Examples Basics History Extra

BackPointerDocObjs

BackPointerDocObjs() as IComosDOwnCollection

A Backpointer collection of all DocObj, the reference setting of which is set to

Connector.

In Section Instructions Examples Basics History Extra

Cable

Cable() as IComosDDevice

Pointer to the associated cable.

In Section Instructions Examples Basics History Extra

CableIndex
CableIndex() as String

The cable designation, Cable and CableIndex together provide the wire information

In Section Instructions Examples Basics History Extra

Category

Categorie() as String

Sub-type, for further differentiation of the type.

In Section Instructions Examples Basics History Extra

CConnector

CConnector() as IComosDConnector

The Connector from the base object path from which properties are inherited.

In Section Instructions Examples Basics History Extra

CheckForSameSignal

CheckForSameSignal() as Boolean

Checks whether the same signal would be valid for the Connector and the Connector
connected to it if the connection did not exist.
In Section Instructions Examples Basics History Extra

CheckWire

CheckWire(Val as Object) as Boolean

Checks whether the specified object (Device) of type Wire may be created as a wire.
Each Wire is used by precisely two connectors that are connected to one another by
these wires.

In Section Instructions Examples Basics History Extra

CLinks

CLinks() as IComosDOwnCollection

Obsolete; only provided for compatibility reasons. No support in future versions.

Will cease to be available in future.

In Section Instructions Examples Basics History Extra

Colour

Colour() as Long

Color of the connection; access takes place via a predefined standard table,
synchronized on connected connectors.
In Section Instructions Examples Basics History Extra

Connect

Connect(Val as Object)

Connects the current connector with the specified connector.

In Section Instructions Examples Basics History Extra

ConnectedCategory

ConnectedCategorie() as String

Returns the valid Categorie. Uses the same rules as for the tracking of potentials
and signals.

In Section Instructions Examples Basics History Extra

ConnectedWith

ConnectedWith() as IComosDConnector

Returns the connected connector.

In Section Instructions Examples Basics History Extra

ConnectionLength

ConnectionLength() as Double

Information on the length of the connection. This property is synchronized for

connected connectors. If two connectors have differing ConnectionLength properties,
they cannot be connected.

This property is only evaluated for certain types of diagrams. In most cases, the
actual concrete length of a connection does not matter at all. In that case two
connectors that belong to one another are synchronized automatically.

In Section Instructions Examples Basics History Extra

Connectors

Connectors() as IComosDCollection

Old variant! Returns a collection of connected connectors but contains only one
element, since only unique connections are possible.

In Section Instructions Examples Basics History Extra

ConnectorAttributesCount

ConnectorAttributesCount() As Long

Connector attributes are free texts (meaning they are not objects of type
IComosDSpecification). They are managed as pairs (key, value).

This Count method returns the the number of attributes.

See also Chapter GetConnectorAttribute and Chapter SetConnectorAttribute.

In Section Instructions Examples Basics History Extra

CrossSection

CrossSection() as Long

Cross-section, access is conducted through a predefined standard table, connected

connectors are synchronized.

In Section Instructions Examples Basics History Extra

Disconnect

Disconnect(Val as Object)

Undoes the connection of the current connector with the specified connector.

In Section Instructions Examples Basics History Extra

Document

Document() as IcomosDDocument

Pointer to the relevant document. This property is used in the P&ID area to set
whether connections are first linked in the report or in the Navigator.
If the connections were first connected in the report (Document = COMOSDocument),
then the settings of the report connectors have priority over the settings of the
COMOS connectors.

If the connections are first linked in the database (Document = NOTHING), the
reverse applies.

In Section Instructions Examples Basics History Extra

GetConnectorAttribute

GetConnectorAttribute(Name As String) As String

Connector attributes are free texts (meaning they are not objects of type
IComosDSpecification). They are managed as pairs (key, value).

This Get method returns the value of a key (if there is a value).

See also Chapter SetConnectorAttribute.

In Section Instructions Examples Basics History Extra

GetConnectorAttributeItem

GetConnectorAttributeItem(Index As Long) As IComosDConnectorAttributeItem

Connector attributes are free texts (meaning they are not objects of type
IComosDSpecification). They are managed as pairs (key, value).

This method returns a ConnectorAttributeItem (type IcomosDConnectorAttributeItem)

for an index.

See also Chapter GetConnectorAttribute and Chapter SetConnectorAttribute.

In Section Instructions Examples Basics History Extra

GetLabelMode

GetLabelMode() as Long

There are two modes:

Normal: Connector owns its own Label.

Owner: Connector gets the label from the owner.

See also Chapter ConnectorConstants.

In Section Instructions Examples Basics History Extra

GetNetConnectors

IComosDCollection GetNetConnectors(ignoreBridges As Long)

Returns a collection containing all connected connectors, starting with the current
connector. Possible methods for performing this search:

Feed-through connections

Connection partners

Auxiliary connectors
Return value: Collection containing all connectors connected to the current
connector.

Parameter ignoreBridges:

If this parameter is set to true, all bridge connections are ignored in the search.

Bridge connections are entered in the "Strip" tab and from there applied in the
properties of the connection in the "Cable index" field. The available bridge types
are taken from the following standard table: "Y10M41N00001 Bridge types"

In Section Instructions Examples Basics History Extra

GetOwnConnectorAttribute

GetOwnConnectorAttribute(Name As String) As String

See also Chapter GetConnectorAttribute. This is the Own-Property without

inheritance.

In Section Instructions Examples Basics History Extra

GetOwnConnectorAttributeItemByIndex

GetOwnConnectorAttributeItemByIndex(index as long) as IComosDConnectorAttributeItem

Counterpart to GetConnectorAttributeItem() (see GetConnectorAttributeItem). Here

the Own variant.

Returns the object of type IComosDConnectorAttributeItem, with the Index index. The
index begins at 1. If no item with the transferred index is available, Nothing is
returned.
In Section Instructions Examples Basics History Extra

GetOwnConnectorAttributeItemByName

GetOwnConnectorAttributeItemByName(name as String) as IComosDConnectorAttributeItem

Returns the object of type IcomosDConnectorAttributeItem, which has the transferred

name as the name parameter. If no such item is available, Nothing is returned.

See also Chapter GetOwnConnectorAttributeItemByIndex.

In Section Instructions Examples Basics History Extra

GetOwnLabelMode

GetOwnLabelMode() as Long

As with GetLabelMode. In this case, the Own information.

In Section Instructions Examples Basics History Extra

InternalConnection

InternalConnection() as String

The internal connection of connectors for potential and signal tracking (the name
of the connector that is connected is entered here). In the case of terminals, this
property can also be used to define a connector as signal-separating or potential-
separating.

It is possible to specify any connector as a feed-through connection; i.e. not only

connectors that belong to the same Device.
For this, there is a new syntax that is based on normal path details.

Path detail

Starting point:

Always the owner of the connection for which the feed-through connection is set.

This means that old details (such as CP2) remain valid for connectors underneath
the same Device.

Navigation:

Use ".." to move up one level and specify a name to select the designated Device or
connector.

All name components of the path must be separated with the pipe symbol "|".

Example:

..|..|DevA|DevA1|CP1

With this path detail, you would move up two levels, select Device DevA, then
Device DevA1 below it and finally connector CP1 of the Devices DevA1.

For terminals

The connections can be defined as signal or potential separating. For this purpose,
the following constants are entered for the Property InternalConnection:

InternalConnection_SeparateSignal(= "@SepS")

The connector does not pass on signals.

InternalConnection_SeparatePotential(= "@SepP")

The connector does not pass on potentials.

If a connector is both signal-separating and potential-separating, then both

strings can be entered one after the other. How the two strings are separated from
each other (spaces, semicolon etc., no separator), is not important because a
substring search is performed.

See also Chapter InternalConnectionAsConnector.

In Section Instructions Examples Basics History Extra

InternalConnectionAsConnector

InternalConnectionAsConnector() as IComosDConnector

Returns the connector identified in the InternalConnection property as an object of

type IcomosDConnector (in the COMOS interface: in the feed-through connection
attribute of the connector properties).

If the path to the InternalConnection property is invalid or empty, Nothing is

returned; otherwise, the connector object is returned.

See also Chapter InternalConnection.

In Section Instructions Examples Basics History Extra

IO

IO() as String

Input / Output information. See also Chapter ConnectorConstants.

In Section Instructions Examples Basics History Extra

IOInfo
IOInfo() as String

Information regarding the actual IO property of the connector and the

IntrinsicalSafety property are managed together in the IO property.

Only the actual IO proportion of this property is returned with this method.
Permitted constants:

ConnectorConstantsIOInput

ConnectorConstantsIOOutput

ConnectorConstantsIONeutral

For completeness: All constants of the property IO:

ConnectorConstantsIOInput

ConnectorConstantsIOOutput

ConnectorConstantsIONeutral

ConnectorConstantsIOIntrinsicalSafety

ConnectorConstantsIOInputAndIntrinsicalSafety

ConnectorConstantsIOOutputAndIntrinsicalSafety

In Section Instructions Examples Basics History Extra

IsConnected
IsConnected(Val as Object) as Boolean

Checks whether the current connector is connected to the specified connector.

In Section Instructions Examples Basics History Extra

IsConnectorConsistent

IsConnectorConsistent(ByVal Type as String) as Long

Checks for the specified type of connector how the linked objects of this connector
and its CorrespondingConnector (see there) relate to one another.

Possible results (constants):

Conector_IsConsistent_Consistent

Conector_IsConsistent_InConsistent

Conector_IsConsistent_Empty

In Section Instructions Examples Basics History Extra

IsIntrinsicalSafety

IsIntrinsicalSafety() as Boolean

Information regarding the actual IO property of the connector and the

IntrinsicalSafety property are managed together in the IO property.

This method only returns the IntrinsicalSafety IO proportion of this property.

Permitted constants:

ConnectorConstantsIOIntrinsicalSafety

ConnectorConstantsIOInputAndIntrinsicalSafety

ConnectorConstantsIOOutputAndIntrinsicalSafety

For completeness: All constants of the property IO:

ConnectorConstantsIOInput

ConnectorConstantsIOOutput

ConnectorConstantsIONeutral

ConnectorConstantsIOIntrinsicalSafety

ConnectorConstantsIOInputAndIntrinsicalSafety

ConnectorConstantsIOOutputAndIntrinsicalSafety

In Section Instructions Examples Basics History Extra

Layer

Layer() as String

In the case of connectors, Layer corresponds to to the type.

In Section Instructions Examples Basics History Extra

Number

Number() as Long

Number of the connection, is synchronized on connected connectors.

In Section Instructions Examples Basics History Extra

OwnCable

OwnCable() as IComosDDevice

The object's own pointer to the associated cable. See also Chapter Cable.

In Section Instructions Examples Basics History Extra

OwnCableIndex

OwnCableIndex() as String

The object's own wire label, Cable and CableIndex together provide the wire
information. See also Chapter CableIndex.

In Section Instructions Examples Basics History Extra

OwnCategorie

OwnCategorie() as String

The object’s own SubType, for further differentiation of the type. See also Chapter
Category.

In Section Instructions Examples Basics History Extra

OwnColour

OwnColour() as Long

Object's own. See also Chapter Colour.

In Section Instructions Examples Basics History Extra

OwnConnectionLength

OwnConnectionLength() as Double

See ConnectionLength. Here the OwnProperty.

In Section Instructions Examples Basics History Extra

OwnConnectorAttributesCount
OwnConnectorAttributesCount() as Long

Counterpart to ConnectorAttributesCount. See also Chapter ConnectorAttributesCount.

Returns the number of OwnConnectorAttributes.

In Section Instructions Examples Basics History Extra

OwnCrossSection

OwnCrossSection() as Long

Object's own. See also Chapter CrossSection.

In Section Instructions Examples Basics History Extra

OwnDescription

OwnDescription() as String

The object’s own description.

In Section Instructions Examples Basics History Extra

OwnInternalConnection
OwnInternalConnection() as String

The object’s own internal connection of connectors for tracking of the potentials
and signals (the name of the connector that is joined is input here).

In Section Instructions Examples Basics History Extra

OwnIO

OwnIO() as String

The object's own input/output information.

See also Chapter:

ConnectorConstants

IO

In Section Instructions Examples Basics History Extra

OwnLabel

OwnLabel() as String

The object’s own property, a label that is not inherited.

In Section Instructions Examples Basics History Extra

OwnLayer
OwnLayer() as String

Object's own Layer. In the case of connectors, Layer corresponds to to the type.
See also Chapter Layer.

In Section Instructions Examples Basics History Extra

OwnNumber

OwnNumber() as Long

Object's own. See also Chapter Number.

In Section Instructions Examples Basics History Extra

OwnPotential

OwnPotential() as IComosDDevice

Returns the object’s own logical potential. See also Chapter Potential.

In Section Instructions Examples Basics History Extra

OwnSignal
OwnSignal() as IComosDDevice

Signal applied to the connector. See also Chapter Signal.

In Section Instructions Examples Basics History Extra

OwnSignalMode

OwnSignalMode() As Long

The object’s own mode for signal tracking.

In Section Instructions Examples Basics History Extra

OwnType

OwnType() as String

Object's own connector type. See also Chapter ConnectorConstants.

In Section Instructions Examples Basics History Extra

OwnTypeInfo

OwnTypeInfo() as Long

Contains the object’s own additional type information at the connector.

In Section Instructions Examples Basics History Extra

OwnWire

OwnWire() as IComosDDevice

The object’s own wire pointer. This information is made up of OwnCable and
OwnCableIndex. See also Chapter Wire.

In Section Instructions Examples Basics History Extra

Potential

Potential() as IComosDDevice

Returns the logical potential. Searches across all connected connectors and
terminals for a potential.

In Section Instructions Examples Basics History Extra

SetConnectorAttribute

SetConnectorAttribute(Name As String, Value As String, Synchronize As Boolean)

Connector attributes are free texts (meaning they are not objects of type
IComosDSpecification). They are managed as pairs (key, value).

With this Set method, you set the value for a key.
See also Chapter GetConnectorAttribute.

In Section Instructions Examples Basics History Extra

SetConnectorAttributeStandardTable

void SetConnectorAttributeStandardTable([in] string attributeName, [in]

IComosDStandardTable stdTable)

Sets a pointer to the specified standard table on the specified connector

attribute.

Parameter attributeName: Specifies which connector attribute should be changed.

Parameter stdTable: The standard table that is to be referenced.

In Section Instructions Examples Basics History Extra

SetLabelMode

SetLabelMode(Val as Long)

Sets the LabelMode for the connector. See also Chapter GetLabelMode:
ConnectorConstants.

In Section Instructions Examples Basics History Extra

Signal
Signal() as IComosDDevice

Signal that is valid at the connector; signal tracking is performed according to

the same rules as potential tracking.

In Section Instructions Examples Basics History Extra

SignalMode

SignalMode() As Long

Mode for tracking of the signal.

In Section Instructions Examples Basics History Extra

SignalNot

SignalNot() As Boolean

This property displays whether there is a negation at this connector. Is used

especially in diagram type FD (Function Diagram).

In Section Instructions Examples Basics History Extra

SignalNotInherited
SignalNotInherited() as Boolean

This property displays whether SignalNot is defined or inherited at the current

connector. A TRUE setting means that SignalNot is inherited.

In Section Instructions Examples Basics History Extra

Type

Type() as String

Connector type. See also Chapter ConnectorConstants.

In Section Instructions Examples Basics History Extra

TypeInfo

TypeInfo() as Long

Contains additional type information at the connector.

In Section Instructions Examples Basics History Extra

Wire

Wire() as IComosDDevice

Wire pointer. This information is made up of Cable and CableIndex.

In Section Instructions Examples Basics History Extra

IComosDConnectorAttributeItem

This chapter contains the following information:IComosDConnectorAttributeItem

Equals

Name

StandardTable

Synchronize

Value

In Section Instructions Examples Basics History Extra

IComosDConnectorAttributeItem

New.

Class for managing attributes at connectors.

See also

IComosDConnector

GetConnectorAttribute

SetConnectorAttribute
In Section Instructions Examples Basics History Extra

Equals

Equals(otherItem as IComosDConnectorAttributeItem) as Boolean

This function allows you to compare two objects of type

IcomosDConnectorAttributeItem.

Returns TRUE if the transferred object on all Properties has the same value as the
object on which the method was called; otherwise FALSE.

In Section Instructions Examples Basics History Extra

Name

Name() As String

Name (= key) of the connector attribute.

In Section Instructions Examples Basics History Extra

StandardTable

IComosDStandardTable StandardTable

Property of type IComosDStandardTable. Each connector attribute can have a

reference to a standard table. This property can be used to set the reference.
In Section Instructions Examples Basics History Extra

Synchronize

Synchronize() As Boolean

Synchronize specifies whether these items should be synchronized for connectors

that are connected.

In Section Instructions Examples Basics History Extra

Value

Value() As String

Value of the connector attribute.

In Section Instructions Examples Basics History Extra

IComosDCSpecificationSet

This chapter contains the following information:IComosDCSpecificationSet

BackPointerCLinks

BackPointerSpecificationSets

CLinks

CSpecificationSets

Level
OwnSpecifications

Specifications

In Section Instructions Examples Basics History Extra

IComosDCSpecificationSet

Catalog properties data set.

Obsolete; only provided for compatibility reasons. No support in future versions.

Will cease to be available in future.

In Section Instructions Examples Basics History Extra

BackPointerCLinks

BackPointerCLinks() as IComosDOwnCollection

Returns a set of CLinks that have a pointer to the current object.

In Section Instructions Examples Basics History Extra

BackPointerSpecificationSets

BackPointerSpecificationSets() as IComosDCollection

Returns a collection of SpecificationSet objects that have a pointer to the current

object.

In Section Instructions Examples Basics History Extra

CLinks

CLinks() as IComosDOwnCollection

Collection of CLinks.

In Section Instructions Examples Basics History Extra

CSpecificationSets

CSpecificationSets() as IComosDOwnCollection

Object's own collection of CSpecificationSet objects.

In Section Instructions Examples Basics History Extra

Level

Level() as Long

Hierarchy level at which the current object is located.

In Section Instructions Examples Basics History Extra

OwnSpecifications

OwnSpecifications() as IComosDOwnCollection

The object's own set of hierarchically-subordinate attributes.

In Section Instructions Examples Basics History Extra

Specifications

Specifications() as IComosDCollection

Collection of own and inherited attributes.

In Section Instructions Examples Basics History Extra

IComosDDevice

This chapter contains the following information:IComosDDevice

ActivateChangeLog

AddNumberRangeGeneratorAssignment

Alias

AliasLabel

AliasNestedLabel
AliasNestedLabel2

AliasULFullLabel

AllConnectors

AllSpecifications

BackPointerCDevices

BackPointerConnectors

BackPointerDevicesWithImplementation

BackPointerDevicesWithLocation

BackPointerDevicesWithUnit

BackPointerDocObjs

BackPointerDocsWithLocation

BackPointerDocsWithUnit

CDevice

CDeviceConnectString

CDeviceMode

CheckDeviceCreateMode

CheckLabel

CheckVirtualElements

Class

ClassificationExists

CObject

Connectors

ConnectorsWhichUsePotential

ConnectorsWhichUseSignal

CountStillCreatableVirtualElements

CreateD3

CreateDefaultElements

D3

DetailClass

DetailType
DeleteD3

Devices

Documents

Elements

EnObs

GeneralObject

GetCurrentCase

GetElementsByClassification

GetElementsByClassifications

GetFirstElementByClassification

GetFirstElementByClassifications

GetFreeProperty

GetGRSpec

GetNumberRangeGeneratorAssignment

GetNumberRangeGeneratorAssignmentCount

GetOwnCurrentCase

GetPropertiesFromCDevice

GetStatus

GetAllConnectorsRecursively

GLocation

GPosition

GUnit

Implementation

IsElement

IsImplementationValid

IsInLocationTree

IsInUnitTree

IsLocationValid

IsNameSystemDocumentGroup
IsPlaced

IsProjectDocumentGroup

IsRequest

IsRevisionReleased

IsUnitValid

LabelExist

Layers

Location

Lock

MainDevice

MatchScanDevices

NestedLabel

NestedName

NestedRelativLabel

NextLabel

NextName

Number

OldAliasFullLabel

OwnConnectors

OwnDescription

OwnDocuments

OwnElements

OwnLabel

OwnLayers

OwnNumber

OwnSpecifications

Position

RemoveFreeProperty

RemoveNumberRangeGeneratorAssignment

ReverseLoggedChanges
RevisionCDevice

RIClass

SetCurrentCase

SetCurrentTimestampForRevision

SetDocObjsStatus

SetFreeProperty

SetStatus

Specifications

SystemLock

Unit

ULFullLabel

ULFullName

In Section Instructions Examples Basics History Extra

IComosDDevice

The general engineering object in COMOS.

In Section Instructions Examples Basics History Extra

ActivateChangeLog

ActivateChangeLog ()

Activates ChangeLogging and defines the current Device as a target for the protocol
or ChangeLog. DeactivateChangeLog
DeactivateChangeLog ()

Deactivates ChangeLogging; changes are no longer logged, even in the case of

explicit log calls at the ChangeLogger.

In Section Instructions Examples Basics History Extra

AddNumberRangeGeneratorAssignment

void AddNumberRangeGeneratorAssignment(IComosDNumberRangeGenerator generator, long

rank)

Generates a new assignment for the current object using the specified
NumberRangeGenerator and Rank value.

In Section Instructions Examples Basics History Extra

Alias

Alias ( ) as IComosDDevice

Device reference (pointer) for an alias labeling system.

In Section Instructions Examples Basics History Extra

AliasLabel

AliasLabel() As String
If an alias exists, this function returns the label of the alias object, otherwise
its own label.

In Section Instructions Examples Basics History Extra

AliasNestedLabel

AliasNestedLabel ( ) as String

Alias evaluation for NestedLabel functionality. NestedLabel, if

Workset.UseAliasforLabelFunctions is set to TRUE

Note This function is obsolete, see AliasNestedLabel2.

In Section Instructions Examples Basics History Extra

AliasNestedLabel2

AliasNestedLabel2 ( ) as String

The function returns its own label and the labels of all superordinate Devices in
the object structure (iteratively ascending). Aborts if the Device class is
changed. The name appears if no labels have been allocated. Includes alias
evaluation if Workset.UseAliasforLabelFunctions is set to TRUE.

Background:

The definitions of AliasNestedLabel and AliasFullLabel are not compatible in terms

of content.

A prefix and a delimiter can be set in the project options.

With AliasFullLabel, the entire path name is output as one item, so that no prefix
is used. In the case of AliasNestedLabel, only parts of the path name are output;
therefore, the prefix setting is also taken into consideration.
If the prefix and delimiter are set differently, the result is that a combination
of hierarchical AliasNestedLabel does not produce the same text as AliasFullLabel ,
but differs according to the prefix and delimiter.

Definition AliasNestedLabel2:

Adding up hierarchical AliasNestedLabel2 returns the same text as AliasFullLabel.

For that reason, the prefix is not evaluated in AliasNestedLabel2 and only the
delimiter is used.

See also RelativLabel.

In Section Instructions Examples Basics History Extra

AliasULFullLabel

AliasULFullLabel ( ) as String

Unit-Location-FullLabel with alias evaluation if Workset.UseAliasforLabelFunctions

is set to TRUE. Returns GUnit.FullLabel, GLocation.FullLabel and SignedLabel.

In Section Instructions Examples Basics History Extra

AllConnectors

AllConnectors ( ) as IComosDCollection

Searches the object tree recursively, starting at the current object, and returns
all connectors of the elements found.

In Section Instructions Examples Basics History Extra

AllSpecifications

AllSpecifications ( ) as IComosDCollection

Returns the properties of the object and all subordinate elements.

In Section Instructions Examples Basics History Extra

BackPointerCDevices

BackPointerCDevices ( ) as IComosDCollection

(Database-supported) collection of cross-project CDevice that own a template

pointer (CDevice.DeviceGroup) to the current Device.

In Section Instructions Examples Basics History Extra

BackPointerConnectors

BackPointerConnectors ( ) as IComosDCollection

Returns all objects of class Connector that have Cable pointers to the current
object.

In Section Instructions Examples Basics History Extra

BackPointerDevicesWithImplementation
BackPointerDevicesWithImplementation ( ) as IComosDOwnCollection

Returns all Devices whose Implementation pointers point to the current object.

In Section Instructions Examples Basics History Extra

BackPointerDevicesWithLocation

BackPointerDevicesWithLocation ( ) as IComosDOwnCollection

Returns all Devices whose Location pointers point to the current object.

In Section Instructions Examples Basics History Extra

BackPointerDevicesWithUnit

BackPointerDevicesWithUnit ( ) as IComosDOwnCollection

Returns all Devices whose Unit pointers point to the current object.

In Section Instructions Examples Basics History Extra

BackPointerDocObjs

BackPointerDocObjs ( ) as IComosDOwnCollection
Returns all objects of class DocObj that have Reference pointers to the current
object.

In Section Instructions Examples Basics History Extra

BackPointerDocsWithLocation

BackPointerDocsWithLocation ( ) as IComosDOwnCollection

Returns all documents whose Location pointers point to the current object.

In Section Instructions Examples Basics History Extra

BackPointerDocsWithUnit

BackPointerDocsWithUnit ( ) as IComosDOwnCollection

Returns all documents whose Unit pointers point to the current object.

In Section Instructions Examples Basics History Extra

CDevice

CDevice ( ) as IComosDCDevice

CDevice-Referenz (pointer); inheritance is conducted by means of this pointer.

In Section Instructions Examples Basics History Extra

CDeviceConnectString

CDeviceConnectString ( ) as String

Symbolic information on the CDevice pointer. (Connect / disconnect project)

In Section Instructions Examples Basics History Extra

CDeviceMode

CDeviceMode ( ) as Long

Mode dictating how attributes are to be handled at the Device (no longer used).

In Section Instructions Examples Basics History Extra

CheckDeviceCreateMode

CheckDeviceCreateMode ( Val1 as Object, Val2 as Object ) as Boolean

Checks the DeviceCreateMode; checks whether the current Device is allowed to be

given the specified CDevice pointer.

Val1 : CDevice with which a Device is to be created

Val2 : CDevice of the owner

Example

Check to determine whether an object with CDevice pointer B is allowed to be

created under object A.

Yes, if CheckDeviceCreateMode (B, A.CDevice) = True.

In Section Instructions Examples Basics History Extra

CheckLabel

CheckLabel ( ) as Boolean

Checks whether a Device with the same label already exists in the OwnerCollection.

In Section Instructions Examples Basics History Extra

CheckVirtualElements

CheckVirtualElements (Val as Object) as Boolean

Checks whether there are fewer elements with the name of the CDevice as the prefix
in the OwnElements collection than were specified in the CDevice.Virtual property.

In Section Instructions Examples Basics History Extra

Class
Class ( ) as String

Class of the Device for internal differentiation.

Valid parameters

DeviceClass

In Section Instructions Examples Basics History Extra

ClassificationExists

bool ClassificationExists([in] long classificationIndex, [in] string searchString)

This method checks whether the specified String is to be found in the

classification specified by the index.

Return value: TRUE, if the specified string is to be found in the specified

classification of the current device (this), otherwise FALSE.

Error message if an invalid parameter is used.

Parameter classificationIndex: Specifies the classification in which the search is

to be conducted:

1 – Hierarchical classification. A check is performed here to determine whether the

classification starts with the specified search string. If the search string is in
the classification, but not directly at the beginning, it is not considered a hit.

2 – Functional classification. Here, it is sufficient for the search string to be

in any part of the classification.

3 - User-specific functional classification. See functional classification.

4 - User-specific hierarchical classification. See hierarchical classification.

Separator

The separator is the period. The separator is specified as follows in the

searchString:

Parameter 1 - hierarchical classification: If a classification needs to be searched

for that covers several layers, the individual layers need to separated by a
period.

Example: Hierarchical classification level 1: "M21", hierarchical classification

level 2: "A050". The searchString is: "M21.A050"

Parameter 2 - functional classification: If a classification needs to be searched

for that can be located anywhere, the enclosing periods can be omitted.

Example: Functional classification 1: "O4", functional classification 2: "A870":

The searchString "A870" is permitted.

In Section Instructions Examples Basics History Extra

CObject

CObject ( ) as IComosDCDevice

Pointer to the associated CDevice which is used to conduct inheritance.

In Section Instructions Examples Basics History Extra

Connectors

Connectors ( ) as IComosDCollection
Returns a collection with own connectors and inherited connectors.

In Section Instructions Examples Basics History Extra

ConnectorsWhichUsePotential

ConnectorsWhichUsePotential ( ) as IComosDCollection

Returns all connectors for which this Device is valid as a potential. Evaluates the
project parameter for the potential tracking.

In Section Instructions Examples Basics History Extra

ConnectorsWhichUseSignal

ConnectorsWhichUseSignal ( ) as IComosDCollection

Returns all connectors for which this Device is valid as a signal. Evaluates the
project parameter for the signal tracking.

In Section Instructions Examples Basics History Extra

CountStillCreatableVirtualElements

CountStillCreatableVirtualElements ( Val as Object ) as Long

Parameter Val as object

Base object of element to be created

Returns the number of elements of the specified base object that can still be
created below the current object. To do so, the "Virtual" setting at the base
object is evaluated and compared with the number of elements already created.

In Section Instructions Examples Basics History Extra

CreateD3

CreateD3 ( ) as Object

Creates a new 3D object at the current Device.

In Section Instructions Examples Basics History Extra

CreateDefaultElements

CreateDefaultElements ( )

Creates elements that are created in the base data view as default elements.

In Section Instructions Examples Basics History Extra

D3
D3 ( ) as Object

This method offers access to the associated 3D object in the Viper environment; the
return value is of type I3DObject (transition between COMOS and the 3D world). The
information is saved on the database side at the Device.

In Section Instructions Examples Basics History Extra

DetailClass

DetailClass ( ) as String

Further detail classification, e.g. terminal, terminal strip, wire, etc. COMOS
constants DetailClass

In Section Instructions Examples Basics History Extra

DetailType

DetailType ( ) as String

Returns the detail type of the CDevice; the DetailType of the owner is specified
for a DeviceClassElement without its own CDevice.

In Section Instructions Examples Basics History Extra

DeleteD3

DeleteD3 ( )
Deletes the associated 3D object.

In Section Instructions Examples Basics History Extra

Devices

Devices ( ) as IComosDOwnCollection

The object's own set of hierarchically-subordinate Devices. The functional scope

corresponds to OwnElements (OwnElementsCollection).

In Section Instructions Examples Basics History Extra

Documents

Documents ( ) as IComosDOwnCollection

The object's own set of hierarchically-secondary objects of class IcomosDDocument.

In Section Instructions Examples Basics History Extra

Elements

Elements ( ) as IComosDCollection

Collection of own and inherited elements.

In Section Instructions Examples Basics History Extra

EnObs

EnObs ( Val as String ) as IComosDCollection

Filters the Elements collection with the specified class parameters.

Valid parameter values

See section DeviceClass.

In Section Instructions Examples Basics History Extra

GeneralObject

GeneralObject ([out, retval] IComosDDevice** retval)

This method runs through the owner chain, starting at the current Device, and
returns the first Device with the class "General" or DeviceClassTopLevel
(constant). Is no such object exists in the owner chain, then NULL or Nothing is
returned.

In Section Instructions Examples Basics History Extra

GetCurrentCase

GetCurrentCase ( ) as IComosDCase
Returns the applicable case for the current object.

In Section Instructions Examples Basics History Extra

GetElementsByClassification

GetElementsByClassification ( ByVal Index as Long, ByVal classification as String )

as IComosDCollection

Parameter Index as long

Index of the searched classification type. Constants see Module ClassificationTypes

or keyword "classificationIndex".

Parameter classification as string

String of the searched classification

Filters the elements below the current device and returns only those elements that
match the searched classification.

In Section Instructions Examples Basics History Extra

GetElementsByClassifications

GetElementsByClassifications ( ByVal classifications as Variant ) as

IComosDCollection

Parameter classifications as variant

Array with the strings of all classification types.

The classification index must be entered for each classification to be checked.

An empty string must be entered for each classification that is not to be checked.

The order of the classifications is determined by the associated classification

index.

Filters the elements below the current device and returns only those elements that
match the specified classifications.

Constants see Module ClassificationTypes or keyword "classificationIndex".

In Section Instructions Examples Basics History Extra

GetFirstElementByClassification

GetFirstElementByClassification ( ByVal Index as Long, ByVal classification as

String ) as IComosDDevice

Parameter Index as long

Index of the searched classification type. Constants see Module ClassificationTypes

or keyword "classificationIndex".

Parameter classification as string

String of the searched classification

Filters the elements below the current device and returns the first element with
the searched classification.
In Section Instructions Examples Basics History Extra

GetFirstElementByClassifications

GetFirstElementByClassifications ( ByVal classifications as Variant ) as

IComosDDevice

Parameter classifications as variant

Array with the strings of all classification types.

The classification index must be entered for each classification to be checked.

An empty string must be entered for each classification that is not to be checked.

The order of the classifications is determined by the associated classification

index.

Returns the first element below the current device which matches one of the
specified classifications.

Constants see Module ClassificationTypes or keyword "classificationIndex".

In Section Instructions Examples Basics History Extra

GetFreeProperty

VARIANT GetFreeProperty([in] string propertyName)

Returns the FreeProperty value for the current object (this), which is specified by
the name that is transferred.
Return value: Value of the FreeProperty as VARIANT. If no FreeProperty with the
specified name exists, the returned variant will contain Variant VT_EMPTY.

Parameter propertyName specifies the FreeProperty from which the value should be
returned. The name must always consist of two parts: the name of the FreeProperty
group (which is also reflected in the table name: "FP_<GroupName>") and the name of
the Property itself (in the column name database). The two parts must be separated
by a dot. Example: OPTIONS.PROP1 activates access to table "FP_OPTIONS" and column
"PROP1".

In Section Instructions Examples Basics History Extra

GetGRSpec

GetGRSpec ( Val as Long ) as IComosDSpecification

Returns the attribute with graphical relevance specified by the parameter.

In Section Instructions Examples Basics History Extra

GetNumberRangeGeneratorAssignment

IComosDNumberRangeGeneratorAssignment GetNumberRangeGeneratorAssignment(long index)

Returns the assignment object specified by "index" (type

IComosDNumberRangeGeneratorAssignment). The index base is 0 and the highest valid
value is "GetNumberRangeGeneratorAssignmentCount() -1".

In Section Instructions Examples Basics History Extra

GetNumberRangeGeneratorAssignmentCount

long GetNumberRangeGeneratorAssignmentCount()

Returns the number of IComosDNumberRangeGeneratorAssignment objects that assign a

NumberRangeGenerator to the current object.

In Section Instructions Examples Basics History Extra

GetOwnCurrentCase

GetOwnCurrentCase ( ) as IComosDCase

Returns the case defined for the current object.

In Section Instructions Examples Basics History Extra

GetPropertiesFromCDevice

GetPropertiesFromCDevice (Val as Object)

Adopts Name, Description, Number, Label, Class, RIClass, DetailClass and CDevice
Pointer from the specified CDevice.

In Section Instructions Examples Basics History Extra

GetStatus
GetStatus ( ) as Long

Returns the status specified by the index (see CDevice.GetStatus)

In Section Instructions Examples Basics History Extra

GetAllConnectorsRecursively

IComosDCollection GetAllConnectorsRecursively ( )

Similar to the AllConnectors method, the object tree is searched recursively,

starting at the current object, and all connectors of the elements found are
returned in the result collection.

Unlike AllConnectors, however, the search does not stop at documents. This means
that additional elements located below documents are found and processed as well.
The method also works faster than AllConnectors, but the sequence of the returned
elements is not identical to the sequence returned by AllConnectors.

Return value: A collection of the IComosDCollection type which contains all the
connectors (IComosDConnector) found.

In Section Instructions Examples Basics History Extra

GLocation

GLocation ( ) as Object

The function searches the hierarchical superstructure for a superordinate location

or for a pointer to a location. If the current object does not have a location
pointer, the owner of the current object is investigated for a location or location
pointer, etc. This iteration stops when the first location or location pointer is
found.
In Section Instructions Examples Basics History Extra

GPosition

GPosition ( ) as Object

The function searches the hierarchical superstructure for a superordinate position

or a pointer to a position. If the current object does not have a position pointer,
the owner of the current object is investigated for a position or position pointer,
etc. This iteration stops when the first position or position pointer is found.

In Section Instructions Examples Basics History Extra

GUnit

GUnit ( ) as Object

The function searches the hierarchical superstructure for a superordinate

unit/position or a pointer to a unit/position. If the current object does not have
a unit/position pointer, the owner of the current object is investigated for a
unit/position or a unit/position pointer, etc. This iteration stops when the first
unit/position or the first unit/position pointer is found.

In Section Instructions Examples Basics History Extra

Implementation

Implementation ( ) as IComosDDevice
Implementation reference (implementation pointer)

If an implementation has been set in the properties of an engineering object, the

connections and connector information (cross-section, color, potential, etc.) are
passed from the request to the object being implemented. The data is returned to
the request when the pointer is deleted.

This functionality does not work if the implementation pointer is set in scripts.
However, if that is precisely what is to be done through the scripted function,
then use a function from the library instead of simple referencing of the pointer:

<workset>.Lib.Device.SetImplementation <Request object >,

<Target object>

<Nothing> has to be specified as the target object to remove an implementation.

Optionally, a third parameter can be passed to the function that sends a message if
an object is "replaced" during the implementation.

In Section Instructions Examples Basics History Extra

IsElement

IsElement ( ) as Boolean

Checks whether the current object is in an OwnCollection (test to determine whether

the owner is a device Device).

In Section Instructions Examples Basics History Extra

IsImplementationValid

IsImplementationValid ( Val as Object ) as Boolean

Returns information on whether the specified object is valid as an implementation

for this Device and whether you are permitted to set the object at the Device.
Possible reasons for invalidity:

Object deleted, no current project set, Device not from the current project, no
editing rights, script function IsImplementationValid, object from the wrong
project.

In Section Instructions Examples Basics History Extra

IsInLocationTree

IsInLocationTree ( ) as Boolean

The function searches iteratively for a location or a unit on the level of the
current object and in the hierarchical superstructure without considering pointers,
and stops when it finds the first object of these classes. The return value is True
if a location has been found.

In Section Instructions Examples Basics History Extra

IsInUnitTree

IsInUnitTree ( ) as Boolean

The function searches iteratively for a location or a unit on the level of the
current object and in the hierarchical superstructure without considering pointers,
and stops when it finds the first object of these classes. The return value is True
if a unit has been found.

In Section Instructions Examples Basics History Extra

IsLocationValid
IsLocationValid ( Val as Object ) as Boolean

Returns information on whether the specified object is valid as a location for this
Device and whether you are permitted to set the object at the Device.

Possible reasons for invalidity:

Object deleted, no current project set, Device not from the current project, no
editing rights, script function IsLocationValid, object from the wrong project,
object is not a location.

In Section Instructions Examples Basics History Extra

IsNameSystemDocumentGroup

IsNameSystemDocumentGroup ( ) as Boolean

Shows whether this involves a document group from the relevant @NameSystem branch.

In Section Instructions Examples Basics History Extra

IsPlaced

IsPlaced (Val as String) as Boolean

Can be called at all Devices.

The function is called with an empty String:

Checks whether the Device is placed at all.

Function is called with string:

Checks whether the Device for the specified diagram type is placed. The string must
correspond exactly to the diagram type or symbol type.

Function is called with IsPlaced (IsPlacedD3):

Checks whether the device is placed in 3D. The COMOS constant IsPlacedD3, IsPlaced
is used for this purpose.

In Section Instructions Examples Basics History Extra

IsProjectDocumentGroup

IsProjectDocumentGroup ( ) as Boolean

Only relevant for Device with class DocumentGroup (document groups).

Returns information on whether the object is located in the @Project branch.

In Section Instructions Examples Basics History Extra

IsRequest

IsRequest ( ) as Boolean

See CDevice.IsRequest.

In Section Instructions Examples Basics History Extra

IsRevisionReleased
bool IsRevisionReleased()

In the case of revisions, specifies whether the revision has already been released.
For Devices that are not a revision, FALSE is returned.

In Section Instructions Examples Basics History Extra

IsUnitValid

IsUnitValid (Val as Object) as Boolean

Returns information on whether the specified object is valid as a unit for this
Device and whether you are permitted to set the object at the Device.

Possible reasons for invalidity:

Object deleted, no current project set, Device not from the current project, no
editing rights, script function IsUnitValid, object from the wrong project, object
is not a unit.

In Section Instructions Examples Basics History Extra

LabelExist

LabelExist ( Val as String ) as Boolean

Checks whether there is a Device with the specified label in the OwnerCollection.

In Section Instructions Examples Basics History Extra

Layers
Layers ( ) as String

See also

Permissible working areas:

CDevice (Layers)

Document (Layers),

Specification (Layers)

User (Layers)

In Section Instructions Examples Basics History Extra

Location

Location

Location ( ) as Object

Location reference (location pointer), can be of class "Location" or "Device" with

DeviceClass "Location".

In Section Instructions Examples Basics History Extra

Lock
Lock ( ) as Boolean

With this property the current document is locked from being changed or deleted.
The lock can only be removed by those users who were also authorized to set this
lock.

In Section Instructions Examples Basics History Extra

MainDevice

MainDevice ( ) as IComosDDevice

The function searches iteratively in the hierarchical superstructure of the current

object, starting at object level, for the highest object of device class "Device".

In Section Instructions Examples Basics History Extra

MatchScanDevices

MatchScanDevices (Val1 as Object, Val2 as Object) as Boolean

The prerequisite for running this function is that ScanDevicesWithCObject had been
called beforehand. See also Chapter ScanDevicesWithCObject.

MatchScanDevices checks whether the relevant object is still located in the scan
set of the parameter 1 object and inherits from the CDevice specified with
parameter 2.

In Section Instructions Examples Basics History Extra

NestedLabel
NestedLabel ( ) as String

The function returns its own label and the labels of all superordinate Devices in
the object structure (iteratively ascending). Aborts if the Device class is
changed.

The name appears if no labels have been allocated. The labels of Devices which have
set the property "Folder" are skipped.

In Section Instructions Examples Basics History Extra

NestedName

NestedName ( ) as String

The function returns its own name and the names of all superordinate Devices in the
object structure (iteratively ascending). Aborts if the Device class is changed.

In Section Instructions Examples Basics History Extra

NestedRelativLabel

NestedRelativLabel ([in] LPDISPATCH referenceObj, [in] VARIANT_BOOL

useOldReferenceStyle, [in] VARIANT_BOOL considerAlias, [in] VARIANT_BOOL
skipFolders, [out, retval] BSTR* nestedLabel)

In Section Instructions Examples Basics History Extra

NextLabel

NextLabel (Val as String) as String

Returns the next valid label (evaluates CDevice.LabelGenerator for this purpose).

In Section Instructions Examples Basics History Extra

NextName

NextName (Val as String) as String

Returns the next free name within the collection in which the object is located,
taking into account the presettings made in the properties mask.

In Section Instructions Examples Basics History Extra

Number

Number ( ) as Double

Integer value for the number, set (e.g. for DeviceClass "Cost" or "Time").

In Section Instructions Examples Basics History Extra

OldAliasFullLabel
OldAliasFullLabel ( ) as String

Old starting point for the AliasFullLabel function.

In Section Instructions Examples Basics History Extra

OwnConnectors

OwnConnectors ( ) as IComosDOwnCollection

Collection of the object's own connectors.

In Section Instructions Examples Basics History Extra

OwnDescription

OwnDescription ( ) as String

The object’s own description.

In Section Instructions Examples Basics History Extra

OwnDocuments

OwnDocuments ( ) as IComosDOwnCollection

Same content as Documents. Only use Documents to avoid any risk of confusion.
OwnDocuments may cease to be used in future.

In Section Instructions Examples Basics History Extra

OwnElements

OwnElements ( ) as IComosDOwnCollection

Collection of the hierarchically-subordinate Device.

In Section Instructions Examples Basics History Extra

OwnLabel

OwnLabel ( ) as String

The object’s own label.

In Section Instructions Examples Basics History Extra

OwnLayers

OwnLayers ( ) as String

The object’s own working areas permit rights administration at the object level.
In Section Instructions Examples Basics History Extra

OwnNumber

OwnNumber ( ) as Double

The object’s own integer value for number, set. (e.g. for DeviceClass "Cost" or
"Time")

In Section Instructions Examples Basics History Extra

OwnSpecifications

OwnSpecifications ( ) as IComosDOwnCollection

Collection of the object's own attributes.

In Section Instructions Examples Basics History Extra

Position

Position ( ) as Object

Returns the Unit pointer if this owns the DeviceClassPosition.

In Section Instructions Examples Basics History Extra

RemoveFreeProperty

void RemoveFreeProperty([in] string propertyName)

Removes the specified FreeProperty at the current object (this). Any subsequent
instances of accessing the specified FreeProperty will now only return the result
VT_EMPTY.

Parameter propertyName: Specifies which FreeProperty should be deleted. For the

naming convention, see the description of GetFreeProperty.

In Section Instructions Examples Basics History Extra

RemoveNumberRangeGeneratorAssignment

void RemoveNumberRangeGeneratorAssignment(long index)

Removes the assignment object specified by "index". The index base is 0.

In Section Instructions Examples Basics History Extra

ReverseLoggedChanges

ReverseLoggedChanges ()

A protocol or ChangeLog stored on the current Device is processed and all recorded
changes are reversed.
In Section Instructions Examples Basics History Extra

RevisionCDevice

RevisionCDevice ( ) as IComosDCDevice

Returns the base object (revision object) used for the revision, depending on the
setting of the RevisionType at the base object.

In Section Instructions Examples Basics History Extra

RIClass

RIClass ( ) as String

P&ID classification, e.g., pipe, instrumentation. Valid parameters RIClass.

In Section Instructions Examples Basics History Extra

SetCurrentCase

SetCurrentCase (Val as Object)

Sets the case specified by the parameter as the current one.

In Section Instructions Examples Basics History Extra

SetCurrentTimestampForRevision

SetCurrentTimestampForRevision ()

Sets the creation stamp on the current timestamp for the Device of the revision
class.

In Section Instructions Examples Basics History Extra

SetDocObjsStatus

SetDocObjsStatus (Val as String)

Sets the database status for:

all BackPointerDocObjs

all BackPointerDocObjs of all elements

All owners of these, iteratively ascending, up to a Device whose owner class is not
DeviceClassDevice.

In Section Instructions Examples Basics History Extra

SetFreeProperty

void SetFreeProperty([in] string propertyName, [in] VARIANT propertyValue)

Sets the value of a FreeProperty of the current object (this).

Parameter propertyName: Specifies which FreeProperty should be changed. For the
naming convention, see the description of GetFreeProperty.

Parameter propertyValue: The new value of the FreeProperty as Variant. The type in
Variant must match the column in the database; otherwise, you can expect error
messages from the database when the current object is saved.

In Section Instructions Examples Basics History Extra

SetStatus

SetStatus ( Val as Object )

Sets the status information for the Device (evaluates IComosDStatusManager as part
of this).

In Section Instructions Examples Basics History Extra

Specifications

Specifications ( ) as IComosDCollection

Collection of own and inherited attributes.

In Section Instructions Examples Basics History Extra

SystemLock
SystemLock ( ) as Long

This property is used to lock the current document against changes or deletion.
Counter that specifies the number of locks set. Changes to the document only become
possible again once the counter = 0.

In Section Instructions Examples Basics History Extra

Unit

Unit ( ) as Object

Unit reference (unit pointer), can be of class "Unit" or "Device" with DeviceClass
"Unit" or "Position".

In Section Instructions Examples Basics History Extra

ULFullLabel

ULFullLabel ( ) as String

GUnit.FullLabel and GLocation.FullLabel and SignedLabel.

See also

GUnit

GLocation

In Section Instructions Examples Basics History Extra

ULFullName

ULFullName ( ) as String

GUnit.FullName and GLocation.FullName and Name.

See also

GUnit

GLocation

In Section Instructions Examples Basics History Extra

IComosDDevSymbol

This chapter contains the following information:IComosDDevSymbol

Filename

OwnDescription

OwnScript

Script

In Section Instructions Examples Basics History Extra

IComosDDevSymbol
Graphical symbol for display in the corresponding documents.

In Section Instructions Examples Basics History Extra

Filename

Filename ( ) as String

Relative file name to the file that is to be used for the symbol if no script was
set.

In Section Instructions Examples Basics History Extra

OwnDescription

OwnDescription ( ) as String

The object’s own description.

In Section Instructions Examples Basics History Extra

OwnScript

OwnScript ( ) as String

The object’s own graphic information in script form that is evaluated by the GEO
engine.
In Section Instructions Examples Basics History Extra

Script

Script ( ) as String

(Graphical) information in script form that is evaluated by the GEO engine.

In Section Instructions Examples Basics History Extra

IComosDDocObj

This chapter contains the following information:IComosDDocObj

CopyMode

DBStatus

ElNr

Par1

Reference

Reference2

ReferenceConnectString

UseType

XQuadrant

YQuadrant
In Section Instructions Examples Basics History Extra

IComosDDocObj

An object placed on COMOS documents.

In Section Instructions Examples Basics History Extra

CopyMode

CopyMode ( ) as Long

Determines the behavior during copy actions:

DocObjCopyMode(0): WithDevice

Device is also copied

DocObjCopyMode(1): Delete

DocObj is deleted

DocObjCopyMode(2): OldReference

DocObj points to old Device

In Section Instructions Examples Basics History Extra

DBStatus
DBStatus ( ) as String

For logocad: Updates or deletes a graphic object.

In Section Instructions Examples Basics History Extra

ElNr

ElNr ( ) as Long

Element number, function-dependent value from Logocad for graphic elements.

In Section Instructions Examples Basics History Extra

Par1

Par1 ( ) as String

Internal parameter used in electrical engineering for potential chains.

In Section Instructions Examples Basics History Extra

Reference

Reference ( ) as Object
Pointer to a placed COMOS object.

In Section Instructions Examples Basics History Extra

Reference2

Reference2 ( ) as Object

Free reference pointer, used in strip technology, for example, to enable references
to documents.

In Section Instructions Examples Basics History Extra

ReferenceConnectString

ReferenceConnectString ( ) as String

Symbolic information of the reference pointer; used when coupling/decoupling an

engineering project to/from the system project.

In Section Instructions Examples Basics History Extra

UseType

UseType ( ) as String

(Old) Diagram type for Logocad

In Section Instructions Examples Basics History Extra

X ( ) as Double

X-coordinate

In Section Instructions Examples Basics History Extra

XQuadrant

XQuadrant ( ) as String

X-quadrant

In Section Instructions Examples Basics History Extra

Y ( ) as Double

Y-coordinate.

In Section Instructions Examples Basics History Extra

YQuadrant

YQuadrant ( ) as String

Y-quadrant.

In Section Instructions Examples Basics History Extra

IComosDDocument

This chapter contains the following information:IComosDDocument

AddNumberRangeGeneratorAssignment

AllBackPointerDocuments

BackPointerCLinks

BackPointerDocuments

BackPointerDocumentsWithOrgDocument

CalculateDirectory

CalculateDirectoryAndMoveFile

ClearDrawingInUse

CDocumentConnectString

Case

CDocument

CheckVirtualElements

ClassificationExists

CLinks

CObject
CObjectConnectString

CountStillCreatableVirtualElements

CreateRevision

Description2

Devices

DocObjs

Documents

DocumentType

DocumentTypeConnectString

EnObs

ErrorFlags

FileNameWithoutDirectories

Filename

FirstPage

FullFileName

GeneralObject

GetBackPointerDocObjs

GetClassification

GetDocObjForDeviceNameMode

GetFileExistsInOverlay

GetFileExistsInOverlayEx

GetFreeProperty

GetInternationalDescription2

GetInternationalDescription3

GetOwnClassification

GLocation

GetNumberRangeGeneratorAssignment

GetNumberRangeGeneratorAssignmentCount

GPosition

GUnit
IsCheckedOutInOtherOverlay

IsDdmContainer

IsDdmDocument

IsDdmPackage

IsDdmVersion

IsInCDeviceTree

IsInDocumentGroupTree

IsInLocationTree

IsInUnitTree

IsLocationValid

IsMasterDocument

IsNameSystemReference

IsProjectReference

IsUnitValid

LastCreatedRevision

LastReleasedRevision

Layers

Location

Lock

MatchScanDocuments

Mode

NameSystemReference

NestedName

NextLabel

NextName

OpenRevision

OrgDocument

OwnLabel

OwnSpecifications
PageCount

PreLoadDevices

ProjectReference

RealCDocument

RemoveFreeProperty

RemoveNumberRangeGeneratorAssignment

RemoveRevisionFromAllOverlays

Report

ReportObject

ResetFileExistsInOverlay

RevisionCDevice

RevisionOf

Revisions

SetClassification

SetDrawingInUse

SetFileExistsInOverlay

SetFreeProperty

SetInternationalDescription2

SetInternationalDescription3

SetOwnClassification

SetSymbolType

ShutDownIReport

Specifications

SpecificationSets

SystemLock

SymbolType

Type

ULFullName

Unit

UseTimeStamp
In Section Instructions Examples Basics History Extra

IComosDDocument

COMOS document object.

In Section Instructions Examples Basics History Extra

AddNumberRangeGeneratorAssignment

void AddNumberRangeGeneratorAssignment(IComosDNumberRangeGenerator generator, long

rank)

Generates a new assignment for the current object using the specified
NumberRangeGenerator and Rank value.

In Section Instructions Examples Basics History Extra

AllBackPointerDocuments

AllBackPointerDocuments ( ) as IComosDCollection

A set of cross-project document objects that have a CDocument pointer to the

current object.

Note This operation is database-supported, meaning that this Collection is newly

created each time the function is called, is not temporarily stored, and may
therefore be very time-intensive.

In Section Instructions Examples Basics History Extra

BackPointerCLinks

BackPointerCLinks ( ) as IComosDOwnCollection

Returns a BackPointerCollection of CLinks that have reference pointers to the

current object.

In Section Instructions Examples Basics History Extra

BackPointerDocuments

BackPointerDocuments ( ) as IComosDCollection

Returns the set of document objects that have a CDocument pointer to the current
object (only the current project).

Note This operation is database-supported, meaning that this Collection is newly

created each time the function is called, is not temporarily stored, and may
therefore be very time-intensive.

In Section Instructions Examples Basics History Extra

BackPointerDocumentsWithOrgDocument
BackPointerDocumentsWithOrgDocument ( ) as IComosDCollection

Returns a BackPointerCollection of objects of class IcomosDDocument, which have

OrgDocument pointers to the current object.

In Section Instructions Examples Basics History Extra

CalculateDirectory

CalculateDirectory ( )

Checks for report documents to see whether the file is to be saved in a sub-
directory. This method is used just once with new reports and internally sets the
sub-directory for these documents. This method is used likewise when copying
documents.

Note Sub-directories are only created from document version 7.0 onwards.

In Section Instructions Examples Basics History Extra

CalculateDirectoryAndMoveFile

CalculateDirectoryAndMoveFile ( ) as Long

Is used to allocate files to the new directory structure. The function calculates
the corresponding directory for report documents in accordance with the conventions
of CalculateDirectory and copies the file there.

In Section Instructions Examples Basics History Extra

ClearDrawingInUse

ClearDrawingInUse ( )

Deletes the editing timestamp.

In Section Instructions Examples Basics History Extra

CDocumentConnectString

CDocumentConnectString ( ) as String

Symbolic information for the CDocument pointer. (Connect / disconnect project)

In Section Instructions Examples Basics History Extra

Case

Case ( ) as IComosDCase

Case reference for case-dependent documents.

In Section Instructions Examples Basics History Extra

CDocument
CDocument ( ) as IComosDDocument

Document reference to a template document.

In Section Instructions Examples Basics History Extra

CheckVirtualElements

CheckVirtualElements ( Val as Object ) as Boolean

Same function as Device.CheckVirtualElements. Checks whether a Device with the

specified CDevice is allowed to be created according to the Virtual rules.

In Section Instructions Examples Basics History Extra

ClassificationExists

bool ClassificationExists([in] long classificationIndex, [in] string searchString)

This method checks whether the specified String is to be found in the

classification specified by the index.

Return value: TRUE, if the specified string is to be found in the specified

classification of the current document (this), otherwise FALSE.

Error message if an invalid parameter is used.

Parameter classificationIndex: Specifies the classification in which the search is

to be conducted:

1 – Hierarchical classification. A check is performed here to determine whether the

classification starts with the specified search string. If the search string is in
the classification, but not directly at the beginning, it is not considered a hit.
2 – Functional classification. Here, it is sufficient for the search string to be
in any part of the classification.

3 - User-specific functional classification. See functional classification.

4 - User-specific hierarchical classification. See hierarchical classification.

Separator

The separator is the period. The separator is specified as follows in the

searchString:

Parameter 1 - hierarchical classification: If a classification needs to be searched

for that covers several layers, the individual layers need to separated by a
period.

Example: Hierarchical classification level 1: "M21", hierarchical classification

level 2: "A050". The searchString is: "M21.A050"

Parameter 2 - functional classification: If a classification needs to be searched

for that can be located anywhere, the enclosing periods can be omitted.

Example: Functional classification 1: "O4", functional classification 2: "A870":

The searchString "A870" is permitted.

In Section Instructions Examples Basics History Extra

CLinks

CLinks ( ) as IComosDOwnCollection

Obsolete; only provided for compatibility reasons. No support in future versions.

Will cease to be available in future.
In Section Instructions Examples Basics History Extra

CObject

CObject ( ) as IComosDCDevice

Pointer to the associated CDevice which is used to conduct inheritance.

In Section Instructions Examples Basics History Extra

CObjectConnectString

CObjectConnectString ( ) as String

Symbolic information for the CObject pointer (connect/disconnect project).

In Section Instructions Examples Basics History Extra

CountStillCreatableVirtualElements

CountStillCreatableVirtualElements ( Val as Object ) as Long

Parameter Val as object

Base object of element to be created

Returns the number of elements of the specified base object that can still be
created below the current object. To do so, the "Virtual" setting at the base
object is evaluated and compared with the number of elements already created.

In Section Instructions Examples Basics History Extra

CreateRevision

CreateRevision (revname as String, elementname as String, cdev as Object,

Description as String, Label as String) as IComosDDevice

Function for creating revision objects and elements outside the COMOS rights
administration system.

In Section Instructions Examples Basics History Extra

Description2

Description2 ( ) as String

Additional description.

In Section Instructions Examples Basics History Extra

Devices

Devices ( ) as IComosDOwnCollection

The object's own set of hierarchically-subordinate Devices. The functional scope

corresponds to OwnElements (OwnElementsCollection)
In Section Instructions Examples Basics History Extra

DocObjs

DocObjs ( ) as IComosDOwnCollection

Hierarchically-subordinate Collection of DocObj objects.

In Section Instructions Examples Basics History Extra

Documents

Documents ( ) as IComosDOwnCollection

Hierarchically-subordinate Collection with document objects.

In Section Instructions Examples Basics History Extra

DocumentType

DocumentType ( ) as IComosDDocumentType

Document type reference for the type of document, must be set for each document.
In Section Instructions Examples Basics History Extra

DocumentTypeConnectString

DocumentTypeConnectString ( ) as String

Symbolic information for the document type reference (connect / disconnect

project).

In Section Instructions Examples Basics History Extra

EnObs

EnObs ( Val as String ) as IComosDCollection

Filters the Elements Collection with the specified class parameters. Valid
parameter values DeviceClass

Examples

EnObs("ED") returns elements of the class Device or element

EnObs("-R") returns objects of all classes up to revision (R).

In Section Instructions Examples Basics History Extra

ErrorFlags

long ErrorFlags
Property of type long. Saves the document status (in terms of evaluation). Possible
values and constants: See also Chapter DocError_.

In Section Instructions Examples Basics History Extra

FileNameWithoutDirectories

FileNameWithoutDirectories ( ) As String

Returns the FileName of the document, without the working layer and subdirectory
("AA" - "ZZ").

In Section Instructions Examples Basics History Extra

Filename

Filename ( ) as String

Name of the file belonging to the document. Whether a file is required for the
document is specified at the DocumentType object.

In Section Instructions Examples Basics History Extra

FirstPage

FirstPage ( ) as Long

First page number of the document. Read-only!

In Section Instructions Examples Basics History Extra

FullFileName

FullFileName ( ) as String

Returns the complete, absolute FileName of this document (evaluates internally

whether FileName is absolute or relative and expands FileName as required to
include DocumentDirectory).

In Section Instructions Examples Basics History Extra

GeneralObject

GeneralObject ([out, retval] IComosDDevice** retval)

Returns the lowermost owner of the Device class General.

In Section Instructions Examples Basics History Extra

GetBackPointerDocObjs

IComosDOwnCollection GetBackPointerDocObjs()

Returns a Collection with all DocObjs which point to the current document (this).

This method replaces the previous method BackPointerDocObjs. The function remains
the same, but the new method works faster.
Return value: Collection with all DocObjs which point to the current document.

In Section Instructions Examples Basics History Extra

GetClassification

GetClassification ( ByVal Index as Long ) as String

Parameter Index as long

Index of the searched classification type. Constants see Module ClassificationTypes

or keyword "classificationIndex".

Returns the classification for the specified classification type of the current
document taking inheritance into consideration.

Note: Only report templates can have a classification.

In Section Instructions Examples Basics History Extra

GetDocObjForDeviceNameMode

DocObj GetDocObjForDeviceNameMode()

This method is intended for Device whose label must contain the name of the
document on which the Device is placed. It returns the DocObj underneath the
document which must be used to form the label. For Device with a specific
DetailClass, the document is never used to form the label. For the following
DetailClasses, NULL is thus always returned as a return value:

Plug
Potential

LogPotential

Terminal

Wire

For the DeviceClasses PlugStrip and TerminalStrip, the first placed Plug/Terminal
is searched and this Device is then used to determine the correct DocObj.

Device with the DeviceClasses Cable, PlugStrip and TerminalStrip must own a
specific classification ("SP"), otherwise the document will not be used for label
formation and this method will return NULL as a return value.

Return value: The DocObj underneath the document which must be used for label
formation. NULL if no document needs to be used for label formation in the case of
the current Device.

In Section Instructions Examples Basics History Extra

GetFileExistsInOverlay

GetFileExistsInOverlay ( ) as Boolean

Returns whether the associated file is in the current layer.

In Section Instructions Examples Basics History Extra

GetFileExistsInOverlayEx
GetFileExistsInOverlayEx(long workingLayerID, /*[out, retval]*/ VARIANT_BOOL*
retval);

Is needed for the overlapping of files in a report. As with GetFileExistsInOverlay,

but with a specification for the Working Layer ID for which you want to know
whether a file exists according to the object model.

In Section Instructions Examples Basics History Extra

GetFreeProperty

GetFreeProperty ( ByVal propertyName as String ) as Variant

Parameter propertyName as string

Specifies the FreeProperty from which the value should be returned. The name must
consist of two parts:

Name of the FreeProperty group

This name is also part of the table name: "FP_<GruppenName>"

Name of the property

This name is also the column name in the database.

The two parts must be separated by a dot. Example: OPTIONS.PROP1 activates access
to table "FP_OPTIONS" and column "PROP1".

Return value

Value of the FreeProperty as VARIANT.

If no FreeProperty with the specified name exists, the returned variant will
contain VT_EMPTY.
Returns the value of the specified FreeProperty for the current object (this).

In Section Instructions Examples Basics History Extra

GetInternationalDescription2

GetInternationalDescription2 (Val as Long) as String

Fetches the localized (foreign-language) text for Description2. The number in the
index of the project languages is used as the parameter.

In Section Instructions Examples Basics History Extra

GetInternationalDescription3

GetInternationalDescription3 (Val as Long) as String

Fetches the localized (foreign-language) text for Description3. The number in the
index of the project languages is used as the parameter.

In Section Instructions Examples Basics History Extra

GetOwnClassification

GetOwnClassification ( ByVal Index as Long ) as String

Parameter Index as log

Index of the searched classification type. Constants see Module ClassificationTypes

or keyword "classificationIndex".

Returns the classification for the specified classification type of the current
document (without inheritance). Note: Only report templates can have a
classification.

In Section Instructions Examples Basics History Extra

GLocation

GLocation ( ) as Object

The function searches the hierarchical superstructure for a superordinate location

or for a pointer to a location. If the current object does not have a location
pointer, the owner of the current object is investigated for a location or location
pointer, etc. This iteration stops when the first location or location pointer is
found.

In Section Instructions Examples Basics History Extra

GetNumberRangeGeneratorAssignment

IComosDNumberRangeGeneratorAssignment GetNumberRangeGeneratorAssignment(long index)

Returns the assignment object specified by "index" (type

IComosDNumberRangeGeneratorAssignment). The index base is 0 and the highest valid
value is "GetNumberRangeGeneratorAssignmentCount() -1".
In Section Instructions Examples Basics History Extra

GetNumberRangeGeneratorAssignmentCount

long GetNumberRangeGeneratorAssignmentCount()

Returns the number of IComosDNumberRangeGeneratorAssignment objects that assign a

NumberRangeGenerator to the current object.

In Section Instructions Examples Basics History Extra

GPosition

GPosition ( ) as Object

The function searches the hierarchical superstructure for a superordinate position

or a pointer to a position. If the current object does not have a position pointer,
the owner of the current object is investigated for a position or position pointer,
etc. This iteration stops when the first position or position pointer is found.

In Section Instructions Examples Basics History Extra

GUnit

GUnit ( ) as Object

The function searches the hierarchical superstructure for a superordinate

unit/position or a pointer to a unit/position. If the current object does not have
a unit/position pointer, the owner of the current object is investigated for a
unit/position or a unit/position pointer, etc. This iteration stops when the first
unit/position or the first unit/position pointer is found.
In Section Instructions Examples Basics History Extra

IsCheckedOutInOtherOverlay

IsCheckedOutInOtherOverlay ( ByVal versionName as String, Out preventingOverlay as

Object, Out preventingTimestamp as Object ) as Long

Parameter versionName as string

Currently without function.

Parameter Out preventingOverlay as object

Output parameter

Includes the working layer in which the version is already checked out with return
value DDMVersionResultAlreadyCheckedOut.

Includes NULL for the released area.

Parameter Out preventingTimestamp as object

Output parameter

Includes the timestamp of the version already checked out with return value
DDMVersionResultAlreadyCheckedOut.

This method only works with version documents. The method determines if this
version is already checked out in another working layer. Return value corresponds
to one of the constants from module ComosSystemConstants, DDMVersionResult*.

In Section Instructions Examples Basics History Extra

IsDdmContainer
bool IsDdmContainer()

Determines whether the current document (this) is a container document from the PQM
environment.

Return value: "true" if the current document is a container document, otherwise

"false".

In Section Instructions Examples Basics History Extra

IsDdmDocument

bool IsDdmDocument()

Determines whether the current document (this) is a document from the PQM
environment. Package documents as well as container and version documents are
considered DDM documents, and this method returns "true" for all three types.

Return value: "true" if the current document if a package, container or version

document from the PQM environment, otherwise "false".

In Section Instructions Examples Basics History Extra

IsDdmPackage

bool IsDdmPackage()

Determines whether the current document (this) is a Package document from the PQM
environment.

Return value: "true" if the current document is a Package document, otherwise

"false".

In Section Instructions Examples Basics History Extra

IsDdmVersion

bool IsDdmVersion()

Determines whether the current document (this) is a version document from the PQM
environment.

Return value: "true" if the current document is a version document, otherwise

"false".

In Section Instructions Examples Basics History Extra

IsInCDeviceTree

IsInCDeviceTree ( ) as Boolean

Returns whether the document is located in the base data. This is the case if there
is a CDevice in the owner Hierarchy.

In Section Instructions Examples Basics History Extra

IsInDocumentGroupTree
IsInDocumentGroupTree ( ) as Boolean

Checks whether the Document is part of the document group view; in other words,
whether the last owner underneath the project is a document group.

In Section Instructions Examples Basics History Extra

IsInLocationTree

IsInLocationTree ( ) as Boolean

See Device.IsInLocationTree. See also Chapter IsInLocationTree.

In Section Instructions Examples Basics History Extra

IsInUnitTree

IsInUnitTree ( ) as Boolean

See Device.IsInUnitTree. See also Chapter IsInUnitTree.

In Section Instructions Examples Basics History Extra

IsLocationValid

IsLocationValid (Val as Object) as Boolean

Returns information on whether the specified object is valid as a location for this
Document and whether you are permitted to set the object at the Document.
Possible reasons for invalidity:

Object deleted, no current project set, Document not from the current project, no
editing rights, script function IsLocationValid, object from the wrong project,
object is not a location.

In Section Instructions Examples Basics History Extra

IsMasterDocument

IsMasterDocument ( ) as Boolean

True: Document is a report template

False: In all other cases.

Determines if the document (the object of the IComosDDocument class) is a report

template.

In Section Instructions Examples Basics History Extra

IsNameSystemReference

IsNameSystemReference ( ) as Boolean

Checks whether the current document is a reference document from the @NameSystem
branch.
In Section Instructions Examples Basics History Extra

IsProjectReference

IsProjectReference ( ) as Boolean

Same as IsNameSystemReference. Here, a check is performed to determine whether the

object is in the @Project branch.

In Section Instructions Examples Basics History Extra

IsUnitValid

IsUnitValid ( Val as Object ) as Boolean

Returns information on whether the specified object is valid as a unit for this
Document and whether you are permitted to set the object at the Document.

Possible reasons for invalidity:

Object deleted, no current project set, Document not from the current project, no
editing rights, script function IsUnitValid, object from the wrong project, object
is not a unit.

In Section Instructions Examples Basics History Extra

LastCreatedRevision

LastCreatedRevision ( ) As Object

Returns the last revision created for this document.

In Section Instructions Examples Basics History Extra

LastReleasedRevision

LastReleasedRevision ( ) As IComosDDevice

Returns the last revision released for this document.

In Section Instructions Examples Basics History Extra

Layers

Layers ( ) as String

Permissible working areas

See also:

CDevice (Layers)

Device (Layers)

Specification (Layers)

User (Layers)

In Section Instructions Examples Basics History Extra

Location

Location ( ) as Object

Location reference (Location pointer), can be of the class Location or Device with
DeviceClass Location

In Section Instructions Examples Basics History Extra

Lock

Lock ( ) as Boolean

With this property the current document is locked from being changed or deleted.
The lock can only be removed by those users who were also authorized to set this
lock.

In Section Instructions Examples Basics History Extra

MatchScanDocuments

MatchScanDocuments (root as Object, Mode as Long) as Boolean

Checks whether the current document would be included in the

ScanDocumentsCollection of the object specified with the parameter (root), with the
ScanModes taken into consideration. Parameter for ScanDokumentsMode: See also
Chapter ScanDocumentsMode.

In Section Instructions Examples Basics History Extra

Mode

Mode ( ) as Long

For documents in the base object tree. Mode = 1 means that the documents are copied
in when creating a Device.

In Section Instructions Examples Basics History Extra

NameSystemReference

NameSystemReference ( ) as IComosDDocument

Returns the reference document from the @NameSystem branch.

In Section Instructions Examples Basics History Extra

NestedName

NestedName ( ) as String

The function returns the own name and the names of all superordinate documents in
the object structure (iteratively ascending).

In Section Instructions Examples Basics History Extra

NextLabel
NextLabel (Val as String) as String

Generates the next free Label; same as the Device.NextLabel method. See also
Chapter (NextLabel).

In Section Instructions Examples Basics History Extra

NextName

NextName(Val As String) As String

Returns the next valid name for the current document. Also evaluates the mask of
the base object.

In Section Instructions Examples Basics History Extra

OpenRevision

OpenRevision ( ) As IComosDDevice

Returns the "*" revision of this document.

In Section Instructions Examples Basics History Extra

OrgDocument
OrgDocument ( ) as IComosDDocument

Document pointer for a document in a document group.

In Section Instructions Examples Basics History Extra

OwnLabel

OwnLabel ( ) as String

The object's own Label.

In Section Instructions Examples Basics History Extra

OwnSpecifications

OwnSpecifications ( ) as IComosDOwnCollection

The object's own set of hierarchically-subordinate Specifications.

In Section Instructions Examples Basics History Extra

PageCount

PageCount ( ) as Long

Number of pages of the document.

In Section Instructions Examples Basics History Extra

PreLoadDevices

PreLoadDevices ( ) as Long

Loads all objects placed on a document (Devices referenced via DocObj) in one
operation to achieve improved performance when opening the document.

In Section Instructions Examples Basics History Extra

ProjectReference

ProjectReference ( ) as IComosDDocument

Same as NameSystemReference. In this case, the reference in the @Project branch is

returned.

In Section Instructions Examples Basics History Extra

RealCDocument

RealCDocument ( ) as IComosDDocument

Original CDocument pointer (i.e. not the one created by means of project-specific
overlay).
In Section Instructions Examples Basics History Extra

RemoveFreeProperty

RemoveFreeProperty ( ByVal propertyName as String )

Parameter propertyName as string

Specifies which FreeProperty should be removed. For the naming convention, see the
description of GetFreeProperty.

Removes the specified FreeProperty at the current object (this). Any subsequent
instances of accessing the specified FreeProperty will now only return the result
VT_EMPTY.

In Section Instructions Examples Basics History Extra

RemoveNumberRangeGeneratorAssignment

void RemoveNumberRangeGeneratorAssignment(long index)

Removes the assignment object specified by "index". The index base is 0.

In Section Instructions Examples Basics History Extra

RemoveRevisionFromAllOverlays
RemoveRevisionFromAllOverlays (Name as String) as Boolean

Removes all unit revisions of this document with the specified name from all
layers.

In Section Instructions Examples Basics History Extra

Report

Report ( ) as Object

Returns the direct access to the report object itself for documents of types
Report, Interactive report, Report template and Interactive report template, from
COMOS (transition between COMOS and the report view). The return value is of data
type IReport.

Examples:

Document.Report.Open opens the report for editing.

Document.Report.OpenReadOnly opens the report as read-only.

In Section Instructions Examples Basics History Extra

ReportObject

ReportObject as Object

Property you can use to set and read the report object for this document. The
report object is the reference object for COMOS reports (see Manual).

The Property provides the established COMOS functionality, which from version 8.2
onwards is defined centrally by means of the comos.dll and is to be used as
standard.
In Section Instructions Examples Basics History Extra

ResetFileExistsInOverlay

ResetFileExistsInOverlay ( )

Resets the information that a file exists for this document in the working layer.
Status after calling this method: No file in the layer.

In Section Instructions Examples Basics History Extra

RevisionCDevice

RevisionCDevice ( ) as IComosDCDevice

Returns the base object (revision object) used for the revision, depending on the
setting of the RevisionType at the base object.

In Section Instructions Examples Basics History Extra

RevisionOf

RevisionOf (Val as Object) as IComosDDevice

Returns the last revision of the specified object that is newer than the last
(newest) change of the object. If there is not a newer one, the last revision is
investigated:

No elements:

returns the current revision

Elements complete:

creates a new revision

Elements not complete:

deletes all elements and returns the revision

In Section Instructions Examples Basics History Extra

Revisions

Revisions ( ) as IComosDCollection

Corresponds to EnObs(DEVICECLASSREVISIONS); also takes Package documents into

consideration during this process.

In Section Instructions Examples Basics History Extra

SetClassification

SetClassification ( ByVal Index as Long, ByVal newClassification as String )

Parameter Index as long

Index of the classification type that is to be set. Constants see Module

ClassificationTypes or keyword "classificationIndex".

Parameter newClassification as string

The classification to be set.

Sets the specified classification to the specified value at the current document.
Note: Only report templates can have a classification.

In Section Instructions Examples Basics History Extra

SetDrawingInUse

SetDrawingInUse ( )

Sets the current timestamp in UseTimeStamp. This shows that the document is being
edited.

In Section Instructions Examples Basics History Extra

SetFileExistsInOverlay

SetFileExistsInOverlay ( )

Has to be called if the file belonging to this document has been changed and
therefore needs to be fetched into the layer (i.e. only to be called upon first
change).

In Section Instructions Examples Basics History Extra

SetFreeProperty
SetFreeProperty ( ByVal propertyName as String, ByVal propertyValue as Variant )

Parameter propertyName as string

Specifies which FreeProperty should be changed. For the naming convention, see the
description of GetFreeProperty.

Parameter propertyValue as variant

The new value of the FreeProperty as variant. The type in the variant must match
the column in the database; otherwise, you can expect error messages from the
database when the current object is saved.

Sets the value of a FreeProperty of the current object (this).

In Section Instructions Examples Basics History Extra

SetInternationalDescription2

SetInternationalDescription2 (Val1 as Long, Val2 as String)

Sets the localized (foreign-language) text for Description2. The number in the
index of the project languages is used as parameter 1. Parameter 2 is the new text.

In Section Instructions Examples Basics History Extra

SetInternationalDescription3

SetInternationalDescription3 (Val1 as Long, Val3 as String)

Sets the localized (foreign-language) text for Description2. The number in the
index of the project languages is used as parameter 1. Parameter 2 is the new text.
In Section Instructions Examples Basics History Extra

SetOwnClassification

SetOwnClassification ( ByVal Index as Long, ByVal newClassification as String )

Parameter Index as long

Index of the classification type that is to be set. Constants see Module

ClassificationTypes or keyword "classificationIndex".

Parameter newClassification as string

The classification to be set.

Sets the specified classification to the specified value at the current document.
Note: Only report templates can have a classification.

In Section Instructions Examples Basics History Extra

SetSymbolType

SetSymbolType (ByVal newVal as String)

Sets the diagram type of the document.

In Section Instructions Examples Basics History Extra

ShutDownIReport

ShutDownIReport ( )

Calls the ShutDown function at IReport and then releases the IReport.

In Section Instructions Examples Basics History Extra

Specifications

Specifications ( ) as IComosDCollection

Collection of own and inherited attributes.

In Section Instructions Examples Basics History Extra

SpecificationSets

SpecificationSets ( ) as IComosDOwnCollection

Obsolete; only provided for compatibility reasons. No support in future versions.

Will cease to be available in future.

In Section Instructions Examples Basics History Extra

SystemLock
SystemLock ( ) as Long

This property is used to lock the current document against changes or deletion.
Counter that specifies the number of locks set. Changes to the document only become
possible again once the counter = 0.

In Section Instructions Examples Basics History Extra

SymbolType

SymbolType ( ) as String

Diagram type of the document.

In Section Instructions Examples Basics History Extra

Type

Type ( ) as Long

Internal distinction

In Section Instructions Examples Basics History Extra

ULFullName
ULFullName ( ) as String

GUnit.FullName and GLocation.FullName and Name.

See also

GUnit

GLocation

In Section Instructions Examples Basics History Extra

Unit

Unit ( ) as Object

Unit reference (unit pointer), can be of the class Unit or Device with
DeviceClassUnit or DeviceClassPosition.

In Section Instructions Examples Basics History Extra

UseTimeStamp

UseTimeStamp ( ) as IComosDTimestamp

Returns the editing time stamp for the document.

In Section Instructions Examples Basics History Extra

IComosDDocumentType

This chapter contains the following information:IComosDDocumentType

Extension

Group

Mode

ProgramName

RunMode

TabType

In Section Instructions Examples Basics History Extra

IComosDDocumentType

COMOS document type object

In Section Instructions Examples Basics History Extra

Extension

Extension ( ) as String

File name extension, e.g. doc, xls or crp.

In Section Instructions Examples Basics History Extra

Group

Group ([in/out, retval] long *pVal)

Grouping of document types. All document types with the same Group value belong in
the same group.

In Section Instructions Examples Basics History Extra

Mode

Mode ( ) as Long

There are two DocType modes:

DocTypeMode (0 ): ExternalFile

i.e. an external file is required.

DocTypeMode (2): NoFile

i.e. an external file is not required. See also Chapter DocTypeMode.

In Section Instructions Examples Basics History Extra

ProgramName

ProgramName ( ) as String

Name of the application connected with this document type.

In Section Instructions Examples Basics History Extra

RunMode

RunMode ( ) as String

Parameter for the application.

In Section Instructions Examples Basics History Extra

TabType

TabType ( ) as String

Table name of the extension table for this document type (no longer in use).

In Section Instructions Examples Basics History Extra

IComosDLanguage

This chapter contains the following information:IComosDLanguage

CharSet

CountryCode

DecimalDelimiter
GroupDelimiter

IsProjectRelevant

LCID

In Section Instructions Examples Basics History Extra

IComosDLanguage

COMOS language object.

In Section Instructions Examples Basics History Extra

CharSet

CharSet ( ) as Long

CharSet returns the Windows CharSet for this language. The CountryCode will also be
shown on the CharSet.

Note Cyrillic is only output with country code 7 (Russian).

In Section Instructions Examples Basics History Extra

CountryCode
CountryCode ( ) as Long

Country code to determine the language display. No sorting by country code is done.

In Section Instructions Examples Basics History Extra

DecimalDelimiter

DecimalDelimiter ( ) as Long

Decimal delimiter (evaluation for DisplayValue of the Spec).

In Section Instructions Examples Basics History Extra

GroupDelimiter

GroupDelimiter ( ) as String

Group delimiter (evaluation for DisplayValue of the Spec).

In Section Instructions Examples Basics History Extra

IsProjectRelevant

bool IsProjectRelevant

Property of the type bool; indicates whether or not the current language is
relevant to the project (to the owner of that language object). The purpose of this
Property is that languages which are not required in the current project are marked
accordingly and can thereby be hidden in the interface.

In Section Instructions Examples Basics History Extra

LCID

LCID ( ) as Long

Internationally defined Language Code Identifier. Unique identifier for languages

(Windows default).

In Section Instructions Examples Basics History Extra

IComosDLocation

This chapter contains the following information:IComosDLocation

BackPointerDevices

BackPointerDocuments

CObject

CObjectConnectString

Devices

Documents

EnObs

GetObjectByLevel

Locations

OwnSpecifications

Specifications
SpecificationSets

In Section Instructions Examples Basics History Extra

IComosDLocation

Replaced by Device with DeviceClass "Location".

Obsolete; only provided for compatibility reasons. No support in future versions.

Will cease to be available in future.

In Section Instructions Examples Basics History Extra

BackPointerDevices

BackPointerDevices ( ) as IComosDOwnCollection

Returns a BackPointerCollection of objects of class Device, which have a Location

pointer to the current object.

In Section Instructions Examples Basics History Extra

BackPointerDocuments

BackPointerDocuments ( ) as IComosDOwnCollection

Returns the set of Document objects that have a Location pointer to the current
object.
In Section Instructions Examples Basics History Extra

CObject

CObject ( ) as IComosDCDevice

Pointer to the associated CDevice which is used to conduct inheritance.

In Section Instructions Examples Basics History Extra

CObjectConnectString

CObjectConnectString ( ) as String

Symbolic information for the CObject pointer (connect/disconnect project).

In Section Instructions Examples Basics History Extra

Devices

Devices ( ) as IComosDOwnCollection

Hierarchically-subordinate Collection of Devices.

In Section Instructions Examples Basics History Extra

Documents

Documents ( ) as IComosDOwnCollection

Hierarchically-subordinate Collection of documents.

In Section Instructions Examples Basics History Extra

EnObs

EnObs (Val as String) as IComosDCollection

Filters the elements collection for objects of the classes specified in the
parameter. Valid parameter values: See also chapter DeviceClass.

Examples

EnObs("ED") returns elements of the class Device or Element

EnObs("-R") returns objects of all classes up to Revision (R).

In Section Instructions Examples Basics History Extra

GetObjectByLevel

GetObjectByLevel ( Val as Long ) as IComosDLocation

Returns the owner structure object specified by the parameter.

In Section Instructions Examples Basics History Extra

Locations

Locations ( ) as IComosDOwnCollection

Hierarchically-subordinate Collection with location objects.

In Section Instructions Examples Basics History Extra

OwnSpecifications

OwnSpecifications ( ) as IComosDOwnCollection

The object's own set of hierarchically-subordinate Specifications.

In Section Instructions Examples Basics History Extra

Specifications

Specifications ( ) as IComosDCollection

Collection of own and inherited Specifications.

In Section Instructions Examples Basics History Extra

SpecificationSets

SpecificationSets ( ) as IComosDOwnCollection

Hierarchically-subordinate Collection with SpecificationSet objects.

In Section Instructions Examples Basics History Extra

IComosDNumberRangeGenerator

This chapter contains the following information:IComosDNumberRangeGenerator

Alphabet

CDevice

CheckEndValue

CheckStartValue

EndValue

GetLastUsedValue

GetNextValue

GetNumberRangeGeneratorAssignment

GetNumberRangeGeneratorAssignmentCount

Increment

IsAlreadyInUse

Postfix

Prefix

SelectedProperties

StartValue
In Section Instructions Examples Basics History Extra

IComosDNumberRangeGenerator

A NumberRangeGenerator contains the definition for naming or numbering objects.

However, you are not restricted to numerical values, and may also generate
ascending or descending letter sequences. Once you have generated a
NumberRangeGenerator, use an object of the type
IComosDNumberRangeGeneratorAssignment to assign the generator to a COMOS object of
type Device, Document or Project . New objects generated underneath this so-called
owner of the NumberRangeGenerator are assigned a name or identifier from the
defined number or letter range if all necessary conditions have been met (see
below).

Important: As soon as the NumberRangeGenerator is in use, i.e after it has

generated at least one value, you can no longer edit properties that will influence
the generator's result.

Note INumberRangeGenerator

The class "NumberRangeGenerator" or the associated interface

"INumberRangeGenerator" is outdated. Only IComosDNumberRangeGenerator is documented
in this class documentation.

In Section Instructions Examples Basics History Extra

Alphabet

string Alphabet

Property of the type string that logs the characters used to form
names/identifiers. The sequence of the characters determines the order used (e.g
"0123456789" defines the natural order of numbers).
In Section Instructions Examples Basics History Extra

CDevice

IComosDCDevice CDevice

Property of the type IComosDCDevice. Pointer to a base object. Only the objects
using the specified base object can use this generator for generation. An object or
object tree may be assigned several NumberRangeGenerators. Which one of these will
actually be used to generate new objects in this tree is primarily determined by
means of the CDevice that has been assigned.

In Section Instructions Examples Basics History Extra

CheckEndValue

CheckEndValue ( ByVal StartValue as String, ByVal EndValue as String, ByVal

Increment as Long ) as Long

Parameter StartValue as string

Start value of the NumberRangeGenerator and thus the first permitted value of the
number range.

Parameter EndValue as string

Maximum possible value of the number range.

Parameter Increment as long

When a new value is generated, the value generated last is incremented by the value
Increment.

Permitted values for Increment:

1
-1

The method checks the transferred values for validity regarding the currently used
NumberRangeGenerator and the currently used end value. The return value indicates
if the value combination is valid or which error was found. Constants see Module
ComosSystemConstants, values "NRGCheck...".

In Section Instructions Examples Basics History Extra

CheckStartValue

CheckStartValue ( ByVal StartValue as String, ByVal EndValue as String, ByVal

Increment as Long ) as Long

Parameter StartValue as string

Start value of the NumberRangeGenerator and thus the first permitted value of the
number range.

Parameter EndValue as string

Maximum possible value of the number range.

Parameter Increment as long

When a new value is generated, the value generated last is incremented by the value
Increment.

Permitted values for Increment:

-1
The method checks the transferred values for validity regarding the currently used
NumberRangeGenerator and the currently used start value. The return value indicates
if the value combination is valid or which error was found. Constants see Module
ComosSystemConstants, values "NRGCheck...".

In Section Instructions Examples Basics History Extra

EndValue

string EndValue

Property of the type string; contains the highest value to be generated. As soon as
this value has been reached, the generator cannot generate any further values and
is out of resources.

In Section Instructions Examples Basics History Extra

GetLastUsedValue

string GetLastUsedValue()

Returns the value of type string, which was the last one produced by the generator.

In Section Instructions Examples Basics History Extra

GetNextValue
GetNextValue ( ) as String

Returns the next value defined by the NumberRangeGenerator. If the

NumberRangeGenerator is initialized incorrectly or exhausted, an exception is
triggered.

In Section Instructions Examples Basics History Extra

GetNumberRangeGeneratorAssignment

IComosDNumberRangeGeneratorAssignment GetNumberRangeGeneratorAssignment(long index)

Returns the assignment object specified by "index" (type

IComosDNumberRangeGeneratorAssignment). The index base is 0 and the highest valid
value is "GetNumberRangeGeneratorAssignmentCount() -1".

In Section Instructions Examples Basics History Extra

GetNumberRangeGeneratorAssignmentCount

long GetNumberRangeGeneratorAssignmentCount()

Returns the number of IComosDNumberRangeGeneratorAssignment objects that assign a

NumberRangeGenerator to the current object.

In Section Instructions Examples Basics History Extra

Increment
long Increment

Property of type long; defines the increment for value generation. Only the values
1 and -1 are currently allowed, which means that either the direct predecessor or
direct successor is used; greater steps are currently not allowed.

In Section Instructions Examples Basics History Extra

IsAlreadyInUse

bool IsAlreadyInUse

Property of the type bool; specifies whether or not the NumberRangeGenerator is

already in use (i.e. has generated at least one value). This allows you to decide
whether or not you can still edit the properties of the NumberRangeGenerator.

In Section Instructions Examples Basics History Extra

Postfix

string Postfix

Property of type string; similar to property Prefix, takes a suffix that is

appended to all names/identifiers generated.

In Section Instructions Examples Basics History Extra

Prefix
string Prefix

Property of type string; takes a prefix that leads all names/identifiers generated.

In Section Instructions Examples Basics History Extra

SelectedProperties

long SelectedProperties

Property of type long; defines the properties for which the NumberRangeGenerator is
to be used. The Long value is interpreted as bit array, with each bit representing
a property. Constants are available for the properties that can be used:

NumberRangeGeneratorSelectedPropertyName

NumberRangeGeneratorSelectedPropertyLabel

In Section Instructions Examples Basics History Extra

StartValue

string StartValue

Property of type string; contains the first value to be generated. This string may
only consist of characters that are also part of the alphabet.

In Section Instructions Examples Basics History Extra

IComosDObjectHistoryEntries
This chapter contains the following information:IComosDObjectHistoryEntries

Count

Item

In Section Instructions Examples Basics History Extra

IComosDObjectHistoryEntries

This Collection contains the history entries of an object for one or more layers.

In Section Instructions Examples Basics History Extra

Count

Count ( ) As Long

Returns the number of history entries in the Collection.

In Section Instructions Examples Basics History Extra

Item

Item (Index As Long) As IComosDObjectHistoryEntry

Returns the Item with the specified Index from the Collection.

In Section Instructions Examples Basics History Extra

IComosDObjectHistoryEntry

This chapter contains the following information:IComosDObjectHistoryEntry

CreatedBy

NextEntry

Object

PreviousEntry

Remark

ValidFrom

ValidTo

In Section Instructions Examples Basics History Extra

IComosDObjectHistoryEntry

An object of this class contains a history entry, which had been created by the
history monitoring, plus the associated history information.

In Section Instructions Examples Basics History Extra

CreatedBy
CreatedBy ( ) As Object

Returns the user whose change operation created this history entry.

In Section Instructions Examples Basics History Extra

NextEntry

NextEntry ( ) As IComosDObjectHistoryEntry

Returns the history entry directly following this history entry in the
chronological order of the history.

In Section Instructions Examples Basics History Extra

Object

Object ( ) As Object

Returns the object that is assigned to this history entry.

In Section Instructions Examples Basics History Extra

PreviousEntry
PreviousEntry ( ) As IComosDObjectHistoryEntry

Returns the history entry directly preceding this history entry in the
chronological order of the history.

In Section Instructions Examples Basics History Extra

Remark

Remark ( ) As String

Returns a remark that corresponds to the at which the history entry was created.
The remark may come from either the HistoryRemark ( ) function at the Workset or
the description of a release.

In Section Instructions Examples Basics History Extra

ValidFrom

ValidFrom ( ) As String

Returns the point in time from which the object with these contents was valid in
the database.

In Section Instructions Examples Basics History Extra

ValidTo
ValidTo ( ) As String

Returns the point in time up to which the object with these contents was valid.

The point in time is blank if the object is still valid.

In Section Instructions Examples Basics History Extra

IComosDObjectRevision

This chapter contains the following information:IComosDObjectRevision

In Section Instructions Examples Basics History Extra

IComosDObjectRevision

Does not contain own methods or Properties.

Saves the history entry that is created when a working layer is released into the
released layer.

In Section Instructions Examples Basics History Extra

IComosDPhysUnit

This chapter contains the following information:IComosDPhysUnit

AddTerm
AllBackPointerSpecifications

BackPointerSpecifications

CalcFrom

DINLabel

Factor

FactorReciprocal

IsD3Unit

IsDefaultUnit

IsSIUnit

Precision

In Section Instructions Examples Basics History Extra

IComosDPhysUnit

COMOS object for physical units.

In Section Instructions Examples Basics History Extra

AddTerm

Main statement

AddTerm() as Double

Additive constant for the conversion of physical units.

Example:
PhysUnit

Factor

AddTerm

Meter

Kilometer

0.001

Centimeter

100

Kelvin

Celsius

273

In Section Instructions Examples Basics History Extra

AllBackPointerSpecifications
AllBackPointerSpecifications() as IComosDCollection

Returns a TempCollection with all Specifications that use this unit (PhysUnit).

The BackpointerCollection for Specification.Unit. These

AllBackPointerSpecifications return the Specifications from all projects.

In Section Instructions Examples Basics History Extra

BackPointerSpecifications

BackPointerSpecifications() as IComosDCollection

See AllBackPointerSpecifications. Only the Specifications of the current project

are returned in this case.

In Section Instructions Examples Basics History Extra

CalcFrom

CalcFrom(Val1 as Object, Val2 as String) as Double

Converts the value (val2) of a PhysUnit (val1) into the PhysUnit that was called.
The parameter Val2 may not be specified with any group delimiters.

Example

Meter.CalcFrom(Km,1) results in: "1000"

Used by CalcFrom from the IComosDSpecification.

In Section Instructions Examples Basics History Extra

DINLabel

DINLabel ( ) as String

DIN label of the current physical unit.

In Section Instructions Examples Basics History Extra

Factor

Factor() as Double

Multiplicative constants for the conversion of physical units. See also Chapter
AddTerm.

In Section Instructions Examples Basics History Extra

FactorReciprocal

FactorReciprocal() as Boolean

Determines whether the reciprocal of the factor is to be used.

In Section Instructions Examples Basics History Extra

IsD3Unit
IsD3Unit() As Boolean

Shows whether this unit is the 3D unit of the unit group (see PhysD3Unit from
IComosDPhysUnitGroup).

In Section Instructions Examples Basics History Extra

IsDefaultUnit

IsDefaultUnit() as Boolean

Result is TRUE if the default Unit of the superordinate group is the same as the
PhysUnit that was called.

In Section Instructions Examples Basics History Extra

IsSIUnit

IsSIUnit() as Boolean

Result is TRUE if the SI-Unit of the superordinate group is the same as the
PhysUnit that was called.

In Section Instructions Examples Basics History Extra

Precision
Precision() as Long

Display precision of the numeric specifications with this PhysUnit (number of

decimal places).

In Section Instructions Examples Basics History Extra

IComosDPhysUnitGroup

This chapter contains the following information:IComosDPhysUnitGroup

AllBackPointerSpecifications

BackPointerSpecifications

PhysD3Unit

PhysDefaultUnit

PhysDefaultUnit1

PhysDefaultUnit2

PhysDefaultUnit3

PhysDefaultUnit4

PhysDefaultUnit5

PhysSIUnit

PhysUnits

In Section Instructions Examples Basics History Extra

IComosDPhysUnitGroup
COMOS object groups of physical units.

In Section Instructions Examples Basics History Extra

AllBackPointerSpecifications

AllBackPointerSpecifications() as IComosDCollection

Returns a TempCollection with all Specifications that use this unit group
PhysUnitGroup.

The BackpointerCollection for Specification.Unit (for groups). These

AllBackPointerSpecifications return the Specifications from all projects.

In Section Instructions Examples Basics History Extra

BackPointerSpecifications

BackPointerSpecifications() as IComosDCollection

See AllBackPointerSpecifications. Only the Specifications of the current project

are returned in this case.

In Section Instructions Examples Basics History Extra

PhysD3Unit

PhysD3Unit() As IComosDPhysUnit
Property for the 3D unit.

In Section Instructions Examples Basics History Extra

PhysDefaultUnit

PhysDefaultUnit() as IComosDPhysUnit

The PhysUnit set as the default unit.

In Section Instructions Examples Basics History Extra

PhysDefaultUnit1

PhysDefaultUnit1() As IComosDPhysUnit

Property for default unit metric.

In Section Instructions Examples Basics History Extra

PhysDefaultUnit2

PhysDefaultUnit2() As IComosDPhysUnit

Property for default unit British.

In Section Instructions Examples Basics History Extra

PhysDefaultUnit3

PhysDefaultUnit3() As IComosDPhysUnit

Property for default unit System1.

In Section Instructions Examples Basics History Extra

PhysDefaultUnit4

PhysDefaultUnit4() As IComosDPhysUnit

Property for default unit System2.

In Section Instructions Examples Basics History Extra

PhysDefaultUnit5

PhysDefaultUnit5() As IComosDPhysUnit

Property for default unit System3.

In Section Instructions Examples Basics History Extra

PhysSIUnit

PhysSIUnit() as IComosDPhysUnit

The PhysUnit set as SI.

In Section Instructions Examples Basics History Extra

PhysUnits

PhysUnits() as IComosDOwnCollection

Hierarchically-subordinate Collection with physical units as objects.

In Section Instructions Examples Basics History Extra

IComosDProgressBarHider

The IComosDProgressBarHider interface is empty. It is only used to define an object

of the type IComosDProgressBarHider.

See also chapter HideProgressBar.

In Section Instructions Examples Basics History Extra

IComosDProject
This chapter contains the following information:IComosDProject

ActualErrorObjectsCount

AddNumberRangeGeneratorAssignment

AllCDevices

AllCDevicesWithScript

AllDevices

AllDocumentGroups

AllDocuments

AllDocumentsWithDocumentType

AllLocations

AllStandardTables

AllUnits

Cases

CDevices

CDeviceSystem

CheckAndWriteLogFile

CheckDocumentDirectory

CheckPreLoadSpecs

CheckVirtualElements

CObject

CompressDatabaseAndDBDirectory

CompressDatabaseAndDBDirectoryTimestamp

ConnectorPrefix

ConnectWithCDeviceSystem

ConnectWithUserSystem

CopyDataFromSystemProject

CountStillCreatableVirtualElements

CSpecificationSets

CurrentCharSet
CurrentLanguage

CurrentObjectRevision

CurrentPhysUnitGroup

CurrentWorkingOverlay

DBCopy

DBCopyWithoutRevisions

DBDelete

DBStatus

DBStatusErrorText

Description2

Description3

DevicePrefix

Devices

DisconnectFromCDeviceSystem

DisconnectFromUserSystem

DisconnectStatus

DocumentPrefix

Documents

DocumentTypes

EnObs

ErrorObjectsCount

ErrorObjectsDescription

ErrorObjectsErrorCode

ErrorObjectsItem

ErrorObjectsMode

ErrorObjectsRemove

GetCDeviceBySystemFullname

GetCDeviceSeparator

GetConsolidationShadowObject
GetCSpecificationSetSeparator

GetCurrentCase

GetDBCurrentLanguage

GetDocumentDirectory

GetFunctionRights

GetHierarchyObjectByName

GetImportUID

GetInternationalDescription2

GetInternationalDescription3

GetNumberRangeGeneratorAssignment

GetNumberRangeGeneratorAssignmentCount

GetParametersFromCDeviceSystem

GetShadowObject

GetWorkingOverlay

GlobalTestForCurrentOverlay

ImportOverlay

IsIDBProject

IsQueryStatusActive

Languages

LoadObjectsInBoundingBox

LocationPrefix

Locations

ObjectRevisions

OverlayAdministrationRights

OwnDocumentTypes

OwnParameters

OwnPhysUnitGroups

OwnSpecifications

OwnStandardTables

Parameters
Params

PhysDir

PhysUnitGroups

PickLists

PositionPrefix

PrimaryLanguage

PreLoadSpecs

ProjectSpecifications

Put_ConnectedBaseWorkingOverlay

RecalculateWorkingLayerHierarchy

RefreshLabelSigns

RefreshQueryStatus

ReleaseObjectsFromOtherProjects

RelevantLanguages

RemoveNumberRangeGeneratorAssignment

Rights

SaveErrorObjects

SavePickList

SetCurrentCase

SetCurrentLanguageForSession

SetImportUID

SetInternationalDescription2

SetInternationalDescription3

SetProjectForMixedCollections

Specifications

SpecificationSets

StandardTables

SwitchCDeviceSystemProject

Type
Units

UnitPrefix

UseLanguages

UserSystem

WorkingOverlays

In Section Instructions Examples Basics History Extra

IComosDProject

The COMOS project object is located in the object hierarchy at the uppermost point
directly under the Workset.

In Section Instructions Examples Basics History Extra

ActualErrorObjectsCount

ActualErrorObjectsCount() As Long

Returns the number of objects of the error list that currently cannot be saved
(i.e., check <> 0). Toggles the "lightning" icon in the status line.

In Section Instructions Examples Basics History Extra

AddNumberRangeGeneratorAssignment
void AddNumberRangeGeneratorAssignment(IComosDNumberRangeGenerator generator, long
rank)

Generates a new assignment for the current object using the specified
NumberRangeGenerator and Rank value.

In Section Instructions Examples Basics History Extra

AllCDevices

AllCDevices() as IComosDCollection

Returns all CDevices of the project (CDevices collection and OwnElements

collection).

In Section Instructions Examples Basics History Extra

AllCDevicesWithScript

AllCDevicesWithScript() as IComosDCollection

Collection with all CDevices that own a script.

In Section Instructions Examples Basics History Extra

AllDevices

AllDevices() as IComosDCollection
Collection of all Devices in the relevant project.

In Section Instructions Examples Basics History Extra

AllDocumentGroups

AllDocumentGroups() as IComosDCollection

Collection of all Devices with the class DocumentGroup in the relevant project.

In Section Instructions Examples Basics History Extra

AllDocuments

AllDocuments() as IComosDCollection

Collection of all Document objects in the relevant project.

In Section Instructions Examples Basics History Extra

AllDocumentsWithDocumentType

AllDocumentsWithDocumentType(Val as Object) as IComosDCollection

Collection of all Document objects and the DocumentType stipulated by the parameter
in the relevant project.
In Section Instructions Examples Basics History Extra

AllLocations

AllLocations() as IComosDCollection

Collection of all Locations and all Devices of class Location in the relevant
project.

In Section Instructions Examples Basics History Extra

AllStandardTables

AllStandardTables() as IComosDCollection

Collection of all standard Tables used in the project.

In Section Instructions Examples Basics History Extra

AllUnits

AllUnits() as IComosDCollection

Collection of all units (Units) and all Devices of class Unit in the relevant
project.
In Section Instructions Examples Basics History Extra

Cases

Cases() as IComosDOwnCollection

Hierarchically-subordinate Collection with all cases.

In Section Instructions Examples Basics History Extra

CDevices

CDevices() as IComosDOwnCollection

Hierarchically-subordinate (structure-forming) Collection with objects of class

CDevice.

In Section Instructions Examples Basics History Extra

CDeviceSystem

CDeviceSystem() as IComosDProject

Base data project; if this Property is implemented, it is necessary to disconnect

the relevant project with DisconnectFromCDeviceSystem and reconnect it with
ConnectWithCDeviceSystem. Alternatively (faster), use SwitchCDeviceSystemProject.

In Section Instructions Examples Basics History Extra

CheckAndWriteLogFile

CheckAndWriteLogFile(Val as String) as Long

Checks and corrects the specified project in the database and creates an error
list.

Note Depends on the project size and can be very time-consuming.

In Section Instructions Examples Basics History Extra

CheckDocumentDirectory

CheckDocumentDirectory()

Checks for existing DocumentDirectory. If one does not exist, it is created.

In Section Instructions Examples Basics History Extra

CheckPreLoadSpecs

CheckPreLoadSpecs(Val as Long) as Boolean

Decides whether the preloading of attributes is worthwhile. The result depends on

the database system being used and the number of Specs that are queried.

See also Chapter PreLoadSpecs.

In Section Instructions Examples Basics History Extra

CheckVirtualElements

CheckVirtualElements(Val as Object) as Boolean

Checks whether there are fewer elements with the name of the CDevices as the prefix
in the OwnElements collection than were specified in the CDevice.Virtual property.
Checks directly under the current project.

In Section Instructions Examples Basics History Extra

CObject

CObject() as IComosDCDevice

The CDevice that is valid for the project. It is saved as CObject at the
SpecificationSet with the name System. This method is only used for easier access.

In Section Instructions Examples Basics History Extra

CompressDatabaseAndDBDirectory

CompressDatabaseAndDBDirectory()

As with Workset.CompressDatabaseAndDBDirectory. All entries that are marked as

deleted (HardDelete flag) in the database (DEL_FLAG = 1) and the associated files
are removed. Unlike the Workset method, not all entries are considered in this
case. Only the entries that relate to the specified project are considered.
In Section Instructions Examples Basics History Extra

CompressDatabaseAndDBDirectoryTimestamp

void CompressDatabaseAndDBDirectoryTimestamp([in] double oleDate)

Removes deleted objects from the database that are older than the transferred point
in time and removes document files associated with deleted documents.

Parameter oleDate: Only objects that are older than this point in time will be
removed from the database. In the case of document files to be deleted, this point
in time is not evaluated. All files associated with deleted documents are deleted.

In Section Instructions Examples Basics History Extra

ConnectorPrefix

ConnectorPrefix() as String

Old notation for the allocation of names of connectors.

In Section Instructions Examples Basics History Extra

ConnectWithCDeviceSystem

ConnectWithCDeviceSystem() as IComosDCollection

Connects the specified project to the base data project. This is necessary when
changing the base project or after sourcing out projects. The returned Collection
contains all objects that could not be allocated properly.

In Section Instructions Examples Basics History Extra

ConnectWithUserSystem

ConnectWithUserSystem() as IComosDCollection

Connects the specified project to the template project. This may be necessary after
sourcing out projects. The returned Collection contains all objects that could not
be allocated properly.

In Section Instructions Examples Basics History Extra

CopyDataFromSystemProject

CopyDataFromSystemProject()

Copies the CDevice structure from the system project into the current project.

In Section Instructions Examples Basics History Extra

CountStillCreatableVirtualElements

CountStillCreatableVirtualElements ( Val as Object ) as Long

Parameter Val as object

Base object of element to be created

The following information is evaluated for the specified base object:

"Virtual" setting

The number of created elements

Return value is the number of elements of the specified base object that can still
be created below the current object.

In Section Instructions Examples Basics History Extra

CSpecificationSets

CSpecificationSets() as IComosDOwnCollection

Hierarchically-subordinate Collection with CSpecificationSet objects.

Obsolete; only provided for compatibility reasons. No support in future versions.

Will cease to be available in future.

In Section Instructions Examples Basics History Extra

CurrentCharSet

CurrentCharSet() as Long

CurrentCharSet (returns CharSet of the CurrentLanguage).

In Section Instructions Examples Basics History Extra

CurrentLanguage

CurrentLanguage() as IComosDLanguage

The language being used currently.

In Section Instructions Examples Basics History Extra

CurrentObjectRevision

CurrentObjectRevision() as IComosDObjectRevision

Not implemented yet!

In Section Instructions Examples Basics History Extra

CurrentPhysUnitGroup

CurrentPhysUnitGroup System() As Long

Property for the current unit system (metric, British, alternative system 1- 3).

In Section Instructions Examples Basics History Extra

CurrentWorkingOverlay

CurrentWorkingOverlay() as IComosDWorkingOverlay

Current WorkingOverlay

In Section Instructions Examples Basics History Extra

DBCopy

DBCopy()

Creates a copy of the specified project in the database. Workset must be

reinitialized to be able to open the new project.

In Section Instructions Examples Basics History Extra

DBCopyWithoutRevisions

DBCopyWithoutRevisions()

Copies the project without copying the revisions as well (no revision objects, no
revision documents).

In Section Instructions Examples Basics History Extra

DBDelete

DBDelete()

Deletes the relevant project from the database; this also requires reinitialization
of the Workset to prevent access to old data.

Note This operation does not mark the objects under the current project as deleted
(delete flag), but instead genuinely deletes all specified objects from the
database!

In Section Instructions Examples Basics History Extra

DBStatus

DBStatus() as Boolean

Returns the validity status of the project. This status is set to valid provided it
was possible to carry out the database operation in full and without errors
(applies to all database operations that lead to the creation of a new project
(such as copying, importing, exporting)).

In Section Instructions Examples Basics History Extra

DBStatusErrorText

DBStatusErrorText() as String

Returns more information for an existing DBStatus Error (see Project.DBStatus).

The text includes the action that led to the error, together with the user and the
date of the action.
In Section Instructions Examples Basics History Extra

Description2

Description2() as String

Additional description.

In Section Instructions Examples Basics History Extra

Description3

Description3() as String

Additional description.

In Section Instructions Examples Basics History Extra

DevicePrefix

DevicePrefix() as String

Old notation for allocating names of Devices.

In Section Instructions Examples Basics History Extra

Devices

Devices() as IComosDOwnCollection

The object's own set of hierarchically-subordinate Devices.

In Section Instructions Examples Basics History Extra

DisconnectFromCDeviceSystem

DisconnectFromCDeviceSystem() as Boolean

Disconnects the relevant project from the system project and resets all pointers to
"symbolic information" (ConnectStrings), in order to allow subsequent reconnection
to another system project to be carried out without any problems.

In Section Instructions Examples Basics History Extra

DisconnectFromUserSystem

DisconnectFromUserSystem() as Boolean

Disconnects the relevant project from the template project and resets all pointers
to "symbolic information" (ConnectStrings), in order to allow subsequent
reconnection to another template project to be carried out without any problems.

In Section Instructions Examples Basics History Extra

DisconnectStatus

DisconnectStatus(Val as Long) as Boolean

Displays the connection status of the projects specified by the parameter. Valid
parameters: See also Chapter Project.

In Section Instructions Examples Basics History Extra

DocumentPrefix

DocumentPrefix() as String

Old notation for the allocation of names of documents.

In Section Instructions Examples Basics History Extra

Documents

Documents() as IComosDOwnCollection

Hierarchically-subordinate Collection with Document objects.

In Section Instructions Examples Basics History Extra

DocumentTypes
DocumentTypes() as IComosDCollection

Collection of document types from OwnDocumentTypes of the relevant project and the
system project.

In Section Instructions Examples Basics History Extra

EnObs

EnObs(Val as String) as IComosDCollection

Filters the elements collection for objects of the classes specified in the
parameter. Valid parameter values: See also chapter DeviceClass.

Examples

EnObs("ED") returns elements of the class Device or Element

EnObs("-R") returns objects of all classes up to Revision (R).

In Section Instructions Examples Basics History Extra

ErrorObjectsCount

ErrorObjectsCount() as Long

Number of entries in the error list. These entries are managed for each user and
for each project. The entries consist of:

Mode ErrorObjectsMode
Code

Comos-Cbject

Description

In Section Instructions Examples Basics History Extra

ErrorObjectsDescription

ErrorObjectsDescription(Val as Long) as String

Description of the error list entry specified with the parameter.

In Section Instructions Examples Basics History Extra

ErrorObjectsErrorCode

ErrorObjectsErrorCode(Val as Long) as Long

Error code of the error list entry.

In Section Instructions Examples Basics History Extra

ErrorObjectsItem
ErrorObjectsItem(Val as Long) as Object

COMOS Object of the error list entry.

In Section Instructions Examples Basics History Extra

ErrorObjectsMode

ErrorObjectsMode(Val as Long) as Long

Mode of the error list entry.

In Section Instructions Examples Basics History Extra

ErrorObjectsRemove

ErrorObjectsRemove(index as Long)

Removes the error list entry specified by the index.

In Section Instructions Examples Basics History Extra

GetCDeviceBySystemFullname

IComosDCDevice GetCDeviceBySystemFullName(string systemFullName, long mode)

Searches for a CDevice which owns the specified SystemFullName. The CDevice can be
found both in the current engineering project and in the base project in use.

This method is preferable to the GetHierarchyObjectByName method because inherited

elements are also found and a search sequence can be specified.

The mode parameter is used to determine the projects in which the search will be
carried out, and in what order. Note that local base objects located below a base
object from SO1 are considered to be base objects from SO1 for the purposes of this
search method. Only if the complete owner chain is part of the engineering object
does the object belong to the engineering project for the purposes of the search.

This means: If two base objects with the same name are located in the same position
but in different projects (engineering project and base project), both objects are
considered to be part of the base project and only one of them is returned as
return value. The object from the base project has precedence in the default
setting.

Parameters

systemFullName

Only CDevice which own this specified SystemFullName are returned.

mode

Specifies the order in which projects are searched:

CDeviceBySystemFullName_Mode_OwnProject (Long value: 0):

CDevice is only searched for in the current engineering project.

CDeviceBySystemFullName_Mode_OwnCDevice (Long value: 1):

CDevice is first searched for in the current engineering project. If it is not

found there, the base project in use is searched.

CDeviceBySystemFullName_Mode_CDeviceOwn (Long value: 2):

CDevice is first searched for in the base project in use. If it is not found there,
the current engineering project is searched.

CDeviceBySystemFullName_Mode_CDevice (Long value: 3):

CDevice is only searched for in the base project in use.

If the CDevice is present in the base project and in the engineering project, the
mode parameter determines which of the two objects is found.

In Section Instructions Examples Basics History Extra

GetCDeviceSeparator

GetCDeviceSeparator() as String

Returns the delimiter for the FullName of the CDevice.

In Section Instructions Examples Basics History Extra

GetConsolidationShadowObject

GetConsolidationShadowObject ( Position as Long, Object as Object ) as Object

Parameter Position as long

Determines the working layer to be evaluated. Permitted values:

1: Update

In this case, the object that is used during the comparison on transferred. The
"Delta" working layer is created as the comparison result. The object can originate
in the "Update collection" working layer or in the "Major release area" working
layer.

2: Delta layer

3: Update collection layer

4: Major release area layer

Parameter Object as object

The object to be evaluated in the current working layer.

Transfers the corresponding counterpart for the specified object in the specified
working layer.

In Section Instructions Examples Basics History Extra

GetCSpecificationSetSeparator

GetCSpecificationSetSeparator() as String

Returns the delimiter for the FullName of the CSpecificationSets.

In Section Instructions Examples Basics History Extra

GetCurrentCase

GetCurrentCase() as Object

Returns the current case of the project.

In Section Instructions Examples Basics History Extra

GetDBCurrentLanguage

GetDBCurrentLanguage() as IComosDLanguage

The language set as the current language in the database.

In Section Instructions Examples Basics History Extra

GetDocumentDirectory

GetDocumentDirectory() as String

Returns the complete path for the documents directory of the project.

In Section Instructions Examples Basics History Extra

GetFunctionRights

GetFunctionRights(user as Object) as Long

Returns the user and project-related interface function rights; i.e. rights that
use specific functions of the software interface.

Note Up until now, these have only been created in the base object tree for the
purpose of editing specifications, but in theory they could be used for any
functions.

In Section Instructions Examples Basics History Extra

GetHierarchyObjectByName

GetHierarchyObjectByName(Val1 as Object, Val2 as String) as Object

Searches for the object specified by parameter 2 (SystemFullName) in the

hierarchical substructure of the project, starting the search in the Collection
specified by parameter 1 directly underneath the project. This was originally used
for CDevices, Documents Locations and Units, but in future it will only be used for
CDevices, since Locations and Units are converted to Devices of the classes
Location and Unit respectively and documents are stored in their own structures.
First searches in the base project and then in the specified one.

In Section Instructions Examples Basics History Extra

GetImportUID

GetImportUID(Val as String) as String

A method that is no longer used for displaying UIDs for imports. In future there
will be no more support for this method!

In Section Instructions Examples Basics History Extra

GetInternationalDescription2

GetInternationalDescription2(Val as Long) as String

Fetches the localized (foreign-language) text for Description2. The number in the
index of the project languages is used as the parameter.
In Section Instructions Examples Basics History Extra

GetInternationalDescription3

GetInternationalDescription3(Val as Long) as String

Fetches the localized (foreign-language) text for Description3. The number in the
index of the project languages is used as the parameter.

In Section Instructions Examples Basics History Extra

GetNumberRangeGeneratorAssignment

IComosDNumberRangeGeneratorAssignment GetNumberRangeGeneratorAssignment(long index)

Returns the assignment object specified by "index" (type

IComosDNumberRangeGeneratorAssignment). The index base is 0 and the highest valid
value is "GetNumberRangeGeneratorAssignmentCount() -1".

In Section Instructions Examples Basics History Extra

GetNumberRangeGeneratorAssignmentCount

long GetNumberRangeGeneratorAssignmentCount()

Returns the number of IComosDNumberRangeGeneratorAssignment objects that assign a

NumberRangeGenerator to the current object.
In Section Instructions Examples Basics History Extra

GetParametersFromCDeviceSystem

GetParametersFromCDeviceSystem()

Checks parameters from the base project into the current project. The following
rule applies: If the parameter in the base project owns a value and if the
parameter in the current project was inherited, then the value is taken from the
base project.

In Section Instructions Examples Basics History Extra

GetShadowObject

GetShadowObject(LPDISPATCH WorkingLayer, LPDISPATCH Object, [out,retval]LPDISPATCH

*retVal)

Belongs to the function "Working layers: Object comparison". ShadowObjects are

required if you want to compare two objects from different working layers. You
usually have to log into a working layer to load an object. The alternative is to
copy in the object. Neither of these can be used for a non-interventive comparison.
COMOS therefore keeps a "free floating" object without an owner that can be
compared with another object from the working layer at the time.

In Section Instructions Examples Basics History Extra

GetWorkingOverlay

GetWorkingOverlay(OverlayID as Long) as IComosDWorkingOverlay

Returns a working layer, using the working layer ID.

In Section Instructions Examples Basics History Extra

GlobalTestForCurrentOverlay

long GlobalTestForCurrentOverlay()

Performs the global test for the current project (this), but only objects which are
checked into the current layer are considered. Otherwise, the same checks are run
here as in the case of normal global checks.

Return value: Number of objects detected as erroneous.

In Section Instructions Examples Basics History Extra

ImportOverlay

ImportOverlay(overlay as Object, DatabaseFileName as String, ImportOverlayID as

Long, Name as String, Description as String) as Long

Imports the working layers that had been exported in an Access database created by
ExportOverlay with the associated document directory.

In Section Instructions Examples Basics History Extra

IsIDBProject

IsIDBProject ( ) as Boolean
True: The current project is part of an iDB and supports iDB updates. Example: Base
project of an iDB.

False: In all other cases.

In Section Instructions Examples Basics History Extra

IsQueryStatusActive

IsQueryStatusActive(val as Long) as Boolean

Checks whether the status transferred as a parameter is a query status for Device
or the default status for Device.

Parameter val:

Index of the status that is checked.

Background:

As an addition to the current status technology, version 8.2 has introduced a

second technology – query technology. The two status technologies work with the
same methods, which then use IsQueryStatusActive() to check the type of status for
which they are called.

In Section Instructions Examples Basics History Extra

Languages

Languages() as IComosDOwnCollection

Hierarchically-subordinate Collection with the languages created in the project as

elements.
In Section Instructions Examples Basics History Extra

LoadObjectsInBoundingBox

LoadObjectsInBoundingBox(x1 as Long, y1 as Long, z1 as Long, x2 as Long, y2 as

Long, z2 as Long) as IComosDD3Collection

This function collects, in a D3Collection (Collection with 3-dimensional objects),

all COMOS objects from the database whose original coordinates satisfy the
condition of being within a virtual cube whose dimensions are defined by points 1
and 2.

This function forms a kind of interface between the 3D world of Viper and the COMOS
object world. This enables you to access COMOS objects directly via the object
coordinates without having to take the route via the object hierarchy in COMOS.

Note: Ensure that the x, y and z values of the two points differ when selecting the
points, otherwise it will not be possible to create a cube.

In Section Instructions Examples Basics History Extra

LocationPrefix

LocationPrefix() as String

Old notation for the allocation of names of locations.

In Section Instructions Examples Basics History Extra

Locations
Locations() as IComosDOwnCollection

Hierarchically-subordinate Collection with location objects.

Obsolete; only provided for compatibility reasons. No support in future versions.

Will cease to be available in future.

In Section Instructions Examples Basics History Extra

ObjectRevisions

ObjectRevisions() as IComosDOwnCollection

Not implemented yet!

In Section Instructions Examples Basics History Extra

OverlayAdministrationRights

OverlayAdministrationRights(overlay as Object, modenew as Boolean) as Boolean

Returns whether you have the rights to manage the specified layer (release, restore
in the layer, create new layers underneath it, etc.).

The mode modenew specifies whether the rights are for the level itself (modenew =
FALSE) or for creation on the next level (modenew = TRUE).

You can obtain modenew rights for the first level by specifying NULL as the first
parameter.

In practice, there is precisely one command which targets not the layer itself but
instead the next layer, and this is: the "New" command. The above-mentioned
function is thus used to work accordingly with the "New" command.

In Section Instructions Examples Basics History Extra

OwnDocumentTypes

OwnDocumentTypes() as IComosDOwnCollection

Hierarchically-subordinate Collection with document type objects.

In Section Instructions Examples Basics History Extra

OwnParameters

OwnParameters() as IComosDOwnCollection

Hierarchically-subordinate Collection with the project parameters.

In Section Instructions Examples Basics History Extra

OwnPhysUnitGroups

OwnPhysUnitGroups() as IComosDOwnCollection

Hierarchically-subordinate Collection with PhysUnitGroup objects.

In Section Instructions Examples Basics History Extra

OwnSpecifications
OwnSpecifications() as IComosDOwnCollection

No project attributes, only attributes from the attribute catalog "@40 @Y".

In Section Instructions Examples Basics History Extra

OwnStandardTables

OwnStandardTables() as IComosDOwnCollection

Hierarchically-subordinate Collection with standard table objects.

In Section Instructions Examples Basics History Extra

Parameters

Parameters() as IComosDCollection

Collection with project parameter objects as elements. The project parameters are
created and preset (among other things) in the COMOS system project and can be
modified on a project-specific basis using the "Options" and "More options" project
tabs.

In Section Instructions Examples Basics History Extra

Params
Params() as Object

Short form for parameters to allow you to access project parameters.

See also Chapter Specs.

In Section Instructions Examples Basics History Extra

PhysDir

PhysDir() as String

Directory name of the specified project. The full path is returned via
GetDocumentDirectory. See also Chapter GetDocumentDirectory.

In Section Instructions Examples Basics History Extra

PhysUnitGroups

PhysUnitGroups() as IComosDCollection

Collection with PhysUnitGroup objects from the specified project, the base project
and the system project as elements.

In Section Instructions Examples Basics History Extra

PickLists
PickLists() as IComosDOwnCollection

Hierarchically-subordinate Collection with Picklist objects.

In Section Instructions Examples Basics History Extra

PositionPrefix

PositionPrefix() as String

Old notation for the allocation of names of positions.

In Section Instructions Examples Basics History Extra

PrimaryLanguage

PrimaryLanguage() as Long

Primary language: Only changes in this language make the other language entries
invalid.

In Section Instructions Examples Basics History Extra

PreLoadSpecs

PreLoadSpecs(Name as String, owner as IComosDCollection) as Long

Load function for attributes. The attributes are addressed by their name, and a
check is performed to determine whether they belong to the set specified with
owner. This function is used for bulk access instances to attributes with the same
NestedName (e.g. in Queries).

In Section Instructions Examples Basics History Extra

ProjectSpecifications

ProjectSpecifications() as IComosDCollection

Returns attributes of the subordinate SpecificationSet objects with the name

System. The attributes that are visible for the project are managed at this point.

In Section Instructions Examples Basics History Extra

Put_ConnectedBaseWorkingOverlay

put_ConnectedBaseWorkingOverlay(/*[in]*/IComosDWorkingOverlay *newVal);

A new functionality for working layers. Connects an engineering project fixed with
a working layer of the base data project. (previously you could only see the
released area of a base data project). Therefore base data can also be evaluated
prior to the release. The same functionality applies to working layers of the
engineering project.

In Section Instructions Examples Basics History Extra

RecalculateWorkingLayerHierarchy
RecalculateWorkingLayerHierarchy ( ) as Boolean

Triggers a recalculation of the status of the objects in the working layer display.

In Section Instructions Examples Basics History Extra

RefreshLabelSigns

RefreshLabelSigns()

Updates the prefixes and delimiters temporarily stored in COMOS for naming, as
stipulated in the project parameters.

In Section Instructions Examples Basics History Extra

RefreshQueryStatus

RefreshQueryStatus(val as Long)

Refreshes the specified Query-Status.

If the specified status is not a Query-Status, then nothing happens.

In Section Instructions Examples Basics History Extra

ReleaseObjectsFromOtherProjects

ReleaseObjectsFromOtherProjects()
As with Workset.ReleaseObjects. All objects that are not referenced any longer are
removed from the cache. This method does not check the number of maximum loaded
objects (Workset.MaxLoadedObjects); instead, all objects that do not originate from
the specified project are removed.

In Section Instructions Examples Basics History Extra

RelevantLanguages

IComosDCollection RelevantLanguages()

Returns a collection of type IComosDColletion that contains all languages that are
relevant to the current project (i.e., all languages for which the
"IsProjectRelevant" flag is set to TRUE).

In Section Instructions Examples Basics History Extra

RemoveNumberRangeGeneratorAssignment

void RemoveNumberRangeGeneratorAssignment(long index)

Removes the assignment object specified by "index". The index base is 0.

In Section Instructions Examples Basics History Extra

Rights

Rights() as IComosDOwnCollection
Hierarchically-subordinate Collection with rights objects.

In Section Instructions Examples Basics History Extra

SaveErrorObjects

SaveErrorObjects()

Saves the ErrorObjects of the ErrorObjects list in the database.

In Section Instructions Examples Basics History Extra

SavePickList

SavePickList(Val as String)

Saves the picklist with the specified name.

In Section Instructions Examples Basics History Extra

SetCurrentCase

SetCurrentCase(Val as Object)

Sets the case specified by the parameter as the current one.

In Section Instructions Examples Basics History Extra

SetCurrentLanguageForSession

SetCurrentLanguageForSession(Val as Object)

Sets the language specified by the parameter as the current language for the
session in progress (but not in the database).

In Section Instructions Examples Basics History Extra

SetImportUID

SetImportUID(Val1 as String, Val2 as String, Val3 as String)

No longer state of the art! In future there will be no more support for this
method!

In Section Instructions Examples Basics History Extra

SetInternationalDescription2

SetInternationalDescription2(Val1 as Long, Val2 as String)

Sets the localized (foreign-language) text for Description2. The number in the
index of the project languages is used as parameter 1. Parameter 2 is the new text.

In Section Instructions Examples Basics History Extra

SetInternationalDescription3

SetInternationalDescription3(Val1 as Long, Val3 as String)

Sets the localized (foreign language) text for Description3. The number in the
index of the project languages is used as parameter 1. Parameter 2 is the new text.

In Section Instructions Examples Basics History Extra

SetProjectForMixedCollections

SetProjectForMixedCollections()

Correction function that corrects incorrect project associations for a number of

object classes (do not use any more).

In Section Instructions Examples Basics History Extra

Specifications

Specifications() as IComosDCollection

No project attributes, only attributes from the attribute catalog "@40 @Y".

In Section Instructions Examples Basics History Extra

SpecificationSets

SpecificationSets() as IComosDOwnCollection

Hierarchically-subordinate Collection with SpecificationSets objects.

In Section Instructions Examples Basics History Extra

StandardTables

StandardTables() as IComosDCollection

Collection with standard table objects from the specified project, the base project
and the system project.

In Section Instructions Examples Basics History Extra

SwitchCDeviceSystemProject

SwitchCDeviceSystemProject(Val as Object) as IComosDCollection

Switches the base project to the specified one. (Quicker than disconnecting from an
old base project and connecting to a new one.)

In Section Instructions Examples Basics History Extra

Type
Type() as String

Project type: Engineering project, system project, base project or template

project. Valid constants: WorkingProject, ComosSystemProject, CDeviceSystemProject,
UserSystemProject.

In Section Instructions Examples Basics History Extra

Units

Units() as IComosDOwnCollection

Hierarchically-subordinate Collection with unit (Unit) objects.

Obsolete; only provided for compatibility reasons. No support in future versions.

Will cease to be available in future.

In Section Instructions Examples Basics History Extra

UnitPrefix

UnitPrefix() as String

Old notation for the allocation of names of units.

In Section Instructions Examples Basics History Extra

UseLanguages
UseLanguages() as Boolean

Controls the use of languages in the specified project.

In Section Instructions Examples Basics History Extra

UserSystem

UserSystem() as IComosDProject

Template project.

In Section Instructions Examples Basics History Extra

WorkingOverlays

WorkingOverlays() as IComosDOwnCollection

The object's own set of WorkingOverlays.

In Section Instructions Examples Basics History Extra

IComosDRight

This chapter contains the following information:IComosDRight

FunctionRights

Layers

IsFunctionRight

ReadOnlyLayers

Reference

Rights

User

In Section Instructions Examples Basics History Extra

IComosDRight

COMOS rights object.

In Section Instructions Examples Basics History Extra

FunctionRights

FunctionRights() as Long

A 16-bit integer value that represents the permitted function rights.

In Section Instructions Examples Basics History Extra

Layers
string Layers

Property of type string, which is evaluated in connection with the LayersPerObject

function. If this function is enabled, users can dynamically own other working
areas.

In Section Instructions Examples Basics History Extra

IsFunctionRight

IsFunctionRight() as Boolean

Determines whether it involves a function right or an object right.

In Section Instructions Examples Basics History Extra

ReadOnlyLayers

string ReadOnlyLayers

Description: Property of type string, which is evaluated in a similar way to

Layers, except in this case it involves working areas to which the user only has
read access.

In Section Instructions Examples Basics History Extra

Reference
Reference() as Object

Object reference (object for which rights are allocated).

In Section Instructions Examples Basics History Extra

Rights

Rights() as Long

Rights for the access to objects. Valid parameters: See also Chapter Rights.

In Section Instructions Examples Basics History Extra

User

User() as Object

User reference (user for which rights are allocated).

In Section Instructions Examples Basics History Extra

IComosDSpecification

This chapter contains the following information:IComosDSpecification

AcceptStaticLinkValues
BackPointerSpecifications

CalcFrom

CalcTo

CalcToEx

CalculateStaticLinkXValue

CaseValueArray

CheckProductRequest

CheckValid

CheckXValid

ClearProperties

ClearXValues

ControlProperties

ControlType

CreateLinkInfo

CreateLinkInfoObject

CreateLocalStandardTable

CSpecification

D3Mode

DeleteLinkInfo

DeleteLinkInfoObject

DetachFromStaticLink

DetachXValueFromStaticLink

DeviceStatus

DeviceStatusValue

DisplayValue

Format

FormattingDigits

FreePropertyGroupName

FreePropertyName
FullFileName

GetFormattedValue

GetDisplayXValue

GetHelpText

GetInternationalDisplayValue

GetInternationalDisplayXValue

GetInternationalValue

GetInternationalXValue

GetLinkedSpecification

GetLinkInfoObject

GetOwnHelpText

GetOwnInternationalValue

GetOwnInternationalXValue

GetOwnLinkInfoObject

GetOwnScriptBlock

GetOwnXValue

GetPhysUnit

GetScriptBlock

GetSIXValue

GetSpecOwner

GetStaticLinkedSpecification

GetStaticXLinkedSpecification

GetValueBlocked

GetValueByCase

GetValueFromStandardValueDescription

GetValueRSByCase

GetXLinkedSpecification

GetXValue

GetXValueFromStandardValueDescription

GetXValueRS
GetXValueRSByCase

HelpTextCount

Inheritance

IsLinkObjectValid

IsLockable

IsMandatoryTab

IsRange

IsStaticLinkXValueAccepted

IsValueValid

IsValueValidEx

IsViewMandatoryTab

IsWorkflowReference

IsXValueDetachedFromStaticLink

Item

Layers

Length

LinkCache

LinkInfo

LinkObject

LinkObjectConnectString

LValue

LXValue

MakeVisible

MappingTable

MaxLinkedXValueCount

MaxStaticLinkedXValueCount

NestedName

OldIsRange

OwnControlProperties
OwnControlType

OwnCSpecification

OwnD3Mode

OwnDescription

OwnDeviceStatus

OwnDeviceStatusValue

OwnFormat

OwnFreePropertyGroupName

OwnFreePropertyName

OwnHelpTextCount

OwnInheritance

OwnIsLockable

OwnLayers

OwnLength

OwnLinkInfo

OwnLinkObject

OwnPrecision

OwnProductRequest

OwnRangeCheckMode

OwnRangeType

OwnScript

OwnSection

OwnSpecifications

OwnStandardTable

OwnTabIndex

OwnType

OwnUnit

OwnValue

PhysUnitLabel

Precision
ProductRequest

ProductUnit

ProductValue

RangeCheckMode

RangeType

RealStandardTable

RefreshUnit

Script

Section

SetAcceptStaticLinkXValue

SetHelpText

SetInternationalValue

SetInternationalXValue

SetMandatoryTab

SetOwnInternationalValue

SetOwnInternationalXValue

SetOwnScriptBlock

SetScriptBlock

SetSIXValue

SetUnitWithoutValueConversion

SetViewMandatoryTab

SetWorkflowReference

SetXValue

SIValue

Specifications

StandardTable

StandardTableConnectString

StandardValue

StandardValueDescription
StandardXValueDescription

StaticLinkDisplayValue

StaticLinkDisplayXValue

StaticLinkValue

StaticLinkXValue

TabIndex

Type

Unit

UseCases

UseCasesInherited

Value

ValueBlocked

View

ViewInherited

XValueArray

XValueByCase

In Section Instructions Examples Basics History Extra

IComosDSpecification

COMOS attributes object.

In Section Instructions Examples Basics History Extra

AcceptStaticLinkValues
AcceptStaticLinkValues() as Boolean

When this function is run the differences in the changing values of a static link
are accepted on a one-time basis. In this case the background color switching is
reset, the status evaluation is not affected, and no values are taken over. Each
time the static link values are changed again, this leads to normal behavior (such
as color switching, status changes, etc.).

In Section Instructions Examples Basics History Extra

BackPointerSpecifications

BackPointerSpecifications() as IComosDCollection

Returns the set of Specification objects that have a CSpecification pointer to the
current object; database-supported BackPointerDocuments.

In Section Instructions Examples Basics History Extra

CalcFrom

CalcFrom(Other_unit as String, Value as String) as Double

Converts the value transferred in Value from the unit transferred in parameter
other_unit to the unit currently set for the attribute.

Value: the value to be processed.

(Must not include any group delimiters.)

Other_unit: specifies the unit of the value transferred in the Value parameter.

The parameter transfers the name of the unit as defined in the physical unit group
to which the unit belongs. E.g. "M01.05" for the unit "meters" from the physical
unit group "M01" (length).

Return value:

The Value converted from the unit Other_unit to the current unit of the attribute
as Double.

Example:

The specification is currently set to kilometers (Name: "M01.30", unit "km",

Description "Kilometer").

Spec.CalcFrom ("M01.05", "1000") = 1

(1000 Meter= 1 km)

Special case:

No unit is specified by other_unit.

The current unit of the specification is used. No conversion takes place in this
case. However, since the return value of the function is of type Double, the
conversion function may still be useful. Therefore, you can use the function to
convert a string variable into a numerical value, which can then be used to carry
out arithmetic operations.

Calls CalcFrom from IComosDPhysUnit.

In Section Instructions Examples Basics History Extra

CalcTo

CalcTo(Other_unit as String, Value as String) as Double

Functions similar to CalcFrom. Converts the value transferred in the Value

parameter from the unit currently set for the specification to the unit transferred
in other_unit.

Value: the value to be processed

Must not be specified with group delimiters. Owns the unit currently set in the
specification.
Other_unit: The unit to which the Value is to be converted.

The parameter transfers the name of the unit as defined in the physical unit group
to which the unit belongs. E.g. "M01.05" for the unit "meters" from the physical
unit group "M01" (length).

Return value:

The Value converted from the unit currently set in the specification to the unit
transferred in Other_unit, as Double.

Example (see also the example in CalcFrom):

other_unit : M01.05 (= meters)

Value : 1000

currently set unit at the specification: "km" (M01.30),

Spec.CalcTo("M01.05", "1000") = 1000000

(1,000 km = 1,000,000 meters)

Special case:

No unit is specified by other_unit.

The current unit of the specification is used. No conversion takes place in this
case. However, since the return value of the function is of type Double, the
conversion function may still be useful. Therefore, you can use the function to
convert a string variable into a numerical value, which can then be used to carry
out arithmetic operations.

In Section Instructions Examples Basics History Extra

CalcToEx
CalcToEx(Other_unit As String, Value As String, Precision As Long) as String

Similar function to CalcTo, but in this case the evaluation is restricted to the
number of decimal places specified by parameter Precision.

Note Unlike CalcTo, the value is returned as a String!

The parameter Value must not be specified with any group delimiters.

In Section Instructions Examples Basics History Extra

CalculateStaticLinkXValue

CalculateStaticLinkXValue(Val as Long)

Accepts the value of the statically-linked attribute for the XValue stipulated by
the specified index. Same as CalculateLinkedSpecifications.

In Section Instructions Examples Basics History Extra

CaseValueArray

CaseValueArray() as String

Returns all cases of an attribute in one String. Calling CaseValueArray() is faster

than calling all cases separately via GetValueByCase(). However, you are
responsible for splitting the String yourself.

All existing cases are always returned. If an attribute does not own a case, then
an empty string is returned.

The returned String owns the following format:

<useCaseId_1>$<useCaseValue>|...|<useCaseId_n>$<useCaseValue>
The indices of the single cases can occur in any sequence.

Example

For three cases (name "Min", Id 1; name "Std", Id 2; name "Max", Id 3) the string
would have the following appearance, for example:

"2$7,5|1$5|3$10,9"

In Section Instructions Examples Basics History Extra

CheckProductRequest

CheckProductRequest(Val As Object) as Boolean

Used for product request combination attributes. Checks whether the request matches
the product specification in terms of the set operator. Is also evaluated by
Spec.CheckValid.

In Section Instructions Examples Basics History Extra

CheckValid

CheckValid() as Boolean

Checks Range attributes to determine whether the conditions min <= value and max >=
value have been violated and evaluates all the static links required for comparison
purposes.

In Section Instructions Examples Basics History Extra

CheckXValid
CheckXValid(Val as Long) as Boolean

Checks the validity of the XValue and StaticLinkXValue specified by the parameters
according to the rules for static links. Similar function to CheckValid, but for
XValues.

In Section Instructions Examples Basics History Extra

ClearProperties

ClearProperties()

Resets all Properties that can be inherited. This is required, for example, if you
use a catalog attribute and wish to ensure that all possible information is
retrieved from this catalog attribute.

In Section Instructions Examples Basics History Extra

ClearXValues

ClearXValues([in, optional] VARIANT startIndex, [in, optional] VARIANT endIndex)

This method can be used to delete an entire area of XValues for an attribute.

Parameter startIndex:

Type Integer; specifies the starting point (index) from which XValues should be
deleted (this includes the starting point).

Parameter endIndex:

Type Integer; specifies the index up to which XValues should be deleted (this
includes the index specified).

Examples:

Example

ClearXValues 10.20

Deletes everything from XValue(10) up to and including XValue(20)

ClearXValues 80

Deletes all XValues from XValue(80) up to the end

ClearXValues ,50

Deletes from XValue(0) up to and including XValue(50)

ClearXValues

Deletes all XValues

In Section Instructions Examples Basics History Extra

ControlProperties

ControlProperties() as String

A String that contains all layout properties of an attribute as well as the display
sizes and coordinate information.
In Section Instructions Examples Basics History Extra

ControlType

ControlType() as String

Type of control used to link specifications on the software interface. ProgID of

the control. For example: ComosSUIList.SUIList for list specification Control.

In Section Instructions Examples Basics History Extra

CreateLinkInfo

CreateLinkInfo()

Creates a link object.

In Section Instructions Examples Basics History Extra

CreateLinkInfoObject

CreateLinkInfoObject(Val as Long)

Creates a link object for the parameterized XValue.

In Section Instructions Examples Basics History Extra

CreateLocalStandardTable

CreateLocalStandardTable() as Boolean

Creates a local standard table and sets it at the attribute. The standard table can
only be used for this attribute. It is created in the StandardTables tree under
@Local. The return value is a boolean value that specifies whether the creation
process was successful.

In Section Instructions Examples Basics History Extra

CSpecification

CSpecification() as IComosDSpecification

Short form for catalog Specification; an attribute from the base project, generally
from the "@40 @Y" branch. All properties that are not defined at the relevant
attribute are taken from this attribute.

In Section Instructions Examples Basics History Extra

D3Mode

D3Mode() as Long

A property that determines whether the attribute is 3D-relevant. Valid values: See
also Chapter SpecD3Mode.

In Section Instructions Examples Basics History Extra

DeleteLinkInfo

DeleteLinkInfo()

Deletes the link object.

In Section Instructions Examples Basics History Extra

DeleteLinkInfoObject

DeleteLinkInfoObject(Val as Long)

Deletes the link object for the parameterized XValue.

In Section Instructions Examples Basics History Extra

DetachFromStaticLink

DetachFromStaticLink() as Boolean

The static link is no longer evaluated, there is no background switching or status

effect and no values are taken over when they are changed.

In Section Instructions Examples Basics History Extra

DetachXValueFromStaticLink
DetachXValueFromStaticLink([in] VARIANT_BOOL detach, [in] long xValueIndex)

In the case of a static link, you can use this method to detach a particular XValue
from the source entirely. This means that a switch to orange highlighting can never
be activated for this XValue, since differing values are always accepted (until
detaching is deactivated).

The detach parameter is used to control whether the XValue should be attached or
detached. The xValueIndex parameter is used to specify the XValue parameter to be
used.

In Section Instructions Examples Basics History Extra

DeviceStatus

DeviceStatus() as Long

Shows the DeviceStatus for which this attribute is responsible (currently 1-6 are
possible).

In Section Instructions Examples Basics History Extra

DeviceStatusValue

DeviceStatusValue() as Long

Specifies the Value to which the status of the Device is to be set, if CheckValid
has not been completed (value 0 - 3).

In Section Instructions Examples Basics History Extra

DisplayValue

DisplayValue() as String

Value to be displayed with regard to:

Links (value taken from other specifications)

Standard tables (value taken over, selection options)

In Section Instructions Examples Basics History Extra

Format

Format() as String

Responsible for formatting the attribute value.

In the special case "Sort text" in the properties of a tab, the sort text
corresponds to the Format.

In Section Instructions Examples Basics History Extra

FormattingDigits

FormattingDigits([in/ out, retval] long* formattingDigits)

See OwnFormattingDigits; the inheritance is also evaluated here.

In Section Instructions Examples Basics History Extra

FreePropertyGroupName

string FreePropertyGroupName

Property of type String. Saves the name of the FreeProperty group, also called
"Extended Properties" in the interface, to which the value of this specification is
to be written.

If the edit mode of the current specification is not set to FreeProperty, this
Property is completely ignored.

Inheritance is used with this Property if the current specification does not have
its own value.

In Section Instructions Examples Basics History Extra

FreePropertyName

string FreePropertyName

Property of type String. Saves the name of the FreeProperty to which the value of
this specification is to be written.

If the edit mode of the current specification is not set to FreeProperty, this
Property is completely ignored.

Inheritance is used with this Property if the current specification does not have
its own value.

In Section Instructions Examples Basics History Extra

FullFileName
FullFileName() as String

Returns the complete, absolute FileName of the current document; in doing so

evaluates it internally to determine whether the FileName is relative or absolute,
and extends it as necessary to include DocumentDirectory.

In Section Instructions Examples Basics History Extra

GetFormattedValue

GetFormattedValue([in, optional] VARIANT value, [in, optional] VARIANT

decimalPlaces, [in, optional] VARIANT formattingDigits, [in, optional] VARIANT
zeroizeDecimalPlaces, [in, optional] VARIANT suppressScientificNotation, [in,
optional] VARIANT unitName, [in, optional] VARIANT DecimalDelimiter, [in, optional]
VARIANT GroupDelimiter, [out, retval] BSTR* formattedValue)

A common kept method to format numeric values. Different settings can be applied to
influence the output.

Parameter value: Type String;

numerical value to be formatted as a String.

Optional parameter; if it is left out, then the Value of the current attribute is
used.

Parameter decimalPlaces: Type Integer;

Number of decimal places to be used.

Optional parameter; if it is left out, the number of decimal places in the original
number is not changed.

Parameter formattingDigits: Type Integer;

Number of "formatting digits" to be used.

Optional parameter; if it is left out, the original number is not reformatted in

terms of the formatting digits.
Parameter zeroizeDecumalPlaces: Type Boolean;

States if not existing decimal points should be replaced with zeros. Example:
Number "11.2" should be formatted with two decimal places. If zeroizeDecimalPlaces
is set to TRUE the result is "11.20", otherwise it is "11.2".

Optional parameter; if it is left out no zeros will be added.

Parameter suppressScientificNotation: Type Integer;

States if and when the exponential notation is allowed. If this parameter is set to
ScientificNotation_SuppressAlways (constant), the numbers in the exponential
notation are formatted into the normal display, no matter how large they are. If
the parameter is set to ScientificNotation_SuppressNotZero (constant), a number is
only transferred to the normal display if it is not rounded to zero by means of the
remaining formatting specifications (example: "0.001" is supposed to be formatted
with 2 decimal places). The result after rounding would be "0.00". In this case a
switch to exponential display would occur and the result would be "1E-3". If the
parameter is set to ScientificNotation_SuppressNever (constant), the display
remains unchanged.

Optional parameter; if it is left out, ScientificNotation_SuppressNever is used.

Parameter unitName: Type string:

Name of a unit to be used. The unit is only used to collect the amount of decimal
places. Therefore, if a valid unit is specified, the parameter decimalPlaces has no
effect since it is overwritten by the settings for the unit.

Optional parameter; if it is left out the name is put to an empty string and
therefore no unit is used.

Parameter decimalDelimiter: Type string;

Delimiter for decimal places; states which character should be used as a decimal
divider.

Optional parameter; if it is left out, the delimiter to be used is determined on

the basis of the string to be formatted. If no decimal is contained, the divider is
selected according to the current language that was selected.

Parameter groupDelimiter: Type String;

Dividing character for blocks of thousands; states which character is supposed to

be used for a character to divide thousands.

Optional parameter; if it is left out the number is formatted without a divider for
thousands.
In Section Instructions Examples Basics History Extra

GetDisplayXValue

GetDisplayXValue(Val as Long) as String

Value to be displayed from a lists specification field specified by the parameter.

In Section Instructions Examples Basics History Extra

GetHelpText

GetHelpText(Val1 as Long, Val2 as Long) as String

Returns the help text specified with Parameter1 in the language specified with
Parameter2.

In Section Instructions Examples Basics History Extra

GetInternationalDisplayValue

string GetInternationalDisplayValue(long languageIndex)

Method which works in a similar way to DisplayValue, but can return the result in a
certain language (if a corresponding value exists for the specified language).

Return value: The DisplayValue of the current attribute (this), in the language
specified by the parameter languageIndex or an empty string if no value exists for
the specified language.
Parameter languageIndex: Defines the language in which the DisplayValue is to be
returned. 1 corresponds to the first language defined in the project, 2 the second,
etc.

In Section Instructions Examples Basics History Extra

GetInternationalDisplayXValue

string GetInternationalDisplayXValue(long XValueIndex, long languageIndex)

Method which works in a similar way to GetDisplayXValue, but can return the result
in a certain language (if a corresponding value exists for the specified language).

Return value: The DisplayXValue of the current attribute (this), in the language
specified by the parameter languageIndex or an empty string if no value exists for
the specified language.

Parameter XValueIndex: Specifies the XValue from which the DisplayValue is to be

returned.

Parameter languageIndex: Defines the language in which the DisplayXValue is to be

returned. 1 corresponds to the first language defined in the project, 2 the second,
etc.

In Section Instructions Examples Basics History Extra

GetInternationalValue

GetInternationalValue(Val as Long) as String

Returns the value of the relevant attribute in the language specified by the
parameter; only attribute values of type "Text" are translated. See also Chapter
SpecificationType.
In Section Instructions Examples Basics History Extra

GetInternationalXValue

GetInternationalXValue(xvalueindex as Long, LanguageIndex as Long) as String

Returns the entry specified by XValueIndex in the language specified by the

LanguageIndex parameter; only attribute values of type "Text" are translated. See
also Chapter SpecificationType.

In Section Instructions Examples Basics History Extra

GetLinkedSpecification

GetLinkedSpecification() as IComosDSpecification

Returns the linked attribute.

In Section Instructions Examples Basics History Extra

GetLinkInfoObject

GetLinkInfoObject(Val as Long) as IComosDLinkInfo

Returns the link object for the XValue specified by the parameter.
In Section Instructions Examples Basics History Extra

GetOwnHelpText

GetHelpText(Val1 as Long, Val2 as Long) as String

Returns the object’s own HelpText. See also Chapter GetHelpText.

In Section Instructions Examples Basics History Extra

GetOwnInternationalValue

GetOwnInternationalValue(Val as Long) as String

Returns the object's own value of the relevant attribute in the language specified
by the parameter; only attribute values of type Text are translated. See also
Chapter SpecificationType.

In Section Instructions Examples Basics History Extra

GetOwnInternationalXValue

GetOwnInternationalXValue(xvalueindex as Long, LanguageIndex as Long) as String

Returns the entry specified by XValueIndex in the language specified by the

LanguageIndex parameter; only attribute values of type Text are translated. See
also Chapter SpecificationType.
In Section Instructions Examples Basics History Extra

GetOwnLinkInfoObject

GetOwnLinkInfoObject(Val as Long) as IComosDLinkInfo

Returns the object's own link object for the XValue specified by the parameter.

In Section Instructions Examples Basics History Extra

GetOwnScriptBlock

GetOwnScriptBlock(Val as Long) as String

Returns the object’s own script block specified with the parameter. See also
Chapter GetScriptBlock.

In Section Instructions Examples Basics History Extra

GetOwnXValue

GetOwnXValue(Val As Long) as String

Returns the object's own XValue with the identified parameter in string form.

In Section Instructions Examples Basics History Extra

GetPhysUnit

GetPhysUnit(Val as String) as IComosDPhysUnit

Returns the PhysUnit specified by the parameter; the PhysUnit of the current object
is returned if no parameter has been set.

In Section Instructions Examples Basics History Extra

GetScriptBlock

GetScriptBlock(Val as Long) as String

Returns the ScriptBlock specified by the parameter (together, all ScriptBlocks

produce the script Property; a script function should be managed per ScriptBlock).

In Section Instructions Examples Basics History Extra

GetSIXValue

GetSIXValue(Index As Long) as Double

See SIValue. In this case, for XValues. The index to be specified is the index of
the XValues.

In Section Instructions Examples Basics History Extra

GetSpecOwner
GetSpecOwner() as Object

Returns the first owner of an attribute, which is neither of type Specification nor
of type SpecificationSet.

In Section Instructions Examples Basics History Extra

GetStaticLinkedSpecification

GetStaticLinkedSpecification() as IComosDSpecification

Returns the linked static attribute.

In Section Instructions Examples Basics History Extra

GetStaticXLinkedSpecification

GetStaticXLinkedSpecification(ByVal Index as Long) as IComosDSpecification

Returns the source attribute of the static link for the specified Index.

In Section Instructions Examples Basics History Extra

GetValueBlocked
GetValueBlocked(Val as Long) as Boolean

Shows whether editing the XValue identified by the parameter is permitted. Possible
reasons for preventing editing:

Layer

Inheritance-Mode

Rights

Link

other project

In Section Instructions Examples Basics History Extra

GetValueByCase

GetValueByCase(Val as Object) as String

Returns the value for the case specified with the parameter.

In Section Instructions Examples Basics History Extra

GetValueFromStandardValueDescription

GetValueFromStandardValueDescription(Description As String) as String

For attributes with standard tables. Performs the conversion back from a
description of a StandardValue to the Value which has to be written to the
attribute.

In Section Instructions Examples Basics History Extra

GetValueRSByCase

GetValueRSByCase(other_case as Object) as IComosDTimestamp

Returns the timestamp of the value for the case parameterized with other_case.

In Section Instructions Examples Basics History Extra

GetXLinkedSpecification

GetXLinkedSpecification(ByVal Index as Long) as IComosDSpecification

Returns the source attribute of the link for the specified Index.

In Section Instructions Examples Basics History Extra

GetXValue

GetXValue(Val as Long) as String

Returns the XValue identified by the parameter.

In Section Instructions Examples Basics History Extra

GetXValueFromStandardValueDescription

GetXValueFromStandardValueDescription(description as String, index as Long) as

String

Does not return the Value of the StandardValue object found using the Description,
but instead the XValue specified by means of the Index.

See also Chapter GetValueFromStandardValueDescription.

In Section Instructions Examples Basics History Extra

GetXValueRS

GetXValueRS(index as Long) as IComosDTimestamp

Returns the timestamp of the XValue specified by index.

In Section Instructions Examples Basics History Extra

GetXValueRSByCase

GetXValueRSByCase(other_case as Object, index as Long) as IComosDTimestamp

Returns the timestamp of the XValue identified by index for the case specified by
other_case.
In Section Instructions Examples Basics History Extra

HelpTextCount

HelpTextCount() as Long

Number of help texts.

In Section Instructions Examples Basics History Extra

Inheritance

Inheritance() as Long

Mode for editing behavior. Valid parameters: See also Chapter SpecInheritance.

In Section Instructions Examples Basics History Extra

IsLinkObjectValid

IsLinkObjectValid(Val as Object) as Boolean

Returns information on whether the specified object is valid as a LinkObject for

this attribute and whether you are permitted to set it in the attribute.

Possible reasons for invalidity:

Object deleted, no current project set, Specification not from the current project,
no editing rights, script function IsLinkObjectValid, object from the wrong
project.
In Section Instructions Examples Basics History Extra

IsLockable

IsLockable() as Long

Property of the type long which determines whether or not the current specification
can be locked on the engineering side.

A specification is usually locked on the engineering side when the SpecOwner is

locked. This property prevents locking, even if the SpecOwner is locked.

The following values are accepted:

0 Specification is not lockable and remains editable

1 Specification is lockable

In Section Instructions Examples Basics History Extra

IsMandatoryTab

IsMandatoryTab ( ) as Long

Evaluates the Flag to see if a tab is mandatory during check in.

This functionality is part of PQM. A tab can be displayed when checking in

documents in PQM; the user is required to fill in this tab. Up until and including
COMOS 10.0, this mandatory tab was identified by the word "Mandatory" being part of
the name. The method SetMandatoryTab is used as of COMOS 10.1 in connection with
the database type iDB.

The mandatory tab also has a second tab called ViewMandatoryTab. This second tab is
read-only and is set with the function SetViewMandatoryTab and queried with
IsViewMandatoryTab.
In Section Instructions Examples Basics History Extra

IsRange

IsRange() as Long

Evaluates the RangeType. See also Chapter Range_.

In Section Instructions Examples Basics History Extra

IsStaticLinkXValueAccepted

IsStaticLinkXValueAccepted([in] long xValueIndex, [out, retval] VARIANT_BOOL*

result)

Returns TRUE or FALSE, depending on whether the current value of the XValues
specified by the parameter xValueIndex was accepted. In the case of static links, a
value that differs from the link source can be accepted via the interface, i.e.
switching to orange highlighting is no longer activated. Therefore, you can use
this method to check the XValue for which this was applied. However, the concrete
value of the XValue at the time it was accepted is stored, meaning that a newly-
entered value is not automatically accepted.

The method always returns FALSE if there is no link or a non-static link.

In Section Instructions Examples Basics History Extra

IsValueValid

IsValueValid(Val as String) as Boolean

Checks whether the specified value is valid for this attribute. Performs a test for
numeric type attributes to determine whether the value is numerical, and checks it
against the IsValueValid script function (if available).

In Section Instructions Examples Basics History Extra

IsValueValidEx

IsValueValidEx(Val as String, Mode as Long) as Boolean

Checks whether the specified value is valid for this attribute. Performs a test for
numeric type attributes to determine whether the value is numerical. The mode
parameter can be used to determine whether the script function IsValueValid (which
may be present) is to be evaluated:

IsValueValidExNormal

IsValueValidExNoScript

In Section Instructions Examples Basics History Extra

IsViewMandatoryTab

IsViewMandatoryTab ( ) as Long

Reads the Flag that is used to declare a tab as read-only copy of a mandatory tab.

This functionality is part of PQM. The SetMandatoryTab method is used in COMOS 10.1
in connection with the database type iDB to declare a tab as a mandatory tab.

The mandatory tab has a copy called ViewMandatoryTab. This copy is read-only and is
set with the function SetViewMandatoryTab and queried with IsViewMandatoryTab.
In Section Instructions Examples Basics History Extra

IsWorkflowReference

IsWorkflowReference ( ) as Long

0: Attribute is not part of a workflow

1: Attribute is part of a workflow

2: The inherited status is valid. The status of the owner determines whether or not
the attribute is part of a workflow.

Reads the Flag whether or not an attribute is part of Workflows. Attributes with
this labeling are monitored by COMOS.

Up until COMOS 10.0, Workflow-relevant attributes were identified by the name

prefix "WFREFOBS_". As of COMOS 10.1, the attributes are labeled with
IsWorkflowReference.

In Section Instructions Examples Basics History Extra

IsXValueDetachedFromStaticLink

IsXValueDetachedFromStaticLink([in] long xValueIndex, [out, retval] VARIANT_BOOL*

result)

In the case of a static link for an XValue, it is possible to not only accept one
particular differing value, but also always accept generally differing values. You
can use this method to check whether this is the case. It returns TRUE if the
XValue specified by the parameter xValueIndex is completely detached; otherwise, it
returns FALSE.
In Section Instructions Examples Basics History Extra

Item

Item(Val as Long) as Object

Returns the XValue specified by the parameter as XValueArrayEntry.

In Section Instructions Examples Basics History Extra

Layers

Layers() as String

Permissible working areas

See also

CDevice (Layers)

Device (Layers)

Document (Layers)

User (Layers)

In Section Instructions Examples Basics History Extra

Length

Length() as Long

Length (text specifications)

In Section Instructions Examples Basics History Extra

LinkCache

LinkCache() as Object

Method for turning the Viewpointer caching on and off (only used to improve
performance in the case of View attributes).

In Section Instructions Examples Basics History Extra

LinkInfo

LinkInfo() as IComosDLinkInfo

Returns the link object for attributes.

In Section Instructions Examples Basics History Extra

LinkObject
LinkObject() as Object

Pointer for link attributes, under which attributes are searched for using the link
object if they are linked.

In Section Instructions Examples Basics History Extra

LinkObjectConnectString

LinkObjectConnectString() as String

Symbolic information for the LinkObject pointer (connect/disconnect projects).

In Section Instructions Examples Basics History Extra

LValue

LValue() as String

Linked Value. Intended for dynamically-linked attributes and normally returns the
same value as Value.

If the attribute is linked to another attribute, LValue returns the value (Value)
of the linked attribute, in contrast to Value. In the case of an existing link, the
linked value is returned if the Value of the attribute is empty or the option
"always choose linked value" is activated at the attribute. (In the latter case,
the attribute can have a Value and the linked value will be returned anyway.)

In the case of statically and fully-dynamically-linked attributes, LValue works in

the same way as Value.
In Section Instructions Examples Basics History Extra

LXValue

LXValue(Val as Long) as String

Linked XValue. Behaves like LValue, but for XValues.

In Section Instructions Examples Basics History Extra

MakeVisible

MakeVisible() as Boolean

Only relevant for attributes with the "not visible" edit mode. These are read-only.

If you have the corresponding rights, this method enables you to make an attribute
visible again (edit mode "normal").

In Section Instructions Examples Basics History Extra

MappingTable

MappingTable() as Object

Searches and, if necessary, creates a MappingTable object under the attribute

owner.

In Section Instructions Examples Basics History Extra

MaxLinkedXValueCount

MaxLinkedXValueCount() as Long

Maximum number of XValue-Array entries for the relevant attribute, and attributes
linked to it.

In Section Instructions Examples Basics History Extra

MaxStaticLinkedXValueCount

MaxStaticLinkedXValueCount() as Long

The maximum number of XValues for which static links return values.

In Section Instructions Examples Basics History Extra

NestedName

NestedName() as String

The function returns its own name and the names of all superordinate objects of its
own class in the object structure, iteratively ascending.

In Section Instructions Examples Basics History Extra

OldIsRange

OldIsRange() as Long

Old method, only provided for compatibility reasons, no function!

In Section Instructions Examples Basics History Extra

OwnControlProperties

OwnControlProperties() as String

The object's own layout information for display on the "Attributes" tab.

In Section Instructions Examples Basics History Extra

OwnControlType

OwnControlType() as String

Object's own type of control, which is used to link attributes on the software
interface. ProgID of the control. For example: ComosSUIList.SUIList for lists
attribute Control.

In Section Instructions Examples Basics History Extra

OwnCSpecification
OwnCSpecification() as IComosDSpecification

The object's own catalog attribute.

In Section Instructions Examples Basics History Extra

OwnD3Mode

OwnD3Mode() as Long

The object's own property that determines whether the attribute is 3D-relevant.
Valid values: See also Chapter SpecD3Mode.

In Section Instructions Examples Basics History Extra

OwnDescription

OwnDescription() as String

The object’s own description.

In Section Instructions Examples Basics History Extra

OwnDeviceStatus

OwnDeviceStatus() as Long
Object's own DeviceStatus. See also Chapter DeviceStatus.

In Section Instructions Examples Basics History Extra

OwnDeviceStatusValue

OwnDeviceStatusValue() as Long

Object's own DeviceStatusValue. See also Chapter DeviceStatusValue.

In Section Instructions Examples Basics History Extra

OwnFormat

OwnFormat() as String

The object’s own formatting.

In Section Instructions Examples Basics History Extra

OwnFreePropertyGroupName

string OwnFreePropertyGroupName

Property of type String. Same as FreePropertyGroupName in terms of content, but

inheritance is not used with this Property; rather, the current specification's own
value is always read.
In Section Instructions Examples Basics History Extra

OwnFreePropertyName

string OwnFreePropertyName

Property of type String. Same as FreePropertyName in terms of content, but

inheritance is not used with this Property; rather, the current specification's own
value is always read.

In Section Instructions Examples Basics History Extra

OwnHelpTextCount

OwnHelpTextCount() as Long

Number of the object’s own help texts.

In Section Instructions Examples Basics History Extra

OwnInheritance

OwnInheritance() as Long

The object’s own mode for editing behavior. Valid parameters: See also Chapter
SpecInheritance.
In Section Instructions Examples Basics History Extra

OwnIsLockable

OwnIsLockable() as Long

Property of type long. Same as IsLockable but involves the own value at the current
specification. See also chapter IsLockable. In addition to the values described
there, the following value is accepted:

-1 undefined, use inheritance

In Section Instructions Examples Basics History Extra

OwnLayers

OwnLayers() as String

The object’s own working areas permit rights administration at the object level.

In Section Instructions Examples Basics History Extra

OwnLength

OwnLength() as Long

The object's own length (text specifications)

In Section Instructions Examples Basics History Extra

OwnLinkInfo

OwnLinkInfo() as IComosDLinkInfo

Returns the object's own link object for attributes.

In Section Instructions Examples Basics History Extra

OwnLinkObject

OwnLinkObject() as Object

Object's own pointers for link attributes, under which attributes are searched for
using the link object if they are linked.

In Section Instructions Examples Basics History Extra

OwnPrecision

OwnPrecision([in/out, retval] long* precision)

Property to define the number of decimal places to which numbered values should be
formatted for the purpose of outputting the attribute value. If a value is set
here, it has priority over over the setting made on a unit which may be assigned
(and also over other potential inheritance sources, e.g. a related base attribute
or a catalog attribute. OwnFormattingDigits

Example/Syntax
OwnFormattingDigits([in/out, retval] long* formattingDigits)

Is part of the "Decimal places and formatting places" functionality.

In Section Instructions Examples Basics History Extra

OwnProductRequest

OwnProductRequest() as Long

The object’s own setting for a product request combination. Here the operator that
is used for comparison of the request data with the product data is managed.

In Section Instructions Examples Basics History Extra

OwnRangeCheckMode

OwnRangeCheckMode([in/out, retval] long* rangeCheckMode)

Property for determining whether the values entered should be checked in the case
of Range attributes. If the Property is set to RangeCheckMode_NoChecking
(constant), then no check is performed. If RangeCheckMode_FullCheck (constant), a
check is performed on min and max attributes to determine that the min attributes
are lower than the max attributes. For Min/Value/Max attributes, another check is
performed to determine that the Value is within the specified limits.

In Section Instructions Examples Basics History Extra

OwnRangeType
OwnRangeType() as Long

Object's own RangeType. See also Chapter RangeType.

In Section Instructions Examples Basics History Extra

OwnScript

OwnScript() as String

The object's own script. Script functions can be called both by COMOS as well as
via the software interface.

In Section Instructions Examples Basics History Extra

OwnSection

OwnSection() as String

Object's own Layers.

In Section Instructions Examples Basics History Extra

OwnSpecifications

OwnSpecifications() as IComosDOwnCollection

Hierarchically-subordinate (structure-forming) Collection with the object’s own

attributes.

In Section Instructions Examples Basics History Extra

OwnStandardTable

OwnStandardTable() as IComosDStandardTable

The object’s own standard tables reference.

In Section Instructions Examples Basics History Extra

OwnTabIndex

OwnTabIndex() as Long

See also Chapter TabIndex. Here the OwnProperty.

In Section Instructions Examples Basics History Extra

OwnType

OwnType() as String

The object's own attribute type. Valid constants: See also Chapter
SpecificationType.
In Section Instructions Examples Basics History Extra

OwnUnit

OwnUnit() as String

The object’s own unit. Name of the PhysUnit or PhysUnitGroup; the default unit is
used in the case of PhysUnitGroup.

In Section Instructions Examples Basics History Extra

OwnValue

OwnValue() as String

The object's own value of the attribute. For UseCases = True, the value depends on
the case. Language-dependent for text specifications.

In Section Instructions Examples Basics History Extra

PhysUnitLabel

PhysUnitLabel() as String

Function corresponds to: GetPhysUnit(" ").Label

In Section Instructions Examples Basics History Extra

Precision

Precision([in/out, retval] long* precision)

See OwnPrecision; in this case, the inheritance is also evaluated if no own value
is defined in OwnPrecision.

In Section Instructions Examples Basics History Extra

ProductRequest

ProductRequest() as Long

The object’s own setting for a product request combination. Here the operator that
is used for comparison of the request data with the product data is managed.

In Section Instructions Examples Basics History Extra

ProductUnit

ProductUnit() as String

For product request combination attributes. This gets the unit of the product
specification (i.e., the base specification).

In Section Instructions Examples Basics History Extra

ProductValue

ProductValue(Val As Long) as String

Used for attributes for which the "Product data, request" property is set on the
"Link" tab. Returns the Value of the product attribute (i.e. the base attribute).

If the owner of the attribute is a CDevice and real device, then the product data
is displayed and edited in the report at Value, XVal(0), XVal(1) instead of
XVal(2), XVal(3), XVal(4).

In other words, mapping is carried out between the saved Values in the base object
tree and on the engineering side.

Base data

Value: visible value

(0): Min

(1): Max

Engineering data

XValue(2) = Empty when Device is created, something is stored here following local
entry

XValue(3) = Min

XValue(4) = Max

Example ProductValue(i)

For Device XValue(2), returns the relevant information if something is here;

otherwise, returns the Value from the base object. In the case of the Device, the
Value is the request value.
In Section Instructions Examples Basics History Extra

RangeCheckMode

RangeCheckMode([in/out, retval] long* rangeCheckMode)

See also Chapter OwnRangeCheckMode. In this case, the inheritance is also

evaluated.

Controls whether the Value is compared with min/max. A comparison with min or max
is not possible.

In Section Instructions Examples Basics History Extra

RangeType

RangeType() as Long

Returns the type of Range attribute. See also Chapter Range_.

In Section Instructions Examples Basics History Extra

RealStandardTable

RealStandardTable() as IComosDStandardTable

Original OwnStandardTable pointer (i.e. not the one created by means of project-
specific overlay).
In Section Instructions Examples Basics History Extra

RefreshUnit

RefreshUnit()

Updates the physical unit if it is set to a PhysUnitGroup and the associated

default Unit thus changes.

In Section Instructions Examples Basics History Extra

Script

Script() as String

Script. Script functions can be called both by COMOS as well as via the software
interface.

In Section Instructions Examples Basics History Extra

Section

Section() as String

Function corresponds to: Layers

In Section Instructions Examples Basics History Extra

SetAcceptStaticLinkXValue

SetAcceptStaticLinkXValue([in] VARIANT_BOOL accept, [in] long xValueIndex)

In the case of a statically-linked specification, this method can be used to accept

or not accept the current value of a XValues as a deviation. The switches are
displayed in orange in the user interface if the value deviates. Switching to
orange highlighting is deactivated as soon as an XValue is accepted as a deviation.

You can use the parameter accept to control whether the value of the specified
XValues should be accepted or not accepted.

In Section Instructions Examples Basics History Extra

SetHelpText

SetHelpText(Val1 as Long, Val2 as String, Val3 as Long)

Sets the help text specified with Parameter1 to the new value (Parameter2) in the
language specified with Parameter3.

In Section Instructions Examples Basics History Extra

SetInternationalValue

SetInternationalValue(Val1 as Long, Val2 as String)

Sets the Value for the language specified with Parameter1 to the value specified
with Parameter2.
In Section Instructions Examples Basics History Extra

SetInternationalXValue

SetInternationalXValue(xvalueindex as Long, LanguageIndex as Long, Val2 as String)

Sets the entry specified by XValueIndex in the language selected with LanguageIndex
to the value specified by Val2.

In Section Instructions Examples Basics History Extra

SetMandatoryTab

SetMandatoryTab ( ByVal IsMandatoryTab as Long )

Parameter IsMandatoryTab as long

Sets a Flag which identifies a tab as mandatory component during check in.

This functionality is part of PQM. A tab can be displayed when checking in

documents in PQM; the user is required to fill in this tab. Up until and including
COMOS 10.0, this mandatory tab was identified by the word "Mandatory" being part of
the name. The method SetMandatoryTab is used as of COMOS 10.1 in connection with
the database type iDB.

The mandatory tab also has a second tab called ViewMandatoryTab. This second tab is
read-only and is set with the function SetViewMandatoryTab and queried with
IsViewMandatoryTab.

In Section Instructions Examples Basics History Extra

SetOwnInternationalValue

SetOwnInternationalValue(Val1 as Long, Val2 as String)

Sets the object's own Value in the language specified by Parameter1 to the value
specified by Parameter2.

In Section Instructions Examples Basics History Extra

SetOwnInternationalXValue

SetOwnInternationalXValue(xvalueindex as Long, LanguageIndex as Long, Val2 as

String)

Sets the object's own entry specified by XValueIndex in the language selected with
LanguageIndex to the value specified by Val2 .

In Section Instructions Examples Basics History Extra

SetOwnScriptBlock

SetOwnScriptBlock(Val1 as Long, Val2 as String)

Sets the object's own script block specified by Val1 to the value specified by
Val2. See also Chapter SetScriptBlock.

In Section Instructions Examples Basics History Extra

SetScriptBlock
SetScriptBlock(Val1 as Long, Val2 as String)

Sets the script block specified by Val1 to the value specified by Val2. See also
Chapter ScriptBlock.

In Section Instructions Examples Basics History Extra

SetSIXValue

SetSIXValue(Index As Long, NewVal As Double)

Assigns a new value to the XValue identified with Index. See also Chapter SIValue.

In Section Instructions Examples Basics History Extra

SetUnitWithoutValueConversion

SetUnitWithoutValueConversion(Val as String)

Sets the unit of the attribute. No unit conversion is conducted. Differs from the
process of setting the Property Unit (see Specification.Unit), during which
conversion is carried out.

The parameter is the name of the unit (PhysUnit).

In Section Instructions Examples Basics History Extra

SetViewMandatoryTab
SetViewMandatoryTab ( ByVal IsViewMandatoryTab as Long )

Parameter IsViewMandatoryTab

Sets the Flag that is used to declare a tab as read-only copy of a mandatory tab.

This functionality is part of PQM. The SetMandatoryTab method is used in COMOS 10.1
in connection with the database type iDB to declare a tab as a mandatory tab.

The mandatory tab has a copy called ViewMandatoryTab. This copy is read-only and is
set with the function SetViewMandatoryTab and queried with IsViewMandatoryTab.

In Section Instructions Examples Basics History Extra

SetWorkflowReference

SetWorkflowReference ( ByVal IsWorkflowReference as Long )

Parameter IsWorkflowReference as long

0: Attribute is not part of a workflow

1: Attribute is part of a workflow

2: The inherited status is valid. The status of the owner determines whether or not
the attribute is part of a workflow.

Sets the Flag which specifies that an attribute is part of Workflows. Attributes
with this labeling are monitored by COMOS.

Up until COMOS 10.0, Workflow-relevant attributes were identified by the name

prefix "WFREFOBS_". As of COMOS 10.1, the attributes are labeled with
IsWorkflowReference.

In Section Instructions Examples Basics History Extra

SetXValue

SetXValue(Val1 as Long, Val2 as String) as Boolean

Sets the XValue specified by Parameter1 to the value specified by Parameter2.

In Section Instructions Examples Basics History Extra

SIValue

SIValue() as Double

Returns the LValue of the attribute as Double and allows it to write a Double to
the Value of the attribute. This makes it very easy to take attribute values into
account.

This process does not pose any problems with group characters and delimiters or
language-specific conversion functions.

Example

Spec.SIValue = SpecA.SIValue * SpecB.SIValue

In Section Instructions Examples Basics History Extra

Specifications
Specifications() as IComosDCollection

Collection with own attribute objects and inherited attribute objects.

In Section Instructions Examples Basics History Extra

StandardTable

StandardTable() as IComosDStandardTable

Standard tables reference.

In Section Instructions Examples Basics History Extra

StandardTableConnectString

StandardTableConnectString() as String

Symbolic information in string form for the StandardTable pointer. (For

connecting/disconnecting projects.)

In Section Instructions Examples Basics History Extra

StandardValue

StandardValue() as IComosDStandardValue
Returns the StandardValue object which is found on the basis of the Value from the
standard table.

In Section Instructions Examples Basics History Extra

StandardValueDescription

StandardValueDescription() as String

Checks the value of the attribute against the values of the set standard table. If
the values match, the Description of the standard table is returned; in the case of
numeric specifications, the number of decimal places of the PhysUnit is evaluated.

In Section Instructions Examples Basics History Extra

StandardXValueDescription

StandardXValueDescription(index as Long) as String

Similar to StandardValueDescription, but for the XValue specified by the index.

In Section Instructions Examples Basics History Extra

StaticLinkDisplayValue

StaticLinkDisplayValue() as String

Returns the DisplayValue when evaluating the static link.

In Section Instructions Examples Basics History Extra

StaticLinkDisplayXValue

StaticLinkDisplayXValue(Val as Long) as String

Returns the parameterized DisplayXValue when evaluating the static link.

In Section Instructions Examples Basics History Extra

StaticLinkValue

StaticLinkValue() as String

Returns the Value of the statically-linked attribute.

In Section Instructions Examples Basics History Extra

StaticLinkXValue

StaticLinkXValue(Val as Long) as String

Returns the XValue of the statically-linked attribute.

In Section Instructions Examples Basics History Extra

TabIndex

TabIndex() as Long

Property for the tab index of the attribute within the COMOS properties.

In Section Instructions Examples Basics History Extra

Type

Type() as String

Attribute type. Valid constants: See also Chapter SpecificationType.

In Section Instructions Examples Basics History Extra

Unit

Unit() as String

Unit. Name of the PhysUnit or PhysUnitGroup; the default unit is used in the case
of PhysUnitGroup.

In Section Instructions Examples Basics History Extra

UseCases

UseCases() as Boolean

Displays whether cases are to be evaluated.

In Section Instructions Examples Basics History Extra

UseCasesInherited

UseCasesInherited() as Boolean

Shows whether UseCases at the current attribute is defined or inherited.

In Section Instructions Examples Basics History Extra

Value

Value() as String

Value of the attribute. For UseCases = True, the value depends on the case.
Language-dependent for text specifications.

In Section Instructions Examples Basics History Extra

ValueBlocked
ValueBlocked() as Boolean

Similar to GetValueBlocked, but for Value. Displays whether it is permitted to

overwrite the value.

In Section Instructions Examples Basics History Extra

View

View() as Boolean

View of a View attribute; this is connected to another attribute on the engineering

side by means of a fully-dynamic link.

In Section Instructions Examples Basics History Extra

ViewInherited

ViewInherited() as Boolean

Indicates whether the View-Property was inherited, or sets the Property to

inherited.

In Section Instructions Examples Basics History Extra

XValueArray
XValueArray() as String

The XValues collected in the form of a String.

In Section Instructions Examples Basics History Extra

XValueByCase

XValueByCase(Val1 as Object, Val2 as Long) as String

Returns the XValue specified by Parameter2 for the case specified by Parameter1.

In Section Instructions Examples Basics History Extra

IComosDSpecificationSet

This chapter contains the following information:IComosDSpecificationSet

CObject

CObjectConnectString

CSpecificationSet

CSpecificationSetConnectString

OwnSpecifications

Specifications

In Section Instructions Examples Basics History Extra

IComosDSpecificationSet
COMOS data record object.

In Section Instructions Examples Basics History Extra

CObject

CObject() as IComosDCDevice

Pointer to the associated CDevice which is used to conduct inheritance.

In Section Instructions Examples Basics History Extra

CObjectConnectString

CObjectConnectString() as String

Symbolic information for the CObject pointer (connect/disconnect project).

In Section Instructions Examples Basics History Extra

CSpecificationSet

CSpecificationSet([in/out, retval] LPDISPATCH *pVal)

The type of this Property has been switched from IComosDCSpecificationSet to
Dispatch, as the type IComosDCSpecificationSet has been discontinued and has no
longer been included as of COMOS 9.0.

In Section Instructions Examples Basics History Extra

CSpecificationSetConnectString

CSpecificationSetConnectString() as String

Symbolic information for the CSpecification pointer (connect/disconnect project).

In Section Instructions Examples Basics History Extra

OwnSpecifications

OwnSpecifications() as IComosDOwnCollection

Hierarchically-subordinate (structure-forming) Collection with the object’s own

specifications.

In Section Instructions Examples Basics History Extra

Specifications

Specifications() as IComosDCollection

Collection of own and inherited attributes.

In Section Instructions Examples Basics History Extra

IComosDStandardTable

This chapter contains the following information:IComosDStandardTable

AllBackPointerSpecifications

BackPointerSpecifications

DefaultValue

ItemByValue

ItemByXValue

StandardTables

StandardValues

Type

In Section Instructions Examples Basics History Extra

IComosDStandardTable

COMOS standard tables object

In Section Instructions Examples Basics History Extra

AllBackPointerSpecifications
AllBackPointerSpecifications() as IComosDCollection

Cross-project Collection of Specification objects that have a StandardTable pointer

set to the current object. This is database-based and hence very time-intensive in
evaluation.

In Section Instructions Examples Basics History Extra

BackPointerSpecifications

BackPointerSpecifications() as IComosDCollection

Returns the set of Specification objects that have a StandardTable pointer to the
current object; database-supported. See also Chapter BackPointerDocuments.

In Section Instructions Examples Basics History Extra

DefaultValue

DefaultValue() as IComosDStandardValue

Default value.

In Section Instructions Examples Basics History Extra

ItemByValue
ItemByValue ( ByVal searchVal as String ) as IComosDStandardValue

Parameter searchVal as string

String that the StandardValue must match

Terms: StandardTable = Auswahlliste; StandardValue = Auswahllistenwert

Searches all StandardValue of the current StandardTable. Return value is the first
StandardValue object with the specified string.

Returns NULL if no matching StandardValue was found.

In Section Instructions Examples Basics History Extra

ItemByXValue

ItemByXValue ( ByVal searchIndex as Long, ByVal searchVal as String ) as

IComosDStandardValue

Parameter searchIndex as long

Index of the XValue to be compared

Parameter searchVal as string

String that the XValue must match

Terms: StandardTable = Auswahlliste; StandardValue = Auswahllistenwert

Searches all StandardValue of the current StandardTable. Return value is the first
StandardValue object with the specified string.

Returns NULL if no matching StandardValue was found.

In Section Instructions Examples Basics History Extra

StandardTables

StandardTables() as IComosDOwnCollection

Hierarchically-subordinate Collection with standard table objects as elements.

In Section Instructions Examples Basics History Extra

StandardValues

StandardValues() as IComosDOwnCollection

Hierarchically-subordinate Collection with standard table entries.

In Section Instructions Examples Basics History Extra

Type

Type() as long

Displays whether a local standard table is involved. (see

Spec.CreateLocalStandardTable). These local standard tables may only be used with a
Specification. For the values, the constants StandardTable_Type_Local,
StandardTable_Type_Normal are valid.

In Section Instructions Examples Basics History Extra

IComosDStandardValue

This chapter contains the following information:IComosDStandardValue

DevSymbols

Filename

GetXValue

HelpTextCount

Script

SetHelpText

SetXValue

Value

XValueCount

In Section Instructions Examples Basics History Extra

IComosDStandardValue

COMOS standard table entry object.

In Section Instructions Examples Basics History Extra

DevSymbols
DevSymbols() as IComosDOwnCollection

Hierarchically-subordinate Collection with DevSymbol objects.

In Section Instructions Examples Basics History Extra

Filename

Filename() as String

File name for the allocation of symbols.

In Section Instructions Examples Basics History Extra

GetXValue

GetXValue(index as Long) as String

Returns the XValue identified by the Index.

In Section Instructions Examples Basics History Extra

HelpTextCount

HelpTextCount([out, retval] long* retVal)

In Section Instructions Examples Basics History Extra

Script

Script() as String

(Graphical) information in script form that is evaluated by the GEO engine.

In Section Instructions Examples Basics History Extra

SetHelpText

SetHelpText(long index, BSTR newValue, long langIndex)

Now it is possible to check in tooltips or help texts individually or to inherit

them.

In Section Instructions Examples Basics History Extra

SetXValue

SetXValue(index as Long, newVal as String)

Sets the XValue specified by the index to the new value parameterized with newVal.

In Section Instructions Examples Basics History Extra

Value

Value() as String

Corresponds to the instruction: GetXValue(0).

In Section Instructions Examples Basics History Extra

XValueCount

XValueCount() as Long

Returns the number of XValues.

In Section Instructions Examples Basics History Extra

IComosDTimestamp

This chapter contains the following information:IComosDTimestamp

Login

Site

TimeZone

User

In Section Instructions Examples Basics History Extra

IComosDTimestamp

COMOS timestamp object. The UIDs of the timestamp objects can be used for time
relation purposes.

In Section Instructions Examples Basics History Extra

Login

Login() as String

Date of the timestamp. By default, one timestamp per user and per project/working
layer is managed; exceptions occur during revisions. Information is output
according to the country setting of the system on which COMOS is running.

In Section Instructions Examples Basics History Extra

Site

Site() as String

Returns the location at which this timestamp object had been created. See Site of
the IComosDWorkset.

In Section Instructions Examples Basics History Extra

TimeZone
TimeZone() as Long

Returns the difference from UTC time at which this timestamp object had been
created (in minutes). See TimeZone of the IComosDWorkset.

In Section Instructions Examples Basics History Extra

User

User() as IComosDUser

User pointer of the timestamp. (User associated with the timestamp.)

In Section Instructions Examples Basics History Extra

IComosDUnit

This chapter contains the following information:IComosDUnit

BackPointerDevices

BackPointerDocuments

CObject

CObjectConnectString

Devices

Documents

EnObs

GetObjectByLevel
OwnSpecifications

Positions

Specifications

SpecificationSets

Units

In Section Instructions Examples Basics History Extra

IComosDUnit

Replaced by Device with DeviceClass Unit.

Obsolete; only provided for compatibility reasons. No support in future versions.

Will cease to be available in future.

In Section Instructions Examples Basics History Extra

BackPointerDevices

BackPointerDevices() as IComosDOwnCollection

Collection of objects of class Device that have a Unit-pointer to the current

object.

In Section Instructions Examples Basics History Extra

BackPointerDocuments
BackPointerDocuments() as IComosDOwnCollection

Collection of objects of class IcomosDDocument that have a Unit pointer to the

current object.

In Section Instructions Examples Basics History Extra

CObject

CObject() as IComosDCDevice

Pointer to the associated CDevice which is used to conduct inheritance.

In Section Instructions Examples Basics History Extra

CObjectConnectString

CObjectConnectString() as String

Symbolic information for the CObject pointer (connect/disconnect project).

In Section Instructions Examples Basics History Extra

Devices
Devices() as IComosDOwnCollection

The object's own set of hierarchically-subordinate Devices.

In Section Instructions Examples Basics History Extra

Documents

Documents() as IComosDOwnCollection

Hierarchically-subordinate Collection with document objects.

In Section Instructions Examples Basics History Extra

EnObs

EnObs(Val as String) as IComosDCollection

Filters the elements collection for objects of the classes specified in the
parameter. Valid parameter values: See also chapter DeviceClass.

Examples

EnObs("ED") returns elements of the class Device or Element

EnObs("-R") returns objects of all classes up to Revision (R).

In Section Instructions Examples Basics History Extra

GetObjectByLevel
GetObjectByLevel(Val as Long) as IComosDUnit

Returns the owner structure object specified by the parameter.

In Section Instructions Examples Basics History Extra

OwnSpecifications

OwnSpecifications() as IComosDOwnCollection

Hierarchically-subordinate (structure-forming) Collection with the object's own

Specification objects.

In Section Instructions Examples Basics History Extra

Positions

Positions() as IComosDCollection

Corresponds to: EnObs(DeviceClassPosition) See also Chapter DeviceClass.

In Section Instructions Examples Basics History Extra

Specifications
Specifications() as IComosDCollection

Collection with own and inherited Specification objects.

In Section Instructions Examples Basics History Extra

SpecificationSets

SpecificationSets() as IComosDOwnCollection

Hierarchically-subordinate Collection with SpecificationSet objects.

In Section Instructions Examples Basics History Extra

Units

Units() as IComosDOwnCollection

Hierarchically-subordinate Collection with unit (Unit) objects.

In Section Instructions Examples Basics History Extra

IComosDUser

This chapter contains the following information:IComosDUser

Active
ActualLayers

ActualRO_Layers

Address

AdminDisabled

AdminRights

AllBackPointerRights

AllBackPointerTimestamps

BackPointerRights

BackPointerTimestamps

CanConsolidateDB

CanUpdateDB

CDeviceAdminDisabled

EMail

ExtendedRights

GetBackPointerCLinksWithReference

GetNumber

GetRemark

Layers

LayersForSession

LoginWithLocalAccount

NumberCount

OwnExtendedRights

OwnLabel

RemarkCount

RO_Layers

SetNumber

SetRemark

UserGroups
In Section Instructions Examples Basics History Extra

IComosDUser

COMOS user object.

In Section Instructions Examples Basics History Extra

Active

Active([in/out, retval] VARIANT_BOOL* active)

Returns TRUE or FALSE. Only active users can log in to the system. Inactive users
do not have any rights, no matter how the rights are set at other times.

In Section Instructions Examples Basics History Extra

ActualLayers

ActualLayers() as String

The working areas that are valid for this user. These may be both the working areas
of the user and the working areas of the user groups that the user belongs to (see
Usergroup.Layers).

In Section Instructions Examples Basics History Extra

ActualRO_Layers

ActualRO_Layers() as String

See ActualLayers. In this case, only for the RO_Layers (see also
Usergroup.RO_Layers).

In Section Instructions Examples Basics History Extra

Address

Address() as String

Text Property for adopting the address.

In Section Instructions Examples Basics History Extra

AdminDisabled

AdminDisabled() as Boolean

Boolean value that determines whether the administrator rights of the user
(relevant user object) are temporarily blocked.

In Section Instructions Examples Basics History Extra

AdminRights
AdminRights() as Long

Integer value that determines the administrator rights of the user.

In Section Instructions Examples Basics History Extra

AllBackPointerRights

AllBackPointerRights() as IComosDCollection

Collects all objects of class Right from all those projects in a Collection whose
user pointer refers to the current object.

This function may, depending on the size of the database, take a great deal of time
and should be used with caution.

In Section Instructions Examples Basics History Extra

AllBackPointerTimestamps

AllBackPointerTimestamps([out, retval] IComosDCollection** retVal)

Returns a Collection with IComosDTimestamp objects that reference the current user.
With this method all projects in the database are viewed.

In Section Instructions Examples Basics History Extra

BackPointerRights
BackPointerRights() as IComosDCollection

Collects all objects of class Right from the current project in a Collection whose
user pointer refers to the current object.

This function may, depending on the size of the database, take a great deal of time
and should be used with caution.

In Section Instructions Examples Basics History Extra

BackPointerTimestamps

BackPointerTimestamps([out, retval] IComosDCollection** retVal)

Works in exactly the same way as AllBackPointerTimestamps, but in this case the
Timestamps are returned from the current project (CurrentProject at the Workset).

In Section Instructions Examples Basics History Extra

CanConsolidateDB

CanConsolidateDB ( ) as Boolean

The method examines if the user has the right to trigger a database consolidation.

In Section Instructions Examples Basics History Extra

CanUpdateDB
CanUpdateDB ( ) as Boolean

The method examines if the user has the right to trigger a database update.

In Section Instructions Examples Basics History Extra

CDeviceAdminDisabled

CDeviceAdminDisabled() as Boolean

Toggles the base data function right for this user. Of course, you can only use
this function to disable it and thus switch over to the mode of a normal user.

In Section Instructions Examples Basics History Extra

EMail

EMail() as String

Text Property for adopting E-mail.

In Section Instructions Examples Basics History Extra

ExtendedRights
ExtendedRights() as Long

Non-object-dependent extended rights inherited from the UserGroup. Currently

available: Project management.

In Section Instructions Examples Basics History Extra

GetBackPointerCLinksWithReference

IComosDOwnCollection GetBackPointerCLinksWithReference()

Returns a Collection with all CLink objects which point to the current user (user
group membership)

Return value: Collection with CLink objects which have set the current user as a
reference.

In Section Instructions Examples Basics History Extra

GetNumber

GetNumber(Index As Long) as String

Fetches the number specified by the Index as a String from the telephone numbers
array.

In Section Instructions Examples Basics History Extra

GetRemark
GetRemark(Index As Long) as String

Fetches the remark specified by the Index as a String from the remarks array.

In Section Instructions Examples Basics History Extra

Layers

Layers() as String

Permissible working areas

See also

CDevice (Layers)

Device (Layers)

Document (Layers)

Specification (Layers)

In Section Instructions Examples Basics History Extra

LayersForSession

LayersForSession() as String

Layers of the current session (not saved, must be a subset of the Layers.)
In Section Instructions Examples Basics History Extra

LoginWithLocalAccount

bool LoginWithLocalAccount

Property of the Boolean type, which determines whether the current user (this) may
also log in with a local Windows account (true), or whether only domain accounts
are permitted (false).

In Section Instructions Examples Basics History Extra

NumberCount

NumberCount() as Long

Number of number entries in the telephone numbers array (strings).

In Section Instructions Examples Basics History Extra

OwnExtendedRights

OwnExtendedRights() as Long

Own non-object-dependent extended rights. Currently available: Project management.

In Section Instructions Examples Basics History Extra

OwnLabel

OwnLabel() as String

Returns the own label of the object.

In Section Instructions Examples Basics History Extra

RemarkCount

RemarkCount() as Long

Number of Remark entries in the remarks array (Strings).

In Section Instructions Examples Basics History Extra

RO_Layers

RO_Layers() as String

Read-only Layer of the user object. The option to edit specific objects under COMOS
or to block editing is handled via Layer. The object Layer (currently at CDevice,
Connector, Device, Specification) must match those set for the user in order to
allow editing.
In Section Instructions Examples Basics History Extra

SetNumber

SetNumber(Index As Long, newVal As String)

Inserts a new number in String form at the position specified by the Index in the
telephone numbers array.

In Section Instructions Examples Basics History Extra

SetRemark

SetRemark(Index As Long, newVal As String)

Inserts a new remark in String form at the position specified by the Index in the
remarks array.

In Section Instructions Examples Basics History Extra

UserGroups

UserGroups() as IComosDCollection

Returns all UserGroups of which the user is a member.

In Section Instructions Examples Basics History Extra

IComosDUserGroup

This chapter contains the following information:IComosDUserGroup

AddUser

AllBackPointerRights

AllUsers

BackPointerRights

ExtendedRights

Layers

RemoveUser

RO_Layers

In Section Instructions Examples Basics History Extra

IComosDUserGroup

COMOS object for user groups.

In Section Instructions Examples Basics History Extra

AddUser

AddUser(Val as Object)

Adds the user specified by the parameter to this group.

In Section Instructions Examples Basics History Extra

AllBackPointerRights

AllBackPointerRights() as IComosDCollection

Collects all objects of class Right from all those projects in a Collection whose
user pointer refers to the current object.

This function may, depending on the size of the database, take a great deal of time
and should be used with caution.

In Section Instructions Examples Basics History Extra

AllUsers

AllUsers() as IComosDCollection

Collection of all users in this group.

In Section Instructions Examples Basics History Extra

BackPointerRights

BackPointerRights() as IComosDCollection

Collects, from the current project, objects of class Right whose user

pointer refers to the current object in a Collection.

This function may, depending on the size of the database, take a great deal of time
and should be used with caution.

In Section Instructions Examples Basics History Extra

ExtendedRights

ExtendedRights() as Long

Extended rights. These rights are not object-dependent and are inherited by members
of the group. Currently available extended right: Project management.

In Section Instructions Examples Basics History Extra

Layers

Layers() as String

Working areas for this group. All users in the group are given these working areas
(see User.AcualLayers).

In Section Instructions Examples Basics History Extra

RemoveUser

RemoveUser(Val as Object)

Removes the user specified by the parameter from this group.

In Section Instructions Examples Basics History Extra

RO_Layers

RO_Layers() as String

Only read-only working areas for this group. All users in the group are given these
read-only working areas (see User.ActualRO_Layers).

In Section Instructions Examples Basics History Extra

IComosDWorkingOverlay

This chapter contains the following information:AllObjects

DBStatus

ExportOverlay

GetDocumentDirectory

GetReleasePreventingDocuments

GetReleasePreventingObjects

ID

IsConsolidationLayer

ObjectOverlays

Put_ConnectedBaseWorkingOverlay

RecalculateConsolidationLayerHierarchy

RecalculateWorkingLayerHierarchy

ReleaseOverlay
ReleaseOverlayEx

WorkingOverlays

In Section Instructions Examples Basics History Extra

AllObjects

AllObjects(SystemType as Long) as IComosDCollection

Returns all objects of the specified SystemType.

In Section Instructions Examples Basics History Extra

DBStatus

DBStatus() as Long

Returns the current status of the layer.

0:

The status is set to 0 ((in progress)) during a layer operation (e.g. release or
import). The status stays at 0 if an import operation is canceled. The status is
set to 3 ((release failed)) if a release operation is canceled.

1:

Free for access (OK).

2:

Layer locked.
3:

Canceling of a release (release failed).

In Section Instructions Examples Basics History Extra

ExportOverlay

ExportOverlay(DatabaseFileName as String) as Boolean

Exports a working layer into a new or existing Access database that was created
with ExportOverlay. In addition, all the documents of the layer are exported into a
separate directory (the directory name corresponds to the database).

In Section Instructions Examples Basics History Extra

GetDocumentDirectory

GetDocumentDirectory() as String

Returns the name of the document directory, including the layer directory. Relates
to the physical directories on the disk.

In Section Instructions Examples Basics History Extra

GetReleasePreventingDocuments
GetReleasePreventingDocuments(Options as Long) as IComosDCollection

From COMOS version 8.2 replaced by GetReleasePreventingObjects. Should not be used

anymore.

This functions detects all documents that are preventing a release. The parameter
determines which checks are to be made:

Options = 1

A check is performed for documents with project revisions but with missing unit
revisions.

Options = 2

A check is performed for open revisions in the layer to be released.

The options can also be combined by adding their values.

In Section Instructions Examples Basics History Extra

GetReleasePreventingObjects

GetReleasePreventingObjects(ByVal Options as long) as IComosDCollection

GetReleasePreventingObjects Checks whether there are any objects that may prevent
the release of a working layer. This function replaces
GetReleasePreventingDocuments and includes its full scope of functions.

Options:

Bit field specifying the conditions that are checked. One of the following
constants, or a combination of these constants (use the ‘Or’ operator), can be
used:

ReleaseCheckPlantRevisions (= 1)

Checks for missing unit revisions.

ReleaseCheckOpenRevisions (= 2)
Checks for open revisions.

ReleaseCheckDuplicateName (= 8)

Checks the working layer for duplicate names, which may come about if you are
working with parallel working layers, for example.

ReleaseCheckWithCreated (= 4)

Also checks whether the revisions found by ReleaseCheckPlantRevisions and

ReleaseCheckOpenRevisions have not been released yet (ReleaseCheckWithCreated set),
or whether they have not been created yet (ReleaseCheckWithCreated not set).

Can only be combined with ReleaseCheckPlantRevisions and ReleaseCheckOpenRevisions.

In Section Instructions Examples Basics History Extra

ID

ID() as Long

Unique label.

In Section Instructions Examples Basics History Extra

IsConsolidationLayer

IsConsolidationLayer ( ) as Boolean

Sets and returns the following property of a working layer:

ConsolidationOverlay as boolean

True: Current layer is consolidation layer

False: In all other cases.

In Section Instructions Examples Basics History Extra

ObjectOverlays

ObjectOverlays(Object as Object, Parameter as Long) as IComosDCollection

Parameter = Object_Get_Overlays_All (0)

Returns all working layers of an object.

Parameter = Object_Get_Overlays_Direct_Predecessor (1)

Returns the directly superordinate working layer in case the object is located in
it.

Parameter = Object_Get_Overlays_All_Predecessors (2)

Returns all working layers which are superordinate to the working layer and in
which the object is located.

Parameter = Object_Get_Overlays_Direct_Successors (3)

Input:

Object to which the information relates (reference object)

A working layer (in which the reference object is located) referenced by the
information ("Reference working layer")
The function returns the exact working layers for the reference object and the
reference working layer:

The reference object is located in the working layer (it is checked in) and

the newly found reference object is the direct successor to the reference object in
the reference working layer. In other words, the reference object is not checked in
again between these.

Example

Released area - Layer1 - Layer2 - Layer3 - Layer4

Assumption:

Object is checked into Layer1, not checked into Layer2 and checked in again in
Layer3 and Layer4.

If you look for the successor for an object in layer1 using Parameter 3, then
Layer3 is returned as response. Layer4 is not returned.

Application example:

Used for passing of collisions.

Parameter = Object_Get_Overlays_All_Successors (4)

Returns all working layers of an object that are subordinate to the working layer
and in which the object is contained.

In Section Instructions Examples Basics History Extra

Put_ConnectedBaseWorkingOverlay

Put_ConnectedBaseWorkingOverlay(/*[in]*/IComosDWorkingOverlay *newVal);

As for the project but for the planning working layers. If you log in to one of the
working layers, then the linked working layer is set to the base project and all
data is obtained from there. E.g. for the evaluation of new base data.
In Section Instructions Examples Basics History Extra

RecalculateConsolidationLayerHierarchy

RecalculateConsolidationLayerHierarchy ( ) as Boolean

Triggers a recalculation of the status of the objects in the consolidation view of

the navigator.

In Section Instructions Examples Basics History Extra

RecalculateWorkingLayerHierarchy

RecalculateWorkingLayerHierarchy([out, retval]VARIANT_BOOL *retVal)

Recalculates the working layer display for a working layer. Is only needed if
errors are present or assumed.

In Section Instructions Examples Basics History Extra

ReleaseOverlay

ReleaseOverlay(Description as String) as boolean

Release. Transfers the data to the next level up, i.e. to the next WorkingOverlay
or the released area, depending on whether the owner of the WorkingOverlay is also
a WorkingOverlay or is a project.
In Section Instructions Examples Basics History Extra

ReleaseOverlayEx

ReleaseOverlayEx(Object as Object) as Boolean

Releases a working layer. In contrast to the ReleaseOverlay method, extended

options for controlling the release are available if you use the
IcomosDOverlayParameter object.

In Section Instructions Examples Basics History Extra

WorkingOverlays

WorkingOverlays() as IComosDOwnCollection

Collection of the hierarchically-subordinate WorkingOverlays.

In Section Instructions Examples Basics History Extra

IPLTBinObjectArchive

This chapter contains the following information:IPLTBinObjectArchive

Load

LoadDouble

LoadLong

LoadPointer

LoadString
Save

SaveDouble

SaveLong

SavePointer

SaveString

Size

Version

In Section Instructions Examples Basics History Extra

IPLTBinObjectArchive

COMOS archive object for managing XObjects whose OnLoad and OnSave routines have an
IPLTBinObjectArchive as a parameter. This allows all standard data types to be
saved. Save- and Load-methods exist once in each case for Variant and the other
data types; it is faster to use special data types. The archiving is conducted in
the order of the entry, i.e., FIFO (first in first out).

In Section Instructions Examples Basics History Extra

Load

Load() as Variant

Loads variable as type Variant.

In Section Instructions Examples Basics History Extra

LoadDouble

LoadDouble() as Double

Loads variable as type Double.

In Section Instructions Examples Basics History Extra

LoadLong

LoadLong() as Long

Loads variable as type Long.

In Section Instructions Examples Basics History Extra

LoadPointer

LoadPointer() as Object

Loads variable as type Pointer. (Currently not yet implemented)

In Section Instructions Examples Basics History Extra

LoadString
LoadString() as String

Loads variable as type String.

In Section Instructions Examples Basics History Extra

Save

Save(Data as Variant) as Long

Saves variable as type Variant.

In Section Instructions Examples Basics History Extra

SaveDouble

SaveDouble(Data as Double) as Long

Saves variable as type Double.

In Section Instructions Examples Basics History Extra

SaveLong

SaveLong(Data as Long) as Long

Saves variable as type Long.

In Section Instructions Examples Basics History Extra

SavePointer

SavePointer(Pointer as Object, Type as Long) as Long

Saves variable as type Pointer (currently not yet implemented)

In Section Instructions Examples Basics History Extra

SaveString

SaveString(Data as String) as Long

Saves variable as type String.

In Section Instructions Examples Basics History Extra

Size

Size() as Long

Archive size (read-only)

In Section Instructions Examples Basics History Extra

Version

Version() as Long

Version of the archive.

In Section Instructions Examples Basics History Extra

IPLTPickList

This chapter contains the following information:IPLTPickList

PickListEntries

In Section Instructions Examples Basics History Extra

IPLTPickList

COMOS administration object for PickLists. These objects are located hierarchically
underneath the project. They are not taken into consideration during normal Save or
Undo operations. They are saved with Project.SavePickList. A maximum of 10 entries
are managed within the picklist in the order that they were entered, so that the
newest entry is at the top of the list. If there are more than 10 entries, all
entries except the newest 10 are dropped from the list.

In Section Instructions Examples Basics History Extra

PickListEntries

PickListEntrys()

Hierarchically-subordinate Collection with PickListEntrys.

In Section Instructions Examples Basics History Extra

IPLTPickListEntrys

This chapter contains the following information:IPLTPickListEntrys

CreateEntry

In Section Instructions Examples Basics History Extra

IPLTPickListEntrys

COMOS Collection with PickList entries.

In Section Instructions Examples Basics History Extra

CreateEntry
CreateEntry(Name as String, Description as String) as IPLTPickListEntry

Creates a new object in the PickListEntrys Collection with the specified name and
Description and inserts it at the beginning of the Collection.

Note Do not use CreateNew !

In Section Instructions Examples Basics History Extra

IPLTVarstorage

This chapter contains the following information:IPLTVarstorage

Exist

ItemExist

In Section Instructions Examples Basics History Extra

IPLTVarstorage

COMOS administration object for storing variables. See also Chapter Globals.

In Section Instructions Examples Basics History Extra

Exist
Exist(Name as String) as Long

Tests whether a variable with the specified name already exists.

In Section Instructions Examples Basics History Extra

ItemExist

ItemExist(Name as String) as Long

Corresponds to the Exist method.

In Section Instructions Examples Basics History Extra

IPLTXValueArrayEntry

This chapter contains the following information:IPLTXValueArrayEntry

DisplayValue

GetRS

GetRSByCase

Index

Specification

StandardValueDescription

StaticLinkDisplayValue

StaticLinkValue

SystemTypeName

Value
ValueByCase

In Section Instructions Examples Basics History Extra

IPLTXValueArrayEntry

COMOS container object that contains the entry of a list cell. Since the cells of
an attribute list are not objects, for example, but it is easier and quicker to
work with objects at numerous points in the program, this container object was
designed so that the cell contents would be available packaged in the same way as
an object during runtime.

In Section Instructions Examples Basics History Extra

DisplayValue

DisplayValue() as String

Corresponds to Spec.GetDisplayXValue(Index).

In Section Instructions Examples Basics History Extra

GetRS

GetRS() as Object

Corresponds to Spec.GetXValueRS(Index).
In Section Instructions Examples Basics History Extra

GetRSByCase

GetRSByCase(obj as Object) as Object

Corresponds to Spec.GetXValueRSByCase(Object, Index).

In Section Instructions Examples Basics History Extra

Index

Index() as Long

Cells Index.

In Section Instructions Examples Basics History Extra

Specification

Specification() as Object

Corresponding Specification.

In Section Instructions Examples Basics History Extra

StandardValueDescription

StandardValueDescription() as String

Corresponds to Spec.StandardXValueDescription(Index).

In Section Instructions Examples Basics History Extra

StaticLinkDisplayValue

StaticLinkDisplayValue() as String

Corresponds to Spec.StaticLinkDisplayXValue(Index).

In Section Instructions Examples Basics History Extra

StaticLinkValue

StaticLinkValue() as String

Corresponds to Spec.StaticLinkXValue(Index).

In Section Instructions Examples Basics History Extra

SystemTypeName
SystemTypeName() as String

Returns the class of the relevant object. Possible values: See also Chapter
SystemType.

In Section Instructions Examples Basics History Extra

Value

Value() as String

Corresponds to Spec.GetXValue(Index).

In Section Instructions Examples Basics History Extra

ValueByCase

ValueByCase(obj as Object) as String

Corresponds to Spec.XValueByCase(Object, Index).

In Section Instructions Examples Basics History Extra

Hierarchy Objects
This chapter contains the following information:IComosDCollection

IComosDOwnCollection

IComosDWorkset

In Section Instructions Examples Basics History Extra

IComosDCollection

This chapter contains the following information:IComosDCollection

Add

Append

CollectionIsSorted

Count

DeviceNextNameWithClass

FastNextName

Insert

Item

ItemExist

ItemIndex

NextName

NextNameWithClass

Remove

SwapItems

In Section Instructions Examples Basics History Extra

IComosDCollection
COMOS collection object. The Collection class was derived from the IPLT-Object
class before the switchover to the new interfaces. When the object structures were
adapted during the switch to dual interfaces (something which can be identified
from the new IComosD prefix), the Collection became a separate class.

The object management system under COMOS uses pointers to navigate to objects that
are exclusively stored in different Collections. A structural distinction is made
in COMOS between Collections, OwnCollections and OwnerCollections.

Collection:

A set of objects of the same or a different class.

OwnCollection:

Subclass of Collection. Only contains objects of the same class.

UndoStates represents a special case in that it behaves in a similar way to an

IComosDCollection but has a very restricted functional scope.

In Section Instructions Examples Basics History Extra

Add

Add(Val as Object)

Inserts the relevant object (sorted) in the Collection. Each object can only be in
one OwnerCollection.

In Section Instructions Examples Basics History Extra

Append
Append(Val as Object)

Inserts the relevant object at the end of the Collection. Each object can only be
in one OwnerCollection

In Section Instructions Examples Basics History Extra

CollectionIsSorted

CollectionIsSorted() as Boolean

Shows whether the Items in the Collection are sorted by name.

In Section Instructions Examples Basics History Extra

Count

Count() as Long

Number of Items in the Collection.

If this involves an OwnCollection (IComosDOwnCollection), the Collection is sorted

with this Count action.

In Section Instructions Examples Basics History Extra

DeviceNextNameWithClass
DeviceNextNameWithClass(Mask as String, class_st as String, device as Object) as
String

For a Device, returns the next valid name in the form specified by the parameter
mask (class-related).

In Section Instructions Examples Basics History Extra

FastNextName

FastNextName(Val as String) as String

For generating multiple NextNames. The entire Collection is not tested each time
(it is better to use the NextName method).

In Section Instructions Examples Basics History Extra

Insert

Insert(Val as Object)

If the object is not yet in the Collection, it is inserted.

In Section Instructions Examples Basics History Extra

Item
Item(Val as Variant) as Object

Either returns i-tes Item of the Collection or Item with the specified name.

In Section Instructions Examples Basics History Extra

ItemExist

ItemExist(Val as Variant) as Boolean

Checks whether an Item with a specified name or Index actually exists.

In Section Instructions Examples Basics History Extra

ItemIndex

ItemIndex(obj as Object) as Long

Returns the Index of the relevant object in the Collection.

In Section Instructions Examples Basics History Extra

NextName

NextName(Val as String) as String

Returns the next free name in the Collection with the specified form.
Example

A Collection contains the Items D01, D02, D03

The instruction Collection.NextName("D??") returns "D04" as a return value.

In Section Instructions Examples Basics History Extra

NextNameWithClass

NextNameWithClass(Val1 as String, Val2 as String) as String

Older variant of DeviceNextNameWithClass, only restricted usage.

In Section Instructions Examples Basics History Extra

Remove

Remove(Val as Object) as Object

Remove cuts objects from the Collection. Objects that have been cut are not
allocated provided they have not been added or edited elsewhere; i.e. a paste
operation must be carried out after the Remove operation to avoid any errors or
problems.

In Section Instructions Examples Basics History Extra

SwapItems
SwapItems(Val1 as Long, Val2 as Long)

Swaps the position of Item(val1) with that of Item(val2) in the Collection.

Example: SwapItems(3,5) results in Item (3) and Item(5) swapping places. Caution:
This swap is only temporary, since a subsequent read operation from the DB produces
alphanumeric sorting of the entire Collection.

IComosDOwnCollection

Derived class from IComosDCollection. IComosDOwnCollection thus has all the

functions of IComosDCollection. The hierarchical structures are formed by means of
the OwnCollections.

IComosDOwnCollection: Function

In Section Instructions Examples Basics History Extra

IComosDOwnCollection

This chapter contains the following information:AddWithoutProjectChange

CreateNew

CreateNewWithName

CreateNewWithNameAndCDevice

Deleted

OwnAndDeleted

In Section Instructions Examples Basics History Extra

AddWithoutProjectChange

AddWithoutProjectChange ( Val as Object )

Parameter Val as object

The object to be added

Adds an objects to an OwnCollection but without changing the project ownership of

the added object. Alternatively: The Add method. Here the object is also applied to
the current program.

In Section Instructions Examples Basics History Extra

CreateNew

CreateNew() as Object

Creates a new object in the Collection and appends this at the end of the
Collection. One of three options for creating a new COMOS object in the Collection.

In Section Instructions Examples Basics History Extra

CreateNewWithName

CreateNewWithName(Val as String) as Object

Creates a new object with the specified name and adds it to the Collection, sorted
by name. One of three options for creating a new COMOS object in the Collection.

In Section Instructions Examples Basics History Extra

CreateNewWithNameAndCDevice

CreateNewWithNameAndCDevice(Val1 as String, Val2 as Object) as Object

Only for Device Collections.

Creates a new Device with the specified name and origin (CDevice)and adds it to the
Collection, sorted by name. One of three options for creating a new COMOS object in
the Collection.

In Section Instructions Examples Basics History Extra

Deleted

Deleted() as IComosDCollection

Returns all objects of the Collection that are marked as deleted in the database by
means of the GetSavedAndDeleted flag for the objects. It is only possible to make a
read access to these objects.

In Section Instructions Examples Basics History Extra

OwnAndDeleted

OwnAndDeleted() as IComosDCollection

Own objects and objects with the GetSavedAndDeleted flag.

IComosDWorkset

When COMOS is started, login causes a unique object of class IComosDWorkset to be

created; this handles all communication with the database. The Workset is assigned
all the central administrative tasks such as database connection and making
database changes, preparation of the COMOS clipboard, management of the object
cache, user administration and global operations such as SaveAll, CheckAll,
UndoAll.

In Section Instructions Examples Basics History Extra

IComosDWorkset

This chapter contains the following information:IComosDWorkset

AcceptCollision

ActivateSoftDeleteWatcher

ActivateTimestampWatcher

AdditionalProject

AddToChangedObjects

AddToCurrentUndoState

AddToErrorLog

BaseMemoryThreshold

BuildD3FromBinaryString

BuildXObjFromBinaryString

CacheEntriesCount

CanCreateConsolidationLayer

ChangedObjects

ChangedObjectsOverflow

CheckAll

CheckDatabaseCredentials

CheckDataBaseIndices

CheckDataBaseTables

CheckDBObjectName

CheckLayer

CheckTimestampUids
CheckVersion

ClearCache

ClearDBSyncName

Clipboard

ClipboardObject

CollectionCount

ComosVersion

CompareTimestamp

CompressCache

CompressDatabaseAndDBDirectory

CompressDatabaseAndDBDirectoryTimestamp

ConnectionStatus

ConnectWithComosSystem

ConvertAnsiToUnicode

ConvertPattern

ConvertUnicodeToAnsi

Copy

CopyFile

CopyFrom

CopyProject

CreateDatabase

CreateDeviceObject

CreateNewCurrentTimeStamp

CreateNewRollbackState

CreateNewUser

CreateObject

CreateObjectStructure

CrossProjectCopy

CurrentDatabaseVersion
CurrentDocumentVersion

CurrentRollbackState

CurrentUndoState

Custom

DatabaseOperationsOverlayMode

DBPriority

DBSyncName

DBVersionChange

DebugMode

DefaultFlag

DeleteDatabaseTables

DeleteErrorObjects

DeleteForCopyFrom

DevicesWithoutProjection

DisconnectFromComosSystem

DisposeAllModules

DocumentVersion

DragObject

ErrorText

Escape

ExecuteCopyFrom

ExportDatabase

ExportDatabaseWithDBSync

ExportDatabaseWithoutDeleted

ExportDB

ExtentedCopyRightForCurrentUser

FinishAOWM

FPXmlDBScheme

FTIndexUpdater

GetAllNumberRangeGenerators
GetAllProjects

GetAllUserGroups

GetAllUsers

GetBaseObjectCollection

GetCachedTempCollection

GetCallstack

GetChangeLogger

GetConsolidationUpdate

GetCopyManager

GetCTISession

GetCurrentProject

GetCurrentTimestamp

GetCurrentUpdate

GetCurrentUser

GetD3BinaryString

GetDateTimeFromUID

GetDBDirectory

GetDBInfo

GetDBName

GetDragOcx

GetExportManager

GetFileAttribute

GetFileProperties

GetFPAllowedColumnTypes

GetFPAllowedColumnTypesFor

GetFPsForGroup

GetFPGroups

GetGeneralCollection

GetMemoryUsage
GetNumeric

GetOldOwnerOfMovingObject

GetOverlayParameter

GetPerformanceValues

GetProjectionErrorText

GetProjectionMode

GetProjectionObject

GetResources

GetRootsOfTemplates

GetScanManager

GetScriptHelper

GetSearchManager

GetSourceObject

GetStatusManager

GetString

GetTempCollection

GetTimestampWatcherObject

GetUserValueForKey

GetUseScriptFunctions

GetUsersByState

GetWatchedRevisionOf

GetWatchedSoftDeleteFlag

GetWatchedTimestamp

GetWorkingOverlayFullFileName

GetXObjBinaryString

Globals

HasGlobalOverflowOccurred

HashTableSize

HideProgressBar

HistoryRemark
ImportFromDatabaseWithDBSync

ImportWorkingProjectFromOtherDB

Init

InitAOWM

InitChangedObjects

InitString

InitWithFullConnectionString

IsAllSaved

IsInitialized

IsInsertReferenceEnabled

IsMaxLoadedObjectsReached

IsNumericForCurrentLanguage

IsSolidBaseDb

IsTerminalServer

LastErrorNumber

LastErrorObject

LastErrorText

Lib

LicenseRuntimeCheck

LicenseServer

LicenseToken

LoadObject

LoadObjectByType

LockPermission

LogoCad

MaxLoadedObjects

MemoryDump

MessageBoxHandler

ModuleLicense
ModuleLicenseCheckedOut

NewComosUID

NotifyAboutChangedUIDs

ObjectCount

ObjectsWithoutProjection

PackageLicense

POptions

ReferencedObjectCount

ReferencedObjects

RefreshRights

ReleaseAllObjects

ReleaseChangedObjects

ReleaseObjects

ReleaseStaticCollections

RemoveFromChangedObjects

RemoveProcessInfo

RemoveProjections

ResetUsers

ResetUsersEx

RevisionCheck

RootDir

RunDatabaseMaintenance

SaveAll

Scan

ScriptErrorHandler

SendCVSMessagesWithOldStyle

SetCurrentProject

SetCurrentUser

SetCurrentUserWithAuthentication

SetDragObjectWithOcx
SetFileAttribute

SetOracleMemoFieldLength

SetOverflowForAllChangedObjects

SetProjection

SetProjectionWithMode

SetRunMode

SetTrLangDB

SetUseScriptFunctions ( Val as Boolean )

SetUseValidationService

SetWatchedTimestamp

ShutdownXObjs

SimpleCDeviceChange

SingleReleaseStaticCollections

Site

SMSInfo

SoftDeleteFilter

SoftDeleteMode

SpecEval

StartErrorLog

StartMode

StopErrorLog

StringCompare

SwitchToCurrentDBVersion

SystemRefCount

SystemType

SystemTypeName

Terminate

TimeBetween

TimeZone
TotalTimeMode

TransactionCount

TransferProjectMode

UndoAll

UndoStates

UnsavedObjectCount

UnsavedObjects

UpdateFullPath

UseAliasForLabelFunctions

Viewing

WriteNetLoginCredentials

XObj

In Section Instructions Examples Basics History Extra

IComosDWorkset

When COMOS is started, login causes a unique object of class IComosDWorkset to be

created; this handles all communication with the database. The Workset is assigned
all the central administrative tasks such as database connection and making
database changes, preparation of the COMOS clipboard, management of the object
cache, user administration and global operations such as SaveAll, CheckAll,
UndoAll.

In Section Instructions Examples Basics History Extra

AcceptCollision
AcceptCollision(Val as Object) as Long

Removes a collision flag that was set at the object. The object then no longer has
the colored marking for collisions (default: dark magenta).

In Section Instructions Examples Basics History Extra

ActivateSoftDeleteWatcher

ActivateSoftDeleteWatcher(Val as Boolean)

Switches on/off SoftDelete monitoring (see IcomosBaseObject.GetSoftDeleteFlag) of

the investigated objects with the aim of a report evaluation (see
IcomosDWorkset.GetWatchedSoftDeleteFlag).

The SoftDelete objects are not monitored; instead, the SoftDelete objects are taken
into consideration during the monitoring process. The monitoring is called
separately for each constituent part of the report (Subreport, Master Report).

In Section Instructions Examples Basics History Extra

ActivateTimestampWatcher

ActivateTimestampWatcher(Val as Boolean)

Activates timestamp monitoring of the objects to be monitored regarding report

evaluation. See also Chapter GetWatchedRevisionOf.

In Section Instructions Examples Basics History Extra

AdditionalProject
AdditionalProject() as IComosDProject

Project that is also evaluated when filtering the CDevices Collection.

In Section Instructions Examples Basics History Extra

AddToChangedObjects

AddToChangedObjects(Val as Object)

Sets the specified object in the list of changed objects.

In Section Instructions Examples Basics History Extra

AddToCurrentUndoState

AddToCurrentUndoState(Val as Object)

Adds the Val object to the current UndoState. Normally this is not necessary, since
this is done automatically in the event of a change. In a 3D environment, however,
it may be that 3D Properties are set directly without the COMOS object being
changed. In this case, one 3D object is stored per Device.

In Section Instructions Examples Basics History Extra

AddToErrorLog
AddToErrorLog(Object as Object, Description as String, Reason as Long) as Boolean

Allows an entry to be written to the Errorlog (see StartErrorLog).

Object: COMOS object for which an entry is to be made.

Description: Error text.

Reason: Error code. There is no central administration of error numbers yet. If

possible, numbers > 1,000 should be assigned.

In Section Instructions Examples Basics History Extra

BaseMemoryThreshold

BaseMemoryThreshold ( ) as Long

This property controls the memory consumption as of which COMOS releases the
objects. 1 GB remains the lower limit. If you enter a value lower than 1 GB, the
lower limit 1 DB is used automatically.

In Section Instructions Examples Basics History Extra

BuildD3FromBinaryString

BuildD3FromBinaryString(Hex As String, Object As Object) as Boolean

Creates a 3D object at the specified object, using the encrypted String that is
transferred. See also Chapter GetD3BinaryString.
In Section Instructions Examples Basics History Extra

BuildXObjFromBinaryString

BuildXObjFromBinaryString(Hex As String, Object As Object)

Creates an XObject at the specified object, using the encrypted String that is
transferred. See also Chapter GetXObjBinaryString.

In Section Instructions Examples Basics History Extra

CacheEntriesCount

CacheEntriesCount() as Long

Integer number of Cache entries. Pointer to COMOS objects that are in the memory
are kept in the Cache.

In Section Instructions Examples Basics History Extra

CanCreateConsolidationLayer

CanCreateConsolidationLayer ( ByVal overlays as IComosDOwnCollection ) as Boolean

Parameter overlays as IComosDOwnCollection

Collection of working layers to be checked

Checks to see if a consolidation layer can be created in a collection of working

layers.

In Section Instructions Examples Basics History Extra

ChangedObjects

ChangedObjects(Val as Long) as IComosDObjectCollection

Returns an ObjectCollection of amended objects, but this only takes selected

changes into consideration, such as changes to a name or label. Usage:

Calling up the InitChangedObjects function returns an integer value (< 20) that
corresponds to a list number.

ChangedObjects receives the list number as a parameter. Now you can (usually) query
the ChangedObjects list on a timer-controlled basis to refresh specific data. The
actual ObjectCollectionItem consists of a pointer to a COMOS object and code. There
are four different reasons for acceptance into the ChangedObjects list:

Object: changes took place at the object itself

Collection: the change took place in a directly subordinate Collection

External: an application triggers the adaption to the list

CVS: the object was changed on another station ChangedObjectsCode.

It is essential to log out with ReleaseChangedObjects, since the number of lists

would otherwise quickly exceed the permitted upper limit of 20 and thus reduce the
system performance.

In Section Instructions Examples Basics History Extra

ChangedObjectsOverflow

ChangedObjectsOverflow(Val as Long) as Boolean

If there are more than 250 objects in the ChangedObjects list, the Boolean value is
set to True and no further objects are accepted into the list. This function should
be used to generate an automatic refresh.

In Section Instructions Examples Basics History Extra

CheckAll

CheckAll() as Long

Checks the object structure for all objects in the memory. The objects can only be
stored if the structures are not defective. See also Chapter SaveAll.

In Section Instructions Examples Basics History Extra

CheckDatabaseCredentials

CheckDatabaseCredentials ( string dbUser, string dbPassword, int dataSourceIndex )

as Boolean

Checks to see if the passed access data match the access data in the access file.

Return: True if the access data match

Parameter dbUser as string

User name to be checked

Parameter dbPassword as string

Password to be checked

Parameter dataSourceIndex as integer [1, 2, 3]

Specifies from which data source the access file is to be checked

In Section Instructions Examples Basics History Extra

CheckDataBaseIndices

CheckDataBaseIndices()

Checks all DB indices. Any indices that are missing are created.

In Section Instructions Examples Basics History Extra

CheckDataBaseTables

CheckDataBaseTables()

Checks the schematic layout of the DB (table structure), and an incorrect schematic
layout is adjusted (the correct tables are created).

In Section Instructions Examples Basics History Extra

CheckDBObjectName
CheckDBObjectName ( ByVal inputString as String ) as String

Parameter inputString

For internal use.

In Section Instructions Examples Basics History Extra

CheckLayer

CheckLayer(Val as String) as Boolean

Checks the Layer (permitted working areas) of the current user against the
specified ones. The user working areas can be set by means of user administration.

In Section Instructions Examples Basics History Extra

CheckTimestampUids

CheckTimestampUids() as Long

Checks the timestamp objects with the aim of removing unused ones.

In Section Instructions Examples Basics History Extra

CheckVersion
CheckVersion() as Boolean

Checks the schematic layout of the relevant database against the details in
Comos.dll; if False is the result, the database has to be adapted. Schematic layout
means the internal structure of the database, in other words, the number,
designations and internal structure of the tables.

In Section Instructions Examples Basics History Extra

ClearCache

ClearCache()

Deletes all objects from the memory! The state is the same as the state following
reinitialization of the Workset; all old object variables are no longer valid;
CurrentUser and CurrentProject must be set again. In many cases it is better to use
the ReleaseObjects method. See also Chapter ReleaseObjects.

In Section Instructions Examples Basics History Extra

ClearDBSyncName

ClearDBSyncName(Val as String)

Not implemented yet!

In Section Instructions Examples Basics History Extra

Clipboard

Clipboard() as IComosDClipboard

Returns the IComosDClipboard object for COMOS Clipboard handling. See also Chapter
IComosDClipboard.

In Section Instructions Examples Basics History Extra

ClipboardObject

ClipboardObject() as Object

COMOS Clipboard for cut, paste and copy operations, etc. The selected objects are
temporarily stored on the COMOS clipboard. You can select multiple items at once
using TempCollections; Workset.GetCachedTempCollection must be used for this
purpose! See also Chapter GetCachedTempCollection.

In Section Instructions Examples Basics History Extra

CollectionCount

CollectionCount() as Long

Integer number, the number of Collections in the memory.

In Section Instructions Examples Basics History Extra

ComosVersion
ComosVersion() as Long

Continuous version number (not the same as the COMOS version number).

In Section Instructions Examples Basics History Extra

CompareTimestamp

CompareTimestamp() as IComosDTimestamp

Timestamp object for use with the history display (compare

GetSystemStatus(System_Status_ObjectRevision)).

In Section Instructions Examples Basics History Extra

CompressCache

CompressCache();

Compresses the COMOS Cache (release of resources); compare e.g. ReleaseObjects.

In Section Instructions Examples Basics History Extra

CompressDatabaseAndDBDirectory
CompressDatabaseAndDBDirectory()

Compresses the database and the database directory by deleting all data records and
document files with DeleteFlag = True.

In Section Instructions Examples Basics History Extra

CompressDatabaseAndDBDirectoryTimestamp

void CompressDatabaseAndDBDirectoryTimestamp([in] IComosDProject project, [in]

double oleDate)

As with IComosDProject::CompressDatabaseAndDBDirectory, the specified project or

all projects in the database can be processed in this case. For information on the
function, see IComosDProject::CompressDatabaseAndDBDirectory.

Parameter project: The project to be processed or nothing if all projects in the

database are to be processed.

Parameter oleDate: Reference time for deleted items to be removed. Objects that are
newer than this point in time will not be removed.

In Section Instructions Examples Basics History Extra

ConnectionStatus

ConnectionStatus() as String

Obsolete. Always returns "CVS" as return value.

In Section Instructions Examples Basics History Extra

ConnectWithComosSystem

ConnectWithComosSystem() as IComosDCollection

Connects all objects with the new system project after changing the system project.
DisconnectFromComosSystem must be called beforehand! The return value is a
Collection that contains all objects that cannot be allocated properly.

In Section Instructions Examples Basics History Extra

ConvertAnsiToUnicode

void ConvertAnsiToUnicode([in] long charset, [in] string stringValue)

Converts a String of type BSTR (standard format for COM calls) in ANSI format
inplace into Unicode format. Each character in the value range 128 to 255 is
converted to its counterpart in the Unicode character set. The source string code
page required for this conversion process must be transferred in parameter charset
(e.g. 204 for Cyrillic).

Parameter charset: defines which language the source string is in. The number
indicates the appropriate code page (e.g. 178 for Arabic, 204 for Cyrillic, etc.)

In Section Instructions Examples Basics History Extra

ConvertPattern

ConvertPattern ( ByVal inputString as String, ByVal dbType as Long ) as String

Parameter inputString as string

String with placeholders. Currently supported:

Parameter dbType as long

Type of used database. Constants see Module "DbType".

This method converts the placeholders of search queries (*, ?) so that the used
database can understand them.

In Section Instructions Examples Basics History Extra

ConvertUnicodeToAnsi

void ConvertUnicodeToAnsi([in] long charset, [in] BSTR stringValue)

Converts a String of type BSTR (standard format for COM calls) in Unicode format
inplace into an ANSI String with the specified code page. Unicode characters for
which there is no equivalent in the specified code page are changed to a question
mark '?'.

Parameter charset: Defines which character set the Unicode string is to be

converted to. The number indicates the appropriate code page (e.g. 178 for Arabic,
204 for Cyrillic, etc.)

In Section Instructions Examples Basics History Extra

Copy

Copy(Val As Object) as Long

Extended copy function (copying across projects). Receives a parameter of type

ComosDCopyManager. See also Chapter IComosDCopyManager.

In Section Instructions Examples Basics History Extra

CopyFile

CopyFile(sourcefile as String, targetfile as String, failifexists as Boolean) as

Boolean

Copies sourcefile to targetfile (file attributes and content are copied).

As with all methods of the Comos.dll: Automatically uses the NetworkLogin.

If the function fails, FALSE is returned; otherwise TRUE is returned.

sourcefile:

Full name of the source file.

targetfile:

Full name of the target file.

failifexists:

FALSE:

targetfile already exists: the file is overwritten.

TRUE:

targetfile already exists: the operation fails.

In Section Instructions Examples Basics History Extra

CopyFrom

CopyFrom(Val1 as Object, Val2 as Object, Val3 as String) as IComosDCollection

Used when copying structures. This method creates the objects in the CopyTree

Val1: Collection with the objects to be copied

Val2: Project (CopyTreeProject, new)

Val3: Not used

In Section Instructions Examples Basics History Extra

CopyProject

CopyProject(Val1 as Object, Val2 as String)

Copies the relevant project into the specified database. The login syntax
corresponds to that of the Workset.Init. Connected projects (base project, system
project) are disconnected before exporting and then reconnected accordingly in the
other database.

In Section Instructions Examples Basics History Extra

CreateDatabase
CreateDatabase(Val as String) as Boolean

Creates a new Access database with the specified name.

In Section Instructions Examples Basics History Extra

CreateDeviceObject

CreateDeviceObject([in] LPDISPATCH Owner, [in] LPDISPATCH CDevice, [in, optional,

defaultvalue("")] VARIANT Name, [in, optional, defaultvalue("")] VARIANT DevClass,
[in, optional, defaultvalue(NULL)] VARIANT Unit, [in, optional, defaultvalue(NULL)]
VARIANT Location, [out, retval] LPDISPATCH* NewDevice)

Creating a new Device.

Parameter:

Owner:

Type IComosBaseObject; the object underneath which the new Device is created.

CDevice:

Type IComosDCDevice; base object for the Device to be created (may also be
NULL/Nothing)

Name:

Type String; name for the new Device; optional parameter.

DevClass:

Type String; Device class for the new Device; optional parameter.

Unit:

Type IComosBaseObject; unit pointer for the new object; optional parameter.
Location:

Type IComosBaseObject; location pointer for the new object, optional parameter.

Return value:

Type IComosDDevice; newly-created Device

In Section Instructions Examples Basics History Extra

CreateNewCurrentTimeStamp

CreateNewCurrentTimeStamp()

Creates a current timestamp that is required for revision editing. Only one
timestamp per User, day and project is created internally within the system; if
additional ones are required to make distinctions within a day, they must be
created with CreateNewCurrentTimeStamp.

In Section Instructions Examples Basics History Extra

CreateNewRollbackState

CreateNewRollbackState() as IComosDRollbackState

Creates a new RollbackState.

In Section Instructions Examples Basics History Extra

CreateNewUser

CreateNewUser(Val as String) as IComosDUser

Creates a new User object with the specified name. This method is not executed by
means of the permissions administration of the Collection!

Enables the creation of a new user without having a current project set.

In Section Instructions Examples Basics History Extra

CreateObject

CreateObject(Val as Long) as Object

Creates an object of the specified class. This is not recommended as a general

method for creating objects, since the new object is not in any Collection and thus
results in the "No owner set" check error if no further action is taken.

In Section Instructions Examples Basics History Extra

CreateObjectStructure

CreateObjectStructure(LPDISPATCH sourceobject, LPDISPATCH sourceroot, LPDISPATCH

targetowner, long mode, [out, retval] LPDISPATCH* retVal)

Copy structure underneath the document

In Section Instructions Examples Basics History Extra

CrossProjectCopy

long CrossProjectCopy(IComosDCopyManager copyManager)

This method allows you to copy a certain set of objects into another project
(cross-project copying). An instance of type IComosDCopyManager is used to specify
how the copy process is to be performed (see documentation for this class). This
method replaces the old method (Copy). In contrast to this old method, the Property
DestinationObject is also evaluated, meaning that the @Tpl and @TplM pointers can
be handled correctly. It should be noted, however, that the copied objects are not
inserted below the target. That is still the job of the calling location.

Parameter copyManager: Instance of the class IComosDCopyManager that controls the

behavior of the copy operation.

In Section Instructions Examples Basics History Extra

CurrentDatabaseVersion

CurrentDatabaseVersion() as Long

Returns the current COMOS version of the database. The DBVersionChange method
returns information on whether the version of the software is identical to it.

In Section Instructions Examples Basics History Extra

CurrentDocumentVersion

CurrentDocumentVersion() as Long

Returns the document version that is valid for this version.

In Section Instructions Examples Basics History Extra

CurrentRollbackState

CurrentRollbackState() as IComosDRollbackState

Current RollbackState; all actions are logged in this RollbackState.

In Section Instructions Examples Basics History Extra

CurrentUndoState

CurrentUndoState() as IComosDUndoState

Current UndoState (all objects that change are added to this UndoState).

In Section Instructions Examples Basics History Extra

Custom

Custom() as Object

Access to Custom.dll; this can be addressed by means of a VB script and enables

user-specific functions.
In Section Instructions Examples Basics History Extra

DatabaseOperationsOverlayMode

DatabaseOperationsOverlayMode() as Long

When carrying out all bulk processing operations on the database, this global
switch can be set to determine whether these operations relate solely to the
released area (DatabaseOperationsOverlayModeApprovedArea (0)) or to the released
area including all working layers (DatabaseOperationsOverlayModeAllOverlays (1 =
standard)).

In Section Instructions Examples Basics History Extra

DBPriority

DBPriority() as Long

The priority that can be set for database operations. Initially only for MS SQL-
Server. Valid values: See also Chapter DBPriority_.

In Section Instructions Examples Basics History Extra

DBSyncName

DBSyncName() as String

A single-character database identifier that is required for Export- and

ImportWithDBSync.
In Section Instructions Examples Basics History Extra

DBVersionChange

DBVersionChange() as Boolean

Boolean = True means that the database version does not match the version of
Comos.dll. The database can now be converted (see SwitchToCurrentDBVersion), but
clients with an older version of COMOS can no longer work with this database.

In Section Instructions Examples Basics History Extra

DebugMode

DebugMode() as Boolean

If DebugMode = True, then all COMOS exceptions are displayed in message boxes. This
is an application development function for preventing errors from being missed.

DisableChangedObjects ( ) as Boolean

Member of: Plt.IComosDWorkset

Objects that are changed are added to all logged-in ChangeObjectsCollections (see
InitChangedObjects, ChangedObjects). This is necessary to allow all interfaces with
Updatewatcher to be able to react to object changes. The adding of changed objects
is suppressed with this method. This is useful for import operations in which a
complete refresh can be done at the end, and periodic refreshing of the interfaces
is not required (switching the latter off results in improved performance).

In Section Instructions Examples Basics History Extra

DefaultFlag
DefaultFlag() as String

For internal use. Default setting for the ADO connection (MS SQL server, Oracle).

In Section Instructions Examples Basics History Extra

DeleteDatabaseTables

DeleteDatabaseTables()

Note This deletes all database tables for server databases.

In Section Instructions Examples Basics History Extra

DeleteErrorObjects

DeleteErrorObjects(context as Object, Objects as Object, Mode as Long) as

IComosDObjectCollection

Returns all objects that were provided with deletion prevention or a warning when
carrying out a deletion. There are IcomosDObjectCollectionItems (see there) in the
Collection that is returned.

Administrators only get warning entries, while other users get warning and deletion
prevention entries.

Context: specifies the document from which it may be possible to call the delete
command.

Objects: The objects to be deleted.

Mode: Reserved for future applications.

In Section Instructions Examples Basics History Extra

DeleteForCopyFrom

DeleteForCopyFrom(Val as Object) as Long

Delete function for copying structures.

In Section Instructions Examples Basics History Extra

DevicesWithoutProjection

DevicesWithoutProjection() as IComosDCollection

Used with Copy Structure and returns all Devices that do not own a projection.

In Section Instructions Examples Basics History Extra

DisconnectFromComosSystem

DisConnectFromComosSystem() as Boolean

Required for changing the system project. The connections to the system project are
stored and separated as symbolic names. They are restored with
ConnectWithComosSystem after a system project change.
In Section Instructions Examples Basics History Extra

DisposeAllModules

DisposeAllModules ( )

For internal use. Is part of control of COMOS Web.

In Section Instructions Examples Basics History Extra

DocumentVersion

DocumentVersion() as Long

The DocumentVersion set in the database (the documents are written in this
version).

In Section Instructions Examples Basics History Extra

DragObject

DragObject() as Object

Clipboard for Drag operations.

In Section Instructions Examples Basics History Extra

ErrorText

ErrorText(Val as Long) as String

Returns the error text for the specified error code.

In Section Instructions Examples Basics History Extra

Escape

Escape ( ByVal inputString as String, ByVal dbType as Long ) as String

Parameter inputString as string

String with the characters for which Escape is to be executed

Parameter dbType as long

Type of used database. See constants in Module "DbType".

This method creates an Escape sequence for an SQL statement that is sent to the
COMOS database. It makes it possible to use special characters in the string of the
SQL statement.

In Section Instructions Examples Basics History Extra

ExecuteCopyFrom
ExecuteCopyFrom() as Object

Used when copying structures, accepts the objects of the CopyTree into the current
project.

In Section Instructions Examples Basics History Extra

ExportDatabase

ExportDatabase(Val1 as Object, Val2 as String, Val3 as String)

Creates an exact copy of the project data in the specified database. All projects
are copied if the project parameter is Null. The login syntax corresponds to that
of the Workset.Init.

In Section Instructions Examples Basics History Extra

ExportDatabaseWithDBSync

ExportDatabaseWithDBSync(Val1 as Object, Val2 as String, Val3 as String)

Behaves in the same way as ExportDatabase, but in this case the source and the
target are also marked to allow subsequent synchronization by means of
ImportDatabaseWithDBSync. All projects are exported if the project parameter is
Null, the login process is the same as for Workset.Init, and Syncname is the name
of the target database.

In Section Instructions Examples Basics History Extra

ExportDatabaseWithoutDeleted
ExportDatabaseWithoutDeleted(Val1 as Object, Val2 as String, Val3 as String)

Behaves in the same way as ExportDatabase, except in this case no entries with
DeleteFlag = True are considered.

In Section Instructions Examples Basics History Extra

ExportDB

ExportDB(Val as Object)

Assumes the task of the ExportDatabase functions.

In Section Instructions Examples Basics History Extra

ExtentedCopyRightForCurrentUser

ExtentedCopyRightForCurrentUser(Project as Object) as Boolean

Tests whether the CurrentUser has all rights in the specified project (Read, Write,
Delete, Create).

In Section Instructions Examples Basics History Extra

FinishAOWM
FinishAOWM ( ByVal answer as String )

Parameter answer

For internal use. Is part of control of COMOS Web.

In Section Instructions Examples Basics History Extra

FPXmlDBScheme

string FPXmlDBSchema

Property of type string: Contains the database scheme of the FreeProperty tables as
XML structure.

In Section Instructions Examples Basics History Extra

FTIndexUpdater

FTIndexUpdater([in] BSTR CommandLine, [out, retval] long *pVal)

Starts FTIndexUpdater.exe with the appropriate command line. Returns the process ID
of the started process.

In Section Instructions Examples Basics History Extra

GetAllNumberRangeGenerators
IComosDOwnCollection GetAllNumberRangeGenerators()

Returns a collection of all NumberRangeGenerators defined in the database.

Return value: Collection of type IComosDOwnCollection with objects of type

IComosDNumberRangeGenerator.

In Section Instructions Examples Basics History Extra

GetAllProjects

GetAllProjects() as IComosDOwnCollection

Returns all projects defined in the database. Start function into the object
hierarchy.

In Section Instructions Examples Basics History Extra

GetAllUserGroups

GetAllUserGroups() as IComosDOwnCollection

Returns all user groups.

In Section Instructions Examples Basics History Extra

GetAllUsers

GetAllUsers() as IComosDOwnCollection

Returns all users.

In Section Instructions Examples Basics History Extra

GetBaseObjectCollection

GetBaseObjectCollection() as IComosBaseObjectCollection

Returns an instance of the IComosBaseObjectCollection class. This is the only way

of receiving an IComosBaseObjectCollection. This type of Collection represents the
fastest type of Collection in COMOS.

In Section Instructions Examples Basics History Extra

GetCachedTempCollection

GetCachedTempCollection() as IComosDCollection

Returns a TempCollection that must be used for multiple selection with the
Clipboard.

In Section Instructions Examples Basics History Extra

GetCallstack
string GetCallstack()

Returns a String which reflects the current CallStack. For this purpose, COMOS
logging must take place in DEBUG (/DG:D) mode or internal debug mode (environment
variable ComosDebug) must be enabled; otherwise, only an empty string will be
returned.

Return value: Multi-line String with as much information about all current
Stackframes as possible.

In Section Instructions Examples Basics History Extra

GetChangeLogger

GetChangeLogger([out, retval] LPDISPATCH* changeLogger)

Returns a reference to a component that implements ChangeLogging.

In Section Instructions Examples Basics History Extra

GetConsolidationUpdate

GetConsolidationUpdate ( ByVal pathToArchive as String ) as IComosDUpdate

Parameter pathToArchive as string

Path to zip file with database update.

Objective: Database update by means of script.

Process:

Requirement: a zip file with database update is available.

Initialization of the IComosDUpdate object from the workset with the

GetConsolidationUpdate method. Transfer of the path to the zip file by means of
pathToArchive.

The zip file is unzipped and the contents are available at the IComosDUpdate
object.

As long as the Import method is not triggered at the IComosDUpdate object, you can
select a different zip file. SetArchivePath is called at the IComosDUpdate object
for this purpose.

If the Import method is used at the IComosDUpdate object, the update is imported
into the database for consolidation but it is not installed yet.

The GetConsolidationUpdate method is called at the workset with an empty string.

This step returns the consolidated update object. The update objects includes the
version, the description as well as the methods required for installation of the
database update.

In Section Instructions Examples Basics History Extra

GetCopyManager

GetCopyManager() as IComosDCopyManager

Factory (creation option) for ComosDCopyManager.

In Section Instructions Examples Basics History Extra

GetCTISession
Comos_Tc_Integrator::IComosTcSession GetCTISession()

Returns a reference to the component that takes care of TeamCenter integration in

COMOS.

Return value: Reference to a component of type

Comos_Tc_Integrator::IComosTcSession.

In Section Instructions Examples Basics History Extra

GetCurrentProject

GetCurrentProject() as IComosDProject

Returns the current project; changes are only permitted in this project.

In Section Instructions Examples Basics History Extra

GetCurrentTimestamp

GetCurrentTimestamp() as IComosDTimestamp

Returns the current Timestamp; upon saving it is written to the related objects as
CS or RS. One timestamp per user, per project and per day is managed. (Exception:
Revisioning of documents)

In Section Instructions Examples Basics History Extra

GetCurrentUpdate

GetCurrentUpdate ( ) as IComosDUpdate

Returns the object with the database update.

Returns NULL if no database update is available.

In Section Instructions Examples Basics History Extra

GetCurrentUser

GetCurrentUser() as IComosDUser

Returns the current user; no current project can be set without this.

In Section Instructions Examples Basics History Extra

GetD3BinaryString

GetD3BinaryString(Object As Object) as String

Returns from the specified object a string that contains the data of the 3D object
in encrypted form. See BuildD3FromBinaryString.

In Section Instructions Examples Basics History Extra

GetDateTimeFromUID

GetDateTimeFromUID(UID as String) as Double

Determines the time and date from an UID. The return value can be converted into a
date format object by using CDate.

In Section Instructions Examples Basics History Extra

GetDBDirectory

GetDBDirectory() as String

Returns the path in which the database is located.

In Section Instructions Examples Basics History Extra

GetDBInfo

string GetDBInfo()

Returns a string that contains information on the currently used database (same
information that is also transmitted to other stations by means of CVS).

In Section Instructions Examples Basics History Extra

GetDBName
GetDBName() as String

Returns the database name.

In Section Instructions Examples Basics History Extra

GetDragOcx

GetDragOcx() as Object

Returns the OCX that was set with WorkSet.SetDragObjectWithOcx. Enables access to
the environment from which the Drag object originated.

In Section Instructions Examples Basics History Extra

GetExportManager

GetExportManager() as Object

Factory (creation option) for IComosDExportManager

In Section Instructions Examples Basics History Extra

GetFileAttribute

GetFileAttribute(file as String, name as String, value as Variant) as Boolean

Reads the CustomProperty specified by name of the file specified by the file. The
value of the Property is written to value.

If the function fails, FALSE is returned; otherwise TRUE is returned.

In Section Instructions Examples Basics History Extra

GetFileProperties

GetFileProperties([in] BSTR fileName, [out,retval]IComosDFileProperties** retVal)

Returns an instance of IComosDFileProperties for a file name. For further

information, see IComosDFileProperties.

In Section Instructions Examples Basics History Extra

GetFPAllowedColumnTypes

Variant GetFPAllowedColumnTypes()

Returns all permitted data types for FreeProperty columns as string array in a
variant object.

In Section Instructions Examples Basics History Extra

GetFPAllowedColumnTypesFor

Variant GetFPAllowedColumnTypesFor(string typeName, long size)

Returns all permitted data types to which an existing FreeProperty column may be
converted.

Return value: String array containing the permitted data types

Parameter "typeName": Existing data type.

Parameter "size": Existing size of the current column if available, otherwise -1.

In Section Instructions Examples Basics History Extra

GetFPsForGroup

Variant GetFPsForGroup(string groupName)

Returns the name of all FreeProperties for a specific FreeProperty group, i.e., the
names of all FreeProperty columns as string array.

In Section Instructions Examples Basics History Extra

GetFPGroups

Variant GetFPGroups()

Returns all names of existing FreeProperty groups as string array.

In Section Instructions Examples Basics History Extra

GetGeneralCollection

GetGeneralCollection(/*[out,retval]*/ IComosDGeneralCollection** retVal);

Returns a new instance of IComosDGeneralCollection.

In Section Instructions Examples Basics History Extra

GetMemoryUsage

long GetMemoryUsage()

Returns the current memory usage of COMOS in bytes. Corresponds to the value
"private bytes" in the ProcessExplorer tool.

Return value: Number of bytes currently used by COMOS in the main memory.

In Section Instructions Examples Basics History Extra

GetNumeric

GetNumeric(value as String) as Double

Converts a String, into a Double in accordance with the conventions of the current
project language and with the group and decimal delimiters taken into account.

In Section Instructions Examples Basics History Extra

GetOldOwnerOfMovingObject

IComosBaseObject GetOldOwnerOfMovingObject([in] IComosBaseObject movingObject)

This method can be used to determine whether a new object has been copied or moved.
Provided a moved object has not yet been added to the new owner, you can call this
method to query the former owner.

Return value: Former Owner of an object which has just been moved. NULL is returned
if the object has not bee moved at all, or if it has already been added to the new
owner.

In Section Instructions Examples Basics History Extra

GetOverlayParameter

GetOverlayParameter() as IComosDOverlayParameter

Returns an IcomosDOverlayParameter object, for use in ReleaseOverlayEX (among other

locations).

In Section Instructions Examples Basics History Extra

GetPerformanceValues

GetPerformanceValues(resourceType as Long) as Double

Returns kernel system values.

For the resourceType parameter, constants with the prefix Performance_Value_ are
available.

In Section Instructions Examples Basics History Extra

GetProjectionErrorText

GetProjectionErrorText(Val as Long) as String

Used with Copy structure. Returns the error text if a projection failed.

In Section Instructions Examples Basics History Extra

GetProjectionMode

GetProjectionMode(Val as Object) as Long

Used with Copy structure. Not used up to now; intended to be used for different
projection modes.

In Section Instructions Examples Basics History Extra

GetProjectionObject

GetProjectionObject(Val as Object) as Object

Used with Copy structure. Returns the projected object for the relevant object.
In Section Instructions Examples Basics History Extra

GetResources

GetResources(ResourceType as Long) as Long

Returns the number of GDI or USER objects used at the machine. This applies to the
current COMOS application on the one hand and to the entire system on the other.

The parameter must be one of the following constants:

Resource_Type_GUI_Current_Process

Resource_Type_GUI_All_Processes

Resource_Type_User_Objects_Current_Process

Resource_Type_User_Objects_All_Processes

Programs that use GDI resources (such as COMOS) become unstable from approximately
10,000 Handles. A flickering screen and sluggish performance in Windows point to
this problem.

If this happens, you can change the registry settings at your own risk.

The following registry value (DWORD) needs to be created or adapted in order to

define the number of permitted GDI processes: HKEY_LOCAL_MACHINE\SOFTWARE\
Microsoft\WindowsNT\CurrentVersion\

Windows\GDIProcessHandleQuota

Maximum setting: 16.384 (0x00004000).

The following registry value (DWORD) needs to be created or adapted in order to

define the number of permitted NT users:

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\WindowsNT\CurrentVersion\

Windows\USERProcessHandleQuotaMaximum setting: 18,000 (0x00004650).

COMOS automatically detects when the user reaches the limit of their PC's graphical
resources, and generates a warning. When this warning appears, you can specify the
following in the registry of the computer:

HKEY_CURRENT_USER/Software/Innotec/Comos/ComosExe/Comos/

MaxGDIRessourceCount

Administrators can change this value, although they do so at their own risk. The
default setting is 9000 (of 12000 at maximum capacity depending on the operating
system).

The settings take effect after the next restart.

See also the COMOS manual, "Unloading all dynamic icons".

In Section Instructions Examples Basics History Extra

GetRootsOfTemplates

void GetRootsOfTemplates(IComosDCollection templateMembers)

Groups members of assemblies in the transferred collection. When transferred, the

Collection must contain one or more members of any assembly. All Root objects,
including the "TemplateMain" objects (target of the @TplM pointer, DeviceClass
"GROUP") are added to the Collection. The objects that were included at the
beginning are always retained at the original position.

Return value: Collection which contains all additional members of assemblies, in

addition to the objects that were intially included.

In Section Instructions Examples Basics History Extra

GetScanManager
GetScanManager() as IComosDScanManager

Factory (creation option) for IComosDScanManager. Returns an instance of this

class.

In Section Instructions Examples Basics History Extra

GetScriptHelper

GetScriptHelper([out, retval] LPDISPATCH* scriptHelper)

Returns a reference to the ScriptHelper, which in many scripts can be accessed

under the variable name Info.

In Section Instructions Examples Basics History Extra

GetSearchManager

GetSearchManager(/*[out,retval]*/ IComosDSearchManager** retVal);

Returns a new instance of IComosDSearchManager.

In Section Instructions Examples Basics History Extra

GetSourceObject
GetSourceObject(byVal obj as Object) as Object

Returns the original during a copy process for a specified object; i.e. the object
from which the specified object was created.

In Section Instructions Examples Basics History Extra

GetStatusManager

GetStatusManager() as Object

Factory (creation option) for IComosDStatusManager.

In Section Instructions Examples Basics History Extra

GetString

GetString(value as Double, precision as Long) as String

Converts a Double into a String in accordance with the conventions of the current
project language and with the group and decimal delimiters taken into account.
Precision has an effect on the number of decimal places; Precision = -1 means that
the number of decimal places remains the same.

In Section Instructions Examples Basics History Extra

GetTempCollection
GetTempCollection() as IComosDCollection

Returns a TempCollectionObject. Do not use this in combination with Clipboard

actions! UseClipboard GetCachedTempCollection!

In Section Instructions Examples Basics History Extra

GetTimestampWatcherObject

GetTimestampWatcherObject(retVal as Object)

Returns the object with the highest (newest) timestamp since the activation of
TimestampWatcher.

In Section Instructions Examples Basics History Extra

GetUserValueForKey

string GetUserValueForKey([in] string user, [in] string key)

Used in conjunction with license management. A value can be queried for a certain
User and a certain Key.

The following list contains the possible keys that can be transferred to the method
GetUserValueForKey, and the corresponding return values:

PACKAGE

<Empty string> | Name of the package to which the login is assigned

USERLICENSES

<Empty string> | <License1>#<Number checked out>;…; <LicenseN>#<Number checked out>

ISACTIVE

<Empty string> | oldest login date as an OLE Automation Date (double value)

In Section Instructions Examples Basics History Extra

GetUseScriptFunctions

GetUseScriptFunctions() as Boolean

The Boolean value shows whether the internal script functions of COMOS are called.

In Section Instructions Examples Basics History Extra

GetUsersByState

GetUsersByState([in] VARIANT_BOOL active, [out,retval]IComosDCollection** retVal)

Returns a Collection that contains all active and inactive users. You can use the
parameter active to control the amount that is to be returned.

In Section Instructions Examples Basics History Extra

GetWatchedRevisionOf

GetWatchedRevisionOf(Val as Object) as IComosDDevice

Comparison of the revision status of the relevant document with the newest
(highest) Timestamp of the monitored objects. See also Chapter
ActivateTimestampWatcher.

Timestamp of the revision object >= Timestamp of the newest object on the document

> everything OK, revision object is the return value of the function.

Timestamp of the revision object < Timestamp of the newest object on the document

> automatic creation of a new revision.

If an old revision has not been completed yet, i.e., it has not been released yet,
it is deleted and a new one is created.

In Section Instructions Examples Basics History Extra

GetWatchedSoftDeleteFlag

GetWatchedSoftDeleteFlag() as Boolean

Returns the result of the SoftDelete monitoring (see

IcomosBaseObject.GetSoftDeleteFlag, see IcomosDWorkset.ActivateSoftDeleteWatcher).
If the result is TRUE, this means an object was found that has the status
SoftDelete.

In Section Instructions Examples Basics History Extra

GetWatchedTimestamp

GetWatchedTimestamp() as String

Returns the newest (highest) Timestamp of all objects that have been investigated
since the start of ActivateTimestampWatcher.
In Section Instructions Examples Basics History Extra

GetWorkingOverlayFullFileName

string GetWorkingOverlayFullFileName([in] string FullFileName, [in] bool write)

This method is an easy tool for determining file names for documents in layers. A
file name for an existing document inside the COMOS document directory must be
entered. For reading purposes (parameter write is set to false), the method returns
the file name of the first document found, starting from the current layer and
moving in the direction of the project. This is the valid file in the current
layer, so to speak. For writing purposes (parameter write is set to true) the file
name of the transferred document file is returned in such a way that it belongs to
the current layer and can, therefore, be used directly for writing.

Parameter FullFileName: File name of an existing document file

Parameter write: Specifies whether you want to read the document file in the
currently valid version (parameter set to false) or whether you want to write the
file in the current layer (e.g. when checking into the current layer) (parameter
set to true).

Return value: File name of the document, if it is valid for the current layer for
either reading or writing. If the same file name is returned that was also entered
as the parameter FullFileName, then the document file is either not found or you
are not currently in a layer.

In Section Instructions Examples Basics History Extra

GetXObjBinaryString

GetXObjBinaryString(Object As Object) as String

Returns a String for the specified object, which contains the data of the XObject
in encrypted form. See also Chapter BuildXObjFromBinaryString.
In Section Instructions Examples Basics History Extra

Globals

Globals() as Object

Case-insensitive

Globals is a variable memory of type IPLTVarstorage. Caution: Variables are created

during the access!

Example : Workset.Globals.Helptext = "ABC" creates the variable Helptext. Please

note that read access Print Workset.Globals.Helptext generates the same variable.
For this reason, you must always first check for the existence of a variable using
Globals.Exist("Variablenname").

In Section Instructions Examples Basics History Extra

HasGlobalOverflowOccurred

HasGlobalOverflowOccurred ( ) as Boolean

True: So many external changes of objects have been registered that the GUI should
be updated.

False: In all other cases.

Auxiliary method in connection with ChangedObjectsOverflow.

This method is only responsible for the status. An update is not triggered
automatically. The update is triggered upon request, see
SetOverflowForAllChangedObjects.
In Section Instructions Examples Basics History Extra

HashTableSize

HashTableSize() as Long

Determines the size of the Hash table (Cache).

In Section Instructions Examples Basics History Extra

HideProgressBar

HideProgressBar() as IComosDProgressBarHider

This method returns an IComosDProgressBarHider object. This means that the progress
bar is hidden until the object is released.

See also chapter IComosDProgressBarHider.

In Section Instructions Examples Basics History Extra

HistoryRemark

HistoryRemark() as String

All history entries that are created get this property as a remark.

The value that had been valid at the point in time that the history entry had been
created is used. The value can be changed as often as desired.

In Section Instructions Examples Basics History Extra

ImportFromDatabaseWithDBSync

ImportFromDatabaseWithDBSync(Val1 as Object, Val2 as String)

Synchronizes projects from different databases that had previously been exported
with ExportDatabaseWithSync. Parameter values and syntax ExportDatabaseWithDBSync.
The login database wins in the event of a collision!

In Section Instructions Examples Basics History Extra

ImportWorkingProjectFromOtherDB

ImportWorkingProjectFromOtherDB(source_project_uid as String, pathtomdb as String,

dest_cdev_project as Object) as IComosDCollection

Import function based on the current database.

Parameter 1: Source project UID

Parameter 2: Path to the source database

Parameter 3: Target base data project

In Section Instructions Examples Basics History Extra

Init

Init(Val1 as String, Val2 as String, Val3 as String) as Boolean

Database connection:

Parameter: User ID (currently not used)

Parameter: Password (currently not used)

Parameter: Database path

ACCESS MDB: Path details to the database

SQL Server: [SQL - SERVER]pt_sql_server

Oracle: [ORACLE]pt_oracle

Note "pt_sql_server" and "pt_oracle" are data source names. The data sources must
be set up correctly!

In Section Instructions Examples Basics History Extra

InitAOWM

InitAOWM ( ) as String

For internal use. Is part of control of COMOS Web.

In Section Instructions Examples Basics History Extra

InitChangedObjects

InitChangedObjects(Val as Long) as Long

Reports a ChangedObjectsCollection to ChangedObjects ChangedObjectsOverflow. The

parameter determines the number of objects from which an overflow is to be created.
Maximum number 250.

In Section Instructions Examples Basics History Extra

InitString

InitString() as String

Parameter 3 of the last Inits is read out. This Init String can be used for
subsequent reinitialization of the workset.

In Section Instructions Examples Basics History Extra

InitWithFullConnectionString

InitWithFullConnectionString ( Val1 as String, Val2 as Long ) as Boolean

Parameter Val1 as string

ConnectionString which defines the connection to the DB.

Example 1:

"SERVER=MD11W1ZC;DATABASE=Comos_10_1_ClassicDB;USER ID=comos;PWD=;"

Example 2:
"D:\\ComosDB\\ComosDB_10_1\\ComosDb.mdb""D:\\ComosDB\\ComosDB_10_1\\ComosDb.mdb"

Parameter Val2 as string

Type of the database. Database type is specified according to the constants in

Module "DbType".

For internal use.

Alternative method to initialize the workset.

The database is specified as ConnectionString without the use of DataSources. Not

all COMOS functions are available with this initialization. The method is used for
integration tests.

In Section Instructions Examples Basics History Extra

IsAllSaved

IsAllSaved() as Boolean

Set to FALSE if objects in the memory are changed.

In Section Instructions Examples Basics History Extra

IsInitialized

IsInitialized() as Boolean

Upon successful initialization of the Workset TRUE. In the case of FALSE, almost
all the Workset methods are blocked.
In Section Instructions Examples Basics History Extra

IsInsertReferenceEnabled

IsInsertReferenceEnabled() as Boolean

Checks whether the ClipboardObject can be inserted as a reference.

In Section Instructions Examples Basics History Extra

IsMaxLoadedObjectsReached

IsMaxLoadedObjectsReached ( ) as Boolean

True: The number of objects is 90% of MaxLoadedObjects or higher.

False: In all other cases.

In Section Instructions Examples Basics History Extra

IsNumericForCurrentLanguage

bool IsNumericForCurrentLanguage([in] string numStr)

Checks whether the specified String contains correct floating-point numbers

(including E notation). Only the decimal and thousands delimiters of the language
currently in use will be accepted (as opposed to IsNumeric, where dots and commas
are accepted).
Return value: true if the transferred string contains a syntactically-correct
floating-point number, otherwise false.

In Section Instructions Examples Basics History Extra

IsSolidBaseDb

IsSolidBaseDb as Boolean

Return value

True: The current database is a SolidBase database (iDB).

False: In all other cases.

Used to determine whether there is a connection to a SolidBase database or not.

In Section Instructions Examples Basics History Extra

IsTerminalServer

IsTerminalServer() as Boolean

Shows whether you are on a Terminal server (e.g. Citrix server).

In Section Instructions Examples Basics History Extra

LastErrorNumber

LastErrorNumber() as Long

Returns the error code of the last Check, CheckDelete or InheritCheckIn operation.
You receive the error text with Workset.LastErrorText.

In Section Instructions Examples Basics History Extra

LastErrorObject

LastErrorObject() as Object

Erroneous object of the last Check, CheckDelete or InheritCheckIn operation.

In Section Instructions Examples Basics History Extra

LastErrorText

LastErrorText() as String

Error message of the last Check, CheckDelete or InheritCheckIn operation.

In Section Instructions Examples Basics History Extra

Lib
Lib() as Object

Lib DLL. The Dynamic Link Library is the start point for a number of script
functions.

In Section Instructions Examples Basics History Extra

LicenseRuntimeCheck

LicenseRuntimeCheck() as Boolean

Periodic query to see if the dongle is still in place and valid.

In Section Instructions Examples Basics History Extra

LicenseServer

string LicenseServer

Property of type String which contains the license server to be used. The String
must be in the form <server>[:port][;<back server>[:port]]; i.e. the port is
optional (default value is 27011) and the backup server is also optional.

In Section Instructions Examples Basics History Extra

LicenseToken
void LicenseToken([in] string newVal)

Description: Internal license management method.

In Section Instructions Examples Basics History Extra

LoadObject

LoadObject(Val1 as String, Val2 as String) as Object

Returns the object of the class specified by type and with the specified UID.

Example

LoadObject("CDevice", UID)

Old version; LoadObjectByType is better and faster.

In Section Instructions Examples Basics History Extra

LoadObjectByType

LoadObjectByType(Type as Long, UID as String) as Object

Returns the object of the class specified by type and with the specified UID.

Example

LoadObjectByType(SytemTypeCDevice,UID)

New form, quicker thanks to use of COMOS system constants SystemType

In Section Instructions Examples Basics History Extra

LockPermission

LockPermission(obj as Object) as Boolean

Shows whether you are permitted to change the Lock/SystemLock property at the
transferred object. This property is required, since you lose all rights to change
this object by system definition after setting a lock and thus would be unable to
remove the lock again.

In Section Instructions Examples Basics History Extra

LogoCad

LogoCad() as Boolean

Boolean as to whether or not you are running under LogoCad (correspondingly out).

In Section Instructions Examples Basics History Extra

MaxLoadedObjects

MaxLoadedObjects() as Long

The number of objects from which the objects are removed from the memory with
SaveAll and ReleaseObjects. See also Chapter ReleaseObjects.
In Section Instructions Examples Basics History Extra

MemoryDump

MemoryDump(Val as String)

Only for the Debug DLL. The Dump process is performed in a suitable, specified
file.

In Section Instructions Examples Basics History Extra

MessageBoxHandler

IMessageBoxHandler MessageBoxHandler

Property of the type IMessageBoxHandler. Can be used to intercept message boxes and
process the messages in a different way. For this purpose, you have to create a
class that implements the IMessageBoxHandler interface. You also have to register
an instance of this class in this MessageBoxHandler property.

If a new MessageBoxHandler is registered, all outputs that usually appear as a

MessageBox on the interface are sent to the instance registered in this property
using the ShowMessageBox method.

In Section Instructions Examples Basics History Extra

ModuleLicense

ModuleLicense(Val as Long) as IComosDModulManager

ModuleManager object. If the object is returned, the associated module is checked

out. See also Chapter ComosModule.
In Section Instructions Examples Basics History Extra

ModuleLicenseCheckedOut

ModuleLicenseCheckedOut(long lmodule) as boolean

Tests whether the specified module has already been checked out (licenses). As
opposed to ModuleLicense, this function also checks out the specified module (if
available).

In Section Instructions Examples Basics History Extra

NewComosUID

NewComosUID() as String

Returns a newly-created COMOS UID.

In Section Instructions Examples Basics History Extra

NotifyAboutChangedUIDs

NotifyAboutChangedUIDs(iXmlIDoc as LPDISPATCH)

Parameter iXmlDoc
Auxiliary method in connection with NewCVS. The ServiceBroker uses this interface
to report changes of COMOS object to the kernel.

This method is used by Global Collaboration Service Broker. The Service Broker
calls the method and passes on an XML document with UIDs to be processed by COMOS.
This method replaces the CVS messages that would not have reached all COMOS
stations in case of Global Collaboration.

In Section Instructions Examples Basics History Extra

ObjectCount

ObjectCount() as Long

Number of objects that are currently in the memory.

In Section Instructions Examples Basics History Extra

ObjectsWithoutProjection

ObjectsWithoutProjection() as IComosDCollection

Functionality for Copy Structure. Returns the objects from the CopyTree without
projection.

In Section Instructions Examples Basics History Extra

PackageLicense
bool PackageLicense()

Checks out the package of licenses assigned to the current user.

Return value: TRUE if the procedure was successful, otherwise FALSE.

In Section Instructions Examples Basics History Extra

POptions

POptions() as Object

Dll, used for the temporary storage of parameters.

In Section Instructions Examples Basics History Extra

ReferencedObjectCount

ReferencedObjectCount() as Long

Number of objects in memory that are referenced by the application. These objects
are not removed from memory.

In Section Instructions Examples Basics History Extra

ReferencedObjects
ReferencedObjects() as IComosDCollection

Returns a Collection with all objects that have not been referenced by the COMOS
internal cache alone.

In Section Instructions Examples Basics History Extra

RefreshRights

RefreshRights()

Sets the rights for all objects in the memory to not initialized. The function is
to be called after each deletion, creation or editing of rights objects.

In Section Instructions Examples Basics History Extra

ReleaseAllObjects

ReleaseAllObjects()

As with ReleaseObjects. In this case, however, MaxLoadedObjects is not evaluated.

See also Chapter ReleaseObjects.

In Section Instructions Examples Basics History Extra

ReleaseChangedObjects
ReleaseChangedObjects(Val as Long)

Logs out the list logged in with InitChangedObjects. See also Chapter
ChangedObjects.

In Section Instructions Examples Basics History Extra

ReleaseObjects

ReleaseObjects()

Under certain circumstances this deletes from memory all objects that are no longer
referenced. This is an important functionality to keep the need for main memory
under control when importing, for example.

The topic "Releasing objects" is covered in detail in the COMOS Manual, in the
chapter titled Database administration: System Monitor.

In Section Instructions Examples Basics History Extra

ReleaseStaticCollections

ReleaseStaticCollections()

Releases the StaticCollections for all objects in the memory. For performance
reasons, the Collections inherited from engineering objects are managed in these
StaticCollections, since this means that they do not have to be recalculated each
time. Changes in the base data only become visible once this method is called up in
the planning view.

In Section Instructions Examples Basics History Extra

RemoveFromChangedObjects
RemoveFromChangedObjects(Object As Object, Index As Long)

Removes the specified object from the ChangedObjects Collection with the specified
index.

See also

ChangedObjects

AddToChangedObjects

In Section Instructions Examples Basics History Extra

RemoveProcessInfo

RemoveProcessInfo([in] long ProcessID)

Has to be called after calling FTIndexUpdater in order to release the used

resources of the new process again.

In Section Instructions Examples Basics History Extra

RemoveProjections

RemoveProjections(Val as Object)

Method for copying structures that removes projections (for the object and all
secondary objects).
In Section Instructions Examples Basics History Extra

ResetUsers

ResetUsers(users as object)

All user objects apart from @SETUP and ComosSystemUser in the users Collection are
deleted in order to clean out the databases supplied.

In Section Instructions Examples Basics History Extra

ResetUsersEx

ResetUsersEx(users as Object, user as Object)

Has the same effect as ResetUsers, but reassigns all existing timestamps back to
the specified User.

In Section Instructions Examples Basics History Extra

RevisionCheck

RevisionCheck(Name as String, owner as Object) as Boolean

Checks whether there already is a revision with the specified name under the
specified owner in any layer of this project.
In Section Instructions Examples Basics History Extra

RootDir

RootDir() as String

Document directory path for server databases.

In Section Instructions Examples Basics History Extra

RunDatabaseMaintenance

RunDatabaseMaintenance([in] long operations, IComosBaseObject* object)

Part of the database maintenance functions. See also ComosSystemConstants.

In Section Instructions Examples Basics History Extra

SaveAll

SaveAll()

Saves all deleted or amended objects in memory; it is essential to call CheckAll

beforehand. If there are more objects in the memory than the number specified in
MaxLoadedObjects, all those that are no longer referenced are deleted.

In Section Instructions Examples Basics History Extra

Scan

Scan(Val as Object) as IComosDCollection

Conducts a scan in accordance with the ScanManager object transferred by Val, and
returns a COMOS Collection. See also IComosDScanManager.

The Scan function replaces all ScanDevices functions, i.e. ScanDevices,

ScanDevicesWithCObject, ScanDevicesWithCObjectX and ScanDevicesX.

Main advantages

Scan is faster and provides more control options. All ScanDevices functions
continue to be supported, however.

In Section Instructions Examples Basics History Extra

ScriptErrorHandler

ScriptErrorHandler() as Object

Auxiliary object that can be docked onto any ScriptEngine to allow error handling
to be provided if required.

In Section Instructions Examples Basics History Extra

SendCVSMessagesWithOldStyle

SendCVSMessagesWithOldStyle(val as Boolean)

Parameter val as boolean

True: CVS messages are being sent

False: In all other cases.

Auxiliary method in connection with NewCVS.

If NewCVS is active in the database, COMOS is no longer sending CVS messages.

SendCVSMessagesWithOldStyle causes old CVS messages to be sent in addition to the

new system.

If NewCVS is inactive, SendCVSMessagesWithOldStyle has no effect and CVS messages

are sent all the time.

In Section Instructions Examples Basics History Extra

SetCurrentProject

SetCurrentProject(Val as Object)

Sets the current project, data can only be created or amended in this one. A
CurrentUser must be logged in already in order to set a project.

In Section Instructions Examples Basics History Extra

SetCurrentUser

SetCurrentUser(Val as Object)

Sets the current user to which rights administration and the error list applies.
See also Chapter ErrorObjectsCount.
In Section Instructions Examples Basics History Extra

SetCurrentUserWithAuthentication

SetCurrentUserWithAuthentication([in] LPDISPATCH user, [in] BSTR domain, [in] BSTR

password, [out, retval] VARIANT_BOOL* result)

Setting a new User as the current User in COMOS. The special feature of this method
is that the User to be set does not necessarily have to be signed in as a Windows
User (in the same way as with SetCurrentUser).

Parameter

User:

Type IComosDUser; User to be set.

Domain:

Type string: the Windows domain in which the user account is valid (should a local
account be used, the point has to be handed over as domain: ".")

Password:

Type string: Password of the user account

Return value:

TRUE if login was successful, otherwise FALSE.

In Section Instructions Examples Basics History Extra

SetDragObjectWithOcx
SetDragObjectWithOcx(Val1 as Object, Val2 as Object)

Sets DragObject (=>) and DragOCX (=>).

In Section Instructions Examples Basics History Extra

SetFileAttribute

SetFileAttribute(file as String, name as String, value as Variant) as Boolean

Sets CustomProperties for the file specified by file. The property name is set to
the value specified with value.

As with all methods of the Comos.dll: Automatically uses the NetworkLogin.

In Section Instructions Examples Basics History Extra

SetOracleMemoFieldLength

SetOracleMemoFieldLength()

Changes the length of the text fields stored in Oracle to 512 characters
(previously 2,000). This gives faster results when making queries. Values that
exceed this length (generally only very few in relation to the overall number) will
continue to be placed in an additional table by using the previous system.

In Section Instructions Examples Basics History Extra

SetOverflowForAllChangedObjects
SetOverflowForAllChangedObjects ( )

Auxiliary method to control the update of user interfaces (especially the

Navigator). This method only has an effect if ChangedObjectsOverflow is active.

When ChangedObjectsOverflow is active, the changed objects from external sources

are not automatically reloaded. This means GUIs, especially the Navigator, are not
constantly updated. Instead the changed objects are first collected and a red
button becomes visible in the GUI.

If SetOverflowForAllChangedObjects is called, all externally changed objects are

once again treated as internal changes. This means the external overflow (which has
generated the red button) is turned into an internal overflow. The GUI is updated
and the button turns green again.

SetOverflowForAllChangedObjects is also called when you click the red button.

In Section Instructions Examples Basics History Extra

SetProjection

SetProjection(Val1 as Object, Val2 as Object) as Long

Functionality for Copy Structure. Creates a projection between an object from the
CopyTree and an object from the current project.

In Section Instructions Examples Basics History Extra

SetProjectionWithMode

SetProjectionWithMode(Val1 as Object, Val2 as Object, Val3 as Long) as Long

Only existent due to compatibility reasons, is not used anymore. Used to control
the different project modes of Copy structure.
In Section Instructions Examples Basics History Extra

SetRunMode

SetRunMode(Val as Long)

Mode to determine whether you are running under CORA.

In Section Instructions Examples Basics History Extra

SetTrLangDB

void SetTrLangDB([in] ComosTrLangDB::TrLangDB dllTrLangDB)

This method enables the component for automatic translation to be made known at
Workset; calls for translation are then passed on to this.

Parameter dllTrLangDB: Pointer to the instance of the translation component.

In Section Instructions Examples Basics History Extra

SetUseScriptFunctions ( Val as Boolean )

SetUseScriptFunctions

Activates (True) or deactivates (False) the call of all script functions in COMOS.
This is necessary for performance reasons when transferring large amounts of data.
In Section Instructions Examples Basics History Extra

SetUseValidationService

SetUseValidationService(Val as Boolean)

Changes the use of the COMOS Cache Validation Service.

The use of the Cache Validation Service (CVS) can also be enabled or disabled at
the workset during on ongoing COMOS session (which means also after the workset
initialization).

In Section Instructions Examples Basics History Extra

SetWatchedTimestamp

SetWatchedTimestamp(Val as String)

Sets the base UID for TimeStampWatcher. See also Chapter ActivateTimestampWatcher.

In Section Instructions Examples Basics History Extra

ShutdownXObjs

ShutdownXObjs()

For each loaded object that also owns a loaded XObject, this calls the method
Shutdown on the XObject.
In Section Instructions Examples Basics History Extra

SimpleCDeviceChange

SimpleCDeviceChange() as Boolean

Toggles whether or not the extended functionality is to be executed when changing

base objects (CDeviceChange). Can be switched off for performance reasons (e.g. for
imports).

In Section Instructions Examples Basics History Extra

SingleReleaseStaticCollections

SingleReleaseStaticCollections(Object as Object)

Member of: Plt.IComosDWorkset

Releases the static Collections for ONE object, as opposed to

ReleaseStaticCollections, which releases the static Collections for ALL objects.
The "inheritance collections" are kept in the static Collections; e.g. the
Specifications at the Device. If any changes are made in the base object tree, this
StaticCollection must be refreshed by means of the specified method.

In Section Instructions Examples Basics History Extra

Site

Site() as String

Property for the location from which this session was started.
In Section Instructions Examples Basics History Extra

SMSInfo

SMSInfo() as String

Information on all users in the CVS.

In Section Instructions Examples Basics History Extra

SoftDeleteFilter

SoftDeleteFilter() as Boolean

Toggles whether objects with a SoftDelete flag (see BaseObject.GetSoftDeleteFlag)

are also to be returned in the object model. When the filter is activated, objects
of this type do not enter Collections or BackpointerCollections and the references
to the objects are not set.

In Section Instructions Examples Basics History Extra

SoftDeleteMode

SoftDeleteMode ( ) as Long

The property controls which of the following display modes is activated in the
Navigator:
Working layer display mode

Consolidation layer display mode

Normal display mode

See constants in Module "SoftDeleteMode".

This property replaces the property "SoftDeleteFilter".

In Section Instructions Examples Basics History Extra

SpecEval

SpecEval() as Object

Returns the formula evaluation class. This has the interface

ComosVBInterface::ISpecEval.

Also used internally in Spec links of the type "Calculation formula".

In Section Instructions Examples Basics History Extra

StartErrorLog

StartErrorLog(Val as String) as Boolean

Starts an ErrorLog. Error messages that otherwise occur in DBMon are diverted to
the file (FileName of the file) specified by Val. Only errors are logged for which
incorrect data had been written to objects (for example, a description had been set
although the description field is set to locked). At the end of the logging
procedure, a StopErrorLog must be created.

In Section Instructions Examples Basics History Extra

StartMode

StartMode() as Long

Determines the start mode of the application (COMOS, Viewing or ComosET).

In Section Instructions Examples Basics History Extra

StopErrorLog

StopErrorLog()

Ends the Errorlog. See StartErrorlog. Closes the Error file. The file can be used
from the time of this call onwards.

In Section Instructions Examples Basics History Extra

StringCompare

long StringCompare([in] string firstString, [in] string secondString)

Compares two Strings with each other, using the same logic that is used to sort
standard COMOS Collections.
Return value: 0 if the two Strings are the same. -1 if the first String is
lexicographically smaller than the second; 1 if the first String is
lexicographically larger.

In Section Instructions Examples Basics History Extra

SwitchToCurrentDBVersion

SwitchToCurrentDBVersion()

An administrator command to change over the database to a new version, old Clients
cannot work any longer. If large numbers of clients need to be switched to a new
COMOS version with changes to the object structure, to ensure a trouble-free
workflow it is necessary to first switch all clients to the new COMOS version and
then run a version update for the database.

In Section Instructions Examples Basics History Extra

SystemRefCount

SystemRefCount() as Long

Number of references of the Workset.

In Section Instructions Examples Basics History Extra

SystemType
SystemType() as Long

Returns the class of the relevant object. Possible values: See also Chapter
SystemType.

In Section Instructions Examples Basics History Extra

SystemTypeName

SystemTypeName() as Long

Name of the Workset class.

In Section Instructions Examples Basics History Extra

Terminate

Terminate()

A cancel function that must be called by applications when they end, in order to
make the CVS connection available again, for example.

In Section Instructions Examples Basics History Extra

TimeBetween

TimeBetween(uid1 as String, uid2 as String) as Long

Returns the time (1/10 s) that has elapsed between the processes of creating the
objects in question. The parameters are the UIDs of the objects.

In Section Instructions Examples Basics History Extra

TimeZone

TimeZone() as Long

Property that stores the difference (in minutes) from UTC time for this session.

In Section Instructions Examples Basics History Extra

TotalTimeMode

TotalTimeMode() as Boolean

Boolean value used to toggle monitoring for all COMOS functions for the PPM.

In Section Instructions Examples Basics History Extra

TransactionCount

TransactionCount() as Long

Number of transactions currently open

In Section Instructions Examples Basics History Extra

TransferProjectMode

TransferProjectMode() as Long

A mode that determines the behavior of the system in terms of its user objects
during project importing and exporting processes. Valid values: See also Chapter
TransferProjectMode.

AllUsers means that all users are transferred; OneUser reassigns all users to
ComosSystemUser.

In Section Instructions Examples Basics History Extra

UndoAll

UndoAll()

Transfers objects in the memory, including the full sub-structure, to the last
saved state:

Changed objects:

Last saved state

Deleted objects:

are restored

New objects:

are deleted
In Section Instructions Examples Basics History Extra

UndoStates

UndoStates() as IComosDUndoStates

Collection of UndoState objects.

In Section Instructions Examples Basics History Extra

UnsavedObjectCount

UnsavedObjectCount() as Long

Number of amended objects in the memory (objects marked as deleted that have not
been saved are not taken into consideration).

In Section Instructions Examples Basics History Extra

UnsavedObjects

UnsavedObjects() as IComosDCollection

Returns a Collection with all objects that have not been saved.

IComosDWorkset : Property

In Section Instructions Examples Basics History Extra

UpdateFullPath

UpdateFullPath ( ByVal startObject as IComosBaseObject )

Parameter startObject as IComosBaseObject

Start object of the update

Method for maintenance of database information.

The method recursively updates the full path of the database entries of all objects
underneath startObject. The method can be used for:

Oracle

SQL server

In Section Instructions Examples Basics History Extra

UseAliasForLabelFunctions

UseAliasForLabelFunctions() as Boolean

Switches on the alias functions if the Boolean value = True. See also Chapter
AliasFullLabel onwards.

In Section Instructions Examples Basics History Extra

Viewing
Viewing() as Boolean

Determines whether COMOS is to be started as a viewing station.

In Section Instructions Examples Basics History Extra

WriteNetLoginCredentials

WriteNetLoginCredentials ( string dbUser, string dbPassword, string netLoginUser,

string netLoginDomain, string netLoginPassword, int dataSourceIndex )

Requirement: The passed access data in the database are correct. Effect: Writes the
passed access data for Netlogin to the access file. The minimum interval when
calling this method is three seconds. In the event of an error an Exception is
triggered.

Parameter dbUser as string

User name in the access file

Parameter dbPassword as string

Password in the access file

Parameter netLoginUser as string

New user name for the access data from Netlogin

Parameter netLoginDomain as string

Domain of the Netlogin account

Parameter netLoginPassword as string

New password for the access data from Netlogin

Parameter dataSourceIndex as integer

Specifies from which data source the access file is to be modified

In Section Instructions Examples Basics History Extra

XObj

XObj() as Object

Extended Binary object. Binary object for user-specific extensions. Used for
queries, for example.

IComosDWorkset : Sub

In Section Instructions Examples Basics History Extra

Administration objects (independent classes)

This chapter contains the following information:CPLTVarstorage

IComosBaseObjectCollection

IComosChangeLogger

IComosDClipboard

IComosDCopyManager

IComosDDeriveSpec1

IComosDExportManager

IComosDFileProperties

IcomosDGeneralCollection

IComosDHistory
IComosDHistorys

IComosDLinkCacheManager

ComosDLinkInfo

IComosDModulManager

IComosDNumberRangeGeneratorAssignment

IComosDObjectCollection

IComosDObjectCollectionItem

IComosDOverlayParameter

IComosDRollbackState

IComosDScanManager

IcomosDSearchCondition

IcomosDSearchManager

IComosDStatusManager

IComosDTextGenerator

IComosDUndoState

IComosDUndoStates

IComosDUpdate

IComosDD3Collection

In Section Instructions Examples Basics History Extra

CPLTVarstorage

This chapter contains the following information:Count

Exist

Item

ItemExist

ItemKey
In Section Instructions Examples Basics History Extra

Count

Count() as Long

Member of: Plt.CPLTVarstorage

Number of Items in this variant memory.

In Section Instructions Examples Basics History Extra

Exist

Exist(Name as String) as Long

Member of: Plt.CPLTVarstorage

See ItemExist.

In Section Instructions Examples Basics History Extra

Item

Item(Index as Long) as Variant

Member of: Plt.CPLTVarstorage

Returns the index-value entry in this variant memory. Index begins at 1.

In Section Instructions Examples Basics History Extra

ItemExist

ItemExist(Name as String) as Long

Member of: Plt.CPLTVarstorage

States whether an entry for the name that was input already exists in the variant
memory.

In Section Instructions Examples Basics History Extra

ItemKey

ItemKey(Index as Long) as String

Member of: Plt.CPLTVarstorage

Returns the key for the index-value entry in this variant memory. Index begins at
1.

In Section Instructions Examples Basics History Extra

IComosBaseObjectCollection

This chapter contains the following information:IComosBaseObjectCollection

InsertAt

SetAt

Assign

In Section Instructions Examples Basics History Extra

IComosBaseObjectCollection

Derived from IComosDCollection.

In Section Instructions Examples Basics History Extra

InsertAt

InsertAt(Index as Long, Val as Object)

Inserts the object Val at the Index-value position. All higher objects are moved.

In Section Instructions Examples Basics History Extra

SetAt

SetAt(Index as Long, Val as Object)

Sets the object Val at the Index-value position. Higher objects are not moved.
In Section Instructions Examples Basics History Extra

Assign

Assign(Val as IComosDCollection)

Accepts all objects of the specified Collection. This may involve a TempCollection
or an OwnCollection. The order of the source collection is retained.

In Section Instructions Examples Basics History Extra

IComosChangeLogger

This chapter contains the following information:GetDependentChangeLogs

isLoggingActive

LogChangedBooleanProperty

LogChangedFloatProperty

LogChangedIntegerProperty

LogChangedReferenceProperty

LogChangedStringProperty

LogCreate

LogDelete

LogMove

LogRenameAfterMove
In Section Instructions Examples Basics History Extra

GetDependentChangeLogs

GetDependentChangeLogs([in] LPDISPATCH reverseAction, [in, optional] VARIANT

otherActions, [out, retval] IComosDCollection** retVal);

In Section Instructions Examples Basics History Extra

isLoggingActive

IsLoggingActive([out, retval] VARIANT_BOOL* active);

In Section Instructions Examples Basics History Extra

LogChangedBooleanProperty

LogChangedBooleanProperty([in] LPDISPATCH propertyOwner, [in] BSTR propertyName,

[in] VARIANT_BOOL valueBefore, [in] VARIANT_BOOL valueAfter);

In Section Instructions Examples Basics History Extra

LogChangedFloatProperty
LogChangedFloatProperty([in] LPDISPATCH propertyOwner, [in] BSTR propertyName, [in]
double valueBefore, [in] double valueAfter)

In Section Instructions Examples Basics History Extra

LogChangedIntegerProperty

LogChangedIntegerProperty([in] LPDISPATCH propertyOwner, [in] BSTR propertyName,

[in] long valueBefore, [in] long valueAfter);

In Section Instructions Examples Basics History Extra

LogChangedReferenceProperty

LogChangedReferenceProperty([in] LPDISPATCH propertyOwner, [in] BSTR propertyName,

[in] LPDISPATCH referenceBefore, [in] LPDISPATCH referenceAfter);

In Section Instructions Examples Basics History Extra

LogChangedStringProperty

LogChangedStringProperty([in] LPDISPATCH propertyOwner, [in] BSTR propertyName,

[in] BSTR valueBefore, [in] BSTR valueAfter);
In Section Instructions Examples Basics History Extra

LogCreate

LogCreate([in] LPDISPATCH createdObject);

In Section Instructions Examples Basics History Extra

LogDelete

LogDelete([in] LPDISPATCH exOwner, [in] LPDISPATCH deleteObject, [in] BSTR

serializedObject);

In Section Instructions Examples Basics History Extra

LogMove

LogMove([in] LPDISPATCH exOwner, [in] LPDISPATCH movedObject); eBlock

In Section Instructions Examples Basics History Extra

LogRenameAfterMove
LogRenameAfterMove([in] LPDISPATCH movedAndRenamedObject, [in] BSTR
movedObjectOldPfn, [in] BSTR movedObjectOldName);

In Section Instructions Examples Basics History Extra

IComosDClipboard

This chapter contains the following information:IComosDClipboard

CheckForCut

CheckForPaste

CopyToClipboard

CutToClipboard

Object

PasteFromClipboard

SingleCheckForCut

In Section Instructions Examples Basics History Extra

IComosDClipboard

Stand-alone COMOS administration object for accessing the COMOS clipboard.

In Section Instructions Examples Basics History Extra

CheckForCut
CheckForCut(objs As Object) As Long

Checks whether it is permissible to cut the specified objects. Objs may be either
an IComosBaseObject or (in the case of multiple selection) an IComosDCollection
(TempCollection). Inherited objects and those that failed the CheckDelete test <>
"0" cannot be cut. The result of the check is used to activate the "Cut" menu item.

In Section Instructions Examples Basics History Extra

CheckForPaste

CheckForPaste(Owner As Object) As Long

Check whether it is permissible to paste under the specified object. Owner is

either an IComosBaseObject or an IComosDOwnCollection (if the Collection into which
the item is to be pasted is not clear).

Pasting is allowed if the result of the check is "0".

The result is <> "0" and pasting is not permitted in cases involving an inherited
Owner, an object that has no create rights, the wrong system types, the wrong
Device classes for the intended project, the wrong Device creation mode or projects
that do not match.

The result of the check is used to (de)activate the "Paste" menu item.

In Section Instructions Examples Basics History Extra

CopyToClipboard

CopyToClipboard(objs As Object) As Boolean

Instruction to transfer the specified objects to the Clipboard. Objs may be either
an IComosBaseObject or (in the case of multiple selection) an IComosDCollection
(TempCollection).
In Section Instructions Examples Basics History Extra

CutToClipboard

CutToClipboard(objs As Object) As Boolean

Instruction to cure the specified objects and transfer them to the to the
Clipboard. Objs may be either an IComosBaseObject or (in the case of multiple
selection) an IComosDCollection (TempCollection).

In Section Instructions Examples Basics History Extra

Object

Object() as Object

The return value is the content of the clipboard, either IComosBaseObject in the
case of single selection or IComosDCollection in the case of multiple selection.

In Section Instructions Examples Basics History Extra

PasteFromClipboard

PasteFromClipboard(Owner As Object, newobject As Object, Save As Boolean) As Long

Instruction to paste the clipboard under the object specified with Owner.
IComosBaseObject or IComosDOwnCollection are permitted as Owner.
IComosDOwnCollection is used if the Collection into which the item to be pasted is
not clear (for example, in the base object tree a CDevice under a CDevice may be
pasted into CDevices or into the OwnElements collection). The Save parameter
defines whether saving should be carried out immediately after executing the
function.

Save should be set to FALSE in cases where the option to Undo or cancel is
required, since otherwise the database will be directly updated when the function
is run. The Paste function already includes a call for the CheckForPaste function,
meaning that a prior CheckForPaste function call is only required in cases that
require interaction and/or a separate evaluation of the result of the CheckForPaste
action.

In Section Instructions Examples Basics History Extra

SingleCheckForCut

SingleCheckForCut(objs As Object) As Long

Similar function to CheckForCut. However, in this case only the root object is
checked and all objects lying underneath it are not considered.

This is a special function that can be used to deactivate the "CUT" menu item
quickly, for example.

In Section Instructions Examples Basics History Extra

IComosDCopyManager

This chapter contains the following information:IComosDCopyManager

CollectReferences

DBMode

DestinationObject

DestinationProject
Mode

NewObjects

NewRootObjects

RestoreRevisions

SourceObjects

In Section Instructions Examples Basics History Extra

IComosDCopyManager

Specifically for the Workset.Copy method; allows multiple selection and the
reference collection, among other things.

In Section Instructions Examples Basics History Extra

CollectReferences

CollectReferences() as Boolean

Determines whether the references are to be recreated or collected under the

@COPYREF node.

In Section Instructions Examples Basics History Extra

DBMode
DBMode() as Boolean

Property that specifies whether the procedure is to run completely at the database
level (instead of creating object instances).

In Section Instructions Examples Basics History Extra

DestinationObject

DestinationObject([in/out] LPDISPATCH *pVal)

Target underneath which copying is performed.

In Section Instructions Examples Basics History Extra

DestinationProject

DestinationProject() as IComosDProject

This is the target project, is is copied there.

In Section Instructions Examples Basics History Extra

Mode

Mode() as Long

This mode determines whether only the base data or all references are to be looked
at.

In Section Instructions Examples Basics History Extra

NewObjects

NewObjects() as IComosDCollection

This is the set of new objects created by the copying action, this still have to be
pasted under the relevant target nodes.

In Section Instructions Examples Basics History Extra

NewRootObjects

NewRootObjects() as IComosDCollection

This is the set of all new objects formed by recreating new object nodes of the top
level.

In Section Instructions Examples Basics History Extra

RestoreRevisions

RestoreRevisions as boolean

Toggles the behavior of the revisions for copying across projects.

Default: The revisions are not copied as well.

They are copied as well if you have activated RestoreRevisions. In that case, on
the one hand the revision objects and revision directories are copied, on the other
hand the just copied objects do not get new timestamps (CS and RS), but instead
retain the timestamps of the originals. That way the target project has the same
status as the source project regarding revisions.

In Section Instructions Examples Basics History Extra

SourceObjects

SourceObjects() as IComosDCollection

This is the set of objects to be copied, and all source objects must be present in
this Collection.

IComosDCopyManager: Property

In Section Instructions Examples Basics History Extra

IComosDDeriveSpec1

This chapter contains the following information:IComosDDeriveSpec1

In Section Instructions Examples Basics History Extra

IComosDDeriveSpec1

Independent COMOS administration object that is only for COMOS internal use.
In Section Instructions Examples Basics History Extra

IComosDExportManager

This chapter contains the following information:IComosDExportManager

ConnectString

FileIncrement

Import

ProjectUID

SyncAllFiles

Timestamp

WithDeleted

In Section Instructions Examples Basics History Extra

IComosDExportManager

Specifically for the Device.ExportDB function.

In Section Instructions Examples Basics History Extra

ConnectString
ConnectString() as String

Required when logging into the target database (the syntax is the same as for
Workset.Init).

In Section Instructions Examples Basics History Extra

FileIncrement

FileIncrement([in/out, retval] IComosDCollection** pVal)

For DBSYNC, specifies whether only files created since the last synchronization
process ((true)) or all files (false - old method) are to be sent (performance vs.
volume)

In Section Instructions Examples Basics History Extra

Import

Import() as Boolean

Boolean value that indicates whether ExportManager is to be used for Export or

Import.

In Section Instructions Examples Basics History Extra

ProjectUID
ProjectUID() as String

UID of a project from the source database which can thus be imported as well.

In Section Instructions Examples Basics History Extra

SyncAllFiles

SyncAllFiles([in/out, retval] VARIANT_BOOL* SyncAllFiles)

Belongs to DBSYNC. Alt: if only one document was changed, then the complete
document directory was copied as well. The date of the last DBSYNC synchronization
is saved and only the newer documents are then copied.

In Section Instructions Examples Basics History Extra

Timestamp

Timestamp() as String

Planned for future use. Currently not used.

In Section Instructions Examples Basics History Extra

WithDeleted

WithDeleted() as Boolean
The Boolean parameter determines whether database objects that had been marked as
deleted are to be taken in consideration when exporting.

In Section Instructions Examples Basics History Extra

IComosDFileProperties

This chapter contains the following information:IComosDFileProperties

CustomPropertyExists

GetCustomPropertyByIndex

GetCustomPropertyByName

GetCustomPropertyCount

GetCustomPropertyName

GetDocumentProperty

GetFileName

IsDocumentProperty

RemoveCustomPropertyByIndex

RemoveCustomPropertyByName

Save

SetCustomPropertyByIndex

SetCustomPropertyByName

SetDocumentProperty

In Section Instructions Examples Basics History Extra

IComosDFileProperties
Case-insensitive

Now supports all reading standard values (except for date fields). Properties with
numbers as values are converted to decimal string. Object read via
workset.GetFileProperties(Name as string), where the name is the file name.

In Section Instructions Examples Basics History Extra

CustomPropertyExists

CustomPropertyExists(BSTR key, [out, retval] VARIANT_BOOL *retVal)

Checks whether there is a CustomProperty with the name key.

In Section Instructions Examples Basics History Extra

GetCustomPropertyByIndex

GetCustomPropertyByIndex(long index, [out, retval] VARIANT *retVal)

Returns the value of the CustomProperty with Index (index 1 to

GetCustomPropertyCount()).

In Section Instructions Examples Basics History Extra

GetCustomPropertyByName
GetCustomPropertyByName(BSTR key, [out, retval] VARIANT *retVal)

Returns the value of the CustomProperty with the name key (call
CustomPropertyExists beforehand).

In Section Instructions Examples Basics History Extra

GetCustomPropertyCount

GetCustomPropertyCount([out, retval] long *retVal)

Number of CustomProperties.

In Section Instructions Examples Basics History Extra

GetCustomPropertyName

GetCustomPropertyName(long index, [out, retval] BSTR *retVal)

Returns the name of the CustomProperty with Index index (Index 1 to

GetCustomPropertyCount()).

In Section Instructions Examples Basics History Extra

GetDocumentProperty

GetDocumentProperty(BSTR key, [out, retval] BSTR *retVal)

Reads DocumentProperty with the name key.

In Section Instructions Examples Basics History Extra

GetFileName

GetFileName([out, retval] BSTR *retVal)

Returns the file name of the file in which the Properties originate.

In Section Instructions Examples Basics History Extra

IsDocumentProperty

IsDocumentProperty(BSTR key, [out, retval] VARIANT_BOOL *retVal)

Returns true if DocumentProperty is supported (currently all from DSOFILE2 without

date values).

In Section Instructions Examples Basics History Extra

RemoveCustomPropertyByIndex

RemoveCustomPropertyByIndex([in] long index)

Removes the CustomProperty at Index index.

In Section Instructions Examples Basics History Extra

RemoveCustomPropertyByName

RemoveCustomPropertyByName([in] BSTR key)

In Section Instructions Examples Basics History Extra

Save

Save([out, retval] VARIANT_BOOL *retVal)

Saves the current Properties.

In Section Instructions Examples Basics History Extra

SetCustomPropertyByIndex

SetCustomPropertyByIndex([in] long index, VARIANT value)

Sets the value of the CustomProperty using Index index.

In Section Instructions Examples Basics History Extra

SetCustomPropertyByName
SetCustomPropertyByName([in] BSTR key , VARIANT value)

Sets the value of the CustomProperty using the name key.

In Section Instructions Examples Basics History Extra

SetDocumentProperty

SetDocumentProperty(BSTR key, BSTR value)

Sets DocumentProperty using the name key.

In Section Instructions Examples Basics History Extra

IcomosDGeneralCollection

This chapter contains the following information:IcomosDGeneralCollection

Add

IndexOf

Insert

Item

In Section Instructions Examples Basics History Extra

IcomosDGeneralCollection
Class which is based on .NET Collections of the interface. Collection of any
objects (not only COMOS objects). Can be used for any desired purposes. Elements in
the Collection are indexed from 1 onwards (VB-Like).

In Section Instructions Examples Basics History Extra

Add

Add(/*[in]*/LPDISPATCH item);

Adds Item at the end of the Collection.

In Section Instructions Examples Basics History Extra

IndexOf

IndexOf(/*[in]*/LPDISPATCH item, /*[out, retval]*/ long* index);

Returns the Index of an Items in the Collection. 0 if an Item is not found.

In Section Instructions Examples Basics History Extra

Insert
Insert(/*[in]*/ long index, LPDISPATCH item);

Adds Item to the desired position. The existing items are moved one position
backwards, starting from the index.

In Section Instructions Examples Basics History Extra

Item

LPDISPATCH Item([in] long index)

Item(index) reads or sets the element using the index. Index between 1 and Count()

Example:

Collection.Item(1) = object

In Section Instructions Examples Basics History Extra

IComosDHistory

This chapter contains the following information:TimestampUID

Value

In Section Instructions Examples Basics History Extra

TimestampUID
TimestampUID() as String

Member of: Plt.IComosDHistory

property TimestampUID

Timestamp UID of the history entry.

In Section Instructions Examples Basics History Extra

Value

Value() as String

Member of: Plt.IComosDHistory

property Value

Description of the history entry.

In Section Instructions Examples Basics History Extra

IComosDHistorys

This chapter contains the following information:Count

Item

In Section Instructions Examples Basics History Extra

Count
Count() as Long

Member of: Plt.IComosDHistorys

method Count

Returns the number of history entries of the Collection.

In Section Instructions Examples Basics History Extra

Item

Item(Index as Long) as IComosDHistory

Member of: Plt.IComosDHistorys

method Item

Returns a history entry.

In Section Instructions Examples Basics History Extra

IComosDLinkCacheManager

This chapter contains the following information:IComosDLinkCacheManager

In Section Instructions Examples Basics History Extra

IComosDLinkCacheManager
Independent COMOS administration object that is only for COMOS internal use.

In Section Instructions Examples Basics History Extra

ComosDLinkInfo

This chapter contains the following information:IComosDLinkInfo

Assign

Index

KeepLinkValue

LinkName

LinkPriority

LinkType

SpecName

StaticLink

StaticLinkCompare

StaticLinkOperator

SystemType

UnitLink

UseForXValues

UserLinkProperties

In Section Instructions Examples Basics History Extra

IComosDLinkInfo
Manages the link information of attributes. The LinkInfo object contains the link
path between two attributes in string form and a number of link-dependent Boolean
parameters.

In Section Instructions Examples Basics History Extra

Assign

Assign(source_obj as Object)

Accepts all Properties of the specified LinkInfo object.

In Section Instructions Examples Basics History Extra

Index

Index() as long

Shows whether a LinkInfo object of an attribute that is being searched for (value =
-1) or a cell (value = XValueIndex) is involved.

In Section Instructions Examples Basics History Extra

KeepLinkValue
KeepLinkValue() as Boolean

Determines whether the linked value is to be taken over if the linked object is
replaced. (only for linking via linked objects)

In Section Instructions Examples Basics History Extra

LinkName

LinkName() as String

IComosDSpecification.NestedName for LinkSpec. See also Chapter NestedName.

In Section Instructions Examples Basics History Extra

LinkPriority

LinkPriority() as Boolean

Determines whether the linked value is to be used. Priority switching for attribute
values:

LinkPriority = True: The linked specification value is used.

LinkPriority = False:

The attribute value, if set; otherwise, the linked attribute value.

In Section Instructions Examples Basics History Extra

LinkType

LinkType() as Long

COMOS system constant for the type of link. See also Chapter Link.

In Section Instructions Examples Basics History Extra

SpecName

SpecName() as String

NestedName for the source specification. See also Chapter NestedName.

In Section Instructions Examples Basics History Extra

StaticLink

StaticLink() as Boolean

Static link.

In Section Instructions Examples Basics History Extra

StaticLinkCompare
StaticLinkCompare() as Boolean

Shows whether the static link is only to be used for comparison purposes.

In Section Instructions Examples Basics History Extra

StaticLinkOperator

StaticLinkOperator() as String

Operator that is to be used when comparing with the statically-linked attribute.

In Section Instructions Examples Basics History Extra

SystemType

SystemType ( ) as Long

Returns the system type of the current object. For objects of the IComosDLinkInfo
type, this is system type 105 (constant SystemTypeLinkInfo: value 105).

In Section Instructions Examples Basics History Extra

UnitLink

UnitLink() as Boolean

Determines whether the unit of the link is to be taken over.

In Section Instructions Examples Basics History Extra

UseForXValues

UseForXValues() as Boolean

Shows whether the link is also to be valid for the XValues.

In Section Instructions Examples Basics History Extra

UserLinkProperties

UserLinkProperties() as String

LinkProperties that can be defined by the user.

In Section Instructions Examples Basics History Extra

IComosDModulManager

This chapter contains the following information:IComosDModulManager

Number
In Section Instructions Examples Basics History Extra

IComosDModulManager

Independent COMOS administration object for COMOS modules.

In Section Instructions Examples Basics History Extra

Number

Number() as Long

Module number (ComosModule) of the requested ModulManagers (ModuleLicense).

In Section Instructions Examples Basics History Extra

IComosDNumberRangeGeneratorAssignment

This chapter contains the following

information:IComosDNumberRangeGeneratorAssignment

GetNumberRangeGenerator

GetOwner

Rank

In Section Instructions Examples Basics History Extra

IComosDNumberRangeGeneratorAssignment

This assignment object sets up a connection between a COMOS object (possible are
IComosDDevice, IComosDDocument and IComosDProject) and a NumberRangeGenerator (type
IComosDNumberRangeGenerator). These assignment objects are necessary for the
connection, as these objects have an n:m relation. Apart from the references to the
participating objects, they contain only a numerical Property that is interpreted
as a kind of assignment priority (see below).

In Section Instructions Examples Basics History Extra

GetNumberRangeGenerator

IComosDNumberRangeGenerator GetNumberRangeGenerator()

Returns the NumberRangeGenerator used in this assignment.

In Section Instructions Examples Basics History Extra

GetOwner

GetOwner

Returns the COMOS object to which the NumberRangeGenerator used will be assigned.

In Section Instructions Examples Basics History Extra

Rank

long Rank

Property of type long; defines a sequence of assignments of equal ranking. As soon

as a COMOS object has been assigned several NumberRangeGenerators that use the same
CDevice pointer, a decision must be made in favor of one of these generators. This
decision is made based on the Rank property. The lower the value of this property,
the earlier the assigned generator is used. If a generator can no longer be used
because its value range is out of resources, the generator with the next higher
Rank value is used.

In Section Instructions Examples Basics History Extra

IComosDObjectCollection

This chapter contains the following information:IComosDObjectCollection

Count

Item

In Section Instructions Examples Basics History Extra

IComosDObjectCollection

Especially for the ChangedObjects function. It supplies the ObjectCollection

containing a maximum of 250 objects as the return value, while a larger number
creates a ChangedObjects overflow and deletes the collection. This functionality is
used to refresh the display, among other things.
In Section Instructions Examples Basics History Extra

Count

Count() as Long

Number of Items in the Collection.

In Section Instructions Examples Basics History Extra

Item

Item(Val as Long)as IComosDObjectCollectionItem

Returns the Item (specified by the parameter) of the ObjectCollection.

In Section Instructions Examples Basics History Extra

IComosDObjectCollectionItem

This chapter contains the following information:IComosDObjectCollectionItem

Code

Object

Reason

ReasonObject
In Section Instructions Examples Basics History Extra

IComosDObjectCollectionItem

Consists of a COMOS object and the associated ChangedObjectsCode that specifies the
reason for including the object in the collection. ChangedObjectsCode

In Section Instructions Examples Basics History Extra

Code

Code() as Long

Reason for acceptance in the ObjectCollection. See also Chapter ChangedObjectsCode.

In Section Instructions Examples Basics History Extra

Object

Object() as Object

Pointer to a COMOS object derived from BaseObject.

In Section Instructions Examples Basics History Extra

Reason
Reason() as String

Returns the reason why this item was added to an ObjectCollection.

Used with Workset.DeleteErrorObjects. You get an error number (code) and an error
text (reason).

In Section Instructions Examples Basics History Extra

ReasonObject

ReasonObject() as Object

See also Chapter Reason. In some cases, at this point you will find the object that
was the cause of this entry.

In Section Instructions Examples Basics History Extra

IComosDOverlayParameter

This chapter contains the following information:SetCheckDuplicateNames

SetCheckOpenRevisions

SetCheckPlantRevisions

SetCheckStarVersions

SetDeleteObjectsMode

SetDeleteOverlayMode

SetDescription
SetDestinationOverlay

SetLockOverlay

SetOpenRevisionType

SetPartialReleaseOwners

SetReleaseDuplicates

SetSourceOverlay

In Section Instructions Examples Basics History Extra

SetCheckDuplicateNames

SetCheckDuplicateNames(ByVal CheckDuplicateNames as long)

Controls whether a check for duplicate names is run before releasing the working
layer.

The following values are possible for CheckDuplicateNames:

OverlayCheckDuplicateNamesDefault (= 0)

The setting of the corresponding base object below "@99 > A70 Working layers" is
used.

(Default)

OverlayCheckDuplicateNamesOFF (= 1)

No check for duplicate names.

OverlayCheckDuplicateNamesON (= 2)

A check for duplicate names is performed.

In Section Instructions Examples Basics History Extra

SetCheckOpenRevisions

SetCheckOpenRevisions(Check as Long)

Determines whether or not a check is to be made for open revisions before the
release.

Check = 0

The setting of the corresponding base object below "@99 > A70 Working layers" is
used.

(Default)

Check = 1

The check for open revisions is carried out before the release.

Check = 2

The check for open revisions is not carried out before the release.

In Section Instructions Examples Basics History Extra

SetCheckPlantRevisions

SetCheckPlantRevisions(Check as Long)

Determines whether or not a check is to be made for project revisions without unit
revisions before the release.

Check = 0

The setting of the corresponding base object below "@99 > A70 Working layers" is
used.

(Default)
Check = 1

The unit documentation is checked before the release.

Check = 2

The unit documentation is not checked before the release.

In Section Instructions Examples Basics History Extra

SetCheckStarVersions

SetCheckStarVersions ( ByVal checkStarVersions as Long )

Parameter checkStarVersions as long

This value determines if a check takes place.

The method determines if a check for version documents with asterisk takes place
when a working layer is released. An asterisk in the version number indicates that
this version number already exists for the document in another working layer.

Permitted settings are:

Default value is used

The setting at the base object of the working layer is valid.

Check for asterisks

No check for asterisks

Constants see Module ComosSystemConstants, values "OverlayCheckStarVersions...".

In Section Instructions Examples Basics History Extra

SetDeleteObjectsMode

SetDeleteObjectsMode(ByVal DeleteObjectsMode as Long)

The following specifications are only evaluated in connection with

SetDeleteOverlayMode(FALSE).

DeleteObjectsMode = 0

The setting of the corresponding base object below "@99 > A70 Working layers" is
used (Default).

DeleteObjectsMode = 1

Released objects are deleted after the release.

DeleteObjectsMode = 2

Objects of the working layer that is to be released are retained after the release.

In Section Instructions Examples Basics History Extra

SetDeleteOverlayMode

SetDeleteOverlayMode(ByVal DeleteOverlayMode as Long)

Specifies whether the working layer to be released is to be retained after the

release. The same applies as in the case of SetDeleteObjectsMode.

In Section Instructions Examples Basics History Extra

SetDescription

SetDescription(ByVal Description as String)

Description for the histories object that is created if necessary through a release
into the released area.

In Section Instructions Examples Basics History Extra

SetDestinationOverlay

SetDestinationOverlay(ByVal DestinationOverlay as Object)

Sets the working layer into which the release is to be performed by means of
ReleaseOverlayEX. It is also permitted to set the project. If NULL is specified,
the owner of the working layer to be released is used.

In Section Instructions Examples Basics History Extra

SetLockOverlay

SetLockOverlay(ByVal LockOverlay as Long)

Determines whether the working layer is locked after release.

The following constants are available for LockOverlay:

Overlay_Lock_Mode_Default (=0)

Value is retrieved by the corresponding base object below "@99 > A70 Working
layers".
Overlay_Lock_Mode_Lock (=1)

The working layer to be released is locked after the release.

Overlay_Lock_Mode_NoLock (=2)

The working layer to be released is not locked after the release.

In Section Instructions Examples Basics History Extra

SetOpenRevisionType

SetOpenRevisionType(OpenRevisionType as Long)

Determines which revision type is considered to be open.

Only has an effect when used in combination with SetCheckOpenRevisions() and

SetCheckPlantRevisions().

The following constants are available for parameter OpenRevisionType :

OverlayOpenRevisionTypeDefault (=0)

Value is retrieved by the corresponding base object below "@99 > A70 Working
layers".

OverlayOpenRevisionTypeOpen (=1)

Check for not yet created.

OverlayOpenRevisionTypeCreated (=2)

Check for not yet released.

In Section Instructions Examples Basics History Extra

SetPartialReleaseOwners

SetPartialReleaseOwners(ByRef PartialReleaseOwners as IComosDCollection)

With the help of this method you can define a set of objects for partial releases
of working layers.

A collection of root objects is passed to do so. The root objects and all objects
located in the substructures of the root objects will be released.

This functionality must be used carefully, since it can produce inconsistent data
in the target of the working layer release!

Objects referenced by the objects to be released are not released at the same time,
unless these objects are also located underneath one of the root objects.
Consequently, references to objects that were created in the overlay that is to be
released and that are not visible in the preceding working layer are lost.

In Section Instructions Examples Basics History Extra

SetReleaseDuplicates

SetReleaseDuplicates(ByVal ReleaseDuplicates as boolean)

Specifies whether duplicates of objects are to be released.

Explanation

When an object is released, a check is always performed to determine whether this

object exists in the working layer in which the release is being performed, and
whether both instances are identical (an exact copy of the object - comparison
carried out via the timestamp). In this case the object is not released, which
provides additional performance.

The other case is when an exact copy does not exist in the working layer in which
the release is to be made, but this layer contains an exact copy as a result of an
overlay ("inheritance"). To put it another way: although the object is displayed in
the working layer, it physically derives from a superordinate working layer.
SetReleaseDuplicates now defines whether or not these specific objects are to be
released.

If the objects are not released, the logical status of the working layer is the
same as in the case with the release, but there are fewer objects in the database
in the working layer. The release would have created objects that would only have
been inherited, in contrast to the case without a release.

This option is required, for example, if you wish to release the intermediate
states of a working layer in advance, but still wish to continue working in the
working layer after the release. If you now release the intermediate state, then
exactly the same objects will usually be present in the original working layer and
in the working layer in which the last release was carried out. Under certain
circumstances you might not want to check the objects into the intermediate layer
again, which would also affect the hierarchical display in Funtree.

In Section Instructions Examples Basics History Extra

SetSourceOverlay

SetSourceOverlay(ByVal SourceOverlay as Object)

Sets the working layer that is released by ReleaseOverlayEX. If it is NULL, the

working layer at which ReleaseOverlayEX was called is used.

In Section Instructions Examples Basics History Extra

IComosDRollbackState

This chapter contains the following information:IComosDRollbackState

AddD3Object

AddRollbackStateEntry

Count

ID

Rollback
In Section Instructions Examples Basics History Extra

IComosDRollbackState

All changes made to 3D objects are logged in RollbackState to permit previous

states to be restored. Only for internal use.

In Section Instructions Examples Basics History Extra

AddD3Object

AddD3Object(ByVal D3 as Object)

Adds the specified 3D object to RollbackState.

In Section Instructions Examples Basics History Extra

AddRollbackStateEntry

AddRollbackStateEntry (ByVal entry as Object, Mode as Long)

Allows you to integrate your own objects into the RollbackState administration (in
COMOS, this is used with the report items for the undo/redo operation in the
document, for example). These objects must implement the IRollBackStateEntry
interface. The following constants are permissible for Mode:

RollbackStateEntry_Mode_Modified

RollbackStateEntry_Mode_New
RollbackStateEntry_Mode_Delete

In Section Instructions Examples Basics History Extra

Count

Count() as Long

Number of objects (Items) in RollbackState.

In Section Instructions Examples Basics History Extra

ID

ID() as Long

Continuous ID numbers of all RollbackStates.

IComosDRollbackState: Sub

In Section Instructions Examples Basics History Extra

Rollback

Rollback()

Undoes (rolls back) all changes to the 3D objects logged in RollbackState.

In Section Instructions Examples Basics History Extra

IComosDScanManager

This chapter contains the following information:IComosDScanManager

AllProjects

CancelAllowed

Classes

CObjects

DirectDBSearch

FilterByLayer

IncludeRoot

Mode

Properties

Recursive

Root

ScanWasCancelled

SingleStage

StopClasses

SystemType

Value

WithBackPointerDevices

WithBackPointerDocuments

WithCLinks

WithRevisionDocuments

WithSystemTemporary
In Section Instructions Examples Basics History Extra

IComosDScanManager

An auxiliary object for the Scan search function in COMOS. This enables efficient
searching for objects of classes CDevice, Device and Document by means of special
routines. Other objects can be found via the general Search.

See also Chapter Scan.

Sample code

' Get an instance of the ScanManager

Set scanman = a.workset.getscanmanager

' Properties Set for ScanManager

scanman.systemtype = 8

scanman.root = b

' Run the search

Set res = a.workset.scan (scanman)

In Section Instructions Examples Basics History Extra

AllProjects

AllProjects as Boolean

Is used for searching documents. Determines whether you only wish to search in the
current project or in all projects.
In Section Instructions Examples Basics History Extra

CancelAllowed

bool CancelAllowed

Property of Boolean type. Defines whether a scan procedure that is started with the
current ScanManager may be canceled. If this property is "true", then a Cancel
button is shown in the user interface.

Warning: Previously, canceling was only supported when scanning devices in the
object model.

In Section Instructions Examples Basics History Extra

Classes

Classes() as String

This is only executed in the search for Device or for a general search. The classes
to be searched are specified in string form, in accordance with DeviceClass. It is
possible to search for multiple classes simultaneously, in which case " | " is used
as the class delimiter.

In Section Instructions Examples Basics History Extra

CObjects

CObjects() as IComosDCollection

This function is used to search for objects of class Device. The objects of this
Collection pass information on to the Devices to be found. The effect is the same
as in the case of the ScanDevicesWithCObject and ScanDevicesWithCObjectX functions;
however, the difference in this case is that a group of objects, rather than an
individual object, serves as the search parameter. This enables a simultaneous
search for signals and functions, for example.

In Section Instructions Examples Basics History Extra

DirectDBSearch

DirectDBSearch() as Boolean

Property for using the search procedure directly at the database level. A
comparison is no longer carried out in relation to COMOS objects, but instead
directly within the database. This brings about performance advantages but also the
disadvantage that linked or inherited information cannot be found any longer.

In Section Instructions Examples Basics History Extra

FilterByLayer

bool FilterByLayer

Property of Boolean type. Controls whether the result of the scan operation is to
be filtered again based on the working areas of the objects found. This means, for
example, that objects with the "~" or "*" working areas are not visible in the
Navigator.

To get the same result when scanning, this Property must be set to TRUE.

In addition to the special working areas, the normal working areas are also
compared with the areas of the current user, and objects for which the user has no
reading rights are filtered out. By default sets this Property to FALSE, meaning
that there is no filtering in terms of working areas.

In Section Instructions Examples Basics History Extra

IncludeRoot

IncludeRoot() as Boolean

Determines whether the RootObject is to remain in the results set (True) or is to

be removed (False).

In Section Instructions Examples Basics History Extra

Mode

Mode() as Long

Property of type long. Depending on the type of objects being searched for, this is
used to define more specifically how the search is to be performed:

Search for CDevices:

1 (Scan_CDevice_CDevices) - CDevices are included in the search.

2 (Scan_CDevice_Elements) - Elements are included in the search.

These two values must be understood to be flags or bits which can also be combined.

Search for documents:

1 (Scan_Documents_Normal) – normal hierarchical search for documents

2 (Scan_Documents_All_Backpointers) – BackPointer are searched for on a cross-

project basis and, in addition, the BackPointerDocuments are evaluated based on the
documents found (meaning that not only are the report templates found, but also the
reports based on these report templates, for example).
3 (Scan_Documents_Direct_Backpointers) – Only the current project is evaluated; no
additional BackPointer from the documents found are evaluated.

These values are not to be understood as summable bits; only one exclusive value
may be used.

In Section Instructions Examples Basics History Extra

Properties

Properties() as Long

Property for specifying the Property that is to be used for the search. Only
relevant if DirectDBSearch is activated.

The following constants are available for this:

DBSearch_Property_Name

DBSearch_Property_Label

DBSearch_Property_Description

DBSearch_Property_Value

DBSearch_Property_Description2

DBSearch_Property_Description3

DBSearch_Property_XValue
DBSearch_Property_FileName

In Section Instructions Examples Basics History Extra

Recursive

Recursive() as Boolean

True triggers a recursive search, meaning that an iterative search is carried out
in the hierarchical substructure.

In Section Instructions Examples Basics History Extra

Root

Root() as Object

The start object from where it is searched.

In Section Instructions Examples Basics History Extra

ScanWasCancelled

ScanWasCancelled ( ) as Boolean

True: The user has clicked on "Cancel" during the scan process.
False: In all other cases.

The method indicates if a user has canceled the scan process manually. An
evaluation takes place in the following cases:

Scanning of Device objects

In Section Instructions Examples Basics History Extra

SingleStage

SingleStage() as Boolean

True triggers a single-stage search, i.e. not a search in the object hierarchy, but
instead only in the OwnCollections and BackpointerCollections.

In Section Instructions Examples Basics History Extra

StopClasses

StopClasses() as String

Only executed when searching for objects of the system type Device. Here you can
specify object classes for which the search is aborted. If any objects of the
specified classes are found, then no further searching is carried out in the
relevant hierarchical substructure. The classes are specified in string form, in
accordance with DeviceClass. It is possible to specify multiple classes
simultaneously. No class delimiter is required for this purpose (classes can be
written one after the other directly, without inserting a space character).

Optional: "#"
"#" = ScanDevicesStopDocobj

Terminates the search when Docobjs is reached.

Technical background: Docobj references are also retraced during the search. If the
search moves underneath a document and a position is placed on this document, for
example, then a Docobj for this position is located underneath the document. The
search finds the Docobj and then searches for the corresponding system type Device
of class Position.

The "#" option above means that the references will not be retraced and the placed
position will not, therefore, be found.

In Section Instructions Examples Basics History Extra

SystemType

SystemType ( ) as Long

Determines which objects are to be searched for. Long is specified, according to

SystemType and ScanManager_.

13

SystemTypeCDevice

SystemTypeDevice

29

SystemTypeDocument

ScanManager_SystemType_All

In Section Instructions Examples Basics History Extra

Value

Value() as String

Property for specifying the value that is to be used for the search. Only relevant
if DirectDBSearch is activated.

In Section Instructions Examples Basics History Extra

WithBackPointerDevices

WithBackPointerDevices() as Boolean

In searches for Device or Document, in identified Devices of the subtypes Unit or

Location, True also triggers the evaluation of the BackPointerDevices Collections.

In Section Instructions Examples Basics History Extra

WithBackPointerDocuments

WithBackPointerDocuments() as Boolean

In searches for Device or Document, in identified Devices of the subtypes Unit or

Location, True also triggers the evaluation of the BackPointerDocuments Collection.

In Section Instructions Examples Basics History Extra

WithCLinks

WithCLinks as Boolean

Used when searching for documents. Determines whether the search is to continue
underneath CDevices via CLinks.

In Section Instructions Examples Basics History Extra

WithRevisionDocuments

WithRevisionDocuments() as Boolean

True causes revision documents to be included in a document search.

In Section Instructions Examples Basics History Extra

WithSystemTemporary

WithSystemTemporary as Boolean

Used when searching for documents. Determines whether temporary (inherited)

documents are to be searched. Only relevant in base object tree.

In Section Instructions Examples Basics History Extra

IcomosDSearchCondition
This chapter contains the following information:IcomosDSearchCondition

Get_AttributeType

Get_ComparisonOperator

Get_LogicalOperator

Get_PerformanceIndex

Get_Value

IsSearchCaseSensitive

IsValid

SystemType

In Section Instructions Examples Basics History Extra

IcomosDSearchCondition

Conditions for the SearchManager can be defined using this class.

In Section Instructions Examples Basics History Extra

Get_AttributeType

get_AttributeType(/*[out, retval]*/ BSTR*attributeType);

Defines whether a search for a certain Property (e.g. "Label") or for a

classification should be performed.
In Section Instructions Examples Basics History Extra

Get_ComparisonOperator

get_ComparisonOperator(/*[out, retval]*/ BSTR* comparisonOperator);

The operator defines how the attribute/classification is compared with the value in
the database.

For classification 2 and 3, only LIKE and NOT LIKE are permitted as operators. When
searching for a Description, you are limited to = and LIKE. (due to multiple
languages).

In Section Instructions Examples Basics History Extra

Get_LogicalOperator

get_LogicalOperator(/*[out, retval]*/ BSTR* logicalOperator);

The value for the first AppendSearchCondition must remain empty. With all other
AppendSearchCondition, either OR or AND must be specified. OR means that at least
one condition must be met. AND means that all conditions must be met. AND is
stricter than OR. Following parenthesis applies: (…AND…AND…) OR (…AND…AND…) OR …

In Section Instructions Examples Basics History Extra

Get_PerformanceIndex

STDMETHOD(get_PerformanceIndex)(/*[out, retval]*/ long* performanceIndex);

For a search condition states how fast this should be conducted by the database.
Used in the query interface for a signal switch. 0 - highest performance, lowest
performance currently 2.

In Section Instructions Examples Basics History Extra

Get_Value

get_Value(/*[out, retval]*/ BSTR* value);

Value which is used to compare. In the case of LIKE and NOT LIKE, "*" and "?" may
be used as wildcards. "?" Serves as a proxy for exactly one optional

character and "*" for an optional number of characters (including no character).

"\" serves as an escape character in order to also search for "*" or "?".

In Section Instructions Examples Basics History Extra

IsSearchCaseSensitive

IsSearchCaseSensitive ( ) as Boolean

True: The strings of the current search condition are evaluated observing upper
case/lower case letters.

False: In all other cases.

In Section Instructions Examples Basics History Extra

IsValid
IsValid(/*[out, retval]*/ long* errorCode);

Checks the condition regarding the consistency. Comprehensive debut outputs, if

erroneous.

In Section Instructions Examples Basics History Extra

SystemType

long SystemType

Property of type long; contains the system type for which the current search is
executed.

In Section Instructions Examples Basics History Extra

IcomosDSearchManager

This chapter contains the following information:FollowLifeCycleLinks

FollowUnitPointers

GetFPAllowedComparisonOps

GetSearchCondition

IsSearchCaseSensitive

IsUserAbortAllowed

RootObjects

SearchConditions

SystemType
In Section Instructions Examples Basics History Extra

FollowLifeCycleLinks

FollowLifeCycleLinks ( ) as Boolean

Method prepared for future functions.

In Section Instructions Examples Basics History Extra

FollowUnitPointers

FollowUnitPointers ( ) as Boolean

Method prepared for future functions.

In Section Instructions Examples Basics History Extra

GetFPAllowedComparisonOps

Variant GetFPAllowedComparisonOps(string groupName, string propertyName)

Returns all permitted compare operators for the specified FreeProperty (group name
and FreeProperty name).

Return value: Array of strings in a variant

In Section Instructions Examples Basics History Extra

GetSearchCondition

GetSearchCondition(/*[out, retval]*/ IComosDSearchCondition** condition);

Returns a new, as yet undefined IComosDSearchCondition. May be added to the

Collection of search conditions, for example.

IcomosDSearchManager: Property

In Section Instructions Examples Basics History Extra

IsSearchCaseSensitive

bool IsSearchCaseSensitive

Property of type bool; specifies whether or not the search is to be case sensitive.

In Section Instructions Examples Basics History Extra

IsUserAbortAllowed

IsUserAbortAllowed(/*[out,retval]*/VARIANT_BOOL* isUserAbortAllowed);

It is possible to define whether a user can abort the search. In this case, the
progress bar will have a "Cancel" button added to it.
In Section Instructions Examples Basics History Extra

RootObjects

RootObjects(/*[out, retval]*/IComosDCollection** rootObjects);

At the SearchManager, there is a TempCollection for the start objects. Any objects
can be added to this TempCollection. The result amount contains only objects that
lie underneath one of the start objects. If the Collection is empty, the search is
conducted across all projects.

In Section Instructions Examples Basics History Extra

SearchConditions

SearchConditions(/*[out, retval]*/ IComosDGeneralCollection** searchConditions);

Returns a GeneralCollection (NEW) with all search conditions defined at the

SearchManager.

In Section Instructions Examples Basics History Extra

SystemType

SystemType(/*[out, retval]*/ long* systemType);

Here you can define what kind of objects should be searched for. Permitted entries:

Device (SystemType 8)
CDevice (SystemType 13)

Document (SystemType 29)

Attribute (SystemType 10)

In Section Instructions Examples Basics History Extra

IComosDStatusManager

This chapter contains the following information:IComosDStatusManager

Classes

DirectionMode

Number

SetMode

Value

In Section Instructions Examples Basics History Extra

IComosDStatusManager

Specifically for the Device.SetStatus function.

Administration object for the Device.SetStatus function. This class is a stand-

alone class in COMOS; it is not derived from any other class.
In Section Instructions Examples Basics History Extra

Classes

Classes() as String

Classes for ScanDevices.

In Section Instructions Examples Basics History Extra

DirectionMode

DirectionMode() as Long

Constants:

StatusDirectionModeObject

StatusDirectionModeUp

StatusDirectionModeDown

In Section Instructions Examples Basics History Extra

Number

Number() as Long
Number of the status that is to be changed.

In Section Instructions Examples Basics History Extra

SetMode

SetMode() as Long

Constants:

StatusSetModeObject

StatusSetModeIncrement

StatusSetModeDecrement

In Section Instructions Examples Basics History Extra

Value

Value() as Long

Value to which the status is to be changed.

In Section Instructions Examples Basics History Extra

IComosDTextGenerator
This chapter contains the following information:IComosDTextGenerator

Check

CheckInherited

CObject

DefaultValue

Mask

OwnDefaultValue

OwnMask

OwnValue

Type

UseDefaultIfEmpty

Value

In Section Instructions Examples Basics History Extra

IComosDTextGenerator

Manages the masks for Name, Label and Description.

In Section Instructions Examples Basics History Extra

Check

Check
Check() as Boolean

Toggles whether the mask is only to be used to generate texts or also to check
existing texts.

In Section Instructions Examples Basics History Extra

CheckInherited

CheckInherited() as Boolean

Shows whether "Check at the current text generator is defined or inherited. A TRUE
setting means that Check is inherited.

In Section Instructions Examples Basics History Extra

CObject

CObject() as IComosDDevice

Associated CDevice.

In Section Instructions Examples Basics History Extra

DefaultValue

DefaultValue() as String
Default value.

In Section Instructions Examples Basics History Extra

Mask

Mask() as String

Mask.

In Section Instructions Examples Basics History Extra

OwnDefaultValue

OwnDefaultValue() as String

The object's own default value.

In Section Instructions Examples Basics History Extra

OwnMask

OwnMask() as String

The object’s own mask.

In Section Instructions Examples Basics History Extra

OwnValue

OwnValue() as String

The object's own Name, Label or Description (depending on type).

In Section Instructions Examples Basics History Extra

Type

Type() as Long

Constants:

GeneratorTypeName

GeneratorTypeLabel

GeneratorTypeDescription

In Section Instructions Examples Basics History Extra

UseDefaultIfEmpty

bool UseDefaultIfEmpty
Property of Boolean type that indicates whether the standard index 0 should be
used, if empty generator text would be returned for an index != 0. This enables a
Fallback to be set up on the standard naming scheme, if no generator text is
entered for the scheme currently in use.

In Section Instructions Examples Basics History Extra

Value

Value() as String

Name, Label or Description (depending on type).

In Section Instructions Examples Basics History Extra

IComosDUndoState

This chapter contains the following information:IComosDUndoState

ChangeTimestamps

Check

CheckAndCorrectObjects

ForceTranslation

LanguageForSubWorkingLayerTranslation

Objects

OwnerFunction

Save

Tag

Undo
In Section Instructions Examples Basics History Extra

IComosDUndoState

Manages the Undo quantities.

Administration object, for managing Undo quantities that are not derived from any
other class. This enables improved behavior as far as Save and Undo are concerned
for quantities of objects. An Ocx (e.g. the properties mask) must create its own
UndoState and set this as CurrentUndoState before it makes any changes at the
objects. COMOS then adds all the objects that change to the Objects Collection of
this UndoState. For this UndoState, an Undo or Check and Save operation will be
performed at the end.

In Section Instructions Examples Basics History Extra

ChangeTimestamps

bool ChangeTimestamps

Property of Boolean type. When transporting translations in the lower layers,

defines whether the timestamps of the objects affected should be changed or not.

In Section Instructions Examples Basics History Extra

Check

Check() As Long
Checks all objects of the Objects Collection (in the same way as Obj.Check).

In Section Instructions Examples Basics History Extra

CheckAndCorrectObjects

CheckAndCorrectObjects() As Long

Performs the function CheckAndCorrectObjects for all objects of the Objects

Collection (in the same way as Obj.CheckAndCorrect objects).

In Section Instructions Examples Basics History Extra

ForceTranslation

bool ForceTranslation

Property of Boolean type. Translations are usually only transported in the lower
layers if something has actually been changed in the translation. You can use this
Property to specify that this should happen even if the translation has not been
changed (value true). This is useful if there are no translations at all yet in the
layers.

In Section Instructions Examples Basics History Extra

LanguageForSubWorkingLayerTranslation

IComosDLanguage LanguageForSubWorkingLayerTranslation
Property of type IComosDLanguage. Used in conjunction with automatic project
translation. This Property is the source language of a translation that has already
been carried out, whose results are also to be transported in lower layers. If, on
a Device for example, the description has been translated from German to English
(Device has been changed and is now in UndoState), German must be set as the source
language and the translation is then transported in lower layers upon saving.

In Section Instructions Examples Basics History Extra

Objects

Objects() as IComosDCollection

Collection that contains all COMOS objects of this UndoState.

In Section Instructions Examples Basics History Extra

OwnerFunction

OwnerFunction() as String

Used for identifying the UndoState.

In Section Instructions Examples Basics History Extra

Save

Save() As Long
Saves all objects of the Objects Collection (in the same way as Obj.Save).

In Section Instructions Examples Basics History Extra

Tag

Tag() as String

Used for identifying the UndoState.

In Section Instructions Examples Basics History Extra

Undo

Undo()

Performs the function Undo for all objects of the Objects Collection (in the same
way as Obj.Undo objects).

In Section Instructions Examples Basics History Extra

IComosDUndoStates

This chapter contains the following information:IComosDUndoStates

Count

CreateNew
Item

Remove

In Section Instructions Examples Basics History Extra

IComosDUndoStates

Independent Collection of UndoState objects.

Collection of UndoState objects, not derived from any other class.

In Section Instructions Examples Basics History Extra

Count

Count() as Long

Number of objects in the Collection.

In Section Instructions Examples Basics History Extra

CreateNew

CreateNew() as IComosDUndoState

Creates a new object in the Collection.

In Section Instructions Examples Basics History Extra

Item

Item

Item(Index as Long) as IComosDUndoState

The object (specified by the Index) of the Collection.

In Section Instructions Examples Basics History Extra

Remove

Remove(Val as IComosDUndoState) as Boolean

Removes the specified object from the Collection.

In Section Instructions Examples Basics History Extra

IComosDUpdate

This chapter contains the following information:ArchivePath

DatabaseVersion

Delete
Information

Install

Import

IsConsolidated

Version

In Section Instructions Examples Basics History Extra

ArchivePath

ArchivePath ( ) as String

Returns or sets the path to the zip file with database update.

The "IComosDUpdate" object represents the database update in COMOS.

In Section Instructions Examples Basics History Extra

DatabaseVersion

DatabaseVersion ( ) as String

Returns the database version number of the database update.

The "IComosDUpdate" object represents the database update in COMOS.

In Section Instructions Examples Basics History Extra

Delete
Delete ( )

Deletes the database update from the COMOS database.

In Section Instructions Examples Basics History Extra

Information

Information ( ) as String

Returns the Info text generated during the database update.

In Section Instructions Examples Basics History Extra

Install

Install ( ByVal releaseConsolidationLayers as Boolean,

deleteLinkedEngineeringLayers as Boolean )

Parameter releaseConsolidationLayers as boolean

True: All consolidation layers in the base project are released.

False: The consolidation layers are deleted.

Parameter deleteLinkedEngineeringLayers as boolean

True: The consolidation layers for the working layers in the engineering project
are deleted.

False: In all other cases.

Installs the database update.

Background information on deleteLinkedEngineeringLayers: Consolidation layers are

working layers that are created prior to the actual installation of the database
update. We distinguish between two types of consolidation layers:

Consolidation layers for working layers in the base project

Optional: Consolidation layers for working layers in the engineering project

These consolidation layers for the engineering projects have the corresponding
consolidation layer in the base project as base working layer.

The user decides with the help of an option if the consolidation layers in the
engineering project are deleted during the actual installation of the database
update.

In Section Instructions Examples Basics History Extra

Import

Import ( )

Imports the database update and transfers the information to the database
consolidation.

In Section Instructions Examples Basics History Extra

IsConsolidated

IsConsolidated ( ) as Boolean

The method determines if the database update is completed. A database update is

completed if each object in the database update is either applied or rejected.

In Section Instructions Examples Basics History Extra

Version

Version ( ) as String

Returns the version number of the database update.

In Section Instructions Examples Basics History Extra

IComosDD3Collection

This chapter contains the following information:Count

Item

In Section Instructions Examples Basics History Extra

Count
Count() as Long

Number of elements in the Collection.

In Section Instructions Examples Basics History Extra

Item

Item(Index as Long) as Object

The element (specified by the Index) of the Collection.

In Section Instructions Examples Basics History Extra

Interface without classes

This chapter contains the following information:IBasic

IComosTaskNotifyObject

IMessageBoxHandler

IRollbackStateEntry

IXObject

In Section Instructions Examples Basics History Extra

IBasic
This chapter contains the following information:CDeviceChange

In Section Instructions Examples Basics History Extra

CDeviceChange

CDeviceChange(device as Object, oldcdevice as Object, newValue as Object,

currentcdevice as Object)

Called if the CDevice is changed at the Device.

device: the device at which the pointer was changed

oldcdevice: old CDevice

newValue: CDevice to be set

currentcdevice: actual CDevice (a difference with respect to newValue is possible

due to dereferencing)

In Section Instructions Examples Basics History Extra

IComosTaskNotifyObject

This chapter contains the following information:IComosTaskNotifyObject

Ready

Cancel
In Section Instructions Examples Basics History Extra

IComosTaskNotifyObject

The interface that is required for the IComosDWorkset.StartPreLoadMonitor method.

In Section Instructions Examples Basics History Extra

Ready

Ready(ByVal NotifyString as String)

Ready is returned by the kernel. You receive it at the end of the PreLoads
(provided the process has not been canceled).

In Section Instructions Examples Basics History Extra

Cancel

Cancel()

Cancel is returned by the kernel. You receive it if PreLoads has been canceled.

In Section Instructions Examples Basics History Extra

IMessageBoxHandler

This chapter contains the following information:IMessageBoxHandler

ShowMessageBox

In Section Instructions Examples Basics History Extra

IMessageBoxHandler

Interface for processing user hints (message boxes). Consists of only one method
called "ShowMessageBox" to which all user hints are sent as soon as an instance of
the implementing class is registered at the workset.

In Section Instructions Examples Basics History Extra

ShowMessageBox

int ShowMessageBox(string text, string caption, int mode)

Required for the Property Workset.MessageBoxHandler. At this point, you can set an
object that implements the IMessageBoxHandler interface.

Parameter text:

The text that should appear in the MessageBox.

Parameter caption:

Header of the MessageBox.

Parameter mode:

Specifies which icon and which buttons are displayed next to the text and whether
the MessageBox is modal or not.

Example: MB_ICONSTOP | MB_OK | MB_TASKMODAL

Shows a modal MessageBox with stop sign as icon and an OK button.

You can find more information on constants in the MSDN documentation from
Microsoft.

Effect:

All message boxes from COMOS are routed to the ShowMessageBox function of this
object.

Application example:

Suppress all message boxes and/or redirect them to DBMon.

Example

Class that implements the IMessageBoxHandler interface:

[ComVisible(true)]

[ComDefaultInterface(typeof(IMessageBoxHandler))]

[ClassInterface(ClassInterfaceType.None)]

[GuidAttribute("")] // GUID creating and entering

public class CustomMessageBoxHandler : IMessageBoxHandler

short _IMessageBoxHandler.ShowMessageBox(string txt, string caption, short Mode)

// The message is intercepted here

}
Example

Create instance of the class listed above that is then registered at the Workset:

private void InitMsgBoxHandler()

CustomMessageBoxHandler messageBoxHandler = new CustomMessageBoxHandler();

// s_Workset = (Plt.IComosDWorkset)new Plt.CPLTWorksetClass();

// create only if none exists yet.

s_Workset.MessageBoxHandler = (Plt.IMessageBoxHandler)messageBoxHandler;

.NET

If the class is written in .NET , observe the following conditions:

The class must be COM-Visible.

The Property must be casted to the Interface in the assignment.

In Section Instructions Examples Basics History Extra

IRollbackStateEntry

This chapter contains the following information:IRollbackStateEntry

Rollback

GetUID

OnRollbackBegin

OnRollbackDone
In Section Instructions Examples Basics History Extra

IRollbackStateEntry

The interface that is required for the IComosDRollbackState.AddRollbackStateEntry

method.

It is used to integrate non-COMOS objects into the Rollback administration (for

example, this is the case in COMOS with Reportitems). These objects must implement
this interface and then be added to the Rollbackstate using the
AddRollbackStateEntry method.

The object must save the backup information itself; the backup information is only
called here.

The constant Mode is defined in RollbackStateEntry_Mode_.

In Section Instructions Examples Basics History Extra

Rollback

Rollback(ByVal Mode as Integer) as Boolean

Called when rolling back the rollback state. Rollback is called for each individual
Item.

In Section Instructions Examples Basics History Extra

GetUID

GetUID() as String

Must return a unique key. Please note: Since this involves "foreign" objects, it is
not a COMOS UID that is processed here but instead a key that has the function of
the COMOS UID.

In Section Instructions Examples Basics History Extra

OnRollbackBegin

OnRollbackBegin(ByVal Mode as Integer) as Boolean

Called when rolling back the rollback state. Called for each individual Item before
the rollback.

In Section Instructions Examples Basics History Extra

OnRollbackDone

OnRollbackDone(ByVal Mode as Integer) as Boolean

Called when rolling back the rollback state. Called for each individual Item after
the rollback.

In Section Instructions Examples Basics History Extra

IXObject

This chapter contains the following information:Container

GetVersion
OnCopy

OnCreate

OnDelete

OnGetProgID

OnLoad

OnSave

OnScan

ShutDown

In Section Instructions Examples Basics History Extra

Container

Container() as Object

The COMOS object with which the XObject is associated.

In Section Instructions Examples Basics History Extra

GetVersion

GetVersion() as Long

Must return the version of the archive of the XObject.

In Section Instructions Examples Basics History Extra

OnCopy

OnCopy()

Called when copying the XObject.

In Section Instructions Examples Basics History Extra

OnCreate

OnCreate()

Not currently used.

In Section Instructions Examples Basics History Extra

OnDelete

OnDelete()

Called when saving a deleted XObject.

In Section Instructions Examples Basics History Extra

OnGetProgID
OnGetProgID() as String

Must return the ProgId of the XObject.

In Section Instructions Examples Basics History Extra

OnLoad

OnLoad(ByVal Archiv as Object, ByVal Version as Long)

Called when loading the XObject.

In Section Instructions Examples Basics History Extra

OnSave

OnSave(ByVal Archiv as Object, ByRef Version as Long)

Called when saving the XObject.

In Section Instructions Examples Basics History Extra

OnScan

OnScan(ByVal Scanmanager as Object)

Not currently used.

In Section Instructions Examples Basics History Extra

ShutDown

ShutDown()

Called by ShutDownXObj.

In Section Instructions Examples Basics History Extra

Object model graphics (Object hierarchy)

This chapter contains the following information:OwnCollections

Reference

In Section Instructions Examples Basics History Extra

OwnCollections

See also IComosDOwnCollection.

In Section Instructions Examples Basics History Extra

Reference

This chapter contains the following information:Background information

References at BaseObject

Own references (Pointer)

Calculated references

In Section Instructions Examples Basics History Extra

Background information

Inheritable classes: Property versus OwnProperty

Only very few classes can be inherited:

Attributes, connectors, documents (in base object tree only), symbols (in base
object tree only), CDevices as elements (in base object tree only).

Of these five classes, only attributes and connectors can be inherited both in the
base object tree and from the base data to the engineering data (as explained
above).

Therefore, (almost all) properties are also available as OwnProperty for these two
classes of attributes and connectors. Example for IComosDConnector: Cable /
OwnCable, Potential / OwnPotential.

BackPointerCollections: OwnCollections versus TempCollections

BackPointerCollections can be of the type IComosDOwnCollection or

IComosDCollection.

Example:

BackPointerCDevices as IComosDOwnCollection or

BackPointerConnectors as IComosDCollection.
Comparison of the two types

IComosDOwnCollection

If you use this type, the data is read into the memory with the first access and
used again with future access. Provided the project is not changed, the
IComosDOwnCollection remains in the memory and can be called (almost) instantly.

IComosDCollection

If you use this type, the data is recalculated with each access. Operations using
them are thus correspondingly time-consuming. If you repeatedly access them, you
should (if possible) assign them to a variable so that they are then held in memory
instead.

BackPointerCollections which have All in their name are generally of type

IComosDCollection.

Example:

AllConnectors ( ) as IComosDCollection .

Access to BackPointerCollections is generally read-only.

CDocument versus RealCDocument

CDocument is calculated from RealCDocument.

Background:

Each report object owns a report template object. This connection is not
established via the UID, however, but instead via the PathFullName. Advantage: you
can simply swap the report template object and each report object recognizes the
new report template object without any further ado.

Since the connection is established via the PathFullName, it is also possible to

"superimpose" a report template object. Normally, the report template object comes
from the base project. However, if there is a report template object with the same
PathFullName in the engineering project (the project is not included in the
PathFullName), then the report template object from the engineering project takes
priority.

RealCDocument always relates to the report template object from the base project.

CDocument first checks whether a report template object with the same PathFullName
also exists in the current engineering project. If that is the case, then the
report template object is supplied from the planning project. For this reason, it
always better for regular users to use CDocument.

In Section Instructions Examples Basics History Extra

References at BaseObject

Class

Reference

(Function or Property)/

Backpointer

Class

IComosBaseObject

InheritParent (calculated)

Owner

In Section Instructions Examples Basics History Extra

Own references (Pointer)

Class

Reference

(Function or Property)/
Backpointer

Class

IComosDCase

IComosDCDevice

CDevice

BackPointerCDevices

IComosDCDevice

IComosDCDevice

CObject

As CDevice

IComosDCDevice

OwnDeviceGroup

BackPointerCDevices

IComosDDevice

IComosDDevice

IComosDCLink

Reference

Each BaseObject instance

BackPointerCLinks, but only for the following BaseObject instances:

CDevice:

BackPointerCLinks

Connector:
BackPointerCLinks

CSpecificationSet:

BackPointerCLinks

Document:

BackPointerCLinks

IComosDConnector

See above, Inherited classes: Property contra OwnProperty.

Then, see also IComosDConnector in section Calculated references .

Document

IcomosDDocument

ConnectedWith

IComosDConnector

OwnCable, see also Cable.

BackPointerConnectors

IComosDDevice

OwnPotential

No BackPointer coll., but similar: ConnectorsWhichUsePotential

IComosDDevice

OwnSignal

No BackPointer coll., but similar: ConnectorsWhichUseSignal

IComosDDevice

IComosDConnectorAttributeItem

IComosDCSpecificationSet

IComosDDevice

Alias

BackPointer coll. not necessary, since a 1-to-1-reference that can be checked

exists

IComosDDevice

CDevice

BackPointerDevices

IComosDCDevice

CObject

BackPointerDevices

IComosDCDevice

Implementation

BackPointerDevicesWithImplementation

IComosDDevice

Location

BackPointerDevicesWithLocation

Actually, every BaseObject instance, but then limited to Device, Class Location
Position

Now only read-only

Each BaseObject instance

Unit

BackPointerDevicesWithUnit

Actually, every BaseObject instance, but then limited to Device, Class Unit

IComosDDevSymbol

IComosDDocObj

Reference

BackPointerDocObjs, but only for the following BaseObject instances:

Device,

Connector

Each BaseObject instance

Reference2

Each BaseObject instance

IComosDDocument

See also IComosDConnector in section Calculated references .

Case

Each BaseObject instance

CDocument

See CDocument versus RealCDocument.

IComosDCDevice

CObject

No BackPointer-Coll, but function BackPointerObjects (with SystemType Document)

IComosDCDevice

DocumentType

IComosDDocumentType

Location

BackPointerDevicesWithLocation

Actually, every BaseObject instance, but then limited to Device, Class Location

OrgDocument

BackPointerDocumentsWithOrgDocument

IComosDDocument

RealCDocument

BackPointerDocuments

IComosDDocument
Unit

BackPointerDevicesWithUnit

Actually, every BaseObject instance, but then limited to Device/Unit

IComosDDocumentType

IComosDLanguage

IComosDLocation

CObject

No BackPointer-Coll, but BackPointerObjects function (SystemType Location)

IComosDCDevice

IComosDObjectRevision

IComosDPhysUnit

IComosDPhysUnitGroup

PhysD3Unit

IComosDPhysUnit

PhysDefaultUnit

BackPointer coll. not necessary, since its calculation is easy: query the owner

IComosDPhysUnit
PhysDefaultUnit1 and following

IComosDPhysUnit

PhysSIUnit

BackPointer coll. not necessary, since its calculation is easy: query the owner

IComosDPhysUnit

IComosDProject

CDeviceSystem

BackPointer coll. not necessary, since its calculation is easy: query the project

IComosDProject

CurrentLanguage

BackPointer coll. not necessary, since its calculation is easy: query the project

IComosDLanguage

CurrentObjectRevision

BackPointer coll. not necessary, since its calculation is easy: query the project

IComosDObjectRevision

CurrentWorkingOverlay

BackPointer coll. not necessary, since its calculation is easy: query the project

IComosDWorkingOverlay

UserSystem

BackPointer coll. not necessary, since its calculation is easy: query the project

IComosDProject
Cases

No BackPointer coll., but GetCurrentCase, SetCurrentCase

IComosDCase

IComosDProject

IComosDRight

Reference

BackPointer coll. not necessary, since its calculation is easy: query the object

Each BaseObject instance

User

BackPointerRights , BackPointerRights

Actually every BaseObject instance, but then only limited to User or UserGroup

IComosDSpecification

See above, Inherited classes: Property contra OwnProperty.

OwnCSpecification

BackPointerSpecifications

IComosDSpecification

OwnLinkObject

BackPointerSpecificationsWithLinkObject

Each BaseObject instance

RealStandardTable

BackPointerSpecifications

IComosDStandardTable
IComosDSpecificationSet

CObject

No BackPointer coll., but function BackPointerObjects (with SystemType

SpecificationSet)

IComosDCDevice

CSpecificationSet

BackPointerSpecificationSets

IComosDCSpecificationSet

IComosDStandardTable

DefaultValue

IComosDStandardValue

IComosDStandardValue

IComosDOwnCollection

IComosDTimestamp

User

IComosDUser

IComosDUnit

CObject

No BackPointer coll., but function BackPointerObjects (with SystemType Unit)

IComosDCDevice

IComosDUser
IComosDUserGroup

IComosDWorkingOverlay

In Section Instructions Examples Basics History Extra

Calculated references

Class

Reference

(Function or Property)/

Backpointer

Class

IComosDCDevice

DeviceGroup

Calculated from OwnDeviceGroup

IComosDDevice

IComosDConnector

See above, Inherited classes: Property contra OwnProperty.

Cable

Is calculated from OwnCable of another object.

IComosDDevice

OwnWire

Is calculated from OwnCable and OwnCableIndex of another object.

IComosDDevice

Potential

Is calculated from OwnPotential of another object.

IComosDDevice

Signal

Is calculated from OwnSignal of another object.

IComosDDevice

Wire

Is calculated from Cable. BackPointer coll not necessary, since a 1-to-1 reference
that can be queried with "Connected" exists

IComosDDevice

IComosDDocument

First see CDocument versus RealCDocument.

CDocument

Calculated after RealCDocument

IComosDDocument

IComosDSpecification

CSpecification

IComosDSpecification
LinkObject

Each BaseObject instance

OwnStandardTable

IComosDStandardTable

StandardTable

IComosDStandardTable

In Section Instructions Examples Basics History Extra

COMOS constants

This chapter contains the following information:CDeviceConstants

ClassificationTypes

ComosSystemConstants

ComosSystemTypes

ConsolidationShadowObjectLocation

ConsolidationStatusValue

dbType

PopupMenuConstants

SoftDeleteMode
In Section Instructions Examples Basics History Extra

CDeviceConstants

This chapter contains the following information:Alias

CalcToEx

CDeviceConstants

Chapter

ConnectorConstants

DetailClass

DeviceClass

DocumentType

InternalConnection_

IsPlaced

Layer

Layers

LicenseModule

Login_

Reports

RevisionArchive

Revisions

RevisionType

RIClass

ScanDevices

SpecCalc

SpecificationType

SpecLink

StaticLinkOperator
Template

Various

In Section Instructions Examples Basics History Extra

Alias

AliasLocation

"@Alias"

AliasUnit

"@Alias"

In Section Instructions Examples Basics History Extra

CalcToEx

CalcToExNoCalculationPossible

"NO_CALC_POSSIBLE"

CalcToExNoNumericSpec

"NO_NUMERIC_SPEC"

CalcToExNoNumericSpecValue

"NO_NUMERIC_SPEC_VALUE"
In Section Instructions Examples Basics History Extra

CDeviceConstants

CDeviceConstantsAccessory

"@A"

CDeviceConstantsAssembly

"@B"

CDeviceConstantsAttributes

"@Y"

CDeviceConstantsCable

"@Cable"

CDeviceConstantsCableChannel

"@K"

CDeviceConstantsCatalog

"@D"

CDeviceConstantsCElement

"@E"

CDeviceConstantsConnector

"@N"
CDeviceConstantsCost

"@C"

CDeviceConstantsDetail

"@Detail"

CDeviceConstantsDeviceSpecification

"@V"

CDeviceConstantsDName

"@2"

CDeviceConstantsDocument

"@O"

The databases of the type "cDB" included a standardized root node of the base
objects for documents: "@O". This constant describes the name of this root node.

The root node "@O" is no longer used in the databases of type "iDB". This means the
constant CDeviceConstantsDocument will not return a value in the databases of type
"iDB". In COMOS 10.1, the constant is no longer used by COMOS. If the constant is
still to be used as part of customizing, the script has to be adapted accordingly
to the database type.

CDeviceConstantsDocumentGroup

"@G"

CDeviceConstantsEContacts

"@C"

CDeviceConstantsElement

"@Element"
CDeviceConstantsEModuls

"@M"

CDeviceConstantsEOthers

"@O"

CDeviceConstantsETransformers

"@T"

CDeviceConstantsFunction

"@F"

CDeviceConstantsFunctionBlock

"@H"

CDeviceConstantsFunctionElement

"@W"

CDeviceConstantsGroup

"@Z"

CDeviceConstantsInformation

"@I"

CDeviceConstantsInstrument

"@Instrument"

CDeviceConstantsLocalInstance

"@LocalInstance"
CDeviceConstantsLocation

"@L"

CDeviceConstantsMaintenance

"@M"

CDeviceConstantsPipe

"@Pipe"

CDeviceConstantsPlug

"@Plug"

CDeviceConstantsPlugStrip

"@PlugStrip"

CDeviceConstantsPosition

"@P"

CDeviceConstantsPotential

"@Potential"

CDeviceConstantsProcessing

"@X"

CDeviceConstantsProject

"@J"

CDeviceConstantsQualityAssurance

"@Q"
CDeviceConstantsRevision

"@R"

CDeviceConstantsRI

"@RI"

CDeviceConstantsSignal

"@S"

CDeviceConstantsSymbol

"@Symbol"

CDeviceConstantsTerminal

"@Terminal"

CDeviceConstantsTerminalStrip

"@TerminalStrip"

CDeviceConstantsTime

"@T"

CDeviceConstantsType

"@3"

CDeviceConstantsUnit

"@U"

CDeviceConstantsWire

"@Wire"
In Section Instructions Examples Basics History Extra

Chapter

ChapterSpecification

"@C"

In Section Instructions Examples Basics History Extra

ConnectorConstants

ConnectorConstants3DConstruction

"K"

ConnectorConstantsElo

"E"

ConnectorConstantsEBlock

"B"

ConnectorConstantsFeed

"D"

ConnectorConstantsFluid
"U"

ConnectorConstantsFup

"F"

ConnectorConstantsGeneral

"G"

ConnectorConstantsInfraStructure

"I"

ConnectorConstantsIOInput

"I"

ConnectorConstantsIOInputAndIntrinsicalSafety

"J"

ConnectorConstantsIOIntrinsicalSafety

"S"

ConnectorConstantsIONeutral

"N"

ConnectorConstantsIOOutput

"O"

ConnectorConstantsIOOutputAndIntrinsicalSafety

"P"

ConnectorConstantsPotential
"L"

ConnectorConstantsProcess

"P"

ConnectorConstantsRI

"R"

ConnectorConstantsSignal

"S"

In Section Instructions Examples Basics History Extra

DetailClass

Table 3:

DetailClassActionBlock

"9"

DetailClassBlackbox

"Z"

DetailClassCabinet

"N"

DetailClassCable

"C"
DetailClassCategorie

"6"

DetailClassConnectionbreak

"B"

DetailClassConsumer

">"

DetailClassContactor

"X"

DetailClassDataPoint

"d"

DetailClassDecisionTable

"J"

DetailClassEquipment

"A"

DetailClassFieldSignal

"f"

DetailClassFitting

"U"

DetailClassGrafic

"0"
DetailClassImport

"5"

DetailClassInstrument

"W"

DetailClassLocalVariable

"a"

DetailClassLogPotential

"G"

DetailClassMaterialPointer

"*"

DetailClassMaterialStream

"#"

DetailClassNetaddress

"D"

DetailClassNozzle

"<"

DetailClassPipe

"Q"

DetailClassPlug
"L"

DetailClassPlugStrip

"P"

DetailClassPotential

"O"

DetailClassQueryCDevice

"2"

DetailClassQueryConnector

"F"

DetailClassQueryDevice

"1"

DetailClassQueryDocument

"3"

DetailClassQueryGeneral

":"

DetailClassQuerySpecification

"4"

DetailClassRack

"R"

DetailClassRoom
"M"

DetailClassScript

"K"

DetailClassSegment

"E"

DetailClassSlot

"Y"

DetailClassStep

"7"

DetailClassSymbol

"H"

DetailClassTerminal

"T"

DetailClassTerminalStrip

"S"

DetailClassTransition

"8"

DetailClassVisualisationElement

"V"
DetailClassWire

"I"

In Section Instructions Examples Basics History Extra

DeviceClass

Table 4:

DeviceClassAccessory

"A"

DeviceClassAction

"J"

DeviceClassAssembly

"B"

DeviceClassCableChannel

"K"

DeviceClassConnector

"N"

DeviceClassCost

"C"

DeviceClassDevice

"D"
DeviceClassDeviceSpecification

"V"

DeviceClassDocument

"O"

DeviceClassDocumentGroup

"G"

DeviceClassElement

"E"

DeviceClassFunction

"F"

DeviceClassFunctionBlock

"H"

DeviceClassFunctionElement

"W"

DeviceClassGroup

"Z"

DeviceClassInformation

"I"

DeviceClassLocation
"L"

DeviceClassMaintenance

"M"

DeviceClassPosition

"P"

DeviceClassProcessing

"X"

DeviceClassQualityAssurance

"Q"

DeviceClassRevision

"R"

DeviceClassSignal

"S"

DeviceClassTime

"T"

DeviceClassTopLevel

"["

DeviceClassUnit

"U"
In Section Instructions Examples Basics History Extra

DocumentType

Table 5:

DocumentTypeAdobePDF

"AdobePDF"

DocumentTypeAutoCad

"AutoCAD"

DocumentTypeComosReport

"ComosReport"

DocumentTypeCXCDocument

"XML-Document"

DocumentTypeCXCTemplate

"XML-Template"

DocumentTypeExcel

"Excel"

DocumentTypeGeneralDocument

"GeneralDocument"

DocumentTypeImagineer

"Imag"
DocumentTypeIReport

"ComosIReport"

DocumentTypeLogiCad

"LogiCad"

DocumentTypeLogoCad

"LogoCad"

DocumentTypeMasterIReport

"ComosMasterIReport"

DocumentTypeMasterReport

"ComosMasterReport"

DocumentTypeOLE

"OLE"

DocumentTypePackage

"Package"

DocumentTypePowerPoint

"PowerPoint"

DocumentTypeReference

"Reference"

DocumentTypeTiff

"TIFF"
DocumentTypeTriga

"Triga"

DocumentTypeUndefine

"Undefine"

DocumentTypeWord

"Word"

In Section Instructions Examples Basics History Extra

InternalConnection_

InternalConnectionSeparatePotential

"@SepP"

InternalConnectionSeparateSignal

"@SepS"

In Section Instructions Examples Basics History Extra

IsPlaced

IsPlacedD3
"3D"

Belongs to IsPlaced

In Section Instructions Examples Basics History Extra

Layer

LayerInvisible

"~"

LayerInvisibleTpl

Tpl

In Section Instructions Examples Basics History Extra

Layers

LayersAllForGroup

"@"

LayersNoLayer

"/"
In Section Instructions Examples Basics History Extra

LicenseModule

LicenseModulAdmin

"Administrator"

LicenseModulAliasIRoute

"Alias-IRoute"

LicenseModulAspenPlusInterface

"AspenPlus-Interface"

LicenseModulBasis

"Basic"

LicenseModulChemCadInterface

"ChemCad-Interface"

LicenseModulCM

"ConceptualModeler"

LicenseModulDetailET

"Detail-ET"

LicenseModulDetailFUP

"Funktionsplan"
LicenseModulDetailMSR

"Detail-MSR"

LicenseModulDGNIMPORT

"DGN-Import"

LicenseModulEbsilonProInterface

"EbsilonPro-Interface"

LicenseModulEloCad

"Elektrotechnik"

LicenseModulESIGN

"eSign"

LicenseModulETAdvanced

"ET-Advanced"

LicenseModulEXF

"EXF"

LicenseModulExternalAccess

"External-Access"

LicenseModulFDA

"FDA"

LicenseModulFluid

"Fluid"
LicenseModulHTFSInterface

"HTFS-Interface"

LicenseModulHTRIInterface

"HTRI-Interface"

LicenseModulHYSYSInterface

"HYSYS-Interface"

LicenseModuliAge

"iAge"

LicenseModuliAgeDirect

"IAgeDirect"

LicenseModuliAgeEventManager

"IAgeEventManager"

LicenseModuliAgeShutDown

"IAgeShutDown"

LicenseModulInspection

"Inspection"

LicenseModulISO

"ISO"

LicenseModulMechatronic

"Mechatronic"
LicenseModulPE

"Prozess-Engineering"

LicenseModulPFD

"PFD"

LicenseModulPID

"PID"

LicenseModulPIDDocument

"PIDDocument"

LicenseModulPipeClassManager

"PipeClassManager"

LicenseModulPIPEEASY

"PipeEasy"

LicenseModulPPC

"PPC"

LicenseModulPQM

"PQM"

LicenseModulProIIInterface

"ProII-Interface"

LicenseModulProMaxInterface

"ProMax-Interface"
LicenseModulReportToExcel

"ReportToExcel"

LicenseModulReportToWord

"ReportToWord"

LicenseModulRI

"RI-Schema"

LicenseModulRMO

"RMO"

LicenseModulRuplan

"Ruplan"

LicenseModulSequenceDesigner

Obsolete.

LicenseModulSystem

"System"

LicenseModulSystemInternal

"SystemInternal"

LicenseModulTestDemo

"TESTDEMO-Modul"

LicenseModulTRMO
"TRMO"

LicenseModulUniSimDesignInterface

"UniSimDesign-Interface"

LicenseModulViewESign

"VieweSign"

LicenseModulViewing

"Viewing"

LicenseModulVIPER

"Viper"

LicenseModulXMPlantInterface

"XMPlant-Interface"

In Section Instructions Examples Basics History Extra

Login_

Table 7:

Login_Oracle

"[ORACLE]"

Login_SQL2000

"[SQL - 2000]"
Login_SQLServer

"[SQL - SERVER]"

In Section Instructions Examples Basics History Extra

Reports

ReportsDirectory

""

In Section Instructions Examples Basics History Extra

RevisionArchive

Table 8:

RevisionArchiveAdobePDF

"AdobePDF"

RevisionArchiveDestiller

"PDF"

RevisionArchivePDFFactory

"PDF_FACTORY"

RevisionArchivePDFWriter
"PDF_WRITER"

RevisionArchiveTIFF

"TIFF"

In Section Instructions Examples Basics History Extra

Revisions

RevisionsDirectory

"Revisions"

In Section Instructions Examples Basics History Extra

RevisionType

Table 9:

RevisionsNoRevision

"NO_REVISION"

RevisionsStandardRevision

"STANDARD_REVISION"

In Section Instructions Examples Basics History Extra

RIClass

Table 10:

RevisionsBlackBox

"B"

RevisionsFitting

"F"

RevisionsPipe

"P"

RevisionsSymbol

"S"

In Section Instructions Examples Basics History Extra

ScanDevices

ScanDevicesStopDocObj

"#"

In Section Instructions Examples Basics History Extra

SpecCalc

ScanDevicesFromD3

"@D3"

ScanDevicesFromDefault

"@Default"

ScanDevicesFromSI

"@SI"

In Section Instructions Examples Basics History Extra

SpecificationType

SpecificationTypeAlphaNumeric

"A"

SpecificationTypeDate

"D"

SpecificationTypeNumeric

"N"

SpecificationTypeSignature

"S"
SpecificationTypeText

"C"

In Section Instructions Examples Basics History Extra

SpecLink

SpecLinkOwnLinkObject

"@S@"

In Section Instructions Examples Basics History Extra

StaticLinkOperator

Table 11:

StaticLinkOperatorEqual

"A"

StaticLinkOperatorGreater

"D"

StaticLinkOperatorGreaterOrEqual

"E"

StaticLinkOperatorInRange
"F"

StaticLinkOperatorLess

"B"

StaticLinkOperatorLessOrEqual

"C"

StaticLinkOperatorOuterRange

"G"

StaticLinkOperatorScript

"I"

StaticLinkOperatorUnEqual

"H"

In Section Instructions Examples Basics History Extra

Template

Table 12:

TemplateLocation

"@Template"

TemplateSpecification

"@Tpl"
TemplateSpecificationMainObject

"@TpIM"

TemplateUnit

"@Template"

In Section Instructions Examples Basics History Extra

Various

CDeviceSystemProject

"S"

ComosSystemProject

"@"

ComosSystemProjectName

"@COMOSSYSTEM"

UserSystemProject

"V"

WorkingProject

"P"

XLocation

"LOCATIONORDEVICELOCATION"
XUnit

"UNITORDEVICEUNIT"

In Section Instructions Examples Basics History Extra

ClassificationTypes

This chapter contains the following information:ClassificationTypes

In Section Instructions Examples Basics History Extra

ClassificationTypes

FunctionalClassification

FunctionalUserClassification

HierarchicalClassification

HierarchicalUserClassification

4
In Section Instructions Examples Basics History Extra

ComosSystemConstants

This chapter contains the following information:Active_Mode

Admin

BackPointer_Behaviour_

CaseType

CDevice

CDeviceBySystemFullName_Mode_

CDeviceCreateOption

ChangedObjectsCode

ClipboardError

ComosModul

ComosModule

ComosNull

Connect

ConnectorLabelMode

Conector_IsConsistent_

CopyManagerMode

CrossProject

Current

DatabaseOperationsOverlayMode

DatabaseMaintenance

DBPriority_

DBSearch_Property_
DDMDocType

DecimalDelimiter_

Delete_Error_Objects_Mode_

DeviceCreateMode

DocError_

DocObjCopyMode

DocTypeMode

DocumentConstants

DocumentMode

Error

ErrorObjectsMode

ExtendedRight_

FunctionRight

GeneratorType

Implementation_Behaviour_

ImportOverlay

InheritableFlagState

InheritCheckInError

InheritMode

IsValueValid

LicenseModule

Link

MassOperation_

NRGCheck

SpecInheritance

ObjectHistoryStatus_

ObjectMerge_

ObjectMerge_Property_

ObjectMerge_SubObject_

ObjectOverlayBehaviour_
ObjectRevisionStatus_

Object_Get_Overlays

Operator

OverlayCheckDuplicateNames

OverlayCheckOpenRevisions

OverlayCheckPlantRevisions

OverlayCheckStarVersions

OverlayOpenRevisionType

OverlayStatus_

Overlay_DBStatus_

Overlay_Delete_Mode_

Overlay_Lock_Mode_

Performance_Value_Col_Load_

ProductRequestOperator

ProductRequest_Behaviour_

ProductValue

Project

Range

Range_

ScientificNotation

Reference_Behaviour_

RegisterForReleaseStaticCollectionsMode

ReleaseCheck

Resource_Type_

Rights

RollbackStateEntry_Mode_

RunMode

Scan_CDevice_

Scan_Documents_
ScanDocumentsMode

ScanManager_

ScriptBlock

SignalMode

SpecD3Mode

SpecInheritance

StandardTable_Type_

StartMode_

StatusDirectionMode

StatusSetMode

System_Status_

System_Status_Consolidation_

System_Status_Overlay_

System_Status_ReadOnly_

TransferProjectMode

WfTaskObject

WorkflowObserved

In Section Instructions Examples Basics History Extra

Active_Mode

Active_Mode_Inactive

Active_Mode_Normal

0
In Section Instructions Examples Basics History Extra

Admin

AdminRight

In Section Instructions Examples Basics History Extra

BackPointer_Behaviour_

BackPointer_Behaviour_Not_Relevant

BackPointer_Behaviour_Show

In Section Instructions Examples Basics History Extra

CaseType

CaseTypeDevice

2
CaseTypeProject

In Section Instructions Examples Basics History Extra

CDevice

CDeviceDefaultVirtual

19998 (&H4E1E)

CDeviceInfiniteVirtuals

19999 (&H4E1F)

In Section Instructions Examples Basics History Extra

CDeviceBySystemFullName_Mode_

CDeviceBySystemFullName_Mode_CDevice

CDeviceBySystemFullName_Mode_CDeviceOwn

CDeviceBySystemFullName_Mode_OwnCDevice

1
CDeviceBySystemFullName_Mode_OwnProject

In Section Instructions Examples Basics History Extra

CDeviceCreateOption

CDeviceCreateOptionBlock

CDeviceCreateOptionGroup

CDeviceCreateOptionObject

CDeviceCreateOptionStructureGroup

In Section Instructions Examples Basics History Extra

ChangedObjectsCode

ChangedObjectsCodeCollection
2

ChangedObjectsCodeCVS

ChangedObjectsCodeExtern

ChangedObjectsCodeObject

ChangedObjectsCodeOverlayStatus

ChangedObjectsCodeSMS

In Section Instructions Examples Basics History Extra

ClipboardError

ClipboardErrorCheckedIn

306

ClipboardErrorCollection

300

ClipboardErrorInheritCheckInNotEnabled
308

ClipboardErrorNoObject

305

ClipboardErrorNoRights

303

ClipboardErrorOwnerNotInCurrentProject

309

ClipboardErrorOwnerTemporary

311

ClipboardErrorSoftDeleted

310

ClipboardErrorTemporary

301

ClipboardErrorWrongOwner

304

ClipboardErrorWrongProject

302

ClipboardErrorWrongSpecType

307
In Section Instructions Examples Basics History Extra

ComosModul

Undocumented, because this constant cannot be used.

In Section Instructions Examples Basics History Extra

ComosModule

ComosModuleAdmin

ComosModuleAliasIRoute

20

ComosModuleBasic

ComosModuleCM

23

ComosModulConstructionAssistant

45

Constants for new licenses

ComosModuleDetailET

ComosModuleDetailFUP

ComosModuleDetailMSR

ComosModuleDGNImport

27

ComosModuleEloCad

ComosModuleeSign

25

ComosModuleETAdvanced

14

ComosModuleEXF

15

ComosModuleExternalAccess

30

ComosModuleFDA

24
ComosModuleFluid

31

ComosModuleiAge

22

ComosModulInspection

43

ComosModuleISO

21

ComosModulePE

ComosModulePFD

ComosModulePID

19

ComosModulePipeClassManager

28

ComosModulePipeEasy

26

ComosModulePPC

29
ComosModulePQM

32

ComosModuleReportToExcel

18

ComosModuleReportToWord

13

ComosModuleRI

ComosModuleRMO

11

ComosModuleRuplan

16

ComosModuleTRMO

12

ComosModuleVieweSign

33

ComosModuleViewing

10

ComosModuleViper
17

In Section Instructions Examples Basics History Extra

ComosNull

ComosModuleDouble

-999,9

ComosModuleInt

-9999

ComosModulPlantModeler

In Section Instructions Examples Basics History Extra

Connect

ConnectAlreadyConnected

ConnectInheritCheckInNotEnabled

ConnectOK

0
ConnectSameObject

12

ConnectWrongAttribute

11

ConnectWrongColour

ConnectWrongConnectionLenght

10

ConnectWrongCrossSection

ConnectWrongLayer

ConnectWrongNumber

ConnectWrongProject

ConnectWrongTypeInfo

ConnectWrongWire
3

In Section Instructions Examples Basics History Extra

ConnectorLabelMode

ConnectorLabelModeNormal

ConnectorLabelModeOwner

In Section Instructions Examples Basics History Extra

Conector_IsConsistent_

Conector_IsConsistent_Consistent

Conector_IsConsistent_Empty

Conector_IsConsistent_InConsistent

1
In Section Instructions Examples Basics History Extra

CopyManagerMode

CopyManagerModeAllReferences

CopyManagerModeOnlyCDeviceReferences

In Section Instructions Examples Basics History Extra

CrossProject

CrossProjectCopy_Error_MissingRights

-2

CrossProjectCopy_Error_ObjIsTemporary

-4

CrossProjectCopy_Error_WorkingLayersNotAllowed

-3

CrossProjectCopy_Error_WrongParam

-1
In Section Instructions Examples Basics History Extra

Current

Table 13:

CurrentComosVersion

running counter

CurrentDocumentVersion

running counter

In Section Instructions Examples Basics History Extra

DatabaseOperationsOverlayMode

Table 14:

ADatabaseOperationsOverlayModellOverlays

DatabaseOperationsOverlayModeApprovedArea

In Section Instructions Examples Basics History Extra

DatabaseMaintenance
DatabaseMaintenanceOptionFixCorruptedUIDs

0x0001

Is part of the "Database maintenance" functionality. See also IComosDWorkset:

RunDatabaseMaintenance.

DatabaseMaintenanceOptionRemoveDeletedRecords

0x0010

Is part of the "Database maintenance" functionality. See also IComosDWorkset:

RunDatabaseMaintenance.

DatabaseMaintenanceOptionFixClassifications

0x0004

Is part of the "Database maintenance" functionality. See also IComosDWorkset:

RunDatabaseMaintenance.

DatabaseMaintenanceOptionFixEmptyStrings

0x0002

Is part of the "Database maintenance" functionality. See also IComosDWorkset:

RunDatabaseMaintenance

DatabaseMaintenanceOptionFixExtensionTables

0x0020

Is part of the "Database maintenance" functionality. See also IComosDWorkset:

RunDatabaseMaintenance

DatabaseMaintenanceOptionFixHierarchy

0x0040

Is part of the "Database maintenance" functionality. See also IComosDWorkset:

RunDatabaseMaintenance
DatabaseMaintenanceOptionFixReferences

0x0008

Is part of the "Database maintenance" functionality. See also IComosDWorkset:

RunDatabaseMaintenance

DatabaseMaintenanceOptionManyUpdatesExpected

0x4000

Is part of the "Database maintenance" functionality. See also IComosDWorkset:

RunDatabaseMaintenance

In Section Instructions Examples Basics History Extra

DBPriority_

Table 15:

DBPriority_High

DBPriority_Low

DBPriority_VeryHigh

DBPriority_VeryLow

In Section Instructions Examples Basics History Extra

DBSearch_Property_

Table 16:

DBSearch_Property_Description

DBSearch_Property_Description2

16

DBSearch_Property_Description3

32

DBSearch_Property_FileName

128

DBSearch_Property_Label

DBSearch_Property_Name

DBSearch_Property_Value

DBSearch_Property_XValue

64
In Section Instructions Examples Basics History Extra

DDMDocType

DDMDocTypeExported

Describes the internal type of a DVM document. Up to now the internal type was
stored as a number.

DDMDocTypeExported = 14

DDMDocTypeCheckedIn

Describes the internal type of a DVM document. Up to now the internal type was
stored as a number.

DDMDocTypeCheckedIn = 11

DDMDocTypeCheckedOut

Describes the internal type of a DVM document. Up to now the internal type was
stored as a number.

DDMDocTypeChekkedOut = 10

DDMDocTypeVersion

Describes the internal type of a DVM document. Up to now the internal type was
stored as a number.

DDMDocTypeVersion = 13

In Section Instructions Examples Basics History Extra

DecimalDelimiter_
DecimalDelimiter_Comma

DecimalDelimiter_Point

In Section Instructions Examples Basics History Extra

Delete_Error_Objects_Mode_

Table 17:

Delete_Error_Objects_Mode_D3

Delete_Error_Objects_Mode_Normal

In Section Instructions Examples Basics History Extra

DeviceCreateMode

DeviceCreateModeElements

DeviceCreateModeNormal
0

DeviceCreateModeSubElements

In Section Instructions Examples Basics History Extra

DocError_

DocError_ContainsInconsistentObjects

DocError_Copied

DocError_NoError

DocError_NotEvaluated

In Section Instructions Examples Basics History Extra

DocObjCopyMode

DocObjCopyModeDelete
1

DocObjCopyModeOldReference

DocObjCopyModeWithDevice

In Section Instructions Examples Basics History Extra

DocTypeMode

DocTypeModeExternalFile

DocTypeModeNoFile

In Section Instructions Examples Basics History Extra

DocumentConstants

DocumentConstantsMaster

2
DocumentConstantsNormal

DocumentConstantsReference

DocumentConstantsTemplate

In Section Instructions Examples Basics History Extra

DocumentMode

Table 18:

DocumentModeCDeviceOnly

DocumentModeCopy

DocumentModeReference

This makes it easier to manage referenced documents. Old: e.g. you needed a
document that in the units or document groups in the base project which was made
available via a base object. Thereafter you had a reference in the engineering
project to the document in the base project in the unit. New. The document can now
be actually located underneath a base object and the engineering document has a
reference to the document below the base object.

DocumentModeStructure
4

DocumentModeVariant

DocumentModeVirtual

In Section Instructions Examples Basics History Extra

Error

Table 19:

ErrorCDeviceIsReadOnlyByLayers

666

New error message

In Section Instructions Examples Basics History Extra

ErrorObjectsMode

ErrorObjectsModeCheck

ErrorObjectsModeExtern

3
ErrorObjectsModeSave

ErrorObjectsModeSync

In Section Instructions Examples Basics History Extra

ExtendedRight_

ExtendedRight_ProjectManagement

In Section Instructions Examples Basics History Extra

FunctionRight

FunctionRightCDevice

FunctionRightDebugger

FunctionRightDocumentCheckIn
32

FunctionRightDocumentCheckOut

64

FunctionRightLock

16

FunctionRightProduct

FunctionRightProjectOptions

In Section Instructions Examples Basics History Extra

GeneratorType

GeneratorTypeDescription

GeneratorTypeLabel

GeneratorTypeName

1
In Section Instructions Examples Basics History Extra

Implementation_Behaviour_

Implementation_Behaviour_No_Replace

Implementation_Behaviour_Replace

Implementation_Behaviour_Use_Project_Settings

In Section Instructions Examples Basics History Extra

ImportOverlay

ImportOverlayErrMsgNoValidProject

Error value for imports of working layers is in the "ImportOverlayErrMsg" globals.

No suitable project found in the to be imported file.

ImportOverlayErrMsgOK

Error value for imports of working layers is in the "ImportOverlayErrMsg" globals.

Import OK.
ImportOverlayErrMsgWLNotValid

Error value for imports of working layers is in the "ImportOverlayErrMsg" globals.

No suitable working layer found for project.

In Section Instructions Examples Basics History Extra

InheritableFlagState

InheritableFlagState_On

InheritableFlagState_Off

InheritableFlagState_Undefined

In Section Instructions Examples Basics History Extra

InheritCheckInError

InheritCheckInErrorInheritanceCDeviceOnly

406
InheritCheckInErrorInheritanceCDeviceSystemOnly

407

InheritCheckInErrorInheritanceCompleteleyBlocked

405

InheritCheckInErrorNoCurrentProject

402

InheritCheckInErrorNoOwner

401

InheritCheckInErrorNoRight

400

InheritCheckInErrorNotInCurrentProject

403

InheritCheckInErrorObjectWihtSameName

404

In Section Instructions Examples Basics History Extra

InheritMode

InheritModeNoCDeviceOnly

2
InheritModeNoInheritance

InheritModeNormal

In Section Instructions Examples Basics History Extra

IsValueValid

IsValueValidExNormal

IsValueValidExNoScript

In Section Instructions Examples Basics History Extra

LicenseModule

LicenseModulConstructionAssistant

LicenseModulInspection
LicenseModulMotionX

LicenseModulPlantModeler

In Section Instructions Examples Basics History Extra

Link

LinkConnect

LinkEvalExpression

LinkMappingTable

LinkNone

10

Exists in order to disable the inherited link to an inheriting Spec.

LinkObjNavigator

LinkOwner
2

LinkScript

LinkScriptValue

LinkSelf

LinkSpec

In Section Instructions Examples Basics History Extra

MassOperation_

MassOperation_Dont_Show_Progress

MassOperation_Show_Progress

In Section Instructions Examples Basics History Extra

NRGCheck
NRGCheckEndValueCharacterNotFoundInAlphabet

133

NRGCheckOk

129

NRGCheckStartEndValueOrderIncorrect

132

NRGCheckStartValueCharacterNotFoundInAlphabet

130

NRGCheckStartValueIsEmpty

131

In Section Instructions Examples Basics History Extra

SpecInheritance

MaxExtendedInfoSize

200

In Section Instructions Examples Basics History Extra

ObjectHistoryStatus_

ObjectHistoryStatus_Backup

ObjectHistoryStatus_NoBackup

In Section Instructions Examples Basics History Extra

ObjectMerge_

ObjectMerge_Default_Mode

In Section Instructions Examples Basics History Extra

ObjectMerge_Property_

ObjectMerge_Property_DontReplaceEmpty

32

ObjectMerge_Property_DontSaveGUnitGLocation

0x0000

Is part of the "Merge objects" functionality. You can find additional information
on this topic in the "COMOS Platform Administration" manual, keyword "Merging
objects".

ObjectMerge_Property_MasterPriority

ObjectMerge_Property_ReplaceEmpty

ObjectMerge_Property_SaveGUnitGlocation

0x0800

Is part of the "Merge objects" functionality. You can find additional information
on this topic in the "COMOS Platform Administration" manual, keyword "Merging
objects".

ObjectMerge_Property_SlavePriority

16

In Section Instructions Examples Basics History Extra

ObjectMerge_SubObject_

ObjectMerge_SubObject_FromOneSide

64

ObjectMerge_SubObject_MasterPriority

ObjectMerge_SubObject_Mix
0

ObjectMerge_SubObject_MixWithPriority

128

ObjectMerge_SubObject_MixWithRename

256

ObjectMerge_SubObject_PureMix

ObjectMerge_SubObject_SlavePriority

512

In Section Instructions Examples Basics History Extra

ObjectOverlayBehaviour_

ObjectOverlayBehaviour_Release

ObjectOverlayBehaviour_Relevant

ObjectOverlayBehaviour_SaveHistory

ObjectOverlayBehaviour_SaveInheritedHistory
2

In Section Instructions Examples Basics History Extra

ObjectRevisionStatus_

ObjectRevisionStatus_Changed

ObjectRevisionStatus_Deleted

ObjectRevisionStatus_New

ObjectRevisionStatus_NoChange

In Section Instructions Examples Basics History Extra

Object_Get_Overlays

Object_Get_OverlaysAll

0
Object_Get_OverlaysAll_Predecessors

Object_Get_OverlaysAll_Successors

Object_Get_OverlaysDirect_Predecessor

Object_Get_OverlaysDirect_Successors

In Section Instructions Examples Basics History Extra

Operator

OperatorEqual

OperatorGreater

GreaterOrEqual

OperatorLess

2
OperatorLessOrEqual

OperatorLike

In Section Instructions Examples Basics History Extra

OverlayCheckDuplicateNames

OverlayCheckDuplicateNamesDefault

OverlayCheckDuplicateNamesOFF

OverlayCheckDuplicateNamesON

In Section Instructions Examples Basics History Extra

OverlayCheckOpenRevisions

OverlayCheckOpenRevisionsDefault

0
OverlayCheckOpenRevisionsIgnore

OverlayCheckOpenRevisionsOnly

In Section Instructions Examples Basics History Extra

OverlayCheckPlantRevisions

OverlayCheckPlantRevisionsDefault

OverlayCheckPlantRevisionsIgnore

OverlayCheckPlantRevisionsOnly

In Section Instructions Examples Basics History Extra

OverlayCheckStarVersions

OverlayCheckStarVersionsDefault

0
OverlayCheckStarVersionsNo

OverlayCheckStarVersionsYes

In Section Instructions Examples Basics History Extra

OverlayOpenRevisionType

OverlayOpenRevisionTypeCreated

OverlayOpenRevisionTypeDefault

OverlayOpenRevisionTypeOpen

In Section Instructions Examples Basics History Extra

OverlayStatus_

OverlayStatus_ChangedInOverlayStatus
2

OverlayStatus_ChangeInStructure

OverlayStatus_ChangeInSubObjects

12

OverlayStatus_Collision

OverlayStatus_CollisionDeleteInStructure

10

OverlayStatus_CollisionDeleteInSubObjects

OverlayStatus_CollisionInStructure

OverlayStatus_CollisionInSubObjects

OverlayStatus_CollisionSoftDeleteInStructure

16

OverlayStatus_CollisionSoftDeleteInSubObjects

17

OverlayStatus_Collision_Deleted
7

OverlayStatus_DeletedInOverlay

OverlayStatus_DeletedInPredecessor

11

OverlayStatus_DoNotReleaseObject

18

OverlayStatus_Moved

13

OverlayStatus_NewInOverlay

OverlayStatus_NoChange

OverlayStatus_NotRelevant

-1

OverlayStatus_ObjectInBothOverlays

23

OverlayStatus_ObjectInCompareOverlay

22
OverlayStatus_ObjectInConsistent

24

OverlayStatus_ObjectInCurrentOverlay

21

OverlayStatus_ObjectInNoneOverlay

20

OverlayStatus_ObjectNotOverlayRelevant

19

OverlayStatus_SoftDeleteInStructure

14

OverlayStatus_SoftDeleteInSubObjects

15

Overlay_Status_System_Overlay_Relevant_No

Overlay_Status_System_Overlay_Relevant_Yes

Constants have to be called with object.GetSystemStatus to return the above listed

values.

The method then returns if an object has a SystemType that is relevant to working
layers.

In Section Instructions Examples Basics History Extra

Overlay_DBStatus_

Overlay_DBStatus_DeleteFailed

Overlay_DBStatus_InProgress

Overlay_DBStatus_Locked

Overlay_DBStatus_OK

Overlay_DBStatus_ReleaseFailed

In Section Instructions Examples Basics History Extra

Overlay_Delete_Mode_

Overlay_Delete_Mode_Default

Overlay_Delete_Mode_Delete

1
Overlay_Delete_Mode_Keep

In Section Instructions Examples Basics History Extra

Overlay_Lock_Mode_

Overlay_Lock_Mode_Default

Overlay_Lock_Mode_Lock

Overlay_Lock_Mode_NoLock

In Section Instructions Examples Basics History Extra

Performance_Value_Col_Load_

Performance_Value_Col_Load_Count_Last

Performance_Value_Col_Load_Count_Permanent

3
Performance_Value_Col_Load_Last

Performance_Value_Col_Load_Permanent

In Section Instructions Examples Basics History Extra

ProductRequestOperator

ProductRequestOperatorEqual

ProductRequestOperatorGreater

ProductRequestOperatorGreaterOrEqual

ProductRequestOperatorInRange

ProductRequestOperatorInString

11

ProductRequestOperatorLess
3

ProductRequestOperatorLessOrEqual

ProductRequestOperatorNone

ProductRequestOperatorOuterRange

ProductRequestOperatorPrefix

10

ProductRequestOperatorScript

12

Belongs to product data with operator. "Script" can now be specified as the
operator for attributes relavant to product data.

ProductRequestOperatorSubSet

In Section Instructions Examples Basics History Extra

ProductRequest_Behaviour_

ProductRequest_Behaviour_Normal

1
ProductRequest_Behaviour_Recursive

In Section Instructions Examples Basics History Extra

ProductValue

ProductValueValue

-1

In Section Instructions Examples Basics History Extra

Project

ProjectCDeviceSystem

ProjectComosSystem

ProjectUserSystem

In Section Instructions Examples Basics History Extra

Range

RangeCheckMode_FullCheck

RangeCheckMode_NoChecking

1 (Alt)

In Section Instructions Examples Basics History Extra

Range_

Range_Specification_Min_Value_Max

Range_Specification_MinMax

1 (Alt)

Range_Specification_MinMax_Only

Specification_MinMax and Specification_Min_Value_Max are equivalent; whereas

Specification_MinMax is the older value.

In other words, the range-specification can engage in two states: MinMax and
MinValueMax. The MinMax state is handled (covered) with the
"Specification_MinMax_Only" constant, and the "MinValueMax" state is handled with
the constants "Specification_MinMax" and "Specification_Min_Value_Max".

You are no longer recommended to use "Specification_MinMax" since it is not

intuitive that the "Specification_MinMax" state covers the "MinValueMax" state.

In Section Instructions Examples Basics History Extra

ScientificNotation

ScientificNotation_SuppressAlways

Trivalent project option for exponential display.

ScientificNotation_SuppressNever

Trivalent project option for exponential display.

ScientificNotation_SuppressNotZero

Trivalent project option for exponential display. Here: Use exponential display
when the value is not equal to zero, but is rounded to zero in the display.

In Section Instructions Examples Basics History Extra

Reference_Behaviour_

Input

Return value
Reference_Behaviour_For_Implementation

Reference_Behaviour_For_Location

Reference_Behaviour_For_Unit

Reference_Behaviour_No_Pointer_Valid

Reference_Behaviour_Some_Pointer_Valid

In Section Instructions Examples Basics History Extra

RegisterForReleaseStaticCollectionsMode

RegisterForReleaseStaticCollectionsModeExecute

1
RegisterForReleaseStaticCollectionsModeRegister

RegisterForReleaseStaticCollectionsModeRemove

In Section Instructions Examples Basics History Extra

ReleaseCheck

ReleaseCheckCollisions

32

ReleaseCheckDuplicateName

ReleaseCheckMultipleUsed

64

ReleaseCheckOpenRevisions

ReleaseCheckPlantRevisions

ReleaseCheckStarVersions

128
ReleaseCheckStopAtFirst

16

ReleaseCheckWithCreated

In Section Instructions Examples Basics History Extra

Resource_Type_

Resource_Type_GUI_All_Processes

Resource_Type_GUI_Current_Process

Resource_Type_User_Objects_All_Processes

Resource_Type_User_Objects_Current_Process

In Section Instructions Examples Basics History Extra

Rights
RightsAccessControl

128

RightsCreate

RightsDelete

RightsInspect

64

RightsRead

RightsReadNoInherit

256

Read only for one object

RightsRelease

32

RightsRevision

16

RightsWrite

2
In Section Instructions Examples Basics History Extra

RollbackStateEntry_Mode_

RollbackStateEntry_Mode_Delete

RollbackStateEntry_Mode_Modified

RollbackStateEntry_Mode_New

In Section Instructions Examples Basics History Extra

RunMode

RunModeWebUser

20

In Section Instructions Examples Basics History Extra

Scan_CDevice_
Scan_CDevice_CDevices

Scan_CDevice_Elements

In Section Instructions Examples Basics History Extra

Scan_Documents_

Scan_Documents_Normal

Scan_Documents_All_Backpointers

Scan_Documents_Direct_Backpointers

In Section Instructions Examples Basics History Extra

ScanDocumentsMode

Scan_Documents_NameSystem

16
Scan_Documents_Normal

Scan_Documents_NoSystemDocGroups

64

Scan_Documents_Project

32

Scan_Documents_WithCLinks

128

Scan_Documents_WithDevBackPointer

Scan_Documents_WithDocBackPointer

Scan_Documents_WithDocDocuments

Scan_Documents_WithDocDocumentsAndTiff

Scan_Documents_WithSystemTemporary

256
In Section Instructions Examples Basics History Extra

ScanManager_

ScanManager_SystemType_All

In Section Instructions Examples Basics History Extra

ScriptBlock

ScriptBlockBeforeCheck

74

Triggered before Object.check, i.e. before the object test.

ScriptBlockCalcNextName

62

ScriptBlockCheckDelete

53

ScriptBlockCheckProductRequestValues

30

Belongs to the topic product data with operator. "Script" can be specified as the
operator for attributes relevant to product data.

ScriptBlockCheckStaticLinkValues
28

ScriptBlockCheckStatus1

10

ScriptBlockCheckStatus2

11

ScriptBlockCheckStatus3

12

ScriptBlockCheckStatus4

13

ScriptBlockCheckStatus5

14

ScriptBlockCheckStatus6

15

ScriptBlockCheckStatus7

26

ScriptBlockCheckStatus8

27

ScriptBlockCheckStatus9

28

ScriptBlockCheckStatus10
29

ScriptBlockCheckStatus11

30

ScriptBlockCheckStatus12

31

ScriptBlockCheckStatus13

32

ScriptBlockCheckTaskState

76

You can find additional information on this topic in the "COMOS Platform
Administration" manual, keyword ".net workflows".

ScriptBlockConnect

ScriptBlockCreateDocumentGroup

56

ScriptBlockCustomizeFileOpenDialog

16

ScriptBlockCustomizeTree

19

ScriptBlockDeleteWarning

54
ScriptBlockDisConnect

ScriptBlockExport

20

ScriptBlockFillComboList

15

ScriptBlockFilterRow

14

ScriptBlockGetConnectorLabel

25

ScriptBlockGetConnectorSpecification

ScriptBlockGetDisplayValue

ScriptBlockGetDisplayXValue

ScriptBlockGetLinkedSpecification

ScriptBlockGetLinkObject
17

ScriptBlockGetRoot

18

ScriptBlockGetScriptLinkObject

26

ScriptBlockGetScriptUnit

ScriptBlockGetScriptValue

ScriptBlockGlobal

ScriptBlockImport

21

ScriptBlockIsDocumentCheckInAllowed

57

ScriptBlockIsDocumentCheckOutAllowed

98

ScriptBlockIsImplementationValid

37

ScriptBlockIsLinkObjectValid
23

ScriptBlockIsLocationValid

36

ScriptBlockIsLockAllowed

63

ScriptBlockIsReleaseAllowed

59

ScriptBlockIsRevisionAllowed

65

ScriptBlockIsSignatureAllowed

25

ScriptBlockIsUnitValid

35

ScriptBlockIsValueValid

22

ScriptBlockNavigatorText

34

ScriptBlockOnBeforeDelete

68
ScriptBlockOnBeforeDocumentCheckIn

73

See OnBeforeDocumentCheckIn

ScriptBlockOnCatalogAttributeChanged

96

ScriptBlockOnChange

ScriptBlockOnChangeOther

12

ScriptBlockOnCheck

23

ScriptBlockOnClick

11

ScriptBlockOnCreateReferenceDocument

22

ScriptBlockOnDocObjCreate

ScriptBlockOnDocObjDelete

ScriptBlockOnDraw

18
ScriptBlockOnEdit

13

ScriptBlockOnEditCancel

99

ScriptBlockOnEditOK

16

ScriptBlockOnExecuteScriptActivity

77

You can find additional information on this topic in the "COMOS Platform
Administration" manual, keyword ".net workflows".

ScriptBlockOnImplementationCopy

71

See OnImplementationCopy

ScriptBlockOnImplementationSet

40

ScriptBlockOnLinkObjectSet

24

ScriptBlockOnLocationSet

39

ScriptBlockOnMenuCreate

19
ScriptBlockOnMenuExecute

20

ScriptBlockOnMove

69

ScriptBlockOnNotLongerReferencedByDevice

ScriptBlockOnProjectOpen

21

ScriptBlockOnReferencedByDevice

ScriptBlockOnReferencedByDocument

ScriptBlockOnRevision

17

ScriptBlockOnRevisionFirstStep

72

See OnRevisionFirstStep

ScriptBlockOnRevisionRelease

33
ScriptBlockOnSaveDone

75

After saving an object

ScriptBlockOnTemplateCreated

70

ScriptBlockOnTransmittalDocumentTakeAction

95

ScriptBlockOnShow

10

ScriptBlockOnSubMenuCreate

55

ScriptBlockOnUnitSet

38

ScriptBlockParameter

ScriptBlockSetScriptLinkObject

27

ScriptBlockSetScriptUnit

ScriptBlockSetScriptValue

7
ScriptBlockSetSuiQueryDefinitions

97

ScriptBlockStaticLinkSetValue

29

ScriptBlockUserBlock1

41

ScriptBlockUserBlock2

42

ScriptBlockUserBlock3

43

ScriptBlockUserBlock4

44

ScriptBlockUserBlock5

45

ScriptBlockUserBlock6

46

ScriptBlockUserBlock7

47

ScriptBlockUserBlock8
48

ScriptBlockUserBlock8

49

In Section Instructions Examples Basics History Extra

SignalMode

SignalModeNormal

SignalModeOwner

In Section Instructions Examples Basics History Extra

SpecD3Mode

SpecD3ModeD3Standard

SpecD3ModeNormal

-9999
In Section Instructions Examples Basics History Extra

SpecInheritance

SpecInheritanceCDevOnly

SpecInheritanceCDevSystemOnly

SpecInheritanceChapterCDevOnly

SpecInheritanceChapterCDevSystemOnly

SpecInheritanceCompletelyBlocked

SpecInheritanceHighPriority

SpecInheritanceInstanceProducing

SpecInheritanceInstanceProducingAndPartialBlocked

9
SpecInheritanceInvisible

10

SpecInheritanceNormal

SpecInheritancePartialBlocked

SpecInheritanceScript

11

SpecInheritanceXML

12

SpecInheritanceXMLHighPriority

13

See Attributes

SpecInheritanceXMLPartialBlocked

14

See Attributes

In Section Instructions Examples Basics History Extra

StandardTable_Type_

Table 20:
StandardTable_Type_Local

StandardTable_Type_Normal

In Section Instructions Examples Basics History Extra

StartMode_

StartMode_AdvancedES

128

StartMode_ComosET

StartMode_ComosPID

StartMode_ComosWeb

256

StartMode_ConstructionAssistant

16

Used by ConstructionAssistant to start the Comos.dll in the correct mode.

StartMode_MotionX
32

StartMode_Normal

StartMode_Package

64

StartMode_Viewing

In Section Instructions Examples Basics History Extra

StatusDirectionMode

Table 21:

StatusDirectionModeDown

StatusDirectionModeObject

StatusDirectionModeUp

In Section Instructions Examples Basics History Extra

StatusSetMode

StatusSetModeDecrement

StatusSetModeIncrement

StatusSetModeObject

In Section Instructions Examples Basics History Extra

System_Status_

System_Status_History

117

System_Status_ObjectRevision

101

System_Status_Overlay

100

In Section Instructions Examples Basics History Extra

System_Status_Consolidation_

System_Status_Consolidation

123

System_Status_Consolidation_Object

122

System_Status_Consolidation_Structure

121

In Section Instructions Examples Basics History Extra

System_Status_Overlay_

Table 22:

System_Status_Overlay_Collision

105

System_Status_Overlay_Collision_Delete_In_Structure

109

System_Status_Overlay_Collision_Delete_In_SubObjects

108

System_Status_Overlay_Collision_In_Structure
107

System_Status_Overlay_Collision_In_SubObjects

106

System_Status_Overlay_Collision_SoftDelete_In_Structure

112

System_Status_Overlay_Collision_SoftDelete_In_SubObjects

113

System_Status_Overlay_Do_Not_Release_Object

114

System_Status_Overlay_ID

116

System_Status_Overlay_Object

102

System_Status_Overlay_Object_Not_OverlayRelevant

115

System_Status_Overlay_SoftDelete_In_Structure

110

System_Status_Overlay_SoftDelete_In_SubObjects

111
System_Status_Overlay_Structure

103

System_Status_Overlay_SubObjects

104

In Section Instructions Examples Basics History Extra

System_Status_ReadOnly_

Table 23:

System_Status_ReadOnly_Locked

501

System_Status_ReadOnly_No_SoftDeleteFilter

508

System_Status_ReadOnly_No_WriteRight

506

System_Status_ReadOnly_NotInCurrentProject

502

System_Status_ReadOnly_OverlayLocked

505

System_Status_ReadOnly_RO_Layer

504
System_Status_ReadOnly_SoftDeleted

503

System_Status_ReadOnly_SystemTemporary

500

System_Status_ReadOnly_Viewing

507

In Section Instructions Examples Basics History Extra

TransferProjectMode

TransferProjectModeAllUsers

TransferProjectModeOneUser

In Section Instructions Examples Basics History Extra

WfTaskObject

WfTaskObjectLocations
Controlson which objects the workflow scripts are offered. Current value is: "@20 >
B40" and "PQM".

You can find additional information on this topic in the "COMOS Platform
Administration" manual, keyword ".net workflows".

In Section Instructions Examples Basics History Extra

WorkflowObserved

WorkflowObservedConnectors

WorkflowObservedDevices

WorkflowObservedDocObjs

32

WorkflowObservedDocuments

WorkflowObservedSpecifications

16

WorkflowObservedThis

You can find additional information on this topic in the "COMOS Platform
Administration" manual, keyword ".net workflows".

In Section Instructions Examples Basics History Extra

ComosSystemTypes

This chapter contains the following information:SystemType

In Section Instructions Examples Basics History Extra

SystemType

SystemTypeCAccessory

16

SystemTypeCase

39

SystemTypeCDevice

13

SystemTypeCLink

20

SystemTypeConnector

21
SystemTypeCSpecificationSet

15

SystemTypeDevice

SystemTypeDevSymbol

18

SystemTypeDocObj

12

SystemTypeDocument

29

SystemTypeDocumentType

30

SystemTypeLanguage

40

SystemTypeLinkInfo

105

SystemTypeLocation

11

SystemTypeObject
1

SystemTypeObjectRevision

41

SystemTypePhysUnit

32

SystemTypePhysUnitGroup

31

SystemTypePickList

27

SystemTypePickListEntry

28

SystemTypePosition

SystemTypeProject

SystemTypeRight

38

SystemTypeSpecification

10

SystemTypeSpecificationSet
7

SystemTypeStandardTable

22

SystemTypeStandardValue

23

SystemTypeTempCollection

102

SystemTypeTimestamp

34

SystemTypeUnit

SystemTypeUser

33

SystemTypeUserGroup

37

SystemTypeWorkingOverlay

42

SystemTypeWorkSet

101
In Section Instructions Examples Basics History Extra

ConsolidationShadowObjectLocation

This chapter contains the following information:Constants

In Section Instructions Examples Basics History Extra

Constants

Undocumented, because these constants cannot be used.

In Section Instructions Examples Basics History Extra

ConsolidationStatusValue

This chapter contains the following information:Constants

In Section Instructions Examples Basics History Extra

Constants
Undocumented, because these constants cannot be used.

In Section Instructions Examples Basics History Extra

dbType

This chapter contains the following information:dbType constants

In Section Instructions Examples Basics History Extra

dbType constants

Access

Current

- 1

Oracle

SQLServer

2
In Section Instructions Examples Basics History Extra

PopupMenuConstants

This chapter contains the following information:ppm

In Section Instructions Examples Basics History Extra

ppm

ppmCOPY

"COPY"

ppmCUT

"CUT"

ppmDELETE

"DELETE"

ppmMARK

"MARK"

ppmNAVIGATE

"NAVIGATE"

ppmNEW

"NEW"
ppmOPEN

"OPEN"

ppmPASTE

"PASTE"

ppmPASTEREF

"PASTEREF"

ppmPROPERTIES

"PROPERTIES"

In Section Instructions Examples Basics History Extra

SoftDeleteMode

This chapter contains the following information:Constants

In Section Instructions Examples Basics History Extra

Constants

Undocumented, because these constants cannot be used.