diff options
| author | Petri Lehtinen <petri@digip.org> | 2009-10-15 21:06:59 +0300 |
|---|---|---|
| committer | Petri Lehtinen <petri@digip.org> | 2009-10-15 21:06:59 +0300 |
| commit | b67e130fda46fb258ac9c974b73cd6f8c70665dc (patch) | |
| tree | 4f240f6ab96922c6dd902a152a3e1225c15e9ab3 | |
| parent | 4cd777712b1e4ec17dc9efcced80a90f83ec1915 (diff) | |
| download | jansson-b67e130fda46fb258ac9c974b73cd6f8c70665dc.zip jansson-b67e130fda46fb258ac9c974b73cd6f8c70665dc.tar.gz jansson-b67e130fda46fb258ac9c974b73cd6f8c70665dc.tar.bz2 | |
json_dumpf: Document the output shortage on error
| -rw-r--r-- | doc/apiref.rst | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/apiref.rst b/doc/apiref.rst index 818ec51..9c28fb8 100644 --- a/doc/apiref.rst +++ b/doc/apiref.rst @@ -514,6 +514,9 @@ is in UTF-8. Write the JSON representation of *root* to the stream *output*. *flags* is described above. Returns 0 on success and -1 on error. + If an error occurs, something may have already been written to + *output*. In this case, the output is undefined and most likely not + valid JSON. .. cfunction:: int json_dump_file(const json_t *json, const char *path, unsigned long flags) |