~ubuntu-branches/debian/jessie/glib2.0/jessie

<a class="link" href="GVolume.html#g-volume-eject-with-operation-finish" title="g_volume_eject_with_operation_finish ()">g_volume_eject_with_operation_finish</a> ()

187

</td>

188

</tr>

189

<tr>

190

<td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *

190

<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *

191

</td>

192

193

<a class="link" href="GVolume.html#g-volume-get-sort-key" title="g_volume_get_sort_key ()">g_volume_get_sort_key</a> ()

263

</div>

264

265

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

266

<pre class="screen"> GInterface

266

<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/GTypeModule.html">GInterface</a>

267

╰── GVolume

268

</pre>

269

</div>

271

<a name="GVolume.prerequisites"></a><h2>Prerequisites</h2>

272

273

GVolume requires

274

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

274

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

275

</div>

276

277

<a name="GVolume.includes"></a><h2>Includes</h2>

288

<a class="link" href="GTask.html" title="GTask">GTask</a>. To mount a <a class="link" href="GVolume.html" title="GVolume">GVolume</a>, first call <a class="link" href="GVolume.html#g-volume-mount" title="g_volume_mount ()"><code class="function">g_volume_mount()</code></a> with (at

289

least) the <a class="link" href="GVolume.html" title="GVolume">GVolume</a> instance, optionally a <a class="link" href="GMountOperation.html" title="GMountOperation">GMountOperation</a> object

290

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

291

Typically, one will only want to pass <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for the

291

Typically, one will only want to pass <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for the

292

<a class="link" href="GMountOperation.html" title="GMountOperation">GMountOperation</a> if automounting all volumes when a desktop session

293

starts since it's not desirable to put up a lot of dialogs asking

294

for credentials.

345

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

346

the name for the given <code>volume</code>

347

. The returned string should

348

be freed with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when no longer needed.

348

be freed with <a href="../glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when no longer needed.

349

350

</div>

351

</div>

357

Gets the UUID for the <code>volume</code>

358

. The reference is typically based on

359

the file system UUID for the volume in question and should be

360

considered an opaque string. Returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if there is no UUID

360

considered an opaque string. Returns <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if there is no UUID

361

available.

362

363

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

377

378

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

379

the UUID for <code>volume</code>

380

or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no UUID can be computed.

381

The returned string should be freed with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>

380

or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no UUID can be computed.

381

The returned string should be freed with <a href="../glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>

382

when no longer needed.

383

384

</div>

408

409

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

410

a <a class="link" href="GIcon.html" title="GIcon">GIcon</a>.

411

The returned object should be unreffed with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>

411

The returned object should be unreffed with <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>

412

when no longer needed.

413

[<acronym title="Free data after the code is done.">transfer full</acronym>]

414

</div>

438

439

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

440

a <a class="link" href="GIcon.html" title="GIcon">GIcon</a>.

441

The returned object should be unreffed with <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>

442

when no longer needed.

443

[<acronym title="Free data after the code is done.">transfer full</acronym>]

444

</div>

468

</div>

469

470

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

471

a <a class="link" href="GDrive.html" title="GDrive">GDrive</a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <code>volume</code>

471

a <a class="link" href="GDrive.html" title="GDrive">GDrive</a> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <code>volume</code>

472

is not

473

associated with a drive. The returned object should be unreffed

474

with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when no longer needed.

474

with <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when no longer needed.

475

[<acronym title="Free data after the code is done.">transfer full</acronym>]

476

</div>

477

</div>

499

</div>

500

501

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

502

a <a class="link" href="GMount.html" title="GMount">GMount</a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <code>volume</code>

502

a <a class="link" href="GMount.html" title="GMount">GMount</a> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <code>volume</code>

503

isn't mounted.

504

The returned object should be unreffed with <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>

505

when no longer needed.

506

[<acronym title="Free data after the code is done.">transfer full</acronym>]

507

</div>

509

<hr>

510

511

<a name="g-volume-can-mount"></a><h3>g_volume_can_mount ()</h3>

512

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

512

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

513

g_volume_can_mount (<code><a class="link" href="GVolume.html" title="GVolume">GVolume</a> *volume</code>);</pre>

514

Checks if a volume can be mounted.

515

529

</div>

530

531

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

532

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

533

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

532

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

533

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

534

535

</div>

536

</div>

537

<hr>

538

539

<a name="g-volume-should-automount"></a><h3>g_volume_should_automount ()</h3>

