Sie sind auf Seite 1von 26

 Klassendokumentation Lib_dll Marken 1

___________________

___________________
Lib.dll 2

COMOS

Platform
Klassendokumentation Lib_dll

Programmierhandbuch

09/2011
A5E03638419-01
Rechtliche Hinweise
Rechtliche Hinweise
Warnhinweiskonzept
Dieses Handbuch enthält Hinweise, die Sie zu Ihrer persönlichen Sicherheit sowie zur Vermeidung von
Sachschäden beachten müssen. Die Hinweise zu Ihrer persönlichen Sicherheit sind durch ein Warndreieck
hervorgehoben, Hinweise zu alleinigen Sachschäden stehen ohne Warndreieck. Je nach Gefährdungsstufe
werden die Warnhinweise in abnehmender Reihenfolge wie folgt dargestellt.

GEFAHR
bedeutet, dass Tod oder schwere Körperverletzung eintreten wird, wenn die entsprechenden
Vorsichtsmaßnahmen nicht getroffen werden.

WARNUNG
bedeutet, dass Tod oder schwere Körperverletzung eintreten kann, wenn die entsprechenden
Vorsichtsmaßnahmen nicht getroffen werden.

VORSICHT
mit Warndreieck bedeutet, dass eine leichte Körperverletzung eintreten kann, wenn die entsprechenden
Vorsichtsmaßnahmen nicht getroffen werden.

VORSICHT
ohne Warndreieck bedeutet, dass Sachschaden eintreten kann, wenn die entsprechenden
Vorsichtsmaßnahmen nicht getroffen werden.

ACHTUNG
bedeutet, dass ein unerwünschtes Ergebnis oder Zustand eintreten kann, wenn der entsprechende Hinweis
nicht beachtet wird.
Beim Auftreten mehrerer Gefährdungsstufen wird immer der Warnhinweis zur jeweils höchsten Stufe verwendet.
Wenn in einem Warnhinweis mit dem Warndreieck vor Personenschäden gewarnt wird, dann kann im selben
Warnhinweis zusätzlich eine Warnung vor Sachschäden angefügt sein.
Qualifiziertes Personal
Das zu dieser Dokumentation zugehörige Produkt/System darf nur von für die jeweilige Aufgabenstellung
qualifiziertem Personal gehandhabt werden unter Beachtung der für die jeweilige Aufgabenstellung zugehörigen
Dokumentation, insbesondere der darin enthaltenen Sicherheits- und Warnhinweise. Qualifiziertes Personal ist
auf Grund seiner Ausbildung und Erfahrung befähigt, im Umgang mit diesen Produkten/Systemen Risiken zu
erkennen und mögliche Gefährdungen zu vermeiden.
Bestimmungsgemäßer Gebrauch von Siemens-Produkten
Beachten Sie Folgendes:

WARNUNG
Siemens-Produkte dürfen nur für die im Katalog und in der zugehörigen technischen Dokumentation
vorgesehenen Einsatzfälle verwendet werden. Falls Fremdprodukte und -komponenten zum Einsatz kommen,
müssen diese von Siemens empfohlen bzw. zugelassen sein. Der einwandfreie und sichere Betrieb der
Produkte setzt sachgemäßen Transport, sachgemäße Lagerung, Aufstellung, Montage, Installation,
Inbetriebnahme, Bedienung und Instandhaltung voraus. Die zulässigen Umgebungsbedingungen müssen
eingehalten werden. Hinweise in den zugehörigen Dokumentationen müssen beachtet werden.

Marken
Alle mit dem Schutzrechtsvermerk ® gekennzeichneten Bezeichnungen sind eingetragene Marken der
Siemens AG. Die übrigen Bezeichnungen in dieser Schrift können Marken sein, deren Benutzung durch Dritte für
deren Zwecke die Rechte der Inhaber verletzen kann.
Haftungsausschluss
Wir haben den Inhalt der Druckschrift auf Übereinstimmung mit der beschriebenen Hard- und Software geprüft.
Dennoch können Abweichungen nicht ausgeschlossen werden, so dass wir für die vollständige Übereinstimmung
keine Gewähr übernehmen. Die Angaben in dieser Druckschrift werden regelmäßig überprüft, notwendige
Korrekturen sind in den nachfolgenden Auflagen enthalten.

Siemens AG A5E03638419-01 Copyright © Siemens AG 2011.


Industry Sector Ⓟ 09/2011 Änderungen vorbehalten
Postfach 48 48
90026 NÜRNBERG
DEUTSCHLAND
Inhaltsverzeichnis

