~ubuntu-branches/ubuntu/vivid/glib2.0/vivid-proposed : revision 203

43

<tbody>

44

<tr>

45

46

<a href="../glib/glib-Basic-Types.html#gssize">gssize</a>

46

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a>

47

</td>

48

49

<a class="link" href="GOutputStream.html#g-output-stream-write" title="g_output_stream_write ()">g_output_stream_write</a> ()

51

</tr>

52

<tr>

53

54

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

54

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

55

</td>

56

57

<a class="link" href="GOutputStream.html#g-output-stream-write-all" title="g_output_stream_write_all ()">g_output_stream_write_all</a> ()

59

</tr>

60

<tr>

61

62

<a href="../glib/glib-Basic-Types.html#gssize">gssize</a>

62

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a>

63

</td>

64

65

<a class="link" href="GOutputStream.html#g-output-stream-splice" title="g_output_stream_splice ()">g_output_stream_splice</a> ()

67

</tr>

68

<tr>

69

70

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

70

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

71

</td>

72

73

<a class="link" href="GOutputStream.html#g-output-stream-flush" title="g_output_stream_flush ()">g_output_stream_flush</a> ()

75

</tr>

76

<tr>

77

78

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

78

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

79

</td>

80

81

<a class="link" href="GOutputStream.html#g-output-stream-close" title="g_output_stream_close ()">g_output_stream_close</a> ()

91

</tr>

92

<tr>

93

94

<a href="../glib/glib-Basic-Types.html#gssize">gssize</a>

94

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a>

95

</td>

96

97

<a class="link" href="GOutputStream.html#g-output-stream-write-finish" title="g_output_stream_write_finish ()">g_output_stream_write_finish</a> ()

107

</tr>

108

<tr>

109

110

<a href="../glib/glib-Basic-Types.html#gssize">gssize</a>

110

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a>

111

</td>

112

113

<a class="link" href="GOutputStream.html#g-output-stream-splice-finish" title="g_output_stream_splice_finish ()">g_output_stream_splice_finish</a> ()

123

</tr>

124

<tr>

125

126

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

126

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

127

</td>

128

129

<a class="link" href="GOutputStream.html#g-output-stream-flush-finish" title="g_output_stream_flush_finish ()">g_output_stream_flush_finish</a> ()

139

</tr>

140

<tr>

141

142

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

142

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

143

</td>

144

145

<a class="link" href="GOutputStream.html#g-output-stream-close-finish" title="g_output_stream_close_finish ()">g_output_stream_close_finish</a> ()

147

</tr>

148

<tr>

149

150

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

150

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

151

</td>

152

153

<a class="link" href="GOutputStream.html#g-output-stream-is-closing" title="g_output_stream_is_closing ()">g_output_stream_is_closing</a> ()

155

</tr>

156

<tr>

157

158

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

158

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

159

</td>

160

161

<a class="link" href="GOutputStream.html#g-output-stream-is-closed" title="g_output_stream_is_closed ()">g_output_stream_is_closed</a> ()

163

</tr>

164

<tr>

165

166

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

166

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

167

</td>

168

169

<a class="link" href="GOutputStream.html#g-output-stream-has-pending" title="g_output_stream_has_pending ()">g_output_stream_has_pending</a> ()

171

</tr>

172

<tr>

173

174

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

174

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

175

</td>

176

177

<a class="link" href="GOutputStream.html#g-output-stream-set-pending" title="g_output_stream_set_pending ()">g_output_stream_set_pending</a> ()

187

</tr>

188

<tr>

189

190

<a href="../glib/glib-Basic-Types.html#gssize">gssize</a>

190

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a>

191

</td>

192

193

<a class="link" href="GOutputStream.html#g-output-stream-write-bytes" title="g_output_stream_write_bytes ()">g_output_stream_write_bytes</a> ()

203

</tr>

204

<tr>

205

206

<a href="../glib/glib-Basic-Types.html#gssize">gssize</a>

206

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a>

207

</td>

208

209

<a class="link" href="GOutputStream.html#g-output-stream-write-bytes-finish" title="g_output_stream_write_bytes_finish ()">g_output_stream_write_bytes_finish</a> ()

233

</div>

234

235

<a name="GOutputStream.object-hierarchy"></a><h2>Object Hierarchy</h2>

236

<pre class="screen"> <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>

236

<pre class="screen"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>

237

╰── GOutputStream

238

├── <a class="link" href="GFilterOutputStream.html" title="GFilterOutputStream">GFilterOutputStream</a>

239

├── <a class="link" href="GFileOutputStream.html" title="GFileOutputStream">GFileOutputStream</a>

