• Home
• News
• Downloads
• Documentation

  • Deployment
  • Architecture
  • XML format
  • Drivers
  • API reference

    • libvirt
    • virterror
    • Driver support
  • Language bindings
  • Internals
• Wiki
• FAQ
• Bug reports
• Contact
• Related Links
• Sitemap

Module virterror from libvirt

Provides the interfaces of the libvirt library to handle errors raised while using the library.

Table of Contents

Types

typedef struct _virError virError
typedef enum virErrorDomain
typedef enum virErrorLevel
typedef enum virErrorNumber
typedef virError * virErrorPtr

Functions

int	virConnCopyLastError		(virConnectPtr conn, 
					 virErrorPtr to)
virErrorPtr	virConnGetLastError	(virConnectPtr conn)
void	virConnResetLastError		(virConnectPtr conn)
void	virConnSetErrorFunc		(virConnectPtr conn, 
					 void * userData, 
					 virErrorFunc handler)
int	virCopyLastError		(virErrorPtr to)
void	virDefaultErrorFunc		(virErrorPtr err)
typedef virErrorFunc
void	virErrorFunc			(void * userData, 
					 virErrorPtr error)

void	virFreeError			(virErrorPtr err)
virErrorPtr	virGetLastError		(void)
void	virResetError			(virErrorPtr err)
void	virResetLastError		(void)
virErrorPtr	virSaveLastError	(void)
void	virSetErrorFunc			(void * userData, 
					 virErrorFunc handler)

Description

Types

virError

struct virError{

}

virErrorDomain

enum virErrorDomain {

}

virErrorLevel

enum virErrorLevel {

}

virErrorNumber

enum virErrorNumber {

}

Functions

virConnCopyLastError

int	virConnCopyLastError		(virConnectPtr conn, 
					 virErrorPtr to)

Copy the content of the last error caught on that connection This method is not protected against access from multiple threads. In a multi-threaded application, always use the global virGetLastError() API which is backed by thread local storage. If the connection object was discovered to be invalid by an API call, then the error will be reported against the global error object. Since 0.6.0, all errors reported in the per-connection object are also duplicated in the global error object. As such an application can always use virGetLastError(). This method remains for backwards compatability. One will need to free the result with virResetError()

virConnGetLastError

virErrorPtr	virConnGetLastError	(virConnectPtr conn)

Provide a pointer to the last error caught on that connection This method is not protected against access from multiple threads. In a multi-threaded application, always use the global virGetLastError() API which is backed by thread local storage. If the connection object was discovered to be invalid by an API call, then the error will be reported against the global error object. Since 0.6.0, all errors reported in the per-connection object are also duplicated in the global error object. As such an application can always use virGetLastError(). This method remains for backwards compatability.

virConnResetLastError

void	virConnResetLastError		(virConnectPtr conn)

The error object is kept in thread local storage, so separate threads can safely access this concurrently. Reset the last error caught on that connection

virConnSetErrorFunc

void	virConnSetErrorFunc		(virConnectPtr conn, 
					 void * userData, 
					 virErrorFunc handler)

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.

virCopyLastError

int	virCopyLastError		(virErrorPtr to)

Copy the content of the last error caught at the library level The error object is kept in thread local storage, so separate threads can safely access this concurrently. One will need to free the result with virResetError()

virDefaultErrorFunc

void	virDefaultErrorFunc		(virErrorPtr err)

Default routine reporting an error to stderr.

virErrorFunc

typedef void	(*virErrorFunc		)	(void * userData, 
					 virErrorPtr error)

Signature of a function to use when there is an error raised by the library.

virFreeError

void	virFreeError			(virErrorPtr err)

Resets and frees the given error.

virGetLastError

virErrorPtr	virGetLastError		(void)

Provide a pointer to the last error caught at the library level The error object is kept in thread local storage, so separate threads can safely access this concurrently.

virResetError

void	virResetError			(virErrorPtr err)

Reset the error being pointed to

virResetLastError

void	virResetLastError		(void)

Reset the last error caught at the library level. The error object is kept in thread local storage, so separate threads can safely access this concurrently, only resetting their own error object.

virSaveLastError

virErrorPtr	virSaveLastError	(void)

Save the last error into a new error object.

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.