mirror of
https://github.com/curl/curl.git
synced 2025-01-06 13:44:52 +08:00
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
64 lines
1.6 KiB
Markdown
64 lines
1.6 KiB
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: CURLOPT_WRITEDATA
|
|
Section: 3
|
|
Source: libcurl
|
|
See-also:
|
|
- CURLOPT_HEADERDATA (3)
|
|
- CURLOPT_READDATA (3)
|
|
- CURLOPT_WRITEFUNCTION (3)
|
|
---
|
|
|
|
# NAME
|
|
|
|
CURLOPT_WRITEDATA - pointer passed to the write callback
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_WRITEDATA, void *pointer);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
A data *pointer* to pass to the write callback. If you use the
|
|
CURLOPT_WRITEFUNCTION(3) option, this is the pointer you get in that
|
|
callback's fourth and last argument. If you do not use a write callback, you
|
|
must make *pointer* a 'FILE *' (cast to 'void *') as libcurl passes this
|
|
to *fwrite(3)* when writing data.
|
|
|
|
The internal CURLOPT_WRITEFUNCTION(3) writes the data to the FILE *
|
|
given with this option, or to stdout if this option has not been set.
|
|
|
|
If you are using libcurl as a Windows DLL, you **MUST** use a
|
|
CURLOPT_WRITEFUNCTION(3) if you set this option or you might experience
|
|
crashes.
|
|
|
|
# DEFAULT
|
|
|
|
By default, this is a FILE * to stdout.
|
|
|
|
# PROTOCOLS
|
|
|
|
Used for all protocols.
|
|
|
|
# EXAMPLE
|
|
|
|
A common technique is to use the write callback to store the incoming data
|
|
into a dynamically growing allocated buffer, and then this
|
|
CURLOPT_WRITEDATA(3) is used to point to a struct or the buffer to store
|
|
data in. Like in the getinmemory example:
|
|
https://curl.se/libcurl/c/getinmemory.html
|
|
|
|
# AVAILABILITY
|
|
|
|
Available in all libcurl versions. This option was formerly known as
|
|
CURLOPT_FILE, the name CURLOPT_WRITEDATA(3) was added in 7.9.7.
|
|
|
|
# RETURN VALUE
|
|
|
|
This returns CURLE_OK.
|