Mercurial > libavformat.hg
changeset 6302:869753e625c4 libavformat
document ff_get_line()
| author | aurel |
|---|---|
| date | Wed, 21 Jul 2010 21:40:50 +0000 |
| parents | 1b2b5dbcf549 |
| children | af30d878f7d7 |
| files | internal.h |
| diffstat | 1 files changed, 11 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/internal.h Wed Jul 21 21:40:10 2010 +0000 +++ b/internal.h Wed Jul 21 21:40:50 2010 +0000 @@ -167,6 +167,17 @@ */ 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"