]> git.ipfire.org Git - thirdparty/curl.git/commitdiff
opts: document CURLE_OUT_OF_MEMORY as RETURN VALUE
authorDan Fandrich <dan@coneharvesters.com>
Wed, 18 Jun 2014 21:27:24 +0000 (23:27 +0200)
committerDan Fandrich <dan@coneharvesters.com>
Wed, 18 Jun 2014 21:28:13 +0000 (23:28 +0200)
24 files changed:
docs/libcurl/opts/CURLOPT_CAINFO.3
docs/libcurl/opts/CURLOPT_COOKIE.3
docs/libcurl/opts/CURLOPT_COOKIEJAR.3
docs/libcurl/opts/CURLOPT_CUSTOMREQUEST.3
docs/libcurl/opts/CURLOPT_EGDSOCKET.3
docs/libcurl/opts/CURLOPT_FTPPORT.3
docs/libcurl/opts/CURLOPT_INTERFACE.3
docs/libcurl/opts/CURLOPT_KEYPASSWD.3
docs/libcurl/opts/CURLOPT_KRBLEVEL.3
docs/libcurl/opts/CURLOPT_PROXY.3
docs/libcurl/opts/CURLOPT_PROXYUSERPWD.3
docs/libcurl/opts/CURLOPT_RANDOM_FILE.3
docs/libcurl/opts/CURLOPT_RANGE.3
docs/libcurl/opts/CURLOPT_REFERER.3
docs/libcurl/opts/CURLOPT_SSLCERT.3
docs/libcurl/opts/CURLOPT_SSLCERTTYPE.3
docs/libcurl/opts/CURLOPT_SSLENGINE.3
docs/libcurl/opts/CURLOPT_SSLENGINE_DEFAULT.3
docs/libcurl/opts/CURLOPT_SSLKEY.3
docs/libcurl/opts/CURLOPT_SSLKEYTYPE.3
docs/libcurl/opts/CURLOPT_SSL_CIPHER_LIST.3
docs/libcurl/opts/CURLOPT_URL.3
docs/libcurl/opts/CURLOPT_USERAGENT.3
docs/libcurl/opts/CURLOPT_USERPWD.3

index 82411e98d42a461a61f51ddbe45297d92d8b308e..1f2dfc42b7c76526c959edaacd0e786d5d6990d1 100644 (file)
@@ -49,6 +49,7 @@ TODO
 .SH AVAILABILITY
 If built TLS enabled
 .SH RETURN VALUE
-Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
+Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
+CURLE_OUT_OF_MEMORY if there was insufficient heap space.
 .SH "SEE ALSO"
 .BR CURLOPT_SSL_VERIFYPEER "(3), " CURLOPT_SSL_VERIFYHOST "(3), "
index 7a8ecc1bdc23457b1aa07fa2b67012b4dd4b58e0..824e9851709e7d5b2176fd36064ef482b6832792 100644 (file)
@@ -55,7 +55,8 @@ TODO
 .SH AVAILABILITY
 If HTTP is enabled
 .SH RETURN VALUE
-Returns CURLE_OK if HTTP is enabled, and CURLE_UNKNOWN_OPTION if not.
+Returns CURLE_OK if HTTP is enabled, CURLE_UNKNOWN_OPTION if not, or
+CURLE_OUT_OF_MEMORY if there was insufficient heap space.
 .SH "SEE ALSO"
 .BR CURLOPT_COOKIEFILE "(3), " CURLOPT_COOKIEJAR "(3), "
 .BR CURLOPT_HTTPHEADER "(3), "
index 4d458b0371b2ba495981d496475fa43ce3db0e69..fd8c0af2b215e962040fcd2fca6af9f8353f1924 100644 (file)
@@ -52,6 +52,7 @@ TODO
 .SH AVAILABILITY
 Along with HTTP
 .SH RETURN VALUE
-Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.
+Returns CURLE_OK if HTTP is supported, CURLE_UNKNOWN_OPTION if not, or
+CURLE_OUT_OF_MEMORY if there was insufficient heap space.
 .SH "SEE ALSO"
 .BR CURLOPT_COOKIEFILE "(3), " CURLOPT_COOKIE "(3), "
index aedf881dc711af7af4343f4aef7d83471bd90d62..2e6ec0ced86ed8fed012e15040714f47787471db 100644 (file)
@@ -89,6 +89,7 @@ TODO
 .SH AVAILABILITY
 IMAP is supported since 7.30.0, POP3 since 7.26.0 and SMTP since 7.34.0.
 .SH RETURN VALUE
-Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
+Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
+CURLE_OUT_OF_MEMORY if there was insufficient heap space.
 .SH "SEE ALSO"
 .BR CURLOPT_HTTPHEADER "(3), " CURLOPT_NOBODY "(3), "
index cc005d3674ada8ba2086984721823f52e840caf4..2e72ecc7d63e485434359b770582e479d8be9e98 100644 (file)
@@ -39,6 +39,7 @@ TODO
 .SH AVAILABILITY
 If built TLS enabled. Only the OpenSSL and GnuTLS backends will use this.
 .SH RETURN VALUE
-Returns CURLE_OK if TLS is supported, and CURLE_UNKNOWN_OPTION if not.
+Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
+CURLE_OUT_OF_MEMORY if there was insufficient heap space.
 .SH "SEE ALSO"
 .BR CURLOPT_RANDOM_FILE "(3), "
index bb1dcf6931e7b04af1a9f09b1711c58b38a1890c..fd87bb234b829e1465acac1a360db9f09a6a369b 100644 (file)
@@ -66,6 +66,7 @@ TODO
 .SH AVAILABILITY
 Port range support was added in 7.19.5
 .SH RETURN VALUE
-Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
+Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
+CURLE_OUT_OF_MEMORY if there was insufficient heap space.
 .SH "SEE ALSO"
 .BR CURLOPT_FTP_USE_EPRT "(3), " CURLOPT_FTP_USE_EPSV "(3), "
index 61c0aed7c240e0f337d42700b4fc01d6bd0edf43..0890eb6c4e9a9110439d1713d592fb5a98235e19 100644 (file)
@@ -49,6 +49,7 @@ TODO
 .SH AVAILABILITY
 The "if!" and "host!" syntax was added in 7.24.0.
 .SH RETURN VALUE
-Returns CURLE_OK
+Returns CURLE_OK on success or
+CURLE_OUT_OF_MEMORY if there was insufficient heap space.
 .SH "SEE ALSO"
 .BR CURLOPT_SOCKOPTFUNCTION "(3), " CURLOPT_TCP_NODELAY "(3), "
index f4fe2774a17cc32a4e6e21faf73157990e60bcd7..0ed0c87555059709dae9fb277c4a7ca6816e50f0 100644 (file)
@@ -42,6 +42,7 @@ TODO
 This option was known as CURLOPT_SSLKEYPASSWD up to 7.16.4 and
 CURLOPT_SSLCERTPASSWD up to 7.9.2.
 .SH RETURN VALUE
-Returns CURLE_OK if TLS enabled, and CURLE_UNKNOWN_OPTION if not.
+Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or
+CURLE_OUT_OF_MEMORY if there was insufficient heap space.
 .SH "SEE ALSO"
 .BR CURLOPT_SSLKEY "(3), " CURLOPT_SSH_PRIVATE_KEYFILE "(3), "
index 62ca08b106c4c58c975e1381bfaea1425eb76865..571eba3b5f923b65dd7cf2a26000696156e6202f 100644 (file)
@@ -42,6 +42,7 @@ TODO
 .SH AVAILABILITY
 This option was known as CURLOPT_KRB4LEVEL up to 7.16.3
 .SH RETURN VALUE
-Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
+Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
+CURLE_OUT_OF_MEMORY if there was insufficient heap space.
 .SH "SEE ALSO"
 .BR CURLOPT_KRBLEVEL "(3), " CURLOPT_FTP_SSL "(3), "
index 53cf2a99921ae6ee99c60e48e29e89895914675e..b419e51bcb3a7c018b4dc98aabf5891481e0ea4a 100644 (file)
@@ -78,7 +78,8 @@ scheme.
 
 Since 7.21.7 the proxy string supports the socks protocols as "schemes".
 .SH RETURN VALUE
-Returns CURLE_OK.
+Returns CURLE_OK if proxies are supported, CURLE_UNKNOWN_OPTION if not, or
+CURLE_OUT_OF_MEMORY if there was insufficient heap space.
 .SH "SEE ALSO"
 .BR CURLOPT_PROXYPORT "(3), " CURLOPT_HTTPPROXYTUNNEL "(3), "
 .BR CURLOPT_PROXYTYPE "(3)"
