diff --git a/ChangeLog b/ChangeLog index c3ed087a19..3d86d3283a 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +Thu Sep 21 10:19:02 EDT 2006 Daniel Berrange + + * docs/*.html: re-generated documentation to pull in latest + APIs + Thu Sep 21 10:19:01 CEST 2006 Daniel Veillard * src/Makefile.am: add a tst target to ease building test progs diff --git a/docs/APIchunk0.html b/docs/APIchunk0.html index 0c0d699e0b..cc81e4240d 100644 --- a/docs/APIchunk0.html +++ b/docs/APIchunk0.html @@ -58,7 +58,6 @@ virNodeGetInfo

Letter F:

For
virDomainGetUUIDString
Free
virDomainFree
-
Frees
virConfFree

Letter G:

Get
virConnectGetType
virConnectGetVersion
virDomainGetID
@@ -75,7 +74,6 @@

Letter K:

KBytes
_virDomainInfo

Letter L:

Launch
virDomainCreateLinux
Linux
virDomainCreateLinux
-
Lookup
virConfGetValue

Letter M:

Macro
LIBVIR_VERSION_NUMBER

Letter N:

NUMA
_virNodeInfo
Note
virDomainGetInfo
@@ -83,7 +81,6 @@ virDomainSetVcpus
virDomainShutdown

Letter O:

OUT
cpumap
-virConfWriteMem
virConnectGetVersion
virDomainGetVcpus
virGetVersion
@@ -93,12 +90,11 @@

Letter P:

Provide
virConnGetLastError
virDomainGetXMLDesc
virGetLastError
-
Provides
virConnectNumOfDomains
+
Provides
virConnectNumOfDefinedDomains
+virConnectNumOfDomains
virGetVersion

Letter R:

RFC4122
virDomainGetUUIDString
Read-Only
virConnectGetVersion
-
Reads
virConfReadFile
-virConfReadMem
Reboot
virDomainReboot
Reset
virConnResetLastError
virResetError
@@ -153,8 +149,6 @@
VIR_CPU_USABLE
VIR_CPU_USABLE
VIR_GET_CPUMAP
VIR_GET_CPUMAP

Letter W:

What
_virError
-
Writes
virConfWriteFile
-virConfWriteMem

Letter X:

XML
virDomainCreateLinux
virDomainDefineXML
virDomainGetXMLDesc
@@ -180,6 +174,7 @@
active
VIR_NODEINFO_MAXCPUS
_virNodeInfo
virConnectListDomains
+virConnectNumOfDefinedDomains
virConnectNumOfDomains
virDomainSuspend
add
virDomainShutdown
@@ -189,7 +184,6 @@
against
virGetVersion
alive
virDomainFree
all
VIR_CPU_MAPLEN
-virConfFree
virDomainDestroy
virDomainGetVcpus
allocated
cpumap
@@ -219,7 +213,6 @@ virDomainDestroy
virDomainPinVcpu
virSetErrorFunc
-
area
virConfWriteMem
argument
virConnectOpen
virConnectOpenReadOnly
array
VIR_COPY_CPUMAP
@@ -230,12 +223,9 @@ virDomainGetUUID
virDomainGetUUIDString
virDomainGetVcpus
-
associated
virConfFree
-virConfGetValue
assumed
virDomainGetVcpus
virGetVersion
available
_virError
-virConfWriteMem
virConnectOpenReadOnly
availble
virGetVersion
avoid
virInitialize
diff --git a/docs/APIchunk1.html b/docs/APIchunk1.html index ce69ca22ec..9b168150fb 100644 --- a/docs/APIchunk1.html +++ b/docs/APIchunk1.html @@ -5,9 +5,7 @@ g-n o-s t-z -

Letter b:

back
virConfWriteFile
-virConfWriteMem
-virConnSetErrorFunc
+

Letter b:

back
virConnSetErrorFunc
virDomainDestroy
virGetVersion
based
virDomainCreateLinux
@@ -35,22 +33,17 @@ virDomainSuspend
virDomainUndefine
virGetLastError
-
byte
virConfReadMem
-virConfWriteMem
-virDomainPinVcpu
+
byte
virDomainPinVcpu
bytes
VIR_CPU_MAPLEN
cpumap
cpumaps
maplen
-virConfWriteFile
-virConfWriteMem
virDomainGetUUID
virDomainGetUUIDString
virDomainGetVcpus
virDomainPinVcpu

Letter c:

calculate
VIR_NODEINFO_MAXCPUS
-
call
virConfWriteMem
-virConnectGetVersion
+
call
virConnectGetVersion
virDomainCreate
virDomainDestroy
virDomainSave
@@ -59,8 +52,7 @@
callback
virConnSetErrorFunc
virErrorFunc
virSetErrorFunc
-
called
virConfGetValue
-virConnSetErrorFunc
+
called
virConnSetErrorFunc
virConnectClose
virConnectOpen
virConnectOpenReadOnly
@@ -70,8 +62,7 @@ virDomainGetXMLDesc
calling
virDomainResume
calloc
virDomainGetVcpus
-
can
virConfReadMem
-virConnectGetVersion
+
can
virConnectGetVersion
virDomainGetInfo
virDomainPinVcpu
capacities
virConnectGetVersion
@@ -98,15 +89,6 @@
command
_virDomainKernel
compiled
virGetVersion
complete
VIR_CPU_MAPLEN
-
conf
virConfWriteFile
-virConfWriteMem
-
config
virConfWriteMem
-
configuration
virConfFree
-virConfGetValue
-virConfReadFile
-virConfReadMem
-virConfWriteFile
-virConfWriteMem
conjonction
VIR_COPY_CPUMAP
VIR_CPU_MAPLEN
VIR_CPU_USABLE
@@ -114,8 +96,7 @@ VIR_UNUSE_CPU
VIR_USE_CPU
consequent
_virError
-
content
virConfReadMem
-virConnCopyLastError
+
content
virConnCopyLastError
virCopyLastError
contents
virDomainSave
control
virConnectOpenReadOnly
@@ -143,11 +124,7 @@
cupmap
virDomainGetVcpus
currently
virConnectOpen
virConnectOpenReadOnly
-

Letter d:

data
virConfFree
-virConfGetValue
-virConfReadFile
-virConfReadMem
-virConnSetErrorFunc
+

Letter d:

data
virConnSetErrorFunc
virDomainDestroy
virDomainFree
virErrorFunc
@@ -173,18 +150,15 @@ virDomainUndefine
domains
virConnectListDefinedDomains
virConnectListDomains
+virConnectNumOfDefinedDomains
virConnectNumOfDomains
virConnectOpenReadOnly
virDomainCreate
down
virDomainDestroy
driver
virGetVersion
-
due
virConfWriteMem

Letter e:

each
virDomainPinVcpu
-
element
_virConfValue
encoded
virDomainGetXMLDesc
-
entry
virConfGetValue
especially
virConnectClose
-
even
virConfWriteMem
expected
_virNodeInfo
extra
_virError
virDomainReboot
@@ -193,10 +167,6 @@ virDomainGetInfo
extraction
virDomainGetXMLDesc

Letter f:

fail
virDomainSetVcpus
-
failed
virConfGetValue
-virConfReadFile
-virConfReadMem
-
fails
virConfWriteMem
failure
virDomainCreateLinux
virDomainDestroy
virDomainFree
@@ -218,13 +188,7 @@ virDomainSuspend
virGetVersion
virNodeGetInfo
-
file
virConfFree
-virConfGetValue
-virConfReadFile
-virConfReadMem
-virConfWriteFile
-virConfWriteMem
-virDomainSave
+
file
virDomainSave
filename
_virDomainKernel
filled
virDomainGetVcpus
find
virDomainLookupByID
@@ -234,7 +198,6 @@ virDomainReboot
for
_virDomainInfo
_virNodeInfo
-virConfWriteMem
virConnGetLastError
virConnectGetVersion
virDomainDefineXML
@@ -259,15 +222,13 @@ virGetVersion
found
virConnCopyLastError
virConnectListDomains
+virConnectNumOfDefinedDomains
virConnectNumOfDomains
virCopyLastError
-
free
virConfReadFile
-virConfReadMem
-virConnCopyLastError
+
free
virConnCopyLastError
virCopyLastError
virDomainGetXMLDesc
-
freed
virConfGetValue
-virDomainDestroy
+
freed
virDomainDestroy
virDomainFree
virDomainGetOSType
frequency
_virNodeInfo
diff --git a/docs/APIchunk2.html b/docs/APIchunk2.html index c3ad83d585..04c66cde17 100644 --- a/docs/APIchunk2.html +++ b/docs/APIchunk2.html @@ -22,11 +22,7 @@
guest
virDomainCreateLinux
virDomainReboot
virDomainShutdown
-

Letter h:

handle
virConfFree
-virConfGetValue
-virConfReadFile
-virConfReadMem
-
handler
virConnSetErrorFunc
+

Letter h:

handler
virConnSetErrorFunc
virSetErrorFunc
handling
virConnSetErrorFunc
virSetErrorFunc
@@ -41,7 +37,6 @@
ignore
virDomainReboot
virDomainShutdown
image
_virDomainKernel
-
indicates
virConfWriteMem
indicating
_virNodeInfo
info
virDomainGetVcpus
information
_virError
@@ -58,9 +53,7 @@ virDomainDestroy
virDomainFree
virDomainGetXMLDesc
-
insufficient
virConfWriteMem
int
virDomainGetID
-
integer
_virConfValue
interaction
virConnectClose
into
VIR_COPY_CPUMAP
its
virDomainGetName
@@ -86,8 +79,6 @@ virDomainGetXMLDesc
launch
virDomainCreate
least
virDomainPinVcpu
-
lenght
virConfReadMem
-virConfWriteMem
length
VIR_CPU_MAPLEN
maplen
level
virConnectGetVersion
@@ -111,18 +102,12 @@
limited
virDomainGetInfo
virDomainSetVcpus
line
_virDomainKernel
-
list
_virConfValue
-virConnectListDefinedDomains
+
list
virConnectListDefinedDomains
virConnectListDomains
listed
virDomainSave
little-endian
virDomainPinVcpu
-
loaded
virConfReadMem
-
long
_virConfValue
looked
virGetVersion
-
lookup
virConfGetValue
-virConfReadFile
-virConfReadMem
-virDomainLookupByName
+
lookup
virDomainLookupByName
virDomainLookupByUUID
virDomainLookupByUUIDString
lowest
virDomainPinVcpu
@@ -164,8 +149,6 @@
mem
_virNodeInfo
memory
_virDomainInfo
_virNodeInfo
-virConfReadMem
-virConfWriteMem
virDomainGetMaxMemory
virDomainGetVcpus
virDomainSave
@@ -211,7 +194,6 @@ virDomainLookupByUUID
virDomainLookupByUUIDString
virDomainSetVcpus
-
next
_virConfValue
node
_virNodeInfo
virNodeGetInfo
non
VIR_CPU_USABLE
diff --git a/docs/APIchunk3.html b/docs/APIchunk3.html index 5d82d37a30..f1b99fbcc4 100644 --- a/docs/APIchunk3.html +++ b/docs/APIchunk3.html @@ -54,22 +54,16 @@ virCopyLastError
virDomainDefineXML
virGetVersion
-
output
virConfWriteMem
-virDomainSave
-

Letter p:

parameter
virConfWriteMem
-virConnCopyLastError
+
output
virDomainSave
+

Letter p:

parameter
virConnCopyLastError
virCopyLastError
parameters
_virDomainKernel
-
parse
virConfReadFile
-virConfReadMem
part
_virError
partial
virDomainGetInfo
pass
virConnSetErrorFunc
virConnectOpen
virConnectOpenReadOnly
-
path
virConfReadFile
-virConfWriteFile
-virDomainRestore
+
path
virDomainRestore
virDomainSave
per
_virNodeInfo
physical
VIR_CPU_MAPLEN
@@ -110,7 +104,6 @@
ramdisk
_virDomainKernel
raw
virDomainLookupByUUID
reactivate
virDomainSuspend
-
read
virConfReadFile
real
_virVcpuInfo
cpumap
virDomainGetVcpus
@@ -128,7 +121,6 @@
request
virDomainReboot
virDomainShutdown
required
VIR_CPU_MAPLEN
-virConfWriteMem
requires
virDomainCreateLinux
virDomainDestroy
virDomainPinVcpu
@@ -190,8 +182,6 @@ virDomainGetInfo
virDomainGetXMLDesc
virDomainPinVcpu
-
settings
virConfReadFile
-virConfReadMem
should
virConnectClose
virConnectOpen
virConnectOpenReadOnly
@@ -203,7 +193,6 @@
similar
virDomainCreateLinux
single
VIR_CPU_MAPLEN
size
_virNodeInfo
-virConfWriteMem
virConnectListDefinedDomains
virConnectListDomains
virDomainGetMaxMemory
@@ -213,7 +202,6 @@ virDomainSetMemory
socket
_virNodeInfo
software
virConnectGetType
-
space
virConfWriteMem
specified
VIR_COPY_CPUMAP
VIR_GET_CPUMAP
start
virDomainDefineXML
@@ -230,17 +218,14 @@
stopped
virDomainReboot
virDomainShutdown
store
VIR_CPU_MAPLEN
-virConfWriteMem
virConnectListDefinedDomains
virConnectListDomains
virConnectOpen
virDomainGetVcpus
stored
virDomainPinVcpu
stores
virConnectListDefinedDomains
-
string
_virConfValue
-_virError
+
string
_virError
_virNodeInfo
-virConfReadMem
virConnectGetType
virDomainGetName
virDomainGetOSType
@@ -252,8 +237,7 @@ virNodeGetInfo
structures
virDomainGetVcpus
succeed
virDomainCreate
-
success
virConfFree
-virConnectClose
+
success
virConnectClose
virDomainCreate
virDomainDestroy
virDomainFree
diff --git a/docs/APIchunk4.html b/docs/APIchunk4.html new file mode 100644 index 0000000000..1aaa27d398 --- /dev/null +++ b/docs/APIchunk4.html @@ -0,0 +1,195 @@ + + +API Alphabetic Index t-z for libvirt

API Alphabetic Index t-z for libvirt

A-a +b-f +g-n +o-s +t-z +

Letter t:

target
virConnCopyLastError
+virCopyLastError
+virDomainSetMemory
+
terminated
virConnectGetType
+virDomainGetXMLDesc
+
that
virConnCopyLastError
+virConnGetLastError
+virConnResetLastError
+virDomainGetInfo
+virDomainGetName
+virDomainPinVcpu
+virDomainReboot
+virDomainSetVcpus
+virDomainShutdown
+
their
virConnectListDomains
+
then
virConnectOpenReadOnly
+virDomainGetMaxMemory
+virDomainGetVcpus
+virDomainSetMaxMemory
+virDomainSetMemory
+
there
virConnectClose
+virDomainGetVcpus
+virDomainReboot
+virDomainShutdown
+virErrorFunc
+virSetErrorFunc
+
thereafter
virDomainDestroy
+virDomainFree
+
this
_virError
+virDomainGetMaxMemory
+virDomainGetVcpus
+virDomainSave
+virDomainSetMaxMemory
+virDomainSetMemory
+virDomainSetVcpus
+virInitialize
+
those
virSetErrorFunc
+
threads
_virNodeInfo
+
time
_virDomainInfo
+_virVcpuInfo
+
total
VIR_NODEINFO_MAXCPUS
+
true
VIR_CPU_USABLE
+
two
virGetVersion
+
type
virDomainGetOSType
+virGetVersion
+

Letter u:

undefine
virDomainUndefine
+
underlying
virDomainGetVcpus
+virDomainPinVcpu
+virDomainSetVcpus
+
uniform
_virNodeInfo
+
unknown
virGetVersion
+
unsigned
virDomainGetID
+
unused
virConnectOpen
+virConnectOpenReadOnly
+
usable
VIR_CPU_USABLE
+VIR_UNUSE_CPU
+VIR_USE_CPU
+virConnectOpenReadOnly
+virDomainPinVcpu
+virDomainReboot
+virDomainShutdown
+
use
virConnGetLastError
+virErrorFunc
+virGetLastError
+
used
VIR_COPY_CPUMAP
+VIR_CPU_MAPLEN
+VIR_CPU_USABLE
+VIR_GET_CPUMAP
+VIR_UNUSE_CPU
+VIR_USE_CPU
+_virDomainInfo
+_virVcpuInfo
+virConnectGetType
+virDomainDestroy
+virDomainFree
+virDomainGetInfo
+virDomainGetXMLDesc
+virDomainReboot
+virDomainSetVcpus
+virDomainSuspend
+
user
virConnSetErrorFunc
+virDomainGetInfo
+virErrorFunc
+virNodeGetInfo
+virSetErrorFunc
+

Letter v:

value
VIR_CPU_USABLE
+_virVcpuInfo
+virConnectGetVersion
+virDomainGetXMLDesc
+virGetVersion
+
values
virGetVersion
+
vcpu
VIR_COPY_CPUMAP
+VIR_CPU_USABLE
+VIR_GET_CPUMAP
+
vcpus
virDomainGetVcpus
+
version
LIBVIR_VERSION_NUMBER
+virConnectGetVersion
+virGetVersion
+
virConnCopyLastError
virConnGetLastError
+
virCopyLastError
virGetLastError
+
virDomainCreateLinux
virDomainGetXMLDesc
+
virDomainFlags
_virDomainInfo
+virDomainCreateLinux
+
virDomainGetVcpus
VIR_COPY_CPUMAP
+VIR_CPU_USABLE
+VIR_GET_CPUMAP
+
virDomainGetXMLDesc
virDomainCreateLinux
+
virDomainInfo
virDomainGetInfo
+
virDomainPinVcpu
VIR_COPY_CPUMAP
+VIR_CPU_MAPLEN
+VIR_GET_CPUMAP
+VIR_UNUSE_CPU
+VIR_USE_CPU
+virDomainGetVcpus
+
virDomainRestore
virDomainSave
+
virDomainResume
virDomainSuspend
+
virDomainSave
virDomainRestore
+
virError
virResetError
+
virErrorNumber
_virError
+
virNodeInfo
nodeinfo
+virNodeGetInfo
+
virResetError
virConnCopyLastError
+virCopyLastError
+
virSuspendDomain
virDomainResume
+
virVcpuInfo
virDomainGetVcpus
+
virVcpuState
_virVcpuInfo
+
virtual
VIR_CPU_MAPLEN
+_virDomainInfo
+_virVcpuInfo
+vcpu
+virDomainGetVcpus
+virDomainPinVcpu
+virDomainSetVcpus
+
virtualization
virDomainGetVcpus
+virDomainPinVcpu
+virDomainSetVcpus
+

Letter w:

was
virConnCopyLastError
+virCopyLastError
+virDomainResume
+virGetVersion
+
when
virErrorFunc
+virInitialize
+
where
virDomainGetMaxMemory
+virDomainResume
+virDomainSetMaxMemory
+virDomainSetMemory
+
which
virConnGetLastError
+virConnSetErrorFunc
+virConnectClose
+virDomainPinVcpu
+virGetLastError
+virGetVersion
+virSetErrorFunc
+
while
virGetVersion
+
will
virConnCopyLastError
+virConnSetErrorFunc
+virCopyLastError
+virDomainGetName
+virDomainRestore
+virDomainSave
+virDomainSuspend
+virGetVersion
+virSetErrorFunc
+
with
VIR_COPY_CPUMAP
+VIR_CPU_MAPLEN
+VIR_CPU_USABLE
+VIR_GET_CPUMAP
+VIR_UNUSE_CPU
+VIR_USE_CPU
+virConnCopyLastError
+virConnectClose
+virConnectGetVersion
+virCopyLastError
+virDomainGetXMLDesc
+
without
virDomainSuspend
+
work
virConnectGetVersion
+

Letter x:

xen
virConnectOpen
+

Letter y:

yet
virDomainGetXMLDesc
+virDomainReboot
+

Letter z:

zero
VIR_CPU_USABLE
+virConnectGetType
+virDomainPinVcpu
+

A-a +b-f +g-n +o-s +t-z +

main menu

related links

Graphics and design by Diana Fong

diff --git a/docs/APIconstructors.html b/docs/APIconstructors.html index f2f2246d7e..740e6a6c3b 100644 --- a/docs/APIconstructors.html +++ b/docs/APIconstructors.html @@ -2,9 +2,6 @@ List of constructors for libvirt diff --git a/docs/APIfunctions.html b/docs/APIfunctions.html index f9d2f8097a..31019e17d5 100644 --- a/docs/APIfunctions.html +++ b/docs/APIfunctions.html @@ -2,8 +2,7 @@ List of function manipulating types in libvirt

List of function manipulating types in libvirt

Type const char **:

virConnectListDefinedDomains

Type const unsigned char *:

virDomainLookupByUUID
-

Type int *:

virConfWriteMem
-virConnectListDomains
+

Type int *:

virConnectListDomains

Type unsigned char *:

virDomainGetUUID
virDomainGetVcpus
virDomainPinVcpu
@@ -15,10 +14,6 @@ virDomainSetMemory

Type unsigned long *:

virConnectGetVersion
virGetVersion
-

Type virConfPtr:

virConfFree
-virConfGetValue
-virConfWriteFile
-virConfWriteMem

Type virConnectPtr:

virConnCopyLastError
virConnGetLastError
virConnResetLastError
@@ -28,6 +23,7 @@ virConnectGetVersion
virConnectListDefinedDomains
virConnectListDomains
+virConnectNumOfDefinedDomains
virConnectNumOfDomains
virDomainCreateLinux
virDomainDefineXML
diff --git a/docs/APIsymbols.html b/docs/APIsymbols.html index 9e45b3ef24..4ff9205e74 100644 --- a/docs/APIsymbols.html +++ b/docs/APIsymbols.html @@ -1,11 +1,7 @@ Alphabetic List of Symbols in libvirt

Alphabetic List of Symbols in libvirt

Letter L:

LIBVIR_VERSION_NUMBER
-

Letter V:

VIR_CONF_LIST
-VIR_CONF_LONG
-VIR_CONF_NONE
-VIR_CONF_STRING
-VIR_COPY_CPUMAP
+

Letter V:

VIR_COPY_CPUMAP
VIR_CPU_MAPLEN
VIR_CPU_USABLE
VIR_DEVICE_DEFAULT
@@ -79,24 +75,12 @@ VIR_VCPU_BLOCKED
VIR_VCPU_OFFLINE
VIR_VCPU_RUNNING
-

Letter _:

_virConfValue
-_virDomainInfo
+

Letter _:

_virDomainInfo
_virDomainKernel
_virError
_virNodeInfo
_virVcpuInfo
-

Letter v:

virConf
-virConfFree
-virConfGetValue
-virConfPtr
-virConfReadFile
-virConfReadMem
-virConfType
-virConfValue
-virConfValuePtr
-virConfWriteFile
-virConfWriteMem
-virConnCopyLastError
+

Letter v:

virConnCopyLastError
virConnGetLastError
virConnResetLastError
virConnSetErrorFunc
@@ -106,6 +90,7 @@ virConnectGetVersion
virConnectListDefinedDomains
virConnectListDomains
+virConnectNumOfDefinedDomains
virConnectNumOfDomains
virConnectOpen
virConnectOpenReadOnly
diff --git a/docs/devhelp/libvirt-conf.html b/docs/devhelp/libvirt-conf.html new file mode 100644 index 0000000000..57fbaecc8e --- /dev/null +++ b/docs/devhelp/libvirt-conf.html @@ -0,0 +1,120 @@ + + + + + conf: + + + + + + + + + + + + + + +
+ + Prev + + + + Up + + + + Home + + libvirt Reference Manual
+

+ conf +

+

conf -

+

+

Author(s):

+
+

Synopsis

+ 
typedef virConfValue * virConfValuePtr;
+typedef enum virConfType;
+typedef struct _virConfValue virConfValue;
+typedef struct _virConf virConf;
+typedef virConf * virConfPtr;
+int	virConfWriteFile		(const char * filename, 
					 virConfPtr conf);
+virConfValuePtr	virConfGetValue		(virConfPtr conf, 
					 const char * setting);
+virConfPtr	virConfReadMem		(const char * memory, 
					 int len);
+int	virConfFree			(virConfPtr conf);
+virConfPtr	virConfReadFile		(const char * filename);
+int	virConfWriteMem			(char * memory, 
					 int * len, 
					 virConfPtr conf);
+
+
+
+

Description

+
+
+

Details

+
+

Structure virConf

struct _virConf {
+The content of this structure is not made public by the API.
+} virConf;
+

+

+
+

Typedef virConfPtr

virConf * virConfPtr;
+

a pointer to a parsed configuration file

+
+
+

Enum virConfType

enum virConfType {
+    VIR_CONF_NONE = 0 /* undefined */
+    VIR_CONF_LONG = 1 /* a long int */
+    VIR_CONF_STRING = 2 /* a string */
+    VIR_CONF_LIST = 3 /*  a list */
+};
+

