Imported Upstream version 7.44.0
[platform/upstream/curl.git] / docs / libcurl / opts / CURLMOPT_PUSHDATA.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al.
9 .\" *
10 .\" * This software is licensed as described in the file COPYING, which
11 .\" * you should have received as part of this distribution. The terms
12 .\" * are also available at http://curl.haxx.se/docs/copyright.html.
13 .\" *
14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15 .\" * copies of the Software, and permit persons to whom the Software is
16 .\" * furnished to do so, under the terms of the COPYING file.
17 .\" *
18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 .\" * KIND, either express or implied.
20 .\" *
21 .\" **************************************************************************
22 .\"
23 .TH CURLMOPT_PUSHDATA 3 "1 Jun 2015" "libcurl 7.44.0" "curl_multi_setopt options"
24 .SH NAME
25 CURLMOPT_PUSHDATA \- pointer to pass to push callback
26 .SH SYNOPSIS
27 .nf
28 #include <curl/curl.h>
29
30 CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_PUSHDATA, void *pointer);
31 .fi
32 .SH DESCRIPTION
33 Set \fIpointer\fP to pass as the last argument to the
34 \fICURLMOPT_PUSHFUNCTION(3)\fP callback. The pointer will not be touched or
35 used by libcurl itself, only passed on to the callback function.
36 .SH DEFAULT
37 NULL
38 .SH PROTOCOLS
39 HTTP(S)
40 .SH EXAMPLE
41 TODO
42 .SH AVAILABILITY
43 Added in 7.44.0
44 .SH RETURN VALUE
45 Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
46 .SH "SEE ALSO"
47 .BR CURLMOPT_PUSHFUNCTION "(3), " CURLMOPT_PIPELINING "(3), "
48 .BR CURLOPT_PIPEWAIT "(3), "
49 .BR RFC 7540