index 3f50dbdec7261cfc423e567664c5c4251b8c5bed..1632f0a9144f6473df245b97242a6fec0428938c 100644 (file)
@@ -44,6 +44,7 @@ TODO
 .SH AVAILABILITY
 Always
 .SH RETURN VALUE
-Returns CURLE_OK
+Returns CURLE_OK if proxies are supported, CURLE_UNKNOWN_OPTION if not, or
+CURLE_OUT_OF_MEMORY if there was insufficient heap space.
 .SH "SEE ALSO"
 .BR CURLOPT_PROXY "(3), " CURLOPT_PROXYTYPE "(3), "
index 33c2b31a0274fa68766e24cf518b65dfa38e84c3..0c2d68843e442a12d816dfb309124aa12c31f081 100644 (file)
@@ -39,6 +39,7 @@ TODO
 .SH AVAILABILITY
 Always
 .SH RETURN VALUE
-Returns CURLE_OK
+Returns CURLE_OK on success or
+CURLE_OUT_OF_MEMORY if there was insufficient heap space.
 .SH "SEE ALSO"
 .BR CURLOPT_EGDSOCKET "(3), "
index 88c02bd1fcba1096dd37460e6ae9b842310ba942..48c3ed9b8ce23000875ea589d76ca2701b051ff9 100644 (file)
@@ -49,6 +49,7 @@ TODO
 .SH AVAILABILITY
 FILE since 7.18.0, RTSP since 7.20.0
 .SH RETURN VALUE
-Returns CURLE_OK
+Returns CURLE_OK on success or
+CURLE_OUT_OF_MEMORY if there was insufficient heap space.
 .SH "SEE ALSO"
 .BR CURLOPT_RESUME_FROM "(3), " 
index 1461be3a5e70a9310f1c950575c43a797d31eddb..d00019b0169ad99b26476024ec08f4b2ef265865 100644 (file)
@@ -41,6 +41,7 @@ TODO
 .SH AVAILABILITY
 If built with HTTP support
 .SH RETURN VALUE
-Returns CURLE_OK if HTTP support is enabled, CURLE_UNKNOWN_OPTION if not.
+Returns CURLE_OK if HTTP support is enabled, CURLE_UNKNOWN_OPTION if not, or
+CURLE_OUT_OF_MEMORY if there was insufficient heap space.
 .SH "SEE ALSO"
 .BR CURLOPT_USERAGENT "(3), " CURLOPT_HTTPHEADER "(3), "
index aaf1874d4026c32d5df91164672d270f47c92303..7ae54f154d93d57620a9c187191a3767c11cde63 100644 (file)
@@ -49,6 +49,7 @@ TODO
 .SH AVAILABILITY
 If built TLS enabled.
 .SH RETURN VALUE
-Returns CURLE_OK if TLS enabled, and CURLE_UNKNOWN_OPTION if not.
+Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or
+CURLE_OUT_OF_MEMORY if there was insufficient heap space.
 .SH "SEE ALSO"
 .BR CURLOPT_SSLCERTTYPE "(3), " CURLOPT_SSLKEY "(3), "
index 71979861c063e6367254c4f5a289c2a47d6b9b7e..b19d5178455681593e9e0e149a5e5f82af7bea98 100644 (file)
@@ -42,6 +42,7 @@ TODO
 .SH AVAILABILITY
 If built TLS enabled. Added in 7.9.3
 .SH RETURN VALUE
-Returns CURLE_OK if TLS is supported, and CURLE_UNKNOWN_OPTION if not.
+Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
+CURLE_OUT_OF_MEMORY if there was insufficient heap space.
 .SH "SEE ALSO"
 .BR CURLOPT_SSLCERT "(3), " CURLOPT_SSLKEY "(3), "
index f2fffea181147e9a83783133e584ee88d7202d99..a88a5a72519c94e059360d1617ac0f7650561cd7 100644 (file)
@@ -42,6 +42,7 @@ TODO
 .SH AVAILABILITY
 If built TLS enabled.
 .SH RETURN VALUE
-Returns CURLE_OK if TLS is supported, and CURLE_UNKNOWN_OPTION if not.
+Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
+CURLE_OUT_OF_MEMORY if there was insufficient heap space.
 .SH "SEE ALSO"
 .BR CURLOPT_SSLENGINE_DEFAULT "(3), " CURLOPT_SSLKEY "(3), "
