summaryrefslogtreecommitdiff
path: root/libgphoto2/gphoto2-filesys.c
diff options
context:
space:
mode:
authorHans Ulrich Niedermann <gp@n-dimensional.de>2007-09-03 18:19:09 +0000
committerHans Ulrich Niedermann <gp@n-dimensional.de>2007-09-03 18:19:09 +0000
commit5ca3eb20a29fca0762163ab0c97a65863ca0d8a5 (patch)
treeb7ce1e3e1f3036be9d6967d8243b25499f97b1a4 /libgphoto2/gphoto2-filesys.c
parent829f8e839e490c7133b125b6e5da56d4feefda78 (diff)
downloadlibgphoto2-5ca3eb20a29fca0762163ab0c97a65863ca0d8a5.tar.gz
More docs for gp_filesystem_get_storageinfo() WRT memory handling
git-svn-id: https://svn.code.sf.net/p/gphoto/code/trunk/libgphoto2@10632 67ed7778-7388-44ab-90cf-0a291f65f57c
Diffstat (limited to 'libgphoto2/gphoto2-filesys.c')
-rw-r--r--libgphoto2/gphoto2-filesys.c14
1 files changed, 10 insertions, 4 deletions
diff --git a/libgphoto2/gphoto2-filesys.c b/libgphoto2/gphoto2-filesys.c
index e26fcbbd7..6ea4865e8 100644
--- a/libgphoto2/gphoto2-filesys.c
+++ b/libgphoto2/gphoto2-filesys.c
@@ -2451,13 +2451,19 @@ gp_filesystem_set_info (CameraFilesystem *fs, const char *folder,
/**
* \brief Get the storage information about this filesystem
* \param fs the filesystem
- * \param storageinfo pointer to receive the array of informations
- * \param nrofstorageinfos pointer to receive number of array entries
+ * \param storageinfo Pointer to receive a pointer to/array of storage info items
+ * \param nrofstorageinfos Pointer to receive number of array entries
* \param context a #GPContext
*
* Retrieves the storage information, like maximum and free space, for
- * the specified filesystem, if supported by the device.
- *
+ * the specified filesystem, if supported by the device. The storage
+ * information is returned in an newly allocated array of
+ * #CameraStorageInformation objects. The variable pointed to by
+ * #nrofstorageinfos will be set to the number of elements in that
+ * array.
+ *
+ * It is the caller's responsibility to free the memory of the array.
+ *
* \return a gphoto error code
**/
int