540

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

540

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

541

g_volume_should_automount (<code><a class="link" href="GVolume.html" title="GVolume">GVolume</a> *volume</code>);</pre>

542

Returns whether the volume should be automatically mounted.

543

557

</div>

558

559

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

560

<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the volume should be automatically mounted

560

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the volume should be automatically mounted

561

562

</div>

563

</div>

567

<pre class="programlisting"><a class="link" href="GFile.html" title="GFile">GFile</a> *

568

g_volume_get_activation_root (<code><a class="link" href="GVolume.html" title="GVolume">GVolume</a> *volume</code>);</pre>

569

Gets the activation root for a <a class="link" href="GVolume.html" title="GVolume">GVolume</a> if it is known ahead of

570

mount time. Returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> otherwise. If not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> and if <code>volume</code>

570

mount time. Returns <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> otherwise. If not <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> and if <code>volume</code>

571

572

is mounted, then the result of <a class="link" href="GMount.html#g-mount-get-root" title="g_mount_get_root ()"><code class="function">g_mount_get_root()</code></a> on the

573

<a class="link" href="GMount.html" title="GMount">GMount</a> object obtained from <a class="link" href="GVolume.html#g-volume-get-mount" title="g_volume_get_mount ()"><code class="function">g_volume_get_mount()</code></a> will always

584

585

586

7</pre></td>

587

<td class="listing_code"><pre class="programlisting">GMount *mount;

588

GFile *mount_root

589

GFile *volume_activation_root;

587

<td class="listing_code"><pre class="programlisting">GMount *mount;

588

GFile *mount_root

589

GFile *volume_activation_root;

590

591

mount = <a href="GVolume.html#g-volume-get-mount">g_volume_get_mount</a> (volume); // mounted, so never NULL

592

mount_root = <a href="GMount.html#g-mount-get-root">g_mount_get_root</a> (mount);

593

volume_activation_root = <a href="GVolume.html#g-volume-get-activation-root">g_volume_get_activation_root</a> (volume); // assume not NULL</pre></td>

591

mount = <a href="GVolume.html#g-volume-get-mount">g_volume_get_mount</a> (volume); // mounted, so never NULL

592

mount_root = <a href="GMount.html#g-mount-get-root">g_mount_get_root</a> (mount);

593

volume_activation_root = <a href="GVolume.html#g-volume-get-activation-root">g_volume_get_activation_root</a> (volume); // assume not NULL</pre></td>

594

</tr>

595

</tbody>

596

</table>

604

<tr>

605

<td class="listing_lines" align="right"><pre>1

606

2</pre></td>

607

<td class="listing_code"><pre class="programlisting">(<a href="GFile.html#g-file-has-prefix">g_file_has_prefix</a> (volume_activation_root, mount_root) ||

608

<a href="GFile.html#g-file-equal">g_file_equal</a> (volume_activation_root, mount_root))</pre></td>

607

<td class="listing_code"><pre class="programlisting">(<a href="GFile.html#g-file-has-prefix">g_file_has_prefix</a> (volume_activation_root, mount_root) ||

608

<a href="GFile.html#g-file-equal">g_file_equal</a> (volume_activation_root, mount_root))</pre></td>

609

</tr>

610

</tbody>

611

</table>

612

</div>

613

614

615

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

615

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

616

Activation roots are typically used in <a class="link" href="GVolumeMonitor.html" title="GVolumeMonitor">GVolumeMonitor</a>

617

implementations to find the underlying mount to shadow, see

618

<a class="link" href="GMount.html#g-mount-is-shadowed" title="g_mount_is_shadowed ()"><code class="function">g_mount_is_shadowed()</code></a> for more details.

634

635

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

636

the activation root of <code>volume</code>

637

or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. Use <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> to free.

637

or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. Use <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> to free.

638

