Contents

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Documents
• Conventions

Part I Getting Started with Search Export

1 Introduction

• 1.1 What's New in This Release
• 1.2 What Does This Technology Do?
  • 1.2.1 SearchML
  • 1.2.2 PageML
  • 1.2.3 SearchHTML
  • 1.2.4 SearchText
• 1.3 Architectural Overview
• 1.4 Definition of Terms
• 1.5 Directory Structure
  • 1.5.1 Installing Multiple SDKs
• 1.6 How to Use Search Export
• 1.7 Copyright Information
• 1.8 Oracle Outside In Search Export Licensing

2 Implementation Issues

• 2.1 Running in 24x7 Environments
• 2.2 Running in Multiple Threads or Processes

3 Sample Applications

• 3.1 Building the Samples on a Windows System
• 3.2 An Overview of the Sample Applications
  • 3.2.1 *sample
  • 3.2.2 batch_process_sx
  • 3.2.3 export (Windows Only)
    • 3.2.3.1 The Export Main Window
  • 3.2.4 exsimple
  • 3.2.5 extract_archive
  • 3.2.6 process_isolate
  • 3.2.7 xxredir (Search Export)
• 3.3 Accessing the SDK via a Java Wrapper
  • 3.3.1 The ExJava Wrapper API
  • 3.3.2 The C-Based Exporter Application
  • 3.3.3 Compiling the Executables
  • 3.3.4 The ExportTest Sample Application
  • 3.3.5 An Example Conversion Using the ExJava Wrapper

Part II Using the C/C++ API

4 Windows Implementation Details

• 4.1 Installation
  • 4.1.1 NSF Support
• 4.2 Libraries and Structure
  • 4.2.1 API DLLs
  • 4.2.2 Support DLLs
  • 4.2.3 Engine Libraries
  • 4.2.4 Filter and Export Filter Libraries
  • 4.2.5 Premier Graphics Filters
  • 4.2.6 Additional Files
• 4.3 The Basics
  • 4.3.1 What You Need in Your Source Code
  • 4.3.2 Options and Information Storage
  • 4.3.3 Structure Alignment
  • 4.3.4 Character Sets
  • 4.3.5 Runtime Considerations
• 4.4 Default Font Aliases
• 4.5 Changing Resources

5 UNIX Implementation Details

• 5.1 Installation
  • 5.1.1 NSF Support
• 5.2 Libraries and Structure
  • 5.2.1 API Libraries
  • 5.2.2 Support Libraries
  • 5.2.3 Engine Libraries
  • 5.2.4 Filter and Export Filter Libraries
  • 5.2.5 Premier Graphics Filters
  • 5.2.6 Additional Files
• 5.3 The Basics
  • 5.3.1 What You Need in Your Source Code
  • 5.3.2 Information Storage
• 5.4 Character Sets
• 5.5 Runtime Considerations
  • 5.5.1 X Server Requirement
  • 5.5.2 OLE2 Objects
  • 5.5.3 Signal Handling
  • 5.5.4 Runtime Search Path and $ORIGIN
• 5.6 Environment Variables
• 5.7 Changing Resources
• 5.8 HP-UX Compiling and Linking
  • 5.8.1 HP-UX on RISC
  • 5.8.2 HP-UX on RISC (64 bit)
  • 5.8.3 HP-UX on Itanium (64 bit)
• 5.9 IBM AIX Compiling and Linking
  • 5.9.1 IBM AIX (32-bit pSeries)
  • 5.9.2 IBM AIX PPC (64-bit)
• 5.10 Linux Compiling and Linking
  • 5.10.1 Library Compatibility
    • 5.10.1.1 Motif Libraries
    • 5.10.1.2 GLIBC and Compiler Versions
    • 5.10.1.3 Other Libraries
  • 5.10.2 Compiling and Linking
    • 5.10.2.1 Linux 32-bit, including Linux PPC
    • 5.10.2.2 Linux 64-bit
    • 5.10.2.3 Linux zSeries
• 5.11 Oracle Solaris Compiling and Linking
  • 5.11.1 Oracle Solaris SPARC
  • 5.11.2 Oracle Solaris (SPARC) 64
  • 5.11.3 Oracle Solaris x86
• 5.12 z/OS Compiling and Linking

6 Data Access Common Functions

• 6.1 Deprecated Functions
• 6.2 DAInitEx
• 6.3 DADeInit
• 6.4 DAOpenDocument
  • 6.4.1 IOSPECLINKEDOBJECT Structure
  • 6.4.2 IOSPECARCHIVEOBJECT Structure
  • 6.4.3 SCCDAOBJECT Structure
