docs.rs failed to build simconnect-sys-0.23.1
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.

`simconnect-sys`

FFI bindings for SimConnect.

Release Support

Currently supported version of simconnect-sys is using SimConnect SDK 0.23.1.

Crate will be updated for each new SimConnect SDK release with the version indicating the SDK version it targets.

Usage

[dependencies]
simconnect-sys = { version = "0.23.1", features = [ "static", "vendored" ] }

Getting Started

use simconnect_sys::*;

// open handle to SimConnect
let mut handle = std::ptr::null_mut();
let hr = unsafe { SimConnect_Open(
    &mut handle,
    CString::new("Example").as_ptr(),
    std::ptr::null_mut(),
    0,
    std::ptr::null_mut(),
    0,
) };
if hr != 0 || handle.is_null() {
    println!("SimConnect_Open failed");
}

See examples/sys-basic for a working example of using the FFI bindings for SimConnect.

Features

static - Statically link to SimConnect lib.
vendored - Use vendored SimConnect lib.

Environment Variables

SIMCONNECT_DIR (default=C:\MSFS SDK\SimConnect SDK)
- Directory containing the following files from the MSFS SimConnect SDK:
. ├── include/ │ └── SimConnect.h └── lib/ ├── SimConnect.lib └── static/ └── SimConnect.lib
SIMCONNECT_NO_VENDOR
- Provides an override of the vendored feature, ensuring vendored libs are not used.

License

This project is licensed under either of

Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed under the terms of both the Apache License, Version 2.0 and the MIT license without any additional terms or conditions.

simconnect-sys 0.23.1

simconnect-sys