Open topic with navigation

# parse_document_idx

The `parse_document_idx` function parses an IDX string or file, and returns a LuaDocument.

TIP:

You can use this function if the string or file contains a single document. If you have an IDX file that contains multiple documents you can use the function `parse_document_idx(filename, handler)` instead.

## Syntax

    parse_document_idx( input, file )

## Arguments

Argument | Description
--- | ---
`input` | (string) The string or path to the file that contains the document in IDX format.
`file` | (boolean, default `false`) Specifies whether the `input` argument is a path to a file.

## 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 2019 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 web mail client, and send this email to swpdl.idoldocsfeedback@microfocus.com. We appreciate your feedback! Product: Topic Title: Help Topic: Feedback:

_FT_HTML5_bannerTitle.htm