Class: CommonClass 1

Class: ComosClass 2

Class: CompanyClass 3
COMOS
Class: ListClass 4
Platform
Class documentation Chemserv_dll

Programming Manual

03/2017 V10.2.1
A5E39839020-AA
Legal information
Warning notice system
This manual contains notices you have to observe in order to ensure your personal safety, as well as to prevent
damage to property. The notices referring to your personal safety are highlighted in the manual by a safety alert
symbol, notices referring only to property damage have no safety alert symbol. These notices shown below are
graded according to the degree of danger.

DANGER
indicates that death or severe personal injury will result if proper precautions are not taken.

WARNING
indicates that death or severe personal injury may result if proper precautions are not taken.

CAUTION
indicates that minor personal injury can result if proper precautions are not taken.

NOTICE
indicates that property damage can result if proper precautions are not taken.
If more than one degree of danger is present, the warning notice representing the highest degree of danger will be
used. A notice warning of injury to persons with a safety alert symbol may also include a warning relating to property
damage.
Qualified Personnel
The product/system described in this documentation may be operated only by personnel qualified for the specific
task in accordance with the relevant documentation, in particular its warning notices and safety instructions. Qualified
personnel are those who, based on their training and experience, are capable of identifying risks and avoiding
potential hazards when working with these products/systems.
Proper use of Siemens products
Note the following:

WARNING
Siemens products may only be used for the applications described in the catalog and in the relevant technical
documentation. If products and components from other manufacturers are used, these must be recommended or
approved by Siemens. Proper transport, storage, installation, assembly, commissioning, operation and
maintenance are required to ensure that the products operate safely and without any problems. The permissible
ambient conditions must be complied with. The information in the relevant documentation must be observed.

Trademarks
All names identified by ® are registered trademarks of Siemens AG. The remaining trademarks in this publication
may be trademarks whose use by third parties for their own purposes could violate the rights of the owner.
Disclaimer of Liability
We have reviewed the contents of this publication to ensure consistency with the hardware and software described.
Since variance cannot be precluded entirely, we cannot guarantee full consistency. However, the information in
this publication is reviewed regularly and any necessary corrections are included in subsequent editions.

Siemens AG A5E39839020-AA Copyright © Siemens AG 2016 - 2017.

Division Process Industries and Drives Ⓟ 11/2017 Subject to change All rights reserved
Postfach 48 48
90026 NÜRNBERG
GERMANY
Table of contents

1 Class: CommonClass...................................................................................................................................5
1.1 Public subs...............................................................................................................................5
1.1.1 ShowPropertiesOfDevice.........................................................................................................5
1.2 Public functions........................................................................................................................5
1.2.1 IsLifeCycleLinkObject...............................................................................................................5
1.2.2 GetReferencedLCObject..........................................................................................................5
1.2.3 GetiAgeNavigatorText..............................................................................................................6
1.2.4 GetOwnerObjectByClassificationExt........................................................................................6
1.2.5 GetDeviceByUID......................................................................................................................7
1.2.6 GetAllOwnerObjectsByClassificationExt..................................................................................7
1.2.7 ListRowCount...........................................................................................................................7
1.2.8 MoveObjectTo..........................................................................................................................8
1.2.9 ScanDevicesByClassificationExt..............................................................................................8
1.2.10 SelectDevice............................................................................................................................9
1.2.11 SelectCDevice..........................................................................................................................9
1.2.12 LockObject.............................................................................................................................10
2 Class: ComosClass....................................................................................................................................11
2.1 Public functions......................................................................................................................11
2.1.1 GetiAgeObject........................................................................................................................11
3 Class: CompanyClass................................................................................................................................13
3.1 Public functions......................................................................................................................13
3.1.1 GetPersonObjectFromLogin..................................................................................................13
4 Class: ListClass..........................................................................................................................................15
4.1 Notes on ListClass.................................................................................................................15
4.2 Public subs.............................................................................................................................15
4.2.1 Add.........................................................................................................................................15
4.2.2 AddList...................................................................................................................................15
4.2.3 AddSorted..............................................................................................................................15
4.2.4 Clear.......................................................................................................................................16
4.2.5 Remove..................................................................................................................................16
4.3 Public functions......................................................................................................................16
4.3.1 Count......................................................................................................................................16
4.3.2 Item........................................................................................................................................16

Class documentation Chemserv_dll

Programming Manual, 03/2017 V10.2.1, A5E39839020-AA 3
Table of contents

Class documentation Chemserv_dll

4 Programming Manual, 03/2017 V10.2.1, A5E39839020-AA
Class: CommonClass 1
1.1 Public subs

1.1.1 ShowPropertiesOfDevice
ShowPropertiesOfDevice ( InDevice As Variant)
Opens the properties of a device in a tab. If the device is a requirement object, the properties
of the implementation object are displayed.
● Parameter InDevice
The device whose properties are to be opened.

1.2 Public functions

