![]() |
![]() |
![]() |
Libosinfo Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties |
GQuark osinfo_media_error_quark (void
); #define OSINFO_MEDIA_ERROR enum OsinfoMediaError; #define OSINFO_MEDIA_PROP_ARCHITECTURE #define OSINFO_MEDIA_PROP_URL #define OSINFO_MEDIA_PROP_VOLUME_ID #define OSINFO_MEDIA_PROP_SYSTEM_ID #define OSINFO_MEDIA_PROP_PUBLISHER_ID #define OSINFO_MEDIA_PROP_APPLICATION_ID #define OSINFO_MEDIA_PROP_KERNEL #define OSINFO_MEDIA_PROP_INITRD #define OSINFO_MEDIA_PROP_LIVE #define OSINFO_MEDIA_PROP_INSTALLER #define OSINFO_MEDIA_PROP_INSTALLER_REBOOTS struct OsinfoMedia; struct OsinfoMediaClass; OsinfoMedia * osinfo_media_new (const gchar *id
,const gchar *architecture
); OsinfoMedia * osinfo_media_create_from_location (const gchar *location
,GCancellable *cancellable
,GError **error
); void osinfo_media_create_from_location_async (const gchar *location
,gint priority
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); OsinfoMedia * osinfo_media_create_from_location_finish (GAsyncResult *res
,GError **error
); const gchar * osinfo_media_get_architecture (OsinfoMedia *media
); const gchar * osinfo_media_get_url (OsinfoMedia *media
); const gchar * osinfo_media_get_volume_id (OsinfoMedia *media
); const gchar * osinfo_media_get_system_id (OsinfoMedia *media
); const gchar * osinfo_media_get_publisher_id (OsinfoMedia *media
); const gchar * osinfo_media_get_application_id (OsinfoMedia *media
); const gchar * osinfo_media_get_kernel_path (OsinfoMedia *media
); const gchar * osinfo_media_get_initrd_path (OsinfoMedia *media
); gboolean osinfo_media_get_installer (OsinfoMedia *media
); gboolean osinfo_media_get_live (OsinfoMedia *media
); gint osinfo_media_get_installer_reboots (OsinfoMedia *media
);
"application-id" gchar* : Read / Write "architecture" gchar* : Read / Write "initrd-path" gchar* : Read / Write "installer" gboolean : Read / Write / Construct "installer-reboots" gint : Read / Write / Construct "kernel-path" gchar* : Read / Write "live" gboolean : Read / Write / Construct "publisher-id" gchar* : Read / Write "system-id" gchar* : Read / Write "url" gchar* : Read / Write "volume-id" gchar* : Read / Write
typedef enum { OSINFO_MEDIA_ERROR_NO_DESCRIPTORS, OSINFO_MEDIA_ERROR_NO_PVD, OSINFO_MEDIA_ERROR_NO_SVD, OSINFO_MEDIA_ERROR_INSUFFICIENT_METADATA, OSINFO_MEDIA_ERROR_NOT_BOOTABLE } OsinfoMediaError;
GError codes used for errors in the OSINFO_MEDIA_ERROR domain, during reading of data from install media location.
struct OsinfoMediaClass { OsinfoEntityClass parent_class; /* class members */ };
OsinfoMedia * osinfo_media_create_from_location (const gchar *location
,GCancellable *cancellable
,GError **error
);
Creates a new OsinfoMedia for installation media at location
. The location
could be any URI that GIO can handle or a local path.
NOTE: Currently this only works for ISO images/devices.
|
the location of an installation media |
|
a GCancellable, or NULL . [allow-none]
|
|
The location where to store any error, or NULL
|
Returns : |
a new OsinfoMedia , or NULL on error. [transfer full] |
void osinfo_media_create_from_location_async (const gchar *location
,gint priority
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronous variant of osinfo_media_create_from_location.
OsinfoMedia * osinfo_media_create_from_location_finish (GAsyncResult *res
,GError **error
);
Finishes an asynchronous media object creation process started with osinfo_media_create_from_location_async.
|
a GAsyncResult |
|
The location where to store any error, or NULL
|
Returns : |
a new OsinfoMedia , or NULL on error. [transfer full] |
const gchar * osinfo_media_get_architecture (OsinfoMedia *media
);
Retrieves the target hardware architecture of the OS media
provides.
|
a OsinfoMedia instance |
Returns : |
the hardware architecture, or NULL. [transfer none] |
const gchar * osinfo_media_get_url (OsinfoMedia *media
);
The URL to the media
|
a OsinfoMedia instance |
Returns : |
the URL, or NULL. [transfer none] |
const gchar * osinfo_media_get_volume_id (OsinfoMedia *media
);
If media
is an ISO9660 image/device, this function retrieves the expected
volume ID.
Note: In practice, this will usually not be the exact copy of the volume ID string on the ISO image/device but rather a regular expression that matches it.
|
a OsinfoMedia instance |
Returns : |
the volume id, or NULL. [transfer none] |
const gchar * osinfo_media_get_system_id (OsinfoMedia *media
);
If media
is an ISO9660 image/device, this function retrieves the expected
system ID.
Note: In practice, this will usually not be the exact copy of the system ID string on the ISO image/device but rather a regular expression that matches it.
|
a OsinfoMedia instance |
Returns : |
the system id, or NULL. [transfer none] |
const gchar * osinfo_media_get_publisher_id (OsinfoMedia *media
);
If media
is an ISO9660 image/device, this function retrieves the expected
publisher ID.
Note: In practice, this will usually not be the exact copy of the publisher ID string on the ISO image/device but rather a regular expression that matches it.
|
a OsinfoMedia instance |
Returns : |
the publisher id, or NULL. [transfer none] |
const gchar * osinfo_media_get_application_id (OsinfoMedia *media
);
If media
is an ISO9660 image/device, this function retrieves the expected
application ID.
Note: In practice, this will usually not be the exact copy of the application ID string on the ISO image/device but rather a regular expression that matches it.
|
a OsinfoMedia instance |
Returns : |
the application id, or NULL. [transfer none] |
const gchar * osinfo_media_get_kernel_path (OsinfoMedia *media
);
Retrieves the path to the kernel image in the install tree.
Note: This only applies to installer medias of 'linux' OS family.
|
a OsinfoMedia instance |
Returns : |
the path to kernel image, or NULL. [transfer none] |
const gchar * osinfo_media_get_initrd_path (OsinfoMedia *media
);
Retrieves the path to the initrd image in the install tree.
Note: This only applies to installer medias of 'linux' OS family.
|
a OsinfoMedia instance |
Returns : |
the path to initrd image, or NULL. [transfer none] |
gboolean osinfo_media_get_installer (OsinfoMedia *media
);
Whether media
provides a installer for an OS.
|
a OsinfoMedia instance |
Returns : |
TRUE if media is installer, FALSE otherwise |
gboolean osinfo_media_get_live (OsinfoMedia *media
);
Whether media
can boot directly an OS without any installations.
|
a OsinfoMedia instance |
Returns : |
TRUE if media is live, FALSE otherwise |
gint osinfo_media_get_installer_reboots (OsinfoMedia *media
);
If media is an installer, this method retrieves the number of reboots the installer takes before installation is complete.
This function is not supposed to be called on media that has no installer. You can use osinfo_media_get_installer (or OsinfoMedia::installer) to check that.
Warning: Some media allow you to install from live sessions, in which case number of reboots *alone* is not a reliable method for tracking installation.
|
a OsinfoMedia instance |
Returns : |
the number of installer reboots or -1 if media is not an installer. [transfer none] |
"application-id"
property "application-id" gchar* : Read / Write
Expected ISO9660 application ID.
Default value: NULL
"architecture"
property "architecture" gchar* : Read / Write
CPU Architecture.
Default value: NULL
"initrd-path"
property "initrd-path" gchar* : Read / Write
The path to the inirtd image.
Default value: NULL
"installer"
property "installer" gboolean : Read / Write / Construct
Media provides a installer.
Default value: TRUE
"installer-reboots"
property "installer-reboots" gint : Read / Write / Construct
Number of installer reboots.
Default value: -1
"kernel-path"
property "kernel-path" gchar* : Read / Write
The path to the kernel image.
Default value: NULL
"live"
property "live" gboolean : Read / Write / Construct
Media can boot directly w/o installation.
Default value: FALSE
"publisher-id"
property "publisher-id" gchar* : Read / Write
Expected ISO9660 publisher ID.
Default value: NULL
"system-id"
property "system-id" gchar* : Read / Write
Expected ISO9660 system ID.
Default value: NULL