Mercurial > libavformat.hg
comparison avformat.h @ 5777:afceb57d364c libavformat
Add doxygen documentation for ff_url_split
author | mstorsjo |
---|---|
date | Mon, 08 Mar 2010 09:07:41 +0000 |
parents | d34f985d6e8f |
children | 3126d2588595 |
comparison
equal
deleted
inserted
replaced
5776:d34f985d6e8f | 5777:afceb57d364c |
---|---|
1341 | 1341 |
1342 struct in_addr; | 1342 struct in_addr; |
1343 /* Deprecated, use getaddrinfo instead. */ | 1343 /* Deprecated, use getaddrinfo instead. */ |
1344 attribute_deprecated int resolve_host(struct in_addr *sin_addr, const char *hostname); | 1344 attribute_deprecated int resolve_host(struct in_addr *sin_addr, const char *hostname); |
1345 | 1345 |
1346 /** | |
1347 * Splits a URL string into components. To reassemble components back into | |
1348 * a URL, use ff_url_join instead of using snprintf directly. | |
1349 * | |
1350 * The pointers to buffers for storing individual components may be null, | |
1351 * in order to ignore that component. Buffers for components not found are | |
1352 * set to empty strings. If the port isn't found, it is set to a negative | |
1353 * value. | |
1354 * | |
1355 * @see ff_url_join | |
1356 * | |
1357 * @param proto the buffer for the protocol | |
1358 * @param proto_size the size of the proto buffer | |
1359 * @param authorization the buffer for the authorization | |
1360 * @param authorization_size the size of the authorization buffer | |
1361 * @param hostname the buffer for the host name | |
1362 * @param hostname_size the size of the hostname buffer | |
1363 * @param port_ptr a pointer to store the port number in | |
1364 * @param path the buffer for the path | |
1365 * @param path_size the size of the path buffer | |
1366 * @param url the URL to split | |
1367 */ | |
1346 void ff_url_split(char *proto, int proto_size, | 1368 void ff_url_split(char *proto, int proto_size, |
1347 char *authorization, int authorization_size, | 1369 char *authorization, int authorization_size, |
1348 char *hostname, int hostname_size, | 1370 char *hostname, int hostname_size, |
1349 int *port_ptr, | 1371 int *port_ptr, |
1350 char *path, int path_size, | 1372 char *path, int path_size, |