diff options
| author | Richard W.M. Jones <rjones@redhat.com> | 2011-04-30 18:31:06 -0400 |
|---|---|---|
| committer | Richard W.M. Jones <rjones@redhat.com> | 2011-04-30 18:31:06 -0400 |
| commit | dd86183f3f6d4d5ad28e1f12c56ba920934e7ad0 (patch) | |
| tree | 37e6db21cf986691bf979bd7694484f18344ec92 | |
| parent | 91b35746b438240c0b64a22afae630ecbce5e02d (diff) | |
| download | libguestfs-dd86183f3f6d4d5ad28e1f12c56ba920934e7ad0.tar.gz libguestfs-dd86183f3f6d4d5ad28e1f12c56ba920934e7ad0.tar.xz libguestfs-dd86183f3f6d4d5ad28e1f12c56ba920934e7ad0.zip | |
guestfs(3): Refresh documentation for guestfs_create, guestfs_close.
| -rw-r--r-- | src/guestfs.pod | 17 |
1 files changed, 12 insertions, 5 deletions
diff --git a/src/guestfs.pod b/src/guestfs.pod index 4e216f12..c6e5a289 100644 --- a/src/guestfs.pod +++ b/src/guestfs.pod @@ -1293,15 +1293,16 @@ L</MULTIPLE HANDLES AND MULTIPLE THREADS> below. Create a connection handle. -You have to call L</guestfs_add_drive_opts> (or one of the equivalent -calls) on the handle at least once. +On success this returns a non-NULL pointer to a handle. On error it +returns NULL. -This function returns a non-NULL pointer to a handle on success or -NULL on error. +You have to "configure" the handle after creating it. This includes +calling L</guestfs_add_drive_opts> (or one of the equivalent calls) on +the handle at least once. After configuring the handle, you have to call L</guestfs_launch>. -You may also want to configure error handling for the handle. See +You may also want to configure error handling for the handle. See the L</ERROR HANDLING> section below. =head2 guestfs_close @@ -1310,6 +1311,12 @@ L</ERROR HANDLING> section below. This closes the connection handle and frees up all resources used. +If autosync was set on the handle and the handle was launched, then +this implicitly calls various functions to unmount filesystems and +sync the disk. See L</guestfs_set_autosync> for more details. + +If a close callback was set on the handle, then it is called. + =head1 ERROR HANDLING API functions can return errors. For example, almost all functions |