## AccessibleHyperlink Interface

AccessibleHyperlink Interface

## Synopsis

    void                AccessibleHyperlink_ref             (AccessibleHyperlink *obj);
    void                AccessibleHyperlink_unref           (AccessibleHyperlink *obj);
    long                AccessibleHyperlink_getNAnchors     (AccessibleHyperlink *obj);
    void                AccessibleHyperlink_getIndexRange   (AccessibleHyperlink *obj,
                                                             long int *startIndex,
                                                             long int *endIndex);
    Accessible*         AccessibleHyperlink_getObject       (AccessibleHyperlink *obj,
                                                             long int i);
    char*               AccessibleHyperlink_getURI          (AccessibleHyperlink *obj,
                                                             long int i);
    SPIBoolean          AccessibleHyperlink_isValid         (AccessibleHyperlink *obj);

## Description

## Details

### AccessibleHyperlink_ref ()

    void                AccessibleHyperlink_ref             (AccessibleHyperlink *obj);

Increment the reference count for an AccessibleHyperlink object.

`obj` : | a pointer to the AccessibleHyperlink object on which to operate.

### AccessibleHyperlink_unref ()

    void                AccessibleHyperlink_unref           (AccessibleHyperlink *obj);

Decrement the reference count for an AccessibleHyperlink object.

`obj` : | a pointer to the AccessibleHyperlink object on which to operate.

### AccessibleHyperlink_getNAnchors ()

    long                AccessibleHyperlink_getNAnchors     (AccessibleHyperlink *obj);

Get the total number of anchors which an AccessibleHyperlink implementor has. Though typical hyperlinks have only one anchor, client-side image maps and other hypertext objects may potentially activate or refer to multiple URIs. For each anchor there is a corresponding URI and object. `see` `AccessibleHyperlink_getURI()` and `AccessibleHyperlink_getObject()`.

`obj` : | a pointer to the AccessibleHyperlink object on which to operate.
Returns : | a long indicating the number of anchors in this hyperlink.

### AccessibleHyperlink_getIndexRange ()

    void                AccessibleHyperlink_getIndexRange   (AccessibleHyperlink *obj,
                                                             long int *startIndex,
                                                             long int *endIndex);

Get the starting and ending character offsets of the text range associated with a AccessibleHyperlink, in its originating AccessibleHypertext.

`obj` : | a pointer to the AccessibleHyperlink implementor on which to operate.
`startIndex` : | a pointer to a long integer into which the starting offset of the text associated with this AccessibleHyperlink is returned.
`endIndex` : | a pointer to a long integer into which the offset of the first character after the text associated with this AccessibleHyperlink is returned.

### AccessibleHyperlink_getObject ()

    Accessible*         AccessibleHyperlink_getObject       (AccessibleHyperlink *obj,
                                                             long int i);

Get the object associated with a particular hyperlink anchor, as an Accessible.

`obj` : | a pointer to the AccessibleHyperlink implementor on which to operate.
`i` : | a (zero-index) long integer indicating which hyperlink anchor to query.
Returns : | an Accessible that represents the object associated with the `ith` anchor of the specified AccessibleHyperlink.

### AccessibleHyperlink_getURI ()

    char*               AccessibleHyperlink_getURI          (AccessibleHyperlink *obj,
                                                             long int i);

Get the URI associated with a particular hyperlink anchor.

`obj` : | a pointer to the AccessibleHyperlink implementor on which to operate.
`i` : | a (zero-index) long integer indicating which hyperlink anchor to query.
Returns : | a UTF-8 string giving the URI of the `ith` hyperlink anchor.

### AccessibleHyperlink_isValid ()

    SPIBoolean          AccessibleHyperlink_isValid         (AccessibleHyperlink *obj);

Tell whether an AccessibleHyperlink object is still valid with respect to its originating hypertext object.

`obj` : | a pointer to the AccessibleHyperlink on which to operate.
Returns : | TRUE of the specified AccessibleHyperlink is still valid with respect to its originating AccessibleHypertext object, FALSE otherwise.