ObjectStore C++ API Reference

Preface

Purpose
The ObjectStore C++ API Reference provides a reference on the core C++ programming interface to ObjectStore. It is supplemented by the ObjectStore Collections C++ API Reference, which describes the programming interface for using ObjectStore collections, queries, and indexes.

Audience
This book assumes the reader is experienced with C++.

Scope
Information in this book assumes that ObjectStore is installed and configured. This book supports ObjectStore Release 5.1.

How This Book Is Organized

The manual has seven chapters and an appendix.

Introduction
The introduction describes the ObjectStore database services. See Chapter 1, Introduction.

Class library
The class library chapter describes the system-supplied C++ classes, whose members and enumerators provide an interface to database features. The classes are listed alphabetically by class name. Within the entry for each class, the class's members, as well as enumerators defined within the class's scope, are listed alphabetically. See Chapter 2, Class Library.

System-supplied global functions
Some system-supplied interface functions are not members of any class, but are global C++ functions (operator new() and operator delete()). These are listed alphabetically in Chapter 3, System-Supplied Global Functions.

System-supplied macros
Some ObjectStore functionality is accessed through the use of macros (such as those for starting and ending transactions). These are listed alphabetically in Chapter 4, System-Supplied Macros.

User-supplied functions
Access to database services sometimes requires support from user-defined functions. The required functions are listed alphabetically in Chapter 5, User-Supplied Functions.

C library interface
In addition to C++ class and function libraries, ObjectStore provides C functions and macros analogous to those provided in the C++ libraries so that it is possible for C programs to access all ObjectStore functionality. These are listed in Chapter 6, C Library Interface.

Exception facility
ObjectStore uses an exception facility added onto C++ by Object Design, Inc. An appendix is included that provides an account of signaling and handling exceptions. See Appendix A, Exception Facility.

Predefined exceptions
This appendix is an alphabetical listing of the predefined exceptions that can be signaled by ObjectStore at run time. See Appendix B, Predefined TIX Exceptions.

Notation Conventions

This document uses the following conventions:
ConventionMeaning
Bold Bold typeface indicates user input or code.
Sans serif Sans serif typeface indicates system output.
Italic sans serif Italic sans serif typeface indicates a variable for which you must supply a value. This most often appears in a syntax line or table.
Italic serif In text, italic serif typeface indicates the first use of an important term.
[ ]Brackets enclose optional arguments.
{ a | b | c }Braces enclose two or more items. You can specify only one of the enclosed items. Vertical bars represent OR separators. For example, you can specify a or b or c.
...Three consecutive periods indicate that you can repeat the immediately previous item. In examples, they also indicate omissions.




Indicates that the operating system named inside the circle supports or does not support the feature being discussed.

ObjectStore Release 5.1 Documentation

The ObjectStore Release 5.1 documentation is chiefly distributed
online in web-browsable format. If you want to order printed books, contact your Object Design sales representative.

Your use of ObjectStore documentation depends on your role and
level of experience with ObjectStore. You can find an overview description of each book in the ObjectStore documentation set at
URL http://www.objectdesign.com. Select Products and then select Product Documentation to view these descriptions.

Internet Sources for More Information

World Wide Web
 Object Design's support organization provides a number of information resources. These are available to you through a Web browser such as Mosaic or Netscape. You can obtain information by accessing the Object Design home page with the URL http://www.objectdesign.com. Select Technical Support. Select Support Communications for detailed instructions about different methods of obtaining information from support.

Internet gateway
You can obtain such information as frequently asked questions (FAQs) from Object Design's Internet gateway machine as well as from the Web. This machine is called ftp.objectdesign.com and its Internet address is 198.3.16.26. You can use ftp to retrieve the FAQs from there. Use the login name odiftp and the password obtained from patch-info. This password also changes monthly, but you can automatically receive the updated password by subscribing to patch-info. See the README file for guidelines for using this connection. The FAQs are in the subdirectory ./FAQ. This directory contains a group of subdirectories organized by topic. The file ./FAQ/FAQ.tar.Z is a compressed tar version of this hierarchy that you can download.

Automatic email notification
In addition to the previous methods of obtaining Object Design's latest patch updates (available on the ftp server as well as the Object Design Support home page) you can now automatically be notified of updates. To subscribe, send email to patch-info-request@objectdesign.com with the keyword SUBSCRIBE patch-info < your siteid> in the body of your email. This will subscribe you to Object Design's patch information server daemon that automatically provides site access information and notification of other changes to the online support services. Your site ID is listed on any shipment from Object Design, or you can contact your Object Design Sales Administrator for the site ID information.

Training

If you are in North America, for information about Object Design's educational offerings, or to order additional documents, call 781.674. 5000, Monday through Friday from 8:30 AM to 5:30 PM Eastern Time.

If you are outside North America, call your Object Design sales representative.

Your Comments

Object Design welcomes your comments about ObjectStore documentation. Send your feedback to support@objectdesign.com. To expedite your message, begin the subject with Doc:. For example:

Subject: Doc: Incorrect message on page 76 of reference manual
You can also fax your comments to 781.674.5440.

Copyright Information

ObjectStore C++ API Reference

ObjectStore Release 5.1, March 1998

ObjectStore, Object Design, the Object Design logo, LEADERSHIP BY DESIGN, and Object Exchange are registered trademarks of Object Design, Inc. ObjectForms and Object Manager are trademarks of Object Design, Inc.

All other trademarks are the property of their respective owners.

Copyright © 1989 to 1998 Object Design, Inc. All rights reserved. Printed in the United States of America. Except as permitted under the Copyright Act of 1976, no part of this publication may be reproduced or distributed in any form or by any means, or stored in a database or retrieval system, without the prior written permission of the publisher.

COMMERCIAL ITEM - The Programs are Commercial Computer Software, as defined in the Federal Acquisition Regulations and Department of Defense FAR Supplement, and are delivered to the United States Government with only those rights set forth in Object Design's software license agreement.

Data contained herein are proprietary to Object Design, Inc., or its licensors, and may not be used, disclosed, reproduced, modified, performed or displayed without the prior written approval of Object Design, Inc.

This document contains proprietary Object Design information and is licensed for use pursuant to a Software License Services Agreement between Object Design, Inc., and Customer.

The information in this document is subject to change without notice. Object Design, Inc., assumes no responsibility for any errors that may appear in this document.

Object Design, Inc.
Twenty Five Mall Road
Burlington, MA 01803-4194

Part number: SW-OS-DOC-REF-510



[next]

Copyright © 1997 Object Design, Inc. All rights reserved.

Updated: 03/31/98 17:23:37