]> granicus.if.org Git - curl/commitdiff
CURLINFO_SCHEME.3: fix variable type
authorJay Satiro <raysatiro@yahoo.com>
Sat, 8 Apr 2017 19:44:39 +0000 (15:44 -0400)
committerJay Satiro <raysatiro@yahoo.com>
Sat, 8 Apr 2017 19:44:39 +0000 (15:44 -0400)
- Change documented param type to char ** from incorrect long *.

docs/libcurl/opts/CURLINFO_SCHEME.3

index 78c3d68868654eca24c86bf83c9a53b1de6f0a26..38a3d15ba0dd020622199df42eea18f2461ef795 100644 (file)
@@ -26,14 +26,15 @@ CURLINFO_SCHEME \- get the URL scheme (sometimes called protocol) used in the co
 .SH SYNOPSIS
 #include <curl/curl.h>
 
-CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SCHEME, long *p);
+CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SCHEME, char **scheme);
 .SH DESCRIPTION
 Pass a pointer to a char pointer to receive the pointer to a zero-terminated
-string holding the URL scheme used for the most recent connection done with this
-\fBcurl\fP handle.
+string holding the URL scheme used for the most recent connection done with
+this CURL \fBhandle\fP.
 
-The \fBid\fP pointer will be NULL or pointing to private read-only memory you
-MUST NOT free or modify.
+The \fBscheme\fP pointer will be NULL or pointing to private memory you MUST
+NOT free - it gets freed when you call \fIcurl_easy_cleanup(3)\fP on the
+corresponding CURL handle.
 .SH PROTOCOLS
 All
 .SH EXAMPLE
@@ -44,8 +45,10 @@ if(curl) {
   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
   res = curl_easy_perform(curl);
   if(res == CURLE_OK) {
-    char * scheme;
+    char *scheme = NULL;
     curl_easy_getinfo(curl, CURLINFO_SCHEME, &scheme);
+    if(scheme)
+      printf("scheme: %s\\n", scheme); /* scheme: HTTP */
   }
   curl_easy_cleanup(curl);
 }