1 Marken....................................................................................................................................................... 7
2 Lib.dll ......................................................................................................................................................... 9
2.1 Lib.cls .............................................................................................................................................9
2.1.1 Public Functions.............................................................................................................................9
2.1.1.1 GetVersionNumber ........................................................................................................................9
2.1.1.2 ResetPFD.......................................................................................................................................9
2.1.1.3 ResetELO.......................................................................................................................................9
2.1.1.4 ResetFluid ......................................................................................................................................9
2.1.1.5 InitNavigator ...................................................................................................................................9
2.1.1.6 ObjRight .......................................................................................................................................10
2.1.1.7 ResetSpecToExcel ......................................................................................................................10
2.1.1.8 ObjPath ........................................................................................................................................10
2.1.1.9 ShowClsFormOnComosMdiForm ................................................................................................10
2.1.1.10 CloseContainerFormOnComosMdiForm .....................................................................................10
2.1.1.11 CallScriptLib .................................................................................................................................11
2.1.1.12 SetShell........................................................................................................................................11
2.1.1.13 GetAllPropertiesAndMethodesByObject......................................................................................11
2.1.1.14 SendOutlookMail..........................................................................................................................11
2.1.1.15 AddSpecValueToStdTable...........................................................................................................11
2.1.1.16 CheckInStdTable .........................................................................................................................12
2.1.1.17 GetLinkedSpecification ................................................................................................................12
2.1.1.18 ShellOpen ....................................................................................................................................12
2.1.1.19 GetStatusCDevice .......................................................................................................................12
2.1.1.20 GetLayerCDevice.........................................................................................................................12
2.1.1.21 GetCDeviceBySystemFullNames ................................................................................................12
2.1.1.22 DocumentDescription...................................................................................................................13
2.1.1.23 SystemStatusConstants...............................................................................................................13
2.1.1.24 StructureCopy ..............................................................................................................................13
2.1.1.25 ConvertSpecPhysUnitByMode.....................................................................................................14
2.1.1.26 ConvertSpecPhysUnit..................................................................................................................14
2.1.1.27 ConvertPhysUnitsToNewSystem.................................................................................................14
2.1.1.28 ConvertSpecPhysUnitToNewSystem ..........................................................................................14
2.1.1.29 ConvertPhysUnits ........................................................................................................................14
2.1.1.30 CreateRight ..................................................................................................................................15
2.1.1.31 CreateFunctionRight ....................................................................................................................15
2.1.1.32 RegCreateKey..............................................................................................................................15
2.1.1.33 RegDeleteKey ..............................................................................................................................15
2.1.1.34 RegDeleteValue ...........................................................................................................................15
2.1.1.35 RegExistKey.................................................................................................................................16
2.1.1.36 RegGetValue................................................................................................................................16
2.1.1.37 RegSetValue ................................................................................................................................16
2.1.1.38 DocumentMappingByExtension...................................................................................................16
2.1.1.39 LoadControl..................................................................................................................................16
2.1.1.40 Compress.....................................................................................................................................17
2.1.1.41 Decompress .................................................................................................................................17

Klassendokumentation Lib_dll
Programmierhandbuch, 09/2011, A5E03638419-01 3
Inhaltsverzeichnis

2.1.1.42 CreateNewOverlayWithCDevice................................................................................................. 17
2.1.1.43 GetWOverlayFromSpec .............................................................................................................. 17
2.1.1.44 IsAutoVueInstalled ...................................................................................................................... 17
2.1.1.45 GetAVInstallationPath ................................................................................................................. 17
2.1.1.46 DocumentMappingByExtensionWithDVM................................................................................... 18
2.1.1.47 SelectBaseWorkingOverlay ........................................................................................................ 18
2.1.1.48 CreateVBACollection .................................................................................................................. 18
2.1.1.49 TextMasks ................................................................................................................................... 18
2.1.1.50 LayerSelectionForm .................................................................................................................... 18
2.1.1.51 WOISBillofMaterial ...................................................................................................................... 19
2.1.2 Public Properties ......................................................................................................................... 19
2.1.2.1 Get SpecToExcel ........................................................................................................................ 19
2.1.2.2 Let SpecToExcel ......................................................................................................................... 19
2.1.2.3 Get RI .......................................................................................................................................... 19
2.1.2.4 Get PFD ...................................................................................................................................... 19
2.1.2.5 Let RI........................................................................................................................................... 19
2.1.2.6 Let PFD ....................................................................................................................................... 19
2.1.2.7 Get ELO ...................................................................................................................................... 19
2.1.2.8 Let ELO ....................................................................................................................................... 20
2.1.2.9 Get FLUID ................................................................................................................................... 20
2.1.2.10 Let FLUID .................................................................................................................................... 20
2.1.2.11 Get SUI........................................................................................................................................ 20
2.1.2.12 Get NLMod .................................................................................................................................. 20
2.1.2.13 Get device ................................................................................................................................... 20
2.1.2.14 Let device .................................................................................................................................... 20
2.1.2.15 Get DeviceExt ............................................................................................................................. 20
2.1.2.16 Let DeviceExt .............................................................................................................................. 21
2.1.2.17 Get CArray .................................................................................................................................. 21
2.1.2.18 Let CArray ................................................................................................................................... 21
2.1.2.19 Get DynProp ............................................................................................................................... 21
2.1.2.20 Let DynProp ................................................................................................................................ 21
2.1.2.21 Get CDevice................................................................................................................................ 21
2.1.2.22 Let CDevice................................................................................................................................. 21
2.1.2.23 Get WorkSet................................................................................................................................ 21
2.1.2.24 Let WorkSet ................................................................................................................................ 22
2.1.2.25 Get DeviceClasses...................................................................................................................... 22
2.1.2.26 Get ConnectorLayers .................................................................................................................. 22
2.1.2.27 Get ConnectorIOs ....................................................................................................................... 22
2.1.2.28 Get DocumentTypes ................................................................................................................... 22
2.1.2.29 Get DetailClasses ....................................................................................................................... 22
2.1.2.30 Get StatusInfo ............................................................................................................................. 22
2.1.2.31 Let StatusInfo .............................................................................................................................. 22
2.1.2.32 Get ProductRequestDisplayText................................................................................................. 23
2.1.2.33 Get PE......................................................................................................................................... 23
2.1.2.34 Get Implementation..................................................................................................................... 23
2.1.2.35 Get FTIndexManager .................................................................................................................. 23
2.1.2.36 Get DVM...................................................................................................................................... 23
2.1.3 Public Subs ................................................................................................................................. 23
2.1.3.1 DeviceClassesClear.................................................................................................................... 23
2.1.3.2 Mail.............................................................................................................................................. 23
2.1.3.3 ExecuteDecisionTables............................................................................................................... 24
2.1.3.4 ExecuteOneDecisionTable.......................................................................................................... 24

