Baoding-FenShuaJiang
/
Green_GoodERP18_FSJ_Standard
關注 1
收藏 0
Wiki 捐赠
gooderp18绿色标准版
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
分支: master
分支列表 標籤
${ item.name }
建立分支 ${ searchTerm }
從 'master'
${ noResults }
Green_GoodERP18_FSJ_Standard/python/Doc/html/library/msilib.html

911 line
80KB
原始文件 永久連結 Blame 歷史記錄 

  1. <!DOCTYPE html>

  2. 

  3. <html lang="en" data-content_root="../">

  4.   <head>

  5.     <meta charset="utf-8" />

  6.     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  7. <meta property="og:title" content="msilib — Read and write Microsoft Installer files" />

  8. <meta property="og:type" content="website" />

  9. <meta property="og:url" content="https://docs.python.org/3/library/msilib.html" />

  10. <meta property="og:site_name" content="Python documentation" />

  11. <meta property="og:description" content="Source code: Lib/msilib/__init__.py The msilib supports the creation of Microsoft Installer (.msi) files. Because these files often contain an embedded “cabinet” file (.cab), it also exposes an API..." />

  12. <meta property="og:image" content="https://docs.python.org/3/_static/og-image.png" />

  13. <meta property="og:image:alt" content="Python documentation" />

  14. <meta name="description" content="Source code: Lib/msilib/__init__.py The msilib supports the creation of Microsoft Installer (.msi) files. Because these files often contain an embedded “cabinet” file (.cab), it also exposes an API..." />

  15. <meta property="og:image:width" content="200" />

  16. <meta property="og:image:height" content="200" />

  17. <meta name="theme-color" content="#3776ab" />

  18. 

  19.     <title>msilib — Read and write Microsoft Installer files &#8212; Python 3.12.3 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">

  20.     

  21.     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />

  22.     <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=bb723527" />

  23.     <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=b20cc3f5" />

  24.     

  25.     <script src="../_static/documentation_options.js?v=2c828074"></script>

  26.     <script src="../_static/doctools.js?v=888ff710"></script>

  27.     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>

  28.     

  29.     <script src="../_static/sidebar.js"></script>

  30.     

  31.     <link rel="search" type="application/opensearchdescription+xml"

  32.           title="Search within Python 3.12.3 documentation"

  33.           href="../_static/opensearch.xml"/>

  34.     <link rel="author" title="About these documents" href="../about.html" />

  35.     <link rel="index" title="Index" href="../genindex.html" />

  36.     <link rel="search" title="Search" href="../search.html" />

  37.     <link rel="copyright" title="Copyright" href="../copyright.html" />

  38.     <link rel="next" title="nis — Interface to Sun’s NIS (Yellow Pages)" href="nis.html" />

  39.     <link rel="prev" title="mailcap — Mailcap file handling" href="mailcap.html" />

  40.     <link rel="canonical" href="https://docs.python.org/3/library/msilib.html" />

  41.     

  42.       

  43.     

  44. 

  45.     

  46.     <style>

  47.       @media only screen {

  48.         table.full-width-table {

  49.             width: 100%;

  50.         }

  51.       }

  52.     </style>

  53. <link rel="stylesheet" href="../_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">

  54.     <link rel="shortcut icon" type="image/png" href="../_static/py.svg" />

  55.             <script type="text/javascript" src="../_static/copybutton.js"></script>

  56.             <script type="text/javascript" src="../_static/menu.js"></script>

  57.             <script type="text/javascript" src="../_static/search-focus.js"></script>

  58.             <script type="text/javascript" src="../_static/themetoggle.js"></script> 

  59. 

  60.   </head>

  61. <body>

  62. <div class="mobile-nav">

  63.     <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"

  64.            aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />

  65.     <nav class="nav-content" role="navigation">

  66.         <label for="menuToggler" class="toggler__label">

  67.             <span></span>

  68.         </label>

  69.         <span class="nav-items-wrapper">

  70.             <a href="https://www.python.org/" class="nav-logo">

  71.                 <img src="../_static/py.svg" alt="Python logo"/>

  72.             </a>

  73.             <span class="version_switcher_placeholder"></span>

  74.             <form role="search" class="search" action="../search.html" method="get">

  75.                 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">

  76.                     <path fill-rule="nonzero" fill="currentColor" d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z"></path>

  77.                 </svg>

  78.                 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" />

  79.                 <input type="submit" value="Go"/>

  80.             </form>

  81.         </span>

  82.     </nav>

  83.     <div class="menu-wrapper">

  84.         <nav class="menu" role="navigation" aria-label="main navigation">

  85.             <div class="language_switcher_placeholder"></div>

  86.             

  87. <label class="theme-selector-label">

  88.     Theme

  89.     <select class="theme-selector" oninput="activateTheme(this.value)">

  90.         <option value="auto" selected>Auto</option>

  91.         <option value="light">Light</option>

  92.         <option value="dark">Dark</option>

  93.     </select>

  94. </label>

  95.   <div>

  96.     <h3><a href="../contents.html">Table of Contents</a></h3>

  97.     <ul>

  98. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">msilib</span></code> — Read and write Microsoft Installer files</a><ul>

  99. <li><a class="reference internal" href="#database-objects">Database Objects</a></li>

  100. <li><a class="reference internal" href="#view-objects">View Objects</a></li>

  101. <li><a class="reference internal" href="#summary-information-objects">Summary Information Objects</a></li>

  102. <li><a class="reference internal" href="#record-objects">Record Objects</a></li>

  103. <li><a class="reference internal" href="#errors">Errors</a></li>

  104. <li><a class="reference internal" href="#cab-objects">CAB Objects</a></li>

  105. <li><a class="reference internal" href="#directory-objects">Directory Objects</a></li>

  106. <li><a class="reference internal" href="#features">Features</a></li>

  107. <li><a class="reference internal" href="#gui-classes">GUI classes</a></li>

  108. <li><a class="reference internal" href="#precomputed-tables">Precomputed tables</a></li>

  109. </ul>

  110. </li>

  111. </ul>

  112. 

  113.   </div>

  114.   <div>

  115.     <h4>Previous topic</h4>

  116.     <p class="topless"><a href="mailcap.html"

  117.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">mailcap</span></code> — Mailcap file handling</a></p>

  118.   </div>

  119.   <div>

  120.     <h4>Next topic</h4>

  121.     <p class="topless"><a href="nis.html"

  122.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">nis</span></code> — Interface to Sun’s NIS (Yellow Pages)</a></p>

  123.   </div>

  124.   <div role="note" aria-label="source link">

  125.     <h3>This Page</h3>

  126.     <ul class="this-page-menu">

  127.       <li><a href="../bugs.html">Report a Bug</a></li>

  128.       <li>

  129.         <a href="https://github.com/python/cpython/blob/main/Doc/library/msilib.rst"

  130.             rel="nofollow">Show Source

  131.         </a>

  132.       </li>

  133.     </ul>

  134.   </div>

  135.         </nav>

  136.     </div>

  137. </div>

  138. 

  139.   

  140.     <div class="related" role="navigation" aria-label="related navigation">

  141.       <h3>Navigation</h3>

  142.       <ul>

  143.         <li class="right" style="margin-right: 10px">

  144.           <a href="../genindex.html" title="General Index"

  145.              accesskey="I">index</a></li>

  146.         <li class="right" >

  147.           <a href="../py-modindex.html" title="Python Module Index"

  148.              >modules</a> |</li>

  149.         <li class="right" >

  150.           <a href="nis.html" title="nis — Interface to Sun’s NIS (Yellow Pages)"

  151.              accesskey="N">next</a> |</li>

  152.         <li class="right" >

  153.           <a href="mailcap.html" title="mailcap — Mailcap file handling"

  154.              accesskey="P">previous</a> |</li>

  155. 

  156.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  157.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  158.           <li class="switchers">

  159.             <div class="language_switcher_placeholder"></div>

  160.             <div class="version_switcher_placeholder"></div>

  161.           </li>

  162.           <li>

  163.               

  164.           </li>

  165.     <li id="cpython-language-and-version">

  166.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  167.     </li>

  168. 

  169.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  170.           <li class="nav-item nav-item-2"><a href="superseded.html" accesskey="U">Superseded Modules</a> &#187;</li>

  171.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">msilib</span></code> — Read and write Microsoft Installer files</a></li>

  172.                 <li class="right">

  173.                     

  174. 

  175.     <div class="inline-search" role="search">

  176.         <form class="inline-search" action="../search.html" method="get">

  177.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  178.           <input type="submit" value="Go" />

  179.         </form>

  180.     </div>

  181.                      |

  182.                 </li>

  183.             <li class="right">

  184. <label class="theme-selector-label">

  185.     Theme

  186.     <select class="theme-selector" oninput="activateTheme(this.value)">

  187.         <option value="auto" selected>Auto</option>

  188.         <option value="light">Light</option>

  189.         <option value="dark">Dark</option>

  190.     </select>

  191. </label> |</li>

  192.             

  193.       </ul>

  194.     </div>    

  195. 

  196.     <div class="document">

  197.       <div class="documentwrapper">

  198.         <div class="bodywrapper">

  199.           <div class="body" role="main">

  200.             

  201.   <section id="module-msilib">

  202. <span id="msilib-read-and-write-microsoft-installer-files"></span><h1><a class="reference internal" href="#module-msilib" title="msilib: Creation of Microsoft Installer files, and CAB files. (deprecated) (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="Link to this heading">¶</a></h1>

  203. <p><strong>Source code:</strong> <a class="reference external" href="https://github.com/python/cpython/tree/3.12/Lib/msilib/__init__.py">Lib/msilib/__init__.py</a></p>

  204. <div class="deprecated-removed" id="index-0">

  205. <p><span class="versionmodified">Deprecated since version 3.11, will be removed in version 3.13: </span>The <a class="reference internal" href="#module-msilib" title="msilib: Creation of Microsoft Installer files, and CAB files. (deprecated) (Windows)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">msilib</span></code></a> module is deprecated

  206. (see <span class="target" id="index-1"></span><a class="pep reference external" href="https://peps.python.org/pep-0594/#msilib"><strong>PEP 594</strong></a> for details).</p>

  207. </div>

  208. <hr class="docutils" />

  209. <p>The <a class="reference internal" href="#module-msilib" title="msilib: Creation of Microsoft Installer files, and CAB files. (deprecated) (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.

  210. Because these files often contain an embedded “cabinet” file (<code class="docutils literal notranslate"><span class="pre">.cab</span></code>), it also

  211. exposes an API to create CAB files. Support for reading <code class="docutils literal notranslate"><span class="pre">.cab</span></code> files is

  212. currently not implemented; read support for the <code class="docutils literal notranslate"><span class="pre">.msi</span></code> database is possible.</p>

  213. <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,

  214. therefore, it is a fairly low-level API. One primary application of this

  215. package is the creation of Python installer package itself (although that currently

  216. uses a different version of <code class="docutils literal notranslate"><span class="pre">msilib</span></code>).</p>

  217. <p>The package contents can be roughly split into four parts: low-level CAB

  218. routines, low-level MSI routines, higher-level MSI routines, and standard table

  219. structures.</p>

  220. <dl class="py function">

  221. <dt class="sig sig-object py" id="msilib.FCICreate">

  222. <span class="sig-prename descclassname"><span class="pre">msilib.</span></span><span class="sig-name descname"><span class="pre">FCICreate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cabname</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">files</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.FCICreate" title="Link to this definition">¶</a></dt>

  223. <dd><p>Create a new CAB file named <em>cabname</em>. <em>files</em> must be a list of tuples, each

  224. containing the name of the file on disk, and the name of the file inside the CAB

  225. file.</p>

  226. <p>The files are added to the CAB file in the order they appear in the list. All

  227. files are added into a single CAB file, using the MSZIP compression algorithm.</p>

  228. <p>Callbacks to Python for the various steps of MSI creation are currently not

  229. exposed.</p>

  230. </dd></dl>

  231. 

  232. <dl class="py function">

  233. <dt class="sig sig-object py" id="msilib.UuidCreate">

  234. <span class="sig-prename descclassname"><span class="pre">msilib.</span></span><span class="sig-name descname"><span class="pre">UuidCreate</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#msilib.UuidCreate" title="Link to this definition">¶</a></dt>

  235. <dd><p>Return the string representation of a new unique identifier. This wraps the

  236. 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>

  237. </dd></dl>

  238. 

  239. <dl class="py function">

  240. <dt class="sig sig-object py" id="msilib.OpenDatabase">

  241. <span class="sig-prename descclassname"><span class="pre">msilib.</span></span><span class="sig-name descname"><span class="pre">OpenDatabase</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">persist</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.OpenDatabase" title="Link to this definition">¶</a></dt>

  242. <dd><p>Return a new database object by calling MsiOpenDatabase.   <em>path</em> is the file

  243. name of the MSI file; <em>persist</em> can be one of the constants

  244. <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>,

  245. <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

  246. <code class="docutils literal notranslate"><span class="pre">MSIDBOPEN_PATCHFILE</span></code>. See the Microsoft documentation for the meaning of

  247. these flags; depending on the flags, an existing database is opened, or a new

  248. one created.</p>

  249. </dd></dl>

  250. 

  251. <dl class="py function">

  252. <dt class="sig sig-object py" id="msilib.CreateRecord">

  253. <span class="sig-prename descclassname"><span class="pre">msilib.</span></span><span class="sig-name descname"><span class="pre">CreateRecord</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">count</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.CreateRecord" title="Link to this definition">¶</a></dt>

  254. <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

  255. number of fields of the record.</p>

  256. </dd></dl>

  257. 

  258. <dl class="py function">

  259. <dt class="sig sig-object py" id="msilib.init_database">

  260. <span class="sig-prename descclassname"><span class="pre">msilib.</span></span><span class="sig-name descname"><span class="pre">init_database</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">schema</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ProductName</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ProductCode</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ProductVersion</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Manufacturer</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.init_database" title="Link to this definition">¶</a></dt>

  261. <dd><p>Create and return a new database <em>name</em>, initialize it with <em>schema</em>, and set

  262. the properties <em>ProductName</em>, <em>ProductCode</em>, <em>ProductVersion</em>, and

  263. <em>Manufacturer</em>.</p>

  264. <p><em>schema</em> must be a module object containing <code class="docutils literal notranslate"><span class="pre">tables</span></code> and

  265. <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

  266. used.</p>

  267. <p>The database will contain just the schema and the validation records when this

  268. function returns.</p>

  269. </dd></dl>

  270. 

  271. <dl class="py function">

  272. <dt class="sig sig-object py" id="msilib.add_data">

  273. <span class="sig-prename descclassname"><span class="pre">msilib.</span></span><span class="sig-name descname"><span class="pre">add_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">database</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">table</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">records</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.add_data" title="Link to this definition">¶</a></dt>

  274. <dd><p>Add all <em>records</em> to the table named <em>table</em> in <em>database</em>.</p>

  275. <p>The <em>table</em> argument must be one of the predefined tables in the MSI schema,

  276. 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>,

  277. etc.</p>

  278. <p><em>records</em> should be a list of tuples, each one containing all fields of a

  279. record according to the schema of the table.  For optional fields,

  280. <code class="docutils literal notranslate"><span class="pre">None</span></code> can be passed.</p>

  281. <p>Field values can be ints, strings, or instances of the Binary class.</p>

  282. </dd></dl>

  283. 

  284. <dl class="py class">

  285. <dt class="sig sig-object py" id="msilib.Binary">

  286. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">msilib.</span></span><span class="sig-name descname"><span class="pre">Binary</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Binary" title="Link to this definition">¶</a></dt>

  287. <dd><p>Represents entries in the Binary table; inserting such an object using

  288. <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>

  289. </dd></dl>

  290. 

  291. <dl class="py function">

  292. <dt class="sig sig-object py" id="msilib.add_tables">

  293. <span class="sig-prename descclassname"><span class="pre">msilib.</span></span><span class="sig-name descname"><span class="pre">add_tables</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">database</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">module</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.add_tables" title="Link to this definition">¶</a></dt>

  294. <dd><p>Add all table content from <em>module</em> to <em>database</em>. <em>module</em> must contain an

  295. attribute <em>tables</em> listing all tables for which content should be added, and one

  296. attribute per table that has the actual content.</p>

  297. <p>This is typically used to install the sequence tables.</p>

  298. </dd></dl>

  299. 

  300. <dl class="py function">

  301. <dt class="sig sig-object py" id="msilib.add_stream">

  302. <span class="sig-prename descclassname"><span class="pre">msilib.</span></span><span class="sig-name descname"><span class="pre">add_stream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">database</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.add_stream" title="Link to this definition">¶</a></dt>

  303. <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

  304. name <em>name</em>.</p>

  305. </dd></dl>

  306. 

  307. <dl class="py function">

  308. <dt class="sig sig-object py" id="msilib.gen_uuid">

  309. <span class="sig-prename descclassname"><span class="pre">msilib.</span></span><span class="sig-name descname"><span class="pre">gen_uuid</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#msilib.gen_uuid" title="Link to this definition">¶</a></dt>

  310. <dd><p>Return a new UUID, in the format that MSI typically requires (i.e. in curly

  311. braces, and with all hexdigits in uppercase).</p>

  312. </dd></dl>

  313. 

  314. <div class="admonition seealso">

  315. <p class="admonition-title">See also</p>

  316. <p><a class="reference external" href="https://msdn.microsoft.com/en-us/library/bb432265.aspx">FCICreate</a>

  317. <a class="reference external" href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa379205.aspx">UuidCreate</a>

  318. <a class="reference external" href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa379352.aspx">UuidToString</a></p>

  319. </div>

  320. <section id="database-objects">

  321. <span id="id1"></span><h2>Database Objects<a class="headerlink" href="#database-objects" title="Link to this heading">¶</a></h2>

  322. <dl class="py method">

  323. <dt class="sig sig-object py" id="msilib.Database.OpenView">

  324. <span class="sig-prename descclassname"><span class="pre">Database.</span></span><span class="sig-name descname"><span class="pre">OpenView</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sql</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Database.OpenView" title="Link to this definition">¶</a></dt>

  325. <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

  326. statement to execute.</p>

  327. </dd></dl>

  328. 

  329. <dl class="py method">

  330. <dt class="sig sig-object py" id="msilib.Database.Commit">

  331. <span class="sig-prename descclassname"><span class="pre">Database.</span></span><span class="sig-name descname"><span class="pre">Commit</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Database.Commit" title="Link to this definition">¶</a></dt>

  332. <dd><p>Commit the changes pending in the current transaction, by calling

  333. <code class="xref c c-func docutils literal notranslate"><span class="pre">MSIDatabaseCommit()</span></code>.</p>

  334. </dd></dl>

  335. 

  336. <dl class="py method">

  337. <dt class="sig sig-object py" id="msilib.Database.GetSummaryInformation">

  338. <span class="sig-prename descclassname"><span class="pre">Database.</span></span><span class="sig-name descname"><span class="pre">GetSummaryInformation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">count</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Database.GetSummaryInformation" title="Link to this definition">¶</a></dt>

  339. <dd><p>Return a new summary information object, by calling

  340. <code class="xref c c-func docutils literal notranslate"><span class="pre">MsiGetSummaryInformation()</span></code>.  <em>count</em> is the maximum number of updated

  341. values.</p>

  342. </dd></dl>

  343. 

  344. <dl class="py method">

  345. <dt class="sig sig-object py" id="msilib.Database.Close">

  346. <span class="sig-prename descclassname"><span class="pre">Database.</span></span><span class="sig-name descname"><span class="pre">Close</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Database.Close" title="Link to this definition">¶</a></dt>

  347. <dd><p>Close the database object, through <code class="xref c c-func docutils literal notranslate"><span class="pre">MsiCloseHandle()</span></code>.</p>

  348. <div class="versionadded">

  349. <p><span class="versionmodified added">New in version 3.7.</span></p>

  350. </div>

  351. </dd></dl>

  352. 

  353. <div class="admonition seealso">

  354. <p class="admonition-title">See also</p>

  355. <p><a class="reference external" href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa370082.aspx">MSIDatabaseOpenView</a>

  356. <a class="reference external" href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa370075.aspx">MSIDatabaseCommit</a>

  357. <a class="reference external" href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa370301.aspx">MSIGetSummaryInformation</a>

  358. <a class="reference external" href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa370067.aspx">MsiCloseHandle</a></p>

  359. </div>

  360. </section>

  361. <section id="view-objects">

  362. <span id="id2"></span><h2>View Objects<a class="headerlink" href="#view-objects" title="Link to this heading">¶</a></h2>

  363. <dl class="py method">

  364. <dt class="sig sig-object py" id="msilib.View.Execute">

  365. <span class="sig-prename descclassname"><span class="pre">View.</span></span><span class="sig-name descname"><span class="pre">Execute</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">params</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.View.Execute" title="Link to this definition">¶</a></dt>

  366. <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

  367. <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

  368. parameter tokens in the query.</p>

  369. </dd></dl>

  370. 

  371. <dl class="py method">

  372. <dt class="sig sig-object py" id="msilib.View.GetColumnInfo">

  373. <span class="sig-prename descclassname"><span class="pre">View.</span></span><span class="sig-name descname"><span class="pre">GetColumnInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">kind</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.View.GetColumnInfo" title="Link to this definition">¶</a></dt>

  374. <dd><p>Return a record describing the columns of the view, through calling

  375. <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

  376. <code class="docutils literal notranslate"><span class="pre">MSICOLINFO_TYPES</span></code>.</p>

  377. </dd></dl>

  378. 

  379. <dl class="py method">

  380. <dt class="sig sig-object py" id="msilib.View.Fetch">

  381. <span class="sig-prename descclassname"><span class="pre">View.</span></span><span class="sig-name descname"><span class="pre">Fetch</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#msilib.View.Fetch" title="Link to this definition">¶</a></dt>

  382. <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>

  383. </dd></dl>

  384. 

  385. <dl class="py method">

  386. <dt class="sig sig-object py" id="msilib.View.Modify">

  387. <span class="sig-prename descclassname"><span class="pre">View.</span></span><span class="sig-name descname"><span class="pre">Modify</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">kind</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.View.Modify" title="Link to this definition">¶</a></dt>

  388. <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

  389. <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>,

  390. <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>,

  391. <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>,

  392. <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>,

  393. <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>

  394. <p><em>data</em> must be a record describing the new data.</p>

  395. </dd></dl>

  396. 

  397. <dl class="py method">

  398. <dt class="sig sig-object py" id="msilib.View.Close">

  399. <span class="sig-prename descclassname"><span class="pre">View.</span></span><span class="sig-name descname"><span class="pre">Close</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#msilib.View.Close" title="Link to this definition">¶</a></dt>

  400. <dd><p>Close the view, through <code class="xref c c-func docutils literal notranslate"><span class="pre">MsiViewClose()</span></code>.</p>

  401. </dd></dl>

  402. 

  403. <div class="admonition seealso">

  404. <p class="admonition-title">See also</p>

  405. <p><a class="reference external" href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa370513.aspx">MsiViewExecute</a>

  406. <a class="reference external" href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa370516.aspx">MSIViewGetColumnInfo</a>

  407. <a class="reference external" href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa370514.aspx">MsiViewFetch</a>

  408. <a class="reference external" href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa370519.aspx">MsiViewModify</a>

  409. <a class="reference external" href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa370510.aspx">MsiViewClose</a></p>

  410. </div>

  411. </section>

  412. <section id="summary-information-objects">

  413. <span id="summary-objects"></span><h2>Summary Information Objects<a class="headerlink" href="#summary-information-objects" title="Link to this heading">¶</a></h2>

  414. <dl class="py method">

  415. <dt class="sig sig-object py" id="msilib.SummaryInformation.GetProperty">

  416. <span class="sig-prename descclassname"><span class="pre">SummaryInformation.</span></span><span class="sig-name descname"><span class="pre">GetProperty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">field</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.SummaryInformation.GetProperty" title="Link to this definition">¶</a></dt>

  417. <dd><p>Return a property of the summary, through <code class="xref c c-func docutils literal notranslate"><span class="pre">MsiSummaryInfoGetProperty()</span></code>.

  418. <em>field</em> is the name of the property, and can be one of the constants

  419. <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>,

  420. <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>,

  421. <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>,

  422. <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>,

  423. <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>

  424. </dd></dl>

  425. 

  426. <dl class="py method">

  427. <dt class="sig sig-object py" id="msilib.SummaryInformation.GetPropertyCount">

  428. <span class="sig-prename descclassname"><span class="pre">SummaryInformation.</span></span><span class="sig-name descname"><span class="pre">GetPropertyCount</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#msilib.SummaryInformation.GetPropertyCount" title="Link to this definition">¶</a></dt>

  429. <dd><p>Return the number of summary properties, through

  430. <code class="xref c c-func docutils literal notranslate"><span class="pre">MsiSummaryInfoGetPropertyCount()</span></code>.</p>

  431. </dd></dl>

  432. 

  433. <dl class="py method">

  434. <dt class="sig sig-object py" id="msilib.SummaryInformation.SetProperty">

  435. <span class="sig-prename descclassname"><span class="pre">SummaryInformation.</span></span><span class="sig-name descname"><span class="pre">SetProperty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">field</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.SummaryInformation.SetProperty" title="Link to this definition">¶</a></dt>

  436. <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

  437. 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.

  438. Possible value types are integer and string.</p>

  439. </dd></dl>

  440. 

  441. <dl class="py method">

  442. <dt class="sig sig-object py" id="msilib.SummaryInformation.Persist">

  443. <span class="sig-prename descclassname"><span class="pre">SummaryInformation.</span></span><span class="sig-name descname"><span class="pre">Persist</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#msilib.SummaryInformation.Persist" title="Link to this definition">¶</a></dt>

  444. <dd><p>Write the modified properties to the summary information stream, using

  445. <code class="xref c c-func docutils literal notranslate"><span class="pre">MsiSummaryInfoPersist()</span></code>.</p>

  446. </dd></dl>

  447. 

  448. <div class="admonition seealso">

  449. <p class="admonition-title">See also</p>

  450. <p><a class="reference external" href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa370409.aspx">MsiSummaryInfoGetProperty</a>

  451. <a class="reference external" href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa370488.aspx">MsiSummaryInfoGetPropertyCount</a>

  452. <a class="reference external" href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa370491.aspx">MsiSummaryInfoSetProperty</a>

  453. <a class="reference external" href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa370490.aspx">MsiSummaryInfoPersist</a></p>

  454. </div>

  455. </section>

  456. <section id="record-objects">

  457. <span id="id3"></span><h2>Record Objects<a class="headerlink" href="#record-objects" title="Link to this heading">¶</a></h2>

  458. <dl class="py method">

  459. <dt class="sig sig-object py" id="msilib.Record.GetFieldCount">

  460. <span class="sig-prename descclassname"><span class="pre">Record.</span></span><span class="sig-name descname"><span class="pre">GetFieldCount</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Record.GetFieldCount" title="Link to this definition">¶</a></dt>

  461. <dd><p>Return the number of fields of the record, through

  462. <code class="xref c c-func docutils literal notranslate"><span class="pre">MsiRecordGetFieldCount()</span></code>.</p>

  463. </dd></dl>

  464. 

  465. <dl class="py method">

  466. <dt class="sig sig-object py" id="msilib.Record.GetInteger">

  467. <span class="sig-prename descclassname"><span class="pre">Record.</span></span><span class="sig-name descname"><span class="pre">GetInteger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">field</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Record.GetInteger" title="Link to this definition">¶</a></dt>

  468. <dd><p>Return the value of <em>field</em> as an integer where possible.  <em>field</em> must

  469. be an integer.</p>

  470. </dd></dl>

  471. 

  472. <dl class="py method">

  473. <dt class="sig sig-object py" id="msilib.Record.GetString">

  474. <span class="sig-prename descclassname"><span class="pre">Record.</span></span><span class="sig-name descname"><span class="pre">GetString</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">field</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Record.GetString" title="Link to this definition">¶</a></dt>

  475. <dd><p>Return the value of <em>field</em> as a string where possible.  <em>field</em> must

  476. be an integer.</p>

  477. </dd></dl>

  478. 

  479. <dl class="py method">

  480. <dt class="sig sig-object py" id="msilib.Record.SetString">

  481. <span class="sig-prename descclassname"><span class="pre">Record.</span></span><span class="sig-name descname"><span class="pre">SetString</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">field</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Record.SetString" title="Link to this definition">¶</a></dt>

  482. <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

  483. integer; <em>value</em> a string.</p>

  484. </dd></dl>

  485. 

  486. <dl class="py method">

  487. <dt class="sig sig-object py" id="msilib.Record.SetStream">

  488. <span class="sig-prename descclassname"><span class="pre">Record.</span></span><span class="sig-name descname"><span class="pre">SetStream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">field</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Record.SetStream" title="Link to this definition">¶</a></dt>

  489. <dd><p>Set <em>field</em> to the contents of the file named <em>value</em>, through

  490. <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>

  491. </dd></dl>

  492. 

  493. <dl class="py method">

  494. <dt class="sig sig-object py" id="msilib.Record.SetInteger">

  495. <span class="sig-prename descclassname"><span class="pre">Record.</span></span><span class="sig-name descname"><span class="pre">SetInteger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">field</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Record.SetInteger" title="Link to this definition">¶</a></dt>

  496. <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

  497. <em>value</em> must be an integer.</p>

  498. </dd></dl>

  499. 

  500. <dl class="py method">

  501. <dt class="sig sig-object py" id="msilib.Record.ClearData">

  502. <span class="sig-prename descclassname"><span class="pre">Record.</span></span><span class="sig-name descname"><span class="pre">ClearData</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Record.ClearData" title="Link to this definition">¶</a></dt>

  503. <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>

  504. </dd></dl>

  505. 

  506. <div class="admonition seealso">

  507. <p class="admonition-title">See also</p>

  508. <p><a class="reference external" href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa370366.aspx">MsiRecordGetFieldCount</a>

  509. <a class="reference external" href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa370373.aspx">MsiRecordSetString</a>

  510. <a class="reference external" href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa370372.aspx">MsiRecordSetStream</a>

  511. <a class="reference external" href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa370371.aspx">MsiRecordSetInteger</a>

  512. <a class="reference external" href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa370364.aspx">MsiRecordClearData</a></p>

  513. </div>

  514. </section>

  515. <section id="errors">

  516. <span id="msi-errors"></span><h2>Errors<a class="headerlink" href="#errors" title="Link to this heading">¶</a></h2>

  517. <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

  518. exception will contain more detail.</p>

  519. </section>

  520. <section id="cab-objects">

  521. <span id="cab"></span><h2>CAB Objects<a class="headerlink" href="#cab-objects" title="Link to this heading">¶</a></h2>

  522. <dl class="py class">

  523. <dt class="sig sig-object py" id="msilib.CAB">

  524. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">msilib.</span></span><span class="sig-name descname"><span class="pre">CAB</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.CAB" title="Link to this definition">¶</a></dt>

  525. <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

  526. will be added simultaneously to the <code class="docutils literal notranslate"><span class="pre">Files</span></code> table, and to a CAB file. Then,

  527. when all files have been added, the CAB file can be written, then added to the

  528. MSI file.</p>

  529. <p><em>name</em> is the name of the CAB file in the MSI file.</p>

  530. <dl class="py method">

  531. <dt class="sig sig-object py" id="msilib.CAB.append">

  532. <span class="sig-name descname"><span class="pre">append</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">full</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">logical</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.CAB.append" title="Link to this definition">¶</a></dt>

  533. <dd><p>Add the file with the pathname <em>full</em> to the CAB file, under the name

  534. <em>logical</em>.  If there is already a file named <em>logical</em>, a new file name is

  535. created.</p>

  536. <p>Return the index of the file in the CAB file, and the new name of the file

  537. inside the CAB file.</p>

  538. </dd></dl>

  539. 

  540. <dl class="py method">

  541. <dt class="sig sig-object py" id="msilib.CAB.commit">

  542. <span class="sig-name descname"><span class="pre">commit</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">database</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.CAB.commit" title="Link to this definition">¶</a></dt>

  543. <dd><p>Generate a CAB file, add it as a stream to the MSI file, put it into the

  544. <code class="docutils literal notranslate"><span class="pre">Media</span></code> table, and remove the generated file from the disk.</p>

  545. </dd></dl>

  546. 

  547. </dd></dl>

  548. 

  549. </section>

  550. <section id="directory-objects">

  551. <span id="msi-directory"></span><h2>Directory Objects<a class="headerlink" href="#directory-objects" title="Link to this heading">¶</a></h2>

  552. <dl class="py class">

  553. <dt class="sig sig-object py" id="msilib.Directory">

  554. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">msilib.</span></span><span class="sig-name descname"><span class="pre">Directory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">database</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cab</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">basedir</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">physical</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">logical</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">componentflags</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Directory" title="Link to this definition">¶</a></dt>

  555. <dd><p>Create a new directory in the Directory table. There is a current component at

  556. each point in time for the directory, which is either explicitly created through

  557. <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.

  558. Files are added into the current component, and into the cab file.  To create a

  559. directory, a base directory object needs to be specified (can be <code class="docutils literal notranslate"><span class="pre">None</span></code>), the

  560. path to the physical directory, and a logical directory name.  <em>default</em>

  561. specifies the DefaultDir slot in the directory table. <em>componentflags</em> specifies

  562. the default flags that new components get.</p>

  563. <dl class="py method">

  564. <dt class="sig sig-object py" id="msilib.Directory.start_component">

  565. <span class="sig-name descname"><span class="pre">start_component</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">component</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">feature</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">flags</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">keyfile</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uuid</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Directory.start_component" title="Link to this definition">¶</a></dt>

  566. <dd><p>Add an entry to the Component table, and make this component the current

  567. component for this directory. If no component name is given, the directory

  568. name is used. If no <em>feature</em> is given, the current feature is used. If no

  569. <em>flags</em> are given, the directory’s default flags are used. If no <em>keyfile</em>

  570. is given, the KeyPath is left null in the Component table.</p>

  571. </dd></dl>

  572. 

  573. <dl class="py method">

  574. <dt class="sig sig-object py" id="msilib.Directory.add_file">

  575. <span class="sig-name descname"><span class="pre">add_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">src</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">language</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Directory.add_file" title="Link to this definition">¶</a></dt>

  576. <dd><p>Add a file to the current component of the directory, starting a new one

  577. if there is no current component. By default, the file name in the source

  578. and the file table will be identical. If the <em>src</em> file is specified, it

  579. is interpreted relative to the current directory. Optionally, a <em>version</em>

  580. and a <em>language</em> can be specified for the entry in the File table.</p>

  581. </dd></dl>

  582. 

  583. <dl class="py method">

  584. <dt class="sig sig-object py" id="msilib.Directory.glob">

  585. <span class="sig-name descname"><span class="pre">glob</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pattern</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Directory.glob" title="Link to this definition">¶</a></dt>

  586. <dd><p>Add a list of files to the current component as specified in the glob

  587. pattern.  Individual files can be excluded in the <em>exclude</em> list.</p>

  588. </dd></dl>

  589. 

  590. <dl class="py method">

  591. <dt class="sig sig-object py" id="msilib.Directory.remove_pyc">

  592. <span class="sig-name descname"><span class="pre">remove_pyc</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Directory.remove_pyc" title="Link to this definition">¶</a></dt>

  593. <dd><p>Remove <code class="docutils literal notranslate"><span class="pre">.pyc</span></code> files on uninstall.</p>

  594. </dd></dl>

  595. 

  596. </dd></dl>

  597. 

  598. <div class="admonition seealso">

  599. <p class="admonition-title">See also</p>

  600. <p><a class="reference external" href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa368295.aspx">Directory Table</a>

  601. <a class="reference external" href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa368596.aspx">File Table</a>

  602. <a class="reference external" href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa368007.aspx">Component Table</a>

  603. <a class="reference external" href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa368579.aspx">FeatureComponents Table</a></p>

  604. </div>

  605. </section>

  606. <section id="features">

  607. <span id="id4"></span><h2>Features<a class="headerlink" href="#features" title="Link to this heading">¶</a></h2>

  608. <dl class="py class">

  609. <dt class="sig sig-object py" id="msilib.Feature">

  610. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">msilib.</span></span><span class="sig-name descname"><span class="pre">Feature</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">title</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">desc</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">display</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">level</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">directory</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attributes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Feature" title="Link to this definition">¶</a></dt>

  611. <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>,

  612. <em>title</em>, <em>desc</em>, <em>display</em>, <em>level</em>, <em>directory</em>, and <em>attributes</em>. The

  613. 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

  614. <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>

  615. <dl class="py method">

  616. <dt class="sig sig-object py" id="msilib.Feature.set_current">

  617. <span class="sig-name descname"><span class="pre">set_current</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Feature.set_current" title="Link to this definition">¶</a></dt>

  618. <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. (deprecated) (Windows)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">msilib</span></code></a>. New components are

  619. automatically added to the default feature, unless a feature is explicitly

  620. specified.</p>

  621. </dd></dl>

  622. 

  623. </dd></dl>

  624. 

  625. <div class="admonition seealso">

  626. <p class="admonition-title">See also</p>

  627. <p><a class="reference external" href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa368585.aspx">Feature Table</a></p>

  628. </div>

  629. </section>

  630. <section id="gui-classes">

  631. <span id="msi-gui"></span><h2>GUI classes<a class="headerlink" href="#gui-classes" title="Link to this heading">¶</a></h2>

  632. <p><a class="reference internal" href="#module-msilib" title="msilib: Creation of Microsoft Installer files, and CAB files. (deprecated) (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

  633. database. However, no standard user interface is provided.</p>

  634. <dl class="py class">

  635. <dt class="sig sig-object py" id="msilib.Control">

  636. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">msilib.</span></span><span class="sig-name descname"><span class="pre">Control</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dlg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Control" title="Link to this definition">¶</a></dt>

  637. <dd><p>Base class of the dialog controls. <em>dlg</em> is the dialog object the control

  638. belongs to, and <em>name</em> is the control’s name.</p>

  639. <dl class="py method">

  640. <dt class="sig sig-object py" id="msilib.Control.event">

  641. <span class="sig-name descname"><span class="pre">event</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">event</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">argument</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">condition</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ordering</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Control.event" title="Link to this definition">¶</a></dt>

  642. <dd><p>Make an entry into the <code class="docutils literal notranslate"><span class="pre">ControlEvent</span></code> table for this control.</p>

  643. </dd></dl>

  644. 

  645. <dl class="py method">

  646. <dt class="sig sig-object py" id="msilib.Control.mapping">

  647. <span class="sig-name descname"><span class="pre">mapping</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">event</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attribute</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Control.mapping" title="Link to this definition">¶</a></dt>

  648. <dd><p>Make an entry into the <code class="docutils literal notranslate"><span class="pre">EventMapping</span></code> table for this control.</p>

  649. </dd></dl>

  650. 

  651. <dl class="py method">

  652. <dt class="sig sig-object py" id="msilib.Control.condition">

  653. <span class="sig-name descname"><span class="pre">condition</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">action</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">condition</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Control.condition" title="Link to this definition">¶</a></dt>

  654. <dd><p>Make an entry into the <code class="docutils literal notranslate"><span class="pre">ControlCondition</span></code> table for this control.</p>

  655. </dd></dl>

  656. 

  657. </dd></dl>

  658. 

  659. <dl class="py class">

  660. <dt class="sig sig-object py" id="msilib.RadioButtonGroup">

  661. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">msilib.</span></span><span class="sig-name descname"><span class="pre">RadioButtonGroup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dlg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">property</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.RadioButtonGroup" title="Link to this definition">¶</a></dt>

  662. <dd><p>Create a radio button control named <em>name</em>. <em>property</em> is the installer property

  663. that gets set when a radio button is selected.</p>

  664. <dl class="py method">

  665. <dt class="sig sig-object py" id="msilib.RadioButtonGroup.add">

  666. <span class="sig-name descname"><span class="pre">add</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">width</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">height</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">text</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.RadioButtonGroup.add" title="Link to this definition">¶</a></dt>

  667. <dd><p>Add a radio button named <em>name</em> to the group, at the coordinates <em>x</em>, <em>y</em>,

  668. <em>width</em>, <em>height</em>, and with the label <em>text</em>. If <em>value</em> is <code class="docutils literal notranslate"><span class="pre">None</span></code>, it

  669. defaults to <em>name</em>.</p>

  670. </dd></dl>

  671. 

  672. </dd></dl>

  673. 

  674. <dl class="py class">

  675. <dt class="sig sig-object py" id="msilib.Dialog">

  676. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">msilib.</span></span><span class="sig-name descname"><span class="pre">Dialog</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">w</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">h</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">title</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">first</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cancel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Dialog" title="Link to this definition">¶</a></dt>

  677. <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,

  678. with the specified coordinates, dialog attributes, title, name of the first,

  679. default, and cancel controls.</p>

  680. <dl class="py method">

  681. <dt class="sig sig-object py" id="msilib.Dialog.control">

  682. <span class="sig-name descname"><span class="pre">control</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">width</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">height</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attributes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">property</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">text</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">control_next</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">help</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Dialog.control" title="Link to this definition">¶</a></dt>

  683. <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

  684. made with the specified parameters.</p>

  685. <p>This is a generic method; for specific types, specialized methods are

  686. provided.</p>

  687. </dd></dl>

  688. 

  689. <dl class="py method">

  690. <dt class="sig sig-object py" id="msilib.Dialog.text">

  691. <span class="sig-name descname"><span class="pre">text</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">width</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">height</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attributes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">text</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Dialog.text" title="Link to this definition">¶</a></dt>

  692. <dd><p>Add and return a <code class="docutils literal notranslate"><span class="pre">Text</span></code> control.</p>

  693. </dd></dl>

  694. 

  695. <dl class="py method">

  696. <dt class="sig sig-object py" id="msilib.Dialog.bitmap">

  697. <span class="sig-name descname"><span class="pre">bitmap</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">width</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">height</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">text</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Dialog.bitmap" title="Link to this definition">¶</a></dt>

  698. <dd><p>Add and return a <code class="docutils literal notranslate"><span class="pre">Bitmap</span></code> control.</p>

  699. </dd></dl>

  700. 

  701. <dl class="py method">

  702. <dt class="sig sig-object py" id="msilib.Dialog.line">

  703. <span class="sig-name descname"><span class="pre">line</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">width</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">height</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Dialog.line" title="Link to this definition">¶</a></dt>

  704. <dd><p>Add and return a <code class="docutils literal notranslate"><span class="pre">Line</span></code> control.</p>

  705. </dd></dl>

  706. 

  707. <dl class="py method">

  708. <dt class="sig sig-object py" id="msilib.Dialog.pushbutton">

  709. <span class="sig-name descname"><span class="pre">pushbutton</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">width</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">height</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attributes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">text</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">next_control</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Dialog.pushbutton" title="Link to this definition">¶</a></dt>

  710. <dd><p>Add and return a <code class="docutils literal notranslate"><span class="pre">PushButton</span></code> control.</p>

  711. </dd></dl>

  712. 

  713. <dl class="py method">

  714. <dt class="sig sig-object py" id="msilib.Dialog.radiogroup">

  715. <span class="sig-name descname"><span class="pre">radiogroup</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">width</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">height</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attributes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">property</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">text</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">next_control</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Dialog.radiogroup" title="Link to this definition">¶</a></dt>

  716. <dd><p>Add and return a <code class="docutils literal notranslate"><span class="pre">RadioButtonGroup</span></code> control.</p>

  717. </dd></dl>

  718. 

  719. <dl class="py method">

  720. <dt class="sig sig-object py" id="msilib.Dialog.checkbox">

  721. <span class="sig-name descname"><span class="pre">checkbox</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">width</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">height</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attributes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">property</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">text</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">next_control</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#msilib.Dialog.checkbox" title="Link to this definition">¶</a></dt>

  722. <dd><p>Add and return a <code class="docutils literal notranslate"><span class="pre">CheckBox</span></code> control.</p>

  723. </dd></dl>

  724. 

  725. </dd></dl>

  726. 

  727. <div class="admonition seealso">

  728. <p class="admonition-title">See also</p>

  729. <p><a class="reference external" href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa368286.aspx">Dialog Table</a>

  730. <a class="reference external" href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa368044.aspx">Control Table</a>

  731. <a class="reference external" href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa368039.aspx">Control Types</a>

  732. <a class="reference external" href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa368035.aspx">ControlCondition Table</a>

  733. <a class="reference external" href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa368037.aspx">ControlEvent Table</a>

  734. <a class="reference external" href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa368559.aspx">EventMapping Table</a>

  735. <a class="reference external" href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa370962.aspx">RadioButton Table</a></p>

  736. </div>

  737. </section>

  738. <section id="precomputed-tables">

  739. <span id="msi-tables"></span><h2>Precomputed tables<a class="headerlink" href="#precomputed-tables" title="Link to this heading">¶</a></h2>

  740. <p><a class="reference internal" href="#module-msilib" title="msilib: Creation of Microsoft Installer files, and CAB files. (deprecated) (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

  741. definitions. Currently, these definitions are based on MSI version 2.0.</p>

  742. <dl class="py data">

  743. <dt class="sig sig-object py" id="msilib.schema">

  744. <span class="sig-prename descclassname"><span class="pre">msilib.</span></span><span class="sig-name descname"><span class="pre">schema</span></span><a class="headerlink" href="#msilib.schema" title="Link to this definition">¶</a></dt>

  745. <dd><p>This is the standard MSI schema for MSI 2.0, with the <em>tables</em> variable

  746. providing a list of table definitions, and <em>_Validation_records</em> providing the

  747. data for MSI validation.</p>

  748. </dd></dl>

  749. 

  750. <dl class="py data">

  751. <dt class="sig sig-object py" id="msilib.sequence">

  752. <span class="sig-prename descclassname"><span class="pre">msilib.</span></span><span class="sig-name descname"><span class="pre">sequence</span></span><a class="headerlink" href="#msilib.sequence" title="Link to this definition">¶</a></dt>

  753. <dd><p>This module contains table contents for the standard sequence tables:

  754. <em>AdminExecuteSequence</em>, <em>AdminUISequence</em>, <em>AdvtExecuteSequence</em>,

  755. <em>InstallExecuteSequence</em>, and <em>InstallUISequence</em>.</p>

  756. </dd></dl>

  757. 

  758. <dl class="py data">

  759. <dt class="sig sig-object py" id="msilib.text">

  760. <span class="sig-prename descclassname"><span class="pre">msilib.</span></span><span class="sig-name descname"><span class="pre">text</span></span><a class="headerlink" href="#msilib.text" title="Link to this definition">¶</a></dt>

  761. <dd><p>This module contains definitions for the UIText and ActionText tables, for the

  762. standard installer actions.</p>

  763. </dd></dl>

  764. 

  765. </section>

  766. </section>

  767. 

  768. 

  769.             <div class="clearer"></div>

  770.           </div>

  771.         </div>

  772.       </div>

  773.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">

  774.         <div class="sphinxsidebarwrapper">

  775.   <div>

  776.     <h3><a href="../contents.html">Table of Contents</a></h3>

  777.     <ul>

  778. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">msilib</span></code> — Read and write Microsoft Installer files</a><ul>

  779. <li><a class="reference internal" href="#database-objects">Database Objects</a></li>

  780. <li><a class="reference internal" href="#view-objects">View Objects</a></li>

  781. <li><a class="reference internal" href="#summary-information-objects">Summary Information Objects</a></li>

  782. <li><a class="reference internal" href="#record-objects">Record Objects</a></li>

  783. <li><a class="reference internal" href="#errors">Errors</a></li>

  784. <li><a class="reference internal" href="#cab-objects">CAB Objects</a></li>

  785. <li><a class="reference internal" href="#directory-objects">Directory Objects</a></li>

  786. <li><a class="reference internal" href="#features">Features</a></li>

  787. <li><a class="reference internal" href="#gui-classes">GUI classes</a></li>

  788. <li><a class="reference internal" href="#precomputed-tables">Precomputed tables</a></li>

  789. </ul>

  790. </li>

  791. </ul>

  792. 

  793.   </div>

  794.   <div>

  795.     <h4>Previous topic</h4>

  796.     <p class="topless"><a href="mailcap.html"

  797.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">mailcap</span></code> — Mailcap file handling</a></p>

  798.   </div>

  799.   <div>

  800.     <h4>Next topic</h4>

  801.     <p class="topless"><a href="nis.html"

  802.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">nis</span></code> — Interface to Sun’s NIS (Yellow Pages)</a></p>

  803.   </div>

  804.   <div role="note" aria-label="source link">

  805.     <h3>This Page</h3>

  806.     <ul class="this-page-menu">

  807.       <li><a href="../bugs.html">Report a Bug</a></li>

  808.       <li>

  809.         <a href="https://github.com/python/cpython/blob/main/Doc/library/msilib.rst"

  810.             rel="nofollow">Show Source

  811.         </a>

  812.       </li>

  813.     </ul>

  814.   </div>

  815.         </div>

  816. <div id="sidebarbutton" title="Collapse sidebar">

  817. <span>«</span>

  818. </div>

  819. 

  820.       </div>

  821.       <div class="clearer"></div>

  822.     </div>  

  823.     <div class="related" role="navigation" aria-label="related navigation">

  824.       <h3>Navigation</h3>

  825.       <ul>

  826.         <li class="right" style="margin-right: 10px">

  827.           <a href="../genindex.html" title="General Index"

  828.              >index</a></li>

  829.         <li class="right" >

  830.           <a href="../py-modindex.html" title="Python Module Index"

  831.              >modules</a> |</li>

  832.         <li class="right" >

  833.           <a href="nis.html" title="nis — Interface to Sun’s NIS (Yellow Pages)"

  834.              >next</a> |</li>

  835.         <li class="right" >

  836.           <a href="mailcap.html" title="mailcap — Mailcap file handling"

  837.              >previous</a> |</li>

  838. 

  839.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  840.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  841.           <li class="switchers">

  842.             <div class="language_switcher_placeholder"></div>

  843.             <div class="version_switcher_placeholder"></div>

  844.           </li>

  845.           <li>

  846.               

  847.           </li>

  848.     <li id="cpython-language-and-version">

  849.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  850.     </li>

  851. 

  852.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  853.           <li class="nav-item nav-item-2"><a href="superseded.html" >Superseded Modules</a> &#187;</li>

  854.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">msilib</span></code> — Read and write Microsoft Installer files</a></li>

  855.                 <li class="right">

  856.                     

  857. 

  858.     <div class="inline-search" role="search">

  859.         <form class="inline-search" action="../search.html" method="get">

  860.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  861.           <input type="submit" value="Go" />

  862.         </form>

  863.     </div>

  864.                      |

  865.                 </li>

  866.             <li class="right">

  867. <label class="theme-selector-label">

  868.     Theme

  869.     <select class="theme-selector" oninput="activateTheme(this.value)">

  870.         <option value="auto" selected>Auto</option>

  871.         <option value="light">Light</option>

  872.         <option value="dark">Dark</option>

  873.     </select>

  874. </label> |</li>

  875.             

  876.       </ul>

  877.     </div>  

  878.     <div class="footer">

  879.     &copy; 

  880.       <a href="../copyright.html">

  881.     

  882.     Copyright

  883.     

  884.       </a>

  885.      2001-2024, Python Software Foundation.

  886.     <br />

  887.     This page is licensed under the Python Software Foundation License Version 2.

  888.     <br />

  889.     Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.

  890.     <br />

  891.     

  892.       See <a href="/license.html">History and License</a> for more information.<br />

  893.     

  894.     

  895.     <br />

  896. 

  897.     The Python Software Foundation is a non-profit corporation.

  898. <a href="https://www.python.org/psf/donations/">Please donate.</a>

  899. <br />

  900.     <br />

  901.       Last updated on Apr 09, 2024 (13:47 UTC).

  902.     

  903.       <a href="/bugs.html">Found a bug</a>?

  904.     

  905.     <br />

  906. 

  907.     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

  908.     </div>

  909. 

  910.   </body>

  911. </html>
上海开阖软件有限公司 沪ICP备12045867号-1