Perl Diver 2.33
Main Environment Variables Perl Default Values Perl Config - Summary Perl Config - Full Installed Modules List Directory uptime Docs

Module Documentation
Details and documentation about a specific module, including version and documentation (if available). Note that while links to perldoc.com and search.cpan.org are provided, the module may be part of a larger distribution. If you reach a File Not Found page on either site, please try the parent module.

XML::Grove::AsCanonXML

Name XML::Grove::AsCanonXML
Version
Located at /usr/share/perl5
File /usr/share/perl5/XML/Grove/AsCanonXML.pm
Is Core No
Search CPAN for this module XML::Grove::AsCanonXML
Documentation XML::Grove::AsCanonXML
Module Details XML::Grove::AsCanonXML

NAME

XML::Grove::AsCanonXML - output XML objects in canonical XML


SYNOPSIS

 use XML::Grove::AsCanonXML;
 # Using as_canon_xml method on XML::Grove objects:
 $string = $xml_object->as_canon_xml( OPTIONS );
 # Using an XML::Grove::AsCanonXML instance:
 $writer = XML::Grove::AsCanonXML->new( OPTIONS );
 $string = $writer->as_canon_xml($xml_object);
 $writer->as_canon_xml($xml_object, $file_handle);


DESCRIPTION

XML::Grove::AsCanonXML will return a string or write a stream of canonical XML for an XML object and it's content (if any).

XML::Grove::AsCanonXML objects hold the options used for writing the XML objects. Options can be supplied when the the object is created,

    $writer = XML::Grove::AsCanonXML->new( Comments => 1 );

or modified at any time before writing an XML object by setting the option directly in the `$writer' hash.


OPTIONS

Comments
By default comments are not written to the output. Setting comment to TRUE will include comments in the output.


AUTHOR

Ken MacLeod, ken@bitsko.slc.ut.us


SEE ALSO

perl(1), XML::Parser(3), XML::Grove(3).

James Clark's Canonical XML definition <http://www.jclark.com/xml/canonxml.html>

Perl Diver brought to you by ScriptSolutions.com © 1997- 2026