[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value.">nullable</acronym>][<acronym title="Free data after the code is done.">transfer full</acronym>]

639

</div>

640

Since 2.18

648

<code><a class="link" href="GMountOperation.html" title="GMountOperation">GMountOperation</a> *mount_operation</code>,

649

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

650

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

651

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

651

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

652

Mounts a volume. This is an asynchronous operation, and is

653

finished by calling <a class="link" href="GVolume.html#g-volume-mount-finish" title="g_volume_mount_finish ()"><code class="function">g_volume_mount_finish()</code></a> with the <code>volume</code>

654

676

</tr>

677

<tr>

678

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

679

<td class="parameter_description"> a <a class="link" href="GMountOperation.html" title="GMountOperation">GMountOperation</a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to avoid user interaction. </td>

679

<td class="parameter_description"> a <a class="link" href="GMountOperation.html" title="GMountOperation">GMountOperation</a> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to avoid user interaction. </td>

680

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

681

</tr>

682

<tr>

683

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

684

<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>

684

<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>

685

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

686

</tr>

687

<tr>

688

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

689

<td class="parameter_description"> a <a class="link" href="GAsyncResult.html#GAsyncReadyCallback" title="GAsyncReadyCallback ()">GAsyncReadyCallback</a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

689

<td class="parameter_description"> a <a class="link" href="GAsyncResult.html#GAsyncReadyCallback" title="GAsyncReadyCallback ()">GAsyncReadyCallback</a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

690

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

691

</tr>

692

<tr>

702

<hr>

703

704

<a name="g-volume-mount-finish"></a><h3>g_volume_mount_finish ()</h3>

705

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

705

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

706

g_volume_mount_finish (<code><a class="link" href="GVolume.html" title="GVolume">GVolume</a> *volume</code>,

707

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

708

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

708

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

709

Finishes mounting a volume. If any errors occurred during the operation,

710

<code>error</code>

711

will be set to contain the errors and <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> will be returned.

711

will be set to contain the errors and <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> will be returned.

712

If the mount operation succeeded, <a class="link" href="GVolume.html#g-volume-get-mount" title="g_volume_get_mount ()"><code class="function">g_volume_get_mount()</code></a> on <code>volume</code>

713

714

is guaranteed to return the mount right after calling this

735

</tr>

736

<tr>

737

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

738

<td class="parameter_description">a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> location to store an error, 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>

738

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

739

740

</tr>

741

</tbody>

743

</div>

744

745

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

746

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

746

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

747

748

</div>

749

</div>

750

<hr>

751

752

<a name="g-volume-can-eject"></a><h3>g_volume_can_eject ()</h3>

753

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

753

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

754

g_volume_can_eject (<code><a class="link" href="GVolume.html" title="GVolume">GVolume</a> *volume</code>);</pre>

755

Checks if a volume can be ejected.

756

770

</div>

771

772

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

773

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

774

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

773

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

774

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

775

776

</div>

777

</div>

783

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

784

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

785

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

786

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

786

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

787

788

<code class="literal">g_volume_eject</code> has been deprecated since version 2.22 and should not be used in newly-written code.

789

Use <a class="link" href="GVolume.html#g-volume-eject-with-operation" title="g_volume_eject_with_operation ()"><code class="function">g_volume_eject_with_operation()</code></a> instead.

814

</tr>

815

<tr>

816

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

817

<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>

818

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

819

</tr>

820

<tr>

821

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

822

<td class="parameter_description"> a <a class="link" href="GAsyncResult.html#GAsyncReadyCallback" title="GAsyncReadyCallback ()">GAsyncReadyCallback</a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

823

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

824

</tr>

825

<tr>

835

<hr>

836

837

<a name="g-volume-eject-finish"></a><h3>g_volume_eject_finish ()</h3>

838

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

838

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

839

g_volume_eject_finish (<code><a class="link" href="GVolume.html" title="GVolume">GVolume</a> *volume</code>,

840

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

841

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

841

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

842

843

<code class="literal">g_volume_eject_finish</code> has been deprecated since version 2.22 and should not be used in newly-written code.

844

Use <a class="link" href="GVolume.html#g-volume-eject-with-operation-finish" title="g_volume_eject_with_operation_finish ()"><code class="function">g_volume_eject_with_operation_finish()</code></a> instead.

845

</div>

846

Finishes ejecting a volume. If any errors occurred during the operation,

847

<code>error</code>

848

will be set to contain the errors and <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> will be returned.

848

will be set to contain the errors and <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> will be returned.

849

850

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

851

867

</tr>

868

<tr>

869

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

870

871

872

</tr>

873

</tbody>

875

</div>

876

877

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

878

879

880

</div>

881

</div>

888

<code><a class="link" href="GMountOperation.html" title="GMountOperation">GMountOperation</a> *mount_operation</code>,

889

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

890

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

891

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

891

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

892

Ejects a volume. This is an asynchronous operation, and is

893

finished by calling <a class="link" href="GVolume.html#g-volume-eject-with-operation-finish" title="g_volume_eject_with_operation_finish ()"><code class="function">g_volume_eject_with_operation_finish()</code></a> with the <code>volume</code>

894

915

</tr>

916

<tr>

917

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

918

<td class="parameter_description"> a <a class="link" href="GMountOperation.html" title="GMountOperation">GMountOperation</a> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to

919

avoid user interaction. </td>

920

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

921

</tr>

922

<tr>

923

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

924

<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>

925

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

926

</tr>

927

<tr>

928

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

929

<td class="parameter_description"> a <a class="link" href="GAsyncResult.html#GAsyncReadyCallback" title="GAsyncReadyCallback ()">GAsyncReadyCallback</a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </td>

930

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

931

</tr>

932

<tr>

943

<hr>

944

945

<a name="g-volume-eject-with-operation-finish"></a><h3>g_volume_eject_with_operation_finish ()</h3>

946

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

946

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

947

g_volume_eject_with_operation_finish (<code><a class="link" href="GVolume.html" title="GVolume">GVolume</a> *volume</code>,

948

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

949

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

949

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

950

Finishes ejecting a volume. If any errors occurred during the operation,

951

<code>error</code>

952

will be set to contain the errors and <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> will be returned.

952

will be set to contain the errors and <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> will be returned.

953

954

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

955

971

</tr>

972

<tr>

973

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

974

<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></td>

974

<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></td>

975

976

</tr>

977

</tbody>

979

</div>

980

981

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

982

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

982

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

983

984

</div>

985

Since 2.22

1009

</div>

1010

1011

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

1012

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

1013

of strings containing kinds of identifiers. Use <a href="http://library.gnome.org/devel/glib/unstable/glib-String-Utility-Functions.html#g-strfreev"><code class="function">g_strfreev()</code></a> to free.

1012

a <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated array

1013

of strings containing kinds of identifiers. Use <a href="../glib/glib-String-Utility-Functions.html#g-strfreev"><code class="function">g_strfreev()</code></a> to free.

1014

[<acronym title="Parameter points to an array of items.">array</acronym> zero-terminated=1][<acronym title="Free data after the code is done.">transfer full</acronym>]

1015

</div>

1016

</div>

1049

1050

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

1051

a newly allocated string containing the

1052

requested identfier, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the <a class="link" href="GVolume.html" title="GVolume">GVolume</a>

1052

requested identfier, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the <a class="link" href="GVolume.html" title="GVolume">GVolume</a>

1053

doesn't have this kind of identifier

1054

1055

</div>

1057

<hr>

1058

1059

<a name="g-volume-get-sort-key"></a><h3>g_volume_get_sort_key ()</h3>

1060

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

1060

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

1061

g_volume_get_sort_key (<code><a class="link" href="GVolume.html" title="GVolume">GVolume</a> *volume</code>);</pre>

1062

Gets the sort key for <code>volume</code>

1063

, if any.

1079

1080

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

1081

Sorting key for <code>volume</code>

1082

or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no such key is available

1082

or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no such key is available

1083

1084

</div>

1085

Since 2.32

1163

</colgroup>

1164

<tbody>

1165

<tr>

1166

<td class="struct_member_name"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GTypeInterface">GTypeInterface</a> <code><a name="GVolumeIface.g-iface"></a>g_iface</code>;</td>

1166

<td class="struct_member_name"><a href="../gobject/gobject-Type-Information.html#GTypeInterface">GTypeInterface</a> <code><a name="GVolumeIface.g-iface"></a>g_iface</code>;</td>

1167

<td class="struct_member_description">The parent interface.</td>

1168

1169

</tr>

1189

</tr>

1190

<tr>

1191

1192

<td class="struct_member_description">Gets the UUID for the <a class="link" href="GVolume.html" title="GVolume">GVolume</a>. The reference is typically based on the file system UUID for the mount in question and should be considered an opaque string. Returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if there is no UUID available.</td>

1192

<td class="struct_member_description">Gets the UUID for the <a class="link" href="GVolume.html" title="GVolume">GVolume</a>. The reference is typically based on the file system UUID for the mount in question and should be considered an opaque string. Returns <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if there is no UUID available.</td>

1193

1194

</tr>

1195

<tr>

1196

<td class="struct_member_name"><code><a name="GVolumeIface.get-drive"></a>get_drive</code> ()</td>

1197

<td class="struct_member_description">Gets a <a class="link" href="GDrive.html" title="GDrive">GDrive</a> the volume is located on. Returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the <a class="link" href="GVolume.html" title="GVolume">GVolume</a> is not associated with a <a class="link" href="GDrive.html" title="GDrive">GDrive</a>.</td>

1197

<td class="struct_member_description">Gets a <a class="link" href="GDrive.html" title="GDrive">GDrive</a> the volume is located on. Returns <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the <a class="link" href="GVolume.html" title="GVolume">GVolume</a> is not associated with a <a class="link" href="GDrive.html" title="GDrive">GDrive</a>.</td>

1198

1199

</tr>

1200

<tr>

1201

<td class="struct_member_name"><code><a name="GVolumeIface.get-mount"></a>get_mount</code> ()</td>

1202

<td class="struct_member_description">Gets a <a class="link" href="GMount.html" title="GMount">GMount</a> representing the mounted volume. Returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the <a class="link" href="GVolume.html" title="GVolume">GVolume</a> is not mounted.</td>

1202

<td class="struct_member_description">Gets a <a class="link" href="GMount.html" title="GMount">GMount</a> representing the mounted volume. Returns <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the <a class="link" href="GVolume.html" title="GVolume">GVolume</a> is not mounted.</td>

1203

1204

</tr>

1205

<tr>

1206

<td class="struct_member_name"><code><a name="GVolumeIface.can-mount"></a>can_mount</code> ()</td>

1207

<td class="struct_member_description">Returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the <a class="link" href="GVolume.html" title="GVolume">GVolume</a> can be mounted.</td>

1207

<td class="struct_member_description">Returns <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the <a class="link" href="GVolume.html" title="GVolume">GVolume</a> can be mounted.</td>

1208

1209

</tr>

1210

<tr>

1237

</tr>

1238

<tr>

1239

<td class="struct_member_name"><code><a name="GVolumeIface.get-identifier"></a>get_identifier</code> ()</td>

1240

<td class="struct_member_description">Returns the <a class="link" href="GVolume.html#volume-identifier" title="Volume Identifiers">identifier</a> of the given kind, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if

1240

<td class="struct_member_description">Returns the <a class="link" href="GVolume.html#volume-identifier" title="Volume Identifiers">identifier</a> of the given kind, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if

1241

the <a class="link" href="GVolume.html" title="GVolume">GVolume</a> doesn't have one.</td>

1242

1243

</tr>

1249

</tr>

1250

<tr>

1251

<td class="struct_member_name"><code><a name="GVolumeIface.should-automount"></a>should_automount</code> ()</td>

1252

1253

1254

</tr>

1255

<tr>

1256

<td class="struct_member_name"><code><a name="GVolumeIface.get-activation-root"></a>get_activation_root</code> ()</td>

1257

<td class="struct_member_description">Returns the activation root for the <a class="link" href="GVolume.html" title="GVolume">GVolume</a> if it is known in advance or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if

1257

<td class="struct_member_description">Returns the activation root for the <a class="link" href="GVolume.html" title="GVolume">GVolume</a> if it is known in advance or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if

1258

it is not known.</td>

1259

1260

</tr>

1270

</tr>

1271

<tr>

1272

1273

<td class="struct_member_description">Gets a key used for sorting <a class="link" href="GVolume.html" title="GVolume">GVolume</a> instance or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no such key exists. Since 2.32.</td>

1273

<td class="struct_member_description">Gets a key used for sorting <a class="link" href="GVolume.html" title="GVolume">GVolume</a> instance or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no such key exists. Since 2.32.</td>

1274

1275

</tr>

1276

<tr>

1337

<a name="GVolume-changed"></a><h3>The <code class="literal">“changed”</code> signal</h3>

1338

<pre class="programlisting">void

1339

user_function (<a class="link" href="GVolume.html" title="GVolume">GVolume</a> *arg0,

1340

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

1340

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

1341

Emitted when the volume has been changed.

1342

1343

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

1361

<a name="GVolume-removed"></a><h3>The <code class="literal">“removed”</code> signal</h3>

1362

<pre class="programlisting">void

1363

user_function (<a class="link" href="GVolume.html" title="GVolume">GVolume</a> *arg0,

1364

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

1364

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

1365

This signal is emitted when the <a class="link" href="GVolume.html" title="GVolume">GVolume</a> have been removed. If

1366

the recipient is holding references to the object they should

1367

release them so the object can be finalized.

Older »