roxml_file.h File Reference

File XML document backend. More...

Go to the source code of this file.

Functions
ROXML_INT int	roxml_read_file (int pos, int size, char *buffer, node_t *node)
	read xml doc function
ROXML_INT void	roxml_close_file (node_t *root)
	unload function
ROXML_INT int	roxml_parse_file (roxml_load_ctx_t *context, roxml_parser_item_t *parser, FILE *file)
	generic load function

Detailed Description

File XML document backend.

(C) Copyright 2014 Tristan Lelong trist.nosp@m.an.l.nosp@m.elong.nosp@m.@lib.nosp@m.roxml.nosp@m..net

SPDX-Licence-Identifier: LGPL-2.1+ The author added a static linking exception, see License.txt.

Definition in file roxml_file.h.

Function Documentation

roxml_close_file()

ROXML_INT void roxml_close_file

(

node_t *

root

)

unload function

This function clear a document that was opened as part of a file

Parameters

n	is any node of the tree to be cleaned

Returns

void

Definition at line 28 of file roxml_file.c.

roxml_parse_file()

ROXML_INT int roxml_parse_file	(	roxml_load_ctx_t *	context,
		roxml_parser_item_t *	parser,
		FILE *	file
	)

generic load function

This function parse a file document and all the corresponding nodes

Parameters

context	internal data used for parsing
parser	the parser object to run
file	file pointer to the document

Returns

an error code and filled context see roxml_close_buff

Definition at line 33 of file roxml_file.c.

roxml_read_file()

ROXML_INT int roxml_read_file	(	int	pos,
		int	size,
		char *	buffer,
		node_t *	node
	)

read xml doc function

this function read inside a xml file and fill the given buffer

Parameters

pos	the pos in the xml document
size	the size of the data to read
buffer	the destination buffer
node	the node that belong to the tree we want to read to

Returns

the number of bytes read

Definition at line 18 of file roxml_file.c.