Blame docs/libvirt-glib/html/Libvirt-glib-Library-initialization.html

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

Library initialization

Packit Service ea0369

Library initialization — Initialize the library

Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

Stability Level

Packit Service ea0369
Packit Service ea0369
develop applications to these interfaces, release them, and have confidence that
Packit Service ea0369
they will run on all minor releases of the product (after the one in which the
Packit Service ea0369
interface was introduced, and within the same major release). Even at a major
Packit Service ea0369
release, incompatible changes are expected to be rare, and to have strong
Packit Service ea0369
justifications.
Packit Service ea0369
">Stable, unless otherwise indicated
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

Functions

Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
void
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
gvir_init ()
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
gboolean
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
gvir_init_check ()
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

Includes

Packit Service ea0369
#include <libvirt-glib/libvirt-glib.h>
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

Description

Packit Service ea0369

The Libvirt GLib library provides glue to integrate core libvirt

Packit Service ea0369
infrastructure with the GLib library. This enables consistent
Packit Service ea0369
error reporting procedures and a common event loop implementation
Packit Service ea0369
for applications.

Packit Service ea0369

Before using any functions in the Libvirt GLib library, it must be initialized

Packit Service ea0369
by calling gvir_init or gvir_init_check.

Packit Service ea0369
Packit Service ea0369

Example 1. Initializing the Libvirt GLib library

Packit Service ea0369
Packit Service ea0369
  
Packit Service ea0369
    
Packit Service ea0369
      
Packit Service ea0369
        
1
Packit Service ea0369
2
Packit Service ea0369
3
Packit Service ea0369
4
Packit Service ea0369
5
Packit Service ea0369
6
Packit Service ea0369
7
Packit Service ea0369
        
int main(int argc, char **argv) {
Packit Service ea0369
  ...setup...
Packit Service ea0369
  gvir_init(&argc, &argv);
Packit Service ea0369
  ...more setup...
Packit Service ea0369
  gtk_main();
Packit Service ea0369
  return 0;
Packit Service ea0369
}
Packit Service ea0369
      
Packit Service ea0369
    
Packit Service ea0369
  
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

Functions

Packit Service ea0369
Packit Service ea0369

gvir_init ()

Packit Service ea0369
void
Packit Service ea0369
gvir_init (int *argc,
Packit Service ea0369
           char ***argv);
Packit Service ea0369

Call this function before using any other Libvirt GLib functions in your applications.

Packit Service ea0369
It will initialize everything needed to operate the toolkit and parses some standard
Packit Service ea0369
command line options.

Packit Service ea0369

Although you are expected to pass the argc

Packit Service ea0369
, argv
Packit Service ea0369
 parameters from main() to this
Packit Service ea0369
function, it is possible to pass NULL if argv
Packit Service ea0369
 is not available or commandline
Packit Service ea0369
handling is not required.

Packit Service ea0369

argc

Packit Service ea0369
 and argv
Packit Service ea0369
 are adjusted accordingly so your own code will never see those
Packit Service ea0369
standard arguments.

Packit Service ea0369

This method will also turn on debug logging of the library if the

Packit Service ea0369
LIBVIRT_GLIB_DEBUG environment variable is set.

Packit Service ea0369

This function will terminate your program if it was unable to initialize

Packit Service ea0369
for some reason. If you want the program to fall back to an alternate
Packit Service ea0369
mode of operation call gvir_init_check instead.

Packit Service ea0369
Packit Service ea0369

Parameters

Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

argc

Packit Service ea0369

Address of the argc parameter of your main() function (or 0

Packit Service ea0369
if argv is NULL). This will be changed if any arguments were handled. 

Packit Service ea0369
[inout]
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

argv

Packit Service ea0369
Packit Service ea0369

Address of the

Packit Service ea0369
argv parameter of main(), or NULL. Any options
Packit Service ea0369

understood by GTK+ are stripped before return.

Packit Service ea0369
Packit Service ea0369
[array length=argc][inout][allow-none][transfer none]
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

Packit Service ea0369
Packit Service ea0369

gvir_init_check ()

Packit Service ea0369
gboolean
Packit Service ea0369
gvir_init_check (int *argc,
Packit Service ea0369
                 char ***argv,
Packit Service ea0369
                 GError **err);
Packit Service ea0369

This function does the same work as gvir_init() with only a single

Packit Service ea0369
change: It does not terminate the program if the Libvirt GLib library
Packit Service ea0369
can't be initialized. Instead it returns FALSE on failure.

Packit Service ea0369

This way the application can fall back to some other mode of

Packit Service ea0369
operation.

Packit Service ea0369
Packit Service ea0369

Parameters

Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

argc

Packit Service ea0369

Address of the argc parameter of your main() function (or 0

Packit Service ea0369
if argv is NULL). This will be changed if any arguments were handled. 

Packit Service ea0369
[inout]
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

argv

Packit Service ea0369
Packit Service ea0369

Address of the

Packit Service ea0369
argv parameter of main(), or NULL. Any options
Packit Service ea0369

understood by GTK+ are stripped before return.

Packit Service ea0369
Packit Service ea0369
[array length=argc][inout][allow-none][transfer none]
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

err

Packit Service ea0369

filled with the error information if initialized failed.

Packit Service ea0369
 
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

Returns

Packit Service ea0369

TRUE if the library was successfully initialized,

Packit Service ea0369
FALSE otherwise

Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

Types and Values

Packit Service ea0369
Packit Service ea0369
Packit Service ea0369
Packit Service ea0369

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