curl / libcurl / API / curl_url

curl_url - create a new CURLU handle

Name

curl_url - create a URL handle

Synopsis

#include <curl/curl.h>
 
CURLU *curl_url();

Description

This function allocates a URL object and returns a CURLU handle for it, to be used as input to all other URL API functions.

This is a handle to a URL object that holds or can hold URL components for a single URL. When the object is first created, there is of course no components stored. They are then set in the object with the curl_url_set function.

The object must be destroyed with a call to curl_url_cleanup when no longer needed.

Protocols

This functionality affects all supported protocols

Example

int main(void)
{
  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

Return value

Returns a CURLU * if successful, or NULL if out of memory.