Class documentation Lib_dll COMOS. Platform Class documentation Lib_dll. Trademarks 1. Lib.dll. Programming Manual A5E

Transcription

1 Trademarks 1 Lib.dll 2 COMOS Platform Programming Manual 04/2012 A5E

2 Legal information 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 with a safety alert symbol, indicates that minor personal injury can result if proper precautions are not taken. CAUTION without a safety alert symbol, indicates that property damage can result if proper precautions are not taken. NOTICE indicates that an unintended result or situation can occur if the relevant information is not taken into account. 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 Industry Sector Postfach NÜRNBERG GERMANY A5E P 05/2012 Technical data subject to change Copyright Siemens AG All rights reserved

3 Table of contents 1 Trademarks Lib.dll Public Functions GetVersionNumber ResetPFD ResetELO ResetFluid InitNavigator ObjRight ResetSpecToExcel ObjPath ShowClsFormOnComosMdiForm CloseContainerFormOnComosMdiForm CallScriptLib SetShell GetAllPropertiesAndMethodsByObject SendOutlookMail AddSpecValueToStdTable CheckInStdTable GetLinkedSpecification ShellOpen GetStatusCDevice GetLayerCDevice GetCDeviceBySystemFullNames DocumentDescription SystemStatusConstants StructureCopy ConvertSpecPhysUnitByMode ConvertSpecPhysUnit ConvertPhysUnitsToNewSystem ConvertSpecPhysUnitToNewSystem ConvertPhysUnits CreateRight CreateFunctionRight RegCreateKey RegDeleteKey RegDeleteValue RegExistKey RegGetValue RegSetValue DocumentMappingByExtension LoadControl Compress Decompress...17 Programming Manual, 04/2012, A5E

4 Table of contents CreateNewOverlayWithCDevice GetWOverlayFromSpec IsAutoVueInstalled GetAVInstallationPath DocumentMappingByExtensionWithDVM SelectBaseWorkingOverlay CreateVBACollection TextMasks LayerSelectionForm WOISBillofMaterial Public Properties Get SpecToExcel Let SpecToExcel Get RI Get PFD Let RI Let PFD Get ELO Let ELO Get FLUID Let FLUID Get SUI Get NLMod Get device Let device Get DeviceExt Let DeviceExt Get CArray Let CArray Get DynProp Let DynProp Get CDevice Let CDevice Get WorkSet Let WorkSet Get DeviceClasses Get ConnectorLayers Get ConnectorIOs Get DocumentTypes Get DetailClasses Get StatusInfo Let StatusInfo Get ProductRequestDisplayText Get PE Get Implementation Get FTIndexManager Get DVM Public Subs DeviceClassesClear Mail ExecuteDecisionTables ExecuteOneDecisionTable Programming Manual, 04/2012, A5E

5 Table of contents Output RefreshSpecValuesBySpecOwner RefreshCurrentChapterBySpecOwner FormShow OnChangeOther ConvertPhysUnitsInProject CopyLanguagesFromCDeviceSystem CreateOverlaySpecs...25 Programming Manual, 04/2012, A5E

6 Table of contents 6 Programming Manual, 04/2012, A5E

7 Trademarks 1 Trademarks Registered trademark: COMOS Programming Manual, 04/2012, A5E

8 Trademarks 8 Programming Manual, 04/2012, A5E

9 Public Functions GetVersionNumber GetVersionNumber() The version number of the Lib.dll is displayed in a message box as shown in the following: "ComosLib.Lib V0.0" ResetPFD ResetPFD() Reference or the class instance created with CreateObject ("ComosPFD.PFDLib"), which is managed as a member variable in the Lib, is set to nothing ResetELO ResetELO() Reference or the class instance created with CreateObject ("ComosELOLib.ELOLib"), which is managed as a member variable in the Lib, is set to nothing ResetFluid ResetFluid() Reference or the class instance created with CreateObject ("ComosFluidLib.FluidLib"), which is managed as a member variable in the Lib, is set to nothing InitNavigator InitNavigator(ByVal WorkSet As Object, ByVal NavObj As Object) WorkSet.Globals.NAVIGATOR = NavObj Initializes Workset.Globals.NAVIGATOR in accordance with the NavObj parameter. Programming Manual, 04/2012, A5E