• 6.5 DACloseDocument
• 6.6 DARetrieveDocHandle
• 6.7 DASetOption
• 6.8 DAGetOption
• 6.9 DAGetFileId
• 6.10 DAGetFileIdEx
• 6.11 DAGetErrorString
• 6.12 DAGetObjectInfo
• 6.13 DAGetTreeCount
• 6.14 DAGetTreeRecord
  • 6.14.1 SCCDATREENODE Structure
• 6.15 DAOpenTreeRecord
• 6.16 DAOpenRandomTreeRecord
  • 6.16.1 DATREENODELOCATOR
  • 6.16.2 SCCCA_TREENODELOCATOR: Tree Node Locator
• 6.17 DASaveInputObject
• 6.18 DASaveTreeRecord
• 6.19 DASaveRandomTreeRecord
  • 6.19.1 DATREENODELOCATOR
  • 6.19.2 SCCCA_TREENODELOCATOR: Tree Node Locator
• 6.20 DACloseTreeRecord
• 6.21 DASetStatCallback
• 6.22 DASetFileAccessCallback

7 Export Functions

• 7.1 General Functions
  • 7.1.1 EXOpenExport
  • 7.1.2 EXCloseExport
  • 7.1.3 EXRunExport
  • 7.1.4 EXExportStatus

8 Redirected IO

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

9 Search Export C/C++ Options

• 9.1 Character Mapping
  • 9.1.1 SCCOPT_DEFAULTINPUTCHARSET
  • 9.1.2 SCCOPT_UNMAPPABLECHAR
• 9.2 Output
  • 9.2.1 SCCOPT_RENDERING_PREFER_OIT
• 9.3 Input Handling
  • 9.3.1 SCCOPT_EXTRACTXMPMETADATA
  • 9.3.2 SCCOPT_FALLBACKFORMAT
  • 9.3.3 SCCOPT_FIFLAGS
  • 9.3.4 SCCOPT_FORMATFLAGS
  • 9.3.5 SCCOPT_SYSTEMFLAGS
  • 9.3.6 SCCOPT_IGNORE_PASSWORD
  • 9.3.7 SCCOPT_LOTUSNOTESDIRECTORY
  • 9.3.8 SCCOPT_PARSEXMPMETADATA
  • 9.3.9 SCCOPT_PDF_FILTER_REORDER_BIDI
  • 9.3.10 SCCOPT_PROCESS_OLE_EMBEDDINGS
  • 9.3.11 SCCOPT_TIMEZONE
  • 9.3.12 SCCOPT_HTML_COND_COMMENT_MODE
  • 9.3.13 SCCOPT_PDF_FILTER_DROPHYPHENS
  • 9.3.14 SCCOPT_ARCFULLPATH
  • 9.3.15 SCCOPT_EX_PERFORMANCEMODE
  • 9.3.16 SCCOPT_GENERATEEXCELREVISIONS
• 9.4 Compression
  • 9.4.1 SCCOPT_FILTERLZW
• 9.5 XML
  • 9.5.1 SCCOPT_ENABLEALLSUBOBJECTS
  • 9.5.2 SCCOPT_XML_DEF_METHOD
  • 9.5.3 SCCOPT_XML_DEF_REFERENCE
  • 9.5.4 SCCOPT_XML_NULLREPLACECHAR
  • 9.5.5 SCCOPT_XML_PAGEML_FLAGS
  • 9.5.6 SCCOPT_XML_PAGEML_PRINTERNAME
  • 9.5.7 SCCOPT_XML_SEARCHML_CHAR_ATTRS
  • 9.5.8 SCCOPT_XML_SEARCHML_FLAGS
  • 9.5.9 SCCOPT_XML_SEARCHML_OFFSET
  • 9.5.10 SCCOPT_XML_SEARCHML_PARA_ATTRS
  • 9.5.11 SCCOPT_XML_SEARCHML_UNMAPPEDTEXT
• 9.6 File System
  • 9.6.1 SCCOPT_IO_BUFFERSIZE
    • 9.6.1.1 SCCBUFFEROPTIONS Structure
  • 9.6.2 SCCOPT_TEMPDIR
    • 9.6.2.1 SCCUTTEMPDIRSPEC Structure
  • 9.6.3 SCCOPT_DOCUMENTMEMORYMODE
  • 9.6.4 SCCOPT_REDIRECTTEMPFILE

Part III Using the Java API

10 Introduction to the Java API

• 10.1 Requirements
• 10.2 Getting Started
  • 10.2.1 Configure the Environment
  • 10.2.2 Generate Code
    • 10.2.2.1 Create an Exporter Object
    • 10.2.2.2 Configure the Output
    • 10.2.2.3 Set the Source and Primary Destination Files
    • 10.2.2.4 Set the Output Type
    • 10.2.2.5 Provide a Callback Handler
    • 10.2.2.6 Run the Export

