Blame docs/libvirt-gobject/html/GVirStorageVol.html

Packit a07778
Packit a07778
<html>
Packit a07778
<head>
Packit a07778
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit a07778
<title>GVirStorageVol: Libvirt-gobject Reference Manual</title>
Packit a07778
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
Packit a07778
<link rel="home" href="index.html" title="Libvirt-gobject Reference Manual">
Packit a07778
<link rel="up" href="ch01.html" title="Libvirt-gobject">
Packit a07778
<link rel="prev" href="GVirStoragePool.html" title="GVirStoragePool">
Packit a07778
<link rel="next" href="GVirStream.html" title="GVirStream">
Packit a07778
<meta name="generator" content="GTK-Doc V1.29 (XML mode)">
Packit a07778
<link rel="stylesheet" href="style.css" type="text/css">
Packit a07778
</head>
Packit a07778
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit a07778
Packit a07778
Packit a07778
Top  | 
Packit a07778
                  Description  | 
Packit a07778
                  Object Hierarchy  | 
Packit a07778
                  Properties
Packit a07778
Packit a07778
Home
Packit a07778
Up
Packit a07778
Prev
Packit a07778
Next
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

GVirStorageVol

Packit a07778

GVirStorageVol

Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

Functions

Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
const gchar *
Packit a07778
Packit a07778
Packit a07778
gvir_storage_vol_get_name ()
Packit a07778
Packit a07778
Packit a07778
Packit a07778
const gchar *
Packit a07778
Packit a07778
Packit a07778
gvir_storage_vol_get_path ()
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
gboolean
Packit a07778
Packit a07778
Packit a07778
gvir_storage_vol_delete ()
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
GVirConfigStorageVol *
Packit a07778
Packit a07778
Packit a07778
gvir_storage_vol_get_config ()
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
GVirStorageVolInfo *
Packit a07778
Packit a07778
Packit a07778
gvir_storage_vol_get_info ()
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
gboolean
Packit a07778
Packit a07778
Packit a07778
gvir_storage_vol_resize ()
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
gboolean
Packit a07778
Packit a07778
Packit a07778
gvir_storage_vol_download ()
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
gboolean
Packit a07778
Packit a07778
Packit a07778
gvir_storage_vol_upload ()
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

Properties

Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
GVirStorageVolHandle *
Packit a07778
handle
Packit a07778
Read / Write / Construct Only
Packit a07778
Packit a07778
Packit a07778
Packit a07778
GVirStoragePool *
Packit a07778
pool
Packit a07778
Read / Write / Construct Only
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

Types and Values

Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
enum
Packit a07778
GVirStorageVolType
Packit a07778
Packit a07778
Packit a07778
enum
Packit a07778
GVirStorageVolResizeFlags
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

Object Hierarchy

Packit a07778
    GBoxed
Packit a07778
    ╰── GVirStorageVolInfo
Packit a07778
    GObject
Packit a07778
    ╰── GVirStorageVol
Packit a07778
Packit a07778
Packit a07778
Packit a07778

Description

Packit a07778
Packit a07778
Packit a07778

Functions

Packit a07778
Packit a07778

gvir_storage_vol_get_name ()

Packit a07778
const gchar *
Packit a07778
gvir_storage_vol_get_name (GVirStorageVol *vol);
Packit a07778
Packit a07778

Packit a07778
Packit a07778

gvir_storage_vol_get_path ()

Packit a07778
const gchar *
Packit a07778
gvir_storage_vol_get_path (GVirStorageVol *vol,
Packit a07778
                           GError **error);
Packit a07778
Packit a07778

Packit a07778
Packit a07778

gvir_storage_vol_delete ()

Packit a07778
gboolean
Packit a07778
gvir_storage_vol_delete (GVirStorageVol *vol,
Packit a07778
                         guint flags,
Packit a07778
                         GError **err);
Packit a07778

Deletes the storage volume vol

Packit a07778
.

Packit a07778
Packit a07778

Parameters

Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

vol

Packit a07778

the storage volume to delete

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

flags

Packit a07778

the flags

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

err

Packit a07778

Return location for errors, or NULL

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

Returns

Packit a07778

TRUE on success, FALSE otherwise

Packit a07778
Packit a07778
Packit a07778

Packit a07778
Packit a07778

gvir_storage_vol_get_config ()

Packit a07778
GVirConfigStorageVol *
Packit a07778
gvir_storage_vol_get_config (GVirStorageVol *vol,
Packit a07778
                             guint flags,
Packit a07778
                             GError **err);
Packit a07778
Packit a07778

Parameters

Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

vol

Packit a07778

the storage_vol

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

flags

Packit a07778

the flags

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

err

Packit a07778

Place-holder for possible errors

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

Returns

Packit a07778

the config. The returned object should be

Packit a07778
unreffed with g_object_unref() when no longer needed. 

Packit a07778

[transfer full]

Packit a07778
Packit a07778
Packit a07778

Packit a07778
Packit a07778

gvir_storage_vol_get_info ()

Packit a07778
GVirStorageVolInfo *
Packit a07778
gvir_storage_vol_get_info (GVirStorageVol *vol,
Packit a07778
                           GError **err);
