Connector Framework Server 24.3

# parse_document_idx

Parses an IDX file, or a string of IDX data, and returns a LuaDocument.

TIP: You can use this function if the file or string contains a single document. If you have a file or string that contains multiple documents, use one of the following functions instead:

- `parse_document_idx(filename, handler)`
- `parse_document_idx(input, isFile, handler)`

## Syntax

    parse_document_idx( input [, file] )

## Arguments

Argument | Description
--- | ---
`input` | (string) The path to the IDX file, or a string of IDX data.
`file` | (boolean, default `false`) Specifies whether the `input` is a file path.

## Example

If you have a string named `myIdxString` that contains a document in IDX format, you can obtain a LuaDocument object as follows:

    local myDocument = parse_document_idx(myIdxString)

## Returns

(LuaDocument). A LuaDocument object that represents the document.

Copyright 2024 Open Text
Version 24.3 | Last updated June 2024

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL Connector Framework Server 24.3

Topic Title: parse_document_idx