summaryrefslogtreecommitdiffstats
path: root/libmpv
diff options
context:
space:
mode:
authorwm4 <wm4@nowhere>2016-02-14 12:44:53 +0100
committerwm4 <wm4@nowhere>2016-02-14 12:44:53 +0100
commite1e052a58eb3c3cb201e9d4ef24e7fe7bfd46687 (patch)
tree1a3a899a87b314037f416ea515210e7f7541f588 /libmpv
parentfa821de8b2b11c0c5e378342e0d56d16366cd96f (diff)
downloadmpv-e1e052a58eb3c3cb201e9d4ef24e7fe7bfd46687.tar.bz2
mpv-e1e052a58eb3c3cb201e9d4ef24e7fe7bfd46687.tar.xz
client API: explain when mpv_create() can return NULL
Diffstat (limited to 'libmpv')
-rw-r--r--libmpv/client.h5
1 files changed, 4 insertions, 1 deletions
diff --git a/libmpv/client.h b/libmpv/client.h
index 313b6dfd89..d5faf45ba7 100644
--- a/libmpv/client.h
+++ b/libmpv/client.h
@@ -403,7 +403,10 @@ const char *mpv_client_name(mpv_handle *ctx);
* client handle. (Whether concurrent access is definitely allowed or not has
* yet to be decided.)
*
- * @return a new mpv client API handle
+ * @return a new mpv client API handle. Returns NULL on error. Currently, this
+ * can happen in the following situations:
+ * - out of memory
+ * - LC_NUMERIC is not set to "C" (see general remarks)
*/
mpv_handle *mpv_create(void);