Contents

List of Tables

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Documents
• Conventions

1 Introduction

• Oracle DIVArchive C++ API Overview
• New and Enhanced Features and Functionality
• Compilers
  • Visual C++ Compiler on Windows
    • Supported Platforms
    • Supported Compilers
    • API Library Options
    • API Compilation
    • Initiator Sample Program API Usage
  • C++ Compiler on Linux
    • Supported Platforms
    • API Compilation
• Using the DIVArchive API in Multithreaded Applications
• Managing Connections
• Using Unicode Strings in the DIVArchive API
• DIVArchive Release Compatibility
• Alternate APIs

2 API Use and Operations

• Session Management Commands
  • DIVA_getApiVersion
    • Synopsis
  • DIVA_connect
    • Synopsis
    • Return Values
  • DIVA_disconnect
    • Synopsis
    • Multithreaded Applications
    • Return Values
• Requests and Commands
  • DIVA_addGroup
    • Synopsis
    • Return Values
  • DIVA_archiveObject
    • Synopsis
    • Return Values
  • DIVA_associativeCopy
    • Synopsis
    • Return Values
  • DIVA_cancelRequest
    • Synopsis
    • Return Values
  • DIVA_changeRequestPriority
    • Synopsis
    • Return Values
  • DIVA_copyToGroup and DIVA_copy
    • Synopsis
    • Return Values
  • DIVA_copyToNewObject
    • Synopsis
    • Return Values
  • DIVA_deleteGroup
    • Synopsis
    • Return Values
  • DIVA_deleteInstance
    • Synopsis
    • Return Values
  • DIVA_deleteObject
    • Synopsis
    • Return Values
  • DIVA_ejectTape
    • Synopsis
    • Return Values
  • DIVA_enable_Automatic_Repack
    • Synopsis
    • Return Values
  • DIVA_getArchiveSystemInfo
    • Synopsis
    • Return Values
  • DIVA_getArrayList
    • Synopsis
    • Return Values
  • DIVA_getFinishedRequestList
    • Synopsis
    • Return Values
  • DIVA_getFilesAndFolders
    • Synopsis
    • Return Values
  • DIVA_getGroupsList
    • Synopsis
    • Return Values
  • DIVA_getObjectDetailsList
    • Synopsis
    • Return Values
    • Use with the DIVAnet Access Gateway
    • Use and Recommended Practices
    • Recommended Practices for Continuous Updates Notification Design Pattern (No Media Filter)
  • DIVA_getObjectInfo
    • Synopsis
    • Return Values
  • DIVA_getPartialRestoreRequestInfo
    • Synopsis
    • Return Values
  • DIVA_getRequestInfo
    • Synopsis
    • Return Values
    • Additional_Info
  • DIVA_getSourceDestinationList
    • Synopsis
    • Return Values
  • DIVA_getStoragePlanList
    • Synopsis
    • Return Values
  • DIVA_getTapeInfo
    • Synopsis
    • Return Values
  • DIVA_insertTape
    • Synopsis
    • Return Values
  • DIVA_linkObjects
    • Synopsis
    • Return Values
  • DIVA_lockObject
    • Synopsis
    • Return Values
  • DIVA_multipleRestoreObject
    • Synopsis
    • Return Values
  • DIVA_partialRestoreObject
    • Synopsis
    • Return Values
  • DIVA_release
    • Synopsis
    • Return Values
  • DIVA_require
    • Synopsis
    • Return Values
  • DIVA_restoreInstance
    • Synopsis
    • Return Values
  • DIVA_restoreObject
    • Synopsis
    • Return Values
  • DIVA_transcodeArchive
    • Synopsis
    • Return Values
  • DIVA_transferFiles
    • Synopsis
    • Return Values
  • DIVA_unlockObject
    • Synopsis
    • Return Values

3 Using the DIVArchive API with Oracle DIVAnet

• What is DIVAnet?
• DIVArchive API SUpport
• Input Parameters
• Return Parameters
• Return Codes
• getObjectDetailsList Call

A Appendix

• List of Authorized Special Characters in DIVArchive
• Maximum Allowed Number of Characters
• API Static Constant Values

Glossary