Home

Getting Started

Utilities

Indexing

Omnidex

Development

Tutorials

Quick Links

 

OmniAccess API

Functions

Syntax

Options

Example

 

Exporting Data

EXPORT

 

OmniAccess API

Programming Basics

Managing Data

Functions

 

OAEXPORT

oaexport retrieves data from rows and writes them to a specified file (passed through filename). The rows and columns to be written to the file must be established by a preceding call to oaselect for that cursor.

oaexport can also transfer row identifiers (row IDs, unique key values, and so on) to a file. In this case, no preceding oaselect is required, only a preceding call to oaqualify.

 

Syntax

oaexport (cursor, options, status, node, filename)

cursor -- Is a 32-bit signed integer passed by value. This is the value returned by a successful call to oaopencursor.

options -- Is a character string, passed by reference, that indicates the action or actions for oaexport to take. Separate multiple options with commas, and terminate the option list with a semicolon or a null character.

status -- Returns information about the success or failure of the oaexport routine. A zero status.error means a successful call to oaexport. The status structure is passed by reference and contains fourteen 32-bit signed integers, followed by a 36-character buffer.

node -- Is reserved when oaexport is used in a server-based application and must contain only a semicolon or null terminator. However, when a client application calls oaexport, node must contain the server object name as declared in the Client Data Source file (terminated by a semicolon or null). In both cases, oaexport creates the file for transferred rows on the server.

filename -- Is a 255-byte character value, passed by reference, and terminated with a semicolon or null character. It specifies the name of the file to contain the transferred rows

 

 

Options

BUFFSIZE=n -- determines the size in bytes ( n) of the buffer that is used to transfer rows. The default size of n is 8192 bytes. The maximum size of n is 65536 bytes. The minimum size of n is the combined length of the columns in the preceding oaselect columns list.

CHAR=n -- converts binary data to character format during export, where n is the byte length of the exported number. The default is 32 bytes. Character data is left-justified and padded with trailing spaces.

DATA -- transfers the data in the most recently selected rows to the specified transfer file. This is the default behavior of oaexport if no option is specified.

DELETE -- deletes any existing file with the specified name (passed through filename) before creating a transfer file.

FILELIMIT=n -- determines the maximum number of rows ( n) that the specified transfer file can hold. The default size of n is 1000000. Note: The FILELIMIT option only affects files on the MPE/iX operating system.

ODXID -- transfers the internal identifiers of the most recently qualified subset to the specified transfer file. You can use these files in an oaqualify search, as described in “Using oaexport’s ID files (keyword-only searches)”.

ODXSI -- transfers the primary key values of the most recently qualified rows to the specified transfer file. You can use these files in an oaqualify search, as described in “Using oaexport’s ID files (keyword-only searches)”.

RECNO -- exports OMNIDEX row numbers.

ROWID -- transfers the native row identifiers of the most recently qualified rows to the specified transfer file.

TEMPFILE -- (MPE/iX and OpenVMS only) creates the specified transfer file as a temporary file that is removed when you log out.

 

 

Example

 

Top