Dimensions CM Developer's Reference
Total Page:16
File Type:pdf, Size:1020Kb
SERENA DIMENSIONS CM 14.3.2 Developer’s Reference Serena Proprietary and Confidential Information Copyright © 1988–2016 Serena Software, Inc. All rights reserved. This document, as well as the software described in it, is furnished under license and may be used or copied only in accordance with the terms of such license. Except as permitted by such license, no part of this publication may be reproduced, photocopied, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, recording, or otherwise, without the prior written permission of Serena. Any reproduction of such software product user documentation, regardless of whether the documentation is reproduced in whole or in part, must be accompanied by this copyright statement in its entirety, without modification. This document contains proprietary and confidential information, and no reproduction or dissemination of any information contained herein is allowed without the express permission of Serena Software. The content of this document is furnished for informational use only, is subject to change without notice, and should not be construed as a commitment by Serena. Serena assumes no responsibility or liability for any errors or inaccuracies that may appear in this document. Third party programs included with the Dimensions product are subject to a restricted use license and can only be used in conjunction with Dimensions. Trademarks Serena, TeamTrack, StarTool, PVCS, Comparex, Dimensions, Prototype Composer, Mariner, and ChangeMan are registered trademarks of Serena Software, Inc. The Serena logo and Version Manager are trademarks of Serena Software, Inc. All other products or company names are used for identification purposes only, and may be trademarks of their respective owners. U.S. Government Rights Any Software product acquired by Licensee under this Agreement for or on behalf of the U.S. Government, its agencies and instrumentalities is "commercial software" as defined by the FAR. Use, duplication, and disclosure by the U.S. Government is subject to the restrictions set forth in the license under which the Software was acquired. The manufacturer is Serena Software, Inc., 2345 NW Amberbrook Drive, Suite 200, Hillsboro, OR 97006. Publication date: October 2016 Table of Contents Part 1 C/C++ API DTK . 29 Chapter 1 What is the Dimensions CM Toolkit Interface? . 31 Overview . 32 Positioning Your Solutions within the DTK . 32 Client Architecture. 32 Event Architecture. 33 Interactions between the Two Architectures . 33 Scope of the DTK Architecture. 33 Chapter 2 Writing Dimensions CM DTK Applications . 35 Introduction . 36 DTK Return Codes . 37 DTK Data Structures . 38 PcmsCallbackStruct . 38 PcmsChdAttachmentStruct . 38 PcmsEventStruct . 39 PcmsLcStruct . 39 PcmsObjAttrDefStruct . 40 PcmsObjAttrStruct. 41 PcmsObjStruct . 42 PcmsPendingUserStruct . 42 PcmsPendStruct . 43 PcmsRelStruct. 43 PcmsRelTypeStruct . 44 PcmsRoleStruct. 44 PcmsTypeStruct . 44 PcmsUserRoleStruct . 45 DTK System Attribute Definitions. 45 DTK Constant Definitions . 50 Memory Allocation within the DTK . 51 Usage of the Functions. 52 Chapter 3 DTK API Functions for C/C++ . 55 Introduction . 57 Memory Allocation by DTK Functions . 57 Access Security in DTK Functions. 57 PcmsAttrDefInit - Get Attribute Definition . 59 Purpose . 59 Prototype . 59 Parameters. 59 Return Codes . 59 Developer's Reference 3 Table of Contents Related Functions . 59 PcmsAttrGetLov - Get Attribute's List of Values . 60 Purpose . 60 Prototype . 60 Parameters. 60 Return Codes . 61 Sample . 61 Related Functions . 62 PcmsAttrValidate - Validate an Attribute Value . 63 Purpose . 63 Prototype . 63 Parameters. 63 Return Codes . 63 Related Functions . 63 PcmsCheckMessages - Check Results of Dimensions CM Command . 64 Purpose . 64 Prototype . 64 Parameters. 64 Return Codes . 64 Comments . 64 Related Functions . 65 PcmsCntrlPlanGet - Get Dimensions CM Process Model Information . 66 Purpose . 66 Prototype . 66 Parameters. 66 Return Codes . 68 PcmsConnect - Connect to Dimensions CM Database . 69 Purpose . 69 Prototype . 69 Parameters. 69 Return Codes . 69 Comments . 69 Sample . 70 Related Function . 70 PcmsDisconnect - Disconnect from a Dimensions CM Database . 71 Purpose . 71 Prototype . 71 Parameters. 71 Return Codes . 71 Sample . 71 Comments . 71 Related Function . 71 PcmsEvntCalloc – Allocate Zero Initialized Memory . 72 Purpose . 72 Prototype . ..