+

+
+

Structure virConfValue

struct _virConfValue {
+    virConfType	type	: the virConfType
+    virConfValuePtr	next	: next element if in a list
+    long	l	: long integer
+    char *	str	: pointer to 0 terminated string
+    virConfValuePtr	list	: list of a list
+} virConfValue;
+

+

+
+

Typedef virConfValuePtr

virConfValue * virConfValuePtr;
+

+

+
+

virConfFree ()

int	virConfFree			(virConfPtr conf)

+

Frees all data associated to the handle

+
conf:a configuration file handle
Returns:0 in case of success, -1 in case of error.
+
+

virConfGetValue ()

virConfValuePtr	virConfGetValue		(virConfPtr conf, 
					 const char * setting)

+

Lookup the value associated to this entry in the configuration file

+
conf:a configuration file handle
setting:
Returns:a pointer to the value or NULL if the lookup failed, the data associated will be freed when virConfFree() is called
+
+

virConfReadFile ()

virConfPtr	virConfReadFile		(const char * filename)

+

Reads a configuration file.

+
filename:the path to the configuration file.
Returns:an handle to lookup settings or NULL if it failed to read or parse the file, use virConfFree() to free the data.
+
+

virConfReadMem ()

virConfPtr	virConfReadMem		(const char * memory, 
					 int len)

