epub_container_result_t Struct Reference

Out-parameter struct returned by priv_epub_xml_parse_container(). More...

#include <epub_xml_shim_internal.h>

Data Fields
char	opf_path [k_epub_max_path_len]
	Rootfile path, NUL-terminated.

Detailed Description

Out-parameter struct returned by priv_epub_xml_parse_container().

Carries the rootfile path lifted out of META-INF/container.xml. The OPF path is always non-empty on success; the caller feeds it to the second pass, priv_epub_xml_parse_opf().

Invariant

opf_path is NUL-terminated whenever the parse returned k_ra8_ok.

opf_path is never longer than k_epub_max_path_len - 1.

Example:

epub_container_result_t res = {};
if (priv_epub_xml_parse_container(buf, len, &res) == k_ra8_ok) {
  // res.opf_path names the OPF document inside the archive
}

See also

priv_epub_xml_parse_container()

Definition at line 60 of file epub_xml_shim_internal.h.

Field Documentation

opf_path

char epub_container_result_t::opf_path[k_epub_max_path_len]

Rootfile path, NUL-terminated.

Definition at line 61 of file epub_xml_shim_internal.h.

Referenced by internal_parse_archive(), and priv_epub_xml_parse_container().

---

The documentation for this struct was generated from the following file:

• apps/shared_libs/epub/src/epub_xml_shim_internal.h