History

avformat/avformat.h: elaborate documentation for avformat_open_input() on error condition

Marth64 committed 2 years ago

Commit 910e5a21 parent 8ad2d191 file · +3 −2Browse files

Unified · Split

libavformat/avformat.h+3−2
@@ -2296,7 +2296,7 @@ int av_probe_input_buffer(AVIOContext *pb, const AVInputFormat **fmt, · 2295 unmodified lines
22962296 * which case an AVFormatContext is allocated by this
22972297 * function and written into ps.
22982298 * Note that a user-supplied AVFormatContext will be freed
2299− * on failure.
2299+ * on failure and its pointer set to NULL.
23002300 * @param url URL of the stream to open.
23012301 * @param fmt If non-NULL, this parameter forces a specific input format.
23022302 * Otherwise the format is autodetected.
@@ -2305,7 +2305,8 @@ int av_probe_input_buffer(AVIOContext *pb, const AVInputFormat **fmt, · 2 unmodified lines
23052305 * On return this parameter will be destroyed and replaced with
23062306 * a dict containing options that were not found. May be NULL.
23072307 *
2308− * @return 0 on success, a negative AVERROR on failure.
2308+ * @return 0 on success; on failure: frees ps, sets its pointer to NULL,
2309+ * and returns a negative AVERROR.
23092310 *
23102311 * @note If you want to use custom IO, preallocate the format context and set its pb field.
23112312 */

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t