Serena ChangeMan Version Manager Developer's Toolkit Reference Guide

1y ago
14 Views
2 Downloads
1.85 MB
210 Pages
Last View : 17d ago
Last Download : 4m ago
Upload by : Mya Leung
Transcription

Serena ChangeMan Version Manager Developer's Toolkit Reference Guide

Copyright 1985–2005 Serena Software, Inc. All rights reserved.This document, as well as the software described in it, is furnished under license and maybe used or copied only in accordance with the terms of such license. Except as permittedby such license, no part of this publication may be reproduced, photocopied, stored in aretrieval system, or transmitted, in any form or by any means, electronic, mechanical,recording, or otherwise, without the prior written permission of Serena. Any reproductionof such software product user documentation, regardless of whether the documentationis reproduced in whole or in part, must be accompanied by this copyright statement in itsentirety, without modification.The content of this document is furnished for informational use only, is subject to changewithout notice, and should not be construed as a commitment by Serena. Serenaassumes no responsibility or liability for any errors or inaccuracies that may appear in thisdocument.TrademarksSerena, TeamTrack, StarTool, PVCS, Collage, and ChangeMan are registered trademarksof Serena Software, Inc. The Serena logo, Dimensions, Professional, Tracker, VersionManager, Builder, Meritage, and Mover are trademarks of Serena Software, Inc.All other products or company names are used for identification purposes only, and maybe trademarks of their respective owners.U.S. Government RightsAny Software product acquired by Licensee under this Agreement for or on behalf of theU.S. Government, its agencies and instrumentalities is "commercial software" as definedby the FAR. Use, duplication, and disclosure by the U.S. Government is subject to therestrictions set forth in the license under which the Software was acquired. Themanufacturer is Serena Software, Inc., 2755 Campus Drive, San Mateo, CA 94403.Publication date: April 2005

Table of ContentsChapter 1Welcome to Version Manager . . . . . . . . . . . . . . . . . . . . .7Using this Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7Contacting Technical Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9Overview . . . . . . . . . . . . . . .Components of the ToolkitCalling Conventions . . . . .Data Structures. . . . . . . .Null Parameters . . . . . . .Chapter 2.1010111112Compiling and Linking Windows Applications . . . . . . . . . . . . . . . . . . . . .12Compiling and Linking UNIX Applications . . . . . . . . . . . . . . . . . . . . . . . .13Initializing the Toolkit and Setting Global Parameters . . . . . . . . . . . . . . . .13Reading the Configuration File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14Using Archive Handles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14Using DTK Applications with a Version Manager File Server . . . . . . . . . . .15Serena ChangeMan Version Manager Functions . . . . . . . . .17IDENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20PvcsAccessAddGroupGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20PvcsAccessAddGroupUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21PvcsAccessCloseDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22PvcsAccessDefineGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .23PvcsAccessDefinePrivilege. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24PvcsAccessDefineUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25PvcsAccessDeleteGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27PvcsAccessDeleteGroupGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28PvcsAccessDeleteGroupUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29PvcsAccessDeletePrivilege. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29PvcsAccessDeleteUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30PvcsAccessEnumerateGroupGroups . . . . . . . . . . . . . . . . . . . . . . . . . . . .31PvcsAccessEnumerateGroups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32PvcsAccessEnumerateGroupUsers . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34PvcsAccessEnumeratePrivilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35Developer's Toolkit Reference Guide.3

Table of Contents4PvcsAccessEnumeratePrivileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36PvcsAccessEnumerateUserGroups . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37PvcsAccessEnumerateUsers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39PvcsAccessOpenDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40PvcsAccessQueryGroup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41PvcsAccessQueryPrivilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42PvcsAccessQueryUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43PvcsAccessRenameGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45PvcsAccessRenameGroupGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46PvcsAccessRenameGroupUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47PvcsAccessRenamePrivilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48PvcsAccessRenameUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49PvcsAddAlias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .50PvcsAddPromoteTreeNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .51PvcsAssignPromoGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53PvcsAssignVersion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .54PvcsCancelUpdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .56PvcsChangeAccessList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .57PvcsChangeArchiveInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .59PvcsCloseAll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62PvcsCloseArchive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .63PvcsComputeArchiveName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .64PvcsCreateArchive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65PvcsDeleteRevision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67PvcsDiagnosticEnable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68PvcsEndArchiveSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .73PvcsExport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .74PvcsFindFirstArchive. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .79PvcsFindNextArchive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .81PvcsGenDeltaFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .82PvcsGetArchiveInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .85PvcsGetArchiveInfoVB1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .87PvcsGetArchiveInfoVB2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .90PvcsGetErrorMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .92PvcsGetExtRevAttribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .93PvcsGetLockInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .95PvcsGetLockInfoVB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .97Serena ChangeMan Version Manager 8.1

