Curtis Jewell > Alien-WiX-Version30-1.305419001 > Alien::WiX

Download:
Alien-WiX-Version30-1.305419001.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 1.305419001   Source  

NAME ^

Alien::WiX - Installing and finding Windows Installer XML (WiX)

VERSION ^

This document describes Alien::WiX version 1.305419001.

Note that the first digit will change if the API changes in an incompatible or major manner, while the other digits change when the version of WiX that is installed by this module changes.

There is no incompatibility between 0.x and 1.x versions, however.

SYNOPSIS ^

    use Alien::WiX qw(:GENERAL);

    print wix_version();
    # Prints 3.0.5419.0, usually.
    
    $version_number = wix_version_number();
    die 'WiX beta-exit build or better required, stopping' 
        if ($version_number < 4805)
    
    print wix_binary('candle'), " exists\n";
    print wix_library('WixFirewall'), " exists\n";
    
    use Alien::WiX 0.305419 qw(:ALL);
    
    print wix_bin_candle(), " exists\n";
    print wix_bin_light(), " exists\n";
    print wix_lib_wixui(), " exists\n";

DESCRIPTION ^

Installing this module will also install Windows Installer XML (otherwise known as WiX) version 3.0.5419.0, if it (or a later version) has not already been installed.

This module provides utility subroutines that would be useful for programs that use WiX to create Windows Installer (.msi) installation packages.

INTERFACE ^

All routines will croak when errors occur. useing the module will also croak if WiX is not installed.

wix_version

Returns the version of Windows Installer XML (i.e. 3.0.5419.0) as a string.

wix_version_number

Returns the third portion of the version of Windows Installer XML (i.e. if wix_version returns 3.0.5419.0, this returns 5419) as a number.

wix_binary

Returns the location of the WiX program specified as its first parameter. The '.exe' part is not required.

wix_library

Returns the location of the WiX extension library specified as its first parameter. The 'Extension.dll' part is not required.

wix_bin_candle

wix_bin_light

Returns the location of candle.exe or light.exe.

wix_lib_wixui

Returns the location of the WixUI extension library.

DIAGNOSTICS ^

Windows Installer XML not installed, cannot continue

The module could not find the registry key for WiX 3.0.

Cannot execute %s

The file wix_binary or a wix_bin routine was attempting to find could not be found or it could not be executed.

Cannot find %s

The file wix_library or a wix_lib routine was attempting to find could not be found.

CONFIGURATION AND ENVIRONMENT ^

Alien::WiX requires no configuration files or environment variables.

It checks the registry entries that WiX's installer wrote to the Windows registry to get its return values.

Note that this module checks if Windows Installer XML is INSTALLED, NOT that it successfully executes.

DEPENDENCIES ^

This module requires Perl 5.8.0.

Non-core perl modules required are Win32API::Registry (which is required to be installed in order to run the Makefile.PL or Build.PL successfully), Module::Build (which is required to install this module), Win32::TieRegistry, version, and Readonly.

Installation of Alien::WiX will install Microsoft .NET Framework 2.0 SP1 and Windows Installer XML 3.0.5419.0 by downloading them from the appropriate sites unless otherwise specified.

INCOMPATIBILITIES ^

If you want to install WiX in a non-default location, you will want to install it yourself before installing this module.

BUGS AND LIMITATIONS ^

No bugs have been reported.

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

AUTHOR ^

Curtis Jewell <csjewell@cpan.org>

LICENCE AND COPYRIGHT ^

Copyright (c) 2009, Curtis Jewell.

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

The software installed by this module has its own licenses and copyrights, and is not included in this license and copyright.

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: