Contents

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Documents
• Conventions

1 Introduction

• 1.1 What's New in Release 8.4.1
• 1.2 What Does This Technology Do?
• 1.3 Architectural Overview
• 1.4 Definition of Terms
• 1.5 Directory Structure
• 1.6 How to Use Content Access
• 1.7 How to Use Text Access
• 1.8 Copyright Information

2 Windows Implementation Details

• 2.1 Installation
  • 2.1.1 NSF Support
• 2.2 Libraries and Structure
• 2.3 The Basics
  • 2.3.1 What You Need in Your Source Code
  • 2.3.2 Options and Information Storage
  • 2.3.3 Structure Alignment
• 2.4 Character Sets
  • 2.4.1 Default API Character Set
  • 2.4.2 Double-Byte Character Set Mapping
• 2.5 Runtime Considerations
• 2.6 Changing Resources

3 UNIX Implementation Details

• 3.1 Installation
  • 3.1.1 NSF Support
• 3.2 Libraries and Structure
• 3.3 The Basics
  • 3.3.1 What You Need in Your Source Code
  • 3.3.2 Options and Information Storage
• 3.4 Character Sets
  • 3.4.1 Default API Character Set
  • 3.4.2 Double-Byte Character Set Mapping
• 3.5 Runtime Considerations
  • 3.5.1 Signal Handling
  • 3.5.2 Runtime Search Path and $ORIGIN
• 3.6 Environment Variables
• 3.7 Changing Resources
• 3.8 HP-UX Compiling and Linking
• 3.9 IBM AIX Compiling and Linking
• 3.10 Linux Compiling and Linking
  • 3.10.1 Library Compatibility
    • 3.10.1.1 Motif Libraries
    • 3.10.1.2 GLIBC and Compiler Versions
    • 3.10.1.3 Other Libraries
  • 3.10.2 Compiling and Linking
• 3.11 Oracle Solaris Compiling and Linking
  • 3.11.1 Oracle Solaris SPARC
  • 3.11.2 Oracle Solaris x86
• 3.12 FreeBSD Compiling and Linking

4 Data Access Common Functions

• 4.1 Deprecated Functions
• 4.2 DAInitEx
• 4.3 DADeInit
• 4.4 DAOpenDocument
  • 4.4.1 IOSPECSUBOBJECT Structure
  • 4.4.2 IOSPECLINKEDOBJECT Structure
  • 4.4.3 IOSPECARCHIVEOBJECT Structure
  • 4.4.4 SCCDAOBJECT Structure
• 4.5 DACloseDocument
• 4.6 DARetrieveDocHandle
• 4.7 DASetOption
• 4.8 DAGetOption
• 4.9 DAGetFileId
• 4.10 DAGetFileIdEx
• 4.11 DAGetErrorString
• 4.12 DAGetObjectInfo
• 4.13 DAGetTreeCount
• 4.14 DAGetTreeRecord
  • 4.14.1 SCCDATREENODE Structure
• 4.15 DAOpenTreeRecord
• 4.16 DAOpenRandomTreeRecord
  • 4.16.1 DATREENODELOCATOR
  • 4.16.2 SCCCA_TREENODELOCATOR: Tree Node Locator
• 4.17 DASaveInputObject
• 4.18 DASaveTreeRecord
• 4.19 DASaveRandomTreeRecord
  • 4.19.1 DATREENODELOCATOR
  • 4.19.2 SCCCA_TREENODELOCATOR: Tree Node Locator
• 4.20 DACloseTreeRecord
• 4.21 DASetStatCallback
• 4.22 DASetFileAccessCallback

5 Text Access Functions

• 5.1 TAOpenText
• 5.2 TACloseText
• 5.3 TAReadFirst
• 5.4 TAReadNext

6 Content Access Functions

• 6.1 CAOpenContent
• 6.2 CACloseContent
• 6.3 CAReadFirst
• 6.4 CAReadNext
  • 6.4.1 SCCCAGETCONTENT Structure
• 6.5 CAContentStatus
  • 6.5.1 EXSUBDOCSTATUS Structure

7 Content Description

• 7.1 SCCCA_BEGINTAG/SCCCA_ENDTAG: Tagged Content
  • 7.1.1 SCCCA_BEGINTAG Content Description
  • 7.1.2 Tag Types
  • 7.1.3 Document Property IDs
  • 7.1.4 SCCCA_SUBDOCPROPERTY Document Properties
  • 7.1.5 Mail Field IDs
• 7.2 SCCCA_BREAK: Content Breaks
• 7.3 SCCCA_CELL: Cell Boundary
  • 7.3.1 SCCCA_CELL Content Description
