Curtis Jewell > Perl-Dist-WiX-1.500002 > Perl::Dist::WiX::Tag::MergeModule

Download:
Perl-Dist-WiX-1.500002.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

New  1
Open  3
View/Report Bugs
Module Version: 1.500   Source  

NAME ^

Perl::Dist::WiX::Tag::MergeModule - <Merge> tag that makes its own <MergeRef> when requested.

VERSION ^

This document describes Perl::Dist::WiX::Tag::MergeModule version 1.500.

SYNOPSIS ^

  my $tag = Perl::Dist::WiX::Tag::MergeModule->new(
                        id          => 'Perl',
                        disk_id     => 1,
                        language    => 1033,
                        source_file => catfile(
                                $dist->output_dir(), $dist->output_base_filename() . '.msm'
                        ),
                        primary_reference => 1,
  );

DESCRIPTION ^

This object defines an XML tag that links a Merge Module into a Perl::Dist::WiX based distribution.

METHODS ^

This class is a WiX3::XML::Merge and inherits its API, so only additional API is documented here.

new

The new constructor takes a series of parameters, validates then and returns a new Perl::Dist::WiX::Tag::MergeModule|Perl::Dist::WiX::Tag::MergeModule object.

If an error occurs, it throws an exception.

It inherits all the parameters described in the WiX3::XML::Merge new method documentation, and adds one additional parameter.

primary_reference

The optional boolean primary_reference param specifies whether the merge module's reference requested with get_merge_reference is the "primary reference" (whether the Primary attribute to the reference is set to "yes") to the contents of the merge module.

get_merge_reference

The get_merge_reference method returns the WiX3::XML::MergeRef defined by the new method's id and primary_reference parameters.

SUPPORT ^

Bugs should be reported via the CPAN bug tracker at

http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Perl-Dist-WiX

For other issues, contact the author.

AUTHOR ^

Curtis Jewell <csjewell@cpan.org>

SEE ALSO ^

Perl::Dist::WiX, http://wix.sourceforge.net/manual-wix3/wix_xsd_merge.htm, http://wix.sourceforge.net/manual-wix3/wix_xsd_mergeref.htm

COPYRIGHT ^

Copyright 2009 - 2010 Curtis Jewell.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

The full text of the license can be found in the LICENSE file included with this module.

syntax highlighting: