Curtis Jewell > WiX3 > WiX3::XML::Directory

Download:
WiX3-0.011.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

Open  1
View/Report Bugs
Module Version: 0.011   Source  

NAME ^

WiX3::XML::Directory - Class representing a Directory tag.

VERSION ^

This document describes WiX3::XML::Directory version 0.009100

SYNOPSIS ^

    my $tag = WiX3::XML::Directory->new(
          name => 'Test';
          path => 'ProgramFilesDir\Test';
        );

DESCRIPTION ^

This class represents a Directory tag and takes most non-deprecated attributes that the tag has (ComponentGuidGenerationSeed is the exception) as parameters.

If an id parameter is not passed, one will be generated using the path parameter.

All attributes are lowercased when passed as a parameter.

INTERFACE ^

This class implementes all methods of the XML::WiX3::Classes::Role::Tag role.

Other parameters to new

These parameters will not go into the XML output, although they may affect it.

path

This is a path that will be used when searching for this directory.

To easily implement this when using standard directories, just use the standard directory name as the root.

noprefix

The Id printed in the XML that this class generates will have a prefix of D_ unless this is set to true.

This is used for standard directories.

get_directory_id

Returns the ID of the directory as it will be printed out in the XML file.

DIAGNOSTICS ^

This module throws an WiX3::Exception::Parameter::Odd object upon build if the parameter count is incorrect.

BUGS AND LIMITATIONS ^

No bugs have been reported.

Please report any bugs or feature requests to bug-wix3@rt.cpan.org, or through the web interface at http://rt.cpan.org.

AUTHOR ^

Curtis Jewell <csjewell@cpan.org>

SEE ALSO ^

http://wix.sourceforge.net/manual-wix3/wix_xsd_directory.htm

LICENCE AND COPYRIGHT ^

Copyright 2009, 2010 Curtis Jewell <csjewell@cpan.org>.

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

DISCLAIMER OF WARRANTY ^

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

syntax highlighting: