External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2025-03-20 07:59:00 +00:00
Code

update virGetVersion description

Browse Source 
The current description suggests that you always have to provide
a valid typeVer pointer. But if you want only the libvirt version
it's also possible to set type and typeVer to NULL to skip the
hypervisor part.
This commit is contained in:
Tiziano Mueller 2011-03-05 18:36:23 +01:00 committed by Eric Blake
parent ae5155768f
commit 83bc4fa7fa
2 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
AUTHORS
View File

@ -159,6 +159,7 @@ Patches have also been contributed by:
Phil Petty <phpetty@cisco.com>
Taku Izumi <izumi.taku@jp.fujitsu.com>
Minoru Usui <usui@mxm.nes.nec.co.jp>
Tiziano Mueller <dev-zero@gentoo.org>
[....send patches to get your name here....]

15
src/libvirt.c
View File

@ -860,14 +860,15 @@ int virStateActive(void) {
/**
* virGetVersion:
* @libVer: return value for the library version (OUT)
* @type: the type of connection/driver looked at
* @typeVer: return value for the version of the hypervisor (OUT)
* @type: the type of connection/driver looked at, if @typeVer is not NULL
* @typeVer: optional return value for the version of the hypervisor (OUT)
*
* Provides two information back, @libVer is the version of the library
* while @typeVer will be the version of the hypervisor type @type against
* which the library was compiled. If @type is NULL, "Xen" is assumed, if
* @type is unknown or not available, an error code will be returned and
* @typeVer will be 0.
* Provides information on up to two versions: @libVer is the version of the
* library and will always be set unless an error occurs, in which case an
* error code will be returned. If @typeVer is not NULL it will be set to the
* version of the hypervisor @type against which the library was compiled.
* If @type is NULL, "Xen" is assumed, if @type is unknown or not
* available, an error code will be returned and @typeVer will be 0.
*
* Returns -1 in case of failure, 0 otherwise, and values for @libVer and
* @typeVer have the format major * 1,000,000 + minor * 1,000 + release.