265

<a name="GOutputStream.functions_details"></a><h2>Functions</h2>

266

267

<a name="g-output-stream-write"></a><h3>g_output_stream_write ()</h3>

268

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gssize">gssize</a>

268

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a>

269

g_output_stream_write (<code><a class="link" href="GOutputStream.html" title="GOutputStream">GOutputStream</a> *stream</code>,

270

<code>const void *buffer</code>,

271

<code><a href="../glib/glib-Basic-Types.html#gsize">gsize</a> count</code>,

271

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize">gsize</a> count</code>,

272

<code><a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable</code>,

273

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

273

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

274

Tries to write <code>count</code>

275

bytes from <code>buffer</code>

276

into the stream. Will block

277

during the operation.

278

If count is 0, returns 0 and does nothing. A value of <code>count</code>

279

280

larger than <a href="../glib/glib-Basic-Types.html#G-MAXSSIZE:CAPS"><code class="literal">G_MAXSSIZE</code></a> will cause a <a class="link" href="gio-GIOError.html#G-IO-ERROR-INVALID-ARGUMENT:CAPS"><code class="literal">G_IO_ERROR_INVALID_ARGUMENT</code></a> error.

280

larger than <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#G-MAXSSIZE:CAPS"><code class="literal">G_MAXSSIZE</code></a> will cause a <a class="link" href="gio-GIOError.html#G-IO-ERROR-INVALID-ARGUMENT:CAPS"><code class="literal">G_IO_ERROR_INVALID_ARGUMENT</code></a> error.

281

On success, the number of bytes written to the stream is returned.

282

It is not an error if this is not the same as the requested size, as it

283

can happen e.g. on a partial I/O error, or if there is not enough

286

<code>count</code>

287

is 0).

288

If <code>cancellable</code>

289

is not <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then the operation can be cancelled by

289

is not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then the operation can be cancelled by

290

triggering the cancellable object from another thread. If the operation

291

was cancelled, the error <a class="link" href="gio-GIOError.html#G-IO-ERROR-CANCELLED:CAPS"><code class="literal">G_IO_ERROR_CANCELLED</code></a> will be returned. If an

292

operation was partially finished when the operation was cancelled the

325

</tr>

326

<tr>

327

<td class="parameter_name">error</td>

328

<td class="parameter_description">location to store the error occurring, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore</td>

328

<td class="parameter_description">location to store the error occurring, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore</td>

329

330

</tr>

331

</tbody>

340

<hr>

341

342

<a name="g-output-stream-write-all"></a><h3>g_output_stream_write_all ()</h3>

343

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

343

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

344

