2006-04-28 18:29:26 +00:00
<?xml version="1.0" encoding="UTF-8"?>
< html >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=UTF-8" / >
< title > virterror: error handling interfaces for the libvirt library< / title >
< meta name = "generator" content = "Libvirt devhelp stylesheet" / >
< link rel = "start" href = "index.html" title = "libvirt Reference Manual" / >
< link rel = "up" href = "general.html" title = "API" / >
< link rel = "stylesheet" href = "style.css" type = "text/css" / >
< link rel = "chapter" href = "general.html" title = "API" / >
< / head >
< body bgcolor = "white" text = "black" link = "#0000FF" vlink = "#840084" alink = "#0000FF" >
< table class = "navigation" width = "100%" summary = "Navigation header" cellpadding = "2" cellspacing = "2" >
< tr valign = "middle" >
< td >
< a accesskey = "p" href = "libvirt-libvirt.html" >
< img src = "left.png" width = "24" height = "24" border = "0" alt = "Prev" / >
< / a >
< / td >
< td >
< a accesskey = "u" href = "general.html" >
< img src = "up.png" width = "24" height = "24" border = "0" alt = "Up" / >
< / a >
< / td >
< td >
< a accesskey = "h" href = "index.html" >
< img src = "home.png" width = "24" height = "24" border = "0" alt = "Home" / >
< / a >
< / td >
< th width = "100%" align = "center" > libvirt Reference Manual< / th >
< / tr >
< / table >
< h2 >
< span class = "refentrytitle" > virterror< / span >
< / h2 >
< p > virterror - error handling interfaces for the libvirt library< / p >
< p > Provides the interfaces of the libvirt library to handle errors raised while using the library. < / p >
< p > Author(s): Daniel Veillard < veillard@redhat.com> < / p >
< div class = "refsynopsisdiv" >
< h2 > Synopsis< / h2 >
< pre class = "synopsis" > typedef < a href = "libvirt-virterror.html#virError" > virError< / a > * < a href = "#virErrorPtr" > virErrorPtr< / a > ;
typedef enum < a href = "#virErrorLevel" > virErrorLevel< / a > ;
typedef enum < a href = "#virErrorDomain" > virErrorDomain< / a > ;
typedef enum < a href = "#virErrorNumber" > virErrorNumber< / a > ;
typedef struct _virError < a href = "#virError" > virError< / a > ;
int < a href = "#virCopyLastError" > virCopyLastError< / a > (< a href = "libvirt-virterror.html#virErrorPtr" > virErrorPtr< / a > to);
void < a href = "#virConnSetErrorFunc" > virConnSetErrorFunc< / a > (< a href = "libvirt-libvirt.html#virConnectPtr" > virConnectPtr< / a > conn, < br / > void * userData, < br / > < a href = "libvirt-virterror.html#virErrorFunc" > virErrorFunc< / a > handler);
void < a href = "#virResetLastError" > virResetLastError< / a > (void);
typedef void < a href = "#virErrorFunc" > virErrorFunc< / a > (void * userData, < br / > < a href = "libvirt-virterror.html#virErrorPtr" > virErrorPtr< / a > error);
void < a href = "#virResetError" > virResetError< / a > (< a href = "libvirt-virterror.html#virErrorPtr" > virErrorPtr< / a > err);
< a href = "libvirt-virterror.html#virErrorPtr" > virErrorPtr< / a > < a href = "#virConnGetLastError" > virConnGetLastError< / a > (< a href = "libvirt-libvirt.html#virConnectPtr" > virConnectPtr< / a > conn);
void < a href = "#virDefaultErrorFunc" > virDefaultErrorFunc< / a > (< a href = "libvirt-virterror.html#virErrorPtr" > virErrorPtr< / a > err);
< a href = "libvirt-virterror.html#virErrorPtr" > virErrorPtr< / a > < a href = "#virGetLastError" > virGetLastError< / a > (void);
void < a href = "#virSetErrorFunc" > virSetErrorFunc< / a > (void * userData, < br / > < a href = "libvirt-virterror.html#virErrorFunc" > virErrorFunc< / a > handler);
int < a href = "#virConnCopyLastError" > virConnCopyLastError< / a > (< a href = "libvirt-libvirt.html#virConnectPtr" > virConnectPtr< / a > conn, < br / > < a href = "libvirt-virterror.html#virErrorPtr" > virErrorPtr< / a > to);
void < a href = "#virConnResetLastError" > virConnResetLastError< / a > (< a href = "libvirt-libvirt.html#virConnectPtr" > virConnectPtr< / a > conn);
< / pre >
< / div >
< div class = "refsect1" lang = "en" >
< h2 > Description< / h2 >
< / div >
< div class = "refsect1" lang = "en" >
< h2 > Details< / h2 >
< div class = "refsect2" lang = "en" >
< div class = "refsect2" lang = "en" > < h3 > < a name = "virError" > Structure < / a > virError< / h3 > < pre class = "programlisting" > struct _virError {
int code : The error code, a < a href = "libvirt-virterror.html#virErrorNumber" > virErrorNumber< / a >
int domain : What part of the library raised this error
char * message : human-readable informative error message
< a href = "libvirt-virterror.html#virErrorLevel" > virErrorLevel< / a > level : how consequent is the error
2008-10-10 09:32:27 +00:00
< a href = "libvirt-libvirt.html#virConnectPtr" > virConnectPtr< / a > conn : connection if available, deprecated see note above
< a href = "libvirt-libvirt.html#virDomainPtr" > virDomainPtr< / a > dom : domain if available, deprecated see note above
2006-04-28 18:29:26 +00:00
char * str1 : extra string information
char * str2 : extra string information
char * str3 : extra string information
int int1 : extra number information
int int2 : extra number information
2008-10-10 09:32:27 +00:00
< a href = "libvirt-libvirt.html#virNetworkPtr" > virNetworkPtr< / a > net : network if available, deprecated see note above
2006-04-28 18:29:26 +00:00
} virError;
< / pre > < p / >
< / div >
< hr / >
< div class = "refsect2" lang = "en" > < h3 > < a name = "virErrorDomain" > Enum < / a > virErrorDomain< / h3 > < pre class = "programlisting" > enum < a href = "#virErrorDomain" > virErrorDomain< / a > {
< a name = "VIR_FROM_NONE" > VIR_FROM_NONE< / a > = 0
< a name = "VIR_FROM_XEN" > VIR_FROM_XEN< / a > = 1 /* Error at Xen hypervisor layer */
< a name = "VIR_FROM_XEND" > VIR_FROM_XEND< / a > = 2 /* Error at connection with xend daemon */
< a name = "VIR_FROM_XENSTORE" > VIR_FROM_XENSTORE< / a > = 3 /* Error at connection with xen store */
2008-03-03 06:18:06 +00:00
< a name = "VIR_FROM_SEXPR" > VIR_FROM_SEXPR< / a > = 4 /* Error in the S-Expression code */
2006-04-28 18:29:26 +00:00
< a name = "VIR_FROM_XML" > VIR_FROM_XML< / a > = 5 /* Error in the XML code */
2006-06-13 16:31:44 +00:00
< a name = "VIR_FROM_DOM" > VIR_FROM_DOM< / a > = 6 /* Error when operating on a domain */
2006-07-03 13:45:55 +00:00
< a name = "VIR_FROM_RPC" > VIR_FROM_RPC< / a > = 7 /* Error in the XML-RPC code */
2006-09-19 15:55:57 +00:00
< a name = "VIR_FROM_PROXY" > VIR_FROM_PROXY< / a > = 8 /* Error in the proxy code */
2007-02-14 18:08:45 +00:00
< a name = "VIR_FROM_CONF" > VIR_FROM_CONF< / a > = 9 /* Error in the configuration file handling */
< a name = "VIR_FROM_QEMU" > VIR_FROM_QEMU< / a > = 10 /* Error at the QEMU daemon */
2007-06-07 13:05:00 +00:00
< a name = "VIR_FROM_NET" > VIR_FROM_NET< / a > = 11 /* Error when operating on a network */
< a name = "VIR_FROM_TEST" > VIR_FROM_TEST< / a > = 12 /* Error from test driver */
2007-07-24 15:32:55 +00:00
< a name = "VIR_FROM_REMOTE" > VIR_FROM_REMOTE< / a > = 13 /* Error from remote driver */
2007-11-27 15:55:42 +00:00
< a name = "VIR_FROM_OPENVZ" > VIR_FROM_OPENVZ< / a > = 14 /* Error from OpenVZ driver */
< a name = "VIR_FROM_XENXM" > VIR_FROM_XENXM< / a > = 15 /* Error at Xen XM layer */
2008-02-20 15:20:44 +00:00
< a name = "VIR_FROM_STATS_LINUX" > VIR_FROM_STATS_LINUX< / a > = 16 /* Error in the Linux Stats code */
2008-04-04 08:06:18 +00:00
< a name = "VIR_FROM_LXC" > VIR_FROM_LXC< / a > = 17 /* Error from Linux Container driver */
2008-07-25 08:52:19 +00:00
< a name = "VIR_FROM_STORAGE" > VIR_FROM_STORAGE< / a > = 18 /* Error from storage driver */
< a name = "VIR_FROM_NETWORK" > VIR_FROM_NETWORK< / a > = 19 /* Error from network config */
2008-11-21 12:54:51 +00:00
< a name = "VIR_FROM_DOMAIN" > VIR_FROM_DOMAIN< / a > = 20 /* Error from domain config */
< a name = "VIR_FROM_UML" > VIR_FROM_UML< / a > = 21 /* Error at the UML driver */
2008-11-25 15:48:11 +00:00
< a name = "VIR_FROM_NODEDEV" > VIR_FROM_NODEDEV< / a > = 22 /* Error from node device monitor */
< a name = "VIR_FROM_XEN_INOTIFY" > VIR_FROM_XEN_INOTIFY< / a > = 23 /* Error from xen inotify layer */
2006-04-28 18:29:26 +00:00
};
< / pre > < p / >
< / div >
< hr / >
< div class = "refsect2" lang = "en" > < h3 > < a name = "virErrorLevel" > Enum < / a > virErrorLevel< / h3 > < pre class = "programlisting" > enum < a href = "#virErrorLevel" > virErrorLevel< / a > {
< a name = "VIR_ERR_NONE" > VIR_ERR_NONE< / a > = 0
< a name = "VIR_ERR_WARNING" > VIR_ERR_WARNING< / a > = 1 /* A simple warning */
< a name = "VIR_ERR_ERROR" > VIR_ERR_ERROR< / a > = 2 /* An error */
};
< / pre > < p / >
< / div >
< hr / >
< div class = "refsect2" lang = "en" > < h3 > < a name = "virErrorNumber" > Enum < / a > virErrorNumber< / h3 > < pre class = "programlisting" > enum < a href = "#virErrorNumber" > virErrorNumber< / a > {
< a name = "VIR_ERR_OK" > VIR_ERR_OK< / a > = 0
< a name = "VIR_ERR_INTERNAL_ERROR" > VIR_ERR_INTERNAL_ERROR< / a > = 1 /* internal error */
< a name = "VIR_ERR_NO_MEMORY" > VIR_ERR_NO_MEMORY< / a > = 2 /* memory allocation failure */
2007-06-25 08:40:38 +00:00
< a name = "VIR_ERR_NO_SUPPORT" > VIR_ERR_NO_SUPPORT< / a > = 3 /* no support for this function */
2006-04-28 18:29:26 +00:00
< a name = "VIR_ERR_UNKNOWN_HOST" > VIR_ERR_UNKNOWN_HOST< / a > = 4 /* could not resolve hostname */
< a name = "VIR_ERR_NO_CONNECT" > VIR_ERR_NO_CONNECT< / a > = 5 /* can't connect to hypervisor */
< a name = "VIR_ERR_INVALID_CONN" > VIR_ERR_INVALID_CONN< / a > = 6 /* invalid connection object */
< a name = "VIR_ERR_INVALID_DOMAIN" > VIR_ERR_INVALID_DOMAIN< / a > = 7 /* invalid domain object */
< a name = "VIR_ERR_INVALID_ARG" > VIR_ERR_INVALID_ARG< / a > = 8 /* invalid function argument */
< a name = "VIR_ERR_OPERATION_FAILED" > VIR_ERR_OPERATION_FAILED< / a > = 9 /* a command to hypervisor failed */
< a name = "VIR_ERR_GET_FAILED" > VIR_ERR_GET_FAILED< / a > = 10 /* a HTTP GET command to failed */
< a name = "VIR_ERR_POST_FAILED" > VIR_ERR_POST_FAILED< / a > = 11 /* a HTTP POST command to failed */
< a name = "VIR_ERR_HTTP_ERROR" > VIR_ERR_HTTP_ERROR< / a > = 12 /* unexpected HTTP error code */
< a name = "VIR_ERR_SEXPR_SERIAL" > VIR_ERR_SEXPR_SERIAL< / a > = 13 /* failure to serialize an S-Expr */
< a name = "VIR_ERR_NO_XEN" > VIR_ERR_NO_XEN< / a > = 14 /* could not open Xen hypervisor control */
< a name = "VIR_ERR_XEN_CALL" > VIR_ERR_XEN_CALL< / a > = 15 /* failure doing an hypervisor call */
< a name = "VIR_ERR_OS_TYPE" > VIR_ERR_OS_TYPE< / a > = 16 /* unknown OS type */
< a name = "VIR_ERR_NO_KERNEL" > VIR_ERR_NO_KERNEL< / a > = 17 /* missing kernel information */
< a name = "VIR_ERR_NO_ROOT" > VIR_ERR_NO_ROOT< / a > = 18 /* missing root device information */
< a name = "VIR_ERR_NO_SOURCE" > VIR_ERR_NO_SOURCE< / a > = 19 /* missing source device information */
< a name = "VIR_ERR_NO_TARGET" > VIR_ERR_NO_TARGET< / a > = 20 /* missing target device information */
< a name = "VIR_ERR_NO_NAME" > VIR_ERR_NO_NAME< / a > = 21 /* missing domain name information */
< a name = "VIR_ERR_NO_OS" > VIR_ERR_NO_OS< / a > = 22 /* missing domain OS information */
< a name = "VIR_ERR_NO_DEVICE" > VIR_ERR_NO_DEVICE< / a > = 23 /* missing domain devices information */
< a name = "VIR_ERR_NO_XENSTORE" > VIR_ERR_NO_XENSTORE< / a > = 24 /* could not open Xen Store control */
< a name = "VIR_ERR_DRIVER_FULL" > VIR_ERR_DRIVER_FULL< / a > = 25 /* too many drivers registered */
2007-06-25 08:40:38 +00:00
< a name = "VIR_ERR_CALL_FAILED" > VIR_ERR_CALL_FAILED< / a > = 26 /* not supported by the drivers (DEPRECATED) */
2006-06-13 16:31:44 +00:00
< a name = "VIR_ERR_XML_ERROR" > VIR_ERR_XML_ERROR< / a > = 27 /* an XML description is not well formed or broken */
2006-08-16 17:58:23 +00:00
< a name = "VIR_ERR_DOM_EXIST" > VIR_ERR_DOM_EXIST< / a > = 28 /* the domain already exist */
2006-09-19 15:55:57 +00:00
< a name = "VIR_ERR_OPERATION_DENIED" > VIR_ERR_OPERATION_DENIED< / a > = 29 /* operation forbidden on read-only connections */
< a name = "VIR_ERR_OPEN_FAILED" > VIR_ERR_OPEN_FAILED< / a > = 30 /* failed to open a conf file */
< a name = "VIR_ERR_READ_FAILED" > VIR_ERR_READ_FAILED< / a > = 31 /* failed to read a conf file */
< a name = "VIR_ERR_PARSE_FAILED" > VIR_ERR_PARSE_FAILED< / a > = 32 /* failed to parse a conf file */
< a name = "VIR_ERR_CONF_SYNTAX" > VIR_ERR_CONF_SYNTAX< / a > = 33 /* failed to parse the syntax of a conf file */
2006-11-09 15:32:44 +00:00
< a name = "VIR_ERR_WRITE_FAILED" > VIR_ERR_WRITE_FAILED< / a > = 34 /* failed to write a conf file */
2007-02-14 18:08:45 +00:00
< a name = "VIR_ERR_XML_DETAIL" > VIR_ERR_XML_DETAIL< / a > = 35 /* detail of an XML error */
< a name = "VIR_ERR_INVALID_NETWORK" > VIR_ERR_INVALID_NETWORK< / a > = 36 /* invalid network object */
2007-03-15 17:24:56 +00:00
< a name = "VIR_ERR_NETWORK_EXIST" > VIR_ERR_NETWORK_EXIST< / a > = 37 /* the network already exist */
2007-06-07 13:05:00 +00:00
< a name = "VIR_ERR_SYSTEM_ERROR" > VIR_ERR_SYSTEM_ERROR< / a > = 38 /* general system call failure */
< a name = "VIR_ERR_RPC" > VIR_ERR_RPC< / a > = 39 /* some sort of RPC error */
< a name = "VIR_ERR_GNUTLS_ERROR" > VIR_ERR_GNUTLS_ERROR< / a > = 40 /* error from a GNUTLS call */
2007-07-09 12:41:29 +00:00
< a name = "VIR_WAR_NO_NETWORK" > VIR_WAR_NO_NETWORK< / a > = 41 /* failed to start network */
< a name = "VIR_ERR_NO_DOMAIN" > VIR_ERR_NO_DOMAIN< / a > = 42 /* domain not found or unexpectedly disappeared */
2007-07-24 15:32:55 +00:00
< a name = "VIR_ERR_NO_NETWORK" > VIR_ERR_NO_NETWORK< / a > = 43 /* network not found */
2008-03-03 06:18:06 +00:00
< a name = "VIR_ERR_INVALID_MAC" > VIR_ERR_INVALID_MAC< / a > = 44 /* invalid MAC address */
2008-02-20 15:20:44 +00:00
< a name = "VIR_ERR_AUTH_FAILED" > VIR_ERR_AUTH_FAILED< / a > = 45 /* authentication failed */
< a name = "VIR_ERR_INVALID_STORAGE_POOL" > VIR_ERR_INVALID_STORAGE_POOL< / a > = 46 /* invalid storage pool object */
< a name = "VIR_ERR_INVALID_STORAGE_VOL" > VIR_ERR_INVALID_STORAGE_VOL< / a > = 47 /* invalid storage vol object */
2008-02-20 16:08:56 +00:00
< a name = "VIR_WAR_NO_STORAGE" > VIR_WAR_NO_STORAGE< / a > = 48 /* failed to start storage */
< a name = "VIR_ERR_NO_STORAGE_POOL" > VIR_ERR_NO_STORAGE_POOL< / a > = 49 /* storage pool not found */
2008-11-21 12:54:51 +00:00
< a name = "VIR_ERR_NO_STORAGE_VOL" > VIR_ERR_NO_STORAGE_VOL< / a > = 50 /* storage pool not found */
< a name = "VIR_WAR_NO_NODE" > VIR_WAR_NO_NODE< / a > = 51 /* failed to start node driver */
< a name = "VIR_ERR_INVALID_NODE_DEVICE" > VIR_ERR_INVALID_NODE_DEVICE< / a > = 52 /* invalid node device object */
< a name = "VIR_ERR_NO_NODE_DEVICE" > VIR_ERR_NO_NODE_DEVICE< / a > = 53 /* node device not found */
2006-04-28 18:29:26 +00:00
};
< / pre > < p / >
< / div >
< hr / >
< div class = "refsect2" lang = "en" > < h3 > < a name = "virErrorPtr" > Typedef < / a > virErrorPtr< / h3 > < pre class = "programlisting" > < a href = "libvirt-virterror.html#virError" > virError< / a > * virErrorPtr;
< / pre > < p / >
< / div >
< hr / >
< div class = "refsect2" lang = "en" > < h3 > < a name = "virErrorFunc" / > Function type virErrorFunc< / h3 > < pre class = "programlisting" > void virErrorFunc (void * userData, < br / > < a href = "libvirt-virterror.html#virErrorPtr" > virErrorPtr< / a > error)< br / >
< / pre > < p > Signature of a function to use when there is an error raised by the library.< / p >
< div class = "variablelist" > < table border = "0" > < col align = "left" / > < tbody > < tr > < td > < span class = "term" > < i > < tt > userData< / tt > < / i > :< / span > < / td > < td > user provided data for the error callback< / td > < / tr > < tr > < td > < span class = "term" > < i > < tt > error< / tt > < / i > :< / span > < / td > < td > the error being raised.< / td > < / tr > < / tbody > < / table > < / div > < / div >
< hr / >
< div class = "refsect2" lang = "en" > < h3 > < a name = "virConnCopyLastError" / > virConnCopyLastError ()< / h3 > < pre class = "programlisting" > int virConnCopyLastError (< a href = "libvirt-libvirt.html#virConnectPtr" > virConnectPtr< / a > conn, < br / > < a href = "libvirt-virterror.html#virErrorPtr" > virErrorPtr< / a > to)< br / >
< / pre > < p > Copy the content of the last error caught on that connection One will need to free the result with virResetError()< / p >
< div class = "variablelist" > < table border = "0" > < col align = "left" / > < tbody > < tr > < td > < span class = "term" > < i > < tt > conn< / tt > < / i > :< / span > < / td > < td > pointer to the hypervisor connection< / td > < / tr > < tr > < td > < span class = "term" > < i > < tt > to< / tt > < / i > :< / span > < / td > < td > target to receive the copy< / td > < / tr > < tr > < td > < span class = "term" > < i > < tt > Returns< / tt > < / i > :< / span > < / td > < td > 0 if no error was found and the error code otherwise and -1 in case of parameter error.< / td > < / tr > < / tbody > < / table > < / div > < / div >
< hr / >
< div class = "refsect2" lang = "en" > < h3 > < a name = "virConnGetLastError" / > virConnGetLastError ()< / h3 > < pre class = "programlisting" > < a href = "libvirt-virterror.html#virErrorPtr" > virErrorPtr< / a > virConnGetLastError (< a href = "libvirt-libvirt.html#virConnectPtr" > virConnectPtr< / a > conn)< br / >
< / pre > < p > Provide a pointer to the last error caught on that connection Simpler but may not be suitable for multithreaded accesses, in which case use virConnCopyLastError()< / p >
2008-03-03 06:18:06 +00:00
< div class = "variablelist" > < table border = "0" > < col align = "left" / > < tbody > < tr > < td > < span class = "term" > < i > < tt > conn< / tt > < / i > :< / span > < / td > < td > pointer to the hypervisor connection< / td > < / tr > < tr > < td > < span class = "term" > < i > < tt > Returns< / tt > < / i > :< / span > < / td > < td > a pointer to the last error or NULL if none occurred.< / td > < / tr > < / tbody > < / table > < / div > < / div >
2006-04-28 18:29:26 +00:00
< hr / >
< div class = "refsect2" lang = "en" > < h3 > < a name = "virConnResetLastError" / > virConnResetLastError ()< / h3 > < pre class = "programlisting" > void virConnResetLastError (< a href = "libvirt-libvirt.html#virConnectPtr" > virConnectPtr< / a > conn)< br / >
< / pre > < p > Reset the last error caught on that connection< / p >
< div class = "variablelist" > < table border = "0" > < col align = "left" / > < tbody > < tr > < td > < span class = "term" > < i > < tt > conn< / tt > < / i > :< / span > < / td > < td > pointer to the hypervisor connection< / td > < / tr > < / tbody > < / table > < / div > < / div >
< hr / >
< div class = "refsect2" lang = "en" > < h3 > < a name = "virConnSetErrorFunc" / > virConnSetErrorFunc ()< / h3 > < pre class = "programlisting" > void virConnSetErrorFunc (< a href = "libvirt-libvirt.html#virConnectPtr" > virConnectPtr< / a > conn, < br / > void * userData, < br / > < a href = "libvirt-virterror.html#virErrorFunc" > virErrorFunc< / a > handler)< br / >
< / pre > < p > Set a connection error handling function, if @handler is NULL it will reset to default which is to pass error back to the global library handler.< / p >
< div class = "variablelist" > < table border = "0" > < col align = "left" / > < tbody > < tr > < td > < span class = "term" > < i > < tt > conn< / tt > < / i > :< / span > < / td > < td > pointer to the hypervisor connection< / td > < / tr > < tr > < td > < span class = "term" > < i > < tt > userData< / tt > < / i > :< / span > < / td > < td > pointer to the user data provided in the handler callback< / td > < / tr > < tr > < td > < span class = "term" > < i > < tt > handler< / tt > < / i > :< / span > < / td > < td > the function to get called in case of error or NULL< / td > < / tr > < / tbody > < / table > < / div > < / div >
< hr / >
< div class = "refsect2" lang = "en" > < h3 > < a name = "virCopyLastError" / > virCopyLastError ()< / h3 > < pre class = "programlisting" > int virCopyLastError (< a href = "libvirt-virterror.html#virErrorPtr" > virErrorPtr< / a > to)< br / >
< / pre > < p > Copy the content of the last error caught at the library level One will need to free the result with virResetError()< / p >
< div class = "variablelist" > < table border = "0" > < col align = "left" / > < tbody > < tr > < td > < span class = "term" > < i > < tt > to< / tt > < / i > :< / span > < / td > < td > target to receive the copy< / td > < / tr > < tr > < td > < span class = "term" > < i > < tt > Returns< / tt > < / i > :< / span > < / td > < td > 0 if no error was found and the error code otherwise and -1 in case of parameter error.< / td > < / tr > < / tbody > < / table > < / div > < / div >
< hr / >
< div class = "refsect2" lang = "en" > < h3 > < a name = "virDefaultErrorFunc" / > virDefaultErrorFunc ()< / h3 > < pre class = "programlisting" > void virDefaultErrorFunc (< a href = "libvirt-virterror.html#virErrorPtr" > virErrorPtr< / a > err)< br / >
< / pre > < p > Default routine reporting an error to stderr.< / p >
< div class = "variablelist" > < table border = "0" > < col align = "left" / > < tbody > < tr > < td > < span class = "term" > < i > < tt > err< / tt > < / i > :< / span > < / td > < td > pointer to the error.< / td > < / tr > < / tbody > < / table > < / div > < / div >
< hr / >
< div class = "refsect2" lang = "en" > < h3 > < a name = "virGetLastError" / > virGetLastError ()< / h3 > < pre class = "programlisting" > < a href = "libvirt-virterror.html#virErrorPtr" > virErrorPtr< / a > virGetLastError (void)< br / >
< / pre > < p > Provide a pointer to the last error caught at the library level Simpler but may not be suitable for multithreaded accesses, in which case use virCopyLastError()< / p >
2008-03-03 06:18:06 +00:00
< div class = "variablelist" > < table border = "0" > < col align = "left" / > < tbody > < tr > < td > < span class = "term" > < i > < tt > Returns< / tt > < / i > :< / span > < / td > < td > a pointer to the last error or NULL if none occurred.< / td > < / tr > < / tbody > < / table > < / div > < / div >
2006-04-28 18:29:26 +00:00
< hr / >
< div class = "refsect2" lang = "en" > < h3 > < a name = "virResetError" / > virResetError ()< / h3 > < pre class = "programlisting" > void virResetError (< a href = "libvirt-virterror.html#virErrorPtr" > virErrorPtr< / a > err)< br / >
< / pre > < p > Reset the error being pointed to< / p >
< div class = "variablelist" > < table border = "0" > < col align = "left" / > < tbody > < tr > < td > < span class = "term" > < i > < tt > err< / tt > < / i > :< / span > < / td > < td > pointer to the < a href = "libvirt-virterror.html#virError" > virError< / a > to clean up< / td > < / tr > < / tbody > < / table > < / div > < / div >
< hr / >
< div class = "refsect2" lang = "en" > < h3 > < a name = "virResetLastError" / > virResetLastError ()< / h3 > < pre class = "programlisting" > void virResetLastError (void)< br / >
< / pre > < p > Reset the last error caught at the library level.< / p >
< / div >
< hr / >
< div class = "refsect2" lang = "en" > < h3 > < a name = "virSetErrorFunc" / > virSetErrorFunc ()< / h3 > < pre class = "programlisting" > void virSetErrorFunc (void * userData, < br / > < a href = "libvirt-virterror.html#virErrorFunc" > virErrorFunc< / a > handler)< br / >
< / pre > < p > 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.< / p >
< div class = "variablelist" > < table border = "0" > < col align = "left" / > < tbody > < tr > < td > < span class = "term" > < i > < tt > userData< / tt > < / i > :< / span > < / td > < td > pointer to the user data provided in the handler callback< / td > < / tr > < tr > < td > < span class = "term" > < i > < tt > handler< / tt > < / i > :< / span > < / td > < td > the function to get called in case of error or NULL< / td > < / tr > < / tbody > < / table > < / div > < / div >
< hr / >
< / div >
< / div >
< / body >
< / html >