+

Reads a configuration file loaded in memory. The string can be zero terminated in which case @len can be 0

+
memory:pointer to the content of the configuration file
len:lenght in byte
Returns:an handle to lookup settings or NULL if it failed to parse the content, use virConfFree() to free the data.
+
+

virConfWriteFile ()

int	virConfWriteFile		(const char * filename, 
					 virConfPtr conf)

+

Writes a configuration file back to a file.

+
filename:the path to the configuration file.
conf:the conf
Returns:the number of bytes written or -1 in case of error.
+
+

virConfWriteMem ()

int	virConfWriteMem			(char * memory, 
					 int * len, 
					 virConfPtr conf)

+

Writes a configuration file back to a memory area. @len is an IN/OUT parameter, it indicates the size available in bytes, and on output the size required for the configuration file (even if the call fails due to insufficient space).

+
memory:pointer to the memory to store the config file
len:pointer to the lenght in byte of the store, on output the size
conf:the conf
Returns:the number of bytes written or -1 in case of error.
+
+
+
+ + diff --git a/docs/devhelp/libvirt-libvirt.html b/docs/devhelp/libvirt-libvirt.html index 5396234f2c..0aab728ca0 100644 --- a/docs/devhelp/libvirt-libvirt.html +++ b/docs/devhelp/libvirt-libvirt.html @@ -90,6 +90,7 @@ int virDomainSetMaxMemory (virDomainFree (virDomainPtr domain); virConnectPtr virConnectOpen (const char * name); int virDomainSuspend (virDomainPtr domain); +int virConnectNumOfDefinedDomains (virConnectPtr conn); int virConnectClose (virConnectPtr conn); int virDomainReboot (virDomainPtr domain,
unsigned int flags); int virInitialize (void); @@ -283,6 +284,10 @@ The content of this structure is not made public by the API.

virConnectListDomains ()

int	virConnectListDomains		(virConnectPtr conn, 
					 int * ids, 
					 int maxids)

Collect the list of active domains, and store their ID in @maxids

conn:pointer to the hypervisor connection
ids:array to collect the list of IDs of active domains
maxids:size of @ids
Returns:the number of domain found or -1 in case of error
+
+

virConnectNumOfDefinedDomains ()

int	virConnectNumOfDefinedDomains	(virConnectPtr conn)

+

Provides the number of active domains.

+
conn:pointer to the hypervisor connection
Returns:the number of domain found or -1 in case of error

virConnectNumOfDomains ()

int	virConnectNumOfDomains		(virConnectPtr conn)

Provides the number of active domains.

diff --git a/docs/html/book1.html b/docs/html/book1.html index 28b5113721..a6a77c2a3c 100644 --- a/docs/html/book1.html +++ b/docs/html/book1.html @@ -1,3 +1,3 @@ -Reference Manual for libvirt

Reference Manual for libvirt

Table of Contents

  • libvirt: core interfaces for the libvirt library
  • virterror: error handling interfaces for the libvirt library

main menu

related links

Graphics and design by Diana Fong

+Reference Manual for libvirt

Reference Manual for libvirt

Table of Contents

  • libvirt: core interfaces for the libvirt library
  • virterror: error handling interfaces for the libvirt library

main menu

related links

Graphics and design by Diana Fong

diff --git a/docs/html/index.html b/docs/html/index.html index 28b5113721..a6a77c2a3c 100644 --- a/docs/html/index.html +++ b/docs/html/index.html @@ -1,3 +1,3 @@ -Reference Manual for libvirt

Reference Manual for libvirt

Table of Contents

  • libvirt: core interfaces for the libvirt library
  • virterror: error handling interfaces for the libvirt library

main menu

related links

Graphics and design by Diana Fong

+Reference Manual for libvirt

Reference Manual for libvirt

Table of Contents

  • libvirt: core interfaces for the libvirt library
  • virterror: error handling interfaces for the libvirt library

main menu

related links

Graphics and design by Diana Fong

diff --git a/docs/html/libvirt-conf.html b/docs/html/libvirt-conf.html new file mode 100644 index 0000000000..cb9d464a4c --- /dev/null +++ b/docs/html/libvirt-conf.html @@ -0,0 +1,44 @@ + + +Module conf from libvirt

Module conf from libvirt

PrevvirterrorUpAPI documentationHomeThe virtualization API

Table of Contents

Structure virConf
struct _virConf
+The content of this structure is not made public by the API.
+
Typedef virConf * virConfPtr
+
Enum virConfType
+
Structure virConfValue
struct _virConfValue
+
Typedef virConfValue * virConfValuePtr
+
int	virConfFree			(virConfPtr conf)
+
virConfValuePtr	virConfGetValue		(virConfPtr conf, 
					 const char * setting)
+
virConfPtr	virConfReadFile		(const char * filename)
+
virConfPtr	virConfReadMem		(const char * memory, 
					 int len)
+
int	virConfWriteFile		(const char * filename, 
					 virConfPtr conf)
+
int	virConfWriteMem			(char * memory, 
					 int * len, 
					 virConfPtr conf)
+

Description

+

Structure virConf

Structure virConf
struct _virConf {
+The content of this structure is not made public by the API.
+}
+ a pointer to a parsed configuration file +

Enum virConfType

Enum virConfType {
+    VIR_CONF_NONE = 0 : undefined
+    VIR_CONF_LONG = 1 : a long int
+    VIR_CONF_STRING = 2 : a string
+    VIR_CONF_LIST = 3 : a list
+}
+

Structure virConfValue

Structure virConfValue
struct _virConfValue {
+    virConfType	type	: the virConfType
+    virConfValuePtr	next	: next element if in a list
+    long	l	: long integer
+    char *	str	: pointer to 0 terminated string
+    virConfValuePtr	list	: list of a list
+}

Function: virConfFree

int	virConfFree			(virConfPtr conf)

+

Frees all data associated to the handle

+
conf:a configuration file handle
Returns:0 in case of success, -1 in case of error.

Function: virConfGetValue

virConfValuePtr	virConfGetValue		(virConfPtr conf, 
					 const char * setting)

+

Lookup the value associated to this entry in the configuration file

+
conf:a configuration file handle
setting:
Returns:a pointer to the value or NULL if the lookup failed, the data associated will be freed when virConfFree() is called

Function: virConfReadFile

virConfPtr	virConfReadFile		(const char * filename)

+

Reads a configuration file.

+
filename:the path to the configuration file.
Returns:an handle to lookup settings or NULL if it failed to read or parse the file, use virConfFree() to free the data.

Function: virConfReadMem

virConfPtr	virConfReadMem		(const char * memory, 
					 int len)

+

Reads a configuration file loaded in memory. The string can be zero terminated in which case @len can be 0

+
memory:pointer to the content of the configuration file
len:lenght in byte
Returns:an handle to lookup settings or NULL if it failed to parse the content, use virConfFree() to free the data.

Function: virConfWriteFile

int	virConfWriteFile		(const char * filename, 
					 virConfPtr conf)

+

Writes a configuration file back to a file.

+
filename:the path to the configuration file.
conf:the conf
Returns:the number of bytes written or -1 in case of error.

Function: virConfWriteMem

int	virConfWriteMem			(char * memory, 
					 int * len, 
					 virConfPtr conf)

+

Writes a configuration file back to a memory area. @len is an IN/OUT parameter, it indicates the size available in bytes, and on output the size required for the configuration file (even if the call fails due to insufficient space).

+
memory:pointer to the memory to store the config file
len:pointer to the lenght in byte of the store, on output the size
conf:the conf
Returns:the number of bytes written or -1 in case of error.

main menu

related links

Graphics and design by Diana Fong

diff --git a/docs/html/libvirt-lib.html b/docs/html/libvirt-lib.html index 28b5113721..a6a77c2a3c 100644 --- a/docs/html/libvirt-lib.html +++ b/docs/html/libvirt-lib.html @@ -1,3 +1,3 @@ -Reference Manual for libvirt

Reference Manual for libvirt

Table of Contents

  • libvirt: core interfaces for the libvirt library
  • virterror: error handling interfaces for the libvirt library

main menu

related links

Graphics and design by Diana Fong

+Reference Manual for libvirt

Reference Manual for libvirt

Table of Contents

  • libvirt: core interfaces for the libvirt library
  • virterror: error handling interfaces for the libvirt library

main menu

related links

Graphics and design by Diana Fong

diff --git a/docs/html/libvirt-libvirt.html b/docs/html/libvirt-libvirt.html index 84f84ca3e0..60c30eeb96 100644 --- a/docs/html/libvirt-libvirt.html +++ b/docs/html/libvirt-libvirt.html @@ -24,6 +24,7 @@ The content of this structure is not made public by the API. 
int	virConnectGetVersion		(virConnectPtr conn, 
					 unsigned long * hvVer)
int	virConnectListDefinedDomains	(virConnectPtr conn, 
					 const char ** names, 
					 int maxnames)
int	virConnectListDomains		(virConnectPtr conn, 
					 int * ids, 
					 int maxids)
+
int	virConnectNumOfDefinedDomains	(virConnectPtr conn)
int	virConnectNumOfDomains		(virConnectPtr conn)
virConnectPtr	virConnectOpen		(const char * name)
virConnectPtr	virConnectOpenReadOnly	(const char * name)
@@ -146,7 +147,9 @@ The content of this structure is not made public by the API.

list the defined domains, stores the pointers to the names in @names

conn:pointer to the hypervisor connection
names:pointer to an array to store the names
maxnames:size of the array
Returns:the number of names provided in the array or -1 in case of error

Function: virConnectListDomains

int	virConnectListDomains		(virConnectPtr conn, 
					 int * ids, 
					 int maxids)

Collect the list of active domains, and store their ID in @maxids

-
conn:pointer to the hypervisor connection
ids:array to collect the list of IDs of active domains
maxids:size of @ids
Returns:the number of domain found or -1 in case of error

Function: virConnectNumOfDomains

int	virConnectNumOfDomains		(virConnectPtr conn)

+
conn:pointer to the hypervisor connection
ids:array to collect the list of IDs of active domains
maxids:size of @ids
Returns:the number of domain found or -1 in case of error
Function: virConnectNumOfDefinedDomains
int	virConnectNumOfDefinedDomains	(virConnectPtr conn)

+
Provides the number of active domains.

+
conn:pointer to the hypervisor connection
Returns:the number of domain found or -1 in case of error
Function: virConnectNumOfDomains
int	virConnectNumOfDomains		(virConnectPtr conn)

 
Provides the number of active domains.

 
conn:pointer to the hypervisor connection
Returns:the number of domain found or -1 in case of error
Function: virConnectOpen
virConnectPtr	virConnectOpen		(const char * name)

 
This function should be called first to get a connection to the Hypervisor and xen store

@@ -216,4 +219,4 @@ The content of this structure is not made public by the API.

Initialize the library. It's better to call this routine at startup in multithreaded applications to avoid potential race when initializing the library.

Returns:0 in case of success, -1 in case of error

Function: virNodeGetInfo

int	virNodeGetInfo			(virConnectPtr conn, 
					 virNodeInfoPtr info)

Extract hardware information about the node.

-
conn:pointer to the hypervisor connection
info:pointer to a virNodeInfo structure allocated by the user
Returns:0 in case of success and -1 in case of failure.

main menu

related links

Graphics and design by Diana Fong

+
conn:pointer to the hypervisor connection
info:pointer to a virNodeInfo structure allocated by the user
Returns:0 in case of success and -1 in case of failure.

main menu

related links

Graphics and design by Diana Fong

diff --git a/docs/html/libvirt-virterror.html b/docs/html/libvirt-virterror.html index 8fe8908de8..e813633d07 100644 --- a/docs/html/libvirt-virterror.html +++ b/docs/html/libvirt-virterror.html @@ -41,6 +41,7 @@ void virErrorFunc (void * userData,
VIR_FROM_DOM = 6 : Error when operating on a domain VIR_FROM_RPC = 7 : Error in the XML-RPC code VIR_FROM_PROXY = 8 : Error in the proxy code + VIR_FROM_CONF = 9 : Error in the configuration file handling }

Enum virErrorLevel

Enum virErrorLevel {
     VIR_ERR_NONE = 0
@@ -78,6 +79,11 @@ void	virErrorFunc			(void * userData, 
					 VIR_ERR_XML_ERROR = 27 : an XML description is not well formed or broken
     VIR_ERR_DOM_EXIST = 28 : the domain already exist
     VIR_ERR_OPERATION_DENIED = 29 : operation forbidden on read-only connections
+    VIR_ERR_OPEN_FAILED = 30 : failed to open a conf file
+    VIR_ERR_READ_FAILED = 31 : failed to read a conf file
+    VIR_ERR_PARSE_FAILED = 32 : failed to parse a conf file
+    VIR_ERR_CONF_SYNTAX = 33 : failed to parse the syntax of a conf file
+    VIR_ERR_WRITE_FAILED = 34 : failed to write a conf file
 }

Function: virConnCopyLastError

int	virConnCopyLastError		(virConnectPtr conn, 
					 virErrorPtr to)

Copy the content of the last error caught on that connection One will need to free the result with virResetError()

@@ -102,4 +108,4 @@ void virErrorFunc (void * userData,
Function: virSetErrorFunc
void	virSetErrorFunc			(void * userData, 
					 virErrorFunc handler)

Set a library global error handling function, if @handler is NULL, it will reset to default printing on stderr. The error raised there are those for which no handler at the connection level could caught.

-
userData:pointer to the user data provided in the handler callback
handler:the function to get called in case of error or NULL

main menu

related links

Graphics and design by Diana Fong

+
userData:pointer to the user data provided in the handler callback
handler:the function to get called in case of error or NULL

main menu

related links

Graphics and design by Diana Fong

diff --git a/docs/libvirt-api.xml b/docs/libvirt-api.xml index bd9721547d..7c4aa3bd92 100644 --- a/docs/libvirt-api.xml +++ b/docs/libvirt-api.xml @@ -80,6 +80,7 @@ + @@ -396,6 +397,11 @@ + + Provides the number of active domains. + + + Provides the number of active domains. diff --git a/docs/libvirt-refs.xml b/docs/libvirt-refs.xml index b5559c5d2d..25a4644539 100644 --- a/docs/libvirt-refs.xml +++ b/docs/libvirt-refs.xml @@ -91,6 +91,7 @@ + @@ -253,6 +254,7 @@ + @@ -381,6 +383,7 @@ + @@ -480,6 +483,7 @@ + @@ -777,6 +781,7 @@ + @@ -932,6 +937,7 @@ + @@ -1291,6 +1297,7 @@ + @@ -1408,6 +1415,7 @@ +