Klassendokumentation Lib_dll
4 Programmierhandbuch, 09/2011, A5E03638419-01
Inhaltsverzeichnis

2.1.3.5 Output ..........................................................................................................................................24


2.1.3.6 RefreshSpecValuesBySpecOwner ..............................................................................................24
2.1.3.7 RefreshCurrentChapterBySpecOwner ........................................................................................24
2.1.3.8 FormShow....................................................................................................................................24
2.1.3.9 OnChangeOther...........................................................................................................................24
2.1.3.10 ConvertPhysUnitsInProject ..........................................................................................................25
2.1.3.11 CopyLanguagesFromCDeviceSystem.........................................................................................25
2.1.3.12 CreateOverlaySpecs....................................................................................................................25

Klassendokumentation Lib_dll
Programmierhandbuch, 09/2011, A5E03638419-01 5
Inhaltsverzeichnis

Klassendokumentation Lib_dll
6 Programmierhandbuch, 09/2011, A5E03638419-01
Marken 1
Marken
Eingetragener Schutzrechtsvermerk: COMOS®

Klassendokumentation Lib_dll
Programmierhandbuch, 09/2011, A5E03638419-01 7
Marken

Klassendokumentation Lib_dll
8 Programmierhandbuch, 09/2011, A5E03638419-01
Lib.dll 2
2.1 Lib.cls

2.1.1 Public Functions

2.1.1.1 GetVersionNumber
GetVersionNumber()
In einer MessageBox wird die Versionsnummer der Lib.dll wie folgt angezeigt:
"ComosLib.Lib V0.0".

2.1.1.2 ResetPFD
ResetPFD()
Verweis bzw. die Klasseninstanz erstellt mit CreateObject ("ComosPFD.PFDLib"), die als
Membervariable in der Lib verwaltet wird, wird auf nothing gesetzt.

2.1.1.3 ResetELO
ResetELO()
Verweis bzw. die Klasseninstanz erstellt mit CreateObject ("ComosELOLib.ELOLib"), die als
Membervariable in der Lib verwaltet wird, wird auf nothing gesetzt.

2.1.1.4 ResetFluid
ResetFluid()
Verweis bzw. die Klasseninstanz erstellt mit CreateObject ("ComosFluidLib.FluidLib"), die als
Membervariable in der Lib verwaltet wird, wird auf nothing gesetzt.

2.1.1.5 InitNavigator
InitNavigator(ByVal WorkSet As Object, ByVal NavObj As Object)
WorkSet.Globals.NAVIGATOR = NavObj
Initialisiert Workset.Globals.NAVIGATOR entsprechend dem Parameter NavObj.

Klassendokumentation Lib_dll
Programmierhandbuch, 09/2011, A5E03638419-01 9
Lib.dll
2.1 Lib.cls

2.1.1.6 ObjRight
ObjRight(ByVal Obj As Object, ByVal Right As String) As Boolean
Über die Funktion können mit Hilfe des Strings "Right" die Rechte des Objekts "Obj"
abgefragt werden.
Für den Übergabeparameter String existieren folgende Möglichkeiten:
● "Rightscreate"
● "Rightsdelete"
● "Rightsinspect"
● "Rightread"
● "Rightswrite"
● "Rightsrelease"
● "Rightsrevision"
● "Rightsaccesscontrol"

2.1.1.7 ResetSpecToExcel
ResetSpecToExcel()
Die Membervariable m_SpecToExcel wird auf nothing gesetzt.

2.1.1.8 ObjPath
ObjPath() As Object
Es wird die Klasseninstanz der ObjAnalyse.dll erstellt
(CreateObject("ComosObjAnalyse.ObjAnalyse")) und zurückgeliefert.

2.1.1.9 ShowClsFormOnComosMdiForm
ShowClsFormOnComosMdiForm(ByVal Title As String, ByVal Frm As
Object) As Boolean
Diese Funktion bietet die Möglichkeit, eine Form von VB mit einem bestimmten Titel als
MDIChild anzuzeigen. Gelingt dies nicht, dann wird die Form als eigenständige Form
angezeigt.
Veraltet.

2.1.1.10 CloseContainerFormOnComosMdiForm
CloseContainerFormOnComosMdiForm(ByVal Frm As Object) As Boolean

Mit Hilfe des Übergabeparameters "Frm" wird die so genannte ContainerForm in Comos
gesucht. Diese ContainerForm wird zusätzlich bei ShowClsFormOnComosMdiForm benötigt
und kann mit dieser Funktion geschlossen werden.
Veraltet.

Klassendokumentation Lib_dll
10 Programmierhandbuch, 09/2011, A5E03638419-01
Lib.dll
2.1 Lib.cls

2.1.1.11 CallScriptLib
CallScriptLib(ByVal CDevFullname As String, ByVal FuncName As
String,
Optional ByVal Param1 As Variant, Optional ByVal Param2 As Variant,
Optional ByVal Param3 As Variant, Optional ByVal Param4 As Variant,
Optional ByVal Param5 As Variant, Optional ByVal Param6 As Variant,
Optional ByVal Param7 As Variant, Optional ByVal Param8 As Variant,
Optional ByVal Param9 As Variant, Optional ByVal Param10 As Variant)
As Variant
Aufruf der entsprechenden Skriptfunktion (FuncName) des CDevices, welches mit Hilfe des
CdevFullname gesucht wird. Die optionalen Parameter sind entsprechende
Übergabeparameter der Skriptfunktion (FuncName).

2.1.1.12 SetShell
SetShell(ByVal FullFileName As String) As Boolean
In SetShell wird über die Shell-Funktion eine Anwendung (ausführbare Datei, z.B. eine EXE
= Übergabeparameter FullFileName) gestartet. Der Rückgabeparameter gibt darüber
Auskunft, ob die Anwendung gestartet werden konnte oder nicht.

2.1.1.13 GetAllPropertiesAndMethodesByObject
GetAllPropertiesAndMethodesByObject(ByVal CalcObj As Object) As
Collection
Diese Funktion liefert als Collection alle Properties und Methoden des Übergabeparameters
"CalcObj" zurück.

2.1.1.14 SendOutlookMail
SendOutlookMail(ByVal An As String, ByVal Subject As String,
Optional ByVal text As String, Optional ByVal Attachment As String,
Optional ByVal SenderName As String = "", Optional ByVal CC As
String = "", Optional ByVal BCC As String = "")
Ermöglicht, dass man mit Hilfe von Outlook eine E-Mail versenden kann.

2.1.1.15 AddSpecValueToStdTable
AddSpecValueToStdTable(ByVal spcObj As IComosDSpecification) As
IComosDStandardValue
Über diese Funktion wird der Attribute-Value des "spObj" der spObj.StandardTable als
StandardValue hinzugefügt.

Klassendokumentation Lib_dll
Programmierhandbuch, 09/2011, A5E03638419-01 11
Lib.dll
2.1 Lib.cls

2.1.1.16 CheckInStdTable
CheckInStdTable(ByVal StdTable As IComosDStandardTable, ByVal
CurrProject As IComosDProject) As IComosDStandardTable
Ist die Struktur des StdTable-Objekts (Struktur wird ermittelt über den SystemFullName des
StdTable-Obj) nicht im CurrProject enthalten, dann wird diese dort angelegt und
entsprechend fehlende StandardValues werden hinzugefügt.

2.1.1.17 GetLinkedSpecification
GetLinkedSpecification(ByVal spcObj As IComosDSpecification, ByVal
LnkMode As Integer, Optional ByVal Para1 As Variant, Optional ByVal
Para2 As Variant, Optional ByVal Para3 As Variant, Optional ByVal
Para4 As Variant, Optional ByVal Para5 As Variant) As
IComosDSpecification
Die Funktion liefert das gelinkte Attribut, wobei es zunächst nur einen realisierten Modus
(mode = 1) für das Verknüpfen von Rohrleitungen gibt.

2.1.1.18 ShellOpen
ShellOpen(ByVal FileName As String, Optional ByVal View As Boolean =
False) As Boolean
Diese Funktion öffnet den ComosDocViewer mit dem entsprechenden File-Name.

2.1.1.19 GetStatusCDevice
GetStatusCDevice(ByVal Project As IComosDProject) As IComosDCDevice
Liefert das CDevice-Objekt "@Status" des Projekts.

2.1.1.20 GetLayerCDevice
GetLayerCDevice(ByVal Project As IComosDProject) As IComosDCDevice
Liefert das CDevice-Objekt "@Layer" des Projekts.

2.1.1.21 GetCDeviceBySystemFullNames
GetCDeviceBySystemFullNames(ByVal Project As IComosDProject, ByVal
OldSystemFullName As String, ByVal NewSystemFullName As String,
Optional ByVal Reserved As Variant) As IComosDCDevice
Die Funktion sucht zunächst ein CDevice vom Projekt ausgehend über den
NewSystemFullname. Falls hier das CDevice-Objekt nicht gefunden wird, wird über
OldSystemFullName gesucht.

Klassendokumentation Lib_dll
12 Programmierhandbuch, 09/2011, A5E03638419-01
Lib.dll
2.1 Lib.cls

2.1.1.22 DocumentDescription
DocumentDescription(ByVal Doc As IComosDDocument, ByVal Nr As
Integer) As String
Liefert die Dokumentenbeschreibung zurück:
● Nr = 2 => Doc.Description2
● Nr = 3 => Doc.Description3
Falls diese Parameter nicht funktionieren, wird über das Attribut "DocDesc.Desc" und
Nummer gesucht.

2.1.1.23 SystemStatusConstants
SystemStatusConstants() As ComosConstants.Constants
Es werden alle System-Status-Konstanten von Comos als ComosConstant.Constants
zurückgeliefert.
Bei der Constants-Collection gibt es folgende Funktionen bzw. Properties:
● Add
● Clear
● Count
● Item
● ItemExist
● Sort
Die Items der Collection sind vom Class-Typ ConstantItems mit folgenden Properties:
● CatalogPictureKey
● Description
● Key
● PictureKey

2.1.1.24 StructureCopy
StructureCopy(ByVal ComosObjects As IComosDCollection) As Long
Die Funktion öffnet eine Form zum Kopieren einer Struktur ins Projekt. Bei der Kopier-
Collection handelt es sich um die ComosObjects.

