parse_document_idx

The parse_document_idx function parses an IDX file into documents and calls a function on each document.

Syntax

parse_document_idx( filename, handler )

Arguments

Argument Description
filename (string) The path and file name of the IDX file to parse into documents.
handler (document_handler_function) The function to call on each document that is parsed from the IDX file. The function must accept a LuaDocument as the only argument.

Example

The following example uses the parse_document_idx function to parse an IDX file, and calls the function appendDocumentReference on each document.

local references = {}

function appendDocumentReference(document)
    table.insert(references, document:getReference())
end 

function read_idx_references(filename)
    parse_document_idx(filename, appendDocumentReference)
    return references
end

Returns

Nil.


_HP_HTML5_bannerTitle.htm