https://github.com/heaths/msica-rs
Rust for Windows Installer Custom Actions
https://github.com/heaths/msica-rs
Last synced: 11 months ago
JSON representation
Rust for Windows Installer Custom Actions
- Host: GitHub
- URL: https://github.com/heaths/msica-rs
- Owner: heaths
- License: mit
- Created: 2022-08-03T09:04:52.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-06-18T22:04:21.000Z (almost 2 years ago)
- Last Synced: 2025-06-29T12:43:10.450Z (11 months ago)
- Language: Rust
- Size: 71.3 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Rust for Windows Installer Custom Actions
[](https://crates.io/crates/msica)
Writing [custom actions] for [Windows Installer] (MSI) can be difficult enough already,
but using Rust can help mitigate some potential issues concerning memory and handle leaks.
These APIs roughly mimic the Windows Installer [automation interface] for those APIs
that can be called in immediate and deferred custom actions.
## Example
You can define custom actions in Rust using its [foreign function interface][ffi] like:
```rust
use msica::prelude::*;
const ERROR_SUCCESS: u32 = 0;
const ERROR_INSTALL_FAILURE: u32 = 1603;
#[no_mangle]
pub extern "C" fn MyCustomAction(session: Session) -> u32 {
match Record::with_fields(
Some("this is [1] [2]"),
vec![
Field::IntegerData(1),
Field::StringData("example".to_owned()),
],
) {
Ok(record) => {
session.message(MessageType::User, &record);
ERROR_SUCCESS
}
_ => ERROR_INSTALL_FAILURE,
}
}
```
### Using nightly feature
If you enable the `nightly` feature and use the nightly toolchain, you can use the question mark operator (`?`) to
propagate errors:
```rust
use msica::prelude::*;
#[no_mangle]
pub extern "C" fn MyCustomAction(session: Session) -> CustomActionResult {
let record = Record::with_fields(
Some("this is [1] [2]"),
vec![Field::IntegerData(1), Field::StringData("example".to_owned())],
)?;
session.message(MessageType::User, &record);
Success
}
```
## License
This project is licensed under the [MIT license](https://github.com/heaths/msica-rs/blob/main/LICENSE.txt).
[automation interface]: https://docs.microsoft.com/windows/win32/msi/automation-interface
[custom actions]: https://docs.microsoft.com/windows/win32/msi/custom-actions
[ffi]: https://doc.rust-lang.org/nomicon/ffi.html
[Windows Installer]: https://docs.microsoft.com/windows/win32/msi/about-windows-installer