Contents

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Documents
• Conventions

1 Introduction

• 1.1 What's New in Release 8.4.0
• 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

2 Windows Implementation Details

• 2.1 Installation
  • 2.1.1 NSF Support
• 2.2 Libraries and Structure
  • 2.2.1 API DLLs
  • 2.2.2 Support DLLs
  • 2.2.3 Engine Libraries
  • 2.2.4 Filter and Export Filter Libraries
  • 2.2.5 Premier Graphics Filters
  • 2.2.6 Additional Files
• 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.3.4 Character Sets
  • 2.3.5 Runtime Considerations
• 2.4 Default Font Aliases
• 2.5 Changing Resources

3 UNIX Implementation Details

• 3.1 Installation
  • 3.1.1 NSF Support
• 3.2 Libraries and Structure
  • 3.2.1 API Libraries
  • 3.2.2 Support Libraries
  • 3.2.3 Engine Libraries
  • 3.2.4 Filter and Export Filter Libraries
  • 3.2.5 Premier Graphics Filters
  • 3.2.6 Additional Files
• 3.3 The Basics
  • 3.3.1 What You Need in Your Source Code
  • 3.3.2 Information Storage
• 3.4 Character Sets
• 3.5 Runtime Considerations
  • 3.5.1 X Server Requirement
  • 3.5.2 OLE2 Objects
  • 3.5.3 Signal Handling
  • 3.5.4 Runtime Search Path and $ORIGIN
• 3.6 Environment Variables
• 3.7 Changing Resources
• 3.8 HP-UX Compiling and Linking
  • 3.8.1 HP-UX on RISC
  • 3.8.2 HP-UX on RISC (64 bit)
  • 3.8.3 HP-UX on Itanium (64 bit)
• 3.9 IBM AIX Compiling and Linking
  • 3.9.1 IBM AIX (32-bit pSeries)
  • 3.9.2 IBM AIX PPC (64-bit)
• 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.10.2.1 Linux 32-bit, including Linux PPC
    • 3.10.2.2 Linux 64-bit
    • 3.10.2.3 Linux zSeries
• 3.11 Oracle Solaris Compiling and Linking
  • 3.11.1 Oracle Solaris SPARC
  • 3.11.2 Oracle Solaris (SPARC) 64
  • 3.11.3 Oracle Solaris x86
• 3.12 z/OS Compiling and Linking

4 Data Access Common Functions

• 4.1 Deprecated Functions
• 4.2 DAInitEx
• 4.3 DADeInit
• 4.4 DAOpenDocument
  • 4.4.1 IOSPECLINKEDOBJECT Structure
  • 4.4.2 IOSPECARCHIVEOBJECT Structure
  • 4.4.3 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 Export Functions

• 5.1 General Functions
  • 5.1.1 EXOpenExport
  • 5.1.2 EXCloseExport
  • 5.1.3 EXRunExport
  • 5.1.4 EXExportStatus

6 Redirected IO

• 6.1 Using Redirected IO
• 6.2 Opening Files
• 6.3 IOClose
• 6.4 IORead
• 6.5 IOWrite
• 6.6 IOSeek
• 6.7 IOTell
• 6.8 IOGetInfo
  • 6.8.1 IOGENSECONDARY and IOGENSECONDARYW Structures
  • 6.8.2 File Types That Cause IOGETINFO_GENSECONDARY
• 6.9 IOSEEK64PROC / IOTELL64PROC
  • 6.9.1 IOSeek64
  • 6.9.2 IOTell64

7 Implementation Issues

• 7.1 Running in 24x7 Environments
• 7.2 Running in Multiple Threads or Processes

8 Sample Applications

• 8.1 Building the Samples on a Windows System
• 8.2 An Overview of the Sample Applications
  • 8.2.1 *sample
  • 8.2.2 batch_process_sx
  • 8.2.3 export (Windows Only)
    • 8.2.3.1 The Export Main Window
  • 8.2.4 exsimple
  • 8.2.5 extract_archive
  • 8.2.6 process_isolate
  • 8.2.7 xxredir (Search Export)
• 8.3 Accessing the SDK via a Java Wrapper
  • 8.3.1 The ExJava Wrapper API
  • 8.3.2 The C-Based Exporter Application
  • 8.3.3 Compiling the Executables
  • 8.3.4 The ExportTest Sample Application
  • 8.3.5 An Example Conversion Using the ExJava Wrapper

A Copyrights and Licensing

• A.1 Oracle Outside In Search Export Licensing

B Search Export Options

