Class: RevisionInfo 1 Class: RevisionMaster 2 COMOS Platform Class documentation RevisionMaster_dll Programming Manual 03/2017 V10.2.1 A5E39859923-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: Trademarks 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. 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 Division Process Industries and Drives Postfach 48 48 90026 NÜRNBERG GERMANY A5E39859923-AA P 02/2017 Subject to change Copyright Siemens AG 2016-2017. All rights reserved
Table of contents 1 Class: RevisionInfo...5 1.1 RevisionInfo: Function...5 1.2 RevisionInfo: Property...5 2 Class: RevisionMaster...7 2.1 RevisionMaster: Function...7 2.2 RevisionMaster: Property...7 Programming Manual, 03/2017 V10.2.1, A5E39859923-AA 3
Table of contents 4 Programming Manual, 03/2017 V10.2.1, A5E39859923-AA
Class: RevisionInfo 1 1.1 RevisionInfo: Function GetReleasedRevision GetReleasedRevision(Optional Index As Long = -1) As IComosDDevice Returns the last released revision object. Index The index starts at 0. If no parameter is set, the last revision object is returned. Default setting: -1. If no parameter is set, -1 is used. The parameter -1 returns the last revision object. GetReleasedRevisionFile GetReleasedRevisionFile(Optional Index As String = -1, Optional ByVal RevIndex As Long = -1) As String Returns the path of the last released revision file. Index The index starts at 0. If no parameter is set, the last revision file is evaluated. Default setting: -1. If no parameter is set, -1 is used. With the parameter -1, the last revision file is evaluated. RevIndex Only continues to be available for compatibility reasons. Do not use. 1.2 RevisionInfo: Property Document Get Document() As Object Returns the revised document. Revision Get Revision() As String Returns the revision index, the revision label and the revision description in a single string. Separator: Semicolon (";") RevisionState Get RevisionState() As String Programming Manual, 03/2017 V10.2.1, A5E39859923-AA 5
Class: RevisionInfo 1.2 RevisionInfo: Property Returns the revision step, the revision step label and the revision step description in a single string for the current revision object. CurrentRevision Get CurrentRevision() As IComosDDevice Returns the current revision object. 6 Programming Manual, 03/2017 V10.2.1, A5E39859923-AA
Class: RevisionMaster 2 2.1 RevisionMaster: Function DoRevision DoRevision(Optional ByVal ElmDescription As String = "", Optional ByVal ElmSign As String = "") As edorevres Generates the next revision step. ElmDescription Description of the revision step. If the information is missing, an automatically generated text is used. ElmSign Revision step label of the revision step. If the information is missing, an automatically generated text is used. CreateRevision CreateRevision(ByVal Document As IComosBaseObject) As IComosDDevice Creates a new revision (*-Revision). GetNextRevisionName GetNextRevisionName(Optional ByVal PlantRev As IComosDDevice) As Long Returns the next revision index. PlantRev Returns the next revision index of the set revision object. If the information is missing, the current revision object is used. GetLastRev GetLastRev() As IComosDDevice Returns the last revision object. 2.2 RevisionMaster: Property CurrentRevision Get CurrentRevision() As IComosDDevice Returns the current revision object. Programming Manual, 03/2017 V10.2.1, A5E39859923-AA 7
Class: RevisionMaster 2.2 RevisionMaster: Property RevDescription Let RevDescription(ByVal vnewvalue As String) Sets the description at the current revision object. RevDescription Get RevDescription() As String Returns the description of the current revision object. Document Get Document() As Object Returns the revised document object. Document Set Document(ByVal vnewvalue As Object) Sets the document to be revised. 8 Programming Manual, 03/2017 V10.2.1, A5E39859923-AA