xref: /aosp_15_r20/external/curl/docs/libcurl/curl_mime_addpart.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: curl_mime_addpart
5*6236dae4SAndroid Build Coastguard WorkerSection: 3
6*6236dae4SAndroid Build Coastguard WorkerSource: libcurl
7*6236dae4SAndroid Build Coastguard WorkerSee-also:
8*6236dae4SAndroid Build Coastguard Worker  - curl_mime_data (3)
9*6236dae4SAndroid Build Coastguard Worker  - curl_mime_data_cb (3)
10*6236dae4SAndroid Build Coastguard Worker  - curl_mime_encoder (3)
11*6236dae4SAndroid Build Coastguard Worker  - curl_mime_filedata (3)
12*6236dae4SAndroid Build Coastguard Worker  - curl_mime_filename (3)
13*6236dae4SAndroid Build Coastguard Worker  - curl_mime_headers (3)
14*6236dae4SAndroid Build Coastguard Worker  - curl_mime_init (3)
15*6236dae4SAndroid Build Coastguard Worker  - curl_mime_name (3)
16*6236dae4SAndroid Build Coastguard Worker  - curl_mime_subparts (3)
17*6236dae4SAndroid Build Coastguard Worker  - curl_mime_type (3)
18*6236dae4SAndroid Build Coastguard WorkerProtocol:
19*6236dae4SAndroid Build Coastguard Worker  - HTTP
20*6236dae4SAndroid Build Coastguard Worker  - IMAP
21*6236dae4SAndroid Build Coastguard Worker  - SMTP
22*6236dae4SAndroid Build Coastguard WorkerAdded-in: 7.56.0
23*6236dae4SAndroid Build Coastguard Worker---
24*6236dae4SAndroid Build Coastguard Worker
25*6236dae4SAndroid Build Coastguard Worker# NAME
26*6236dae4SAndroid Build Coastguard Worker
27*6236dae4SAndroid Build Coastguard Workercurl_mime_addpart - append a new empty part to a mime structure
28*6236dae4SAndroid Build Coastguard Worker
29*6236dae4SAndroid Build Coastguard Worker# SYNOPSIS
30*6236dae4SAndroid Build Coastguard Worker
31*6236dae4SAndroid Build Coastguard Worker~~~c
32*6236dae4SAndroid Build Coastguard Worker#include <curl/curl.h>
33*6236dae4SAndroid Build Coastguard Worker
34*6236dae4SAndroid Build Coastguard Workercurl_mimepart *curl_mime_addpart(curl_mime *mime);
35*6236dae4SAndroid Build Coastguard Worker~~~
36*6236dae4SAndroid Build Coastguard Worker
37*6236dae4SAndroid Build Coastguard Worker# DESCRIPTION
38*6236dae4SAndroid Build Coastguard Worker
39*6236dae4SAndroid Build Coastguard Workercurl_mime_addpart(3) creates and appends a new empty part to the given
40*6236dae4SAndroid Build Coastguard Workermime structure and returns a handle to it. The returned part handle can
41*6236dae4SAndroid Build Coastguard Workersubsequently be populated using functions from the mime API.
42*6236dae4SAndroid Build Coastguard Worker
43*6236dae4SAndroid Build Coastguard Worker*mime* is the handle of the mime structure in which the new part must be
44*6236dae4SAndroid Build Coastguard Workerappended.
45*6236dae4SAndroid Build Coastguard Worker
46*6236dae4SAndroid Build Coastguard Worker# %PROTOCOLS%
47*6236dae4SAndroid Build Coastguard Worker
48*6236dae4SAndroid Build Coastguard Worker# EXAMPLE
49*6236dae4SAndroid Build Coastguard Worker
50*6236dae4SAndroid Build Coastguard Worker~~~c
51*6236dae4SAndroid Build Coastguard Workerint main(void)
52*6236dae4SAndroid Build Coastguard Worker{
53*6236dae4SAndroid Build Coastguard Worker  curl_mime *mime;
54*6236dae4SAndroid Build Coastguard Worker  curl_mimepart *part;
55*6236dae4SAndroid Build Coastguard Worker
56*6236dae4SAndroid Build Coastguard Worker  CURL *curl = curl_easy_init();
57*6236dae4SAndroid Build Coastguard Worker  if(curl) {
58*6236dae4SAndroid Build Coastguard Worker    /* create a mime handle */
59*6236dae4SAndroid Build Coastguard Worker    mime = curl_mime_init(curl);
60*6236dae4SAndroid Build Coastguard Worker
61*6236dae4SAndroid Build Coastguard Worker    /* add a part */
62*6236dae4SAndroid Build Coastguard Worker    part = curl_mime_addpart(mime);
63*6236dae4SAndroid Build Coastguard Worker
64*6236dae4SAndroid Build Coastguard Worker    /* continue and set name + data to the part */
65*6236dae4SAndroid Build Coastguard Worker    curl_mime_data(part, "This is the field data", CURL_ZERO_TERMINATED);
66*6236dae4SAndroid Build Coastguard Worker    curl_mime_name(part, "data");
67*6236dae4SAndroid Build Coastguard Worker  }
68*6236dae4SAndroid Build Coastguard Worker}
69*6236dae4SAndroid Build Coastguard Worker~~~
70*6236dae4SAndroid Build Coastguard Worker
71*6236dae4SAndroid Build Coastguard Worker# %AVAILABILITY%
72*6236dae4SAndroid Build Coastguard Worker
73*6236dae4SAndroid Build Coastguard Worker# RETURN VALUE
74*6236dae4SAndroid Build Coastguard Worker
75*6236dae4SAndroid Build Coastguard WorkerA mime part structure handle, or NULL upon failure.
76