refInfoGetProcessedDocLength

SYNOPSIS

int64 refInfoGetProcessedDocLength(refInfo ref)

Parameters:

  • ref - A refInfo object

Returns:

  • The int64 character length of the reference's element in the processed document (HTML)


DESCRIPTION
The refInfoGetProcessedDocLength function returns the int64 character (not byte) length of the reference's element in the processed document (here), which is the HTML that was processed (downloaded HTML plus any dynamic HTML, in UTF-8). The length will generally span from the start of the opening tag through the end of the closing tag (if any).


EXAMPLE

<urlinfo processeddoc><$html = $ret>
  <$offset = (refInfoGetProcessedDocOffset($ref))>
  <$length = (refInfoGetProcessedDocLength($ref))>
  <substr $html $offset $length>
  Reference's HTML: $ret


CAVEATS
Note that the returned length is in characters, not bytes. Thus the length is typically correct for use with <substr> (with default stringcomparemode) on <urlinfo processeddoc>, which is always UTF-8 if possible.

The length may be -1 (unavailable) in some instances, e.g. if the reference was generated by JavaScript.


SEE ALSO
refInfoGetRawDocLength


Copyright © Thunderstone Software     Last updated: Jul 17 2021
Copyright © 2021 Thunderstone Software LLC. All rights reserved.