curl_url_get(3)                 libcurl Manual                 curl_url_get(3)

NAME
       curl_url_get - extract a part from a URL

SYNOPSIS
       #include <curl/curl.h>

       CURLUcode curl_url_get(CURLU *url,
                              CURLUPart what,
                              char **part,
                              unsigned int flags)

DESCRIPTION
       Given the url handle of an already parsed URL, this function lets the
       user extract individual pieces from it.

       The what argument should be the particular part to extract (see list
       below) and part points to a 'char *' to get updated to point to a newly
       allocated string with the contents.

       The flags argument is a bitmask with individual features.

       The returned part pointer must be freed with _free&section=3">curl_free(3) after use.

FLAGS
       The flags argument is zero, one or more bits set in a bitmask.

       CURLU_DEFAULT_PORT
              If the handle has no port stored, this option will make
              _url_get&section=3">curl_url_get(3) return the default port for the used scheme.

       CURLU_DEFAULT_SCHEME
              If the handle has no scheme stored, this option will make
              _url_get&section=3">curl_url_get(3) return the default scheme instead of error.

       CURLU_NO_DEFAULT_PORT
              Instructs _url_get&section=3">curl_url_get(3) to not return a port number if it
              matches the default port for the scheme.

       CURLU_URLDECODE
              Asks _url_get&section=3">curl_url_get(3) to URL decode the contents before returning
              it. It will not attempt to decode the scheme, the port number or
              the full URL.

              The query component will also get plus-to-space conversion as a
              bonus when this bit is set.

              Note that this URL decoding is charset unaware and you will get
              a zero terminated string back with data that could be intended
              for a particular encoding.

              If there's any byte values lower than 32 in the decoded string,
              the get operation will return an error instead.

PARTS
       CURLUPART_URL
              When asked to return the full URL, _url_get&section=3">curl_url_get(3) will return a
              normalized and possibly cleaned up version of what was
              previously parsed.

       CURLUPART_SCHEME
              Scheme cannot be URL decoded on get.

       CURLUPART_USER

       CURLUPART_PASSWORD

       CURLUPART_OPTIONS

       CURLUPART_HOST
              The host name. If it is an IPv6 numeric address, the zoneid will
              not be part of it but is provided separately in
              CURLUPART_ZONEID. IPv6 numerical addresses are returned within
              brackets ([]).

       CURLUPART_ZONEID
              If the host name is a numeric IPv6 address, this field might
              also be set.

       CURLUPART_PORT
              Port cannot be URL decoded on get.

       CURLUPART_PATH

       CURLUPART_QUERY
              The query part will also get pluses converted to space when
              asked to URL decode on get with the CURLU_URLDECODE bit.

       CURLUPART_FRAGMENT

RETURN VALUE
       Returns a CURLUcode error value, which is CURLUE_OK (0) if everything
       went fine.

       If this function returns an error, no URL part is returned.

EXAMPLE
         CURLUcode rc;
         CURLU *url = curl_url();
         rc = curl_url_set(url, CURLUPART_URL, "https://example.com", 0);
         if(!rc) {
           char *scheme;
           rc = curl_url_get(url, CURLUPART_SCHEME, &scheme, 0);
           if(!rc) {
             printf("the scheme is %s\n", scheme);
             curl_free(scheme);
           }
           curl_url_cleanup(url);
         }

AVAILABILITY
       Added in curl 7.62.0. CURLUPART_ZONEID was added in 7.65.0.

SEE ALSO
       curl_url_cleanup(3), curl_url(3), curl_url_set(3),  curl_url_dup(3),
       CURLOPT_CURLU(3),

libcurl 7.77.0                  March 27, 2021                 curl_url_get(3)