mirror of
https://github.com/curl/curl.git
synced 2026-04-24 06:52:12 +03:00
e694c8284a
Expand a little. - mention the type name of the return code - avoid stating which exact return codes that might be returned, as that varies over time, builds and conditions - avoid stating some always return OK - refer to the manpage documenting all the return codes Closes #15900
75 lines
1.6 KiB
Markdown
75 lines
1.6 KiB
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: CURLOPT_REQUEST_TARGET
|
|
Section: 3
|
|
Source: libcurl
|
|
See-also:
|
|
- CURLOPT_CUSTOMREQUEST (3)
|
|
- CURLOPT_HTTPGET (3)
|
|
- CURLOPT_PATH_AS_IS (3)
|
|
- CURLOPT_URL (3)
|
|
Protocol:
|
|
- HTTP
|
|
Added-in: 7.55.0
|
|
---
|
|
|
|
# NAME
|
|
|
|
CURLOPT_REQUEST_TARGET - alternative target for this request
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#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.
|
|
|
|
Using this option multiple times makes the last set string override the
|
|
previous ones. Set it to NULL to disable its use again.
|
|
|
|
The application does not have to keep the string around after setting this
|
|
option.
|
|
|
|
# DEFAULT
|
|
|
|
NULL
|
|
|
|
# %PROTOCOLS%
|
|
|
|
# EXAMPLE
|
|
|
|
~~~c
|
|
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%
|
|
|
|
# RETURN VALUE
|
|
|
|
curl_easy_setopt(3) returns a CURLcode indicating success or error.
|
|
|
|
CURLE_OK (0) means everything was OK, non-zero means an error occurred, see
|
|
libcurl-errors(3).
|