Gdome2 Reference Manual
<<< Previous Page | Home | Up | Next Page >>>

# Module Private List

## Name

Module Private List -- Structures and APIs

## Synopsis

    struct      GdomePrivateList;
    GdomePrivateList* gdome_private_list_append (GdomePrivateList *list,
                                                 void *data);
    GdomePrivateList* gdome_private_list_prepend
                                                (GdomePrivateList *list,
                                                 void *data);
    unsigned int gdome_private_list_length      (GdomePrivateList *list);
    GdomePrivateList* gdome_private_list_remove (GdomePrivateList *list,
                                                 void *data);
    GdomePrivateList* gdome_private_list_nth    (GdomePrivateList *list,
                                                 unsigned int n);

## Description

This module is used to debug the gdome2 reference counting system, you can access to those information specifing --with-ref-debug option configuring gdome2 compilation process (./configure --with-ref-debug).

## Details

### struct GdomePrivateList

    struct GdomePrivateList {
    	void *data;
    	GdomePrivateList *next;
    };

### gdome_private_list_append ()

    GdomePrivateList* gdome_private_list_append (GdomePrivateList *list,
                                                 void *data);

Append a new element containing `data` to the list specified.

`list` : | a pointer to the list to which append a new element
`data` : | a pointer to the data that we want to add to the list
Returns : | the list with the new element appended.

### gdome_private_list_prepend ()

    GdomePrivateList* gdome_private_list_prepend
                                                (GdomePrivateList *list,
                                                 void *data);

Add a new element containing `data` at the first position of list specified.

`list` : | a pointer to the list to which add a new element in the first position
`data` : | a pointer to the data that we want to add to the list
Returns : | the list with the new element added.

### gdome_private_list_length ()

    unsigned int gdome_private_list_length      (GdomePrivateList *list);

`list` : | a pointer to a list
Returns : | the number of elements in the list specified.

### gdome_private_list_remove ()

    GdomePrivateList* gdome_private_list_remove (GdomePrivateList *list,
                                                 void *data);

Remove the element containing `data` from the list.

`list` : | a pointer to the list to which remove an element
`data` : | the pointer to the data that is to be removed from the list
Returns : | the resulted list.

### gdome_private_list_nth ()

    GdomePrivateList* gdome_private_list_nth    (GdomePrivateList *list,
                                                 unsigned int n);

`list` : | a pointer to the list of which the nth element is wanted
`n` : | the index to the element wanted
Returns : | a pointer to the nth element of the list specified.

<<< Previous Page | Home | Up | Next Page >>>
Memory Management System | Module Tree Garbage Collector