Klassendokumentation Lib_dll
Programmierhandbuch, 09/2011, A5E03638419-01 13
Lib.dll
2.1 Lib.cls

2.1.1.25 ConvertSpecPhysUnitByMode
ConvertSpecPhysUnitByMode(ByVal Spec As IComosDSpecification, ByVal
ConvMode As eConvertMode) As Boolean
Dient dazu, die Einheit eines Attributs umzustellen. Es gibt vier verschiedene Modi:
● ConvMode = 0
Umrechnung nach britischer Einheit gemäß der Standardtabelle @UnitMapping.
● ConvMode = 1
Umrechnung nach metrischer Einheit gemäß Standardtabelle @Unit Mapping.
● ConvMode = 2
Umrechnung nach Default, d.h. die Einheit wird auf die Gruppe gesetzt. Der Default des
dazugehörigen Einheitensystems wird automatisch verwendet.
● ConvMode = 3
Die Einheit wird auf die Default-Einheit der Gruppe gesetzt, gemäß dem aktuell
ausgewählten Einheitensystem.

2.1.1.26 ConvertSpecPhysUnit
ConvertSpecPhysUnit(ByVal Spec As IComosDSpecification, ByVal
ToBritish As Boolean) As Boolean
Veraltet.

2.1.1.27 ConvertPhysUnitsToNewSystem
ConvertPhysUnitsToNewSystem(ByVal ComosObj As IComosBaseObject,
ByVal NewSystem As Integer) As Boolean
Für alle Attribute eines Objekts wird die Einheit auf die Default-Einheit der Gruppe des
neuen Einheitensystems gesetzt.

2.1.1.28 ConvertSpecPhysUnitToNewSystem
ConvertSpecPhysUnitToNewSystem(ByVal Spec As IComosDSpecification,
ByVal NewSystem As Integer) As Boolean
Für ein Attribut eines Objekts wird die Einheit auf die Default-Einheit der Gruppe des neuen
Einheitensystems gesetzt.

2.1.1.29 ConvertPhysUnits
ConvertPhysUnits(ByVal ComosObj As IComosBaseObject, ByVal ToBritish
As Boolean) As Boolean
Veraltet.

Klassendokumentation Lib_dll
14 Programmierhandbuch, 09/2011, A5E03638419-01
Lib.dll
2.1 Lib.cls

2.1.1.30 CreateRight
CreateRight(ByVal reference As IComosBaseObject, ByVal user As
IComosBaseObject, rights As Long) As Boolean
Es wird ein Rechte-Objekt (IComosDRight) in der reference.Project.RightsCollection erzeugt.
Existiert das Recht (rights) für den Benutzer (user) bereits, dann wird False oder True
zurückgeliefert.

2.1.1.31 CreateFunctionRight
CreateFunctionRight(ByVal reference As IComosBaseObject, ByVal user
As IComosBaseObject, rights As Long) As Boolean
Es wird ein Funktionsrechte-Objekt (IComosDRight) in der
reference.Project.RightsCollection erzeugt. Existiert das Recht (rights) für den Benutzer
(user) bereits, dann wird False oder True zurückgeliefert.

2.1.1.32 RegCreateKey
RegCreateKey(ByVal Root As hKey, ByVal NewKey$) As Boolean
Erzeugt einen Eintrag in der Registry.

Hinweis
Anwendung nur durch erfahrene Anwender auf eigene Gefahr!

2.1.1.33 RegDeleteKey
RegDeleteKey(ByVal Root As hKey, ByVal Key$) As Boolean
Löscht einen Schlüssel aus der Registry.

Hinweis
Anwendung nur durch erfahrene Anwender auf eigene Gefahr!

2.1.1.34 RegDeleteValue
RegDeleteValue(ByVal Root As hKey, ByVal Key$, ByVal Field$) As
Boolean
Löscht einen Wert in einem Registryschlüssel.

Hinweis
Anwendung nur durch erfahrene Anwender auf eigene Gefahr!

Klassendokumentation Lib_dll
Programmierhandbuch, 09/2011, A5E03638419-01 15
Lib.dll
2.1 Lib.cls

2.1.1.35 RegExistKey
RegExistKey(ByVal Root As hKey, ByVal Key$) As Boolean
Es wird geprüft, ob ein Registry-Unterschlüssel existiert. Existiert der Schlüssel, wird der
Rückgabewert entsprechend gesetzt. Falls der Schlüssel nicht existiert, wird er neu
angelegt.

Hinweis
Anwendung nur durch erfahrene Anwender auf eigene Gefahr!

2.1.1.36 RegGetValue
RegGetValue(ByVal Root As hKey, ByVal Key$, ByVal Field$) As String
Liefert den Wert eines Eintrags, der durch Root, Key und Field spezifiziert wird.

Hinweis
Anwendung nur durch erfahrene Anwender auf eigene Gefahr!

2.1.1.37 RegSetValue
RegSetValue(ByVal Root As hKey, ByVal Key$, ByVal Field$, ByVal
Value$) As Boolean
Setzt einen neuen Wert eines Eintrags, der durch Root, Key und Field spezifiziert wird.

Hinweis
Anwendung nur durch erfahrene Anwender auf eigene Gefahr!

2.1.1.38 DocumentMappingByExtension
DocumentMappingByExtension(pltDoc As IComosDDocument) As Object
Liefert ein CDevice für Dokumente, das dokumententypabhängig ist.