Table of ContentsPvcsGetPromoParent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .99PvcsGetRevision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .100PvcsGetRevisionInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .103PvcsGetRevisionInfo2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .105PvcsGetRevisionInfoVB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .107PvcsGetUserInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .110PvcsGroupToRevision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .111PvcsInit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .113PvcsIsArchive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .114PvcsIsUserInDatabase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .114PvcsListJournal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .115PvcsLockRevisionGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .117PvcsLog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .119PvcsLogin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .122PvcsMakeDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .123PvcsMerge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .124PvcsMerge2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .126PvcsOpenArchive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .129PvcsPromoteRevision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .131PvcsPutExtRevAttribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .132PvcsPutRevision. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .134PvcsQueryAlias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .138PvcsQueryArchiveAccess. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .139PvcsQueryConfiguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .140PvcsQueryConfigurationError. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .143PvcsQueryConfigurationItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Directive Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .144145PvcsQueryUserAccess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .150PvcsQueryVconfigItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .151PvcsReadDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .152PvcsRedirectOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .154PvcsRegisterCallback . . . . . . . . . . . . . .PVCS CALLBACK CFG ALIASREF . .PVCS CALLBACK CFG CONDITION .PVCS CALLBACK CFG INCLUDE . . .PVCS CALLBACK CHGDESC . . . . . .PVCS CALLBACK CONFIG . . . . . . .PVCS CALLBACK CONFIRM . . . . . .PVCS CALLBACK DELAY . . . . . . . .PVCS CALLBACK FREEMEM . . . . . .PVCS CALLBACK WORKDESC . . . .155156157157157158159160160161.Developer's Toolkit Reference Guide.5

Table of ContentsChapter 3Chapter 4PVCS CALLBACK NO DIRECTORY . . . . . . . . . . . . . . . . . . . . . . . . .PVCS CALLBACK YIELD. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .161162PvcsRegisterEvent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .163PvcsReportDifferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .165PvcsSetGlobalParameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .168PvcsSetProjectSemaphore. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .169PvcsTestDifferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .170PvcsUnLockRevision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .172PvcsUnRegisterEvent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .173PvcsVconfig. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .175PvcsVerifyPromoTree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .177PvcsVerifyPromoTreeNodeExist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .178PvcsVersionToRevision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .179Serena Configuration Builder Functions . . . . . . . . . . . . . . 183PvcsBuild . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .184PvcsCloseBuildScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .185PvcsReadBuildScript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .186PvcsRedirectBuildOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .188PvcsRegisterBuildCallback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .190PvcsSaveWinmainParams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .193PvcsUnsaveWinmainParams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .194Return Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195Return Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Chapter 5195Data Structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203Data Structures . . .ARCHIVEINFO .CONFIG . . . . .LOCK . . . . . . .PVCSDATE . . .REVINFO . . . .203203204205205205Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2076Serena ChangeMan Version Manager 8.1

Welcome to Version ManagerThank you for choosing Serena ChangeMan Version Manager, a powerful and versatileversion control system that will revolutionize the way you develop software. VersionManager helps you organize, manage, and protect your software development projects onevery level—from storing and tracking changes to individual files, to managing andmonitoring an entire development cycle.Purpose of thismanualFor moreinformationThe Serena ChangeMan Version Manager Developer's Toolkit Reference Guide containsinformation for programmers using Developer's Toolkit to build applications that useSerena ChangeMan Professional Suite services.Refer to the Serena ChangeMan Version Manager Getting Started Guide for a descriptionof the Version Manager documentation set, a summary of the ways to work with VersionManager, and instructions for accessing the Online Help.Using this ManualInformation forprogrammersThe Serena ChangeMan Version Manager Developer's Toolkit Reference Guide containsinformation for programmers using Developer's Toolkit to build applications that useSerena ChangeMan Professional Suite services.The Developer's Toolkit Reference Guide contains these chapters: Information aboutVersion ManagerfunctionsChapter 1, "Introduction" on page 9, presents an overview of the Developer's Toolkit,and explains how to compile and link applications that use Serena ChangeManProfessional Suite services.Chapter 2, "Serena ChangeMan Version Manager Functions" on page 17, describesVersion Manager functions in alphabetic order.Chapter 3, "Serena Configuration Builder Functions" on page 183, describesConfiguration Builder functions in alphabetic order.Chapter 4, "Return Values" on page 195, lists values returned by Professionalfunctions, along with an explanation of each error.Chapter 5, "Data Structures" on page 203, lists data structures used by Professionalfunctions.The function descriptions in Chapters 2 and 3 include function syntax, parameters, returnvalues, and code examples. Developer's Toolkit includes source files that contain codeused in the examples.Typographical ConventionsThe following typographical conventions are used in the online manuals and online help.These typographical conventions are used to assist you when using the documentation;Developer's Toolkit Reference Guide7

Welcome to Version Managerthey are not meant to contradict or change any standard use of typographical conventionsin the various product components or the host operating system.ConventionitalicsExplanationIntroduces new terms that you may not be familiarwith and occasionally indicates emphasis.boldEmphasizes important information and field names.UPPERCASEIndicates keys or key combinations that you can use.For example, press the ENTER key.monospaceIndicates syntax examples, values that you specify,or results that you receive.monospaceditalicsIndicates names that are placeholders for values youspecify; for example, filename.monospace boldIndicates the results of an executed command.vertical rule Separates menus and their associated commands.For example, select File Copy means to select Copyfrom the File menu.Also, indicates mutually exclusive choices in acommand syntax line.brackets []Indicates optional items. For example, in thefollowing statement: SELECT [DISTINCT],DISTINCT is an optional keyword.Indicates command arguments that can have morethan one value.Contacting Technical SupportRegistered customers can log in to http://support.serena.com/.8Serena ChangeMan Version Manager 8.1

Chapter 1IntroductionOverview10Compiling and Linking Windows Applications12Compiling and Linking UNIX Applications13Initializing the Toolkit and Setting Global Parameters13Reading the Configuration File14Using Archive Handles14Using DTK Applications with a Version Manager File Server15Developer's Toolkit Reference Guide9

Chapter 1 IntroductionOverviewUseVersion Managerfunctions in yourapplicationSerena ChangeMan Version Manager Developer's Toolkit provides applicationprogramming interface (API) functions for programmers who want to develop applicationsthat use Serena ChangeMan Professional Suite services. You can use the functions inDeveloper's Toolkit to build your own interface to Serena configuration management tools,or to add configuration management capabilities to your applications.Visual Basic and Delphi programmers can also utilize the Serena ChangeMan VersionManager Developer's Toolkit functionality easily without having to write external functionsto manipulate certain data structures normally returned by a few Developer's Toolkitfunctions.The Developer's Toolkit includes functions that implement the functionality of SerenaChangeMan Version Manager and Serena Configuration Builder.You can use Developer's Toolkit to build applications that use Serena ChangeManProfessional Suite services on various platforms.Components of the ToolkitDLLs, libraries,and header filesSerena ChangeMan Version Manager Developer's Toolkit consists of a set of dynamic linklibraries (DLLs), import libraries, shared libraries, two static libraries, and header files.Dynamic Link LibrariesWindows DLLsThe Developer's Toolkit includes the following DLLs for Windows: VMWFDTK.DLL contains functions for Version Manager services for 32-bit Windows. CBWF51.DLL contains functions for Configuration Builder services for 32-bit Windows.NOTE When you are using the Serena ChangeMan Professional Suite services, thecalling application must be able to find the DLLs. Under Windows, the DLLs must be inthe same directory as the calling application or in a directory included in the PATHstatement.Import LibrariesWindows librariesShared UNIXLibraries10The Developer's Toolkit includes the following import libraries for linking Windowsprograms: VMWFDTK.LIB is the 32-bit import library for Version Manager functions. CBWF51.LIB is the 32-bit import library for Configuration Builder functions.Shared LibrariesThe Developer's Toolkit includes the following shared libraries for UNIX: libpvcsvm.a is the shared UNIX object library for Version Manager for AIX. libpvcsvm.sl is the shared UNIX object library for Version Manager for HP-UX. libpvcsvm.so is the shared UNIX object library for Version Manager for Solaris.Serena ChangeMan Version Manager 8.1

