eefcc1bda4
curldown is this new file format for libcurl man pages. It is markdown inspired with differences: - Each file has a set of leading headers with meta-data - Supports a small subset of markdown - Uses .md file extensions for editors/IDE/GitHub to treat them nicely - Generates man pages very similar to the previous ones - Generates man pages that still convert nicely to HTML on the website - Detects and highlights mentions of curl symbols automatically (when their man page section is specified) tools: - cd2nroff: converts from curldown to nroff man page - nroff2cd: convert an (old) nroff man page to curldown - cdall: convert many nroff pages to curldown versions - cd2cd: verifies and updates a curldown to latest curldown This setup generates .3 versions of all the curldown versions at build time. CI: Since the documentation is now technically markdown in the eyes of many things, the CI runs many more tests and checks on this documentation, including proselint, link checkers and tests that make sure we capitalize the first letter after a period... Closes #12730
57 lines
1.2 KiB
Markdown
57 lines
1.2 KiB
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: curl_share_init
|
|
Section: 3
|
|
Source: libcurl
|
|
See-also:
|
|
- curl_share_cleanup (3)
|
|
- curl_share_setopt (3)
|
|
---
|
|
|
|
# NAME
|
|
|
|
curl_share_init - Create a shared object
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <curl/curl.h>
|
|
|
|
CURLSH *curl_share_init();
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
This function returns a pointer to a *CURLSH* handle to be used as input
|
|
to all the other share-functions, sometimes referred to as a share handle in
|
|
some places in the documentation. This init call MUST have a corresponding
|
|
call to curl_share_cleanup(3) when all operations using the share are
|
|
complete.
|
|
|
|
This *share handle* is what you pass to curl using the
|
|
CURLOPT_SHARE(3) option with curl_easy_setopt(3), to make that
|
|
specific curl handle use the data in this share.
|
|
|
|
# EXAMPLE
|
|
|
|
~~~c
|
|
int main(void)
|
|
{
|
|
CURLSHcode sh;
|
|
CURLSH *share = curl_share_init();
|
|
sh = curl_share_setopt(share, CURLSHOPT_SHARE, CURL_LOCK_DATA_CONNECT);
|
|
if(sh)
|
|
printf("Error: %s\n", curl_share_strerror(sh));
|
|
}
|
|
~~~
|
|
|
|
# AVAILABILITY
|
|
|
|
Added in 7.10
|
|
|
|
# RETURN VALUE
|
|
|
|
If this function returns NULL, something went wrong (out of memory, etc.)
|
|
and therefore the share object was not created.
|