Return to CURLOPT_CURLU.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl / opts

Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_CURLU.3, revision 1.1.1.1

1.1       misho       1: .\" **************************************************************************
                      2: .\" *                                  _   _ ____  _
                      3: .\" *  Project                     ___| | | |  _ \| |
                      4: .\" *                             / __| | | | |_) | |
                      5: .\" *                            | (__| |_| |  _ <| |___
                      6: .\" *                             \___|\___/|_| \_\_____|
                      7: .\" *
                      8: .\" * Copyright (C) 1998 - 2019, Daniel Stenberg, <daniel@haxx.se>, et al.
                      9: .\" *
                     10: .\" * This software is licensed as described in the file COPYING, which
                     11: .\" * you should have received as part of this distribution. The terms
                     12: .\" * are also available at https://curl.haxx.se/docs/copyright.html.
                     13: .\" *
                     14: .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
                     15: .\" * copies of the Software, and permit persons to whom the Software is
                     16: .\" * furnished to do so, under the terms of the COPYING file.
                     17: .\" *
                     18: .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
                     19: .\" * KIND, either express or implied.
                     20: .\" *
                     21: .\" **************************************************************************
                     22: .\"
                     23: .TH CURLOPT_CURLU 3 "October 31, 2019" "libcurl 7.70.0" "curl_easy_setopt options"
                     24: 
                     25: .SH NAME
                     26: CURLOPT_CURLU \- set URL with CURLU *
                     27: .SH SYNOPSIS
                     28: #include <curl/curl.h>
                     29: 
                     30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CURLU, void *pointer);
                     31: .SH DESCRIPTION
                     32: Pass in a pointer to the \fIURL\fP to work with. The parameter should be a
                     33: CURLU *. Setting \fICURLOPT_CURLU(3)\fP will explicitly override
                     34: \fICURLOPT_URL(3)\fP.
                     35: 
                     36: \fICURLOPT_URL(3)\fP or \fICURLOPT_CURLU(3)\fP \fBmust\fP be set before a
                     37: transfer is started.
                     38: 
                     39: libcurl will use this handle and its contents read-only and will not change
                     40: its contents. An application can very well update the contents of the URL
                     41: handle after a transfer is done and if the same handle is then used in a
                     42: subsequent request the updated contents will then be used.
                     43: .SH DEFAULT
                     44: The default value of this parameter is NULL.
                     45: .SH PROTOCOLS
                     46: All
                     47: .SH EXAMPLE
                     48: .nf
                     49: CURL *handle = curl_easy_init();
                     50: CURLU *urlp = curl_url();
                     51: int res = 0;
                     52: if(curl) {
                     53: 
                     54:   res = curl_url_set(urlp, CURLUPART_URL, "http://example.com", 0);
                     55: 
                     56:   curl_easy_setopt(handle, CURLOPT_CURLU, urlp);
                     57: 
                     58:   ret = curl_easy_perform(handle);
                     59: 
                     60:   curl_url_cleanup(urlp);
                     61:   curl_easy_cleanup(handle);
                     62: }
                     63: .fi
                     64: .SH AVAILABILITY
                     65: Added in 7.63.0.
                     66: .SH RETURN VALUE
                     67: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
                     68: .SH "SEE ALSO"
                     69: .BR CURLOPT_URL "(3), "
                     70: .BR curl_url "(3), " curl_url_get "(3), " curl_url_set "(3), "