2.1.1.39 LoadControl
LoadControl(ByVal ContainerControls As Object, ByVal
ContainerLicenses As Object, ByVal ProgID As String, ByVal
ControlName As String, Optional ByVal WithMsg As Boolean = True) As
Object ' VB.VBControlExtender
Funktion, die dazu dient, Controls dynamisch zu platzieren. Momentan wird der Parameter
ContainerLicenses nicht ausgewertet.

Klassendokumentation Lib_dll
16 Programmierhandbuch, 09/2011, A5E03638419-01
Lib.dll
2.1 Lib.cls

● ContainerControls = die Controls-Collection, der das neue Control hinzugefügt wird, in


dem die ProdID und der ControlName (kann beliebig sein) verwendet werden.
● WithMsg = ob eine MessageBox angezeigt werden soll, über das Gelingen der Funktion.
Veraltet.

2.1.1.40 Compress
Compress(ByRef uncompressed() As Byte) As Byte()
Ist eine Methode zur Komprimierung von Daten ähnlich wie das ZIP-Format.

2.1.1.41 Decompress
Decompress(ByRef compressed() As Byte) As Byte()
Ist eine Methode zur Dekomprimierung von Daten.

2.1.1.42 CreateNewOverlayWithCDevice
CreateNewOverlayWithCDevice(ByVal WOOwner As IComosBaseObject) As
IComosDWorkingOverlay
Die Funktion erzeugt eine neue Arbeitsschicht in der WOOwner mit Stammobjekt und
Attributen des Stammobjekts.

2.1.1.43 GetWOverlayFromSpec
GetWOverlayFromSpec(ByVal SP As IComosBaseObject) As
IComosDWorkingOverlay
Die Funktion ermittel über das SP-Objekt, welches vom SystemTypeSpecification oder
SystemTypeSpecificationSet sein kann, dass dazugehörige WorkingOverlay.
Das WorkingOverlay wird mit Hilfe der WorkingOverlay.Id, die im entsprechend ermitteltem
SpecificationSet im Name enthalten ist, gefunden.

2.1.1.44 IsAutoVueInstalled
IsAutoVueInstalled() As Boolean
Diese Funktion liefert einen boolschen Wert zurück, der angibt, ob AutoVue installiert ist
oder nicht.

2.1.1.45 GetAVInstallationPath
GetAVInstallationPath() As String
Liefert einen String zurück, in dem der Installationspfad von AutoVue enthalten ist.

Klassendokumentation Lib_dll
Programmierhandbuch, 09/2011, A5E03638419-01 17
Lib.dll
2.1 Lib.cls

2.1.1.46 DocumentMappingByExtensionWithDVM
DocumentMappingByExtensionWithDVM(ByVal pltDoc As IComosDDocument,
ByVal WithDVM As Boolean) As IComosBaseObject
Ist eine Technik, die für DVM-Dokumente das passende CDevice je nach Dateierweiterung
findet.
Damit die Technik funktioniert, muss die Datenbank wie folgt angepasst werden (Beispiel für
Excel):

'- @System
'- @D
'- @DocumentMapping
'- XLS -Das CDevice für Fremddokumente mit Excel-Datei.
'- XLS_DVM -Das CDevice für DVM-Dokumente mit Excel-Datei.

Hierdurch ist es möglich, in einem PQM oder einem normalen Projekt zwei Excel-Dateien mit
zwei unterschiedlichen Stammobjekten zu haben.

2.1.1.47 SelectBaseWorkingOverlay
SelectBaseWorkingOverlay(BaseProject As IComosDProject, RefObject As
Object) As IComosDWorkingOverlay
Öffnet die Stammarbeitsschichtenauswahl.

