Mercurial > libavutil.hg
comparison error.h @ 962:399b530e8fb2 libavutil
Improve av_strerror() documentation
author | mru |
---|---|
date | Wed, 30 Jun 2010 20:09:52 +0000 |
parents | e34e8d654ded |
children |
comparison
equal
deleted
inserted
replaced
961:64a8e85b50be | 962:399b530e8fb2 |
---|---|
61 * Put a description of the AVERROR code errnum in errbuf. | 61 * Put a description of the AVERROR code errnum in errbuf. |
62 * In case of failure the global variable errno is set to indicate the | 62 * In case of failure the global variable errno is set to indicate the |
63 * error. Even in case of failure av_strerror() will print a generic | 63 * error. Even in case of failure av_strerror() will print a generic |
64 * error message indicating the errnum provided to errbuf. | 64 * error message indicating the errnum provided to errbuf. |
65 * | 65 * |
66 * @param errnum error code to describe | |
67 * @param errbuf buffer to which description is written | |
66 * @param errbuf_size the size in bytes of errbuf | 68 * @param errbuf_size the size in bytes of errbuf |
67 * @return 0 on success, a negative value if a description for errnum | 69 * @return 0 on success, a negative value if a description for errnum |
68 * cannot be found | 70 * cannot be found |
69 */ | 71 */ |
70 int av_strerror(int errnum, char *errbuf, size_t errbuf_size); | 72 int av_strerror(int errnum, char *errbuf, size_t errbuf_size); |