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

1.3 KiB

c SPDX-License-Identifier Title Section Source See-also
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)

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

PROTOCOLS

HTTP

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);
  }
}

AVAILABILITY

Added in 7.55.0

RETURN VALUE

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