Daniel Stenberg b935fd4a07

docs: make each libcurl man specify protocol(s)

The mandatory header now has a mandatory list of protocols for which the
manpage is relevant.

Most man pages already has a "PROTOCOLS" section, but this introduces a
stricter way to specify the relevant protocols.

cd2nroff verifies that at least one protocol is mentioned (which can be
`*`).

This information is not used just yet, but A) the PROTOCOLS section can
now instead get generated and get a unified wording across all manpages
and B) this allows us to more reliably filter/search for protocol
specific manpages/options.

Closes #13166

2024-03-21 15:27:06 +01:00

1.0 KiB

Raw Blame History

c: Copyright (C) Daniel Stenberg, daniel@haxx.se, et al. SPDX-License-Identifier: curl Title: curl_easy_reset Section: 3 Source: libcurl See-also: - curl_easy_cleanup (3) - curl_easy_duphandle (3) - curl_easy_init (3) - curl_easy_setopt (3) Protocol: - *

NAME

curl_easy_reset - reset all options of a libcurl session handle

SYNOPSIS

#include <curl/curl.h>

void curl_easy_reset(CURL *handle);

DESCRIPTION

Re-initializes all options previously set on a specified CURL handle to the default values. This puts back the handle to the same state as it was in when it was just created with curl_easy_init(3).

It does not change the following information kept in the handle: live connections, the Session ID cache, the DNS cache, the cookies, the shares or the alt-svc cache.

EXAMPLE

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {

    /* ... the handle is used and options are set ... */
    curl_easy_reset(curl);
  }
}

AVAILABILITY

This function was added in libcurl 7.12.1

RETURN VALUE

Nothing

1.0 KiB Raw Blame History