trusty (3) HTMLDocument.string.3kaya.gz

Provided by: kaya_0.4.4-6ubuntu3_amd64 bug

NAME
       HTMLDocument::string - Convert an entire HTML document to a String


SYNOPSIS
       String string( HTMLDocument doc, UnicodeFormat uform=LiteralUTF8 )


ARGUMENTS
       doc The HTML document

       uform  The mode for handling multibyte UTF-8 characters.  LiteralUTF8 will give a smaller String, and one
       that is more readable in other Unicode-aware applications.  NumericReference will give a  larger  String,
       especially  if  multibyte characters are very common in the text, but will work better if the String will
       later be edited in non-Unicode applications. This argument is optional, and defaults to  the  recommended
       LiteralUTF8


DESCRIPTION
       Converts  the  entire document to String form for output. If the String will then be immediately printed,
       the HTMLDocument.write (3kaya) function is considerably more efficient.

    str = string(doc);
    str = string(doc,NumericReference);


AUTHORS
       Kaya standard  library  by  Edwin  Brady,  Chris  Morris  and  others  (kaya@kayalang.org).  For  further
       information see http://kayalang.org/


LICENSE
       The  Kaya  standard library is free software; you can redistribute it and/or modify it under the terms of
       the GNU Lesser General Public License (version 2.1 or  any  later  version)  as  published  by  the  Free
       Software Foundation.


       ElementTreeData.UnicodeFormat (3kaya)
       HTMLDocument.HTMLDocument (3kaya)
       HTMLDocument.substring (3kaya)
       HTMLDocument.write (3kaya)