• 7.4 SCCCA_COMMENTREFERENCE
• 7.5 SCCCA_FILEPROPERTY: File Property Content
  • 7.5.1 SCCCA_FILEPROPERTY Content Description
• 7.6 SCCCA_GENERATED: Generated Information
  • 7.6.1 SCCCA_GENERATED Content Description
• 7.7 SCCCA_OBJECT: SubObjects
  • 7.7.1 SCCCA_OBJECT Content Description
• 7.8 SCCCA_OBJECTALTSTRING: Alternate String
  • 7.8.1 SCCCA_OBJECTALTSTRING Content Description
• 7.9 SCCCA_OBJECTNAME: Object Name
  • 7.9.1 SCCCA_OBJECTNAME Content Description
• 7.10 SCCCA_RECORD: Archive Record
  • 7.10.1 SCCCA_RECORD Content Description
• 7.11 SCCCA_SHEET: Sheet Names
  • 7.11.1 SCCCA_SHEET Content Description
• 7.12 SCCCA_SLIDE: Presentation Slide
• 7.13 SCCCA_STYLECHANGE: Style Information
  • 7.13.1 SCCCA_STYLECHANGE Content Description
• 7.14 SCCCA_TEXT: Text Content
  • 7.14.1 SCCCA_TEXT Content Description
  • 7.14.2 Special Text Character Substitutions
• 7.15 SCCCA_TREENODELOCATOR: Tree Node Locator
  • 7.15.1 SCCCA_TREENODELOCATOR Content Description

8 Redirected IO

• 8.1 Using Redirected IO
• 8.2 IOClose
• 8.3 IORead
• 8.4 IOWrite
• 8.5 IOSeek
• 8.6 IOTell
• 8.7 IOGetInfo
  • 8.7.1 IOGENSECONDARY and IOGENSECONDARYW Structures
  • 8.7.2 File Types That Cause IOGETINFO_GENSECONDARY
• 8.8 IOSEEK64PROC / IOTELL64PROC
  • 8.8.1 IOSeek64
  • 8.8.2 IOTell64

9 Implementation Issues

• 9.1 Running in 24x7 Environments

10 Sample Applications

• 10.1 Building the Samples on a Windows System
• 10.2 Building the Samples on a UNIX System
• 10.3 An Overview of the Sample Applications
  • 10.3.1 batch_process_ca
  • 10.3.2 casample
  • 10.3.3 extract_archive
  • 10.3.4 extract_object
  • 10.3.5 memoryio
  • 10.3.6 parsepst
  • 10.3.7 tademo (Windows Only)
  • 10.3.8 taredir (UNIX Only)
  • 10.3.9 textdemo (UNIX Only)

A Copyrights and Licensing

• A.1 Outside In Content Access Licensing

B Content Access Options

• B.1 Character Mapping
  • B.1.1 SCCOPT_DEFAULTINPUTCHARSET
  • B.1.2 SCCOPT_OUTPUTCHARACTERSET
  • B.1.3 SCCOPT_UNMAPPABLECHAR
• B.2 Input Handling
  • B.2.1 SCCOPT_EXTRACTXMPMETADATA
  • B.2.2 SCCOPT_FALLBACKFORMAT
  • B.2.3 SCCOPT_FIFLAGS
  • B.2.4 SCCOPT_SYSTEMFLAGS
  • B.2.5 SCCOPT_IGNORE_PASSWORD
  • B.2.6 SCCOPT_LOTUSNOTESDIRECTORY
  • B.2.7 SCCOPT_PARSEXMPMETADATA
  • B.2.8 SCCOPT_PDF_FILTER_REORDER_BIDI
  • B.2.9 SCCOPT_PROCESS_OLE_EMBEDDINGS
  • B.2.10 SCCOPT_TIMEZONE
  • B.2.11 SCCOPT_HTML_COND_COMMENT_MODE
  • B.2.12 SCCOPT_PDF_FILTER_DROPHYPHENS
  • B.2.13 SCCOPT_ARCFULLPATH
• B.3 Compression
  • B.3.1 SCCOPT_FILTERJPG
  • B.3.2 SCCOPT_FILTERLZW
• B.4 Content Access Flags
  • B.4.1 SCCOPT_ENABLEALLSUBOBJECTS
  • B.4.2 SCCOPT_CA_FLAGS
  • B.4.3 SCCOPT_FORMATFLAGS
• B.5 File System
  • B.5.1 SCCOPT_IO_BUFFERSIZE
    • B.5.1.1 SCCBUFFEROPTIONS Structure
  • B.5.2 SCCOPT_TEMPDIR
    • B.5.2.1 SCCUTTEMPDIRSPEC Structure
  • B.5.3 SCCOPT_DOCUMENTMEMORYMODE
  • B.5.4 SCCOPT_REDIRECTTEMPFILE

Index