OverviewStatic LibraryStatic UNIX libraryThe Developer's Toolkit includes two static libraries for UNIX: pvcscb.a is the UNIX object library for Configuration Builder functions. pvcsdtk.a is the UNIX object library for Version Manager functions.Header FilesThe Developer's Toolkit includes the following C header files: pvcs.h contains definitions and function prototypes for the Serena ChangeManProfessional Suite services.pvcsb.h contains definitions and function prototypes for Configuration Builderfunctions. This file is automatically included by pvcs.h.pvcsvm.h contains definitions and function prototypes for Version Manager functions.This file is automatically included by pvcs.h.pvcsvm.bas contains definitions and function prototypes for use with Visual Basicapplications.pvcsdtk.pas contains definitions and function prototypes for use with Delphiapplications.NOTE When compiling under Windows, your program should include windows.h beforeincluding pvcs.h.Calling ConventionsUnless stated otherwise, any revision parameter can be a revision number, version label,or promotion group. If the parameter refers to a version label that begins with a number,you must prefix the label with a backslash (\) so that Version Manager does not recognizeit as a revision number.All functions return a value of zero if successful. Non-zero return values indicate that anerror occurred. See Chapter 4, "Return Values" for descriptions of the error codes.Developer's Toolkit uses the following conventions for Windows DLLs: The CDecl calling convention for 32-bit Windows.Developer's Toolkit uses the following convention for UNIX: The C language calling convention.Data StructuresTypes of returneddataMany Serena ChangeMan Professional Suite services return data to the caller. There arethree types of returned data: Simple data types, such as integer. Null-terminated ASCII text strings.Developer's Toolkit Reference Guide11

Chapter 1 Introduction Data structures. These data structures are listed as C structures in the header filesPVCSVM.H and PVCSCB.H, and in Chapter 5, "Data Structures"The caller must allocate memory for data returned by the Professional services. The datastructures contain a fixed-length structure, which may contain pointers to variable-lengthstrings. The buffer must be large enough to hold the fixed portion plus the variableportion.The Developer's Toolkit returns the error code PVCS E BUFFER OVERFLOW if the buffer istoo small.Structures use the Microsoft C convention of even-byte alignment. This means that allstructure members begin on an even-byte address.Null ParametersNull pointer equalspointer to a nullstringUnless otherwise stated, functions with parameters that are pointers to text strings treata null pointer and a pointer to a null string as equivalent.Compiling and Linking Windows ApplicationsCompiling tipsThe following tips on compiling and linking applications use the Professional API functions: ExamplesPublic names. Professional services are case-insensitive. If you are using theMicrosoft C compiler, the header files declare the functions as Pascal type, whichmeans that the compiler converts all public symbols to upper case in generated objectcode.Stack. Allocate an additional 4K beyond your application's normal stackrequirements. (Use the /Stack command-line option with the Microsoft linker.)Single thread. Professional services were not designed to be used with multiplethreads. Results are unpredictable if a process has more than one active threadexecuting Professional functions. Multiple processes executing Professional functionswill not cause problems.Memory model. Professional services use the flat memory model for Windows: 32bit values are used for everything.The following compiling and linking examples are for Windows using Microsoft win32 SDK:set LIB %LIB%;\pvcsdtk\libset INCLUDE %INCLUDE%;\pvcsdtk\includecl386 -c -Di386 -D X86 -G3 -Foobject file source filelink32 -machine:i386 -out:executable file -subsystem:consoleobject r.libadvapi32.lib12Serena ChangeMan Version Manager 8.1

Compiling and Linking UNIX ApplicationsMS Visual C :set LIB \msvcnt\lib;\pvcsdtk\libset INCLUDE \msvcnt\include;\pvcsdtk\includeset LINK -machine:i386 -subsystem:consoleCL /c /W3 /G3 test.cLINK test.obj,vmwfdtk libcmt kernel32 advapi32Compiling and Linking UNIX ApplicationsTips on compilingExamplesTo compile a module that includes Developer's Toolkit functions, add the directorycontaining the header files to the compiler's header file search path. For UNIX Ccompilers, you generally use the -I option to specify an additional directory in which tosearch for header files.In the examples below, os is sol, hpux, or aix. To compile a module named test.c thatincludes a Developer's Toolkit function, type:cc -I/usr/pvcs/vm/os/dtk -DCDECL "" -DSYS UNIX -c test.cTo link programs that use Developer's Toolkit, name all of the Developer's Toolkit librarieson the command line.The following examples link a program called test, which uses both Version Manager andConfiguration Builder functions.To link the application, enter:cc -o test test.o \/usr/pvcs/vm/os/dtk/pvcsvm \/usr/pvcs/vm/os/dtk/pvcscb.a \where pvcsvm specifies the shared object library for Version Manager for the operatingsystem. The value can be any of the following: for AIX: pvcsvm.a for HP-UX: pvcsvm.sl for Solaris: pvcsvm.soFor programs that require the Configuration Builder functions, you must link in pvcscb.a.If you are building a static application, use pvcsdtk instead of pvcsvm.Initializing the Toolkit and Setting Global ParametersInitialize theToolkit firstSet globalparametersBefore performing Version Manager operations, you must first use the PvcsInit function toinitialize the Toolkit. If you don't initialize the Toolkit, the first function you call will callPvcsInit for you. See "PvcsInit" on page 113 for details.After you have initialized the toolkit, you should set global parameters that affect allDeveloper's Toolkit functions. See "PvcsSetGlobalParameter" on page 168 for details.Developer's Toolkit Reference Guide13

