Return to CURLOPT_HTTPGET.3 CVS log

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

Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_HTTPGET.3, revision 1.1

1.1     ! misho       1: .\" **************************************************************************
        !             2: .\" *                                  _   _ ____  _
        !             3: .\" *  Project                     ___| | | |  _ \| |
        !             4: .\" *                             / __| | | | |_) | |
        !             5: .\" *                            | (__| |_| |  _ <| |___
        !             6: .\" *                             \___|\___/|_| \_\_____|
        !             7: .\" *
        !             8: .\" * Copyright (C) 1998 - 2018, 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_HTTPGET 3 "May 21, 2018" "libcurl 7.70.0" "curl_easy_setopt options"
        !            24: 
        !            25: .SH NAME
        !            26: CURLOPT_HTTPGET \- ask for an HTTP GET request
        !            27: .SH SYNOPSIS
        !            28: #include <curl/curl.h>
        !            29: 
        !            30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HTTPGET, long useget);
        !            31: .SH DESCRIPTION
        !            32: Pass a long. If \fIuseget\fP is 1, this forces the HTTP request to get back to
        !            33: using GET. Usable if a POST, HEAD, PUT, etc has been used previously using the
        !            34: same curl \fIhandle\fP.
        !            35: 
        !            36: When setting \fICURLOPT_HTTPGET(3)\fP to 1, it will automatically set
        !            37: \fICURLOPT_NOBODY(3)\fP to 0 and \fICURLOPT_UPLOAD(3)\fP to 0.
        !            38: 
        !            39: Setting this option to zero has no effect. Applications need to explicitly
        !            40: select which HTTP request method to use, they cannot deselect a method. To
        !            41: reset a handle to default method, consider \fIcurl_easy_reset(3)\fP.
        !            42: .SH DEFAULT
        !            43: 0
        !            44: .SH PROTOCOLS
        !            45: HTTP(S)
        !            46: .SH EXAMPLE
        !            47: .nf
        !            48: curl = curl_easy_init();
        !            49: if(curl) {
        !            50:   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
        !            51: 
        !            52:   /* use a GET to fetch this */
        !            53:   curl_easy_setopt(curl, CURLOPT_HTTPGET, 1L);
        !            54: 
        !            55:   /* Perform the request */
        !            56:   curl_easy_perform(curl);
        !            57: }
        !            58: .fi
        !            59: .SH AVAILABILITY
        !            60: Along with HTTP
        !            61: .SH RETURN VALUE
        !            62: Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.
        !            63: .SH "SEE ALSO"
        !            64: .BR CURLOPT_NOBODY "(3), " CURLOPT_UPLOAD "(3), " CURLOPT_POST "(3), "
        !            65: .BR curl_easy_reset "(3) "