index 97f2cf320ba13766e077279fe8746c6e770b3a00..6570df1028b08688106f9b3cddab5ee932de35cb 100644 (file)
@@ -42,6 +42,7 @@ TODO
 .SH AVAILABILITY
 If built TLS enabled.
 .SH RETURN VALUE
-Returns CURLE_OK if TLS is supported, and CURLE_UNKNOWN_OPTION if not.
+Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
+CURLE_OUT_OF_MEMORY if there was insufficient heap space.
 .SH "SEE ALSO"
 .BR CURLOPT_SSLENGINE "(3), " CURLOPT_SSLCERT "(3), "
index b48119057d85f8443246e049339bce08e9f172a3..add69d8926e26db384d9a8aefd99f42c09959376 100644 (file)
@@ -44,6 +44,7 @@ TODO
 .SH AVAILABILITY
 If built TLS enabled.
 .SH RETURN VALUE
-Returns CURLE_OK if TLS is supported, and CURLE_UNKNOWN_OPTION if not.
+Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
+CURLE_OUT_OF_MEMORY if there was insufficient heap space.
 .SH "SEE ALSO"
 .BR CURLOPT_SSLKEYTYPE "(3), " CURLOPT_SSLCERT "(3), "
index 9ec09aa4329c26b796bc01da63b1f55c9a84047f..d4916349e55b0ebb87fe2e26d48b6bbbeeda2e74 100644 (file)
@@ -44,6 +44,7 @@ TODO
 .SH AVAILABILITY
 If built TLS enabled.
 .SH RETURN VALUE
-Returns CURLE_OK if TLS is supported, and CURLE_UNKNOWN_OPTION if not.
+Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
+CURLE_OUT_OF_MEMORY if there was insufficient heap space.
 .SH "SEE ALSO"
 .BR CURLOPT_SSLKEY "(3), " CURLOPT_SSLCERT "(3), "
index c9bb7e2c46dae2b490f3948b31918ba931949c13..7e05a5905777e99674a41b0c26eba13949133770 100644 (file)
@@ -59,6 +59,7 @@ TODO
 .SH AVAILABILITY
 If built TLS enabled.
 .SH RETURN VALUE
-Returns CURLE_OK if TLS is supported, and CURLE_UNKNOWN_OPTION if not.
+Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
+CURLE_OUT_OF_MEMORY if there was insufficient heap space.
 .SH "SEE ALSO"
 .BR CURLOPT_SSLVERSION "(3), " CURLOPT_USE_SSL "(3), "
index 7dee395ed55ef12f85b6debf335ee2c884a74e5a..b465e2ed4048b28d346cc6a2bc50f26a586ec14b 100644 (file)
@@ -277,7 +277,8 @@ All
 .SH AVAILABILITY
 POP3 and SMTP added in 7.31.0
 .SH RETURN VALUE
-Returns CURLE_OK
+Returns CURLE_OK on success or
+CURLE_OUT_OF_MEMORY if there was insufficient heap space.
 .SH "SEE ALSO"
 .BR CURLOPT_VERBOSE "(3), " CURLOPT_PROTOCOLS "(3), "
 .BR curl_easy_perform "(3)"
index ab7995f8ded497cf72b9174d6e4952a95d87b6d3..13ccbd48dbbe2601ac7023bcc520bad67dad47da 100644 (file)
@@ -41,6 +41,7 @@ TODO
 .SH AVAILABILITY
 As long as HTTP is supported
 .SH RETURN VALUE
-Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.
+Returns CURLE_OK if HTTP is supported, CURLE_UNKNOWN_OPTION if not, or
+CURLE_OUT_OF_MEMORY if there was insufficient heap space.
 .SH "SEE ALSO"
 .BR CURLOPT_REFERER "(3), " CURLOPT_HTTPHEADER "(3), "
index 274c0a07528bf5da3a0ac1e68b51a4faf2b39086..03d80760ed9505a5d490e57faa5e3abbea05b37a 100644 (file)
@@ -59,6 +59,7 @@ TODO
 .SH AVAILABILITY
 Always
 .SH RETURN VALUE
-Returns CURLE_OK
+Returns CURLE_OK on success or
+CURLE_OUT_OF_MEMORY if there was insufficient heap space.
 .SH "SEE ALSO"
 .BR CURLOPT_USERNAME "(3), " CURLOPT_PASSWORD "(3), "