client API: explain when mpv_create() can return NULL

This commit is contained in:
wm4 2016-02-14 12:44:53 +01:00
parent fa821de8b2
commit e1e052a58e
1 changed files with 4 additions and 1 deletions

View File

@ -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);