From: Richard W.M. Jones Date: Sat, 30 Apr 2011 22:31:06 +0000 (-0400) Subject: guestfs(3): Refresh documentation for guestfs_create, guestfs_close. X-Git-Tag: 1.11.4~14 X-Git-Url: http://git.annexia.org/?a=commitdiff_plain;h=dd86183f3f6d4d5ad28e1f12c56ba920934e7ad0;p=libguestfs.git guestfs(3): Refresh documentation for guestfs_create, guestfs_close. --- diff --git a/src/guestfs.pod b/src/guestfs.pod index 4e216f1..c6e5a28 100644 --- a/src/guestfs.pod +++ b/src/guestfs.pod @@ -1293,15 +1293,16 @@ L below. Create a connection handle. -You have to call L (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 (or one of the equivalent calls) on +the handle at least once. After configuring the handle, you have to call L. -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 section below. =head2 guestfs_close @@ -1310,6 +1311,12 @@ L 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 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