refInfoGetDescription

SYNOPSIS

varchar refInfoGetDescription(refInfo ref)

Parameters:

• ref - A refInfo object

Returns:

• The varchar human description of the reference.

DESCRIPTION
The refInfoGetDescription function returns the varchar description of the given reference. This is intended as a short human-readble note, not for machine parsing, as its format may change in the future.

EXAMPLE

<$ret = (refInfoGetDescription($ref))>
  Description: $ret

The output might be "a href" for a simple link, or "document.location" for a JavaScript redirect taken as a link.

SEE ALSO
refInfoGetTypes, refInfoGetFlags