MIRAGE_Index object

MIRAGE_Index object

Synopsis

#include <mirage.h>

                    MIRAGE_Index;
gboolean            mirage_index_set_number             (MIRAGE_Index *self,
                                                         gint number,
                                                         GError **error);
gboolean            mirage_index_get_number             (MIRAGE_Index *self,
                                                         gint *number,
                                                         GError **error);
gboolean            mirage_index_set_address            (MIRAGE_Index *self,
                                                         gint address,
                                                         GError **error);
gboolean            mirage_index_get_address            (MIRAGE_Index *self,
                                                         gint *address,
                                                         GError **error);

Description

Details

MIRAGE_Index

typedef struct {
    MIRAGE_Object parent;
} MIRAGE_Index;

Contains private data only, and should be accessed using the functions below.


mirage_index_set_number ()

gboolean            mirage_index_set_number             (MIRAGE_Index *self,
                                                         gint number,
                                                         GError **error);

Sets index' index number.

self :

a MIRAGE_Index

number :

index number

error :

location to store error, or NULL

Returns :

TRUE on success, FALSE on failure

mirage_index_get_number ()

gboolean            mirage_index_get_number             (MIRAGE_Index *self,
                                                         gint *number,
                                                         GError **error);

Retrieves index' index number.

self :

a MIRAGE_Index

number :

location to store index number

error :

location to store error, or NULL

Returns :

TRUE on success, FALSE on failure

mirage_index_set_address ()

gboolean            mirage_index_set_address            (MIRAGE_Index *self,
                                                         gint address,
                                                         GError **error);

Sets index' start address. The address is given in sectors.

self :

a MIRAGE_Index

address :

address

error :

location to store error, or NULL

Returns :

TRUE on success, FALSE on failure

mirage_index_get_address ()

gboolean            mirage_index_get_address            (MIRAGE_Index *self,
                                                         gint *address,
                                                         GError **error);

Retrieves index' start adddress. The address is given in sectors.

self :

a MIRAGE_Index

address :

location to store address

error :

location to store error, or NULL

Returns :

TRUE on success, FALSE on failure