g_output_stream_write_all (<code><a class="link" href="GOutputStream.html" title="GOutputStream">GOutputStream</a> *stream</code>,

345

<code>const void *buffer</code>,

346

<code><a href="../glib/glib-Basic-Types.html#gsize">gsize</a> count</code>,

347

<code><a href="../glib/glib-Basic-Types.html#gsize">gsize</a> *bytes_written</code>,

346

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize">gsize</a> count</code>,

347

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize">gsize</a> *bytes_written</code>,

348

<code><a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable</code>,

349

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

349

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

350

Tries to write <code>count</code>

351

bytes from <code>buffer</code>

352

into the stream. Will block

354

This function is similar to <a class="link" href="GOutputStream.html#g-output-stream-write" title="g_output_stream_write ()"><code class="function">g_output_stream_write()</code></a>, except it tries to

355

write as many bytes as requested, only stopping on an error.

356

On a successful write of <code>count</code>

357

bytes, <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> is returned, and <code>bytes_written</code>

357

bytes, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> is returned, and <code>bytes_written</code>

358

359

is set to <code>count</code>

360

.

361

If there is an error during the operation <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned and <code>error</code>

361

If there is an error during the operation <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned and <code>error</code>

362

363

is set to indicate the error status, <code>bytes_written</code>

364

is updated to contain

395

</tr>

396

<tr>

397

<td class="parameter_name">cancellable</td>

398

<td class="parameter_description"> optional <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> object, <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore. </td>

398

<td class="parameter_description"> optional <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> object, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore. </td>

399

<td class="parameter_annotations">[<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]</td>

400

</tr>

401

<tr>

402

<td class="parameter_name">error</td>

403

<td class="parameter_description">location to store the error occurring, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore</td>

403

<td class="parameter_description">location to store the error occurring, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore</td>

404

405

</tr>

406

</tbody>

408

</div>

409

410

<a name="id-1.4.7.4.9.3.9"></a><h4>Returns</h4>

411

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if there was an error

411

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if there was an error

412

413

</div>

414

</div>

415

<hr>

416

417

<a name="g-output-stream-splice"></a><h3>g_output_stream_splice ()</h3>

418

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gssize">gssize</a>

418

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a>

419

g_output_stream_splice (<code><a class="link" href="GOutputStream.html" title="GOutputStream">GOutputStream</a> *stream</code>,

420

<code><a class="link" href="GInputStream.html" title="GInputStream">GInputStream</a> *source</code>,

421

<code><a class="link" href="GOutputStream.html#GOutputStreamSpliceFlags" title="enum GOutputStreamSpliceFlags">GOutputStreamSpliceFlags</a> flags</code>,

422

<code><a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable</code>,

423

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

423

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

424

Splices an input stream into an output stream.

425

426

<a name="id-1.4.7.4.9.4.5"></a><h4>Parameters</h4>

448

</tr>

449

<tr>

450

<td class="parameter_name">cancellable</td>

451

<td class="parameter_description"> optional <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> object, <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore. </td>

451

<td class="parameter_description"> optional <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> object, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore. </td>

452

<td class="parameter_annotations">[<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]</td>

453

</tr>

454

<tr>

455

<td class="parameter_name">error</td>

456

<td class="parameter_description">a <a href="../glib/glib-Error-Reporting.html#GError">GError</a> location to store the error occurring, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to

456

<td class="parameter_description">a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> location to store the error occurring, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to

457

ignore.</td>

458

459

</tr>

462

</div>

463

464

<a name="id-1.4.7.4.9.4.6"></a><h4>Returns</h4>

465

a <a href="../glib/glib-Basic-Types.html#gssize">gssize</a> containing the size of the data spliced, or

465

a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a> containing the size of the data spliced, or

466

-1 if an error occurred. Note that if the number of bytes

467

spliced is greater than <a href="../glib/glib-Basic-Types.html#G-MAXSSIZE:CAPS"><code class="literal">G_MAXSSIZE</code></a>, then that will be

467

spliced is greater than <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#G-MAXSSIZE:CAPS"><code class="literal">G_MAXSSIZE</code></a>, then that will be

468

returned, and there is no way to determine the actual number

469

of bytes spliced.

470

473

<hr>

474

475

<a name="g-output-stream-flush"></a><h3>g_output_stream_flush ()</h3>

476

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

476

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

477

g_output_stream_flush (<code><a class="link" href="GOutputStream.html" title="GOutputStream">GOutputStream</a> *stream</code>,

478

<code><a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable</code>,

479

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

479

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

480

Forces a write of all user-space buffered data for the given

481

<code>stream</code>

482

. Will block during the operation. Closing the stream will

483

implicitly cause a flush.

484

This function is optional for inherited classes.

485

If <code>cancellable</code>

486

is not <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then the operation can be cancelled by

486

is not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then the operation can be cancelled by

487

triggering the cancellable object from another thread. If the operation

488

was cancelled, the error <a class="link" href="gio-GIOError.html#G-IO-ERROR-CANCELLED:CAPS"><code class="literal">G_IO_ERROR_CANCELLED</code></a> will be returned.

489

507

</tr>

508

<tr>

509

<td class="parameter_name">error</td>

510

<td class="parameter_description">location to store the error occurring, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore</td>

510

<td class="parameter_description">location to store the error occurring, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore</td>

511

512

</tr>

513

</tbody>

515

</div>

516

517

<a name="id-1.4.7.4.9.5.8"></a><h4>Returns</h4>

518

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on error

518

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on error

519

520

</div>

521

</div>

522

<hr>

523

524

<a name="g-output-stream-close"></a><h3>g_output_stream_close ()</h3>

525

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

525

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

526

g_output_stream_close (<code><a class="link" href="GOutputStream.html" title="GOutputStream">GOutputStream</a> *stream</code>,

527

<code><a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable</code>,

528

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

528

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

529

Closes the stream, releasing resources related to it.

530

Once the stream is closed, all other operations will return <a class="link" href="gio-GIOError.html#G-IO-ERROR-CLOSED:CAPS"><code class="literal">G_IO_ERROR_CLOSED</code></a>.

531

Closing a stream multiple times will not return an error.

543

is important to check and report the error to the user, otherwise

544

there might be a loss of data as all data might not be written.

545

If <code>cancellable</code>

546

is not <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then the operation can be cancelled by

546

is not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then the operation can be cancelled by

547

triggering the cancellable object from another thread. If the operation

548

was cancelled, the error <a class="link" href="gio-GIOError.html#G-IO-ERROR-CANCELLED:CAPS"><code class="literal">G_IO_ERROR_CANCELLED</code></a> will be returned.

549

Cancelling a close will still leave the stream closed, but there some streams

571

</tr>

572

<tr>

573

<td class="parameter_name">error</td>

574

<td class="parameter_description">location to store the error occurring, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore</td>

574

<td class="parameter_description">location to store the error occurring, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore</td>

575

576

</tr>

577

</tbody>

579

</div>

580

581

<a name="id-1.4.7.4.9.6.12"></a><h4>Returns</h4>

582

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on failure

582

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on failure

583

584

</div>

585

</div>

589

<pre class="programlisting">void

590

g_output_stream_write_async (<code><a class="link" href="GOutputStream.html" title="GOutputStream">GOutputStream</a> *stream</code>,

591

<code>const void *buffer</code>,

592

<code><a href="../glib/glib-Basic-Types.html#gsize">gsize</a> count</code>,

592

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize">gsize</a> count</code>,

593

<code>int io_priority</code>,

594

<code><a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable</code>,

595

<code><a class="link" href="GAsyncResult.html#GAsyncReadyCallback" title="GAsyncReadyCallback ()">GAsyncReadyCallback</a> callback</code>,

596

<code><a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> user_data</code>);</pre>

596

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> user_data</code>);</pre>

597

Request an asynchronous write of <code>count</code>

598

bytes from <code>buffer</code>

599

into

604

During an async request no other sync and async calls are allowed,

605

and will result in <a class="link" href="gio-GIOError.html#G-IO-ERROR-PENDING:CAPS"><code class="literal">G_IO_ERROR_PENDING</code></a> errors.

606

A value of <code>count</code>

607

larger than <a href="../glib/glib-Basic-Types.html#G-MAXSSIZE:CAPS"><code class="literal">G_MAXSSIZE</code></a> will cause a

607

larger than <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#G-MAXSSIZE:CAPS"><code class="literal">G_MAXSSIZE</code></a> will cause a

608

<a class="link" href="gio-GIOError.html#G-IO-ERROR-INVALID-ARGUMENT:CAPS"><code class="literal">G_IO_ERROR_INVALID_ARGUMENT</code></a> error.

609

On success, the number of bytes written will be passed to the

610

<code>callback</code>

617

method will just wait until this changes.

618

Any outstanding I/O request with higher priority (lower numerical

619

value) will be executed before an outstanding request with lower

620

priority. Default priority is <a href="../glib/glib-The-Main-Event-Loop.html#G-PRIORITY-DEFAULT:CAPS"><code class="literal">G_PRIORITY_DEFAULT</code></a>.

620

priority. Default priority is <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#G-PRIORITY-DEFAULT:CAPS"><code class="literal">G_PRIORITY_DEFAULT</code></a>.

621

The asyncronous methods have a default fallback that uses threads

622

to implement asynchronicity, so they are optional for inheriting

623

classes. However, if you override one you must override all.

627

will be made, so it must stay valid

628

until <code>callback</code>

629

is called. See <a class="link" href="GOutputStream.html#g-output-stream-write-bytes-async" title="g_output_stream_write_bytes_async ()"><code class="function">g_output_stream_write_bytes_async()</code></a>

630

for a <a href="../glib/glib-Byte-Arrays.html#GBytes">GBytes</a> version that will automatically hold a reference to

630

for a <a href="http://library.gnome.org/devel/glib/unstable/glib-Byte-Arrays.html#GBytes">GBytes</a> version that will automatically hold a reference to

631

the contents (without copying) for the duration of the call.

632

633

<a name="id-1.4.7.4.9.7.13"></a><h4>Parameters</h4>

660

</tr>

661

<tr>

662

<td class="parameter_name">cancellable</td>

663

<td class="parameter_description"> optional <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> object, <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore. </td>

663

<td class="parameter_description"> optional <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> object, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore. </td>

664

<td class="parameter_annotations">[<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]</td>

665

</tr>

666

<tr>

680

<hr>

681

682

<a name="g-output-stream-write-finish"></a><h3>g_output_stream_write_finish ()</h3>

683

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gssize">gssize</a>

683

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a>

684

g_output_stream_write_finish (<code><a class="link" href="GOutputStream.html" title="GOutputStream">GOutputStream</a> *stream</code>,

685

<code><a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a> *result</code>,

686

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

686

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

687

Finishes a stream write operation.

688

689

<a name="id-1.4.7.4.9.8.5"></a><h4>Parameters</h4>

706

</tr>

707

<tr>

708

<td class="parameter_name">error</td>

709

<td class="parameter_description">a <a href="../glib/glib-Error-Reporting.html#GError">GError</a> location to store the error occurring, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to

709

<td class="parameter_description">a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> location to store the error occurring, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to

710

ignore.</td>

711

712

</tr>

715

</div>

716

717

<a name="id-1.4.7.4.9.8.6"></a><h4>Returns</h4>

718

a <a href="../glib/glib-Basic-Types.html#gssize">gssize</a> containing the number of bytes written to the stream.

718

a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a> containing the number of bytes written to the stream.

719

720

</div>

721

</div>

729

<code>int io_priority</code>,

730

<code><a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable</code>,

731

<code><a class="link" href="GAsyncResult.html#GAsyncReadyCallback" title="GAsyncReadyCallback ()">GAsyncReadyCallback</a> callback</code>,

732

<code><a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> user_data</code>);</pre>

732

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> user_data</code>);</pre>

733

Splices a stream asynchronously.

734

When the operation is finished <code>callback</code>

735

will be called.

768

</tr>

769

<tr>

770

<td class="parameter_name">cancellable</td>

771

<td class="parameter_description"> optional <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> object, <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore. </td>

771

<td class="parameter_description"> optional <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> object, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore. </td>

772

<td class="parameter_annotations">[<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]</td>

773

</tr>

774

<tr>

789

<hr>

790

791

<a name="g-output-stream-splice-finish"></a><h3>g_output_stream_splice_finish ()</h3>

792

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gssize">gssize</a>

792

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a>

793

g_output_stream_splice_finish (<code><a class="link" href="GOutputStream.html" title="GOutputStream">GOutputStream</a> *stream</code>,

794

<code><a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a> *result</code>,

795

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

795

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

796

Finishes an asynchronous stream splice operation.

797

798

<a name="id-1.4.7.4.9.10.5"></a><h4>Parameters</h4>

815

</tr>

816

<tr>

817

<td class="parameter_name">error</td>

818

<td class="parameter_description">a <a href="../glib/glib-Error-Reporting.html#GError">GError</a> location to store the error occurring, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to

818

<td class="parameter_description">a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> location to store the error occurring, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to

819

ignore.</td>

820

821

</tr>

824

</div>

825

826

<a name="id-1.4.7.4.9.10.6"></a><h4>Returns</h4>

827

a <a href="../glib/glib-Basic-Types.html#gssize">gssize</a> of the number of bytes spliced. Note that if the

828

number of bytes spliced is greater than <a href="../glib/glib-Basic-Types.html#G-MAXSSIZE:CAPS"><code class="literal">G_MAXSSIZE</code></a>, then that

827

a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a> of the number of bytes spliced. Note that if the

828

number of bytes spliced is greater than <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#G-MAXSSIZE:CAPS"><code class="literal">G_MAXSSIZE</code></a>, then that

829

will be returned, and there is no way to determine the actual

830

number of bytes spliced.

831

839

<code>int io_priority</code>,

840

<code><a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable</code>,

841

<code><a class="link" href="GAsyncResult.html#GAsyncReadyCallback" title="GAsyncReadyCallback ()">GAsyncReadyCallback</a> callback</code>,

842

<code><a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> user_data</code>);</pre>

842

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> user_data</code>);</pre>

843

Forces an asynchronous write of all user-space buffered data for

844

the given <code>stream</code>

845

.

869

</tr>

870

<tr>

871

<td class="parameter_name">cancellable</td>

872

<td class="parameter_description"> optional <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> object, <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore. </td>

872

<td class="parameter_description"> optional <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> object, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore. </td>

873

<td class="parameter_annotations">[<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]</td>

874

</tr>

875

<tr>

889

<hr>

890

891

<a name="g-output-stream-flush-finish"></a><h3>g_output_stream_flush_finish ()</h3>

892

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

892

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

893

g_output_stream_flush_finish (<code><a class="link" href="GOutputStream.html" title="GOutputStream">GOutputStream</a> *stream</code>,

894

<code><a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a> *result</code>,

895

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

895

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

896

Finishes flushing an output stream.

897

898

<a name="id-1.4.7.4.9.12.5"></a><h4>Parameters</h4>

915

</tr>

916

<tr>

917

<td class="parameter_name">error</td>

918

<td class="parameter_description">a <a href="../glib/glib-Error-Reporting.html#GError">GError</a> location to store the error occurring, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to

918

<td class="parameter_description">a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> location to store the error occurring, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to

919

ignore.</td>

920

921

</tr>

924

</div>

925

926

<a name="id-1.4.7.4.9.12.6"></a><h4>Returns</h4>

927

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if flush operation succeeded, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.

927

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if flush operation succeeded, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.

928

929

</div>

930

</div>

936

<code>int io_priority</code>,

937

<code><a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable</code>,

938

<code><a class="link" href="GAsyncResult.html#GAsyncReadyCallback" title="GAsyncReadyCallback ()">GAsyncReadyCallback</a> callback</code>,

939

<code><a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> user_data</code>);</pre>

939

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> user_data</code>);</pre>

