.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "String 3pm"
.TH String 3pm "2022-10-13" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
XML::Writer::String \- Capture output from XML::Writer.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  use XML::Writer;
\&  use XML::Writer::String;
\&
\&  my $s = XML::Writer::String\->new();
\&  my $writer = new XML::Writer( OUTPUT => $s );
\&
\&  $writer\->xmlDecl();
\&  $writer\->startTag(\*(Aqroot\*(Aq);
\&  $writer\->endTag();
\&  $writer\->end();
\&
\&  print $s\->value();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module implements a bare-bones class specifically for the purpose 
of capturing data from the XML::Writer module.  XML::Writer expects an 
IO::Handle object and writes \s-1XML\s0 data to the specified object (or \s-1STDOUT\s0) 
via it's \fBprint()\fR method.  This module simulates such an object for the 
specific purpose of providing the required \fBprint()\fR method.
.PP
It is recommended that \f(CW$writer\fR\->\fBend()\fR is called prior to calling \f(CW$s\fR\->\fBvalue()\fR 
to check for well-formedness.
.SH "METHODS"
.IX Header "METHODS"
XML::Writer::String provides three methods, \f(CW\*(C`new()\*(C'\fR, \f(CW\*(C`print()\*(C'\fR and 
\&\f(CW\*(C`value()\*(C'\fR:
.ie n .IP """$s = XML::Writer::String\-""new([list]);>" 4
.el .IP "\f(CW$s = XML::Writer::String\-\fRnew([list]);>" 4
.IX Item "$s = XML::Writer::String-new([list]);>"
\&\fBnew()\fR returns a new String handle.
.ie n .IP """$count = $s\-""print([list]);>" 4
.el .IP "\f(CW$count = $s\-\fRprint([list]);>" 4
.IX Item "$count = $s-print([list]);>"
\&\fBprint()\fR appends concatenated list data and returns number of items in list.
.ie n .IP """$val = $s\-""value([list]);>" 4
.el .IP "\f(CW$val = $s\-\fRvalue([list]);>" 4
.IX Item "$val = $s-value([list]);>"
\&\fBvalue()\fR returns the current content of the object as a scalar.  It can also be used to 
initialize/overwrite the current content with concatenated list data.
.SH "NOTES"
.IX Header "NOTES"
This module is designed for the specific purpose of capturing the output of XML::Writer 
objects, as described in this document.  It does not inherit form IO::Handle.  For an 
alternative solution look at IO::Scalar, IO::Lines, IO::String or Tie::Handle::Scalar.
.SH "AUTHOR"
.IX Header "AUTHOR"
Simon Oliver <simon.oliver@umist.ac.uk>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2002 Simon Oliver
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
XML::Writer, IO::Handle, IO::Scalar