Packit a07778
Packit a07778

Parameters

Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

vol

Packit a07778

the storage_vol

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

err

Packit a07778

Place-holder for possible errors

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

Returns

Packit a07778

the info. The returned object should be

Packit a07778
unreffed with g_object_unref() when no longer needed. 

Packit a07778

[transfer full]

Packit a07778
Packit a07778
Packit a07778

Packit a07778
Packit a07778

gvir_storage_vol_resize ()

Packit a07778
gboolean
Packit a07778
gvir_storage_vol_resize (GVirStorageVol *vol,
Packit a07778
                         guint64 capacity,
Packit a07778
                         guint flags,
Packit a07778
                         GError **err);
Packit a07778

Changes the capacity of the storage volume vol

Packit a07778
 to capacity
Packit a07778
.

Packit a07778
Packit a07778

Parameters

Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

vol

Packit a07778

the storage volume to resize

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

capacity

Packit a07778

the new capacity of the volume

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

flags

Packit a07778

the flags.

Packit a07778
[type GVirStorageVolResizeFlags]
Packit a07778
Packit a07778
Packit a07778

err

Packit a07778

Return location for errors, or NULL

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

Returns

Packit a07778

TRUE success, FALSE otherwise

Packit a07778
Packit a07778
Packit a07778

Packit a07778
Packit a07778

gvir_storage_vol_download ()

Packit a07778
gboolean
Packit a07778
gvir_storage_vol_download (GVirStorageVol *vol,
Packit a07778
                           GVirStream *stream,
Packit a07778
                           guint64 offset,
Packit a07778
                           guint64 length,
Packit a07778
                           guint flags,
Packit a07778
                           GError **err);
Packit a07778
Packit a07778

Parameters

Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

vol

Packit a07778

the storage volume to download from

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

stream

Packit a07778

stream to use as output

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

offset

Packit a07778

position in vol

Packit a07778
to start reading from

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

length

Packit a07778

limit on amount of data to download, or 0 for downloading all data

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

flags

Packit a07778

extra flags, not used yet, pass 0

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

Returns

Packit a07778

TRUE of success, FALSE otherwise

Packit a07778
Packit a07778
Packit a07778

Packit a07778
Packit a07778

gvir_storage_vol_upload ()

Packit a07778
gboolean
Packit a07778
gvir_storage_vol_upload (GVirStorageVol *vol,
Packit a07778
                         GVirStream *stream,
Packit a07778
                         guint64 offset,
Packit a07778
                         guint64 length,
Packit a07778
                         guint flags,
Packit a07778
                         GError **err);
Packit a07778
Packit a07778

Parameters

Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

vol

Packit a07778

the storage volume to upload

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

stream

Packit a07778

stream to use as input

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

offset

Packit a07778

position in vol

Packit a07778
to start to write to

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

length

Packit a07778

limit on amount of data to upload, or 0 for uploading all data

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

flags

Packit a07778

the flags, not set yet, pass 0

Packit a07778
 
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

Returns

Packit a07778

TRUE of success, FALSE otherwise

Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

Types and Values

Packit a07778
Packit a07778

enum GVirStorageVolType

Packit a07778
Packit a07778

Members

Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

GVIR_STORAGE_VOL_STATE_FILE

Packit a07778
 
Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

GVIR_STORAGE_VOL_STATE_BLOCK

Packit a07778
 
Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

GVIR_STORAGE_VOL_STATE_DIR

Packit a07778
 
Packit a07778
 
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

Packit a07778
Packit a07778

enum GVirStorageVolResizeFlags

Packit a07778
Packit a07778

Members

Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

GVIR_STORAGE_VOL_RESIZE_NONE

Packit a07778
Packit a07778

No flags

Packit a07778
Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

GVIR_STORAGE_VOL_RESIZE_ALLOCATE

Packit a07778
Packit a07778

force allocation of new size

Packit a07778
Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

GVIR_STORAGE_VOL_RESIZE_DELTA

Packit a07778
Packit a07778

size is relative to current

Packit a07778
Packit a07778
 
Packit a07778
Packit a07778
Packit a07778

GVIR_STORAGE_VOL_RESIZE_SHRINK

Packit a07778
Packit a07778

allow decrease in capacity. This combined

Packit a07778
with GVIR_STORAGE_VOL_RESIZE_DELTA, implies a negative delta.

Packit a07778
Packit a07778
 
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

Property Details

Packit a07778
Packit a07778

The “handle” property

Packit a07778
  “handle”                   GVirStorageVolHandle *
Packit a07778

The storage_vol handle.

Packit a07778

Flags: Read / Write / Construct Only

Packit a07778
Packit a07778

Packit a07778
Packit a07778

The “pool” property

Packit a07778
  “pool”                     GVirStoragePool *
Packit a07778

The containing storage pool.

Packit a07778

Flags: Read / Write / Construct Only

Packit a07778
Packit a07778
Packit a07778
Packit a07778
Packit a07778

Generated by GTK-Doc V1.29
Packit a07778
</body>
Packit a07778
</html>