luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-04-01 13:23:07 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: Clarify error values for empty files when loading

Browse Source 
Signed-off-by: Philip Withnall <withnall@endlessm.com>
This commit is contained in:
Philip Withnall 2018-08-13 14:27:46 +01:00
parent d2f0461ec0
commit 57962aac85
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
gvdb-reader.c
View File

@ -128,7 +128,8 @@ gvdb_table_setup_root (GvdbTable *file,
* *
* Creates a new #GvdbTable from the contents of @bytes. * Creates a new #GvdbTable from the contents of @bytes.
* *
* This call can fail if the header contained in @bytes is invalid. * This call can fail if the header contained in @bytes is invalid or if @bytes
* is empty; if so, %G_FILE_ERROR_INVAL will be returned.
* *
* You should call gvdb_table_free() on the return result when you no * You should call gvdb_table_free() on the return result when you no
* longer require it. * longer require it.
@ -189,6 +190,12 @@ invalid:
* Creates a new #GvdbTable using the #GMappedFile for @filename as the * Creates a new #GvdbTable using the #GMappedFile for @filename as the
* #GBytes. * #GBytes.
* *
* This function will fail if the file cannot be opened.
* In that case, the #GError that is returned will be an error from
* g_mapped_file_new().
*
* An empty or corrupt file will result in %G_FILE_ERROR_INVAL.
*
* Returns: a new #GvdbTable * Returns: a new #GvdbTable
**/ **/
GvdbTable * GvdbTable *