xref: /aosp_15_r20/external/curl/docs/libcurl/opts/CURLOPT_DEBUGDATA.md (revision 6236dae45794135f37c4eb022389c904c8b0090d)
1*6236dae4SAndroid Build Coastguard Worker---
2*6236dae4SAndroid Build Coastguard Workerc: Copyright (C) Daniel Stenberg, <[email protected]>, et al.
3*6236dae4SAndroid Build Coastguard WorkerSPDX-License-Identifier: curl
4*6236dae4SAndroid Build Coastguard WorkerTitle: CURLOPT_DEBUGDATA
5*6236dae4SAndroid Build Coastguard WorkerSection: 3
6*6236dae4SAndroid Build Coastguard WorkerSource: libcurl
7*6236dae4SAndroid Build Coastguard WorkerSee-also:
8*6236dae4SAndroid Build Coastguard Worker  - CURLOPT_DEBUGFUNCTION (3)
9*6236dae4SAndroid Build Coastguard Worker  - CURLOPT_STDERR (3)
10*6236dae4SAndroid Build Coastguard WorkerProtocol:
11*6236dae4SAndroid Build Coastguard Worker  - All
12*6236dae4SAndroid Build Coastguard WorkerAdded-in: 7.9.6
13*6236dae4SAndroid Build Coastguard Worker---
14*6236dae4SAndroid Build Coastguard Worker
15*6236dae4SAndroid Build Coastguard Worker# NAME
16*6236dae4SAndroid Build Coastguard Worker
17*6236dae4SAndroid Build Coastguard WorkerCURLOPT_DEBUGDATA - pointer passed to the debug callback
18*6236dae4SAndroid Build Coastguard Worker
19*6236dae4SAndroid Build Coastguard Worker# SYNOPSIS
20*6236dae4SAndroid Build Coastguard Worker
21*6236dae4SAndroid Build Coastguard Worker~~~c
22*6236dae4SAndroid Build Coastguard Worker#include <curl/curl.h>
23*6236dae4SAndroid Build Coastguard Worker
24*6236dae4SAndroid Build Coastguard WorkerCURLcode curl_easy_setopt(CURL *handle, CURLOPT_DEBUGDATA, void *pointer);
25*6236dae4SAndroid Build Coastguard Worker~~~
26*6236dae4SAndroid Build Coastguard Worker
27*6236dae4SAndroid Build Coastguard Worker# DESCRIPTION
28*6236dae4SAndroid Build Coastguard Worker
29*6236dae4SAndroid Build Coastguard WorkerPass a *pointer* to whatever you want passed in to your
30*6236dae4SAndroid Build Coastguard WorkerCURLOPT_DEBUGFUNCTION(3) in the last void * argument. This pointer is
31*6236dae4SAndroid Build Coastguard Workernot used by libcurl, it is only passed to the callback.
32*6236dae4SAndroid Build Coastguard Worker
33*6236dae4SAndroid Build Coastguard Worker# DEFAULT
34*6236dae4SAndroid Build Coastguard Worker
35*6236dae4SAndroid Build Coastguard WorkerNULL
36*6236dae4SAndroid Build Coastguard Worker
37*6236dae4SAndroid Build Coastguard Worker# %PROTOCOLS%
38*6236dae4SAndroid Build Coastguard Worker
39*6236dae4SAndroid Build Coastguard Worker# EXAMPLE
40*6236dae4SAndroid Build Coastguard Worker
41*6236dae4SAndroid Build Coastguard Worker~~~c
42*6236dae4SAndroid Build Coastguard Workerstruct data {
43*6236dae4SAndroid Build Coastguard Worker  void *custom;
44*6236dae4SAndroid Build Coastguard Worker};
45*6236dae4SAndroid Build Coastguard Worker
46*6236dae4SAndroid Build Coastguard Workerstatic int my_trace(CURL *handle, curl_infotype type,
47*6236dae4SAndroid Build Coastguard Worker                    char *data, size_t size,
48*6236dae4SAndroid Build Coastguard Worker                    void *clientp)
49*6236dae4SAndroid Build Coastguard Worker{
50*6236dae4SAndroid Build Coastguard Worker  struct data *mine = clientp;
51*6236dae4SAndroid Build Coastguard Worker  printf("our ptr: %p\n", mine->custom);
52*6236dae4SAndroid Build Coastguard Worker
53*6236dae4SAndroid Build Coastguard Worker  /* output debug info */
54*6236dae4SAndroid Build Coastguard Worker}
55*6236dae4SAndroid Build Coastguard Worker
56*6236dae4SAndroid Build Coastguard Workerint main(void)
57*6236dae4SAndroid Build Coastguard Worker{
58*6236dae4SAndroid Build Coastguard Worker  CURL *curl;
59*6236dae4SAndroid Build Coastguard Worker  CURLcode res;
60*6236dae4SAndroid Build Coastguard Worker  struct data my_tracedata;
61*6236dae4SAndroid Build Coastguard Worker
62*6236dae4SAndroid Build Coastguard Worker  curl = curl_easy_init();
63*6236dae4SAndroid Build Coastguard Worker  if(curl) {
64*6236dae4SAndroid Build Coastguard Worker    curl_easy_setopt(curl, CURLOPT_DEBUGFUNCTION, my_trace);
65*6236dae4SAndroid Build Coastguard Worker
66*6236dae4SAndroid Build Coastguard Worker    curl_easy_setopt(curl, CURLOPT_DEBUGDATA, &my_tracedata);
67*6236dae4SAndroid Build Coastguard Worker
68*6236dae4SAndroid Build Coastguard Worker    /* the DEBUGFUNCTION has no effect until we enable VERBOSE */
69*6236dae4SAndroid Build Coastguard Worker    curl_easy_setopt(curl, CURLOPT_VERBOSE, 1L);
70*6236dae4SAndroid Build Coastguard Worker
71*6236dae4SAndroid Build Coastguard Worker    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
72*6236dae4SAndroid Build Coastguard Worker    res = curl_easy_perform(curl);
73*6236dae4SAndroid Build Coastguard Worker
74*6236dae4SAndroid Build Coastguard Worker    /* always cleanup */
75*6236dae4SAndroid Build Coastguard Worker    curl_easy_cleanup(curl);
76*6236dae4SAndroid Build Coastguard Worker  }
77*6236dae4SAndroid Build Coastguard Worker  return 0;
78*6236dae4SAndroid Build Coastguard Worker}
79*6236dae4SAndroid Build Coastguard Worker~~~
80*6236dae4SAndroid Build Coastguard Worker
81*6236dae4SAndroid Build Coastguard Worker# %AVAILABILITY%
82*6236dae4SAndroid Build Coastguard Worker
83*6236dae4SAndroid Build Coastguard Worker# RETURN VALUE
84*6236dae4SAndroid Build Coastguard Worker
85*6236dae4SAndroid Build Coastguard WorkerReturns CURLE_OK
86