summaryrefslogtreecommitdiffstats
path: root/guestfs-actions.pod
diff options
context:
space:
mode:
authorRichard Jones <rjones@redhat.com>2009-04-18 15:31:53 +0100
committerRichard Jones <rjones@redhat.com>2009-04-18 15:31:53 +0100
commitef499de8946cf4b8120ef7917b2e5d7f9115041f (patch)
tree8972aedf961b05a1d836ab15dcf946e837d12b42 /guestfs-actions.pod
parentad1d84a142169baaed293de71fb9430178d9f999 (diff)
downloadlibguestfs-ef499de8946cf4b8120ef7917b2e5d7f9115041f.tar.gz
libguestfs-ef499de8946cf4b8120ef7917b2e5d7f9115041f.tar.xz
libguestfs-ef499de8946cf4b8120ef7917b2e5d7f9115041f.zip
Separate out the high-level API actions.
- Split out the high-level API actions so that they are in a separate file, and use the defined guestfs C API, instead of fiddling around with internal structures.
Diffstat (limited to 'guestfs-actions.pod')
-rw-r--r--guestfs-actions.pod55
1 files changed, 55 insertions, 0 deletions
diff --git a/guestfs-actions.pod b/guestfs-actions.pod
index 520425cc..8667340a 100644
--- a/guestfs-actions.pod
+++ b/guestfs-actions.pod
@@ -520,6 +520,17 @@ return the default path.
This function returns a string, or NULL on error.
The string is owned by the guest handle and must I<not> be freed.
+=head2 guestfs_get_state
+
+ int guestfs_get_state (guestfs_h *handle);
+
+This returns the current state as an opaque integer. This is
+only useful for printing debug and internal error messages.
+
+For more information on states, see L<guestfs(3)>.
+
+On error this function returns -1.
+
=head2 guestfs_get_verbose
int guestfs_get_verbose (guestfs_h *handle);
@@ -528,6 +539,28 @@ This returns the verbose messages flag.
This function returns a C truth value on success or -1 on error.
+=head2 guestfs_is_busy
+
+ int guestfs_is_busy (guestfs_h *handle);
+
+This returns true iff this handle is busy processing a command
+(in the C<BUSY> state).
+
+For more information on states, see L<guestfs(3)>.
+
+This function returns a C truth value on success or -1 on error.
+
+=head2 guestfs_is_config
+
+ int guestfs_is_config (guestfs_h *handle);
+
+This returns true iff this handle is being configured
+(in the C<CONFIG> state).
+
+For more information on states, see L<guestfs(3)>.
+
+This function returns a C truth value on success or -1 on error.
+
=head2 guestfs_is_dir
int guestfs_is_dir (guestfs_h *handle,
@@ -554,6 +587,28 @@ See also C<guestfs_stat>.
This function returns a C truth value on success or -1 on error.
+=head2 guestfs_is_launching
+
+ int guestfs_is_launching (guestfs_h *handle);
+
+This returns true iff this handle is launching the subprocess
+(in the C<LAUNCHING> state).
+
+For more information on states, see L<guestfs(3)>.
+
+This function returns a C truth value on success or -1 on error.
+
+=head2 guestfs_is_ready
+
+ int guestfs_is_ready (guestfs_h *handle);
+
+This returns true iff this handle is ready to accept commands
+(in the C<READY> state).
+
+For more information on states, see L<guestfs(3)>.
+
+This function returns a C truth value on success or -1 on error.
+
=head2 guestfs_kill_subprocess
int guestfs_kill_subprocess (guestfs_h *handle);