| .. function:: CreateRecord(count) |
| |
| Return a new record object by calling :cfunc:`MSICreateRecord`. *count* is the |
| number of fields of the record. |
| |
| |
| .. function:: init_database(name, schema, ProductName, ProductCode, ProductVersion, Manufacturer) |
| |
n | Create and return a new database *name*, initialize it with *schema*, and set |
n | Create and return a new database *name*, initialize it with *schema*, and set |
| the properties *ProductName*, *ProductCode*, *ProductVersion*, and |
| *Manufacturer*. |
| |
| *schema* must be a module object containing ``tables`` and |
| ``_Validation_records`` attributes; typically, :mod:`msilib.schema` should be |
| used. |
| |
| The database will contain just the schema and the validation records when this |
| function returns. |
| |
| |
n | .. function:: add_data(database, records) |
n | .. function:: add_data(database, table, records) |
| |
n | Add all *records* to *database*. *records* should be a list of tuples, each one |
n | Add all *records* to the table named *table* in *database*. |
| containing all fields of a record according to the schema of the table. For |
| |
| 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, |
| optional fields, ``None`` can be passed. |
| ``None`` can be passed. |
| |
| Field values can be int or long numbers, strings, or instances of the Binary |
| class. |
| |
| |
| .. class:: Binary(filename) |
| |
| Represents entries in the Binary table; inserting such an object using |
| `UuidToString <http://msdn.microsoft.com/library/default.asp?url=/library/en-us/rpc/rpc/uuidtostring.asp>`_ |
| |
| .. _database-objects: |
| |
| Database Objects |
| ---------------- |
| |
| |
n | .. method:: XXX Class.OpenView(sql) |
n | .. method:: Database.OpenView(sql) |
| |
| Return a view object, by calling :cfunc:`MSIDatabaseOpenView`. *sql* is the SQL |
| statement to execute. |
| |
| |
n | .. method:: XXX Class.Commit() |
n | .. method:: Database.Commit() |
| |
| Commit the changes pending in the current transaction, by calling |
| :cfunc:`MSIDatabaseCommit`. |
| |
| |
n | .. method:: XXX Class.GetSummaryInformation(count) |
n | .. method:: Database.GetSummaryInformation(count) |
| |
| Return a new summary information object, by calling |
| :cfunc:`MsiGetSummaryInformation`. *count* is the maximum number of updated |
| values. |
| |
| |
| .. seealso:: |
| |
n | `MSIOpenView <http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/msiopenview.asp>`_ |
n | `MSIDatabaseOpenView <http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/msidatabaseopenview.asp>`_ |
| `MSIDatabaseCommit <http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/msidatabasecommit.asp>`_ |
| `MSIGetSummaryInformation <http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/msigetsummaryinformation.asp>`_ |
| |
| .. _view-objects: |
| |
| View Objects |
| ------------ |
| |
| |
n | .. method:: XXX Class.Execute([params=None]) |
n | .. method:: View.Execute(params) |
| |
n | Execute the SQL query of the view, through :cfunc:`MSIViewExecute`. *params* is |
n | Execute the SQL query of the view, through :cfunc:`MSIViewExecute`. If |
| an optional record describing actual values of the parameter tokens in the |
| *params* is not ``None``, it is a record describing actual values of the |
| query. |
| parameter tokens in the query. |
| |
| |
n | .. method:: XXX Class.GetColumnInfo(kind) |
n | .. method:: View.GetColumnInfo(kind) |
| |
| Return a record describing the columns of the view, through calling |
| :cfunc:`MsiViewGetColumnInfo`. *kind* can be either ``MSICOLINFO_NAMES`` or |
| ``MSICOLINFO_TYPES``. |
| |
| |
n | .. method:: XXX Class.Fetch() |
n | .. method:: View.Fetch() |
| |
| Return a result record of the query, through calling :cfunc:`MsiViewFetch`. |
| |
| |
n | .. method:: XXX Class.Modify(kind, data) |
n | .. method:: View.Modify(kind, data) |
| |
| Modify the view, by calling :cfunc:`MsiViewModify`. *kind* can be one of |
| ``MSIMODIFY_SEEK``, ``MSIMODIFY_REFRESH``, ``MSIMODIFY_INSERT``, |
| ``MSIMODIFY_UPDATE``, ``MSIMODIFY_ASSIGN``, ``MSIMODIFY_REPLACE``, |
| ``MSIMODIFY_MERGE``, ``MSIMODIFY_DELETE``, ``MSIMODIFY_INSERT_TEMPORARY``, |
| ``MSIMODIFY_VALIDATE``, ``MSIMODIFY_VALIDATE_NEW``, |
| ``MSIMODIFY_VALIDATE_FIELD``, or ``MSIMODIFY_VALIDATE_DELETE``. |
| |
| *data* must be a record describing the new data. |
| |
| |
n | .. method:: XXX Class.Close() |
n | .. method:: View.Close() |
| |
| Close the view, through :cfunc:`MsiViewClose`. |
| |
| |
| .. seealso:: |
| |
| `MsiViewExecute <http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/msiviewexecute.asp>`_ |
| `MSIViewGetColumnInfo <http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/msiviewgetcolumninfo.asp>`_ |
| `MsiViewClose <http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/msiviewclose.asp>`_ |
| |
| .. _summary-objects: |
| |
| Summary Information Objects |
| --------------------------- |
| |
| |
n | .. method:: XXX Class.GetProperty(field) |
n | .. method:: SummaryInformation.GetProperty(field) |
| |
| Return a property of the summary, through :cfunc:`MsiSummaryInfoGetProperty`. |
| *field* is the name of the property, and can be one of the constants |
| ``PID_CODEPAGE``, ``PID_TITLE``, ``PID_SUBJECT``, ``PID_AUTHOR``, |
| ``PID_KEYWORDS``, ``PID_COMMENTS``, ``PID_TEMPLATE``, ``PID_LASTAUTHOR``, |
| ``PID_REVNUMBER``, ``PID_LASTPRINTED``, ``PID_CREATE_DTM``, |
| ``PID_LASTSAVE_DTM``, ``PID_PAGECOUNT``, ``PID_WORDCOUNT``, ``PID_CHARCOUNT``, |
| ``PID_APPNAME``, or ``PID_SECURITY``. |
| |
| |
n | .. method:: XXX Class.GetPropertyCount() |
n | .. method:: SummaryInformation.GetPropertyCount() |
| |
| Return the number of summary properties, through |
| :cfunc:`MsiSummaryInfoGetPropertyCount`. |
| |
| |
n | .. method:: XXX Class.SetProperty(field, value) |
n | .. method:: SummaryInformation.SetProperty(field, value) |
| |
| Set a property through :cfunc:`MsiSummaryInfoSetProperty`. *field* can have the |
| same values as in :meth:`GetProperty`, *value* is the new value of the property. |
| Possible value types are integer and string. |
| |
| |
n | .. method:: XXX Class.Persist() |
n | .. method:: SummaryInformation.Persist() |
| |
| Write the modified properties to the summary information stream, using |
| :cfunc:`MsiSummaryInfoPersist`. |
| |
| |
| .. seealso:: |
| |
| `MsiSummaryInfoGetProperty <http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/msisummaryinfogetproperty.asp>`_ |
| `MsiSummaryInfoPersist <http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/msisummaryinfopersist.asp>`_ |
| |
| .. _record-objects: |
| |
| Record Objects |
| -------------- |
| |
| |
n | .. method:: XXX Class.GetFieldCount() |
n | .. method:: Record.GetFieldCount() |
| |
| Return the number of fields of the record, through |
| :cfunc:`MsiRecordGetFieldCount`. |
| |
| |
n | .. method:: Record.GetInteger(field) |
| |
| Return the value of *field* as an integer where possible. *field* must |
| be an integer. |
| |
| |
| .. method:: Record.GetString(field) |
| |
| Return the value of *field* as a string where possible. *field* must |
| be an integer. |
| |
| |
| .. method:: XXX Class.SetString(field, value) |
| .. method:: Record.SetString(field, value) |
| |
| Set *field* to *value* through :cfunc:`MsiRecordSetString`. *field* must be an |
| integer; *value* a string. |
| |
| |
n | .. method:: XXX Class.SetStream(field, value) |
n | .. method:: Record.SetStream(field, value) |
| |
| Set *field* to the contents of the file named *value*, through |
| :cfunc:`MsiRecordSetStream`. *field* must be an integer; *value* a string. |
| |
| |
n | .. method:: XXX Class.SetInteger(field, value) |
n | .. method:: Record.SetInteger(field, value) |
| |
| Set *field* to *value* through :cfunc:`MsiRecordSetInteger`. Both *field* and |
| *value* must be an integer. |
| |
| |
n | .. method:: XXX Class.ClearData() |
n | .. method:: Record.ClearData() |
| |
| Set all fields of the record to 0, through :cfunc:`MsiRecordClearData`. |
| |
| |
| .. seealso:: |
| |
| `MsiRecordGetFieldCount <http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/msirecordgetfieldcount.asp>`_ |
| `MsiRecordSetString <http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/msirecordsetstring.asp>`_ |
| The class :class:`CAB` represents a CAB file. During MSI construction, files |
| will be added simultaneously to the ``Files`` 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. |
| |
| *name* is the name of the CAB file in the MSI file. |
| |
| |
n | .. method:: CAB.append(full, logical) |
n | .. method:: append(full, file, logical) |
| |
n | Add the file with the pathname *full* to the CAB file, under the name *logical*. |
n | Add the file with the pathname *full* to the CAB file, under the name |
| If there is already a file named *logical*, a new file name is created. |
| *logical*. If there is already a file named *logical*, a new file name is |
| created. |
| |
n | Return the index of the file in the CAB file, and the new name of the file |
n | Return the index of the file in the CAB file, and the new name of the file |
| inside the CAB file. |
| inside the CAB file. |
| |
| |
n | .. method:: CAB.append(database) |
n | .. method:: commit(database) |
| |
n | Generate a CAB file, add it as a stream to the MSI file, put it into the |
n | Generate a CAB file, add it as a stream to the MSI file, put it into the |
| ``Media`` table, and remove the generated file from the disk. |
| ``Media`` table, and remove the generated file from the disk. |
| |
| |
| .. _msi-directory: |
| |
| Directory Objects |
| ----------------- |
| |
| |
| :meth:`start_component`, 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 ``None``), the |
| path to the physical directory, and a logical directory name. *default* |
| specifies the DefaultDir slot in the directory table. *componentflags* specifies |
| the default flags that new components get. |
| |
| |
n | .. method:: Directory.start_component([component[, feature[, flags[, keyfile[, uuid]]]]]) |
n | .. method:: start_component([component[, feature[, flags[, keyfile[, uuid]]]]]) |
| |
n | Add an entry to the Component table, and make this component the current |
n | 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 |
| component for this directory. If no component name is given, the directory |
| is used. If no *feature* is given, the current feature is used. If no *flags* |
| name is used. If no *feature* is given, the current feature is used. If no |
| are given, the directory's default flags are used. If no *keyfile* is given, the |
| *flags* are given, the directory's default flags are used. If no *keyfile* |
| KeyPath is left null in the Component table. |
| is given, the KeyPath is left null in the Component table. |
| |
| |
n | .. method:: Directory.add_file(file[, src[, version[, language]]]) |
n | .. method:: add_file(file[, src[, version[, language]]]) |
| |
n | Add a file to the current component of the directory, starting a new one if |
n | Add a file to the current component of the directory, starting a new one |
| there is no current component. By default, the file name in the source and the |
| if there is no current component. By default, the file name in the source |
| file table will be identical. If the *src* file is specified, it is interpreted |
| and the file table will be identical. If the *src* file is specified, it |
| relative to the current directory. Optionally, a *version* and a *language* can |
| is interpreted relative to the current directory. Optionally, a *version* |
| be specified for the entry in the File table. |
| and a *language* can be specified for the entry in the File table. |
| |
| |
n | .. method:: Directory.glob(pattern[, exclude]) |
n | .. method:: glob(pattern[, exclude]) |
| |
n | Add a list of files to the current component as specified in the glob pattern. |
n | Add a list of files to the current component as specified in the glob |
| Individual files can be excluded in the *exclude* list. |
| pattern. Individual files can be excluded in the *exclude* list. |
| |
| |
n | .. method:: Directory.remove_pyc() |
n | .. method:: remove_pyc() |
| |
n | Remove ``.pyc``/``.pyo`` files on uninstall. |
n | Remove ``.pyc``/``.pyo`` files on uninstall. |
| |
| |
| .. seealso:: |
| |
| `Directory Table <http://msdn.microsoft.com/library/en-us/msi/setup/directory_table.asp>`_ |
| `File Table <http://msdn.microsoft.com/library/en-us/msi/setup/file_table.asp>`_ |
| `Component Table <http://msdn.microsoft.com/library/en-us/msi/setup/component_table.asp>`_ |
| `FeatureComponents Table <http://msdn.microsoft.com/library/en-us/msi/setup/featurecomponents_table.asp>`_ |
| |
| |
| .. class:: Control(dlg, name) |
| |
| Base class of the dialog controls. *dlg* is the dialog object the control |
| belongs to, and *name* is the control's name. |
| |
| |
n | .. method:: Control.event(event, argument[, condition = ``1''[, ordering]]) |
n | .. method:: event(event, argument[, condition=1[, ordering]]) |
| |
n | Make an entry into the ``ControlEvent`` table for this control. |
n | Make an entry into the ``ControlEvent`` table for this control. |
| |
| |
n | .. method:: Control.mapping(event, attribute) |
n | .. method:: mapping(event, attribute) |
| |
n | Make an entry into the ``EventMapping`` table for this control. |
n | Make an entry into the ``EventMapping`` table for this control. |
| |
| |
n | .. method:: Control.condition(action, condition) |
n | .. method:: condition(action, condition) |
| |
n | Make an entry into the ``ControlCondition`` table for this control. |
n | Make an entry into the ``ControlCondition`` table for this control. |
| |
| |
| .. class:: RadioButtonGroup(dlg, name, property) |
| |
| Create a radio button control named *name*. *property* is the installer property |
| that gets set when a radio button is selected. |
| |
| |
n | .. method:: RadioButtonGroup.add(name, x, y, width, height, text [, value]) |
n | .. method:: add(name, x, y, width, height, text [, value]) |
| |
n | Add a radio button named *name* to the group, at the coordinates *x*, *y*, |
n | Add a radio button named *name* to the group, at the coordinates *x*, *y*, |
| *width*, *height*, and with the label *text*. If *value* is omitted, it defaults |
| *width*, *height*, and with the label *text*. If *value* is omitted, it |
| to *name*. |
| defaults to *name*. |
| |
| |
| .. class:: Dialog(db, name, x, y, w, h, attr, title, first, default, cancel) |
| |
| Return a new :class:`Dialog` object. An entry in the ``Dialog`` table is made, |
| with the specified coordinates, dialog attributes, title, name of the first, |
| default, and cancel controls. |
| |
| |
n | .. method:: Dialog.control(name, type, x, y, width, height, attributes, property, text, control_next, help) |
n | .. method:: control(name, type, x, y, width, height, attributes, property, text, control_next, help) |
| |
n | Return a new :class:`Control` object. An entry in the ``Control`` table is made |
n | Return a new :class:`Control` object. An entry in the ``Control`` table is |
| with the specified parameters. |
| made with the specified parameters. |
| |
n | This is a generic method; for specific types, specialized methods are provided. |
n | This is a generic method; for specific types, specialized methods are |
| provided. |
| |
| |
n | .. method:: Dialog.text(name, x, y, width, height, attributes, text) |
n | .. method:: text(name, x, y, width, height, attributes, text) |
| |
n | Add and return a ``Text`` control. |
n | Add and return a ``Text`` control. |
| |
| |
n | .. method:: Dialog.bitmap(name, x, y, width, height, text) |
n | .. method:: bitmap(name, x, y, width, height, text) |
| |
n | Add and return a ``Bitmap`` control. |
n | Add and return a ``Bitmap`` control. |
| |
| |
n | .. method:: Dialog.line(name, x, y, width, height) |
n | .. method:: line(name, x, y, width, height) |
| |
n | Add and return a ``Line`` control. |
n | Add and return a ``Line`` control. |
| |
| |
n | .. method:: Dialog.pushbutton(name, x, y, width, height, attributes, text, next_control) |
n | .. method:: pushbutton(name, x, y, width, height, attributes, text, next_control) |
| |
n | Add and return a ``PushButton`` control. |
n | Add and return a ``PushButton`` control. |
| |
| |
n | .. method:: Dialog.radiogroup(name, x, y, width, height, attributes, property, text, next_control) |
n | .. method:: radiogroup(name, x, y, width, height, attributes, property, text, next_control) |
| |
n | Add and return a ``RadioButtonGroup`` control. |
n | Add and return a ``RadioButtonGroup`` control. |
| |
| |
n | .. method:: Dialog.checkbox(name, x, y, width, height, attributes, property, text, next_control) |
n | .. method:: checkbox(name, x, y, width, height, attributes, property, text, next_control) |
| |
n | Add and return a ``CheckBox`` control. |
n | Add and return a ``CheckBox`` control. |
| |
| |
| .. seealso:: |
| |
| `Dialog Table <http://msdn.microsoft.com/library/en-us/msi/setup/dialog_table.asp>`_ |
| `Control Table <http://msdn.microsoft.com/library/en-us/msi/setup/control_table.asp>`_ |
| `Control Types <http://msdn.microsoft.com/library/en-us/msi/setup/controls.asp>`_ |
| `ControlCondition Table <http://msdn.microsoft.com/library/en-us/msi/setup/controlcondition_table.asp>`_ |