Chapter 1 IntroductionReading the Configuration FileRead theconfiguration filefirstBefore performing most Version Manager operations, you should first use thePvcsQueryConfiguration function to read the configuration file, which defines manyaspects of Version Manager's behavior.PvcsQueryConfiguration finds the default configuration file using the usual VersionManager rules. (These rules are listed in the Serena ChangeMan Version ManagerCommand-Line Reference Guide.) You can specify a configuration file, which overridesthe normal rules for locating the configuration file.If you do not call PvcsQueryConfiguration, the Professional services use the defaultconfiguration settings. If your application changes the current directory to a directory thatcontains a local configuration file, you should call PvcsQueryConfiguration again toupdate the configuration settings.Using Archive HandlesFunctions to openand close archivesBefore accessing an archive, you can open it with PvcsOpenArchive. This functionreturns an archive handle, which you pass to other Professional services. When you arefinished with the archive, call PvcsCloseArchive, which applies pending updates to thearchive, closes it, and frees internal resources associated with it.Functions canopen archivesautomaticallyIt is not necessary to use PvcsOpenArchive to open an archive before processing it. Ifyou use the services that access archives with an archive name rather than an archivehandle, they can open and close the archives themselves.However, if you are performing multiple operations on an archive, it is more efficient toopen the archive first and pass the archive handle to other services.Close or keeparchives openIf you have several operations to perform on an archive, you can close the archive aftereach, or you can close it after the last operation. Here are the advantages anddisadvantages of each: Operating onmultiple archivesClose after each operation. This makes each operation a separate event. Theadvantage is that the archive is free between operations, which allows access by otherusers. However, there is more overhead associated with opening and closing thearchive multiple times, and another user could update the archive betweenoperations.Close after last operation. The archive remains open throughout the operations,which has the advantage of making all operations appear as a single transaction. Ifyou open the archive in update mode, no other users can update the archive until youclose it.If you will perform operations on multiple archives, make sure the you close

The Developer's Toolkit includes functions that implement the functionality of Serena ChangeMan Version Manager and Serena Configuration Builder. You can use Developer's Toolkit to build applications that use Serena ChangeMan Professional Suite services on various platforms. Components of the Toolkit DLLs, libraries, and header files

Related Documents:

Serena Requirements Manager is an orchestration of Serena Dimensions RM and Serena Business Manager. As part of Serena ALM, Requirements Manager fits into an orchestrated workflow with Serena Development Manager. Optionally, it can leverage the rich reporting capabilities of Serena Dashboard. It also includes Serena Prototype Composer as a .

Serena Prototype Composer Integration Guide for Serena Dimensions RM SERENA PROPRIETARY AND CONFIDENTIAL INFORMATION

REST Services Getting Started Guide 3 Table of Contents . Documents the Web Services application programming interface to ChangeMan ZMF. Manual Description. 8 ChangeMan ZMF Welcome to ChangeMan ZMF 6 Optionally, select one or more of the additional search options, such as Whole words

6 Install the IBI WebFOCUS Server, which powers the Serena ALM Dashboard. 7 Install the Serena ALM Dashboard, which provides reporting features for Serena Development Manager. 8 Install the IBI WebFOCUS Developer Studio, which enables you to manage and edit metrics for the Serena ALM Dashboard. Preparing for the Installation .

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, Collage, Comparex, Dimensions, Serena Dimensions, Mashup Composer, Mashup Exchange, Prototype Composer, Mariner and ChangeMan are

Serena Dashboard presents data on your most essential key performance indicators (KPIs) with a fully configurable set of graphical charts, tabular data, and more. What Is Included Out-of-the-Box Right out-of-the-box, Serena Dashboard includes a number of KPI metrics designed to present

SERENA SERENA DASHBOARD Installation and Configuration Guide Serena Proprietary and Confidential Information

an accounting policy. In making that judgment, management considers, first the requirement of other IFRS standards dealing with similar issues, and the concepts in the IASB’s framework. It also may consider the accounting standards of other standard-setting bodies. International Financial Reporting Standards Australian Accounting Standards