curl/docs/libcurl/curl_url_cleanup.md
Viktor Szakats 3040971d12
GHA: silence proselint warnings and an error
Fix new issues found by `proselint`.

Also:
- silence this technical warning:
  ```
  :0: DeprecationWarning: /home/runner/.proselintrc was found instead of a JSON file. Rename to /home/runner/.proselintrc.json.
  ```
- fix an input filename.
  `proselints` fails now if an input file is missing.

Reported-by: Jay Satiro
Bug: https://github.com/curl/curl/pull/15291#issuecomment-2410505100
Closes #15293
2024-10-15 16:44:17 +02:00

58 lines
906 B
Markdown

---
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
Title: curl_url_cleanup
Section: 3
Source: libcurl
See-also:
- CURLOPT_CURLU (3)
- curl_url (3)
- curl_url_dup (3)
- curl_url_get (3)
- curl_url_set (3)
Protocol:
- All
Added-in: 7.62.0
---
# NAME
curl_url_cleanup - free the URL handle
# SYNOPSIS
~~~c
#include <curl/curl.h>
void curl_url_cleanup(CURLU *handle);
~~~
# DESCRIPTION
Frees all the resources associated with the given *CURLU* handle.
Passing in a NULL pointer in *handle* makes this function return
immediately with no action.
Any use of the **handle** after this function has been called and have
returned, is illegal.
# %PROTOCOLS%
# EXAMPLE
~~~c
int main(void)
{
CURLU *url = curl_url();
curl_url_set(url, CURLUPART_URL, "https://example.com", 0);
curl_url_cleanup(url);
}
~~~
# %AVAILABILITY%
# RETURN VALUE
none