document ff_get_line()

Originally committed as revision 24401 to svn://svn.ffmpeg.org/ffmpeg/trunk
This commit is contained in:
Aurelien Jacobs 2010-07-21 21:40:50 +00:00
parent a43416a540
commit b0335fd957

View File

@ -167,6 +167,17 @@ int ff_get_v_length(uint64_t val);
*/
void ff_put_v(ByteIOContext *bc, uint64_t val);
/**
* Read a whole line of text from ByteIOContext. Stop reading after reaching
* either a \n, a \0 or EOF. The returned string is always \0 terminated,
* and may be truncated if the buffer is too small.
*
* @param s the read-only ByteIOContext
* @param buf buffer to store the read line
* @param maxlen size of the buffer
* @return the length of the string written in the buffer, not including the
* final \0
*/
int ff_get_line(ByteIOContext *s, char *buf, int maxlen);
#define SPACE_CHARS " \t\r\n"