1.2.1 IsLifeCycleLinkObject
IsLifeCycleLinkObject ( oPltDevice As Variant ) as Boolean
Returns the information as to whether a device is a lifecycle link object.
● Parameter oPltDevice
The device to be checked.
The function checks the name of the object: When the name starts with "@Link@", the object
is treated as lifecycle link object. Technically, we are dealing with a requirement object and
not an implementation in this case.
Return:
● True
The device is a lifecycle link object.

1.2.2 GetReferencedLCObject
GetReferencedLCObject ( oPltLink As Variant ) as Variant
Returns the implementation of a lifecycle link object. The function is identical to
Device.Implementation.
● Parameter oPltLink
The lifecycle link object.

Class documentation Chemserv_dll

Programming Manual, 03/2017 V10.2.1, A5E39839020-AA 5
Class: CommonClass
1.2 Public functions

Return:
● Object
The object serving as implementation.

1.2.3 GetiAgeNavigatorText
GetiAgeNavigatorText ( InObject As Variant, Optional sType = "" ) as
String
The function supplies the navigator text of an MRO object. The navigator text is then used in
the NavigatorText event.
● Parameter InObject
The MRO object from which the navigator text is read.
● Parameter sType
System type of InObject. When the information is missing, the system type is determined
automatically.
Return:
● String
The navigator text

1.2.4 GetOwnerObjectByClassificationExt
GetOwnerObjectByClassificationExt ( oPltDevice As Variant,
sStructClass As String, sFuncClass As String, sUserClass As String,
sUserStructClass As String ) as Variant
Searches for the first owner with the specified classifications. The lifecycle structure is taken
into consideration.
● Parameter oPltDevice
Start object of the search. The owner of this object is searched for.
● Parameter sStructClass
Classification key 1, hierarchical
● Parameter sFuncClass
Classification key 2, functional
● Parameter sUserClass
Classification key 4, functional customer definition
● Parameter sUserStructClass
Classification key 3, hierarchical customer definition
If a classification key is specified in different parameters, the object must have all classification
keys to be listed as a hit.
Return:
● Object
The owner object

Class documentation Chemserv_dll

6 Programming Manual, 03/2017 V10.2.1, A5E39839020-AA
 Class: CommonClass
1.2 Public functions

1.2.5 GetDeviceByUID
GetDeviceByUID ( InWorkset As Variant, InUID As String ) as Variant
Loads a device according to the specified UID. The function is identical to
Workset.LoadObjectByType.
● Parameter InWorkset
The current workset. Even though only one workset can be active, the workset must
be loaded for technical reasons.
● Parameter InUID
The UID of the object searched for.
Return:
● Device
The object with the specified UID.

1.2.6 GetAllOwnerObjectsByClassificationExt
GetAllOwnerObjectsByClassificationExt ( oPltDevice As Variant,
sStructClass As String, sFuncClass As String, sUserClass As String,
sUserStructClass As String ) as Variant
Returns all owners according to the specified classification. Return value is a collection:
Chemserv.ListClass.
See also GetOwnerObjectByClassificationExt.
● Parameter oPltDevice
Start object of the search. The owners of this object are searched for.
● Parameter sStructClass
Classification key 1, hierarchical
● Parameter sFuncClass
Classification key 2, functional
● Parameter sUserClass
Classification key 4, functional customer definition
● Parameter sUserStructClass
Classification key 3, hierarchical customer definition
If a classification key is specified in different parameters, an object must have all classification
keys to be listed as a hit.
Return:
● Object collection
See also ScanDevicesByClassificationExt.

1.2.7 ListRowCount
ListRowCount ( InList As Variant ) as Integer

Class documentation Chemserv_dll

Programming Manual, 03/2017 V10.2.1, A5E39839020-AA 7
Class: CommonClass
1.2 Public functions

Returns the current number of rows of a list attribute.

● Parameter InList
The list attribute object.
Return:
● Number of rows

1.2.8 MoveObjectTo
MoveObjectTo ( oObject As Variant, oNewParent As Variant ) as Boolean
Moves an object (oObject) to a new owner (oNewParent). If the current user does not have all
necessary rights, the action is executed with the user "MRO System".
When oObject is a device with the class "Equipment", the function
GetMaintenanceClass.CheckEquipmentName is called.
If successful, the function informs all iPlugin.
● Parameter oObject
The object to be moved.
● Parameter oNewParent
The new owner.
Return:
● True
The object was moved.

1.2.9 ScanDevicesByClassificationExt
ScanDevicesByClassificationExt ( oDevice As Variant, ByVal
sStructClass As String, ByVal sFuncClass As String, ByVal sUserClass
As String, ByVal sUserStructClass As String ) as Variant
Returns all child objects according to the specified classification. Return value is a collection:
Chemserv.ListClass. The lifecycle structure is taken into consideration.
● Parameter oPltDevice
Start object of the search. The child objects of this object are searched for.
● Parameter sStructClass
Classification key 1, hierarchical
● Parameter sFuncClass
Classification key 2, functional
● Parameter sUserClass
Classification key 4, functional customer definition
● Parameter sUserStructClass
Classification key 3, hierarchical customer definition

Class documentation Chemserv_dll

8 Programming Manual, 03/2017 V10.2.1, A5E39839020-AA
 Class: CommonClass
1.2 Public functions

