Imported Upstream version 7.59.0
[platform/upstream/curl.git] / docs / libcurl / opts / CURLINFO_CONTENT_TYPE.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2017, 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 CURLINFO_CONTENT_TYPE 3 "May 06, 2017" "libcurl 7.59.0" "curl_easy_getinfo options"
24
25 .SH NAME
26 CURLINFO_CONTENT_TYPE \- get Content-Type
27 .SH SYNOPSIS
28 #include <curl/curl.h>
29
30 CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_CONTENT_TYPE, char **ct);
31 .SH DESCRIPTION
32 Pass a pointer to a char pointer to receive the content-type of the downloaded
33 object. This is the value read from the Content-Type: field. If you get NULL,
34 it means that the server didn't send a valid Content-Type header or that the
35 protocol used doesn't support this.
36
37 The \fBct\fP pointer will be NULL or pointing to private memory you MUST NOT
38 free it - it gets freed when you call \fIcurl_easy_cleanup(3)\fP on the
39 corresponding CURL handle.
40 .SH PROTOCOLS
41 HTTP(S)
42 .SH EXAMPLE
43 .nf
44 CURL *curl = curl_easy_init();
45 if(curl) {
46   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
47
48   res = curl_easy_perform(curl);
49
50   if(!res) {
51     /* extract the content-type */
52     char *ct = NULL;
53     res = curl_easy_getinfo(curl, CURLINFO_CONTENT_TYPE, &ct);
54     if(!res && ct) {
55       printf("Content-Type: %s\\n", ct);
56     }
57   }
58   curl_easy_cleanup(curl);
59 }
60 .fi
61 .SH AVAILABILITY
62 Added in 7.9.4
63 .SH RETURN VALUE
64 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
65 .SH "SEE ALSO"
66 .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "