XesamGHits

XesamGHits — Container used to encapsulate a batch of XesamGHit objects

Synopsis

                    XesamGHitsPrivate;
                    XesamGHits;
guint               xesam_g_hits_get_count              (XesamGHits *hits);
XesamGHit*          xesam_g_hits_get                    (XesamGHits *hits,
                                                         guint offset);

Object Hierarchy

  GObject
   +----XesamGHits

Description

Container for conveniently handling and managing a batch of XesamGHit objects.

XesamGHits is available since 1.0

Details

XesamGHitsPrivate

typedef struct _XesamGHitsPrivate XesamGHitsPrivate;


XesamGHits

typedef struct _XesamGHits XesamGHits;


xesam_g_hits_get_count ()

guint               xesam_g_hits_get_count              (XesamGHits *hits);

hits :

The hits object to get the hit count on

Returns :

The number of hits in the XesamGHits object

xesam_g_hits_get ()

XesamGHit*          xesam_g_hits_get                    (XesamGHits *hits,
                                                         guint offset);

Get a handle to the n'th XesamGHit in a XesamGHits object.

XesamGHit objects are generated lazily and cached. The hit is cached in the XesamGHits object for the entire lifetime of the parent hits.

If you need a reference to the hit past the lifetime of the XesamGHits object's lifetime you need to reference the XesamGHit object.

hits :

The XesamGHits object to retrieve a hit from

offset :

Offset in the XesamGHits of the hit to retrieve

Returns :

The hit at the specified offset or NULL if the offset is out of bounds