# 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 2016-2020 Micro Focus or one of its affiliates | Send documentation feedback Close Send documentation feedback To open the configured email client on this computer, open an email window. Otherwise, copy the information below to a mail client, and then send this email to swpdl.idoldocsfeedback@microfocus.com. We appreciate your feedback! Product: Topic Title: Help Topic: Feedback:

_FT_HTML5_bannerTitle.htm