2.1.1.48 CreateVBACollection
CreateVBACollection() As Collection
Erstellt eine neue Instanz einer VB Collection (C#: VBA.Collection).

2.1.1.49 TextMasks
TextMasks() As ComosKDictionary.KDictionary
Liefert eine Liste der Bezeichnungen aus dem KDictionary von normenspezifischen
Textmasken (ab Comos 9.1).

2.1.1.50 LayerSelectionForm
LayerSelectionForm(ByVal FormCaption As String, ByVal ControlType As
String, ByRef Project As Object, ByRef Layers As String, ByRef
ROLayers As String, Optional LayerEnabled As Boolean = True) As
LayerRights
Ermöglicht die Definition der sichtbaren Arbeitsbereiche eines Benutzers, über das Ein- und
Ausschalten (Rechtevergabe) von Arbeitsbereichen, in der Benutzerverwaltung.

Klassendokumentation Lib_dll
18 Programmierhandbuch, 09/2011, A5E03638419-01
Lib.dll
2.1 Lib.cls

2.1.1.51 WOISBillofMaterial
WOIsBillOfMaterial(ByRef WO As IComosDWorkingOverlay) As Boolean
Die Funktion prüft, ob die angegebene Arbeitsschicht eine Materialfreigabeliste ist (ab
Comos 9.1).

2.1.2 Public Properties

2.1.2.1 Get SpecToExcel


Get SpecToExcel() As Object
CreateObject("ComosSpecToExcel.SpecToExcel").

2.1.2.2 Let SpecToExcel


Let SpecToExcel(ByVal vNewValue As Object)
Diese Funktion setzt die Member-Variable m_SpecToExcel.

2.1.2.3 Get RI
Get RI() As Object
CreateObject("ComosRILib.RILib")

2.1.2.4 Get PFD


Get PFD() As Object
CreateObject("ComosPFD.PFDLib")

2.1.2.5 Let RI
Let RI(ByVal vNewValue As Object)
Setzt die Member-Variable m_RI.

2.1.2.6 Let PFD


Let PFD(ByVal vNewValue As Object)
Setzt die Member-Variable m_PFD.

2.1.2.7 Get ELO


Get ELO() As Object
Verweis bzw. die Klasseninstanz erstellt mit CreateObject("ComosELOLib.ELOLib") und wird
der Member-Variablen m_ELO zugewiesen und zurückgeliefert.

Klassendokumentation Lib_dll
Programmierhandbuch, 09/2011, A5E03638419-01 19
Lib.dll
2.1 Lib.cls

2.1.2.8 Let ELO


Let ELO(ByVal vNewValue As Object)
Setzt die Member-Variable m_ELO.

2.1.2.9 Get FLUID


Get FLUID() As Object
Verweis bzw. die Klasseninstanz erstellt mit CreateObject("ComosFluidLib.FluidLib") und
wird der Member-Variablen m_FLuid zugewiesen und zurückgeliefert.

2.1.2.10 Let FLUID


Let FLUID(ByVal vNewValue As Object)
Setzt die Member-Variable m_Fluid.

2.1.2.11 Get SUI


Get SUI() As Object
Erzeugt und liefert einen Verweis bzw. eine Klasseninstanz zurück auf die SuiEdDll.dll
(CreateObject("ComosSUIEdDll.SUIEdDll")).

2.1.2.12 Get NLMod


Get NLMod() As Object
Liefert als Rückgabewert einen Verweis auf "ComosNameLabelMod.NLMod".

2.1.2.13 Get device


Get device() As Object
Liefert als Rückgabewert einen Verweis auf "ComosClassDevice.ClassDevice".

2.1.2.14 Let device


Let device(ByVal vNewValue As Object)
Initialisiert die MemberVariable m_Device neu, die auch als Rückgabewert von Get device
verwendet wird.

2.1.2.15 Get DeviceExt


Get DeviceExt() As Object
Verweis bzw. die Klasseninstanz erstellt mit
CreateObject("ComosClassDeviceExt.ClassDeviceExt") und wird der Member-Variablen
m_DeviceExt zugewiesen und zurückgeliefert.

Klassendokumentation Lib_dll
20 Programmierhandbuch, 09/2011, A5E03638419-01
Lib.dll
2.1 Lib.cls

2.1.2.16 Let DeviceExt


Let DeviceExt(ByVal vNewValue As Object)
Setzt die Member-Variable m_DeviceExt.

2.1.2.17 Get CArray


Get CArray() As Object
Verweis bzw. die Klasseninstanz erstellt mit CreateObject("ComosClassArray.ClassArray")
und wird der Member-Variablen m_CArray zugewiesen und zurückgeliefert.

2.1.2.18 Let CArray


Let CArray(ByVal vNewValue As Object)
Setzt die Member-Variable m_CArray.

2.1.2.19 Get DynProp


Get DynProp() As Object
Verweis bzw. die Klasseninstanz erstellt mit CreateObject("ComosDynProp.DynProp") und
wird der Member-Variablen m_DynProp zugewiesen und zurückgeliefert.

2.1.2.20 Let DynProp


Let DynProp(ByVal vNewValue As Object)
Setzt die Member-Variable m_DynProp.

2.1.2.21 Get CDevice


Get CDevice() As Object
Verweis bzw. die Klasseninstanz erstellt mit
CreateObject("ComosClassCDevice.ClassCDevice") und wird der Member-Variablen
m_CDevice zugewiesen und zurückgeliefert.

2.1.2.22 Let CDevice


Let CDevice(ByVal vNewValue As Object)
Setzt die Member-Variable m_CDevice.

2.1.2.23 Get WorkSet


Get WorkSet() As Object
Liefert Workset.

Klassendokumentation Lib_dll
Programmierhandbuch, 09/2011, A5E03638419-01 21
Lib.dll
2.1 Lib.cls

2.1.2.24 Let WorkSet


Let WorkSet(ByVal vNewValue As Object)
Setzt die Membervariable m_Workset und wird von Comos selbst aufgerufen.

2.1.2.25 Get DeviceClasses


Get DeviceClasses() As Object
Der Rückgabewert ist vom Typ ComosConstants.Constants und enthält Comos-
CDeviceConstans DeviceClass mit entsprechender Beschreibung.

2.1.2.26 Get ConnectorLayers


Get ConnectorLayers() As Object
Rückgabewert ist vom Typ ComosConstants.Constants und enthält Comos-
CDeviceConstans ConnectorsConstants mit entsprechender Beschreibung.

2.1.2.27 Get ConnectorIOs


Get ConnectorIOs() As Object
Rückgabewert ist vom Typ ComosConstants.Constants und enthält Comos-
CDeviceConstans ConnectorsConstants mit entsprechender Beschreibung.

2.1.2.28 Get DocumentTypes


Get DocumentTypes() As Object
Rückgabewert ist vom Typ ComosConstants.Constants und enthält Comos-
CDeviceConstans DocumentType mit entsprechender Beschreibung.

2.1.2.29 Get DetailClasses


Get DetailClasses(ByVal DeviceClass As String) As Object
Rückgabewert ist vom Typ ComosConstants.Constants und enthält Comos-
CDeviceConstans DetailClass mit entsprechender Beschreibung.

2.1.2.30 Get StatusInfo


Get StatusInfo() As String
Liefert als String die StatusInfo zurück.

2.1.2.31 Let StatusInfo


Let StatusInfo(ByVal vNewValue As String)
Setzt die StatusInfo durch einen String-Parameter.

Klassendokumentation Lib_dll
22 Programmierhandbuch, 09/2011, A5E03638419-01
Lib.dll
2.1 Lib.cls

2.1.2.32 Get ProductRequestDisplayText


Get ProductRequestDisplayText(ByVal Spec As IComosDSpecification) As
String
Liefert einen String zurück, der bei ProductRequest-Daten angezeigt wird, in Abhängigkeit
von Range oder normalen Attributen und Einheit.

2.1.2.33 Get PE
Get PE() As Object
Ein Verweis bzw. die Klasseninstanz, die mit CreateObject("ComosPEModul.PEModul")
erstellt wurde, wird zurückgeliefert.

2.1.2.34 Get Implementation


Get Implementation() As Object
Verweis bzw. die Klasseninstanz erstellt mit CreateObject("ComosClassDevice.Implement").

2.1.2.35 Get FTIndexManager


Get FTIndexManager() As Object
Verweis bzw. die Klasseninstanz erstellt mit CreateObject("ComosFTIndex-
Manager.FTIndexManager").

2.1.2.36 Get DVM


Get DVM() As Object
Verweis bzw. die Klasseninstanz erstellt mit CreateObject("ComosDDMSafe.DDMSafe").

2.1.3 Public Subs

2.1.3.1 DeviceClassesClear
DeviceClassesClear()
Setzt m_DeviceClasses = nothing.m_DeviceClasses-Collection ist vom Typ
ComosConstants.Constants und enthält alle Comos-DeviceClass-Konstanten zuzüglich
Beschreibungstext.

2.1.3.2 Mail
Mail(ByVal Adr As String, ByVal Subject As String, ByVal text As
String)
Ermöglicht es, dass man über das eingestellte E-Mail-System E-Mails versenden kann.

Klassendokumentation Lib_dll
Programmierhandbuch, 09/2011, A5E03638419-01 23
Lib.dll
2.1 Lib.cls

2.1.3.3 ExecuteDecisionTables
ExecuteDecisionTables(ByVal RootObj As IComosBaseObject)
Alle unter dem RootObj enthaltenen Entscheidungstabellen-Objekte werden ausgeführt.

2.1.3.4 ExecuteOneDecisionTable
ExecuteOneDecisionTable(ByVal DecisionTableObj As IComosBaseObject)
Handelt es sich bei dem Übergabeparameter um ein Entscheidungstabellen-Objekt, dann
wird dieses ausgeführt, ansonsten werden die darunter liegenden Objekte untersucht und
alle ExecuteOneDecisionTable-Objekte ausgeführt.

2.1.3.5 Output
Output(OutputStr As String)
OutputDebugstring-Aufruf.

2.1.3.6 RefreshSpecValuesBySpecOwner
RefreshSpecValuesBySpecOwner(ByVal SpecOwner As Object)

Aktualisiert die Attribut-Werte der geöffneten Registerkarte "Attribute". Mit Hilfe des
SpecOwner wird die geöffnete Form in COMOS gesucht.

2.1.3.7 RefreshCurrentChapterBySpecOwner
RefreshCurrentChapterBySpecOwner
RefreshCurrentChapterBySpecOwner(ByVal SpecOwner As Object)
Aktualisiert die aktuelle Attributekapitelkarte des geöffnete SpecOwner, d.h. es werden die
Controls der Attribute neu geladen.

2.1.3.8 FormShow
FormShow(ByVal VBFrm As Object, Optional ByVal mode As
FormShowConstants = vbModeless)
Zeigt eine entsprechende VB-Form im angegebenen Modus (modal bzw. nicht modal) unter
Comos an.

2.1.3.9 OnChangeOther
OnChangeOther(ByVal Spec As IComosDSpecification, ByVal NestedName
As String)
Mit dieser Funktion kann die Skriptfunktion OnChangeOther an einem anderen Attribut
aufgerufen werden. Das Attribut wird dabei über den Spec.Get-SpecOwner und von diesem
ausgehend mit .spec(NestedName) gesucht.

Klassendokumentation Lib_dll
24 Programmierhandbuch, 09/2011, A5E03638419-01
Lib.dll
2.1 Lib.cls

2.1.3.10 ConvertPhysUnitsInProject
ConvertPhysUnitsInProject(ByVal Proj As IComosDProject, ByVal
ConvMode As eConvertMode, _ ByVal ConvObjs As eConvertObjs, ByVal
ConvSpecs As eConvertSpecs)
Funktion, um pro Objekt oder pro Attribut die Einheit auf die Standardeinheit eines der fünf
Einheitensysteme umzustellen.

2.1.3.11 CopyLanguagesFromCDeviceSystem
CopyLanguagesFromCDeviceSystem(ByVal Proj As IComosDProject, ByVal
WithMsgBox As Boolean)
Funktion zum Kopieren von Sprachen aus dem Stammprojekt.

2.1.3.12 CreateOverlaySpecs
CreateOverlaySpecs(ByVal WO As IComosDWorkingOverlay)
Erzeugt die Attribute des Stammobjekts für eine neu erzeugte Arbeitsschicht.

Klassendokumentation Lib_dll
Programmierhandbuch, 09/2011, A5E03638419-01 25
Lib.dll
2.1 Lib.cls

Klassendokumentation Lib_dll
26 Programmierhandbuch, 09/2011, A5E03638419-01

Das könnte Ihnen auch gefallen