docs: Small fix
git-svn-id: http://pugixml.googlecode.com/svn/trunk@886 99668b35-9821-0410-8761-19e4c4f06640
This commit is contained in:
parent
e6fcef1b3e
commit
4a5d55fc86
1 changed files with 1 additions and 1 deletions
|
@ -1260,7 +1260,7 @@ All of the above saving functions are implemented in terms of writer interface.
|
|||
|
||||
void xml_document::save(xml_writer& writer, const char_t* indent = "\t", unsigned int flags = format_default, xml_encoding encoding = encoding_auto) const;
|
||||
|
||||
In order to output the document via some custom transport, for example sockets, you should create an object which implements `xml_writer_file` interface and pass it to `save` function. `xml_writer_file::write` function is called with a buffer as an input, where `data` points to buffer start, and `size` is equal to the buffer size in bytes. `write` implementation must write the buffer to the transport; it can not save the passed buffer pointer, as the buffer contents will change after `write` returns. The buffer contains the chunk of document data in the desired encoding.
|
||||
In order to output the document via some custom transport, for example sockets, you should create an object which implements `xml_writer` interface and pass it to `save` function. `xml_writer::write` function is called with a buffer as an input, where `data` points to buffer start, and `size` is equal to the buffer size in bytes. `write` implementation must write the buffer to the transport; it can not save the passed buffer pointer, as the buffer contents will change after `write` returns. The buffer contains the chunk of document data in the desired encoding.
|
||||
|
||||
`write` function is called with relatively large blocks (size is usually several kilobytes, except for the first block with BOM, which is output only if [link format_write_bom] is set, and last block, which may be small), so there is often no need for additional buffering in the implementation.
|
||||
|
||||
|
|
Loading…
Add table
Reference in a new issue