11 Search Export Java Classes

• 11.1 ArchiveNode Class
• 11.2 Exporter Interface
  • 11.2.1 Document Interface
  • 11.2.2 SeekableByteChannel6 Interface
  • 11.2.3 OptionsCache Class
    • 11.2.3.1 DefaultInputCharacterSet
    • 11.2.3.2 DocumentMemoryMode
    • 11.2.3.3 DropPDFHyphens
    • 11.2.3.4 EnableAllSubObjects
    • 11.2.3.5 EnableAlphaBlending
    • 11.2.3.6 ExtractXMPMetadata
    • 11.2.3.7 FallbackFormat
    • 11.2.3.8 IECondCommentMode
    • 11.2.3.9 IgnorePassword
    • 11.2.3.10 IncludeCharacterAttributes
    • 11.2.3.11 IncludeSearchMLOffset
    • 11.2.3.12 InternalRendering
    • 11.2.3.13 ISODateTimes
    • 11.2.3.14 LotusNotesDirectory
    • 11.2.3.15 NullReplacementCharacter
    • 11.2.3.16 PageMLFlags
    • 11.2.3.17 ParseXMPMetadata
    • 11.2.3.18 PDFReorderBiDi
    • 11.2.3.19 PerformExtendedFI
    • 11.2.3.20 PrinterName
    • 11.2.3.21 ProcessOLEEmbeddingMode
    • 11.2.3.22 RenderEmbeddedFonts
    • 11.2.3.23 SearchMLFlags
    • 11.2.3.24 ShowArchiveFullPath
    • 11.2.3.25 StrictFile
    • 11.2.3.26 TimeZoneOffset
    • 11.2.3.27 UnmappableCharacter
    • 11.2.3.28 UnmappedText
    • 11.2.3.29 XMLDefinitionReference
• 11.3 ExportStatus Class
• 11.4 FileFormat Class
• 11.5 ObjectInfo Class
• 11.6 OutsideIn
• 11.7 OutsideInException Class
• 11.8 XMLReference Class

Part IV Using the .NET API

12 Introduction to the .NET API

• 12.1 Requirements
• 12.2 Getting Started
  • 12.2.1 Configuring your Environment
  • 12.2.2 Generate Code
    • 12.2.2.1 Create an Exporter Object
    • 12.2.2.2 Configure the Output
    • 12.2.2.3 Set the Source and Primary Destination Files
    • 12.2.2.4 Set the Output Type
    • 12.2.2.5 Provide a Callback Handler
    • 12.2.2.6 Run the Export
  • 12.2.3 Redirected I/O Support in .NET

13 Search Export .NET Classes

• 13.1 ArchiveNode Class
• 13.2 Exporter Interface
  • 13.2.1 Document Interface
  • 13.2.2 OptionsCache Class
    • 13.2.2.1 DefaultInputCharacterSet
    • 13.2.2.2 DocumentMemoryMode
    • 13.2.2.3 DropPDFHyphens
    • 13.2.2.4 EnableAllSubObjects
    • 13.2.2.5 ExtractXMPMetadata
    • 13.2.2.6 FallbackFormat
    • 13.2.2.7 IECondCommentMode
    • 13.2.2.8 IgnorePassword
    • 13.2.2.9 IncludeCharacterAttributes
    • 13.2.2.10 IncludeSearchMLOffset
    • 13.2.2.11 ISODateTimes
    • 13.2.2.12 LotusNotesDirectory
    • 13.2.2.13 NullReplacementCharacter
    • 13.2.2.14 PageMLFlags
    • 13.2.2.15 ParseXMPMetadata
    • 13.2.2.16 PDFReorderBiDi
    • 13.2.2.17 PerformExtendedFI
    • 13.2.2.18 PrinterName
    • 13.2.2.19 ProcessOLEEmbeddingMode
    • 13.2.2.20 RenderEmbeddedFonts
    • 13.2.2.21 SearchMLFlags
    • 13.2.2.22 ShowArchiveFullPath
    • 13.2.2.23 StrictFile
    • 13.2.2.24 TimeZoneOffset
    • 13.2.2.25 UnmappableCharacter
    • 13.2.2.26 UnmappedText
    • 13.2.2.27 XMLDefinitionReference
• 13.3 ExportStatus Class
• 13.4 FileFormat Class
• 13.5 ObjectInfo Class
• 13.6 OutsideIn Class
• 13.7 OutsideInException Class
• 13.8 XMLReference Class

Index