iw7-mod/deps/curl/docs/libcurl/opts/CURLOPT_PROXYPASSWORD.md
2024-08-13 05:15:34 -04:00

1.4 KiB

c SPDX-License-Identifier Title Section Source See-also
Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. curl CURLOPT_PROXYPASSWORD 3 libcurl
CURLOPT_HTTPAUTH (3)
CURLOPT_PASSWORD (3)
CURLOPT_PROXYAUTH (3)
CURLOPT_PROXYUSERNAME (3)

NAME

CURLOPT_PROXYPASSWORD - password to use with proxy authentication

SYNOPSIS

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYPASSWORD, char *pwd);

DESCRIPTION

Pass a char pointer as parameter, which should be pointing to the null-terminated password to use for authentication with the proxy.

The CURLOPT_PROXYPASSWORD(3) option should be used in conjunction with the CURLOPT_PROXYUSERNAME(3) option.

The application does not have to keep the string around after setting this option.

DEFAULT

blank

PROTOCOLS

Most

EXAMPLE

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode res;
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/foo.bin");
    curl_easy_setopt(curl, CURLOPT_PROXY, "http://localhost:8080");
    curl_easy_setopt(curl, CURLOPT_PROXYUSERNAME, "mrsmith");
    curl_easy_setopt(curl, CURLOPT_PROXYPASSWORD, "qwerty");
    res = curl_easy_perform(curl);
    curl_easy_cleanup(curl);
  }
}

AVAILABILITY

Added in 7.19.1

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.