RepoMirrors
/
mpv
mirror of https://github.com/mpv-player/mpv
1
0
Fork 0
Code Issues Releases Wiki Activity

client API: add comment about character encoding issues 

Also mention that NULL isn't valid. Although I'm not sure whether the
implementation strictly follows this (it should, but there are some
wacky corner cases).
This commit is contained in:
wm4 2014-02-24 21:07:15 +01:00
parent f628d5e859
commit 38a36fd7ea
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
libmpv/client.h
View File

@ -364,6 +364,14 @@ typedef enum mpv_format {
* The basic type is char*. It returns the raw property string, like * The basic type is char*. It returns the raw property string, like
* using ${=property} in input.conf (see input.rst). * using ${=property} in input.conf (see input.rst).
* *
* NULL isn't an allowed value.
*
* Warning: although the encoding is usually UTF-8, this is not always the
* case. File tags often store strings in some legacy codepage,
* and even filenames don't necessarily have to be in UTF-8 (at
* least on Linux). If you pass the strings to code that requires
* valid UTF-8, you have to sanitize it in some way.
*
* Example for reading: * Example for reading:
* *
* char *result = NULL; * char *result = NULL;
@ -665,6 +673,8 @@ int mpv_get_property(mpv_handle *ctx, const char *name, mpv_format format,
* Return the value of the property with the given name as string. This is * Return the value of the property with the given name as string. This is
* equivalent to mpv_get_property() with MPV_FORMAT_STRING. * equivalent to mpv_get_property() with MPV_FORMAT_STRING.
* *
* See MPV_FORMAT_STRING for character encoding issues.
*
* On error, NULL is returned. Use mpv_get_property() if you want fine-grained * On error, NULL is returned. Use mpv_get_property() if you want fine-grained
* error reporting. * error reporting.
* *