ObjectStore Active Toolkit Reference

Preface

Purpose
The ObjectStore Active Toolkit Reference provides a reference on the Active Toolkit ActiveX and OLE DB programming interfaces to ObjectStore.

Audience
This book is for experienced Visual Basic, Visual Basic Script, Java, Java Script, or C++ developers who are developing applications that run under Windows NT or Windows 95/98 and want to access objects stored in an ObjectStore database through an ActiveX interface.

Scope
This book supports Release 6.0 of the ATK interface to ObjectStore Release 6.0. Information in this book assumes that ATK is installed and configured.

How This Book Is Organized

ATK and Inspector
When you define data views and instance formats using Inspector, ObjectStore saves them in the metaknowledge. ATK uses the metaknowledge when accessing data views and instance formats. See Chapter 1, ATK and the Inspector.

ActiveX Server
ATK is an ActiveX server that provides access to any ObjectStore database. See Chapter 2, ATK ActiveX Server.

ATK OLE DB
ATK is also an OLE DB provider. OLE DB is a standard interface for accessing data, and ATK provides access to any ObjectStore database through OLE DB. See Chapter 3, Active Toolkit OLE DB Provider.

Configuration
The ATK installation program configures ATK to use the same metaknowledge as Inspector, and assigns several other default settings. If you reconfigure Inspector, you should update the corresponding ATK settings. You can also reconfigure ATK to meet the specific needs of an application. See Chapter 4, Configuring ATK.

ATK object model
The ATK object model consists of 17 COM classes. This chapter lists each class alphabetically by class name. Within the entry for each class, the class's properties and methods appear alphabetically. See Chapter 5, ATK Object Model.

Sample Data

This document refers to sample applications and demonstration databases. If you installed ATK using the installation program defaults, you can find them in these directories:
ComponentLocation
ATK

C:\odi\ATK6.0

Sample Applications

C:\odi\ATK6.0\Samples

Demonstration Databases

C:\odi\ATK6.0\DemoDBs

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 parameters.

{ 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.

...

An ellipsis indicates missing code that is not pertinent to the current example. In syntax lines, it indicates that the previous item can be repeated.

Internet Sources of More Information

Object Design
Object Design's site on the World Wide Web is the source for company news, white papers, and information about product offerings and services. Point your browser to http://www.objectdesign.com/ for more information.

Other ObjectStore products
In addition to ObjectStore, the industry's leading object database, Object Design offers a comprehensive set of rapid development and enterprise integration tools. For information about these and other Object Design products, point your browser to http://www.objectdesign.com.

Product support
Object Design's support organization provides a number of information resources and services. Their home page is at http://support.objectdesign.com. From the support home page, click Tech Support Information to learn about support policies, product discussion groups, and the different ways Object Design can keep you informed about the latest release information - including the web, ftp, and email services.

Training

If you are in North America, for information about Object Design's educational offerings, call 781.674.5320, Monday through Friday from 8:30 AM to 5:30 PM Eastern Time. Outside these hours, call 800.706.2507.

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 Active Toolkit Reference

ObjectStore ATK Release 6.0, May 1999

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.

ISG Navigator is a trademark of ISG International Software Group.

Seagate Crystal Reports is a trademark of Seagate Technology, Inc.

All other trademarks are the property of their respective owners.

Copyright © 1989 to 1999 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



[next]

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

Updated: 05/11/99 11:33:41