refInfoGetSuppressedReason

SYNOPSIS

varchar refInfoGetSuppressedReason(refInfo ref)

Parameters:

• ref - A refInfo object

Returns:

• A varchar human-readable value describing why the reference was suppressed, or ok if not suppressed

DESCRIPTION
The refInfoGetSuppressedReason function returns a varchar value describing why the reference was suppressed (removed from the list of <urlinfo links> etc.). For example, refs within elements matching ignorerefsselectors (here) are suppressed. The value is a human-readable description, or the computer-parseable token ok if the reference is not suppressed.

EXAMPLE

<$ret = (refInfoGetSuppressedReason($ref))>
  <if "ok" eq $ret>
    Ref is valid
  <else>
    Ref is suppressed: $ret
  </if>

CAVEATS
The refInfoGetSuppressedReason function was added in version 8.01.1664481650 20220929. <urlinfo allrefs> refs include suppressed refs; other lists (e.g. <urlinfo links>) do not. In previous versions, suppressed links effectively did not exist, or were permanently removed.