940

Requests an asynchronous close of the stream, releasing resources

941

related to it. When the operation is finished <code>callback</code>

942

will be

987

<hr>

988

989

<a name="g-output-stream-close-finish"></a><h3>g_output_stream_close_finish ()</h3>

990

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

990

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

991

g_output_stream_close_finish (<code><a class="link" href="GOutputStream.html" title="GOutputStream">GOutputStream</a> *stream</code>,

992

<code><a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a> *result</code>,

993

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

993

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

994

Closes an output stream.

995

996

<a name="id-1.4.7.4.9.14.5"></a><h4>Parameters</h4>

1013

</tr>

1014

<tr>

1015

<td class="parameter_name">error</td>

1016

<td class="parameter_description">a <a href="../glib/glib-Error-Reporting.html#GError">GError</a> location to store the error occurring, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to

1016

<td class="parameter_description">a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> location to store the error occurring, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to

1017

ignore.</td>

1018

1019

</tr>

1022

</div>

1023

1024

<a name="id-1.4.7.4.9.14.6"></a><h4>Returns</h4>

1025

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if stream was successfully closed, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.

1025

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if stream was successfully closed, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.

1026

1027

</div>

1028

</div>

1029

<hr>

1030

1031

<a name="g-output-stream-is-closing"></a><h3>g_output_stream_is_closing ()</h3>

1032

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

1032

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

1033

g_output_stream_is_closing (<code><a class="link" href="GOutputStream.html" title="GOutputStream">GOutputStream</a> *stream</code>);</pre>

1034

Checks if an output stream is being closed. This can be

1035

used inside e.g. a flush implementation to see if the

1052

</div>

1053

1054

<a name="id-1.4.7.4.9.15.6"></a><h4>Returns</h4>

1055

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <code>stream</code>

1056

is being closed. <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.

1055

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <code>stream</code>

1056

is being closed. <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.

1057

1058

</div>

1059

Since 2.24

1061

<hr>

1062

1063

<a name="g-output-stream-is-closed"></a><h3>g_output_stream_is_closed ()</h3>

1064

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

1064

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

1065

g_output_stream_is_closed (<code><a class="link" href="GOutputStream.html" title="GOutputStream">GOutputStream</a> *stream</code>);</pre>

1066

Checks if an output stream has already been closed.

1067

1081

</div>

1082

1083

<a name="id-1.4.7.4.9.16.6"></a><h4>Returns</h4>

1084

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <code>stream</code>

1085

is closed. <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.

1084

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <code>stream</code>

1085

is closed. <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.

1086

1087

</div>

1088

</div>

1089

<hr>

1090

1091

<a name="g-output-stream-has-pending"></a><h3>g_output_stream_has_pending ()</h3>

1092

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

1092

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

1093

g_output_stream_has_pending (<code><a class="link" href="GOutputStream.html" title="GOutputStream">GOutputStream</a> *stream</code>);</pre>

1094

Checks if an ouput stream has pending actions.

1095

1109

</div>

1110

1111

<a name="id-1.4.7.4.9.17.6"></a><h4>Returns</h4>

1112

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <code>stream</code>

1112

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <code>stream</code>

1113

has pending actions.

1114

1115

</div>

1117

<hr>

1118

1119

<a name="g-output-stream-set-pending"></a><h3>g_output_stream_set_pending ()</h3>

1120

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a>

1120

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a>

1121

g_output_stream_set_pending (<code><a class="link" href="GOutputStream.html" title="GOutputStream">GOutputStream</a> *stream</code>,

1122

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

1122

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

1123

Sets <code>stream</code>

1124

to have actions pending. If the pending flag is

1125

already set or <code>stream</code>

1126

is closed, it will return <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> and set

1126

is closed, it will return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> and set

1127

<code>error</code>

1128

.

1129

1142

</tr>

1143

<tr>

1144

<td class="parameter_name">error</td>

1145

<td class="parameter_description">a <a href="../glib/glib-Error-Reporting.html#GError">GError</a> location to store the error occurring, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to

1145

<td class="parameter_description">a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> location to store the error occurring, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to

1146

ignore.</td>

1147

1148

</tr>

1151

</div>

1152

1153

<a name="id-1.4.7.4.9.18.6"></a><h4>Returns</h4>

1154

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if pending was previously unset and is now set.

1154

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if pending was previously unset and is now set.

1155

1156

</div>

1157

</div>

1181

<hr>

1182

1183

<a name="g-output-stream-write-bytes"></a><h3>g_output_stream_write_bytes ()</h3>

1184

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gssize">gssize</a>

1184

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a>

1185

g_output_stream_write_bytes (<code><a class="link" href="GOutputStream.html" title="GOutputStream">GOutputStream</a> *stream</code>,

1186

<code><a href="../glib/glib-Byte-Arrays.html#GBytes">GBytes</a> *bytes</code>,

1186

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Byte-Arrays.html#GBytes">GBytes</a> *bytes</code>,

1187

<code><a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable</code>,

1188

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

1188

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

1189

A wrapper function for <a class="link" href="GOutputStream.html#g-output-stream-write" title="g_output_stream_write ()"><code class="function">g_output_stream_write()</code></a> which takes a

1190

<a href="../glib/glib-Byte-Arrays.html#GBytes">GBytes</a> as input. This can be more convenient for use by language

1191

bindings or in other cases where the refcounted nature of <a href="../glib/glib-Byte-Arrays.html#GBytes">GBytes</a>

1190

<a href="http://library.gnome.org/devel/glib/unstable/glib-Byte-Arrays.html#GBytes">GBytes</a> as input. This can be more convenient for use by language

1191

bindings or in other cases where the refcounted nature of <a href="http://library.gnome.org/devel/glib/unstable/glib-Byte-Arrays.html#GBytes">GBytes</a>

1192

is helpful over a bare pointer interface.

1193

However, note that this function may still perform partial writes,

1194

just like <a class="link" href="GOutputStream.html#g-output-stream-write" title="g_output_stream_write ()"><code class="function">g_output_stream_write()</code></a>. If that occurs, to continue

1195

writing, you will need to create a new <a href="../glib/glib-Byte-Arrays.html#GBytes">GBytes</a> containing just the

1196

remaining bytes, using <a href="../glib/glib-Byte-Arrays.html#g-bytes-new-from-bytes"><code class="function">g_bytes_new_from_bytes()</code></a>. Passing the same

1197

<a href="../glib/glib-Byte-Arrays.html#GBytes">GBytes</a> instance multiple times potentially can result in duplicated

1195

writing, you will need to create a new <a href="http://library.gnome.org/devel/glib/unstable/glib-Byte-Arrays.html#GBytes">GBytes</a> containing just the

1196

remaining bytes, using <a href="http://library.gnome.org/devel/glib/unstable/glib-Byte-Arrays.html#g-bytes-new-from-bytes"><code class="function">g_bytes_new_from_bytes()</code></a>. Passing the same

1197

<a href="http://library.gnome.org/devel/glib/unstable/glib-Byte-Arrays.html#GBytes">GBytes</a> instance multiple times potentially can result in duplicated

1198

data in the output stream.

1199

1200

<a name="id-1.4.7.4.9.20.6"></a><h4>Parameters</h4>

1212

</tr>

1213

<tr>

1214

<td class="parameter_name">bytes</td>

1215

<td class="parameter_description">the <a href="../glib/glib-Byte-Arrays.html#GBytes">GBytes</a> to write</td>

1215

<td class="parameter_description">the <a href="http://library.gnome.org/devel/glib/unstable/glib-Byte-Arrays.html#GBytes">GBytes</a> to write</td>

1216

1217

</tr>

1218

<tr>

1222

</tr>

1223

<tr>

1224

<td class="parameter_name">error</td>

1225

<td class="parameter_description">location to store the error occurring, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore</td>

1225

<td class="parameter_description">location to store the error occurring, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore</td>

1226

1227

</tr>

1228

</tbody>

1239

<a name="g-output-stream-write-bytes-async"></a><h3>g_output_stream_write_bytes_async ()</h3>

1240

<pre class="programlisting">void

1241

g_output_stream_write_bytes_async (<code><a class="link" href="GOutputStream.html" title="GOutputStream">GOutputStream</a> *stream</code>,

1242

<code><a href="../glib/glib-Byte-Arrays.html#GBytes">GBytes</a> *bytes</code>,

1242

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Byte-Arrays.html#GBytes">GBytes</a> *bytes</code>,

1243

<code>int io_priority</code>,

1244

<code><a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable</code>,

1245

<code><a class="link" href="GAsyncResult.html#GAsyncReadyCallback" title="GAsyncReadyCallback ()">GAsyncReadyCallback</a> callback</code>,

1246

<code><a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> user_data</code>);</pre>

1246

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> user_data</code>);</pre>

1247

This function is similar to <a class="link" href="GOutputStream.html#g-output-stream-write-async" title="g_output_stream_write_async ()"><code class="function">g_output_stream_write_async()</code></a>, but

1248

takes a <a href="../glib/glib-Byte-Arrays.html#GBytes">GBytes</a> as input. Due to the refcounted nature of <a href="../glib/glib-Byte-Arrays.html#GBytes">GBytes</a>,

1248

takes a <a href="http://library.gnome.org/devel/glib/unstable/glib-Byte-Arrays.html#GBytes">GBytes</a> as input. Due to the refcounted nature of <a href="http://library.gnome.org/devel/glib/unstable/glib-Byte-Arrays.html#GBytes">GBytes</a>,

1249

this allows the stream to avoid taking a copy of the data.

1250

However, note that this function may still perform partial writes,

1251

just like <a class="link" href="GOutputStream.html#g-output-stream-write-async" title="g_output_stream_write_async ()"><code class="function">g_output_stream_write_async()</code></a>. If that occurs, to continue

1252

writing, you will need to create a new <a href="../glib/glib-Byte-Arrays.html#GBytes">GBytes</a> containing just the

1253

remaining bytes, using <a href="../glib/glib-Byte-Arrays.html#g-bytes-new-from-bytes"><code class="function">g_bytes_new_from_bytes()</code></a>. Passing the same

1254

<a href="../glib/glib-Byte-Arrays.html#GBytes">GBytes</a> instance multiple times potentially can result in duplicated

1252

writing, you will need to create a new <a href="http://library.gnome.org/devel/glib/unstable/glib-Byte-Arrays.html#GBytes">GBytes</a> containing just the

1253

remaining bytes, using <a href="http://library.gnome.org/devel/glib/unstable/glib-Byte-Arrays.html#g-bytes-new-from-bytes"><code class="function">g_bytes_new_from_bytes()</code></a>. Passing the same

1254

<a href="http://library.gnome.org/devel/glib/unstable/glib-Byte-Arrays.html#GBytes">GBytes</a> instance multiple times potentially can result in duplicated

1255

data in the output stream.

1256

For the synchronous, blocking version of this function, see

1257

<a class="link" href="GOutputStream.html#g-output-stream-write-bytes" title="g_output_stream_write_bytes ()"><code class="function">g_output_stream_write_bytes()</code></a>.

1281

</tr>

1282

<tr>

1283

<td class="parameter_name">cancellable</td>

1284

<td class="parameter_description"> optional <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> object, <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore. </td>

1284

<td class="parameter_description"> optional <a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> object, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore. </td>

1285

<td class="parameter_annotations">[<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]</td>

1286

</tr>

1287

<tr>

1301

<hr>

1302

1303

<a name="g-output-stream-write-bytes-finish"></a><h3>g_output_stream_write_bytes_finish ()</h3>

1304

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gssize">gssize</a>

1304

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a>

1305

g_output_stream_write_bytes_finish (<code><a class="link" href="GOutputStream.html" title="GOutputStream">GOutputStream</a> *stream</code>,

1306

<code><a class="link" href="GAsyncResult.html" title="GAsyncResult">GAsyncResult</a> *result</code>,

1307

<code><a href="../glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

1308

Finishes a stream write-from-<a href="../glib/glib-Byte-Arrays.html#GBytes">GBytes</a> operation.

1307

<code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

1308

Finishes a stream write-from-<a href="http://library.gnome.org/devel/glib/unstable/glib-Byte-Arrays.html#GBytes">GBytes</a> operation.

1309

1310

<a name="id-1.4.7.4.9.22.5"></a><h4>Parameters</h4>

1311

1327

</tr>

1328

<tr>

1329

<td class="parameter_name">error</td>

1330

<td class="parameter_description">a <a href="../glib/glib-Error-Reporting.html#GError">GError</a> location to store the error occurring, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to

1330

<td class="parameter_description">a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> location to store the error occurring, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to

1331

ignore.</td>

1332

1333

</tr>

1336

</div>

1337

1338

<a name="id-1.4.7.4.9.22.6"></a><h4>Returns</h4>

1339

a <a href="../glib/glib-Basic-Types.html#gssize">gssize</a> containing the number of bytes written to the stream.

1339

a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gssize">gssize</a> containing the number of bytes written to the stream.

1340

1341

</div>

1342

</div>