• B.1 Search Export C/C++ Options
  • B.1.1 Character Mapping
    • B.1.1.1 SCCOPT_DEFAULTINPUTCHARSET
    • B.1.1.2 SCCOPT_UNMAPPABLECHAR
  • B.1.2 Output
    • B.1.2.1 SCCOPT_RENDERING_PREFER_OIT
  • B.1.3 Input Handling
    • B.1.3.1 SCCOPT_EXTRACTXMPMETADATA
    • B.1.3.2 SCCOPT_FALLBACKFORMAT
    • B.1.3.3 SCCOPT_FIFLAGS
    • B.1.3.4 SCCOPT_FORMATFLAGS
    • B.1.3.5 SCCOPT_SYSTEMFLAGS
    • B.1.3.6 SCCOPT_IGNORE_PASSWORD
    • B.1.3.7 SCCOPT_LOTUSNOTESDIRECTORY
    • B.1.3.8 SCCOPT_PARSEXMPMETADATA
    • B.1.3.9 SCCOPT_PDF_FILTER_REORDER_BIDI
    • B.1.3.10 SCCOPT_PROCESS_OLE_EMBEDDINGS
    • B.1.3.11 SCCOPT_TIMEZONE
    • B.1.3.12 SCCOPT_HTML_COND_COMMENT_MODE
  • B.1.4 Compression
    • B.1.4.1 SCCOPT_FILTERLZW
  • B.1.5 XML
    • B.1.5.1 SCCOPT_ENABLEALLSUBOBJECTS
    • B.1.5.2 SCCOPT_XML_DEF_METHOD
    • B.1.5.3 SCCOPT_XML_DEF_REFERENCE
    • B.1.5.4 SCCOPT_XML_NULLREPLACECHAR
    • B.1.5.5 SCCOPT_XML_PAGEML_FLAGS
    • B.1.5.6 SCCOPT_XML_PAGEML_PRINTERNAME
    • B.1.5.7 SCCOPT_XML_SEARCHML_CHAR_ATTRS
    • B.1.5.8 SCCOPT_XML_SEARCHML_FLAGS
    • B.1.5.9 SCCOPT_XML_SEARCHML_OFFSET
    • B.1.5.10 SCCOPT_XML_SEARCHML_PARA_ATTRS
    • B.1.5.11 SCCOPT_XML_SEARCHML_UNMAPPEDTEXT
  • B.1.6 File System
    • B.1.6.1 SCCOPT_IO_BUFFERSIZE
    • B.1.6.2 SCCOPT_TEMPDIR
    • B.1.6.3 SCCOPT_DOCUMENTMEMORYMODE
    • B.1.6.4 SCCOPT_REDIRECTTEMPFILE
• B.2 Search Export SOAP Options
  • B.2.1 How Options Work
  • B.2.2 Character Mapping
    • B.2.2.1 defaultInputCharset
    • B.2.2.2 unmappableCharacter
  • B.2.3 Output
    • B.2.3.1 preferOITRendering
  • B.2.4 Input Handling
    • B.2.4.1 fallbackFormat
    • B.2.4.2 extendedTestForText
    • B.2.4.3 ignorePassword
    • B.2.4.4 oleEmbeddings
    • B.2.4.5 parseXMPMetaData
    • B.2.4.6 reorderBIDI
    • B.2.4.7 timezone
    • B.2.4.8 extractXMPMetaData
    • B.2.4.9 htmlCondCommentIE5On
    • B.2.4.10 htmlCondCommentIE6On
    • B.2.4.11 htmlCondCommentIE7On
    • B.2.4.12 htmlCondCommentIE8On
    • B.2.4.13 htmlCondCommentIE9On
    • B.2.4.14 htmlCondCommentAllOn
  • B.2.5 Compression
    • B.2.5.1 allowLZW
  • B.2.6 XML
    • B.2.6.1 allCapsOn
    • B.2.6.2 boldOn
    • B.2.6.3 cellInfoOn
    • B.2.6.4 changeNumbertoTextOn
    • B.2.6.5 documentPropertiesOn
    • B.2.6.6 doubleUnderlineOn
    • B.2.6.7 embeddingsOn
    • B.2.6.8 errorInfoOn
    • B.2.6.9 generateSystemMetaDataOn
    • B.2.6.10 hiddenOn
    • B.2.6.11 italicOn
    • B.2.6.12 metadataOnlyOn
    • B.2.6.13 originalCharsetOn
    • B.2.6.14 outlineOn
    • B.2.6.15 produceURLsOn
    • B.2.6.16 revisionAddOn
    • B.2.6.17 revisionDeleteOn
    • B.2.6.18 revisionsOn
    • B.2.6.19 smallCapsOn
    • B.2.6.20 strikeoutOn
    • B.2.6.21 underlineOn
    • B.2.6.22 xmlDefinitionMethod
    • B.2.6.23 xmlDefinitionLocation
    • B.2.6.24 nullReplacementCharacter
    • B.2.6.25 printerName
    • B.2.6.26 paragraphStyleNamesOn
    • B.2.6.27 includeTextOffsets
    • B.2.6.28 paragraphAttributes
    • B.2.6.29 unmappedText
    • B.2.6.30 suppressArchiveSubDocsOn
    • B.2.6.31 suppressAttachmentsOn
    • B.2.6.32 textOutOn
    • B.2.6.33 xmlDeclarationOff
  • B.2.7 File System
    • B.2.7.1 fileAccess
    • B.2.7.2 readBufferSize
    • B.2.7.3 memoryMappedInputSize
    • B.2.7.4 tempBufferSize

Index