diff options
author | Georg Brandl <georg@python.org> | 2008-02-23 22:55:18 (GMT) |
---|---|---|
committer | Georg Brandl <georg@python.org> | 2008-02-23 22:55:18 (GMT) |
commit | b0b0317ba2d46ba38973a4c4cf24f6dec054ca38 (patch) | |
tree | cefecd7442e3cd74395dfe54d7c2ad0a99b79615 | |
parent | c12b9888f70d4845af6dcdf7683e19e2f4c925fa (diff) | |
download | cpython-b0b0317ba2d46ba38973a4c4cf24f6dec054ca38.zip cpython-b0b0317ba2d46ba38973a4c4cf24f6dec054ca38.tar.gz cpython-b0b0317ba2d46ba38973a4c4cf24f6dec054ca38.tar.bz2 |
#1825: correctly document msilib.add_data.
-rw-r--r-- | Doc/library/msilib.rst | 16 |
1 files changed, 11 insertions, 5 deletions
diff --git a/Doc/library/msilib.rst b/Doc/library/msilib.rst index 193ac3b..c605473 100644 --- a/Doc/library/msilib.rst +++ b/Doc/library/msilib.rst @@ -67,7 +67,7 @@ structures. .. function:: init_database(name, schema, ProductName, ProductCode, ProductVersion, Manufacturer) - Create and return a new database *name*, initialize it with *schema*, and set + Create and return a new database *name*, initialize it with *schema*, and set the properties *ProductName*, *ProductCode*, *ProductVersion*, and *Manufacturer*. @@ -79,11 +79,17 @@ structures. function returns. -.. function:: add_data(database, records) +.. function:: add_data(database, table, records) - Add all *records* to *database*. *records* should be a list of tuples, each one - containing all fields of a record according to the schema of the table. For - optional fields, ``None`` can be passed. + Add all *records* to the table named *table* in *database*. + + The *table* argument must be one of the predefined tables in the MSI schema, + e.g. ``'Feature'``, ``'File'``, ``'Component'``, ``'Dialog'``, ``'Control'``, + etc. + + *records* should be a list of tuples, each one containing all fields of a + record according to the schema of the table. For optional fields, + ``None`` can be passed. Field values can be int or long numbers, strings, or instances of the Binary class. |