If a classification key is specified in different parameters, an object must have all classification
keys to be listed as a hit.
Return:
● Object collection
See also GetAllOwnerObjectsByClassificationExt.

1.2.10 SelectDevice
SelectDevice ( oRootNode As Variant, strHeader As String, strType As
String, Optional bAllowProjectSelection As Boolean = False ) as
Variant
Opens a dialog in which the user can select a device.
● Parameter oRootNode
Root node with which the dialog is started. The user must select the node or an object
below this node.
● Parameter strHeader
Title bar of the dialog
● Parameter strType
System types permitted for user selection
● Parameter bAllowProjectSelection
True: The project can be changed in the dialog.
False: The project cannot be changed in the dialog. The user must select an object from
the currently open project.
Return:
● Device
The device selected by the user.

1.2.11 SelectCDevice
SelectCDevice ( oRootNode As Variant, strHeader As String, strType
As String ) as Variant
Opens a dialog in which the user can select a CDevice.
● Parameter oRootNode
Root node with which the dialog is started. The user must select the node or an object
below this node.
● Parameter strHeader
Title bar of the dialog
● Parameter strType
System types permitted for user selection

Class documentation Chemserv_dll

Programming Manual, 03/2017 V10.2.1, A5E39839020-AA 9
Class: CommonClass
1.2 Public functions

Return:
● CDevice
The CDevice selected by the user.

1.2.12 LockObject
LockObject ( InDevice As Variant, InLocked As Boolean ) as Boolean
Description: xxx
● Parameter InDevice
Device for which the property is to be set
● Parameter InLocked
Property to be set:
– True: Locked
– False: Unlocked
Return:
● True
The object was locked.
● False
The object was unlocked.

Class documentation Chemserv_dll

10 Programming Manual, 03/2017 V10.2.1, A5E39839020-AA
Class: ComosClass 2
2.1 Public functions

2.1.1 GetiAgeObject

GetiAgeObject ( strClass As String ) as Object

Creates or returns the instance of the specified class.
The created instance is cached and each new call of GetiAgeObject always returns the
same instance. It is not possible to create multiple instances simultaneously with
GetiAgeObject.
Example: GetiAgeObject(„Chemserv.CommonClass“) supplies the same result as
CreateObject(„Chemserv.CommonClass“).
● Parameter strClass
The class to be instantiated.
Return:
● Object
The instance of the class

Class documentation Chemserv_dll

Programming Manual, 03/2017 V10.2.1, A5E39839020-AA 11
Class: ComosClass
2.1 Public functions

Class documentation Chemserv_dll

12 Programming Manual, 03/2017 V10.2.1, A5E39839020-AA
Class: CompanyClass 3
3.1 Public functions

3.1.1 GetPersonObjectFromLogin
GetPersonObjectFromLogin ( oWorkset As Variant, sUserLogin As
String ) as Variant
Returns a USER object from the linked USERS database. For the USER object: The user
name of the current COMOS user (COMOS login) matches the "Initials, login" property of the
USER object.
● Parameter oWorkset
The current workset. Even though only one workset can be active, the workset must
be loaded for technical reasons.
● Parameter sUserLogin
The user name of the current COMOS user.
Return:
● USER object

Class documentation Chemserv_dll

Programming Manual, 03/2017 V10.2.1, A5E39839020-AA 13
Class: CompanyClass
3.1 Public functions

Class documentation Chemserv_dll

14 Programming Manual, 03/2017 V10.2.1, A5E39839020-AA
Class: ListClass 4
4.1 Notes on ListClass
ListClass is an object collection (Collection). The index range is between 0 and
(Count -1).
The assigned string collection is StringListClass.

4.2 Public subs

4.2.1 Add
Add ( InObj )
Adds an object to the collection.
● Parameter InObj
The object to be added.

4.2.2 AddList
AddList ( InList As Variant )
Adds multiple objects to the collection.
● Parameter InList
Collection of the type ListClass. The collection includes the added objects.

4.2.3 AddSorted
AddSorted ( InSortString As String, InObj )
Adds an object and a sorting feature for the object to the collection.
● Parameter InSortString
The sorting string.
● Parameter InObj
The object to be added.
The collection is not sorted when AddSorted is executed. The collection is only sorted when
an element of the collection is read for the first time with Item().

Class documentation Chemserv_dll

Programming Manual, 03/2017 V10.2.1, A5E39839020-AA 15
Class: ListClass
4.3 Public functions

4.2.4 Clear
Clear ()
Deletes the contents of the collection.

4.2.5 Remove
Remove ( ByVal InIndex As Long )
Deletes an object from the collection.
● Parameter InIndex
Index starting at 0. The index determines the element to be deleted.

4.3 Public functions

4.3.1 Count
Count () As Long
Counts the elements in ListClass.
Return:
● Quantity
Number of elements in the collection

4.3.2 Item
Item ( ByVal InIndex As Long )
Returns an object of the collection.
● Parameter InIndex
Index starting at 0. The index determines the returned element.
Return:
● Object
The element of the list searched for.

Class documentation Chemserv_dll

16 Programming Manual, 03/2017 V10.2.1, A5E39839020-AA