curl/docs/libcurl/opts/CURLOPT_REQUEST_TARGET.md
Daniel Stenberg 8c1d9378ac
curldown: make 'added-in:' a mandatory header field
- generate AVAILABILITY manpage sections automatically - for consistent
  wording

- allows us to double-check against other documumentation (symbols-in-versions
  etc)

- enables proper automation/scripting based on this data

- lots of them were wrong or missing in the manpages

- several of them repeated (sometimes mismatching) backend support info

Add test 1488 to verify "added-in" version numbers against
symbols-in-versions.

Closes #14217
2024-07-18 18:04:09 +02:00

1.2 KiB

c SPDX-License-Identifier Title Section Source See-also Protocol Added-in
Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. curl CURLOPT_REQUEST_TARGET 3 libcurl
CURLOPT_CUSTOMREQUEST (3)
CURLOPT_HTTPGET (3)
CURLOPT_PATH_AS_IS (3)
CURLOPT_URL (3)
HTTP
7.55.0

NAME

CURLOPT_REQUEST_TARGET - alternative target for this request

SYNOPSIS

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_REQUEST_TARGET, string);

DESCRIPTION

Pass a char pointer to string which libcurl uses in the upcoming request instead of the path as extracted from the URL.

libcurl passes on the verbatim string in its request without any filter or other safe guards. That includes white space and control characters.

DEFAULT

NULL

EXAMPLE

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/*");
    curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "OPTIONS");

    /* issue an OPTIONS * request (no leading slash) */
    curl_easy_setopt(curl, CURLOPT_REQUEST_TARGET, "*");

    /* Perform the request */
    curl_easy_perform(curl);
  }
}

RETURN VALUE

Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.