X7ROOT File Manager
Current Path:
/usr/share/doc/python2-docs/html/library
usr
/
share
/
doc
/
python2-docs
/
html
/
library
/
π
..
π
2to3.html
(58.11 KB)
π
__builtin__.html
(10.81 KB)
π
__future__.html
(14.34 KB)
π
__main__.html
(7.34 KB)
π
_winreg.html
(63.12 KB)
π
abc.html
(25.22 KB)
π
aepack.html
(13.83 KB)
π
aetools.html
(16 KB)
π
aetypes.html
(20.53 KB)
π
aifc.html
(24.48 KB)
π
al.html
(18.23 KB)
π
allos.html
(34.47 KB)
π
anydbm.html
(17.7 KB)
π
archiving.html
(9.84 KB)
π
argparse.html
(257.44 KB)
π
array.html
(31.11 KB)
π
ast.html
(37.27 KB)
π
asynchat.html
(33.13 KB)
π
asyncore.html
(39.68 KB)
π
atexit.html
(18.02 KB)
π
audioop.html
(33.45 KB)
π
autogil.html
(8.53 KB)
π
base64.html
(21.35 KB)
π
basehttpserver.html
(36.56 KB)
π
bastion.html
(11.52 KB)
π
bdb.html
(40.42 KB)
π
binascii.html
(22.46 KB)
π
binhex.html
(11.04 KB)
π
bisect.html
(24.09 KB)
π
bsddb.html
(27.92 KB)
π
bz2.html
(28.37 KB)
π
calendar.html
(40.78 KB)
π
carbon.html
(50.78 KB)
π
cd.html
(29.33 KB)
π
cgi.html
(54.61 KB)
π
cgihttpserver.html
(13.7 KB)
π
cgitb.html
(11.98 KB)
π
chunk.html
(15.53 KB)
π
cmath.html
(27.7 KB)
π
cmd.html
(28.36 KB)
π
code.html
(26.33 KB)
π
codecs.html
(115.49 KB)
π
codeop.html
(15.53 KB)
π
collections.html
(144.19 KB)
π
colorpicker.html
(7.85 KB)
π
colorsys.html
(11.64 KB)
π
commands.html
(15.15 KB)
π
compileall.html
(18.18 KB)
π
compiler.html
(74.12 KB)
π
configparser.html
(66.16 KB)
π
constants.html
(13.65 KB)
π
contextlib.html
(22.24 KB)
π
cookie.html
(40.87 KB)
π
cookielib.html
(88.9 KB)
π
copy.html
(12.7 KB)
π
copy_reg.html
(14.35 KB)
π
crypt.html
(10.4 KB)
π
crypto.html
(7.58 KB)
π
csv.html
(74.66 KB)
π
ctypes.html
(258.37 KB)
π
curses.ascii.html
(24.29 KB)
π
curses.html
(163.58 KB)
π
curses.panel.html
(15.45 KB)
π
custominterp.html
(7.84 KB)
π
datatypes.html
(17.59 KB)
π
datetime.html
(247.5 KB)
π
dbhash.html
(16.43 KB)
π
dbm.html
(13.19 KB)
π
debug.html
(10.45 KB)
π
decimal.html
(217.1 KB)
π
development.html
(14.48 KB)
π
difflib.html
(89.82 KB)
π
dircache.html
(12.01 KB)
π
dis.html
(82.18 KB)
π
distribution.html
(7.5 KB)
π
distutils.html
(9.91 KB)
π
dl.html
(17.25 KB)
π
doctest.html
(181.53 KB)
π
docxmlrpcserver.html
(17.16 KB)
π
dumbdbm.html
(15.18 KB)
π
dummy_thread.html
(9.83 KB)
π
dummy_threading.html
(8.72 KB)
π
easydialogs.html
(32.35 KB)
π
email-examples.html
(46.31 KB)
π
email.charset.html
(28.73 KB)
π
email.encoders.html
(12.55 KB)
π
email.errors.html
(17.53 KB)
π
email.generator.html
(22.6 KB)
π
email.header.html
(28.43 KB)
π
email.html
(54.42 KB)
π
email.iterators.html
(12.33 KB)
π
email.message.html
(68.54 KB)
π
email.mime.html
(30.91 KB)
π
email.parser.html
(34.32 KB)
π
email.utils.html
(26.44 KB)
π
ensurepip.html
(17.9 KB)
π
errno.html
(39.3 KB)
π
exceptions.html
(62.2 KB)
π
fcntl.html
(25.63 KB)
π
filecmp.html
(23.43 KB)
π
fileformats.html
(9.43 KB)
π
fileinput.html
(26.44 KB)
π
filesys.html
(10.61 KB)
π
fl.html
(55.2 KB)
π
fm.html
(12.7 KB)
π
fnmatch.html
(15.88 KB)
π
formatter.html
(36.5 KB)
π
fpectl.html
(16.48 KB)
π
fpformat.html
(11.19 KB)
π
fractions.html
(24.3 KB)
π
framework.html
(36.07 KB)
π
frameworks.html
(7.37 KB)
π
ftplib.html
(48.42 KB)
π
functions.html
(200.82 KB)
π
functools.html
(28.95 KB)
π
future_builtins.html
(14.14 KB)
π
gc.html
(27.76 KB)
π
gdbm.html
(17.39 KB)
π
gensuitemodule.html
(12.28 KB)
π
getopt.html
(24.69 KB)
π
getpass.html
(11.16 KB)
π
gettext.html
(82.98 KB)
π
gl.html
(23.77 KB)
π
glob.html
(14.09 KB)
π
grp.html
(11.05 KB)
π
gzip.html
(20.09 KB)
π
hashlib.html
(24.87 KB)
π
heapq.html
(34.07 KB)
π
hmac.html
(14.04 KB)
π
hotshot.html
(19.67 KB)
π
htmllib.html
(27.03 KB)
π
htmlparser.html
(41.44 KB)
π
httplib.html
(69.27 KB)
π
i18n.html
(9.81 KB)
π
ic.html
(18.22 KB)
π
idle.html
(41.16 KB)
π
imageop.html
(15.72 KB)
π
imaplib.html
(57.14 KB)
π
imgfile.html
(12.43 KB)
π
imghdr.html
(11.95 KB)
π
imp.html
(36.72 KB)
π
importlib.html
(8.72 KB)
π
imputil.html
(32.78 KB)
π
index.html
(77.23 KB)
π
inspect.html
(55.49 KB)
π
internet.html
(25.53 KB)
π
intro.html
(9.13 KB)
π
io.html
(111.04 KB)
π
ipc.html
(16.21 KB)
π
itertools.html
(122.46 KB)
π
jpeg.html
(13.43 KB)
π
json.html
(71.95 KB)
π
keyword.html
(8.02 KB)
π
language.html
(11.41 KB)
π
linecache.html
(11.15 KB)
π
locale.html
(60.13 KB)
π
logging.config.html
(78.17 KB)
π
logging.handlers.html
(78.31 KB)
π
logging.html
(107.67 KB)
π
mac.html
(22.83 KB)
π
macos.html
(15.75 KB)
π
macosa.html
(13.75 KB)
π
macostools.html
(16.5 KB)
π
macpath.html
(8.19 KB)
π
mailbox.html
(167.11 KB)
π
mailcap.html
(13.8 KB)
π
markup.html
(19.4 KB)
π
marshal.html
(19 KB)
π
math.html
(42.98 KB)
π
md5.html
(14.77 KB)
π
mhlib.html
(23.56 KB)
π
mimetools.html
(20.71 KB)
π
mimetypes.html
(29.92 KB)
π
mimewriter.html
(15.7 KB)
π
mimify.html
(14.92 KB)
π
miniaeframe.html
(12.8 KB)
π
misc.html
(7.07 KB)
π
mm.html
(9.35 KB)
π
mmap.html
(30.11 KB)
π
modulefinder.html
(17.67 KB)
π
modules.html
(8.81 KB)
π
msilib.html
(56.5 KB)
π
msvcrt.html
(20.73 KB)
π
multifile.html
(25.64 KB)
π
multiprocessing.html
(404.82 KB)
π
mutex.html
(11.86 KB)
π
netdata.html
(17.95 KB)
π
netrc.html
(13.69 KB)
π
new.html
(12.87 KB)
π
nis.html
(11.23 KB)
π
nntplib.html
(44.62 KB)
π
numbers.html
(39.68 KB)
π
numeric.html
(13.96 KB)
π
operator.html
(91.43 KB)
π
optparse.html
(244.25 KB)
π
os.html
(234.57 KB)
π
os.path.html
(42.38 KB)
π
ossaudiodev.html
(44.53 KB)
π
othergui.html
(9.18 KB)
π
parser.html
(41.56 KB)
π
pdb.html
(37.7 KB)
π
persistence.html
(15.31 KB)
π
pickle.html
(107.11 KB)
π
pickletools.html
(11.21 KB)
π
pipes.html
(19.22 KB)
π
pkgutil.html
(26.73 KB)
π
platform.html
(30.86 KB)
π
plistlib.html
(17.91 KB)
π
popen2.html
(26.95 KB)
π
poplib.html
(23.75 KB)
π
posix.html
(16.24 KB)
π
posixfile.html
(20.89 KB)
π
pprint.html
(31.45 KB)
π
profile.html
(71.08 KB)
π
pty.html
(9.96 KB)
π
pwd.html
(12.1 KB)
π
py_compile.html
(11.65 KB)
π
pyclbr.html
(15.44 KB)
π
pydoc.html
(13.33 KB)
π
pyexpat.html
(78.99 KB)
π
python.html
(12.55 KB)
π
queue.html
(26.23 KB)
π
quopri.html
(12.44 KB)
π
random.html
(41.72 KB)
π
re.html
(152.33 KB)
π
readline.html
(36.51 KB)
π
repr.html
(21.27 KB)
π
resource.html
(27.62 KB)
π
restricted.html
(12.08 KB)
π
rexec.html
(39.62 KB)
π
rfc822.html
(45.32 KB)
π
rlcompleter.html
(14.12 KB)
π
robotparser.html
(13.09 KB)
π
runpy.html
(21.41 KB)
π
sched.html
(19.41 KB)
π
scrolledtext.html
(9.5 KB)
π
select.html
(43.06 KB)
π
sets.html
(39.21 KB)
π
sgi.html
(10.13 KB)
π
sgmllib.html
(33.66 KB)
π
sha.html
(12.76 KB)
π
shelve.html
(29.25 KB)
π
shlex.html
(34.21 KB)
π
shutil.html
(44.39 KB)
π
signal.html
(33.23 KB)
π
simplehttpserver.html
(19.87 KB)
π
simplexmlrpcserver.html
(36.91 KB)
π
site.html
(26.26 KB)
π
smtpd.html
(13.27 KB)
π
smtplib.html
(45.95 KB)
π
sndhdr.html
(10.74 KB)
π
socket.html
(113.69 KB)
π
socketserver.html
(74.64 KB)
π
someos.html
(16.09 KB)
π
spwd.html
(10.9 KB)
π
sqlite3.html
(146.5 KB)
π
ssl.html
(197.71 KB)
π
stat.html
(33.79 KB)
π
statvfs.html
(11.06 KB)
π
stdtypes.html
(291.16 KB)
π
string.html
(117.4 KB)
π
stringio.html
(19.59 KB)
π
stringprep.html
(17.31 KB)
π
strings.html
(15.53 KB)
π
struct.html
(43.84 KB)
π
subprocess.html
(107.86 KB)
π
sun.html
(7.08 KB)
π
sunau.html
(29.31 KB)
π
sunaudio.html
(18.79 KB)
π
symbol.html
(7.95 KB)
π
symtable.html
(25.26 KB)
π
sys.html
(108.39 KB)
π
sysconfig.html
(25.68 KB)
π
syslog.html
(19.27 KB)
π
tabnanny.html
(11.13 KB)
π
tarfile.html
(86.65 KB)
π
telnetlib.html
(27.13 KB)
π
tempfile.html
(31.16 KB)
π
termios.html
(16.9 KB)
π
test.html
(55.69 KB)
π
textwrap.html
(29.43 KB)
π
thread.html
(20.98 KB)
π
threading.html
(84.62 KB)
π
time.html
(62.3 KB)
π
timeit.html
(39.58 KB)
π
tix.html
(49.4 KB)
π
tk.html
(25.95 KB)
π
tkinter.html
(82.34 KB)
π
token.html
(20.51 KB)
π
tokenize.html
(20.12 KB)
π
trace.html
(28 KB)
π
traceback.html
(39.94 KB)
π
ttk.html
(105.97 KB)
π
tty.html
(9.52 KB)
π
turtle.html
(225.08 KB)
π
types.html
(29.13 KB)
π
undoc.html
(24.1 KB)
π
unicodedata.html
(19.71 KB)
π
unittest.html
(219.75 KB)
π
unix.html
(10.96 KB)
π
urllib.html
(66.67 KB)
π
urllib2.html
(110.72 KB)
π
urlparse.html
(42.46 KB)
π
user.html
(12.41 KB)
π
userdict.html
(31.32 KB)
π
uu.html
(11.53 KB)
π
uuid.html
(29.43 KB)
π
warnings.html
(49.76 KB)
π
wave.html
(24.31 KB)
π
weakref.html
(37.9 KB)
π
webbrowser.html
(25.94 KB)
π
whichdb.html
(9.28 KB)
π
windows.html
(9.59 KB)
π
winsound.html
(19.99 KB)
π
wsgiref.html
(86.31 KB)
π
xdrlib.html
(32.24 KB)
π
xml.dom.html
(95.58 KB)
π
xml.dom.minidom.html
(42.22 KB)
π
xml.dom.pulldom.html
(13.51 KB)
π
xml.etree.elementtree.html
(109.18 KB)
π
xml.html
(17.58 KB)
π
xml.sax.handler.html
(40.9 KB)
π
xml.sax.html
(22.91 KB)
π
xml.sax.reader.html
(43.75 KB)
π
xml.sax.utils.html
(15.71 KB)
π
xmlrpclib.html
(67.57 KB)
π
zipfile.html
(60.77 KB)
π
zipimport.html
(22.24 KB)
π
zlib.html
(30.5 KB)
Editing: msilib.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="X-UA-Compatible" content="IE=Edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>35.1. msilib β Read and write Microsoft Installer files — Python 2.7.16 documentation</title> <link rel="stylesheet" href="../_static/classic.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> <script type="text/javascript" src="../_static/jquery.js"></script> <script type="text/javascript" src="../_static/underscore.js"></script> <script type="text/javascript" src="../_static/doctools.js"></script> <script type="text/javascript" src="../_static/sidebar.js"></script> <link rel="search" type="application/opensearchdescription+xml" title="Search within Python 2.7.16 documentation" href="../_static/opensearch.xml"/> <link rel="author" title="About these documents" href="../about.html" /> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> <link rel="copyright" title="Copyright" href="../copyright.html" /> <link rel="next" title="35.2. msvcrt β Useful routines from the MS VC++ runtime" href="msvcrt.html" /> <link rel="prev" title="35. MS Windows Specific Services" href="windows.html" /> <link rel="shortcut icon" type="image/png" href="../_static/py.png" /> <link rel="canonical" href="https://docs.python.org/2/library/msilib.html" /> <script type="text/javascript" src="../_static/copybutton.js"></script> </head><body> <div class="related" role="navigation" aria-label="related navigation"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="msvcrt.html" title="35.2. msvcrt β Useful routines from the MS VC++ runtime" accesskey="N">next</a> |</li> <li class="right" > <a href="windows.html" title="35. MS Windows Specific Services" accesskey="P">previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="https://www.python.org/">Python</a> »</li> <li> <a href="../index.html">Python 2.7.16 documentation</a> » </li> <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li> <li class="nav-item nav-item-2"><a href="windows.html" accesskey="U">35. MS Windows Specific Services</a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body" role="main"> <div class="section" id="module-msilib"> <span id="msilib-read-and-write-microsoft-installer-files"></span><h1>35.1. <a class="reference internal" href="#module-msilib" title="msilib: Creation of Microsoft Installer files, and CAB files. (Windows)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">msilib</span></code></a> β Read and write Microsoft Installer files<a class="headerlink" href="#module-msilib" title="Permalink to this headline">ΒΆ</a></h1> <div class="versionadded" id="index-0"> <p><span class="versionmodified">New in version 2.5.</span></p> </div> <p>The <a class="reference internal" href="#module-msilib" title="msilib: Creation of Microsoft Installer files, and CAB files. (Windows)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">msilib</span></code></a> supports the creation of Microsoft Installer (<code class="docutils literal notranslate"><span class="pre">.msi</span></code>) files. Because these files often contain an embedded βcabinetβ file (<code class="docutils literal notranslate"><span class="pre">.cab</span></code>), it also exposes an API to create CAB files. Support for reading <code class="docutils literal notranslate"><span class="pre">.cab</span></code> files is currently not implemented; read support for the <code class="docutils literal notranslate"><span class="pre">.msi</span></code> database is possible.</p> <p>This package aims to provide complete access to all tables in an <code class="docutils literal notranslate"><span class="pre">.msi</span></code> file, therefore, it is a fairly low-level API. Two primary applications of this package are the <a class="reference internal" href="distutils.html#module-distutils" title="distutils: Support for building and installing Python modules into an existing Python installation."><code class="xref py py-mod docutils literal notranslate"><span class="pre">distutils</span></code></a> command <code class="docutils literal notranslate"><span class="pre">bdist_msi</span></code>, and the creation of Python installer package itself (although that currently uses a different version of <code class="docutils literal notranslate"><span class="pre">msilib</span></code>).</p> <p>The package contents can be roughly split into four parts: low-level CAB routines, low-level MSI routines, higher-level MSI routines, and standard table structures.</p> <dl class="function"> <dt id="msilib.FCICreate"> <code class="descclassname">msilib.</code><code class="descname">FCICreate</code><span class="sig-paren">(</span><em>cabname</em>, <em>files</em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.FCICreate" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Create a new CAB file named <em>cabname</em>. <em>files</em> must be a list of tuples, each containing the name of the file on disk, and the name of the file inside the CAB file.</p> <p>The files are added to the CAB file in the order they appear in the list. All files are added into a single CAB file, using the MSZIP compression algorithm.</p> <p>Callbacks to Python for the various steps of MSI creation are currently not exposed.</p> </dd></dl> <dl class="function"> <dt id="msilib.UuidCreate"> <code class="descclassname">msilib.</code><code class="descname">UuidCreate</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#msilib.UuidCreate" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Return the string representation of a new unique identifier. This wraps the Windows API functions <code class="xref c c-func docutils literal notranslate"><span class="pre">UuidCreate()</span></code> and <code class="xref c c-func docutils literal notranslate"><span class="pre">UuidToString()</span></code>.</p> </dd></dl> <dl class="function"> <dt id="msilib.OpenDatabase"> <code class="descclassname">msilib.</code><code class="descname">OpenDatabase</code><span class="sig-paren">(</span><em>path</em>, <em>persist</em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.OpenDatabase" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Return a new database object by calling MsiOpenDatabase. <em>path</em> is the file name of the MSI file; <em>persist</em> can be one of the constants <code class="docutils literal notranslate"><span class="pre">MSIDBOPEN_CREATEDIRECT</span></code>, <code class="docutils literal notranslate"><span class="pre">MSIDBOPEN_CREATE</span></code>, <code class="docutils literal notranslate"><span class="pre">MSIDBOPEN_DIRECT</span></code>, <code class="docutils literal notranslate"><span class="pre">MSIDBOPEN_READONLY</span></code>, or <code class="docutils literal notranslate"><span class="pre">MSIDBOPEN_TRANSACT</span></code>, and may include the flag <code class="docutils literal notranslate"><span class="pre">MSIDBOPEN_PATCHFILE</span></code>. See the Microsoft documentation for the meaning of these flags; depending on the flags, an existing database is opened, or a new one created.</p> </dd></dl> <dl class="function"> <dt id="msilib.CreateRecord"> <code class="descclassname">msilib.</code><code class="descname">CreateRecord</code><span class="sig-paren">(</span><em>count</em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.CreateRecord" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Return a new record object by calling <code class="xref c c-func docutils literal notranslate"><span class="pre">MSICreateRecord()</span></code>. <em>count</em> is the number of fields of the record.</p> </dd></dl> <dl class="function"> <dt id="msilib.init_database"> <code class="descclassname">msilib.</code><code class="descname">init_database</code><span class="sig-paren">(</span><em>name</em>, <em>schema</em>, <em>ProductName</em>, <em>ProductCode</em>, <em>ProductVersion</em>, <em>Manufacturer</em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.init_database" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Create and return a new database <em>name</em>, initialize it with <em>schema</em>, and set the properties <em>ProductName</em>, <em>ProductCode</em>, <em>ProductVersion</em>, and <em>Manufacturer</em>.</p> <p><em>schema</em> must be a module object containing <code class="docutils literal notranslate"><span class="pre">tables</span></code> and <code class="docutils literal notranslate"><span class="pre">_Validation_records</span></code> attributes; typically, <a class="reference internal" href="#msilib.schema" title="msilib.schema"><code class="xref py py-mod docutils literal notranslate"><span class="pre">msilib.schema</span></code></a> should be used.</p> <p>The database will contain just the schema and the validation records when this function returns.</p> </dd></dl> <dl class="function"> <dt id="msilib.add_data"> <code class="descclassname">msilib.</code><code class="descname">add_data</code><span class="sig-paren">(</span><em>database</em>, <em>table</em>, <em>records</em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.add_data" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Add all <em>records</em> to the table named <em>table</em> in <em>database</em>.</p> <p>The <em>table</em> argument must be one of the predefined tables in the MSI schema, e.g. <code class="docutils literal notranslate"><span class="pre">'Feature'</span></code>, <code class="docutils literal notranslate"><span class="pre">'File'</span></code>, <code class="docutils literal notranslate"><span class="pre">'Component'</span></code>, <code class="docutils literal notranslate"><span class="pre">'Dialog'</span></code>, <code class="docutils literal notranslate"><span class="pre">'Control'</span></code>, etc.</p> <p><em>records</em> should be a list of tuples, each one containing all fields of a record according to the schema of the table. For optional fields, <code class="docutils literal notranslate"><span class="pre">None</span></code> can be passed.</p> <p>Field values can be int or long numbers, strings, or instances of the Binary class.</p> </dd></dl> <dl class="class"> <dt id="msilib.Binary"> <em class="property">class </em><code class="descclassname">msilib.</code><code class="descname">Binary</code><span class="sig-paren">(</span><em>filename</em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Binary" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Represents entries in the Binary table; inserting such an object using <a class="reference internal" href="#msilib.add_data" title="msilib.add_data"><code class="xref py py-func docutils literal notranslate"><span class="pre">add_data()</span></code></a> reads the file named <em>filename</em> into the table.</p> </dd></dl> <dl class="function"> <dt id="msilib.add_tables"> <code class="descclassname">msilib.</code><code class="descname">add_tables</code><span class="sig-paren">(</span><em>database</em>, <em>module</em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.add_tables" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Add all table content from <em>module</em> to <em>database</em>. <em>module</em> must contain an attribute <em>tables</em> listing all tables for which content should be added, and one attribute per table that has the actual content.</p> <p>This is typically used to install the sequence tables.</p> </dd></dl> <dl class="function"> <dt id="msilib.add_stream"> <code class="descclassname">msilib.</code><code class="descname">add_stream</code><span class="sig-paren">(</span><em>database</em>, <em>name</em>, <em>path</em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.add_stream" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Add the file <em>path</em> into the <code class="docutils literal notranslate"><span class="pre">_Stream</span></code> table of <em>database</em>, with the stream name <em>name</em>.</p> </dd></dl> <dl class="function"> <dt id="msilib.gen_uuid"> <code class="descclassname">msilib.</code><code class="descname">gen_uuid</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#msilib.gen_uuid" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Return a new UUID, in the format that MSI typically requires (i.e. in curly braces, and with all hexdigits in upper-case).</p> </dd></dl> <div class="admonition seealso"> <p class="first admonition-title">See also</p> <p class="last"><a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/devnotes/winprog/fcicreate.asp">FCICreateFile</a> <a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/rpc/rpc/uuidcreate.asp">UuidCreate</a> <a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/rpc/rpc/uuidtostring.asp">UuidToString</a></p> </div> <div class="section" id="database-objects"> <span id="id1"></span><h2>35.1.1. Database Objects<a class="headerlink" href="#database-objects" title="Permalink to this headline">ΒΆ</a></h2> <dl class="method"> <dt id="msilib.Database.OpenView"> <code class="descclassname">Database.</code><code class="descname">OpenView</code><span class="sig-paren">(</span><em>sql</em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Database.OpenView" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Return a view object, by calling <code class="xref c c-func docutils literal notranslate"><span class="pre">MSIDatabaseOpenView()</span></code>. <em>sql</em> is the SQL statement to execute.</p> </dd></dl> <dl class="method"> <dt id="msilib.Database.Commit"> <code class="descclassname">Database.</code><code class="descname">Commit</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Database.Commit" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Commit the changes pending in the current transaction, by calling <code class="xref c c-func docutils literal notranslate"><span class="pre">MSIDatabaseCommit()</span></code>.</p> </dd></dl> <dl class="method"> <dt id="msilib.Database.GetSummaryInformation"> <code class="descclassname">Database.</code><code class="descname">GetSummaryInformation</code><span class="sig-paren">(</span><em>count</em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Database.GetSummaryInformation" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Return a new summary information object, by calling <code class="xref c c-func docutils literal notranslate"><span class="pre">MsiGetSummaryInformation()</span></code>. <em>count</em> is the maximum number of updated values.</p> </dd></dl> <div class="admonition seealso"> <p class="first admonition-title">See also</p> <p class="last"><a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/msidatabaseopenview.asp">MSIDatabaseOpenView</a> <a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/msidatabasecommit.asp">MSIDatabaseCommit</a> <a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/msigetsummaryinformation.asp">MSIGetSummaryInformation</a></p> </div> </div> <div class="section" id="view-objects"> <span id="id2"></span><h2>35.1.2. View Objects<a class="headerlink" href="#view-objects" title="Permalink to this headline">ΒΆ</a></h2> <dl class="method"> <dt id="msilib.View.Execute"> <code class="descclassname">View.</code><code class="descname">Execute</code><span class="sig-paren">(</span><em>params</em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.View.Execute" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Execute the SQL query of the view, through <code class="xref c c-func docutils literal notranslate"><span class="pre">MSIViewExecute()</span></code>. If <em>params</em> is not <code class="docutils literal notranslate"><span class="pre">None</span></code>, it is a record describing actual values of the parameter tokens in the query.</p> </dd></dl> <dl class="method"> <dt id="msilib.View.GetColumnInfo"> <code class="descclassname">View.</code><code class="descname">GetColumnInfo</code><span class="sig-paren">(</span><em>kind</em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.View.GetColumnInfo" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Return a record describing the columns of the view, through calling <code class="xref c c-func docutils literal notranslate"><span class="pre">MsiViewGetColumnInfo()</span></code>. <em>kind</em> can be either <code class="docutils literal notranslate"><span class="pre">MSICOLINFO_NAMES</span></code> or <code class="docutils literal notranslate"><span class="pre">MSICOLINFO_TYPES</span></code>.</p> </dd></dl> <dl class="method"> <dt id="msilib.View.Fetch"> <code class="descclassname">View.</code><code class="descname">Fetch</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#msilib.View.Fetch" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Return a result record of the query, through calling <code class="xref c c-func docutils literal notranslate"><span class="pre">MsiViewFetch()</span></code>.</p> </dd></dl> <dl class="method"> <dt id="msilib.View.Modify"> <code class="descclassname">View.</code><code class="descname">Modify</code><span class="sig-paren">(</span><em>kind</em>, <em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.View.Modify" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Modify the view, by calling <code class="xref c c-func docutils literal notranslate"><span class="pre">MsiViewModify()</span></code>. <em>kind</em> can be one of <code class="docutils literal notranslate"><span class="pre">MSIMODIFY_SEEK</span></code>, <code class="docutils literal notranslate"><span class="pre">MSIMODIFY_REFRESH</span></code>, <code class="docutils literal notranslate"><span class="pre">MSIMODIFY_INSERT</span></code>, <code class="docutils literal notranslate"><span class="pre">MSIMODIFY_UPDATE</span></code>, <code class="docutils literal notranslate"><span class="pre">MSIMODIFY_ASSIGN</span></code>, <code class="docutils literal notranslate"><span class="pre">MSIMODIFY_REPLACE</span></code>, <code class="docutils literal notranslate"><span class="pre">MSIMODIFY_MERGE</span></code>, <code class="docutils literal notranslate"><span class="pre">MSIMODIFY_DELETE</span></code>, <code class="docutils literal notranslate"><span class="pre">MSIMODIFY_INSERT_TEMPORARY</span></code>, <code class="docutils literal notranslate"><span class="pre">MSIMODIFY_VALIDATE</span></code>, <code class="docutils literal notranslate"><span class="pre">MSIMODIFY_VALIDATE_NEW</span></code>, <code class="docutils literal notranslate"><span class="pre">MSIMODIFY_VALIDATE_FIELD</span></code>, or <code class="docutils literal notranslate"><span class="pre">MSIMODIFY_VALIDATE_DELETE</span></code>.</p> <p><em>data</em> must be a record describing the new data.</p> </dd></dl> <dl class="method"> <dt id="msilib.View.Close"> <code class="descclassname">View.</code><code class="descname">Close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#msilib.View.Close" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Close the view, through <code class="xref c c-func docutils literal notranslate"><span class="pre">MsiViewClose()</span></code>.</p> </dd></dl> <div class="admonition seealso"> <p class="first admonition-title">See also</p> <p class="last"><a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/msiviewexecute.asp">MsiViewExecute</a> <a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/msiviewgetcolumninfo.asp">MSIViewGetColumnInfo</a> <a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/msiviewfetch.asp">MsiViewFetch</a> <a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/msiviewmodify.asp">MsiViewModify</a> <a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/msiviewclose.asp">MsiViewClose</a></p> </div> </div> <div class="section" id="summary-information-objects"> <span id="summary-objects"></span><h2>35.1.3. Summary Information Objects<a class="headerlink" href="#summary-information-objects" title="Permalink to this headline">ΒΆ</a></h2> <dl class="method"> <dt id="msilib.SummaryInformation.GetProperty"> <code class="descclassname">SummaryInformation.</code><code class="descname">GetProperty</code><span class="sig-paren">(</span><em>field</em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.SummaryInformation.GetProperty" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Return a property of the summary, through <code class="xref c c-func docutils literal notranslate"><span class="pre">MsiSummaryInfoGetProperty()</span></code>. <em>field</em> is the name of the property, and can be one of the constants <code class="docutils literal notranslate"><span class="pre">PID_CODEPAGE</span></code>, <code class="docutils literal notranslate"><span class="pre">PID_TITLE</span></code>, <code class="docutils literal notranslate"><span class="pre">PID_SUBJECT</span></code>, <code class="docutils literal notranslate"><span class="pre">PID_AUTHOR</span></code>, <code class="docutils literal notranslate"><span class="pre">PID_KEYWORDS</span></code>, <code class="docutils literal notranslate"><span class="pre">PID_COMMENTS</span></code>, <code class="docutils literal notranslate"><span class="pre">PID_TEMPLATE</span></code>, <code class="docutils literal notranslate"><span class="pre">PID_LASTAUTHOR</span></code>, <code class="docutils literal notranslate"><span class="pre">PID_REVNUMBER</span></code>, <code class="docutils literal notranslate"><span class="pre">PID_LASTPRINTED</span></code>, <code class="docutils literal notranslate"><span class="pre">PID_CREATE_DTM</span></code>, <code class="docutils literal notranslate"><span class="pre">PID_LASTSAVE_DTM</span></code>, <code class="docutils literal notranslate"><span class="pre">PID_PAGECOUNT</span></code>, <code class="docutils literal notranslate"><span class="pre">PID_WORDCOUNT</span></code>, <code class="docutils literal notranslate"><span class="pre">PID_CHARCOUNT</span></code>, <code class="docutils literal notranslate"><span class="pre">PID_APPNAME</span></code>, or <code class="docutils literal notranslate"><span class="pre">PID_SECURITY</span></code>.</p> </dd></dl> <dl class="method"> <dt id="msilib.SummaryInformation.GetPropertyCount"> <code class="descclassname">SummaryInformation.</code><code class="descname">GetPropertyCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#msilib.SummaryInformation.GetPropertyCount" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Return the number of summary properties, through <code class="xref c c-func docutils literal notranslate"><span class="pre">MsiSummaryInfoGetPropertyCount()</span></code>.</p> </dd></dl> <dl class="method"> <dt id="msilib.SummaryInformation.SetProperty"> <code class="descclassname">SummaryInformation.</code><code class="descname">SetProperty</code><span class="sig-paren">(</span><em>field</em>, <em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.SummaryInformation.SetProperty" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Set a property through <code class="xref c c-func docutils literal notranslate"><span class="pre">MsiSummaryInfoSetProperty()</span></code>. <em>field</em> can have the same values as in <a class="reference internal" href="#msilib.SummaryInformation.GetProperty" title="msilib.SummaryInformation.GetProperty"><code class="xref py py-meth docutils literal notranslate"><span class="pre">GetProperty()</span></code></a>, <em>value</em> is the new value of the property. Possible value types are integer and string.</p> </dd></dl> <dl class="method"> <dt id="msilib.SummaryInformation.Persist"> <code class="descclassname">SummaryInformation.</code><code class="descname">Persist</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#msilib.SummaryInformation.Persist" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Write the modified properties to the summary information stream, using <code class="xref c c-func docutils literal notranslate"><span class="pre">MsiSummaryInfoPersist()</span></code>.</p> </dd></dl> <div class="admonition seealso"> <p class="first admonition-title">See also</p> <p class="last"><a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/msisummaryinfogetproperty.asp">MsiSummaryInfoGetProperty</a> <a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/msisummaryinfogetpropertycount.asp">MsiSummaryInfoGetPropertyCount</a> <a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/msisummaryinfosetproperty.asp">MsiSummaryInfoSetProperty</a> <a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/msisummaryinfopersist.asp">MsiSummaryInfoPersist</a></p> </div> </div> <div class="section" id="record-objects"> <span id="id3"></span><h2>35.1.4. Record Objects<a class="headerlink" href="#record-objects" title="Permalink to this headline">ΒΆ</a></h2> <dl class="method"> <dt id="msilib.Record.GetFieldCount"> <code class="descclassname">Record.</code><code class="descname">GetFieldCount</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Record.GetFieldCount" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Return the number of fields of the record, through <code class="xref c c-func docutils literal notranslate"><span class="pre">MsiRecordGetFieldCount()</span></code>.</p> </dd></dl> <dl class="method"> <dt id="msilib.Record.GetInteger"> <code class="descclassname">Record.</code><code class="descname">GetInteger</code><span class="sig-paren">(</span><em>field</em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Record.GetInteger" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Return the value of <em>field</em> as an integer where possible. <em>field</em> must be an integer.</p> </dd></dl> <dl class="method"> <dt id="msilib.Record.GetString"> <code class="descclassname">Record.</code><code class="descname">GetString</code><span class="sig-paren">(</span><em>field</em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Record.GetString" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Return the value of <em>field</em> as a string where possible. <em>field</em> must be an integer.</p> </dd></dl> <dl class="method"> <dt id="msilib.Record.SetString"> <code class="descclassname">Record.</code><code class="descname">SetString</code><span class="sig-paren">(</span><em>field</em>, <em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Record.SetString" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Set <em>field</em> to <em>value</em> through <code class="xref c c-func docutils literal notranslate"><span class="pre">MsiRecordSetString()</span></code>. <em>field</em> must be an integer; <em>value</em> a string.</p> </dd></dl> <dl class="method"> <dt id="msilib.Record.SetStream"> <code class="descclassname">Record.</code><code class="descname">SetStream</code><span class="sig-paren">(</span><em>field</em>, <em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Record.SetStream" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Set <em>field</em> to the contents of the file named <em>value</em>, through <code class="xref c c-func docutils literal notranslate"><span class="pre">MsiRecordSetStream()</span></code>. <em>field</em> must be an integer; <em>value</em> a string.</p> </dd></dl> <dl class="method"> <dt id="msilib.Record.SetInteger"> <code class="descclassname">Record.</code><code class="descname">SetInteger</code><span class="sig-paren">(</span><em>field</em>, <em>value</em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Record.SetInteger" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Set <em>field</em> to <em>value</em> through <code class="xref c c-func docutils literal notranslate"><span class="pre">MsiRecordSetInteger()</span></code>. Both <em>field</em> and <em>value</em> must be an integer.</p> </dd></dl> <dl class="method"> <dt id="msilib.Record.ClearData"> <code class="descclassname">Record.</code><code class="descname">ClearData</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Record.ClearData" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Set all fields of the record to 0, through <code class="xref c c-func docutils literal notranslate"><span class="pre">MsiRecordClearData()</span></code>.</p> </dd></dl> <div class="admonition seealso"> <p class="first admonition-title">See also</p> <p class="last"><a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/msirecordgetfieldcount.asp">MsiRecordGetFieldCount</a> <a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/msirecordsetstring.asp">MsiRecordSetString</a> <a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/msirecordsetstream.asp">MsiRecordSetStream</a> <a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/msirecordsetinteger.asp">MsiRecordSetInteger</a> <a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/msirecordclear.asp">MsiRecordClear</a></p> </div> </div> <div class="section" id="errors"> <span id="msi-errors"></span><h2>35.1.5. Errors<a class="headerlink" href="#errors" title="Permalink to this headline">ΒΆ</a></h2> <p>All wrappers around MSI functions raise <code class="xref py py-exc docutils literal notranslate"><span class="pre">MSIError</span></code>; the string inside the exception will contain more detail.</p> </div> <div class="section" id="cab-objects"> <span id="cab"></span><h2>35.1.6. CAB Objects<a class="headerlink" href="#cab-objects" title="Permalink to this headline">ΒΆ</a></h2> <dl class="class"> <dt id="msilib.CAB"> <em class="property">class </em><code class="descclassname">msilib.</code><code class="descname">CAB</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.CAB" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>The class <a class="reference internal" href="#msilib.CAB" title="msilib.CAB"><code class="xref py py-class docutils literal notranslate"><span class="pre">CAB</span></code></a> represents a CAB file. During MSI construction, files will be added simultaneously to the <code class="docutils literal notranslate"><span class="pre">Files</span></code> table, and to a CAB file. Then, when all files have been added, the CAB file can be written, then added to the MSI file.</p> <p><em>name</em> is the name of the CAB file in the MSI file.</p> <dl class="method"> <dt id="msilib.CAB.append"> <code class="descname">append</code><span class="sig-paren">(</span><em>full</em>, <em>file</em>, <em>logical</em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.CAB.append" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Add the file with the pathname <em>full</em> to the CAB file, under the name <em>logical</em>. If there is already a file named <em>logical</em>, a new file name is created.</p> <p>Return the index of the file in the CAB file, and the new name of the file inside the CAB file.</p> </dd></dl> <dl class="method"> <dt id="msilib.CAB.commit"> <code class="descname">commit</code><span class="sig-paren">(</span><em>database</em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.CAB.commit" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Generate a CAB file, add it as a stream to the MSI file, put it into the <code class="docutils literal notranslate"><span class="pre">Media</span></code> table, and remove the generated file from the disk.</p> </dd></dl> </dd></dl> </div> <div class="section" id="directory-objects"> <span id="msi-directory"></span><h2>35.1.7. Directory Objects<a class="headerlink" href="#directory-objects" title="Permalink to this headline">ΒΆ</a></h2> <dl class="class"> <dt id="msilib.Directory"> <em class="property">class </em><code class="descclassname">msilib.</code><code class="descname">Directory</code><span class="sig-paren">(</span><em>database</em>, <em>cab</em>, <em>basedir</em>, <em>physical</em>, <em>logical</em>, <em>default</em><span class="optional">[</span>, <em>componentflags</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Directory" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Create a new directory in the Directory table. There is a current component at each point in time for the directory, which is either explicitly created through <a class="reference internal" href="#msilib.Directory.start_component" title="msilib.Directory.start_component"><code class="xref py py-meth docutils literal notranslate"><span class="pre">start_component()</span></code></a>, or implicitly when files are added for the first time. Files are added into the current component, and into the cab file. To create a directory, a base directory object needs to be specified (can be <code class="docutils literal notranslate"><span class="pre">None</span></code>), the path to the physical directory, and a logical directory name. <em>default</em> specifies the DefaultDir slot in the directory table. <em>componentflags</em> specifies the default flags that new components get.</p> <dl class="method"> <dt id="msilib.Directory.start_component"> <code class="descname">start_component</code><span class="sig-paren">(</span><span class="optional">[</span><em>component</em><span class="optional">[</span>, <em>feature</em><span class="optional">[</span>, <em>flags</em><span class="optional">[</span>, <em>keyfile</em><span class="optional">[</span>, <em>uuid</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Directory.start_component" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Add an entry to the Component table, and make this component the current component for this directory. If no component name is given, the directory name is used. If no <em>feature</em> is given, the current feature is used. If no <em>flags</em> are given, the directoryβs default flags are used. If no <em>keyfile</em> is given, the KeyPath is left null in the Component table.</p> </dd></dl> <dl class="method"> <dt id="msilib.Directory.add_file"> <code class="descname">add_file</code><span class="sig-paren">(</span><em>file</em><span class="optional">[</span>, <em>src</em><span class="optional">[</span>, <em>version</em><span class="optional">[</span>, <em>language</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Directory.add_file" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Add a file to the current component of the directory, starting a new one if there is no current component. By default, the file name in the source and the file table will be identical. If the <em>src</em> file is specified, it is interpreted relative to the current directory. Optionally, a <em>version</em> and a <em>language</em> can be specified for the entry in the File table.</p> </dd></dl> <dl class="method"> <dt id="msilib.Directory.glob"> <code class="descname">glob</code><span class="sig-paren">(</span><em>pattern</em><span class="optional">[</span>, <em>exclude</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Directory.glob" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Add a list of files to the current component as specified in the glob pattern. Individual files can be excluded in the <em>exclude</em> list.</p> </dd></dl> <dl class="method"> <dt id="msilib.Directory.remove_pyc"> <code class="descname">remove_pyc</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Directory.remove_pyc" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Remove <code class="docutils literal notranslate"><span class="pre">.pyc</span></code>/<code class="docutils literal notranslate"><span class="pre">.pyo</span></code> files on uninstall.</p> </dd></dl> </dd></dl> <div class="admonition seealso"> <p class="first admonition-title">See also</p> <p class="last"><a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/directory_table.asp">Directory Table</a> <a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/file_table.asp">File Table</a> <a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/component_table.asp">Component Table</a> <a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/featurecomponents_table.asp">FeatureComponents Table</a></p> </div> </div> <div class="section" id="features"> <span id="id4"></span><h2>35.1.8. Features<a class="headerlink" href="#features" title="Permalink to this headline">ΒΆ</a></h2> <dl class="class"> <dt id="msilib.Feature"> <em class="property">class </em><code class="descclassname">msilib.</code><code class="descname">Feature</code><span class="sig-paren">(</span><em>database</em>, <em>id</em>, <em>title</em>, <em>desc</em>, <em>display</em><span class="optional">[</span>, <em>level=1</em><span class="optional">[</span>, <em>parent</em><span class="optional">[</span>, <em>directory</em><span class="optional">[</span>, <em>attributes=0</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Feature" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Add a new record to the <code class="docutils literal notranslate"><span class="pre">Feature</span></code> table, using the values <em>id</em>, <em>parent.id</em>, <em>title</em>, <em>desc</em>, <em>display</em>, <em>level</em>, <em>directory</em>, and <em>attributes</em>. The resulting feature object can be passed to the <code class="xref py py-meth docutils literal notranslate"><span class="pre">start_component()</span></code> method of <a class="reference internal" href="#msilib.Directory" title="msilib.Directory"><code class="xref py py-class docutils literal notranslate"><span class="pre">Directory</span></code></a>.</p> <dl class="method"> <dt id="msilib.Feature.set_current"> <code class="descname">set_current</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Feature.set_current" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Make this feature the current feature of <a class="reference internal" href="#module-msilib" title="msilib: Creation of Microsoft Installer files, and CAB files. (Windows)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">msilib</span></code></a>. New components are automatically added to the default feature, unless a feature is explicitly specified.</p> </dd></dl> </dd></dl> <div class="admonition seealso"> <p class="first admonition-title">See also</p> <p class="last"><a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/feature_table.asp">Feature Table</a></p> </div> </div> <div class="section" id="gui-classes"> <span id="msi-gui"></span><h2>35.1.9. GUI classes<a class="headerlink" href="#gui-classes" title="Permalink to this headline">ΒΆ</a></h2> <p><a class="reference internal" href="#module-msilib" title="msilib: Creation of Microsoft Installer files, and CAB files. (Windows)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">msilib</span></code></a> provides several classes that wrap the GUI tables in an MSI database. However, no standard user interface is provided; use <a class="reference internal" href="../distutils/apiref.html#module-distutils.command.bdist_msi" title="distutils.command.bdist_msi: Build a binary distribution as a Windows MSI file"><code class="xref py py-mod docutils literal notranslate"><span class="pre">bdist_msi</span></code></a> to create MSI files with a user-interface for installing Python packages.</p> <dl class="class"> <dt id="msilib.Control"> <em class="property">class </em><code class="descclassname">msilib.</code><code class="descname">Control</code><span class="sig-paren">(</span><em>dlg</em>, <em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Control" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Base class of the dialog controls. <em>dlg</em> is the dialog object the control belongs to, and <em>name</em> is the controlβs name.</p> <dl class="method"> <dt id="msilib.Control.event"> <code class="descname">event</code><span class="sig-paren">(</span><em>event</em>, <em>argument</em><span class="optional">[</span>, <em>condition=1</em><span class="optional">[</span>, <em>ordering</em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Control.event" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Make an entry into the <code class="docutils literal notranslate"><span class="pre">ControlEvent</span></code> table for this control.</p> </dd></dl> <dl class="method"> <dt id="msilib.Control.mapping"> <code class="descname">mapping</code><span class="sig-paren">(</span><em>event</em>, <em>attribute</em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Control.mapping" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Make an entry into the <code class="docutils literal notranslate"><span class="pre">EventMapping</span></code> table for this control.</p> </dd></dl> <dl class="method"> <dt id="msilib.Control.condition"> <code class="descname">condition</code><span class="sig-paren">(</span><em>action</em>, <em>condition</em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Control.condition" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Make an entry into the <code class="docutils literal notranslate"><span class="pre">ControlCondition</span></code> table for this control.</p> </dd></dl> </dd></dl> <dl class="class"> <dt id="msilib.RadioButtonGroup"> <em class="property">class </em><code class="descclassname">msilib.</code><code class="descname">RadioButtonGroup</code><span class="sig-paren">(</span><em>dlg</em>, <em>name</em>, <em>property</em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.RadioButtonGroup" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Create a radio button control named <em>name</em>. <em>property</em> is the installer property that gets set when a radio button is selected.</p> <dl class="method"> <dt id="msilib.RadioButtonGroup.add"> <code class="descname">add</code><span class="sig-paren">(</span><em>name</em>, <em>x</em>, <em>y</em>, <em>width</em>, <em>height</em>, <em>text</em><span class="optional">[</span>, <em>value</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#msilib.RadioButtonGroup.add" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Add a radio button named <em>name</em> to the group, at the coordinates <em>x</em>, <em>y</em>, <em>width</em>, <em>height</em>, and with the label <em>text</em>. If <em>value</em> is omitted, it defaults to <em>name</em>.</p> </dd></dl> </dd></dl> <dl class="class"> <dt id="msilib.Dialog"> <em class="property">class </em><code class="descclassname">msilib.</code><code class="descname">Dialog</code><span class="sig-paren">(</span><em>db</em>, <em>name</em>, <em>x</em>, <em>y</em>, <em>w</em>, <em>h</em>, <em>attr</em>, <em>title</em>, <em>first</em>, <em>default</em>, <em>cancel</em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Dialog" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Return a new <a class="reference internal" href="#msilib.Dialog" title="msilib.Dialog"><code class="xref py py-class docutils literal notranslate"><span class="pre">Dialog</span></code></a> object. An entry in the <code class="docutils literal notranslate"><span class="pre">Dialog</span></code> table is made, with the specified coordinates, dialog attributes, title, name of the first, default, and cancel controls.</p> <dl class="method"> <dt id="msilib.Dialog.control"> <code class="descname">control</code><span class="sig-paren">(</span><em>name</em>, <em>type</em>, <em>x</em>, <em>y</em>, <em>width</em>, <em>height</em>, <em>attributes</em>, <em>property</em>, <em>text</em>, <em>control_next</em>, <em>help</em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Dialog.control" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Return a new <a class="reference internal" href="#msilib.Control" title="msilib.Control"><code class="xref py py-class docutils literal notranslate"><span class="pre">Control</span></code></a> object. An entry in the <code class="docutils literal notranslate"><span class="pre">Control</span></code> table is made with the specified parameters.</p> <p>This is a generic method; for specific types, specialized methods are provided.</p> </dd></dl> <dl class="method"> <dt id="msilib.Dialog.text"> <code class="descname">text</code><span class="sig-paren">(</span><em>name</em>, <em>x</em>, <em>y</em>, <em>width</em>, <em>height</em>, <em>attributes</em>, <em>text</em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Dialog.text" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Add and return a <code class="docutils literal notranslate"><span class="pre">Text</span></code> control.</p> </dd></dl> <dl class="method"> <dt id="msilib.Dialog.bitmap"> <code class="descname">bitmap</code><span class="sig-paren">(</span><em>name</em>, <em>x</em>, <em>y</em>, <em>width</em>, <em>height</em>, <em>text</em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Dialog.bitmap" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Add and return a <code class="docutils literal notranslate"><span class="pre">Bitmap</span></code> control.</p> </dd></dl> <dl class="method"> <dt id="msilib.Dialog.line"> <code class="descname">line</code><span class="sig-paren">(</span><em>name</em>, <em>x</em>, <em>y</em>, <em>width</em>, <em>height</em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Dialog.line" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Add and return a <code class="docutils literal notranslate"><span class="pre">Line</span></code> control.</p> </dd></dl> <dl class="method"> <dt id="msilib.Dialog.pushbutton"> <code class="descname">pushbutton</code><span class="sig-paren">(</span><em>name</em>, <em>x</em>, <em>y</em>, <em>width</em>, <em>height</em>, <em>attributes</em>, <em>text</em>, <em>next_control</em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Dialog.pushbutton" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Add and return a <code class="docutils literal notranslate"><span class="pre">PushButton</span></code> control.</p> </dd></dl> <dl class="method"> <dt id="msilib.Dialog.radiogroup"> <code class="descname">radiogroup</code><span class="sig-paren">(</span><em>name</em>, <em>x</em>, <em>y</em>, <em>width</em>, <em>height</em>, <em>attributes</em>, <em>property</em>, <em>text</em>, <em>next_control</em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Dialog.radiogroup" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Add and return a <code class="docutils literal notranslate"><span class="pre">RadioButtonGroup</span></code> control.</p> </dd></dl> <dl class="method"> <dt id="msilib.Dialog.checkbox"> <code class="descname">checkbox</code><span class="sig-paren">(</span><em>name</em>, <em>x</em>, <em>y</em>, <em>width</em>, <em>height</em>, <em>attributes</em>, <em>property</em>, <em>text</em>, <em>next_control</em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Dialog.checkbox" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Add and return a <code class="docutils literal notranslate"><span class="pre">CheckBox</span></code> control.</p> </dd></dl> </dd></dl> <div class="admonition seealso"> <p class="first admonition-title">See also</p> <p class="last"><a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/dialog_table.asp">Dialog Table</a> <a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/control_table.asp">Control Table</a> <a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/controls.asp">Control Types</a> <a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/controlcondition_table.asp">ControlCondition Table</a> <a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/controlevent_table.asp">ControlEvent Table</a> <a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/eventmapping_table.asp">EventMapping Table</a> <a class="reference external" href="https://msdn.microsoft.com/library?url=/library/en-us/msi/setup/radiobutton_table.asp">RadioButton Table</a></p> </div> </div> <div class="section" id="precomputed-tables"> <span id="msi-tables"></span><h2>35.1.10. Precomputed tables<a class="headerlink" href="#precomputed-tables" title="Permalink to this headline">ΒΆ</a></h2> <p><a class="reference internal" href="#module-msilib" title="msilib: Creation of Microsoft Installer files, and CAB files. (Windows)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">msilib</span></code></a> provides a few subpackages that contain only schema and table definitions. Currently, these definitions are based on MSI version 2.0.</p> <dl class="data"> <dt id="msilib.schema"> <code class="descclassname">msilib.</code><code class="descname">schema</code><a class="headerlink" href="#msilib.schema" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>This is the standard MSI schema for MSI 2.0, with the <em>tables</em> variable providing a list of table definitions, and <em>_Validation_records</em> providing the data for MSI validation.</p> </dd></dl> <dl class="data"> <dt id="msilib.sequence"> <code class="descclassname">msilib.</code><code class="descname">sequence</code><a class="headerlink" href="#msilib.sequence" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>This module contains table contents for the standard sequence tables: <em>AdminExecuteSequence</em>, <em>AdminUISequence</em>, <em>AdvtExecuteSequence</em>, <em>InstallExecuteSequence</em>, and <em>InstallUISequence</em>.</p> </dd></dl> <dl class="data"> <dt id="msilib.text"> <code class="descclassname">msilib.</code><code class="descname">text</code><a class="headerlink" href="#msilib.text" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>This module contains definitions for the UIText and ActionText tables, for the standard installer actions.</p> </dd></dl> </div> </div> </div> </div> </div> <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> <div class="sphinxsidebarwrapper"> <h3><a href="../contents.html">Table Of Contents</a></h3> <ul> <li><a class="reference internal" href="#">35.1. <code class="docutils literal notranslate"><span class="pre">msilib</span></code> β Read and write Microsoft Installer files</a><ul> <li><a class="reference internal" href="#database-objects">35.1.1. Database Objects</a></li> <li><a class="reference internal" href="#view-objects">35.1.2. View Objects</a></li> <li><a class="reference internal" href="#summary-information-objects">35.1.3. Summary Information Objects</a></li> <li><a class="reference internal" href="#record-objects">35.1.4. Record Objects</a></li> <li><a class="reference internal" href="#errors">35.1.5. Errors</a></li> <li><a class="reference internal" href="#cab-objects">35.1.6. CAB Objects</a></li> <li><a class="reference internal" href="#directory-objects">35.1.7. Directory Objects</a></li> <li><a class="reference internal" href="#features">35.1.8. Features</a></li> <li><a class="reference internal" href="#gui-classes">35.1.9. GUI classes</a></li> <li><a class="reference internal" href="#precomputed-tables">35.1.10. Precomputed tables</a></li> </ul> </li> </ul> <h4>Previous topic</h4> <p class="topless"><a href="windows.html" title="previous chapter">35. MS Windows Specific Services</a></p> <h4>Next topic</h4> <p class="topless"><a href="msvcrt.html" title="next chapter">35.2. <code class="docutils literal notranslate"><span class="pre">msvcrt</span></code> β Useful routines from the MS VC++ runtime</a></p> <div role="note" aria-label="source link"> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../_sources/library/msilib.rst.txt" rel="nofollow">Show Source</a></li> </ul> </div> <div id="searchbox" style="display: none" role="search"> <h3>Quick search</h3> <div class="searchformwrapper"> <form class="search" action="../search.html" method="get"> <input type="text" name="q" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="clearer"></div> </div> <div class="related" role="navigation" aria-label="related navigation"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" >index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="msvcrt.html" title="35.2. msvcrt β Useful routines from the MS VC++ runtime" >next</a> |</li> <li class="right" > <a href="windows.html" title="35. MS Windows Specific Services" >previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="https://www.python.org/">Python</a> »</li> <li> <a href="../index.html">Python 2.7.16 documentation</a> » </li> <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li> <li class="nav-item nav-item-2"><a href="windows.html" >35. MS Windows Specific Services</a> »</li> </ul> </div> <div class="footer"> © <a href="../copyright.html">Copyright</a> 1990-2019, Python Software Foundation. <br /> The Python Software Foundation is a non-profit corporation. <a href="https://www.python.org/psf/donations/">Please donate.</a> <br /> Last updated on Mar 27, 2019. <a href="../bugs.html">Found a bug</a>? <br /> Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.7.6. </div> </body> </html>
Upload File
Create Folder