10 ObjRight ObjRight(ByVal Obj As Object, ByVal Right As String) As Boolean This function can be used to query the rights of the "Obj" object with the help of the "Right" string. The following options exist for the String transfer parameter: "Rightscreate" "Rightsdelete" "Rightsinspect" "Rightread" "Rightswrite" "Rightsrelease" "Rightsrevision" "Rightsaccesscontrol" ResetSpecToExcel ResetSpecToExcel() The member variable m_spectoexcel is set to nothing ObjPath ObjPath() As Object The ObjAnalyse.dll class instance is created (CreateObject("ComosObjAnalyse.ObjAnalyse")) and returned ShowClsFormOnComosMdiForm ShowClsFormOnComosMdiForm(ByVal Title As String, ByVal Frm As Object) As Boolean This function offers the option to display a form of VB with a particular title as MDIChild. If this does not work, then the form is displayed as a separate form. Obsolete CloseContainerFormOnComosMdiForm CloseContainerFormOnComosMdiForm(ByVal Frm As Object) As Boolean The so-called ContainerForm is searched for in Comos with the help of the "Frm" transfer parameter. This ContainerForm is also required for ShowClsFormOnComosMdiForm and can be closed with this function. Obsolete. 10 Programming Manual, 04/2012, A5E

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 Call of the corresponding script function (FuncName) of the CDevice, which is searched for with the help of the CdevFullname. The optional parameters are corresponding transfer parameters of the script function (FuncName) SetShell SetShell(ByVal FullFileName As String) As Boolean An application (executable file, for example an EXE = transfer parameter FullFileName) is started in SetShell via the Shell function. The return parameter provides information whether the application could be started or not GetAllPropertiesAndMethodsByObject GetAllPropertiesAndMethodsByObject(ByVal CalcObj As Object) As Collection This function returns all properties and methods of the transfer parameter "CalcObj" as a collection 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 = "") Enables an to be sent with the help of Outlook AddSpecValueToStdTable AddSpecValueToStdTable(ByVal spcobj As IComosDSpecification) As IComosDStandardValue This function is used to add the attribute value of the "spobj" of the spobj.standardtable as StandardValue. Programming Manual, 04/2012, A5E

12 CheckInStdTable CheckInStdTable(ByVal StdTable As IComosDStandardTable, ByVal CurrProject As IComosDProject) As IComosDStandardTable If the structure of the StdTable object (the structure is determined via the SystemFullName of the StdTable object) is not contained in the CurrProject, then this is created there and any missing StandardValues are added 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 The function returns the linked attribute, initially there is only one implemented mode (mode = 1) for linking pipes ShellOpen ShellOpen(ByVal FileName As String, Optional ByVal View As Boolean = False) As Boolean This function opens the ComosDocViewer with the corresponding file name GetStatusCDevice GetStatusCDevice(ByVal Project As IComosDProject) As IComosDCDevice Returns the CDevice object "@Status" of the project GetLayerCDevice GetLayerCDevice(ByVal Project As IComosDProject) As IComosDCDevice Returns the CDevice object "@Layer" of the project GetCDeviceBySystemFullNames GetCDeviceBySystemFullNames(ByVal Project As IComosDProject, ByVal OldSystemFullName As String, ByVal NewSystemFullName As String, Optional ByVal Reserved As Variant) As IComosDCDevice The function first searches for a CDevice from the project via the NewSystemFullname. If the CDevice object is not found here, the search is carried out via OldSystemFullName. 12 Programming Manual, 04/2012, A5E

13 DocumentDescription DocumentDescription(ByVal Doc As IComosDDocument, ByVal Nr As Integer) As String Returns the document description: No = 2 => Doc.Description2 No = 3 => Doc.Description3 If these parameters do not work, it is searched via the "DocDesc.Desc" attribute and number SystemStatusConstants SystemStatusConstants() As ComosConstants.Constants All system status constants of Comos are returned as ComosConstant.Constants. The Constants collection contains the following functions or properties: Add Clear Count Item ItemExist Sort The items of the collection are of the ConstantItems class type with the following properties: CatalogPictureKey Description Key PictureKey StructureCopy StructureCopy(ByVal ComosObjects As IComosDCollection) As Long The function opens a form for copying a structure to the project. The copy collection are ComosObjects. Programming Manual, 04/2012, A5E

14 ConvertSpecPhysUnitByMode ConvertSpecPhysUnitByMode(ByVal Spec As IComosDSpecification, ByVal ConvMode As econvertmode) As Boolean Is used to convert the unit of an attribute. There are four different modes: ConvMode = 0 Conversion to British unit in accordance with standard table. ConvMode = 1 Conversion to metric unit in according to standard table. ConvMode = 2 Conversion to default, i.e. the unit is set to the group. The default of the associated unit system is automatically used. ConvMode = 3 The unit is set to the default unit of the group, according to the currently selected unit system ConvertSpecPhysUnit ConvertSpecPhysUnit(ByVal Spec As IComosDSpecification, ByVal ToBritish As Boolean) As Boolean Obsolete ConvertPhysUnitsToNewSystem ConvertPhysUnitsToNewSystem(ByVal ComosObj As IComosBaseObject, ByVal NewSystem As Integer) As Boolean The unit is set to the default unit of the group of the new unit system for all attributes of an object ConvertSpecPhysUnitToNewSystem ConvertSpecPhysUnitToNewSystem(ByVal Spec As IComosDSpecification, ByVal NewSystem As Integer) As Boolean The unit is set to the default unit of the group of the new unit system for an attribute of an object ConvertPhysUnits ConvertPhysUnits(ByVal ComosObj As IComosBaseObject, ByVal ToBritish As Boolean) As Boolean Obsolete. 14 Programming Manual, 04/2012, A5E

15 CreateRight CreateRight(ByVal reference As IComosBaseObject, ByVal user As IComosBaseObject, rights As Long) As Boolean A rights object (IComosDRight) is generated in the reference.project.rightscollection. If the right (rights) already exists for the user (user), then False or True is returned CreateFunctionRight CreateFunctionRight(ByVal reference As IComosBaseObject, ByVal user As IComosBaseObject, rights As Long) As Boolean A function right object (IComosDRight) is generated in the reference.project.rightscollection. If the right (rights) already exists for the user (user), then False or True is returned RegCreateKey RegCreateKey(ByVal Root As hkey, ByVal NewKey$) As Boolean Generates an entry in the registry. Note Only to be used by experienced users at their own risk! RegDeleteKey RegDeleteKey(ByVal Root As hkey, ByVal Key$) As Boolean Deletes a key from the registry. Note Only to be used by experienced users at their own risk! RegDeleteValue RegDeleteValue(ByVal Root As hkey, ByVal Key$, ByVal Field$) As Boolean Deletes a value in a registry key. Note Only to be used by experienced users at their own risk! Programming Manual, 04/2012, A5E

16 RegExistKey RegExistKey(ByVal Root As hkey, ByVal Key$) As Boolean A check is carried out as to whether a registry subkey exists. If the key exists, the return value is set accordingly. If the key does not exist, it is created. Note Only to be used by experienced users at their own risk! RegGetValue RegGetValue(ByVal Root As hkey, ByVal Key$, ByVal Field$) As String Returns the value of an entry which is specified by Root, Key and Field. Note Only to be used by experienced users at their own risk! RegSetValue RegSetValue(ByVal Root As hkey, ByVal Key$, ByVal Field$, ByVal Value$) As Boolean Sets a new value of an entry which is specified by Root, Key and Field. Note Only to be used by experienced users at their own risk! DocumentMappingByExtension DocumentMappingByExtension(pltDoc As IComosDDocument) As Object Returns a CDevice for documents which is document type dependent. 16 Programming Manual, 04/2012, A5E

17 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 Function which is used to dynamically place controls. The parameter ContainerLicenses is currently not evaluated. ContainerControls = the controls collection to which the new control is added by using the ProdID and the ControlName (any). WithMsg = whether a message box is to be displayed, regarding the success of the function. Obsolete Compress Compress(ByRef uncompressed() As Byte) As Byte() Is a method for compressing data similar to the ZIP format Decompress Decompress(ByRef compressed() As Byte) As Byte() Is a method for decompressing data CreateNewOverlayWithCDevice CreateNewOverlayWithCDevice(ByVal WOOwner As IComosBaseObject) As IComosDWorkingOverlay The function creates a new working layer in the WOOwner with a base object and attributes of the base object GetWOverlayFromSpec GetWOverlayFromSpec(ByVal SP As IComosBaseObject) As IComosDWorkingOverlay The function retrieves the associated WorkingOverlay via the SP object, which may be of the SystemTypeSpecification or SystemTypeSpecificationSet. The WorkingOverlay is found with the help of the WorkingOverlay.Id, which is contained in the determined SpecificationSet in the name IsAutoVueInstalled IsAutoVueInstalled() As Boolean This function returns a Boolean value, which indicates whether AutoVue is installed or not. Programming Manual, 04/2012, A5E

18 GetAVInstallationPath GetAVInstallationPath() As String Returns a string containing the installation path of AutoVue DocumentMappingByExtensionWithDVM DocumentMappingByExtensionWithDVM(ByVal pltdoc As IComosDDocument, ByVal WithDVM As Boolean) As IComosBaseObject Is a technology that finds the suitable CDevice for DVM documents, depending on the file extension. To ensure that the technology functions, the database must be adapted as follows (Example with Excel): '- XLS -The CDevice for external documents with Excel file. '- XLS_DVM -The CDevice for DVM documents with Excel file. This enables you to have two Excel projects with two different base objects in a PQM or normal project SelectBaseWorkingOverlay SelectBaseWorkingOverlay(BaseProject As IComosDProject, RefObject As Object) As IComosDWorkingOverlay Opens the base working layer selection CreateVBACollection CreateVBACollection() As Collection Creates a new instance of a VB collection (C#: VBA.Collection) TextMasks TextMasks() As ComosKDictionary.KDictionary Returns a list of the names of standard-specific texts masks from the KDictionary (Comos 9.1 and higher). 18 Programming Manual, 04/2012, A5E

19 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 Enables the definition of the visible working areas of a user, by enabling and disabling (assignment of rights) working areas, in user management WOISBillofMaterial WOIsBillOfMaterial(ByRef WO As IComosDWorkingOverlay) As Boolean The function checks whether the specified working layer is a material release list (Comos 9.1 and higher) Public Properties Get SpecToExcel Get SpecToExcel() As Object CreateObject("ComosSpecToExcel.SpecToExcel") Let SpecToExcel Let SpecToExcel(ByVal vnewvalue As Object) This function sets the member variable m_spectoexcel Get RI Get RI() As Object CreateObject("ComosRILib.RILib") Get PFD Get PFD() As Object CreateObject("ComosPFD.PFDLib") Let RI Let RI(ByVal vnewvalue As Object) Sets the member variable m_ri. Programming Manual, 04/2012, A5E

20 Let PFD Let PFD(ByVal vnewvalue As Object) Sets the member variable m_pfd Get ELO Get ELO() As Object Reference or the class instance created with CreateObject("ComosELOLib.ELOLib") and is assigned to the member variable m_elo and returned Let ELO Let ELO(ByVal vnewvalue As Object) Sets the member variable m_elo Get FLUID Get FLUID() As Object Reference or the class instance created with CreateObject("ComosFluidLib.FluidLib") and is assigned to the member variable m_fluid and returned Let FLUID Let FLUID(ByVal vnewvalue As Object) Sets the member variable m_fluid Get SUI Get SUI() As Object Generates and returns a reference or class instance to the SuiEdDll.dll (CreateObject("ComosSUIEdDll.SUIEdDll")) Get NLMod Get NLMod() As Object Returns a reference to "ComosNameLabelMod.NLMod" as the return value Get device Get device() As Object Returns a reference to "ComosClassDevice.ClassDevice" as the return value. 20 Programming Manual, 04/2012, A5E

21 Let device Let device(byval vnewvalue As Object) Reinitializes the MemberVariable m_device, which is also used as the return value of Get device Get DeviceExt Get DeviceExt() As Object Reference or the class instance created with CreateObject("ComosClassDeviceExt.ClassDeviceExt") and is assigned to the member variable m_deviceext and returned Let DeviceExt Let DeviceExt(ByVal vnewvalue As Object) Sets the member variable m_deviceext Get CArray Get CArray() As Object Reference or the class instance created with CreateObject("ComosClassArray.ClassArray") and is assigned to the member variable m_carray and returned Let CArray Let CArray(ByVal vnewvalue As Object) Sets the member variable m_carray Get DynProp Get DynProp() As Object Reference or the class instance created with CreateObject("ComosDynProp.DynProp") and is assigned to the member variable m_dynprop and returned Let DynProp Let DynProp(ByVal vnewvalue As Object) Sets the member variable m_dynprop. Programming Manual, 04/2012, A5E

22 Get CDevice Get CDevice() As Object Reference or the class instance created with CreateObject("ComosClassCDevice.ClassCDevice") and is assigned to the member variable m_cdevice and returned Let CDevice Let CDevice(ByVal vnewvalue As Object) Sets the member variable m_cdevice Get WorkSet Get WorkSet() As Object Returns Workset Let WorkSet Let WorkSet(ByVal vnewvalue As Object) Sets the member variable m_workset and is called by Comos itself Get DeviceClasses Get DeviceClasses() As Object The return value is of the ComosConstants.Constants type and contains Comos- CDeviceConstans DeviceClass with a corresponding description Get ConnectorLayers Get ConnectorLayers() As Object The return value is of the ComosConstants.Constants type and contains Comos- CDeviceConstans ConnectorsConstants with a corresponding description Get ConnectorIOs Get ConnectorIOs() As Object The return value is of the ComosConstants.Constants type and contains Comos- CDeviceConstans ConnectorsConstants with a corresponding description Get DocumentTypes Get DocumentTypes() As Object The return value is of the ComosConstants.Constants type and contains Comos- CDeviceConstans DocumentType with a corresponding description. 22 Programming Manual, 04/2012, A5E

23 Get DetailClasses Get DetailClasses(ByVal DeviceClass As String) As Object The return value is of the ComosConstants.Constants type and contains Comos- CDeviceConstans DetailClass with a corresponding description Get StatusInfo Get StatusInfo() As String Returns the StatusInfo as a string Let StatusInfo Let StatusInfo(ByVal vnewvalue As String) Sets the StatusInfo via a string parameter Get ProductRequestDisplayText Get ProductRequestDisplayText(ByVal Spec As IComosDSpecification) As String Returns a string which is displayed for ProductRequest data, depending on the range or normal attributes and unit Get PE Get PE() As Object A reference or the class instance that was created with CreateObject("ComosPEModul.PEModul") is returned Get Implementation Get Implementation() As Object Reference or the class instance created with CreateObject("ComosClassDevice.Implement") Get FTIndexManager Get FTIndexManager() As Object Reference or class instance created with CreateObject("ComosFTIndex- Manager.FTIndexManager") Get DVM Get DVM() As Object Reference or the class instance created with CreateObject("ComosDDMSafe.DDMSafe"). Programming Manual, 04/2012, A5E

24 2.1.3 Public Subs DeviceClassesClear DeviceClassesClear() Sets m_deviceclasses = nothing.m_deviceclasses-collection is of the ComosConstants.Constants type and contains all Comos-DeviceClass constants with description text Mail Mail(ByVal Adr As String, ByVal Subject As String, ByVal text As String) Enables s to be sent via the set system ExecuteDecisionTables ExecuteDecisionTables(ByVal RootObj As IComosBaseObject) All decision table objects located underneath the RootObj are listed ExecuteOneDecisionTable ExecuteOneDecisionTable(ByVal DecisionTableObj As IComosBaseObject) If the transfer parameter is a decision table object, it is executed; otherwise, the objects located underneath it are evaluated and all ExecuteOneDecisionTable objects are executed Output Output(OutputStr As String) OutputDebugstring call RefreshSpecValuesBySpecOwner RefreshSpecValuesBySpecOwner(ByVal SpecOwner As Object) Refreshes the attribute values of the open "Attributes" tab. The open form is searched for in COMOS with the help of the SpecOwner RefreshCurrentChapterBySpecOwner RefreshCurrentChapterBySpecOwner RefreshCurrentChapterBySpecOwner(ByVal SpecOwner As Object) Refreshes the current attributes tab of the open SpecOwner, i.e. the controls of the attributes are reloaded. 24 Programming Manual, 04/2012, A5E

25 FormShow FormShow(ByVal VBFrm As Object, Optional ByVal mode As FormShowConstants = vbmodeless) Displays a corresponding VB form in the specified mode (modal or not modal) in Comos OnChangeOther OnChangeOther(ByVal Spec As IComosDSpecification, ByVal NestedName As String) This function enables the script function OnChangeOther to be called at a different attribute. The attribute is searched for via the Spec.Get-SpecOwner and starting from this with.spec(nestedname) ConvertPhysUnitsInProject ConvertPhysUnitsInProject(ByVal Proj As IComosDProject, ByVal ConvMode As econvertmode, _ ByVal ConvObjs As econvertobjs, ByVal ConvSpecs As econvertspecs) Function for converting the unit per object or per attribute to the default unit of one of the five unit systems CopyLanguagesFromCDeviceSystem CopyLanguagesFromCDeviceSystem(ByVal Proj As IComosDProject, ByVal WithMsgBox As Boolean) Function for copying languages from the base project CreateOverlaySpecs CreateOverlaySpecs(ByVal WO As IComosDWorkingOverlay) Generates the attributes of the base object for a newly generated working layer. Programming Manual, 04/2012, A5E

26 26 Programming Manual, 04/2012, A5E