diff options
Diffstat (limited to 'docs/libcurl/opts/GNURLOPT_PASSWORD.3')
| -rw-r--r-- | docs/libcurl/opts/GNURLOPT_PASSWORD.3 | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/docs/libcurl/opts/GNURLOPT_PASSWORD.3 b/docs/libcurl/opts/GNURLOPT_PASSWORD.3 new file mode 100644 index 000000000..397af1b2e --- /dev/null +++ b/docs/libcurl/opts/GNURLOPT_PASSWORD.3 @@ -0,0 +1,63 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * +.\" * This software is licensed as described in the file COPYING, which +.\" * you should have received as part of this distribution. The terms +.\" * are also available at https://curl.haxx.se/docs/copyright.html. +.\" * +.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell +.\" * copies of the Software, and permit persons to whom the Software is +.\" * furnished to do so, under the terms of the COPYING file. +.\" * +.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +.\" * KIND, either express or implied. +.\" * +.\" ************************************************************************** +.\" +.TH GNURLOPT_PASSWORD 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options" +.SH NAME +CURLOPT_PASSWORD \- password to use in authentication +.SH SYNOPSIS +#include <gnurl/curl.h> + +CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PASSWORD, char *pwd); +.SH DESCRIPTION +Pass a char * as parameter, which should be pointing to the zero terminated +password to use for the transfer. + +The \fICURLOPT_PASSWORD(3)\fP option should be used in conjunction with the +\fICURLOPT_USERNAME(3)\fP option. + +The application does not have to keep the string around after setting this +option. +.SH DEFAULT +blank +.SH PROTOCOLS +Most +.SH EXAMPLE +.nf +CURL *curl = curl_easy_init(); +if(curl) { + curl_easy_setopt(curl, CURLOPT_URL, "http://example.com/foo.bin"); + + curl_easy_setopt(curl, CURLOPT_PASSWORD, "qwerty"); + + ret = curl_easy_perform(curl); + + curl_easy_cleanup(curl); +} +.fi +.SH AVAILABILITY +Added in 7.19.1 +.SH RETURN VALUE +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_USERPWD "(3), " CURLOPT_USERNAME "(3), " +.BR CURLOPT_HTTPAUTH "(3), " CURLOPT_PROXYAUTH "(3)" |