SimConnect


Contents
Related Links

Overview

The SimConnect SDK can be used by programmers to write add-on components for Prepar3D. Add-on components for Prepar3D can be written in C, C++, or, if the managed API calls are being used, any .NET language such as C#.net or VB.net. Typically the components will perform one or more of the following:


SimConnect Setup


This section describes how to set up a development environment for SimConnect.

SimConnect Projects

To build SimConnect add-ons, you must use Visual Studio 2013 or later. To build the project make sure you have completed the following steps.

Potential issues when using SimConnect.lib

C++ projects that import SimConnect.lib will need to also import the following libraries:

Steps to add:

C/C++ Projects

  1. For C or C++ add-ons, start a new Win32 Console Application project if the add-on will have no user interface. Start a new Win32 Project or MFC Application if the add-on will have a user interface.
  2. Include the SimConnect.h header file.
  3. Link to the SimConnect.lib library, by adding SimConnect.lib to the Additional Options of the Command Line (see image below):

    Adding SimConnect.lib to the Additional Options

  4. Build the application using the function calls described in this document.

DLL Projects

  1. Create and add a definition file to the project. This is needed because SimConnect expects the exported names DLLStart and DLLStop to be undecorated (by default additional characters are added to these names). The definition file can be created by selecting Project/Add New Item from the main menu in Visual Studio. Edit the definition (.def) file so it looks like this (where DLL Project is the name of your project):
    LIBRARY "DLL Project"
    EXPORTS
    DLLStart
    DLLStop
  2. Confirm that the definition file has been added to the project by checking the Linker\Input properties:


    Linker Input dialog page

  3. Pay particular attention to the remarks and working samples for SimConnect_CallDispatch.

C#/.NET / VB.NET Projects

  1. For C#, or other .NET language add-ons, refer to the special section on Programming SimConnect Clients using Managed Code.
  2. Build the application using the function calls described in this document.
  3. There are three C# samples, and one VB.NET sample included with the SDK for reference.

All Projects

  1. Ensure that Visual Studio 2013 or later have been set to 32-bit only. When installed with a 64-bit operating system, these tools will default to a setting which is incompatible with SimConnect.dll. Go through the steps in the Setting x86 Platform Configuration section if you are working with a 64 bit operating system.
  2. Ensure the SimConnect.ini file is placed in your %USERPROFILE%\Documents\Prepar3D v3 Files folder. A default version of this files can be found in the SDK\Utilities\SimConnectSDK directory.You do not usually have to make any changes to this file. The SimConnect.ini file provided ensures that the SimConnect debug window opens to display communication information between the server and the clients.
  3. If the client is to work remotely, write a SimConnnect.cfg file for it.
  4. By default, SimConnect is disabled. To enable it, you must copy the necessary configuration files to the correct locations. Default versions of these files can be found in the SDK\Utilities\SimConnectSDK directory. Ensure the EXE.xml, DLL.xml files and SimConnect.xml files are placed in either the %APPDATA%\Lockheed Martin\Prepar3D v3 or %PROGRAMDATA%\Lockheed Martin\Prepar3D v3 folder, and edit these files according to the instructions that follow.
  5. Run Prepar3D to test your SimConnect client.

Setting x86 Platform Configuration

This section only applies to developers working with on a 64-bit operating system. If you are using Microsoft Visual Studio 2013 or later, open up your SimConnect client project and start from step 4. If you are using Microsoft Visual C++ or C# 2013 Express Edition, start from step 1.

  1. Select the Tools/Options menu item.
  2. Check Show all settings.
  3. Check Project and Solutions->Show Advanced Build Configurations.
  4. Open Build->Configuration Manager.
  5. Select the combo box under the Platform column for the project you want to target.
  6. Choose NEW
  7. Under New Platform select x86.
  8. Click OK, then Close. Note that the Toolbar combo box for Platform Configuration has x86 selected.
  9. Building will now be restricted to x86-only binaries.

Using Legacy SimConnect Versions

Some third party add-on software requires an older version of SimConnect than the most current one. In the same folder as your Prepar3D.exe, go to the "\redist\Interface" folder. There are multiple different legacy versions of SimConnect available:

Each of the legacy versions of SimConnect can be installed by following the instructions in their root folders. For most, you can install them using their respective .msi files.


The SimConnect.ini file

The default SimConnect.ini file will enable the debug window and disable the log file. Use a semi-colon to start a comment, or comment out a directive. The file should be placed in your %USERPROFILE%\Documents\Prepar3D v3 Files folder.

Directive Values Description
level Verbose, Normal, Warning, Error, Off Set the level of text communication to be provided to the console, debug string, or log file.
console Yes, No Open a command line debug window to display server to client communication.
OutputDebugString Yes, No Sends server client communication to the debugger for display. Either your SimConnect application or Prepar3D must be launched from within an integrated development environment (IDE) debugger in order for this option to work. Refer to MSDN documentation for more details.
file Filename Output communications to a log file. If the text %03u is included in the filename, then the filename will be incremented each time Prepar3D starts, so giving a new log file for each test run.
Example: file=c:\simconnect%03u.log
file_next_index Integer The index of the first log file. Subsequent log files will have the index number incremented by one.

The SimConnect.cfg file

The SimConnect.cfg file contains communications information for a client (the SimConnect.xml file contains information for a server). This file is only required if a client is going to access Prepar3D running on a remote machine, and should be placed in the Documents folder, or in the same folder as the client application or library, on the computer the client is running on.

Note: SimConnect.msi is no longer needed due to the fact that the WinSxS library has been depreciated.

The SimConnect.cfg file can contain a number of configurations, identified in sections with the [SimConnect.N] title. The index number is used as a parameter in the SimConnect_Open function. This is useful for applications that communicate with a number of different machines that are running Prepar3D. The default configuration index is zero, and if there is only one configuration in the file, no index number is required.


Directive Values Description
Protocol Pipe, IPv4, IPv6 Pipe uses a Named-Pipes communication system. The IPv4 and IPv6 protocols are available on computers running Windows, with IPv4 as the default. IPv6 has more security features and is recommended. If IPv6 is not already installed, there is a utility to install it in the SimConnect SDK\config folder.
The order in which protocols are evaluated is: Pipe, IPv6, IPv4, Pipe. So, for example, if this entry is set at IPv6, then IPv4 and Pipe will evaluated in that order. The first working protocol found will be used. The advantage of Pipe communication is that it avoids conflict with firewalls and virus protection software when the connection is local, which of course is not the situation if a SimConnect.cfg file is required.
Address

Port
  The Address and Port of the SimConnect server should be entered in these fields, these will be the same values as those in the appropriate Comm section of the Simconnect.xml file. A good knowledge of Windows networking and client/server applications will be needed to set these correctly. The address can be the name of a computer in a Domain Controller environment.
MaxReceiveSize Integer The maximum packet size. The default is 8192. If the client receives a packet larger than this size, it will disconnect from the server.
DisableNagle 0, 1 Set to 1 to disable the Nagle packet optimization algorithms.

The EXE.xml and DLL.xml files

Information, such as how to configure add-ons for your SimConnect add-on, can be found in the Add-Ons section of the documentation. These articles contain examples and precise directions to configure add-ons ranging from low to high complexity.

The SimConnect.xml file

The SimConnect.xml file contains communication information for the SimConnect server (the SimConnect.cfg file contains information for a client). The default behavior is that three servers are initiated by the system, for local communication using one of each of the three protocols: Pipe, IPv4, and IPv6. These servers do not require entries in the XML file. The Simconnect.xml file is not needed if this covers the communication requirements. If remote connections are required, then one entry will need to be made in this file to cover each type of remote communication that needs to be supported.

The following table describes the file format. The file should be placed in the in the %APPDATA%\Lockheed Martin\Prepar3D v3 folder, on the computer the server is running on.


XML Values Description
<SimBase.Document Type="SimConnect" version="1,0"></SimBase.Document> String SimConnect version information.
<Descr>SimConnect</Descr> String Description of this file.
<Filename>SimConnect.xml</Filename> String This filename.
<Disabled>False</Disabled> True, False Set to True to disable SimConnect completely.
<SimConnect.Comm></SimConnect.Comm>   Communications section. If remote connections are required, then additional SimConnect.Comm sections should be added, one for each protocol or scope that should be supported.
<Disabled>False</Disabled> True, False Set to True to disable this communication section.
<Protocol>IPv6</Protocol> Pipe (or Auto),
IPv4,
IPv6
The entry Auto is accepted for backwards compatibility as synonymous with Pipe. The protocol entered here is the only one this particular server will accept.
<Scope>local</Scope> local,
global,
link-local,
unrestricted
For Pipe or IPv4, one of local or global. For IPv6, one of local, link-local, global, or unrestricted. Link-local is an IPv6 mechanism for accessing computers on a network that does not involve traversing a router. Unrestricted enables Teredo tunneling. Refer to Named-Pipe, IPv4 and IPv6 documentation on MSDN for more details.
<Address></Address>
<Port></Port>
  The server address and port. These should be copied to the identically named fields in the SimConnect.cfg files for the clients.
<MaxClients></MaxClients> Integer Define the maximum number of SimConnect clients that can be active at any one time, using this communication section.
<MaxRecvSize></MaxRecvSize> Integer The maximum receive packet size, in bytes. The server will disconnect a client that transmits a packet larger than this.
<DisableNagle>True</DisableNagle> True,
False
Set to True to disable the Nagle packet sending algorithms.

Design Considerations

The design of a SimConnect add-on involves writing a client to communicate with a server running within Prepar3D. The client opens up communications with the server, then requests that certain events and certain object information are passed to it. The client then waits for the information to be received from the server, and then processes it appropriately.

The recommended method of writing an add-on is to build it out-of-process, as an application (an .exe file) rather than in-process, as a library (a .dll file). This is because out-of-process applications provide more stability, if they crash they will typically will not crash Prepar3D, and are easier to build, test and debug. Out-of-process also supports Managed code, and therefore applications can be written in .NET languages, with their rich support for objects and ease of building the UI. SimConnect clients are not currently thread-safe.

SimConnect makes extensive use of ID numbers defined by the client. There are ID numbers for requests, data definitions, events, groups, and so on. These ID numbers should be unique for the client. Re-using an ID will result in the previous call using that ID becoming obsolete, and ignored by the server.

It is a good idea to check out control sequences (such as start-up) in the simulator itself, before trying to code those sequences using SimConnect calls.

Versioning

Only one version of Prepar3D can be running on one computer at a time, so a client installed on a local machine will only be communicating with one server. However it is possible to have one client communicate with multiple copies of Prepar3D, running on a network.

The SimConnect client library used by Prepar3D will be located in the WinSxS (side-by-side) folder. As new versions of the client library are released, they too will be placed in this folder, alongside and not replacing previous versions. This means that add-ons written for older versions of SimConnect will still run as newer versions are released. If a developer wishes to ensure that their client code will run against an earlier version of SimConnect, they should develop using the header and library provided in the SimConnect SDK/LegacyInterfaces folder. Internal version tagging of each API call ensures that a function call will be routed correctly when multiple options exist.


SimConnect API Reference

This section lists all the API functions, structures, enumerations, and other coding information necessary to build SimConnect clients.

Information on each API call includes some example code. This code does not form a complete program in any sense, but simply highlights the uses of the API call. The Working Samples sections list run-able sample code.


General Functions Description
DispatchProc Written by the developer of the SimConnect client, as a callback function to handle all the communications with the server.
SimConnect_AddClientEventToNotificationGroup Used to add an individual client defined event to a notification group.
SimConnect_AddToClientDataDefinition Used to add an offset and a size in bytes, or a type, to a client data definition.
SimConnect_AddToDataDefinition Used to add a Prepar3D simulation variable name to a client defined object definition.
SimConnect_CallDispatch Used to process the next SimConnect message received through the specified callback function.
SimConnect_ChangeVehicle Used to change the user's vehicle.
SimConnect_ChangeVehicleWithExternalSim Used to change the user's vehicle and override the sim to use a specific External Sim instead.
SimConnect_ClearClientDataDefinition Used to clear the definition of the specified client data.
SimConnect_ClearDataDefinition Used to remove all simulation variables from a client defined object.
SimConnect_ClearInputGroup Used to remove all the input events from a specified input group object.
SimConnect_ClearNotificationGroup Used to remove all the client defined events from a notification group.
SimConnect_Close Used to request that the communication with the server is ended.
SimConnect_CreateClientData Used to request the creation of a reserved data area for this client.
SimConnect_FlightLoad Used to load an existing scenario file.
SimConnect_FlightPlanLoad Used to load an existing flight plan.
SimConnect_FlightSave Used to save the current state of a scenario to a scenario file.
SimConnect_GetLastSentPacketID Returns the ID of the last packet sent to the SimConnect server.
SimConnect_GetNextDispatch Used to process the next SimConnect message received, without the use of a callback function.
SimConnect_MapClientDataNameToID Used to associate an ID with a named client date area.
SimConnect_MapClientEventToSimEvent Used to associate a client defined event ID with an Prepar3D event name.
SimConnect_MapInputEventToClientEvent Used to connect input events (such as keystrokes, joystick or mouse movements) with the sending of appropriate event notifications.
SimConnect_Open Used to send a request to the Prepar3D server to open up communications with a new client.
SimConnect_RemoveClientEvent Used to remove a client defined event from a notification group.
SimConnect_RemoveInputEvent Used to remove an input event from a specified input group object.
SimConnect_RequestAttachPointData Used to request attach point positions and orientations from a simulation object.
SimConnect_RequestClientData Used to request that the data in an area created by another client be sent to this client.
SimConnect_RequestDataOnSimObject Used to request when the SimConnect client is to receive data values for a specific object.
SimConnect_RequestDataOnSimObjectType Used to retrieve information about simulation objects of a given type that are within a specified radius of the user's vehicle.
SimConnect_RequestMobileSceneryInRadius Used to retrieve mobile scenery objects that are within a specified radius of the user's vehicle.
SimConnect_RequestMobileSceneryDataByID Used to retrieve data about a specific mobile scenery object using its object ID.
SimConnect_RequestJoystickDeviceInfo Used to request the name and number of currently connected joystick devices.
SimConnect_RequestNotificationGroup Used to request events are transmitted from a notification group, when the simulation is in Dialog Mode.
SimConnect_RequestReservedKey Used to request a specific keyboard TAB-key combination applies only to this client.
SimConnect_RequestSceneryComplexity Used to request the current scenery complexity setting.
SimConnect_RequestSessionDuration Used to request the duration of the current scenario in seconds.
SimConnect_RequestShadowFlags Used to request the current shadow flag settings.
SimConnect_RequestSystemState Used to request information from a number of Prepar3D system components.
SimConnect_RequestTrafficSettings Used to request the current traffic settings.
SimConnect_RequestVersion Used to request license type and version numbers of P3D and SimConnect.
SimConnect_SetClientData Used to write one or more units of data to a client data area.
SimConnect_SetDataOnSimObject Used to make changes to the data properties of an object.
SimConnect_SetInputGroupPriority Used to set the priority for a specified input group object.
SimConnect_SetInputGroupState Used to turn requests for input event information from the server on and off.
SimConnect_SetNotificationGroupPriority Used to set the priority of a notification group.
SimConnect_SetSystemEventState Used to turn requests for event information from the server on and off.
SimConnect_SetSystemState Used to access a number of Prepar3D system components.
SimConnect_SetTrafficSettings Used to set the current traffic settings.
SimConnect_SubscribeToSystemEvent Used to request that a specific system event is notified to the client.
SimConnect_SubscribeToSystemEventEx Used to request that a specific system event is notified to the client. Flags allow you to request a blocking callback.
SimConnect_TransmitClientEvent Used to request that the Prepar3D server transmit to all SimConnect clients the specified client event.
SimConnect_UnsubscribeFromSystemEvent Used to request that notifications are no longer received for the specified system event.
Helper Functions Description
SimConnect_InsertString Used to assist in adding variable length strings to a structure.
SimConnect_RequestResponseTimes Used to provide some data on the performance of the client-server connection
SimConnect_RetrieveString Used to assist in retrieving variable length strings from a structure.
AI Object Specific Functions Description
SimConnect_AICreateEnrouteATCAircraft Used to create an AI controlled aircraft that is about to start or is already underway on its flight plan.
SimConnect_AICreateNonATCAircraft Used to create an aircraft that is not flying under ATC control (so is typically flying under VFR rules).
SimConnect_AICreateParkedATCAircraft Used to create an AI controlled aircraft that is currently parked and does not have a flight plan.
SimConnect_AICreateSimulatedObject Used to create AI controlled objects other than aircraft.
SimConnect_AICreateSimulatedObjectEx Used to create AI controlled objects other than aircraft. Extended for use with disabled simulations and Owned objects
SimConnect_AICreateObjectWithExternalSim Used to create an AI object, overriding the sim to use a specific External Sim instead.
SimConnect_AIReleaseControl Used to clear the AI control of a simulated object, typically an aircraft, in order for it to be controlled by a SimConnect client.
SimConnect_AIReleaseControlEx Used to clear the AI control of a simulated object, typically an aircraft, in order for it to be controlled by a SimConnect client. Extended to be able to remove the AI entirely.
SimConnect_AIRemoveObject Used to remove any object created by the client using one of the SimConnect AI creation functions.
SimConnect_AISetAircraftFlightPlan Used to set or change the flight plan of an AI controlled aircraft.
SimConnect_AISetGroundClamp Used to enable/disable ground clamping on a specific SimConnect owned SimObject.
Camera Specific Functions Description
SimConnect_AddPostProcess Used to add a post process effect to the specified camera.
SimConnect_AddPostProcessMainCamera Used to add a post process effect to the main camera.
SimConnect_CameraPanToView Used to smoothly transition the view of the specified camera to the view of the specified target camera.
SimConnect_CameraSetRelative6DOF Used to adjust the user's aircraft view camera.
SimConnect_CameraSetRelative6DofByName Used to adjust the specified view's camera.
SimConnect_CameraSmoothRelative6DOF Used to smoothly transition the view of the main camera to the specified location.
SimConnect_CameraSmoothRelative6DOFByName Used to smoothly transition the view of the specified camera to the specified location.
SimConnect_CameraZoomIn Used to adjust the zoom of the camera.
SimConnect_CameraZoomOut Used to adjust the zoom of the camera.
SimConnect_ChangeView Used to change the camera used by the main view.
SimConnect_CloseView Used to close a view.
SimConnect_CreateCameraDefinition Used to create a new camera definition.
SimConnect_CreateCameraInstance Used to create a new camera instance from a camera definition.
SimConnect_DeleteCameraInstance Used to remove a camera instance from a camera definition.
SimConnect_DockView Used to dock a view.
SimConnect_MainCameraPanToView Used to smoothly transition the view of the main camera to the view of the specified target camera.
SimConnect_MainCameraZoomIn Used to adjust the zoom of the main camera.
SimConnect_MainCameraZoomOut Used to adjust the zoom of the main camera.
SimConnect_OpenView Used to open a new view.
SimConnect_RemovePostProcess Used to remove a post process effect to the specified camera.
SimConnect_RemovePostProcessMainCamera Used to remove a post process effect to the main camera.
SimConnect_RequestCameraFov Used to request the field-of-view of a given view (horizontal and vertical). See SIMCONNECT_RECV_CAMERA_FOV.
SimConnect_RequestCameraRelative6DOF Used to request the XYZ delta offset from the eyepoint reference point, as well as the pitch, bank, and heading of the main view.
SimConnect_RequestCameraRelative6DofByName Used to request the XYZ delta offset from the eyepoint reference point, as well as the pitch, bank, and heading of a given view.
SimConnect_RequestCameraSensorMode Used to request the current sensor mode of a given view.
SimConnect_RequestCameraWindowPosition Used to request the current window position of a given view.
SimConnect_RequestCameraWindowSize Used to request the current window size of a given view.
SimConnect_RequestMainCameraFov Used to request the field-of-view of the main view (horizontal and vertical). See SIMCONNECT_RECV_CAMERA_FOV.
SimConnect_RequestMainCameraSensorMode Used to request the current sensor mode of the main view.
SimConnect_SendCameraCommand Used to simulate user inputs to control camera movement and rotation.
SimConnect_SetCameraFov Used to change the FoV (Field of View) of a camera.
SimConnect_SetCameraHorizontalFov Used to change the horizontal FoV (Field of View) of a camera.
SimConnect_SetCameraSensorMode Used to change the sensor mode of a camera.
SimConnect_SetCameraVerticalFov Used to change the vertical FoV (Field of View) of a camera.
SimConnect_SetCameraWindowPosition Used to set the window position of the specified view.
SimConnect_SetCameraWindowSize Used to set the window size of the specified view.
SimConnect_SetMainCameraFov Used to change the FoV (Field of View) of the main camera.
SimConnect_SetMainCameraHorizontalFov Used to change the horizontal FoV (Field of View) of the main camera.
SimConnect_SetMainCameraSensorMode Used to change the sensor mode of the main camera.
SimConnect_SetMainCameraVerticalFov Used to change the vertical FoV (Field of View) of the main camera.
SimConnect_UndockView Used to undock a view.
SimConnect_CaptureImage Used to capture an image of a view.
SimConnect_BeginVideoStream Used to begin a video stream of a view.
SimConnect_EndVideoStream Used to end a video stream of a view.
Facilities Data Functions Description
SimConnect_RequestFacilitiesList Used to request a list of all the facilities of a given type currently held in the facilities cache.
SimConnect_SubscribeToFacilities Used to request notifications when a facility of a certain type is added to the facilities cache.
SimConnect_UnsubscribeToFacilities Used to request that notifications of additions to the facilities cache are not longer sent.
Menu Specific Functions Description
SimConnect_MenuAddItem Used to add a menu item, associated with a client event.
SimConnect_MenuAddSubItem Used to add a sub-menu item, associated with a client event.
SimConnect_MenuDeleteItem Used to remove a client defined menu item.
SimConnect_MenuDeleteSubItem Used to remove a specified sub-menu item.
SimConnect_Text Used to display a text menu, message window, or scrolling or static text, on the screen.
Structured Scenario Specific Functions Description
SimConnect_CompleteCustomMissionAction Used to complete the scenario action specified by a GUID.
SimConnect_ExecuteMissionAction Used to execute the scenario action specified by a GUID.
SimConnect_RequestFlightSegmentCount Used to request the number of Flight Segment objects in the active scenario.
SimConnect_RequestFlightSegmentDataByGUID Used to request information about a Flight Segment object in the active scenario.
SimConnect_RequestFlightSegmentDataByIndex Used to request information about a Flight Segment object in the active scenario.
SimConnect_RequestFlightSegmentRangeData Used to request information about a specific range of a Flight Segment object in the active scenario.
SimConnect_RequestGoalCount Used to request the number of Goal/Group Goal objects in the active scenario.
SimConnect_RequestGoalDataByGUID Used to request information about a Goal/Group Goal object in the active scenario.
SimConnect_RequestGoalDataByIndex Used to request information about a Goal/Group Goal object in the active scenario.
SimConnect_RequestMissionObjectiveCount Used to request the number of Mission Objective objects in the active scenario.
SimConnect_RequestMissionObjectiveDataByGUID Used to request information about a Goal/Group Goal object in the active scenario.
SimConnect_RequestMissionObjectiveDataByIndex Used to request information about a Goal/Group Goal object in the active scenario.
SimConnect_ResolveGoal Used to resolve a goal to specified goal state.
SimConnect_RequestChildGoalDataByIndex Used to request information about a mission objective or group goal's children.
SimConnect_GenerateFlightAnalysisDiagrams Used to generate diagrams as shown in the flight analysis UI which can be used, for example, to examine ILS landing performance.
SimConnect_RequestLandingTriggerCount Used to request the number of Area Landing Trigger or Airport Landing Trigger objects in the active scenario.
SimConnect_RequestLandingTriggerLandingInfoCount Used to request information about a Landing Trigger object's landings in the active scenario.
SimConnect_RequestLandingTriggerLandingInfoByIndex Used to request information about a specific landing of a Landing Trigger object in the active scenario.
Weather Specific Functions Description
SimConnect_WeatherCreateStation Used to add a weather station.
SimConnect_WeatherCreateThermal Used to create a thermal at a specific location.
SimConnect_WeatherRemoveStation Used to remove a weather station.
SimConnect_WeatherRemoveThermal Used to remove a thermal.
SimConnect_WeatherRequestCloudState Used to request cloud density information on a given area.
SimConnect_WeatherRequestInterpolatedObservation Used to send a request for weather data that is interpolated from the weather at the nearest weather stations.
SimConnect_WeatherRequestObservationAtNearestStation Used to send a request for the weather data from the weather station nearest to the specified lat/lon position.
SimConnect_WeatherRequestObservationAtStation Used to send a request for the weather data from a weather station identified by its ICAO code.
SimConnect_WeatherSetDynamicUpdateRate Used to set the rate at which cloud formations change.
SimConnect_WeatherSetModeCustom Used to set the weather mode to user-defined.
SimConnect_WeatherSetModeGlobal Used to set the weather mode to global, so the same weather data is used everywhere.
SimConnect_WeatherSetModeServer Deprecated.
SimConnect_WeatherSetModeTheme Used to set the weather mode to a particular theme.
SimConnect_WeatherSetObservation Used to set the weather at a specific weather station, identified from within the Metar data string
Observer View Specific Functions Description
SimConnect_CreateObserver Used to create an observer view.
SimConnect_RequestObserverData Used to request all data for a specific observer.
SimConnect_MoveObserver Used to move an observer using an xyz translation.
SimConnect_RotateObserver Used to rotate an observer around a specified axis.
SimConnect_SetObserverPosition Used to place an observer at a specific world position.
SimConnect_SetObserverRotation Used to set an observer's specific rotation.
SimConnect_SetObserverLookAt Used to have an observer look at a world position.
SimConnect_SetObserverLookAtEx Used to have an observer look at a world position round world corrected.
SimConnect_ObserverTrackLocationOn Used to have an observer track a world position (round world corrected) using an above ground level altitude and accounting for changes in elevation.
SimConnect_ObserverTrackLocationOff Used to disable continuous tracking of the previously specified world position.
SimConnect_SetObserverFieldOfView Used to set an observer's field of view.
SimConnect_SetObserverStepSize Used to set an observer's linear and angular step size.
SimConnect_SetObserverFocalLength Used to set an observer's focal length (in meters).
SimConnect_SetObserverFocusFixed Used to switch an observer's focus between local and world.
SimConnect_SetObserverRegime Used to switch an observer's regime (terrestrial, tellurian, or ghost).
SimConnect_SetObserverZoomLevels Used to set an observer's zoom level.
SimConnect_ObserverTrackEntityOn Used to enable continuous tracking of the specified entity.
SimConnect_ObserverTrackEntityOff Used to disable continuous tracking of the previously specified entity.
SimConnect_ObserverAttachToEntityOn Used to attach an observer to the specified entity.
SimConnect_ObserverAttachToEntityOff Used to detach an observer from its attached entity.
SimConnect_SetObserverSceneryOrigin Used to switch an observer's scenery origin mode (target or self).
Ground Info Specific Functions - Overview Description
SimConnect_RequestGroundInfo Used to request a grid of ground altitudes at a specific lat/lon.
SimConnect_RequestGroundInfoOnSimObject Used to request a recurring grid of ground altitudes based on a SimObjects lat/lon.
Synchronous SimConnect Specific Functions - Overview Description
SimConnect_RequestSynchronousBlock Used to request a blocking callback.
SimConnect_SynchronousUnblock Used to release a blocking callback.
SimConnect_SetSynchronousTimeout Used to set the error timeout length for blocking callbacks.
SimConnect_SubscribeToSystemEventEx Used to request that a specific system event is notified to the client. Flags allow you to request a blocking callback.
External Sim Specific Functions - Overview Description
SimConnect_RegisterExternalSim Used to register this client as an external sim provider.
SimConnect_UnregisterExternalSim Used to unregister this client as an external sim provider.
SimConnect_RegisterExternalSecondarySim Used to register this client as an external secondary sim provider.
SimConnect_UnregisterExternalSecondarySim Used to unregister this client as an external secondarysim provider.
SimConnect_AttachExternalSecondarySimToSimObject Used to attach an External Secondary Sim to an existing SimObject.
SimConnect_DetachExternalSecondarySimFromSimObject Used to detach an External Secondary Sim from an existing SimObject.
SimConnect_AICreateObjectWithExternalSim Used to create an AI object, overriding the sim to use a specific External Sim instead.
SimConnect_ChangeVehicleWithExternalSim Used to change the user's vehicle and override the sim to use a specific External Sim instead.
Attach Sim Specific Functions - Overview Description
SimConnect_AttachObjectToSimObject Used to create a SimObject and attach it to an existing SimObject.
SimConnect_AttachSimObjectToSimObject Used to attach an existing SimObject to another existing SimObject.
SimConnect_ReleaseSimObjectFromSimObject Used to release a SimObject from another SimObject.
Attach Weapon Specific Functions - Overview Description
SimConnect_AttachWeaponToObject Used to create a Weapon and attach it to an existing SimObject.
SimConnect_ClearWeapons Used to remove all Weapons from a SimObject.
Effect Specific Functions Description
SimConnect_CreateEffect Used to create an effect at a location or attach it to an existing SimObject.
SimConnect_RemoveEffect Used to remove an effect.
Recorder Specific Functions Description
SimConnect_PlaybackRecording Used to playback a specified recording from a specified start time to a specified end time.
SimConnect_StartRecorder Used to trigger the Prepar3D Recorder to start recording.
SimConnect_StopRecorderAndSaveRecording Used to trigger the Prepar3D Recorder to stop recording and either prompt the user or save the recording with a specified file name.
SimConnect_RequestRecordingInfo Used to request information on a recording.
SimConnect_RequestBookmarkInfo Used to request bookmark information on a recording.
Deprecated Functions Description
SetCameraRenderSettings Deprecated
SetCameraColorizationMode Deprecated

General Functions

DispatchProc

The DispatchProc function is a written by the developer of the SimConnect client, as a callback function to handle all the communications with the server.


Syntax

void CALLBACK DispatchProc(
  SIMCONNECT_RECV*  pData,
  DWORD  cbData,
  void *  pContext
);

Parameters

pData
[in]  Pointer to a data buffer, to be treated initially as a SIMCONNECT_RECV structure. If you are going to make a copy of the data buffer (which is maintained by the SimConnect client library) make sure that the defined buffer is large enough (the size of the returned data structure is one member of the SIMCONNECT_RECV structure.
cbData
[in]  The size of the data buffer, in bytes.
pContext
[in]  Contains the pointer specified by the client in the SimConnect_CallDispatch function call.

Return Values

This function does not return a value.

Example


void CALLBACK MyDispatchProc(SIMCONNECT_RECV* pData, DWORD cbData)
{
  switch(pData->dwID)
  {
    case SIMCONNECT_RECV_ID_OPEN:
      // enter code to handle SimConnect version information received in a SIMCONNECT_RECV_OPEN structure.
      SIMCONNECT_RECV_OPEN *openData = (SIMCONNECT_RECV_OPEN*) pData;
      break;

    case SIMCONNECT_RECV_ID_EVENT:
      // enter code to handle events received in a SIMCONNECT_RECV_EVENT structure.
      SIMCONNECT_RECV_EVENT *evt = (SIMCONNECT_RECV_EVENT*) pData;
      break;

    case SIMCONNECT_RECV_ID_EVENT_FILENAME:
      // enter code to handle event filenames received in a SIMCONNECT_RECV_EVENT_FILENAME
      // structure.
      SIMCONNECT_RECV_EVENT_FILENAME *evt = (SIMCONNECT_RECV_EVENT_FILENAME*) pData;
      break;

    case SIMCONNECT_RECV_ID_EVENT_OBJECT_ADDREMOVE:
      // enter code to handle AI objects that have been added or removed, and received in a SIMCONNECT_RECV_EVENT_OBJECT_ADDREMOVE
      // structure.
      SIMCONNECT_RECV_EVENT_OBJECT_ADDREMOVE *evt = (SIMCONNECT_RECV_EVENT_OBJECT_ADDREMOVE*) pData;
      break;

    case SIMCONNECT_RECV_ID_EVENT_FRAME:
      // enter code to handle frame data received in a SIMCONNECT_RECV_EVENT_FRAME
      // structure.
      SIMCONNECT_RECV_EVENT_FRAME *evt = (SIMCONNECT_RECV_EVENT_FRAME*) pData;
      break;

    case SIMCONNECT_RECV_ID_SIMOBJECT_DATA:
      // enter code to handle object data received in a SIMCONNECT_RECV_SIMOBJECT_DATA structure.
      SIMCONNECT_RECV_SIMOBJECT_DATA *pObjData = (SIMCONNECT_RECV_SIMOBJECT_DATA*) pData;
      break;

    case SIMCONNECT_RECV_ID_SIMOBJECT_DATA_BYTYPE:
      // enter code to handle object data received in a SIMCONNECT_RECV_SIMOBJECT_DATA_BYTYPE
      // structure.
      SIMCONNECT_RECV_SIMOBJECT_DATA_BYTYPE *pObjData = (SIMCONNECT_RECV_SIMOBJECT_DATA_BYTYPE*) pData;
      break;

    case SIMCONNECT_RECV_ID_QUIT:
      // enter code to handle exiting the application
      break;

    case SIMCONNECT_RECV_ID_EXCEPTION:
      // enter code to handle errors received in a SIMCONNECT_RECV_EXCEPTION structure.
      SIMCONNECT_RECV_EXCEPTION *except = (SIMCONNECT_RECV_EXCEPTION*) pData;
      break;

    case SIMCONNECT_RECV_ID_WEATHER_OBSERVATION:
      // enter code to handle object data received in a SIMCONNECT_RECV_WEATHER_OBSERVATION structure.
      SIMCONNECT_RECV_WEATHER_OBSERVATION* pWxData = (SIMCONNECT_RECV_WEATHER_OBSERVATION*) pData;
      const char* pszMETAR = (const char*) (pWxData+1);
      break;

    // Enter similar case statements to handle the other types of data that can be received, including:
    // SIMCONNECT_RECV_ID_ASSIGNED_OBJECT_ID,
    // SIMCONNECT_RECV_ID_RESERVED_KEY,
    // SIMCONNECT_RECV_ID_CUSTOM_ACTION
    // SIMCONNECT_RECV_ID_SYSTEM_STATE
    // SIMCONNECT_RECV_ID_CLOUD_STATE

    default:
      // enter code to handle the case where an unexpected message is received
      break;
   }
}

Working Samples

Primary samples Client Event
Tracking Errors
Reference samples All but a few of the other samples implement this function.

Remarks

This function can be named appropriately by the client developer. The name of the function is passed to the client-side library with the SimConnect_CallDispatch function call. Handle all the callback events in this function. If you do not wish to implement a callback function use SimConnect_GetNextDispatch.

To receive time based notifications, see the SimConnect_SubscribeToSystemEvent function. To receive event based notifications see the SimConnect_AddClientEventToNotificationGroup function. To send an event to be received by other clients, see the SimConnect_TransmitClientEvent function.

See Also


SimConnect_AddClientEventToNotificationGroup

The SimConnect_AddClientEventToNotificationGroup function is used to add an individual client defined event to a notification group.

Syntax

HRESULT SimConnect_AddClientEventToNotificationGroup(
  HANDLE  hSimConnect,
  SIMCONNECT_NOTIFICATION_GROUP_ID  GroupID,
  SIMCONNECT_CLIENT_EVENT_ID  EventID,
  BOOL  bMaskable = FALSE
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
GroupID
[in]  Specifies the ID of theclient defined group.
EventID
[in]  Specifies the ID of theclient defined event.
bMaskable
[in, optional]  Boolean, True indicates that the event will be masked by this client and will not be transmitted to any more clients, possibly including Prepar3D itself (if the priority of the client exceeds that of Prepar3D). False is the default. See the explanation of SimConnect Priorities.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Example

static enum EVENT_ID {
  EVENT_1,
  EVENT_2
  EVENT_3
};
static enum GROUP_ID {
  GROUP_1,
};
hr = SimConnect_AddClientEventToNotificationGroup(hSimConnect, GROUP_1, EVENT_1);
hr = SimConnect_AddClientEventToNotificationGroup(hSimConnect, GROUP_1, EVENT_2);
hr = SimConnect_AddClientEventToNotificationGroup(hSimConnect, GROUP_1, EVENT_3, TRUE);
hr = SimConnect_SetNotificationGroupPriority(hSimConnect, GROUP_1, SIMCONNECT_GROUP_PRIORITY_HIGHEST);

Working Samples

Primary samples Client Event
Cockpit Camera
Joystick Input
Menu Items
Send Event A
Send Event B
Send Event C
Tracking Errors
Reference samples Many of the other samples implement this function.

Remarks

The maximum number of events that can be added to a notification group is 1000. A notification group is simply a convenient way of  setting the appropriate priority for a range of events, and all client events (such as EVENT_1, EVENT_2, EVENT_3 in the example above) must be assigned to a notification group before any event notifications will be received from the SimConnect server.

See Also


SimConnect_AddToClientDataDefinition

The SimConnect_AddToClientDataDefinition function is used to add an offset and a size in bytes, or a type, to a client data definition.

Syntax

HRESULT SimConnect_AddToClientDataDefinition(
  HANDLE  hSimConnect,
  SIMCONNECT_CLIENT_DATA_DEFINITION_ID  DefineID,
  DWORD  dwOffset,
  DWORD  dwSizeOrType,
  float  fEpsilon = 0,
  DWORD  DatumID = SIMCONNECT_UNUSED
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
DefineID
[in] Specifies the ID of the client-defined client data definition.
dwOffset
[in]  Double word containing the offset into the client area, where the new addition is to start. Set this to SIMCONNECT_CLIENTDATAOFFSET_AUTO for the offsets to be calculated by the SimConnect server.
dwSizeOrType
[in]  Double word containing either the size of the client data in bytes, or one of the following defined values (note that these definitions have a negative value, all positive values will be treated as a size parameter.
Constant Value
SIMCONNECT_CLIENTDATATYPE_INT8 -1
SIMCONNECT_CLIENTDATATYPE_INT16 -2
SIMCONNECT_CLIENTDATATYPE_INT32 -3
SIMCONNECT_CLIENTDATATYPE_INT64 -4
SIMCONNECT_CLIENTDATATYPE_FLOAT32 -5
SIMCONNECT_CLIENTDATATYPE_FLOAT64 -6
fEpsilon
[in, optional]  If data is requested only when it changes (see the flags parameter of SimConnect_RequestClientData), a change will only be reported if it is greater than the value of this parameter (not greater than or equal to). The default is zero, so even the tiniest change will initiate the transmission of data. Set this value appropriately so insignificant changes are not transmitted. This can be used with integer data, the floating point fEpsilon value is first truncated to its integer component before the comparison is made (for example, an fEpsilon value of 2.9 truncates to 2, so a data change of 2 will not trigger a transmission, and a change of 3 will do so). This parameter only applies if one of the six constant values listed above has been set in the dwSizeOrType parameter, if a size has been specified SimConnect has no record of the type of data being sent, so cannot do a meaningful comparison of values.
DatumID
[in, optional]  Specifies a client defined datum ID. The default is zero. Use this to identify the data received if the data is being returned in tagged format (see the flags parameter of SimConnect_RequestClientData). There is no need to specify datum IDs if the data is not being returned in tagged format.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

This function must be called before a client data area can be written to or read from. Typically this function would be called once for each variable that is going to be read or written. Note that an error will not be given if the size of a data definition exceeds the size of the client area -- this is to allow for the case where definitions are specified by one client before the relevant client area is created by another.

The most efficient use of client data areas is to group data that changes at the same time into the same data area. Minor performance improvements are gained by not using tagged data, or the fEpsilon parameter, if they are not needed.

See Also


SimConnect_AddToDataDefinition

The SimConnect_AddToDataDefinition function is used to add a Prepar3D simulation variable name to a client defined object definition.

Syntax

HRESULT SimConnect_AddToDataDefinition(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_DEFINITION_ID  DefineID,
  const char*  DatumName,
  const char*  UnitsName,
  SIMCONNECT_DATATYPE  DatumType = SIMCONNECT_DATATYPE_FLOAT64,
  float  fEpsilon = 0,
  DWORD  DatumID = SIMCONNECT_UNUSED
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
DefineID
[in]  Specifies the ID of the client defined data definition.
DatumName
[in]  Specifies the name of the Prepar3D simulation variable. See the Simulation Variables document for a table of variable names. If an index is required then it should be appended to the variable name following a colon, see the example for DEFINITION_2 below. Indexes are numbered from 1 (not zero). Simulation variable names are not case-sensitive (so can be entered in upper or lower case).
UnitsName
[in]  Specifies the units of the variable. See the Simulation Variables document for a table of acceptable unit names. It is possible to specify different units to receive the data in, from those specified in the Simulation Variables document. See DEFINITION_2 below for an example. The alternative units must come under the same heading (such as Angular Velocity, or Volume, as specified in the Units of Measurement section of the Simulation Variables document). For strings and structures enter "NULL" for this parameter.
DatumType
[in, optional]  One member of the SIMCONNECT_DATATYPE enumeration type. This parameter is used to determine what datatype should be used to return the data. The default is SIMCONNECT_DATATYPE_FLOAT64. Note that the structure data types are legitimate parameters here.
fEpsilon
[in, optional]  If data is requested only when it changes (see the flags parameter of SimConnect_RequestDataOnSimObject), a change will only be reported if it is greater than the value of this parameter (not greater than or equal to). The default is zero, so even the tiniest change will initiate the transmission of data. Set this value appropriately so insignificant changes are not transmitted. This can be used with integer data, the floating point fEpsilon value is first truncated to its integer component before the comparison is made (for example, an fEpsilon value of 2.9 truncates to 2, so a data change of 2 will not trigger a transmission, and a change of 3 will do so).
DatumID
[in, optional]  Specifies a client defined datum ID. The default is zero. Use this to identify the data received if the data is being returned in tagged format (see the flags parameter of SimConnect_RequestDataOnSimObject). There is no need to specify datum IDs if the data is not being returned in tagged format.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Example


static enum DATA_DEFINE_ID {
  DEFINITION_1,
  DEFINITION_2
};

static enum DATA_REQUEST_ID {
    REQUEST_1,
    REQUEST_2,
};

struct Struct1
{
    double  kohlsmann;
    double  altitude;
    double  latitude;
    double  longitude;
};

// Match string definitions from the Simulation Variables document with the client defined ID

hr = SimConnect_AddToDataDefinition(hSimConnect, DEFINITION_1, "Kohlsman setting hg", "inHg");
hr = SimConnect_AddToDataDefinition(hSimConnect, DEFINITION_1, "Indicated Altitude", "feet");
hr = SimConnect_AddToDataDefinition(hSimConnect, DEFINITION_1, "Plane Latitude", "degrees");
hr = SimConnect_AddToDataDefinition(hSimConnect, DEFINITION_1, "Plane Longitude", "degrees");

hr = SimConnect_AddToDataDefinition(hSimConnect, DEFINITION_2, "GENERAL ENG RPM:1", "rpm");
hr = SimConnect_AddToDataDefinition(hSimConnect, DEFINITION_2, "
GENERAL ENG RPM:2", "revolutions per minute");
hr = SimConnect_AddToDataDefinition(hSimConnect, DEFINITION_2, "
GENERAL ENG RPM:3", "degrees per second");
hr = SimConnect_AddToDataDefinition(hSimConnect, DEFINITION_2, "
GENERAL ENG RPM:4", "minutes per round");

// Sections of code in DispatchProc

// At the right point request the data
// In this example the data is being requested on the user aircraft
....
hr = SimConnect_RequestDataOnSimObject(hSimConnect, REQUEST_1, DEFINITION_1,SIMCONNECT_OBJECT_ID_USER, SIMCONNECT_PERIOD_ONCE);

....
// When the data is received -- cast it to the correct structure type

case SIMCONNECT_RECV_ID_SIMOBJECT_DATA:
{
  SIMCONNECT_RECV_SIMOBJECT_DATA *pObjData = (SIMCONNECT_RECV_SIMOBJECT_DATA*)pData;

  switch(pObjData->dwRequestID)
  {
    case REQUEST_1:

      Struct1 *pS = (Struct1*)&pObjData->dwData;
   
      // Add code to process the structure appropriately

      break;
  }
break;
}
....

Working Samples

Primary samples Request Data
Set Data
Tagged Data
Throttle Control

Remarks

The maximum number of entries in a data definition is 1000.

See Also


SimConnect_CallDispatch

The SimConnect_CallDispatch function is used to process the next SimConnect message received, through the specified callback function.

Syntax

HRESULT SimConnect_CallDispatch(
  HANDLE  hSimConnect,
  DispatchProc  pfcnDispatch,
  void *  pContext
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
pfcnDispatch
[in]  Specifies the callback function. For a definition of the function see DispatchProc.
pContext
[in]  Specifies a pointer that the client can define that will be returned in the callback. This is used in particular by managed code clients to pass a this pointer to the callback.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Example

int quit = 0;
....
//
while( quit == 0 )
{
  hr = SimConnect_CallDispatch(hSimConnect, MyDispatchProc, NULL);
};

Working Samples

Primary samples Client Event
Tracking Errors
Reference samples All but a few of the other samples implement this function.

Remarks

It is important to call this function sufficiently frequently that the queue of information received from the server is processed (typically it is coded within a while loop that terminates when the application is exited). However, if the project involves developing a library (DLL) rather than an application (EXE) then only one call to this function is necessary. This call will store the name of the callback in a cache, and whenever a packet is sent to the client, the callback function will be run. The format of a DLL project is shown in the following table:

// Include files are no different than for an EXE

HANDLE hSimConnect = NULL;

void CALLBACK MyDispatchProcDLL(SIMCONNECT_RECV* pData, DWORD cbData, void *pContext)
{
  // Callback code for a DLL is no different than for an EXE
}

//
// The DLLStart function must be present.
//
int __stdcall DLLStart(void)
{
  HRESULT hr;
  if (SUCCEEDED(SimConnect_Open(&hSimConnect, "DLL name", NULL, 0, NULL, 0)))
  {
    printf("\nConnected...");

    // Place all initialization code for the client in this function

    hr = SimConnect_CallDispatch(hSimConnect, MyDispatchProcDLL, NULL);
  }
  return 0;
}

//
// The DLLStop function must be present.
//
void __stdcall DLLStop(void)
{
  // Close the client
  if (hSimConnect != NULL)
    HRESULT hr = SimConnect_Close(hSimConnect);
}

In order to implement SimConnect as a class, and maintain an object-oriented design of an add-on, the following constructs can be used. Note in particular the static function and the use of the pContext parameter.

Class CName
{
    void Dispatch();
    static void DispatchCallback(SIMCONNECT_RECV *pData, DWORD cbData, void *pContext);
    void Process(SIMCONNECT_RECV *pData, DWORD cbData);

    HANDLE hSimConnect; // use SimConnect_Open to set this value.
};

void CName::Dispatch()
{
    ::SimConnect_Dispatch(hSimConnect, &CName::DispatchCallback, this);
}

// static function
void CName::DispatchCallback(SIMCONNECT_RECV *pData, DWORD cbData, void *pContext)
{
    CName *pThis = reinterpret_cast<CName*>(pContext);
    pThis->Process(pData, cbData);
}

void CName::Process(SIMCONNECT_RECV *pData, DWORD cbData)
{
    // do processing of SimConnect data
}

See Also


SimConnect_ChangeVehicle

The SimConnect_ChangeVehicle function is used to change the selected vehicle.

Syntax

HRESULT SimConnect_ChangeVehicle(
  HANDLE  hSimConnect,
  const char*  Vehicletitle
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
Vehicletitle
[in]  title of the desired vehicle

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Samples

Primary samples Change Vehicle
Managed Change Vehicle

Remarks

The instant replay does not get reset on the vehicle change which is the normal behavior when changing the vehicle in Prepar3D.

See Also

None.


SimConnect_ClearClientDataDefinition

The SimConnect_ClearClientDataDefinition function is used to clear the definition of the specified client data.

Syntax

HRESULT SimConnect_ClearClientDataDefinition(
  HANDLE  hSimConnect,
  SIMCONNECT_CLIENT_DATA_DEFINITION_ID  DefineID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
DefineID
[in]  Specifies the ID of the client defined client data definition.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

None.

See Also


SimConnect_ClearDataDefinition

The SimConnect_ClearDataDefinition function is used to remove all simulation variables from a client defined data definition.

Syntax

HRESULT SimConnect_ClearDataDefinition(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_DEFINITION_ID  DefineID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
DefineID
[in]  Specifies the ID of the client defined data definition.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Example

static enum DATA_DEFINE_ID {
  DEFINITION_1,
  DEFINITION_2
};
....

// Match string definitions from the Simulation Variables document with the client defined ID

hr = SimConnect_AddToDataDefinition(hSimConnect, DEFINITION_1, "Kohlsman setting hg", "inHg");
hr = SimConnect_AddToDataDefinition(hSimConnect, DEFINITION_1, "Indicated Altitude", "feet");
hr = SimConnect_AddToDataDefinition(hSimConnect, DEFINITION_1, "Plane Latitude", "degrees");
hr = SimConnect_AddToDataDefinition(hSimConnect, DEFINITION_1, "Plane Longitude", "degrees");
....
hr = SimConnect_ClearDataDefinition(hSimConnect, DEFINITION_1);
....

Remarks


Use this function to permanently delete a data definition. To temporarily suspend data requests see the remarks for the SimConnect_RequestDataOnSimObject function.

See Also


SimConnect_ClearInputGroup

The SimConnect_ClearInputGroup function is used to remove all the input events from a specified input group object.

Syntax

HRESULT SimConnect_ClearInputGroup(
  HANDLE   hSimConnect
  SIMCONNECT_INPUT_GROUP_ID  GroupID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
GroupID
[in]  Specifies the ID of the client defined input group that is to have all its events removed.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Example

static enum INPUT_ID {
  INPUT_1,
};
static enum EVENT_ID {
  EVENT_1,
};
hr = SimConnect_MapClientEventToSimEvent(hSimConnect, EVENT_1, "parking_brakes");
hr = SimConnect_MapInputEventToClientEvent(hSimConnect, INPUT_1, "a+B", EVENT_1);
....
hr = SimConnect_ClearInputGroup(hSimConnect, INPUT_1);

Remarks

Use this function to permanently delete an input group. Use the SimConnect_SetInputGroupState function to temporarily suspend input group notifications.

See Also


SimConnect_ClearNotificationGroup

The SimConnect_ClearNotificationGroup function is used to remove all the client defined events from a notification group.

Syntax

HRESULT SimConnect_ClearNotificationGroup(
  HANDLE  hSimConnect,
  SIMCONNECT_NOTIFICATION_GROUP_ID  GroupID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
GroupID
[in]  Specifies the ID of the client defined group that is to have all its events removed.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Example

static enum EVENT_ID {
  EVENT_1,
  EVENT_2
  EVENT_3
};
static enum GROUP_ID {
  GROUP_1,
};
hr = SimConnect_AddClientEventToNotificationGroup(hSimConnect, GROUP_1, EVENT_1);
hr = SimConnect_AddClientEventToNotificationGroup(hSimConnect, GROUP_1, EVENT_2);
hr = SimConnect_AddClientEventToNotificationGroup(hSimConnect, GROUP_1, EVENT_3, TRUE);

hr = SimConnect_ClearNotificationGroup(hSimConnect, GROUP_1);

Remarks

There is a maximum of 20 notification groups in any SimConnect client. Use this function if the maximum has been reached, but one or more are not longer required.

See Also


SimConnect_Close

The SimConnect_Close function is used to request that the communication with the server is ended.

Syntax

HRESULT SimConnect_Close(
  HANDLE  hSimConnect
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Example

hr = SimConnect_Close(hSimConnect);

Working Samples

Primary samples Open and Close
Windows Event
Reference samples All of the other samples implement this function.

Remarks

When a SimConnect client is closed, the server will remove all objects, menu items, group definitions and so on, defined or requested by that client, so there is no need to remove them explicitly in the client code.

See Also


SimConnect_CreateClientData

The SimConnect_CreateClientData function is used to request the creation of a reserved data area for this client.

Syntax

HRESULT SimConnect_CreateClientData(
  HANDLE  hSimConnect,
  SIMCONNECT_CLIENT_DATA_ID  ClientDataID,
  DWORD  dwSize,
  SIMCONNECT_CREATE_CLIENT_DATA_FLAG  Flags
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
ClientDataID
[in]  ID of the client data area. Before calling this function, call SimConnect_MapClientDataNameToID to map an ID to a unique client area name.
dwSize
[in]  Double word containing the size of the data area in bytes.
Flags
[in]  Specify the flag SIMCONNECT_CREATE_CLIENT_DATA_FLAG_READ_ONLY if the data area can only be written to by this client (the client creating the data area). By default other clients can write to this data area.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

Use this function, along with the other client data functions, to reserve an area of memory for client data on the server, that other clients can have read (or read and write) access to. Specify the contents of the data area with the SimConnect_AddToClientDataDefinition call, and set the actual values with a call to SimConnect_SetClientData. Other clients can receive the data with a call to SimConnect_RequestClientData.

The maximum size of a client data area is set by the constant SIMCONNECT_CLIENTDATA_MAX_SIZE. For the RTM version of Prepar3D this is 8K. There is no maximum number of client data areas, but the total must not exceed 1Mbyte for the RTM version. If a request is made for a client data area greater than SIMCONNECT_CLIENTDATA_MAX_SIZE a SIMCONNECT_EXCEPTION_INVALID_DATA_SIZE exception is returned. If a request is made for a client data area that will exceed the total maximum memory a SIMCONNECT_EXCEPTION_OUT_OF_BOUNDS exception is returned.

One client area can be referenced by any number of client data definitions. Typically the name of the client area, and the data definitions, should be published appropriately so other clients can be written to use them. Care should be taken to give the area a unique name.

Once created, a client data area cannot be deleted or reduced in size. To increase the size of the data area, first close the connection, then re-open it and request the client data area again, using the same name, but with the required size. The additional data area will be initialized to zero, but the previous data will be untouched by this process. Client data persists to the end of the Prepar3D session, and is not removed when the client that created it is closed. It is also possible to change a read-only data area to write-able using this technique.

See Also


SimConnect_FlightLoad

The SimConnect_FlightLoad function is used to load an existing scenario file.

Syntax

HRESULT SimConnect_FlightLoad(
  HANDLE  hSimConnect,
  const char*  szFileName
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szFileName
[in]  Null-terminated string containing the path to the scenario file. The path can either be absolute, or relative to the %USERPROFILE%\Documents\Prepar3D v3 Files folder. Scenario files have the extension .FXML. The extension is not required for .FXML files. To load deprecated .FLT files, the .FLT extension must be specified.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

Scenario files can be opened using a text editor.

See Also


SimConnect_FlightPlanLoad

The SimConnect_FlightPlanLoad function is used to load an existing flight plan file.

Syntax

HRESULT SimConnect_FlightPlanLoad(
  HANDLE  hSimConnect,
  const char*  szFileName
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szFileName
[in]  Null-terminated string containing the path to the flight plan file. Flight plans have the extension .PLN, but no need to enter an extension here. There is no need to enter the full path to the file (just enter the filename) if the scenario file is in the default Prepar3D v3 Files directory. The easiest way to create flight plans is to create them from within Prepar3D itself, and then save them off for use by the user or AI controlled aircraft.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

Flight plan files can be opened using a text editor.

See Also


SimConnect_FlightSave

The SimConnect_FlightSave function is used to save the current state of a scenario to a scenario file.

Syntax

HRESULT SimConnect_FlightSave(
  HANDLE  hSimConnect,
  const char*  szFileName,
  const char*  sztitle,
  const char*  szDescription,
  DWORD  Flags
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szFileName
[in]  Null-terminated string containing the path to the scenario file. The path can either be absolute, or relative to the %USERPROFILE%\Documents\Prepar3D v3 Files folder. Scenario files have the extension .FXML. If the extension is not specified, it will still save as an .FXML. If the deprecated .FLT extension is specified, it will be overwritten as an .FXML. It is not possible to save deprecated .FLT files.
sztitle
[in]  Null-terminated string containing the title of the scenario file. If this is NULL then the szFileName parameter is used as the title.
szDescription
[in]  Null-terminated string containing the text to enter in the Description field of the scenario file.
Flags
[in]  Unused.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

Scenario files can be opened using a text editor.

See Also


SimConnect_GetLastSentPacketID

The SimConnect_GetLastSentPacketID function returns the ID of the last packet sent to the SimConnect server.

Syntax

HRESULT SimConnect_GetLastSentPacketID(
  HANDLE  hSimConnect,
  DWORD*  pdwSendID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
pdwSendID
[out]  Pointer to a double word containing the ID of the last sent packet.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Example


DWORD dwLastID;

hr = SimConnect_MapClientEventToSimEvent(hSimConnect, EVENT_MY_EVENT, "Custom.Event");
hr = SimConnect_TransmitClientEvent(hSimConnect, 0, EVENT_MY_EVENT, 0, SIMCONNECT_GROUP_PRIORITY_HIGHEST, 0);
// Get the Send ID of the last transmission to the server
hr = SimConnect_GetLastSentPacketID(hSimConnect, &dwLastID);

Working Sample

Primary sample Tracking Errors

Remarks

This function should be used in conjunction with returned structures of type SIMCONNECT_RECV_EXCEPTION to help pinpoint errors (exceptions) returned by the server. This is done by matching the send ID returned with the exception, with the number returned by this function and stored appropriately. This function is primarily intended to be used while debugging and testing the client application, rather than in a final retail build.

See Also


SimConnect_GetNextDispatch

The SimConnect_GetNextDispatch function is used to process the next SimConnect message received, without the use of a callback function.

Syntax

HRESULT SimConnect_GetNextDispatch(
  HANDLE  hSimConnect,
  SIMCONNECT_RECV**  ppData,
  DWORD*  pcbData
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
ppData
[in]  Pointer to a pointer to a data buffer, initially to be treated as a SIMCONNECT_RECV structure. If you are going to make a copy of the data buffer (which is maintained by the SimConnect client library) make sure that the defined buffer is large enough (the size of the returned data structure is one member of the SIMCONNECT_RECV structure.
pcbData
[in]  Pointer to the size of the data buffer, in bytes. 

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Example

SIMCONNECT_RECV* pData;
DWORD cbData;

hr = SimConnect_GetNextDispatch(hSimConnect, &pData, &cbData);
if (SUCCEEDED(hr))
{
  switch(pData->dwID)
  {
    case SIMCONNECT_RECV_ID_OPEN:
      // enter code to handle SimConnect version information received in a SIMCONNECT_RECV_OPEN structure.
      SIMCONNECT_RECV_OPEN *openData = (SIMCONNECT_RECV_OPEN*) pData;
      break;

    case SIMCONNECT_RECV_ID_EVENT:
      // enter code to handle events received in a SIMCONNECT_RECV_EVENT> structure.
      SIMCONNECT_RECV_EVENT *evt = (SIMCONNECT_RECV_EVENT*) pData;
      break;

    case SIMCONNECT_RECV_ID_EVENT_FILENAME:
      // enter code to handle event filenames received in a SIMCONNECT_RECV_EVENT_FILENAME
      // structure.
      SIMCONNECT_RECV_EVENT_FILENAME *evt = (SIMCONNECT_RECV_EVENT_FILENAME*) pData;
      break;

    case SIMCONNECT_RECV_ID_EVENT_OBJECT_ADDREMOVE:
      // enter code to handle AI objects that have been added or removed, and received in a SIMCONNECT_RECV_EVENT_OBJECT_ADDREMOVE
      // structure.
      SIMCONNECT_RECV_EVENT_OBJECT_ADDREMOVE *evt = (SIMCONNECT_RECV_EVENT_OBJECT_ADDREMOVE*) pData;
      break;

    case SIMCONNECT_RECV_ID_EVENT_FRAME:
      // enter code to handle frame data received in a SIMCONNECT_RECV_EVENT_FRAME
      // structure.
      SIMCONNECT_RECV_EVENT_FRAME *evt = (SIMCONNECT_RECV_EVENT_FRAME*) pData;
      break;

    case SIMCONNECT_RECV_ID_SIMOBJECT_DATA:
      // enter code to handle object data received in a SIMCONNECT_RECV_SIMOBJECT_DATA structure.
      SIMCONNECT_RECV_SIMOBJECT_DATA *pObjData = (SIMCONNECT_RECV_SIMOBJECT_DATA*) pData;
      break;

    case SIMCONNECT_RECV_ID_SIMOBJECT_DATA_BYTYPE:
      // enter code to handle object data received in a SIMCONNECT_RECV_SIMOBJECT_DATA_BYTYPE
      // structure.
      SIMCONNECT_RECV_SIMOBJECT_DATA_BYTYPE *pObjData = (SIMCONNECT_RECV_SIMOBJECT_DATA_BYTYPE*) pData;
      break;

    case SIMCONNECT_RECV_ID_QUIT:
      // enter code to handle exiting the application
      break;

    case SIMCONNECT_RECV_ID_EXCEPTION:
      // enter code to handle errors received in a SIMCONNECT_RECV_EXCEPTION structure.
      SIMCONNECT_RECV_EXCEPTION *except = (SIMCONNECT_RECV_EXCEPTION*) pData;
      break;

    case SIMCONNECT_RECV_ID_WEATHER_OBSERVATION:
      // enter code to handle object data received in a SIMCONNECT_RECV_WEATHER_OBSERVATION structure.
      SIMCONNECT_RECV_WEATHER_OBSERVATION* pWxData = (SIMCONNECT_RECV_WEATHER_OBSERVATION*) pData;
      const char* pszMETAR = (const char*) (pWxData+1);
      break;

    // Enter similar case statements to handle the other types of data that can be received, including:
    // SIMCONNECT_RECV_ID_ASSIGNED_OBJECT_ID,
    // SIMCONNECT_RECV_ID_RESERVED_KEY,
    // SIMCONNECT_RECV_ID_CUSTOM_ACTION
    // SIMCONNECT_RECV_ID_SYSTEM_STATE
    // SIMCONNECT_RECV_ID_CLOUD_STATE

    default:
      // enter code to handle the case where an unexpected message is received
      break;
   }
}

Working Sample

Primary sample No Callback  

Remarks

It is important to call this function sufficiently frequently that the queue of information received from the server is processed. If there are no messages in the queue, the dwID parameter will be set to SIMCONNECT_RECV_ID_NULL.

See Also


SimConnect_MapClientDataNameToID

The SimConnect_MapClientDataNameToID function is used to associate an ID with a named client data area.

Syntax

HRESULT SimConnect_MapClientDataNameToID(
  HANDLE  hSimConnect,
  const char*  szClientDataName,
  SIMCONNECT_CLIENT_DATA_ID  ClientDataID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szClientDataName
[in]  Null-terminated string containing the client data area name. This is the name that another client will use to specify the data area. The name is not case-sensitive. If the name requested is already in use by another add-on, a SIMCONNECT_EXCEPTION_ALREADY_CREATED error will be returned.
ClientDataID
[in] A unique ID for the client data area, specified by the client. If the ID number is already in use, the SIMCONNECT_EXCEPTION_DUPLICATE_ID error will be returned.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

This function should be called once for each client data area: the client setting up the data should call it just before a call to SimConnect_CreateClientData, and the clients requesting the data should call it before any calls to SimConnect_RequestClientData are made. The name given to a client data area must be unique, however by mapping an ID number to the name, calls to the functions to set and request the data are made more efficient.

See Also


SimConnect_MapClientEventToSimEvent

The SimConnect_MapClientEventToSimEvent function associates a client defined event ID with a Prepar3D event name.

Syntax

HRESULT SimConnect_MapClientEventToSimEvent(
  HANDLE  hSimConnect,
  SIMCONNECT_CLIENT_EVENT_ID  EventID,
  const char*  EventName
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
EventID
[in]  Specifies the ID of the client event.
EventName
[in]  Specifies the Prepar3D event name. Refer to the Event IDs document for a list of event names (listed under String Name). If the event name includes one or more periods (such as "Custom.Event" in the example below) then they are custom events specified by the client, and will only be recognized by another client (and not Prepar3D) that has been coded to receive such events. No Prepar3D events include periods. If no entry is made for this parameter, the event is private to the client.

Alternatively enter a decimal number in the format "#nnnn" or a hex number in the format "#0xnnnn", where these numbers are in the range THIRD_PARTY_EVENT_ID_MIN and THIRD_PARTY_EVENT_ID_MAX, in order to receive events from third-party add-ons to Prepar3D.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Example


static enum EVENT_ID {
  EVENT_PAUSE,
  EVENT_BRAKES,
  EVENT_CUSTOM,
  EVENT_PRIVATE,
};

// Attach the client event EVENT_BRAKES to the simulation event "brakes"
hr = SimConnect_MapClientEventToSimEvent(hSimConnect, EVENT_BRAKES, "brakes");

// Attach the client event EVENT_PAUSE to the simulation event "pause_toggle"
hr = SimConnect_MapClientEventToSimEvent(hSimConnect, EVENT_PAUSE, "pause_toggle");

// Create a custom event, for use when communicating with other clients
hr = SimConnect_MapClientEventToSimEvent(hSimConnect, EVENT_CUSTOM, "Custom.Event");

// Create a private event for use within this client only
hr = SimConnect_MapClientEventToSimEvent(hSimConnect, EVENT_PRIVATE);

Working Samples

Primary samples Client Event
Cockpit Camera
Joystick Input
Reserved Key
Send Event A
Send Event B
Send Event C
Set Data
Throttle Control
Tracking Errors
Reference samples All but a few of the other samples implement this function.

Remarks

Client events, such as EVENT_BRAKES, must be added to a group event (to set the appropriate priority) before event notifications will be received from the SimConnect server (see the SimConnect_AddClientEventToNotificationGroup function).

See Also


SimConnect_MapInputEventToClientEvent

The SimConnect_MapInputEventToClientEvent function is used to connect input events (such as keystrokes, joystick or mouse movements) with the sending of appropriate event notifications.


Syntax

HRESULT SimConnect_MapInputEventToClientEvent(
  HANDLE  hSimConnect,
  SIMCONNECT_INPUT_GROUP_ID  GroupID,
  const char*  pszInputDefinition,
  SIMCONNECT_CLIENT_EVENT_ID  DownEventID,
  DWORD  DownValue = 0,
  SIMCONNECT_CLIENT_EVENT_ID  UpEventID =(SIMCONNECT_CLIENT_EVENT_ID)SIMCONNECT_UNUSED,
  DWORD  UpValue = 0,
  BOOL  bMaskable = FALSE
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
GroupID
[in]  Specifies the ID of the client defined input group that the input event is to be added to.
pszInputDefinition
[in]  Pointer to a null-terminated string containing the definition of the input events (keyboard keys, mouse or joystick events, for example). See the Remarks and example below for a range of possibilities. 
DownEventID
[in]  Specifies the ID of the down, and default, event. This is the client defined event that is triggered when the input event occurs. If only an up event is required, set this to SIMCONNECT_UNUSED.
DownValue
[in, optional] Specifies an optional numeric value, which will be returned when the down event occurs. This value is only acknowledged for keyboard and button events.
UpEventID
[in, optional]  Specifies the ID of the up event. This is the client defined event that is triggered when the up action occurs.
UpValue
[in, optional]  Specifies an optional numeric value, which will be returned when the up event occurs. This value is only acknowledged for keyboard and button events.
bMaskable
[in, optional]  If set to true, specifies that the client will mask the event, and no other lower priority clients will receive it. The default is false.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Example



static enum INPUT_ID {
      INPUT_1,
};

static enum EVENT_ID {
     EVENT_1,
     EVENT_2,
     EVENT_3  
};

hr = SimConnect_MapClientEventToSimEvent(hSimConnect, EVENT_1, "parking_brakes");
// Set similar mappings for EVENT_2 and EVENT_3

// Lower case a and upper case B are hit together
hr = SimConnect_MapInputEventToClientEvent(hSimConnect, INPUT_1, "a+B", EVENT_1);

// Ctrl, upper case A and upper case U are hit together
hr = SimConnect_MapInputEventToClientEvent(hSimConnect, INPUT_1, "Ctrl+A+U", EVENT_1);

// Ctrl, shift, lower case a, has been hit
hr = SimConnect_MapInputEventToClientEvent(hSimConnect, INPUT_1, "shift+ctrl+a", EVENT_2);

// Ctrl, shift, lower case a, will trigger an EVENT_2 when it is pressed, and an EVENT_3 when released
hr = SimConnect_MapInputEventToClientEvent(hSimConnect, INPUT_1, "shift+ctrl+a", EVENT_2, 0, EVENT_3);

// The first configured button of joystick 0 is hit
hr = SimConnect_MapInputEventToClientEvent(hSimConnect, INPUT_1, "joystick:0:button:0", EVENT_2);

// The second configured button of joystick 0 is hit
hr = SimConnect_MapInputEventToClientEvent(hSimConnect, INPUT_1, "joystick:0:button:1", EVENT_3);

// The first configured joystick has had its first configured point of view (or hat) switch pressed
hr = SimConnect_MapInputEventToClientEvent(hSimConnect, INPUT_1, "joystick:0:POV:0", EVENT_3);

// The first configured joystick has been moved along the x axis
hr = SimConnect_MapInputEventToClientEvent(hSimConnect, INPUT_1, "joystick:0:XAxis", EVENT_3);


hr = SimConnect_SetInputGroupPriority(hSimConnect, INPUT_1, SIMCONNECT_GROUP_PRIORITY_HIGHEST);

Working Samples

Primary samples Cockpit Camera
Input Event
Joystick Input
Throttle Control
Reference samples Set Data

Remarks

The maximum number of events that can be added to an input group is 1000.

For the keyboard the input definition can include a maximum of two modifiers (Shift, Ctrl, Alt) and two keys (case sensitive).

For joysticks the input definition is in the form "joystick:n:input[:i]". Where n is the joystick number (starting from 0), input is the input name, and i is an optional index number that might be required by the input name (joystick:0:button:0 for example). The joystick number can be retrieved through the SimConnect_RequestJoystickDeviceInfo function. The input name can be one in the following table:

Input Name Description Range of values
Button One of the joystick buttons, configured from 0. 0 = up state, 1 = down state
POV Point of view switch (often called the hat switch). 0 facing ahead
4500 forward right
9000 right
13500 rear right
18000 rear
22500 rear left
27000 left
31500 forward left
Slider The variable position slider on the joystick. The actual values returned can vary widely on the joystick, though the limits are 32K (pulled back to the limit) to -32K (maximum forward limit).
XAxis, YAxis or ZAxis Movement of the joystick in the X, Y, or Z directions. For most joysticks the movement is left or right for the XAxis and forward or backward for the YAxis, with no values for the ZAxis. The limits in the Y axis are 32K (pulled back) to -32K (pushed forward). The limits in the X axis are -32K (full left) to 32K (full right). Depending on the joystick though, the limits may be significantly less than these values.
RxAxis, RyAxis, or RzAxis Rotation of the joystick about the X, Y, or Z axis. For most joysticks there is only rotational movement around the Z axis, with no values for the X or Y axis. For the Z axis, the limits are -32K (rotated left to the maximum) to 32K (rotated right to the maximum). Again, actual limits depend on the joystick.

For keyboard hits, usually no further information other than the key has been pressed is necessary for the client to process the event appropriately. For joystick events, other than button events, it is also important to know the extent of the movement (or position of the hat switch, or of the slider). This information is returned with the event in the dwData parameter of a SIMCONNECT_RECV_EVENT structure.

For button, hat switch, or keyboard events, one event is transmitted to the client, or two if an up event is specified, when the input event occurs. If joystick axis, rotation or slider events are requested, then an event is transmitted for these six times per second whether the joystick is actually moved or not, unless the value for these is zero, in which case events are not transmitted until the joystick is moved from this position. Joystick and keyboard events are only transmitted when a scenario is loaded, not while the user is navigating the shell of the product.

For reference, the default input mappings of joystick buttons to events is specified in the Standard.xml file in the root Lockheed Martin\Prepar3D v3 folder. The first time Prepar3D is run, a subset of this file is written out to a file with the same name in the %APPDATA%\Lockheed Martin\Prepar3D v3\Controls folder, containing just the mappings that the current setup is using. Each time Prepar3D is run the smaller file is read in, and is the first used to find a mapping for a device. If a mapping is not found the larger file in the root folder is opened and searched (and a successful mapping added to the internal copy of the file). A generic mapping is used if no match is found. The file is written out again when the simulation is exited, obviously containing any new mappings. It is usually safe for a third-party to update the smaller version of Standard.xml with correct and appropriate mappings, as long as this does not happen while Prepar3D is running, as in this case the file will be over-written.

See Also


SimConnect_Open

The SimConnect_Open function is used to send a request to the Prepar3D server to open up communications with a new client.

Syntax

HRESULT SimConnect_Open(
  HANDLE*  phSimConnect,
  LPCSTR  szName,
  HWND  hWnd,
  DWORD  UserEventWin32,
  HANDLE  hEventHandle,
  DWORD  ConfigIndex
);

Parameters

phSimConnect
[in]  Pointer to a handle to a SimConnect object.
szName
[in]  Pointer to a null-terminated string containing an appropriate name for the client program. The empty string ("") is a valid entry, NULL is not supported.
hWnd
[in]  Handle to a Windows object. Set this to NULL if the handle is not being used.
UserEventWin32
[in]  Code number that the client can specify. Set this to 0 if it is not being used.
hEventHandle
[in] A Windows Event handle. A client can be written to respond to Windows Events, rather than use a polling and callback system, which can be a more efficient process if the client does not have to respond very frequently to changes in data in Prepar3D.
ConfigIndex
[in]  The configuration index. The SimConnect.cfg file can contain a number of configurations, identified in sections with the [SimConnect] or [SimConnect.N] titles. Setting this configuration index indicates which configuration settings to use for this SimConnect client. This is useful for applications that communicate with a number of different machines that are running Prepar3D. The default configuration index is zero (matching a [SimConnect] entry in a SimConnect.cfg file). Note the E_INVALIDARG return value.


To ensure that a configuration file is not read accidentally, for example when creating a .dll add-on that is only to work locally, enter SIMCONNECT_OPEN_CONFIGINDEX_LOCAL for this parameter, which will force local operation regardless of the existence of any configuration files.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.


Return value Description
S_OK The function succeeded.
E_FAIL The function failed.
E_INVALIDARG A SimConnect section in the Simconnect.cfg file did not contain the config index requested in the parameters.

Example

HRESULT hr;
HANDLE hSimConnect = NULL;

hr = SimConnect_Open(&hSimConnect, "Your Application Name", NULL, 0, 0, SIMCONNECT_OPEN_CONFIGINDEX_LOCAL);

Working Samples

Primary samples Open and Close
Windows Event
Reference samples All of the other samples implement this function.

Remarks

Most client applications will have one SimConnect_Open call, and one corresponding SimConnect_Close call. However in some applications, multiplayer in particular,  multiple SimConnect_Open calls may be necessary, in which case an array or list of handles will need to be maintained, and closed appropriately.

A client can optionally examine the SIMCOMMENT_RECV_OPEN structure that is returned after a call to SimConnect_Open. This structure gives versioning and build information that should be useful when multiple versions of SimConnect and multiple versions of Prepar3D that support it, are available.

If a remote client successfully establishes a link with Prepar3D, but at some later time the network connection is lost, SimConnect functions will return the NTSTATUS error STATUS_REMOTE_DISCONNECT (0xC000013CL).

The SIMCONNECT_EXCEPTION_VERSION_MISMATCH exception will be returned if a versioning error has occurred, typically when a client built on a newer version of the SimConnect client dll attempts to work with an older version of the SimConnect server. If this exception is received the dwIndex parameter will contain the following:

(version minor number * 65536) + version major number
. The minor number will be 0 and the major number 10. Use the LOWORD and HIWORD macros to easily extract the two numbers.

See Also


SimConnect_RemoveClientEvent

The SimConnect_RemoveClientEvent function is used to remove a client defined event from a notification group.

Syntax

HRESULT SimConnect_RemoveClientEvent(
  HANDLE  hSimConnect,
  SIMCONNECT_NOTIFICATION_GROUP_ID  GroupID,
  SIMCONNECT_CLIENT_EVENT_ID  EventID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
GroupID
[in]  Specifies the ID of the client defined group.
EventID
[in]  Specifies the ID of the client defined event ID that is to be removed from the group.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Example

static enum EVENT_ID {
  EVENT_1,
  EVENT_2
  EVENT_3
};
static enum GROUP_ID {
  GROUP_1,
};
hr = SimConnect_AddClientEventToNotificationGroup(hSimConnect, GROUP_1, EVENT_1);
hr = SimConnect_AddClientEventToNotificationGroup(hSimConnect, GROUP_1, EVENT_2);
hr = SimConnect_AddClientEventToNotificationGroup(hSimConnect, GROUP_1, EVENT_3, TRUE);

hr = SimConnect_RemoveClientEvent(hSimConnect, GROUP_1, EVENT_2);

Remarks

Use this function to permanently remove the client event. There is no reliable procedure to temporarily turn off a client event.

See Also


SimConnect_RemoveInputEvent

The SimConnect_RemoveInputEvent function is used to remove an input event from a specified input group object.

Syntax

HRESULT SimConnect_RemoveInputEvent(
  HANDLE  hSimConnect,
  SIMCONNECT_INPUT_GROUP_ID  GroupID,
  const char*  pszInputDefinition
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
GroupID
[in]  Specifies the ID of the client defined input group from which the event is to be removed.
pszInputDefinition
[in]  Pointer to a null-terminated string containing the input definition.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Example

static enum INPUT_ID {
  INPUT_1,
};
static enum EVENT_ID {
  EVENT_1,
};
hr = SimConnect_MapClientEventToSimEvent(hSimConnect, EVENT_1, "parking_brakes");
hr = SimConnect_MapInputEventToClientEvent(hSimConnect, INPUT_1, "a+B", EVENT_1);
....
hr = SimConnect_RemoveInputEvent(hSimConnect, INPUT_1, "a+B");

Remarks

The input string definitions must match exactly, before anything is removed from the group definition. For example, the string definitions "A+B" and "a+B" do not match.

See Also


SimConnect_RequestAttachPointData

The SimConnect_RequestAttachPointData function is used to request attach point data from a simulation object.

Syntax

HRESULT SimConnect_RequestAttachPointData(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID,
  DWORD  dwObjectID,
  const char*  szAttachPointName,
  BOOL  bRequestWorldCoordinates = FALSE
);

Parameters

hSimConnect
[in]   Handle to a SimConnect object.
RequestID
[in] Specifies the ID of the client-defined request. This is used later by the client to identify which data has been received. This value should be unique for each request, re-using a RequestID will overwrite any previous request using the same ID.
dwObjectID
[in]  The ID of the object to request attachpoint information from.
szAttachPointName
[in]  Specifies the name of the attach point to request data from.
bRequestWorldCoordinates
[in, optional]  If set to TRUE, the world position and orientation information will be requested as well. If FALSE, world position and orientation information will be returned as zero.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

The data will be returned in a SIMCONNECT_RECV_ATTACHPOINT_DATA structure.

See Also


SimConnect_RequestClientData

The SimConnect_RequestClientData function is used to request that the specified data in an area created by another client be sent to this client.

Syntax

HRESULT SimConnect_RequestClientData(
  HANDLE  hSimConnect,
  SIMCONNECT_CLIENT_DATA_ID  ClientDataID,
  SIMCONNECT_DATA_REQUEST_ID  RequestID,
  SIMCONNECT_CLIENT_DATA_DEFINITION_ID  DefineID,
  SIMCONNECT_CLIENT_DATA_PERIOD  Period = SIMCONNECT_CLIENT_DATA_PERIOD_ONCE,
  SIMCONNECT_CLIENT_DATA_REQUEST_FLAG  Flags = 0,
  DWORD  origin = 0,
  DWORD  interval = 0,
  DWORD  limit = 0
);

Parameters

hSimConnect
[in]   Handle to a SimConnect object.
ClientDataID
[in]   Specifies the ID of the client data area. Before calling this function for the first time on one client area, call SimConnect_MapClientDataNameToID to map an ID to the unique client data area name. This name must match the name specified by the client creating the data area with the SimConnect_MapClientDataNameToID and SimConnect_CreateClientData functions.
RequestID
[in] Specifies the ID of the client-defined request. This is used later by the client to identify which data has been received. This value should be unique for each request, re-using a RequestID will overwrite any previous request using the same ID.
DefineID
[in]  Specifies the ID of the client-defined data definition. This definition specifies the data that should be sent to the client.
Period
[in, optional]  One member of the SIMCONNECT_CLIENT_DATA_PERIOD enumeration type, specifying how often the data is to be sent by the server and received by the client.
Flags
[in, optional]  A DWORD containing one or more of the following values:
Flag value Description
0 The default, data will be sent strictly according to the defined period.
SIMCONNECT_CLIENT_DATA_REQUEST_FLAG_CHANGED Data will only be sent to the client when one or more values have changed. If this is the only flag set, then all the variables in a data definition will be returned if just one of the values changes.
SIMCONNECT_CLIENT_DATA_REQUEST_FLAG_TAGGED Requested data will be sent in tagged format (datum ID/value pairs). Tagged format requires that a datum reference ID is returned along with the data value, in order that the client code is able to identify the variable. This flag is usually set in conjunction with the previous flag, but it can be used on its own to return all the values in a data definition in datum ID/value pairs. See the SIMCONNECT_RECV_CLIENT_DATA structure for more details.
origin
[in, optional]  The number of Period events that should elapse before transmission of the data begins. The default is zero, which means transmissions will start immediately.
interval
[in, optional]  The number of Period events that should elapse between transmissions of the data. The default is zero, which means the data is transmitted every Period.
limit
[in, optional]  The number of times the data should be transmitted before this communication is ended. The default is zero, which means the data should be transmitted endlessly.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

A data definition must be specified, using the SimConnect_AddToClientDataDefinition function, before this function can be called If the data definition exceeds the size of the client data area on the server, then the extra bytes will be filled with zeros, an error will not be returned.

The data will be returned in a SIMCONNECT_RECV_CLIENT_DATA structure.

See the remarks for SimConnect_RequestDataOnSimObject, as the two functions work in a very similar manner.

This function has been updated for the SP1a release of the SDK, expanding on its functionality.

See Also


SimConnect_RequestDataOnSimObject

The SimConnect_RequestDataOnSimObject function is used to request when the SimConnect client is to receive data values for a specific object.

Syntax

HRESULT SimConnect_RequestDataOnSimObject(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID,
  SIMCONNECT_DATA_DEFINITION_ID  DefineID,
  SIMCONNECT_OBJECT_ID  ObjectID,
  SIMCONNECT_PERIOD  Period,
  SIMCONNECT_DATA_REQUEST_FLAG  Flags = 0,
  DWORD  origin = 0,
  DWORD  interval = 0,
  DWORD  limit = 0
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
RequestID
[in]  Specifies the ID of the client defined request. This is used later by the client to identify which data has been received. This value should be unique for each request, re-using a RequestID will overwrite any previous request using the same ID.
DefineID
[in]  Specifies the ID of the client defined data definition.
ObjectID
[in]  Specifies the ID of the Prepar3D object that the data should be about. This ID can be SIMCONNECT_OBJECT_ID_USER (to specify the user's aircraft) or obtained from a SIMCONNECT_RECV_SIMOBJECT_DATA_BYTYPE structure after a call to SimConnect_RequestDataOnSimObjectType. Also refer to the note on developing clients for multiplayer mode in the Remarks section below.
Period
[in]  One member of the SIMCONNECT_PERIOD enumeration type, specifying how often the data is to be sent by the server and received by the client.
Flags
[in, optional]  A DWORD containing one or more of the following values:
Flag value Description
0 The default, data will be sent strictly according to the defined period.
SIMCONNECT_DATA_REQUEST_FLAG_CHANGED Data will only be sent to the client when one or more values have changed. If this is the only flag set, then all the variables in a data definition will be returned if just one of the values changes.
SIMCONNECT_DATA_REQUEST_FLAG_TAGGED Requested data will be sent in tagged format (datum ID/value pairs). Tagged format requires that a datum reference ID is returned along with the data value, in order that the client code is able to identify the variable. This flag is usually set in conjunction with the previous flag, but it can be used on its own to return all the values in a data definition in datum ID/value pairs. See the SIMCONNECT_RECV_SIMOBJECT_DATA structure for more details.
SIMCONNECT_DATA_REQUEST_FLAG_BLOCK Requested data will be sent using a blocking callback. See SimConnect_RequestSynchronousBlock for more information.
origin
[in, optional]  The number of Period events that should elapse before transmission of the data begins. The default is zero, which means transmissions will start immediately.
interval
[in, optional]  The number of Period events that should elapse between transmissions of the data. The default is zero, which means the data is transmitted every Period.
limit
[in, optional]  The number of times the data should be transmitted before this communication is ended. The default is zero, which means the data should be transmitted endlessly.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Example


static enum DATA_DEFINE_ID {
  DEFINITION_1,
  DEFINITION_2
};

static enum DATA_REQUEST_ID {
    REQUEST_1,
    REQUEST_2,
};

struct Struct1
{
    double  kohlsmann;
    double  altitude;
    double  latitude;
    double  longitude;
};
// Match string definitions from the Simulation Variables document with the client defined ID

hr = SimConnect_AddToDataDefinition(hSimConnect, DEFINITION_1, "Kohlsman setting hg", "inHg");
hr = SimConnect_AddToDataDefinition(hSimConnect, DEFINITION_1, "Indicated Altitude", "feet");
hr = SimConnect_AddToDataDefinition(hSimConnect, DEFINITION_1, "Plane Latitude", "degrees");
hr = SimConnect_AddToDataDefinition(hSimConnect, DEFINITION_1, "Plane Longitude", "degrees");

// Sections of code in DispatchProc

....
SimConnect_RequestDataOnSimObject(hSimConnect, REQUEST_2, DEFINITION_1, SIMCONNECT_OBJECT_ID_USER, SIMCONNECT_PERIOD_SECOND);
....
// When the data is received -- cast it to the correct structure type

case SIMCONNECT_RECV_ID_SIMOBJECT_DATA:
{
  SIMCONNECT_RECV_SIMOBJECT_DATA *pObjData = (SIMCONNECT_RECV_SIMOBJECT_DATA*) pData;

  switch(pObjData->dwRequestID)
  {
    case REQUEST_2:

      Struct1 *pS = (Struct1*)&pObjData->dwData;
   
      // Add code to process the structure appropriately

      break;
  }
break;
}
....

Working Samples

Primary samples Tagged Data
Reference samples Weather Station

Remarks

Changing the Period parameter or changing the content of a data definition has a higher performance cost than changing the origin, interval or limit parameters. So to temporarily turn off data requests, especially for short periods of time, consider setting the interval parameter to a very high value (such as DWORD _MAX). If changes are required to a data definition, consider setting the Period parameter to SIMCONNECT_PERIOD_NEVER (see the SIMCONNECT_PERIOD enumeration) before making the changes, and then turning on the appropriate period after the changes have been made.

It is possible to change the period of a request, by resending the SimConnect_RequestDataOnSimObject call with the same RequestID, DefineID and ObjectID parameters, but with a new period. The one exception to this is the new period cannot be SIMCONNECT_PERIOD_ONCE, in this case a request with a new RequestID should be sent.

If an object is removed, and if it has a current periodic data request, a SIMCONNECT_EXCEPTION_UNRECOGNIZED_ID exception will be sent every requested period. This can be avoided by sending a new SimConnect_RequestDataOnSimObject with the period set to SIMCONNECT_PERIOD_NEVER, before the object is removed or once the first exception is generated.

Data is always transmitted with the SimConnect_RequestDataOnSimObject function, so if timing only notifications are required, use the SimConnect_SubscribeToSystemEvent function.

Note that variable length strings should not be used in data definitions, except where the Period parameter has been set to SIMCONNECT_PERIOD_ONCE.

One method of testing whether the user has changed aircraft type is to use this function to return the title of the user aircraft, and note that if it changes, the user has changed the type of aircraft (all aircraft types have unique title strings, including those simply with different color schemes). An example of requesting the aircraft title is in the Variable Strings working sample. See the Aircraft Configuration Files document for more details on titles.

If boolean data has been requested as part of a data definition, note that the only reliable numeric equivalent is that 0 is returned for False. Non-zero values, especially both 1 and -1, are used to indicate True.

Note: Multiplayer Mode

When developing a client for use in multiplayer mode it is not safe to use the ID number for the user aircraft returned by the function SimConnect_RequestDataOnSimObjectType, as the actual number can change depending on several factors, including the number of users involved in the multiplayer scenario. Always use the constant SIMCONNECT_OBJECT_ID_USER for the ObjectID parameter if the SimConnect client is to work in multiplayer mode. Also note that in this mode it is good practice to remove any calls associated with periodic data on AI objects and to remove subscriptions to AI objects.

See Also


SimConnect_RequestDataOnSimObjectType

The SimConnect_RequestDataOnSimObjectType function is used to retrieve information about simulation objects of a given type that are within a specified radius of the user's aircraft.

Syntax

HRESULT SimConnect_RequestDataOnSimObjectType(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID,
  SIMCONNECT_DATA_DEFINITION_ID  DefineID,
  DWORD  dwRadiusMeters,
  SIMCONNECT_SIMOBJECT_TYPE  type
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
RequestID
[in]  Specifies the ID of the client defined request. This is used later by the client to identify which data has been received. This value should be unique for each request, re-using a RequestID will overwrite any previous request using the same ID.
DefineID
[in]  Specifies the ID of the client defined data definition.
dwRadiusMeters
[in]  Double word containing the radius in meters. If this is set to zero only information on the user aircraft will be returned, although this value is ignored if type is set to SIMCONNECT_SIMOBJECT_TYPE_USER. The error SIMCONNECT_EXCEPTION_OUT_OF_BOUNDS will be returned if a radius is given and it exceeds the maximum allowed (200000 meters, or 200 Km).
type
[in]  Specifies the type of object to receive information on. One member of the SIMCONNECT_SIMOBJECT_TYPE enumeration type.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Example

See SimConnect_AddToDataDefinition for an example of when to use this function

Working Samples

Primary samples Request Data
Variable Strings
Reference samples  

Remarks

The data will be returned on all the relevant objects within the specified radius, but they will not be returned in any specific order. It is the responsibility of the client program to sort the returned data into order, if that is required. Information is returned in a SIMCONNECT_RECV_SIMOBJECT_DATA_BYTYPE structure, one structure per object.

Also refer to the note on multiplayer mode in the remarks for SimConnect_RequestDataOnSimObject.

See Also


SimConnect_RequestFlightSegmentCount

The SimConnect_RequestFlightSegmentCount function is used to request the number of Flight Segment objects in the active scenario.

Syntax

HRESULT SimConnect_RequestFlightSegmentCount(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID,
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
RequestID
[in]  Specifies the client defined request ID.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Samples

Primary samples Managed Mission Objects

Remarks

The information requested will be returned in a SIMCONNECT_RECV_MISSION_OBJECT_COUNT structure.

See Also


SimConnect_RequestFlightSegmentDataByGUID

The SimConnect_RequestFlightSegmentDataByGUID function is used to request information about a Flight Segment object in the active scenario.

Syntax

HRESULT SimConnect_RequestFlightSegmentDataByGUID(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID,
  const GUID  guidInstanceID,
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
RequestID
[in]  Specifies the client defined request ID.
guidInstanceID
[in]  Specifies the instance ID of the Flight Segment.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Samples

Primary samples Managed Mission Objects

Remarks

The information requested will be returned in a SIMCONNECT_RECV_FLIGHT_SEGMENT structure.

See Also


SimConnect_RequestFlightSegmentDataByIndex

The SimConnect_RequestFlightSegmentDataByIndex function is used to request information about a Flight Segment object in the active scenario.

Syntax

HRESULT SimConnect_RequestFlightSegmentDataByIndex(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID,
  int  flightSegmentIndex,
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
RequestID
[in]  Specifies the client defined request ID.
flightSegmentIndex
[in]  Specifies the index of the requested Flight Segment in the scenario.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Samples

Primary samples Managed Mission Objects

Remarks

The information requested will be returned in a SIMCONNECT_RECV_FLIGHT_SEGMENT structure.

See Also


SimConnect_RequestFlightSegmentRangeData

The SimConnect_RequestFlightSegmentRangeData function is used to request information about a specific range of a Flight Segment object in the active scenario.

Syntax

HRESULT SimConnect_RequestFlightSegmentRangeData(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID,
  const GUID  guidInstanceID,
  int  rangeIndex,
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
RequestID
[in]  Specifies the client defined request ID.
guidInstanceID
[in]  Specifies the instance ID of the Flight Segment.
rangeIndex
[in]  Specifies the index of the range within the requested Flight Segment in the scenario.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Samples

Primary samples Managed Mission Objects

Remarks

The information requested will be returned in a SIMCONNECT_RECV_PARAMETER_RANGE structure.

See Also


SimConnect_RequestGoalCount

The SimConnect_RequestGoalCount function is used to request the number of Goal/Group Goal objects in the active scenario.

Syntax

HRESULT SimConnect_RequestGoalCount(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID,
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
RequestID
[in]  Specifies the client defined request ID.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Samples

Primary samples Managed Mission Objects

Remarks

The information requested will be returned in a SIMCONNECT_RECV_MISSION_OBJECT_COUNT structure.

See Also


SimConnect_RequestGoalDataByGUID

The SimConnect_RequestGoalDataByGUID function is used to request information about a Goal/Group Goal object in the active scenario.

Syntax

HRESULT SimConnect_RequestGoalDataByGUID(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID,
  const GUID  guidInstanceID,
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
RequestID
[in]  Specifies the client defined request ID.
guidInstanceID
[in]  Specifies the instance ID of the Goal/Group Goal.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Samples

Primary samples Managed Mission Objects

Remarks

The information requested will be returned in a SIMCONNECT_RECV_GOAL structure.

See Also


SimConnect_RequestGoalDataByIndex

The SimConnect_RequestGoalDataByIndex function is used to request information about a Goal/Group Goal object in the active scenario.

Syntax

HRESULT SimConnect_RequestGoalDataByIndex(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID,
  int  goalIndex,
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
RequestID
[in]  Specifies the client defined request ID.
goalIndex
[in]  Specifies the index of the requested Goal/Group Goal object in the scenario.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table. /p>
Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Samples

Primary samples Managed Mission Objects

Remarks

The information requested will be returned in a SIMCONNECT_RECV_GOAL structure.

See Also


SimConnect_RequestChildGoalDataByIndex

The SimConnect_RequestChildGoalDataByIndex function is used to request information about a mission objective or group goal's children.

Syntax

HRESULT SimConnect_RequestChildGoalDataByIndex(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID,
  const GUID  parentGuidInstanceID,
  int  goalIndex,
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
RequestID
[in]  Specifies the client defined request ID.
parentGuidInstanceID
[in]  Specifies the instance ID of the Mission Objective or Group Goal that will have their children queried.
goalIndex
[in]  Specifies the index of the child goal to query.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

The information requested will be returned in a SIMCONNECT_RECV_GOAL_PAIR structure.

See Also


SimConnect_RequestMissionObjectiveCount

The SimConnect_RequestMissionObjectiveCount function is used to request the number of Mission Objective objects in the active scenario.

Syntax

HRESULT SimConnect_RequestMissionObjectiveCount(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID,
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
RequestID
[in]  Specifies the client defined request ID.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Samples

Primary samples Managed Mission Objects

Remarks

The information requested will be returned in a SIMCONNECT_RECV_MISSION_OBJECT_COUNT structure.

See Also


SimConnect_RequestMissionObjectiveDataByGUID

The SimConnect_RequestMissionObjectiveDataByGUID function is used to request information about a Mission Objective object in the active scenario.

Syntax

HRESULT SimConnect_RequestMissionObjectiveDataByGUID(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID,
  const GUID  guidInstanceID,
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
RequestID
[in]  Specifies the client defined request ID.
guidInstanceID
[in]  Specifies the instance ID of the Mission Objective.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Samples

Primary samples Managed Mission Objects

Remarks

The information requested will be returned in a SIMCONNECT_RECV_MISSION_OBJECTIVE structure.

See Also


SimConnect_RequestMissionObjectiveDataByIndex

The SimConnect_RequestMissionObjectiveDataByIndex function is used to request information about a Mission Objective object in the active scenario.

Syntax

HRESULT SimConnect_RequestMissionObjectiveDataByIndex(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID,
  int  missionObjectiveIndex,
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
RequestID
[in]  Specifies the client defined request ID.
missionObjectiveIndex
[in]  Specifies the index of the requested Mission Objective object in the scenario.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Samples

Primary samples Managed Mission Objects

Remarks

The information requested will be returned in a SIMCONNECT_RECV_MISSION_OBJECTIVE structure.

See Also


SimConnect_GenerateFlightAnalysisDiagrams

The SimConnect_GenerateFlightAnalysisDiagrams function is primarily used to generate diagrams as shown in the flight analysis UI which can be used, for example, to examine ILS landing performance. The following images will be generated in your Prepar3D v3 Files in the My Pictures Library:


Syntax

HRESULT SimConnect_GenerateFlightAnalysisDiagrams(
  HANDLE  hSimConnect
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

The information requested will be returned in a SIMCONNECT_RECV_EVENT_FLIGHT_ANALYSIS_DIAGRAMS structure.

See Also


SimConnect_RequestLandingTriggerCount

The SimConnect_RequestLandingTriggerCount function is used to request the number of Area Landing Trigger or Airport Landing Trigger objects in the active scenario.

Syntax

HRESULT SimConnect_RequestLandingTriggerCount(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
RequestID
[in]  Specifies the client defined request ID.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

The information requested will be returned in a SIMCONNECT_RECV_MISSION_OBJECT_COUNT structure.

See Also


SimConnect_RequestLandingTriggerLandingInfoCount

The SimConnect_RequestLandingTriggerLandingInfoCount function is used to request information about a landing trigger object's landings in the active scenario.

Syntax

HRESULT SimConnect_RequestLandingTriggerLandingInfoCount(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID,
  int  landingTriggerIndex
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
RequestID
[in]  Specifies the client defined request ID.
landingTriggerIndex
[in]  Specifies the index of the requested Landing Trigger object in the scenario.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

The information requested will be returned in a SIMCONNECT_RECV_LANDING_TRIGGER_INFO structure.

See Also


SimConnect_RequestLandingTriggerLandingInfoByIndex

The SimConnect_RequestLandingTriggerLandingInfoByIndex function is used to request information about a specific landing of a Landing Trigger object in the active scenario.

Syntax

HRESULT SimConnect_RequestLandingTriggerLandingInfoByIndex(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID,
  const GUID  landingTriggerInstanceID,
  int  landingIndex
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
RequestID
[in]  Specifies the client defined request ID.
landingTriggerInstanceID
[in]  Specifies the instance ID of the Landing Trigger.
landingIndex
[in]  Specifies the index of the landing within the requested Landing Trigger in the scenario.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

The information requested will be returned in a SIMCONNECT_RECV_LANDING_INFO structure.

See Also


SimConnect_RequestJoystickDeviceInfo

The SimConnect_RequestJoystickDeviceInfo function is used to request information on currently connected joystick devices.

Syntax

HRESULT SimConnect_RequestJoystickDeviceInfo(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
RequestID
[in]  Specifies the client defined request ID.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

The information requested will be returned in a SIMCONNECT_RECV_JOYSTICK_DEVICE_INFO structure.

This function does not include mouse devices.

See Also


SimConnect_RequestMobileSceneryInRadius

The SimConnect_RequestMobileSceneryInRadius function is used to retrieve mobile scenery objects that are within a specified radius of the user's vehicle. Any request over 20,000 meters will return all mobile scenery objects.

Syntax

HRESULT SimConnect_RequestMobileSceneryInRadius(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID
  DWORD  dwRadiusMeters
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
RequestID
[in]  Specifies the client defined request ID.
dwRadiusMeters
[in]  Specifies the radius (in meters) from the user vehicle from which to obtain mobile scenery.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

The information requested will be returned in a SIMCONNECT_RECV_MOBILE_SCENERY_IN_RADIUS structure.


Working Samples

Primary samples See Managed Mission Objects sample in SimConnect SDK.

See Also


SimConnect_RequestMobileSceneryDataByID

The SimConnect_RequestMobileSceneryDataByID function is used to retrieve data about a specific mobile scenery object using its object ID.

Syntax

HRESULT SimConnect_RequestMobileSceneryDataByID(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID
  SIMCONNECT_OBJECT_ID  ObjectID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
RequestID
[in]  Specifies the client defined request ID.
ObjectID
[in]  Specifies the object ID of the mobile scenery object to retrieve data about.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

The information requested will be returned in a SIMCONNECT_RECV_MOBILE_SCENERY_DATA structure.


Working Samples

Primary samples See Managed Mission Objects sample in SimConnect SDK.

See Also


SimConnect_RequestNotificationGroup

The SimConnect_RequestNotificationGroup function is used to request events are transmitted from a notification group, when the simulation is in Dialog Mode.

Syntax

HRESULT SimConnect_RequestNotificationGroup(
  HANDLE  hSimConnect,
  SIMCONNECT_NOTIFICATION_GROUP_ID  GroupID,
  DWORD  dwReserved = 0,
  DWORD  Flags = 0
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
GroupID
[in]  Specifies the ID of the client defined group.
dwReserved
[in, optional]  Reserved for future use.
Flags
[in, optional]  Reserved for future use.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

In this version this function has the specific purpose of enabling the sending of events, particularly joystick events, when the simulation is in Dialog Mode.

See Also


SimConnect_RequestReservedKey

The SimConnect_RequestReservedKey function is used to request a specific keyboard TAB-key combination applies only to this client.

Syntax

HRESULT SimConnect_RequestReservedKey(
  HANDLE  hSimConnect,
  SIMCONNECT_CLIENT_EVENT_ID  EventID,
  const char*  szKeyChoice1,
  const char*  szKeyChoice2 = "",
  const char*  szKeyChoice3 = ""
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
EventID
[in]  Specifies the client defined event ID.
szKeyChoice1
[in]  Null-terminated string containing the first key choice. Refer to the document Key Strings for a full list of choices that can be entered for these three parameters.
szKeyChoice2
[in, optional]  Null-terminated string containing the second key choice.
szKeyChoice3
[in, optional]  Null-terminated string containing the third key choice.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Sample

Primary sample Reserved Key

Remarks

A successful call to this function will result in a SIMCONNECT_RECV_RESERVED_KEY structure being returned, with the key that has been assigned to this client. The first of the three that can be assigned will be the choice, unless all three are already taken, in which case a null string will be returned.

The szKeyChoice parameters should be a single character (such as "A"), which is requesting that the key combination TAB-A is reserved for this client. All reserved keys are TAB-key combinations.

See Also


SimConnect_RequestSystemState

The SimConnect_RequestSystemState function is used to request information from a number of Prepar3D system components.

Syntax

HRESULT SimConnect_RequestSystemState(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID,
  const char*  szState
);

Parameters

hSimConnect
  Handle to a SimConnect object.
RequestID
  The client defined request ID.
szState
  A null-terminated string identifying the system function. One from the following table:

String Description
AircraftLoaded Requests the full path name of the last loaded aircraft flight dynamics file. These files have a .AIR extension.
DialogMode Requests whether the simulation is in Dialog mode or not. See SimConnect_SetSystemState for a description of Dialog mode.
FlightLoaded Requests the full path name of the last loaded scenario. Scenario files have the extension .FXML.
FlightPlan Requests the full path name of the active flight plan. An empty string will be returned if there is no active flight plan.
FullScreenMode Requests whether the simulation is in Full Screen mode or not.
Sim Requests the state of the simulation. If 1 is returned, the user is in control of the aircraft, if 0 is returned, the user is navigating the UI. This is the same state that notifications can be subscribed to with the "SimStart" and "SimStop" string with the SimConnect_SubscribeToSystemEvent function.


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

The information requested will be returned in a SIMCONNECT_RECV_SYSTEM_STATE structure.

See Also


SimConnect_RequestVersion

The SimConnect_RequestVersion function is used to request license type, Prepar3D version, and Prepar3D SimConnect version.

Syntax

HRESULT SimConnect_RequestVersion(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
RequestID
[in]  Specifies the client defined request ID.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

The information requested will be returned in a SIMCONNECT_RECV_VERSION structure.

See Also


SimConnect_RequestSceneryComplexity

The SimConnect_RequestSceneryComplexity function is used to request the current scenery complexity setting.

Syntax

HRESULT SimConnect_RequestSceneryComplexity(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
RequestID
[in]  Specifies the client defined request ID.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Samples

Primary samples Scenery Complexity and Shadow Flags

Remarks

The information requested will be returned in a SIMCONNECT_RECV_SCENERY_COMPLEXITY structure.

See Also


SimConnect_RequestShadowFlags

The SimConnect_RequestShadowFlags function is used to request the current shadow flag settings.

Syntax

HRESULT SimConnect_RequestShadowFlags(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
RequestID
[in]  Specifies the client defined request ID.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Samples

Primary samples Scenery Complexity and Shadow Flags

Remarks

The information requested will be returned in a SIMCONNECT_RECV_SHADOW_FLAGS structure.

See Also


SimConnect_RequestSessionDuration

The SimConnect_RequestSessionDuration function is used to request the simulated time in seconds since the last scenario load. When in a scenario, the duration is accumulated between scenario saves/loads, such as saving and loading checkpoints.

HRESULT SimConnect_RequestSessionDuration(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
RequestID
[in]  Specifies the client defined request ID.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

The information requested will be returned in a SIMCONNECT_RECV_SESSION_DURATION structure.

See Also


SimConnect_RequestTrafficSettings

The SimConnect_RequestTrafficSettings function is used to request the current traffic settings.

Syntax

HRESULT SimConnect_RequestTrafficSettings(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
RequestID
[in]  Specifies the client defined request ID.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Samples

Primary samples None

Remarks

The information requested will be returned in a SIMCONNECT_RECV_TRAFFIC_SETTINGS structure.

See Also


SimConnect_ResolveGoal

The SimConnect_ResolveGoal function is used to resolve a goal to specified goal state.

HRESULT SimConnect_ResolveGoal(
  HANDLE  hSimConnect,
  const GUID  guidInstanceID,
  SIMCONNECT_GOAL_RESOLUTION  goalResolution
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
RequestID
[in]  Specifies the client defined request ID.
guidInstanceID
[in]  Specifies the instance ID of the Flight Segment.
goalResolution
[in]  Specifies the state, defined in SIMCONNECT_GOAL_RESOLUTION, the goal/group goal should resolve to.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Samples

Primary samples Managed Mission Objects

Remarks

This allows the client to do its own processing to determine the passing state of a goal.

See Also


SimConnect_SetClientData

The SimConnect_SetClientData function is used to write one or more units of data to a client data area.

Syntax

HRESULT SimConnect_SetClientData(
  HANDLE  hSimConnect,
  SIMCONNECT_CLIENT_DATA_ID  ClientDataID,
  SIMCONNECT_CLIENT_DATA_DEFINITION_ID  DefineID,
  DWORD  Flags,
  DWORD  dwReserved,
  DWORD  cbUnitSize,
  void*  pDataSet
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
ClientDataID
[in]  Specifies the ID of the client data area.
DefineID
[in]  Specifies the ID of the client defined client data definition.
Flags
[in]  Null, or one or more of the following flags.
Flag Description
SIMCONNECT_CLIENT_DATA_SET_FLAG_TAGGED The data to be set is being sent in tagged format. If this flag is not set then the entire client data area should be replaced with new data. Refer to the pDataSet parameter and SimConnect_RequestClientData for more details on the tagged format.
dwReserved
[in]  Reserved for future use. Set to zero.
cbUnitSize
[in]  Specifies the size of the data set in bytes. The server will check that this size matches exactly the size of the data definition provided in the DefineID parameter. An exception will be returned if this is not the case.
pDataSet
[in]  Pointer to the data that is to be written. If the data is not in tagged format, this should point to the block of client data. If the data is in tagged format this should point to the first tag name (datumID), which is always four bytes long, which should be followed by the data itself. Any number of tag name/value pairs can be specified this way, the server will use the cbUnitSize parameter to determine how much data has been sent.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

A data definition must be specified, using the SimConnect_AddToClientDataDefinition function, before data can be set.

See Also


SimConnect_SetDataOnSimObject

The SimConnect_SetDataOnSimObject function is used to make changes to the data properties of an object.

Syntax

HRESULT SimConnect_SetDataOnSimObject(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_DEFINITION_ID  DefineID,
  SIMCONNECT_OBJECT_ID  ObjectID,
  SIMCONNECT_DATA_SET_FLAG  Flags,
  DWORD  ArrayCount,
  DWORD  cbUnitSize,
  void*  pDataSet
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
DefineID
[in]  Specifies the ID of the client defined data definition.
ObjectID
[in]  Specifies the ID of the Prepar3D object that the data should be about. This ID can be SIMCONNECT_OBJECT_ID_USER (to specify the user's aircraft) or obtained from a SIMCONNECT_RECV_SIMOBJECT_DATA_BYTYPE structure after a call to SimConnect_RequestDataOnSimObjectType. Also refer to the note on multiplayer mode in the remarks for SimConnect_RequestDataOnSimObject.
Flags
[in]  Null, or one or more of the following flags.
Flag Description
SIMCONNECT_DATA_SET_FLAG_TAGGED The data to be set is being sent in tagged format. Refer to SimConnect_RequestDataOnSimObject for more details on the tagged format.
SIMCONNECT_DATA_SET_FLAG_UNBLOCK Any currently outstanding blocking callbacks are released. See SimConnect_RequestSynchronousBlock for more information.
ArrayCount
[in]  Specifies the number of elements in the data array. A count of zero is interpreted as one element. Ensure that the data array has been initialized completely before transmitting it to Prepar3D. Failure to properly initialize all array elements may result in unexpected behavior.
cbUnitSize
[in]  Specifies the size of each element in the data array in bytes.

pDataSet
[in]  Pointer to the data that is to be written. If the data is not in tagged format, this should point to the block of data. If the data is in tagged format this should point to the first tag name (datumID), which is always four bytes long, which should be followed by the data itself. Any number of tag name/value pairs can be specified this way, the server will use the cbUnitSize parameter to determine how much data has been sent.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Example

static enum DATA_DEFINE_ID {
  DEFINITION3
};
  
// Link DEFINITION3 with the SIMCONNECT_DATA_INITPOSITION structure

hr = SimConnect_AddToDataDefinition(hSimConnect, DEFINITION3, "Initial Position", "NULL", SIMCONNECT_DATATYPE_INITPOSITION, 0);

SIMCONNECT_DATA_INITPOSITION Init;
Init.Altitude = 5000.0;
Init.Latitude = 47.64210;
Init.Longitude = -122.13010;
Init.Pitch = -0.0;
Init.Bank = -1.0;
Init.Heading = 180.0;
Init.OnGround = 0;
Init.Airspeed = 0;

SimConnect_SetDataOnSimObject(hSimConnect, DEFINITION3, SIMCONNECT_OBJECT_ID_USER, 0, 0, sizeof(Init), &Init);

Working Samples

Primary samples Set Data
Throttle Control
 
Reference samples AI Objects and Waypoints
Managed AI Waypoints

Remarks

The data that is set on an object is defined in a data definition (see the SimConnect_AddToDataDefinition function). This data can include the following structures: SIMCONNECT_DATA_WAYPOINT, SIMCONNECT_DATA_INITPOSITION, and SIMCONNECT_DATA_MARKERSTATE. Any number of waypoints can be given to an AI object using a single call to this function, and any number of marker state structures can also be combined into an array.

The Simulation Variables document includes a column indicating whether variables can be written to or not. An exception will be returned if an attempt is made to write to a variable that cannot be set in this way.

See Also


SimConnect_SetInputGroupPriority

The SimConnect_SetInputGroupPriority function is used to set the priority for a specified input group object.

Syntax

HRESULT SimConnect_SetInputGroupPriority(
  HANDLE  hSimConnect,
  SIMCONNECT_INPUT_GROUP_ID  GroupID,
  DWORD  uPriority
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
GroupID
[in]  Specifies the ID of the client defined input group that the priority setting is to apply to.
uPriority
[in]  Specifies the priority setting for the input group. See the explanation of SimConnect Priorities.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Example

hr=SimConnect_SetInputGroupPriority(hSimConnect,INPUT0,SIMCONNECT_GROUP_PRIORITY_HIGHEST);

Working Samples

Primary samples Input Event
Joystick Input
 

Remarks

A priority setting must be made for all input groups, otherwise event notifications will not be sent by the SimConnect server.

See Also


SimConnect_SetInputGroupState

The SimConnect_SetInputGroupState function is used to turn requests for input event information from the server on and off.

Syntax

HRESULT SimConnect_SetInputGroupState(
  HANDLE  hSimConnect,
  SIMCONNECT_INPUT_GROUP_ID  GroupID,
  DWORD  dwState
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
GroupID
[in]  Specifies the ID of the client defined input group that is to have its state changed.
dwState
[in]  Double word containing the new state. One member of the SIMCONNECT_STATE enumeration type.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Example

static enum INPUT_ID {
  INPUT_1,
  INPUT_2
};
static enum EVENT_ID {
  EVENT_1,
  EVENT_2
};
....
hr = SimConnect_MapClientEventToSimEvent(hSimConnect, EVENT_1, "parking_brakes");
hr = SimConnect_MapInputEventToClientEvent(hSimConnect, INPUT_1, "ctrl+U+Q", EVENT_1);
hr = SimConnect_SetInputGroupState(hSimConnect, INPUT_1, SIMCONNECT_STATE_ON);

Working Samples

Primary samples Input Event
Joystick Input
Throttle Control
Reference samples Set Data

Remarks

The default state for input groups is to be inactive, so make sure to call this function each time an input group is to become active.

See Also


SimConnect_SetNotificationGroupPriority

The SimConnect_SetNotificationGroupPriority function is used to set the priority for a notification group.

Syntax

HRESULT SimConnect_SetNotificationGroupPriority(
  HANDLE  hSimConnect,
  SIMCONNECT_NOTIFICATION_GROUP_ID  GroupID,
  DWORD  uPriority
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
GroupID
[in]  Specifies the ID of the client defined group.
uPriority
[in]  Requests the group's priority. See the explanation of SimConnect Priorities.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Example

hr=SimConnect_SetNotificationGroupPriority(hSimConnect,GROUP0,SIMCONNECT_GROUP_PRIORITY_HIGHEST);

Working Samples

Primary samples Client Event
Send Event A
Send Event B
Send Event C
Tracking Errors

Remarks

SimConnect Priorities

SimConnect constants define the following priorities:

Priority Value Description
SIMCONNECT_GROUP_PRIORITY_HIGHEST 1 The highest priority.
SIMCONNECT_GROUP_PRIORITY_HIGHEST_MASKABLE 10000000 The highest priority that allows events to be masked.
SIMCONNECT_GROUP_PRIORITY_STANDARD 1900000000 The standard priority.
SIMCONNECT_GROUP_PRIORITY_DEFAULT 2000000000 The default priority.
SIMCONNECT_GROUP_PRIORITY_LOWEST 4000000000 Priorities lower than this will be ignored.

Each notification group has an assigned priority, and the SimConnect server will send events out strictly in the order of priority. No two groups will be set at the same priority. If a request is received for a group to be set at a priority that has already been taken, the group will be assigned the next lowest priority that is available. This includes groups from all the clients that have opened communications with the server.

If a group has an assigned priority above SIMCONNECT_GROUP_PRIORITY_HIGHEST_MASKABLE then it cannot mask events (hide them from other clients). If the group has a priority equal to or below SIMCONNECT_GROUP_PRIORITY_HIGHEST_MASKABLE, then events can be masked (the maskable flag must be set by the SimConnect_AddClientEventToNotificationGroup function to do this). Note that it is possible to mask Prepar3D events, and therefore intercept them before they reach the simulation engine, and perhaps send new events to the simulation engine after appropriate processing has been done. Prepar3D's simulation engine is treated as SimConnect client in this regard, with a priority of SIMCONNECT_GROUP_PRIORITY_DEFAULT.

Input group events work in a similar manner. The priority groups are not combined though, a group and an input group can both have the same priority number. The SimConnect server manages two lists: notification groups and input groups.

A typical use of masking is to prevent Prepar3D itself from receiving an event, in order for the SimConnect client to completely replace the functionality in this case. Another use of masking is with co-operative clients, where there are multiple versions (perhaps a deluxe and standard version, or later and earlier versions), where the deluxe or later version might need to mask events from the other client, if they are both up and running. Prepar3D does not mask any events.

See Also


SimConnect_SetSystemEventState

The SimConnect_SetSystemEventState function is used to turn requests for event information from the server on and off.

Syntax

HRESULT SimConnect_SetSystemEventState(
  HANDLE  hSimConnect,
  SIMCONNECT_CLIENT_EVENT_ID  EventID,
  SIMCONNECT_STATE  dwState
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
EventID
[in]  Specifies the ID of the client event that is to have its state changed.
dwState
[in]  Double word containing the state (one member of SIMCONNECT_STATE).

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Example

See the example and working samples for SimConnect_SubscribeToSystemEvent.

Remarks

If this function is not called, the default is for the state to be on. This is different from input events, which have a default state of off.

Use this function to turn system events temporarily on and off, rather than make multiple calls to SimConnect_SubscribeToSystemEvent and SimConnect_UnsubscribeFromSystemEvent, which is less efficient.

See Also


SimConnect_SetSystemState

The SimConnect_SetSystemState function is used to access a number of Prepar3D system components.

Syntax

HRESULT SimConnect_SetSystemState(
  HANDLE  hSimConnect,
  const char*  szState,
  DWORD  dwInteger,
  float  fFloat,
  char*  szString
);

Parameters

hSimConnect
  Handle to a SimConnect object.
szState
  A null-terminated string identifying the system function. One from the following table:

String Description
DialogMode The dwInteger parameter should be set to 1 to turn Dialog mode on, or 0 to turn it off. Dialog mode enables the display of dialogs when the simulation is running in full-screen mode. When in dialog mode the 3D area of the screen will turn black, and will only revert to the simulation view when Dialog mode is turned off (not automatically when the dialog is closed). See the Working Sample for a simple example.
It is safe to set and reset Dialog mode when the simulation is being run in Windows mode.
Sim It is not possible to set this state, so entering this will result in an exception being returned.
dwInteger
  An integer value, set depending on the value of szState..
fFloat
  A float value, set depending on the value of szState (not currently used).
szString
  A string value, set depending on the value of szState (not currently used).

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Samples

Primary samples DialogBoxMode

Remarks

The integer, float and string set with this function match those in the SIMCONNECT_RECV_SYSTEM_STATE structure (which is returned if the information is requested with the SimConnect_RequestSystemState call.

See Also


SimConnect_SetTrafficSettings

The SimConnect_SetTrafficSettings function is used to set the current traffic settings.

Syntax

HRESULT SimConnect_SetTrafficSettings(
  HANDLE  hSimConnect,
  UINT  uAirlineDensity,
  UINT  uGADensity,
  UINT  uRoadTrafficDensity,
  UINT  uShipsAndFerriesDensity,
  UINT  uLeisureBoatDensity,
  SIMCONNECT_DYNAMIC_FREQUENCY  eAirportVehicleDensity,
  BOOL  bIFROnly
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
uAirlineDensity
[in]  The value that airline traffic density should be set to from 0 to 100.
uGADensity
[in]  The value that general aviation traffic density should be set to from 0 to 100.
uRoadTrafficDensity
[in]  The value that road traffic density should be set to from 0 to 100.
uShipsAndFerries
[in]  The value that ship and ferry traffic density should to be set to from 0 to 100.
uLeisureBoatDensity
[in]  The value that leisure boat traffic density should be set to from 0 to 100.
eAirportVehicleDensity
[in]  The value that airport vehicle traffic density should be set to. See also enumeration SIMCONNECT_DYNAMIC_FREQUENCY.
bIFROnly
[in]  Set to TRUE if only IFR traffic should be present, FALSE otherwise.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Samples

Primary samples None

Remarks

The information requested will be returned in a SIMCONNECT_RECV_TRAFFIC_SETTINGS structure.

See Also


SimConnect_SubscribeToSystemEvent

The SimConnect_SubscribeToSystemEvent function is used to request that a specific system event is notified to the client.

Syntax

HRESULT SimConnect_SubscribeToSystemEvent(
  HANDLE  hSimConnect,
  SIMCONNECT_CLIENT_EVENT_ID  EventID,
  const char*  SystemEventName
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
EventID
[in]  Specifies the client-defined event ID.
SystemEventName
[in]  The string name for the requested system event, which should be one from the following table (note that the event names are not case-sensitive). Unless otherwise stated in the Description, notifications of the event are returned in a SIMCONNECT_RECV_EVENT structure (identify the event from the EventID given with this function).
General System Event Name  
1sec Request a notification every second.
4sec Request a notification every four seconds.
6Hz Request notifications six times per second. This is the same rate that joystick movement events are transmitted.
AircraftLoaded Request a notification when the aircraft flight dynamics file is changed. These files have a .AIR extension. The filename is returned in a SIMCONNECT_RECV_EVENT_FILENAME structure.
Crashed Request a notification if the user aircraft crashes.
CrashReset Request a notification when the crash cut-scene has completed.
FlightLoaded Request a notification when a scenario is loaded. Note that when a scenario is ended, a default scenario is typically loaded, so these events will occur when scenarios are started and finished. The filename of the scenario loaded is returned in a SIMCONNECT_RECV_EVENT_FILENAME structure.
FlightSaved Request a notification when a scenario is saved correctly. The filename of the scenario saved is returned in a SIMCONNECT_RECV_EVENT_FILENAME structure.
FlightPlanActivated Request a notification when a new flight plan is activated. The filename of the activated flight plan is returned in a SIMCONNECT_RECV_EVENT_FILENAME structure.
FlightPlanDeactivated Request a notification when the active flight plan is de-activated.
Frame Request notifications every visual frame. Information is returned in a SIMCONNECT_RECV_EVENT_FRAME structure.
Pause Request notifications when the scenario is paused or unpaused, and also immediately returns the current pause state (1 = paused or 0 = unpaused). The state is returned in the dwData parameter.
Paused Request a notification when the scenario is paused.
PauseFrame Request notifications for every visual frame that the simulation is paused. Information is returned in a SIMCONNECT_RECV_EVENT_FRAME structure.
PositionChanged Request a notification when the user changes the position of their aircraft through a dialog.
Sim Request notifications when the scenario is running or not, and also immediately returns the current state (1 = running or 0 = not running). The state is returned in the dwData parameter.
SimStart The simulator is running. Typically the user is actively controlling the vehicle which is on the ground, underwater or in the air.
SimStop The simulator is not running. Typically the user is loading a scenario, navigating the user interface or in a dialog.
Sound Requests a notification when the master sound switch is changed. This request will also return the current state of the master sound switch immediately. A flag is returned in the dwData parameter, 0 if the switch is off, SIMCONNECT_SOUND_SYSTEM_EVENT_DATA_MASTER (0x1) if the switch is on.
Unpaused Request a notification when the scenario is un-paused.
View Requests a notification when the user aircraft view is changed. This request will also return the current view immediately. A flag is returned in the dwData parameter, one of:
SIMCONNECT_VIEW_SYSTEM_EVENT_DATA_COCKPIT_2D
SIMCONNECT_VIEW_SYSTEM_EVENT_DATA_COCKPIT_VIRTUAL
SIMCONNECT_VIEW_SYSTEM_EVENT_DATA_ORTHOGONAL (the map view).
WeatherModeChanged Request a notification when the weather mode is changed.
AI Specific Event Name  
ObjectAdded Request a notification when an AI object is added to the simulation. Refer also to the SIMCONNECT_RECV_EVENT_OBJECT_ADDREMOVE structure.
ObjectRemoved Request a notification when an AI object is removed from the simulation. Refer also to the SIMCONNECT_RECV_EVENT_OBJECT_ADDREMOVE structure.
Mission Specific Event Name  
MissionCompleted Request a notification when the user has completed a scenario. Refer also to the SIMCONNECT_MISSION_END enum.
CustomMissionActionExecuted Request a notification when a scenario action has been executed. Refer also to the SimConnect_CompleteCustomMissionAction function.
FlightSegmentReadyForGrading Request a notification when a Flight Segment has been completed and is ready for grading.
Multiplayer Racing Event Name  
MultiplayerClientStarted Used by a client to request a notification that they have successfully joined a multiplayer race. The event is returned as a SIMCONNECT_RECV_EVENT_MULTIPLAYER_CLIENT_STARTED structure. This event is only sent to the client, not the host of the session.
MultiplayerServerStarted Used by a host of a multiplayer race to request a notification when the race is open to other players in the lobby. The event is returned in a SIMCONNECT_RECV_EVENT_MULTIPLAYER_SERVER_STARTED structure.
MultiplayerSessionEnded Request a notification when the multiplayer race session is terminated. The event is returned in a SIMCONNECT_RECV_EVENT_MULTIPLAYER_SESSION_ENDED structure. If a client player leaves a race, this event will be returned just to the client. If a host leaves or terminates the session, then all players will receive this event. This is the only event that will be broadcast to all players.
RaceEnd Request a notification of the race results for each racer. The results will be returned in SIMCONNECT_RECV_EVENT_RACE_END structures, one for each player.
RaceLap Request a notification of the race results for each racer. The results will be returned in SIMCONNECT_RECV_EVENT_RACE_LAP structures, one for each player.
Recorder Specific Event Name  
PlaybackStateChanged Request a notification when the state of Prepar3D playback changes. Either playback has started or ended. Information is returned in a SIMCONNECT_RECV_PLAYBACK_STATE_CHANGED structure.
RecorderStateChanged Request a notification when the state of Prepar3D recording changes. Either recording has started or ended. Information is returned in a SIMCONNECT_RECV_RECORDER_STATE_CHANGED structure.
Weapon System Event Name PROFESSIONAL PLUS ONLY
WeaponFired Request a notification when a detachable weapon is fired. Refer also to the SIMCONNECT_RECV_EVENT_WEAPON structure.
WeaponDetonated Request a notification when a detachable weapon is detonated or destroyed. Refer also to the SIMCONNECT_RECV_EVENT_WEAPON structure.
CountermeasureFired Request a notification when a countermeasure is deployed. Refer also to the SIMCONNECT_RECV_EVENT_COUNTERMEASURE structure.
ObjectDamagedByWeapon Request a notification when an object is damaged by a weapon. Refer also to the SIMCONNECT_RECV_EVENT_OBJECT_DAMAGED_BY_WEAPON structure.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Example


static enum EVENT_ID {
   EVENT_FLIGHT_LOAD,
   EVENT_RECUR_1SEC,
   EVENT_RECUR_FRAME,
};
hr = SimConnect_SubscribeToSystemEvent(hSimConnect, EVENT_FLIGHT_LOAD, "FlightLoaded");
hr = SimConnect_SubscribeToSystemEvent(hSimConnect, EVENT_RECUR_1SEC,  "1sec");
hr = SimConnect_SubscribeToSystemEvent(hSimConnect, EVENT_RECUR_FRAME, "frame");

// The recurring events will be on by default, so set one of them to off.
hr = SimConnect_SetSystemEventState(hSimConnect, EVENT_RECUR_FRAME, SIMCONNECT_STATE_OFF);

Working Samples

Primary samples Mission Action
System Event
Reference samples Many of the other samples implement this function.

Remarks

A single call to this function is all that is necessary to receive the notifications. For greatest efficiency use SimConnect_SetSystemEventState to turn these requests on and off temporarily, and call SimConnect_UnsubscribeFromSystemEvent once only to permanently terminate the notifications of these events.

See Also


SimConnect_SubscribeToSystemEventEx

The SimConnect_SubscribeToSystemEventEx function is used to request that a specific system event is notified to the client. The Ex specific version of the function adds a Flags parameter.

Syntax

HRESULT SimConnect_SubscribeToSystemEventEx(
  HANDLE  hSimConnect,
  SIMCONNECT_CLIENT_EVENT_ID  EventID,
  const char*  SystemEventName,
  SIMCONNECT_EVENT_SUBSCRIPTION_FLAG  Flags
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
EventID
[in]  Specifies the client-defined event ID.
SystemEventName
[in]  The string name for the requested system event, which should be one from the following table (note that the event names are not case-sensitive). Unless otherwise stated in the Description, notifications of the event are returned in a SIMCONNECT_RECV_EVENT structure (identify the event from the EventID given with this function).
Flags
[in]  One or more of the following flags.
Flags Description
SIMCONNECT_EVENT_SUBSCRIPTION_FLAG_BLOCK Specifies that a blocking callback will be used when this system event occurs. See SimConnect_RequestSynchronousBlock for more information.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

See SimConnect_SubscribeToSystemEvent for description of other parameters.

See Also


SimConnect_TransmitClientEvent

The SimConnect_TransmitClientEvent function is used to request that the Prepar3D server transmit to all SimConnect clients the specified client event.

Syntax

HRESULT SimConnect_TransmitClientEvent(
  HANDLE  hSimConnect,
  SIMCONNECT_OBJECT_ID  ObjectID,
  SIMCONNECT_CLIENT_EVENT_ID  EventID,
  DWORD  dwData,
  SIMCONNECT_NOTIFICATION_GROUP_ID  GroupID,
  SIMCONNECT_EVENT_FLAG  Flags
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
ObjectID
[in]  Specifies the ID of the server defined object. If this parameter is set to SIMCONNECT_OBJECT_ID_USER, then the transmitted event will be sent to the other clients in priority order. If this parameters contains another object ID, then the event will be sent direct to that sim-object, and no other clients will receive it.
EventID
[in]  Specifies the ID of the client event.
dwData
[in]  Double word containing any additional number required by the event. This is often zero. If the event is a Prepar3D event, then refer to the Event IDs document for information on this additional value. If the event is a custom event, then any value put in this parameter will be available to the clients that receive the event.
GroupID
[in]  The default behavior is that this specifies the GroupID of the event. The SimConnect server will use the priority of this group to send the message to all clients with a lower priority. To receive the event notification other SimConnect clients must have subscribed to receive the event.  See the explanation of SimConnect Priorities. The exception to the default behavior is set by the SIMCONNECT_EVENT_FLAG_GROUPID_IS_PRIORITY flag, described below.
Flags
[in] One or more of the following flags:



NOTE: For panel control you must specify a group priority of 0.

Flag Description
0 Do nothing.
SIMCONNECT_EVENT_FLAG_SLOW_REPEAT_TIMER The flag will effectively reset the repeat timer to simulate slow repeat. Use this flag to reset the repeat timer that works with various keyboard events and mouse clicks.
SIMCONNECT_EVENT_FLAG_FAST_REPEAT_TIMER The flag will effectively reset the repeat timer to simulate fast repeat.
SIMCONNECT_EVENT_FLAG_GROUPID_IS_PRIORITY
Indicates to the SimConnect server to treat the GroupID as a priority value. If this flag is set, and the GroupID parameter is set to SIMCONNECT_GROUP_PRIORITY_HIGHEST then all client notification groups that have subscribed to the event will receive the notification (unless one of them masks it). The event will be transmitted to clients starting at the priority specified in the GroupID parameter, though this can result in the client that transmitted the event, receiving it again.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Examples


// 1. Transmitting a custom event to other clients
static enum EVENT_ID {
 EVENT_MY_EVENT
 EVENT_DME
 EVENT_OPEN_PANEL
};
hr = SimConnect_MapClientEventToSimEvent(hSimConnect, EVENT_MY_EVENT, "Custom.Event");
// Send EVENT_MY_EVENT to all current SimConnect clients.
SimConnect_TransmitClientEvent(hSimConnect, 0, EVENT_MY_EVENT, 0, SIMCONNECT_GROUP_PRIORITY_HIGHEST, SIMCONNECT_EVENT_FLAG_GROUPID_IS_PRIORITY);

// 2. Setting an event value
hr = SimConnect_MapClientEventToSimEvent(hSimConnect, EVENT_DME, "DME_SELECT");
// Set the selected DME to 2
SimConnect_TransmitClientEvent(hSimConnect, 0, EVENT_DME, 2, SIMCONNECT_GROUP_PRIORITY_DEFAULT, SIMCONNECT_EVENT_FLAG_GROUPID_IS_PRIORITY);

NOTE: For panel control you must specify a group priority of 0.

SimConnect_TransmitClientEvent(hSimConnect, 0, EVENT_OPEN_PANEL, 0, 0, SIMCONNECT_EVENT_FLAG_GROUPID_IS_PRIORITY);

Working Sample

Primary sample Send Event A

Remarks

Typically use this function to transmit an event to other SimConnect clients, including the simulation engine, although the client that transmits the event can also receive it. The order in which client notification groups are informed of the event is determined by the priority of each group. The higher the priority of the group, the earlier it will receive the event notification. Refer to the explanation of the maskable parameter for the SimConnect_AddClientEventToNotificationGroup call, which describes when the event may be masked and not transmitted to lower priority groups.  Also see the explanation of SimConnect Priorities.

See Also


SimConnect_UnsubscribeFromSystemEvent

The SimConnect_UnsubscribeFromSystemEvent function is used to request that notifications are no longer received for the specified system event.

Syntax

HRESULT SimConnect_UnsubscribeFromSystemEvent(
  HANDLE  hSimConnect,
  SIMCONNECT_CLIENT_EVENT_ID  EventID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
EventID
[in]  Specifies the client-defined event ID.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Example


static enum EVENT_ID {
   EVENT_FLIGHT_LOAD,
   EVENT_RECUR_1SEC,
   EVENT_RECUR_FRAME,
};

hr = SimConnect_SubscribeToSystemEvent(hSimConnect, EVENT_RECUR_1SEC);
...
hr = SimConnect_UnsubscribeFromSystemEvent(hSimConnect, EVENT_RECUR_1SEC);

Remarks

There is no limit to the number of system events that can be subscribed to, but use this function to improve performance when a system event notification is no longer needed.

See Also


Helper Functions

SimConnect_InsertString

The SimConnect_InsertString function is used to assist in adding variable length strings to a structure.

Syntax

HRESULT SimConnect_InsertString(
  char*  pDest,
  DWORD  cbDest,
  void**  ppEnd,
  DWORD*  pcbStringV,
  const char*  pSource
);

Parameters

pDest
[in]  Pointer to where the source string is to be written in the destination object.
cbDest
[in]  The size of the remaining space in the destination object.
ppEnd
[in,out]  Pointer to a pointer, (usually a pointer to a char pointer). On return the pointer locates the end of the string in the structure, and hence the starting position for any other string to be included in the structure.
pcbStringV
[in,out]  Pointer to a DWORD. On returning this DWORD will contain the size of the source string in bytes.
pSource
[in]  Pointer to the source string.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

This function does not communicate with the SimConnect server, but is a helper function to assist in the handling of variable length strings. Its counterpart is the SimConnect_RetrieveString function.

See Also


SimConnect_RequestResponseTimes

The SimConnect_RequestResponseTimes function is used to provide some data on the performance of the client-server connection.

Syntax

HRESULT SimConnect_RequestResponseTimes(
  HANDLE  hSimConnect,
  DWORD  nCount,
  float*  fElapsedSeconds
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
nCount
[in]  Integer containing the number of elements in the array of floats. This should be set to five for the full range of timings, but can be less if only the first few are of interest. There is no point creating an array of greater than five floats.
fElapsedSeconds
[in]  An array of nCount floats, containing the times. The five elements will contain the following: 0 - total round trip time, 1 - time from the request till the packet is sent, 2 - time from the request till the packet is received by the server, 3 - time from the request till the response is made by the server, 4 - time from the server response to the client receives the packet.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Example

int quit = 0;
bool fTesting = true;
....
while( quit == 0 )
{
 hr = SimConnect_CallDispatch(hSimConnect, MyDispatchProc, NULL);
  Sleep(0);
  if (fTesting)
  {
    fTesting = false;
    float fElapsedSeconds[5];
    hr = SimConnect_RequestResponseTimes(hSimConnect, 5, &fElapsedSeconds[0]);
    \\ Enter code to display the contents of fElapsedSeconds
  }
}

Remarks

This function should not be used as part of  a final application, as it is costly in performance, but is available to help provide some performance data that can be used while building an testing a client application.

See Also


SimConnect_RetrieveString

The SimConnect_RetrieveString function is used to assist in retrieving variable length strings from a structure.

Syntax

HRESULT SimConnect_RetrieveString(
  SIMCONNECT_RECV*  pData,
  DWORD  cbData,
  void*  pStringV,
  char**  ppszString,
  DWORD*  pcbString
);

Parameters

pData
[in]  Pointer to a SIMCONNECT_RECV structure, containing the data.
cbData
[in]  The size of the structure that inherits the SIMCONNECT_RECV structure, in bytes.
pStringV
[in]  Pointer to a the start of the variable length string within the structure.
ppszString
[in, out]  Specifies a pointer to a pointer to a character buffer that should be large enough to contain the maximum length of string that might be returned. On return this buffer should contain the retrieved string.
pcbString
[in, out]  Pointer to a DWORD. On return this contains the length of the string in bytes.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Example

struct StructVS {
  char title[1];
}
StructVS *pS = (StructVS*)&pObjData->dwData;
char *psztitle;
DWORD cbtitle;
hr = SimConnect_RetrieveString(pData, cbData, &pS->strings, &psztitle, &cbtitle)))

Working Sample

Primary sample Variable Strings

Remarks

This function does not communicate with the SimConnect server, but is a helper function to assist in the handling of variable length strings. Its counterpart is the SimConnect_InsertString function. Note that this function works in the case where an empty string is in the structure returned by the server.

See Also


AI Object Specific Functions

SimConnect_AICreateEnrouteATCAircraft

The SimConnect_AICreateEnrouteATCAircraft function is used to create an AI controlled aircraft that is about to start or is already underway on its flight plan.

Syntax

HRESULT SimConnect_AICreateEnrouteATCAircraft(
  HANDLE  hSimConnect,
  const char*  szContainertitle,
  const char*  szTailNumber,
  int  iFlightNumber,
  const char*  szFlightPlanPath,
  double  dFlightPlanPosition,
  BOOL  bTouchAndGo,
  SIMCONNECT_DATA_REQUEST_ID  RequestID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szContainertitle
[in]  Null-terminated string containing the container title. The container title is found in the aircraft.cfg file (see the Aircraft Configuration Files document): for example: title=Airbus A321, or title= Aircreation582SL.
szTailNumber
[in]  Null-terminated string containing the tail number. This should have a maximum of 12 characters.
iFlightNumber
[in]  Integer containing the flight number. There is no specific maximum length of this number. Any negative number indicates that there is no flight number.
szFlightPlanPath
[in]  Null-terminated string containing the path to the flight plan file. Flight plans have the extension .pln, but no need to enter an extension here. The easiest way to create flight plans is to create them from within Prepar3D itself, and then save them off for use with the AI controlled aircraft. There is no need to enter the full path to the file (just enter the filename) if the flight plan is in the default Prepar3D v3 Files directory.
dFlightPlanPosition
[in]  Double floating point number containing the flight plan position. The number before the point contains the waypoint index, and the number afterwards how far along the route to the next waypoint the aircraft is to be positioned. The first waypoint index is 0. For example, 0.0 indicates that the aircraft has not started on the flight plan, 2.5 would indicate the aircraft is to be initialized halfway between the third and fourth waypoints (which would have indexes 2 and 3). The waypoints are those recorded in the flight plan, which may just be two airports, and do not include any taxiway points on the ground. Also there is a threshold that will ignore requests to have an aircraft taxiing or taking off, or landing. So set the value after the point to ensure the aircraft will be in level flight. See the section on Aircraft Flight Plans.
bTouchAndGo
[in]  Flag, True indicating that landings should be touch and go, and not full stop landings.
RequestID
[in]  Specifies the client defined request ID.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Sample

Primary sample AI Traffic

Remarks

An enroute aircraft can be on the ground or airborne when it is created by this function. Typically this will be an aircraft flying under IFR rules, and in constant radio contact with ATC. A number of errors, including SIMCONNECT_EXCEPTION_CREATE_AIRCRAFT_FAILED, apply to AI objects (refer to the SIMCONNECT_EXCEPTION enum for more details).

A SIMCONNECT_RECV_ID_EVENT_OBJECT_ADDREMOVE event notification can be subscribed to (see the SimConnect_SubscribeToSystemEvent function), which will return a SIMCONNECT_RECV_EVENT_OBJECT_ADDREMOVE structure whenever any client, including the one making the change, successfully adds or removes an AI controlled object.

This function should be used for fixed-wing aircraft flying between airports on land. There is no internal AI pilot for helicopters, gliders or hot-air balloons. In order to add a helicopter, glider or balloon not controlled by the user, the SimConnect client must implement full control of the aircraft. Set up these objects with a call to SimConnect_AICreateSimulatedObject.

For float-planes the recommended procedure is to control them using waypoints, and not the ATC system, as there is no concept of a "parking space" after a water landing. So, the waypoints of the route of the float-plane should include the route that it should follow before takeoff and after landing. For all these cases of controlling aircraft using the client, or using waypoints, set up the object using the SimConnect_AICreateNonATCAircraft call.

The Reality Bubble

In order to improve performance, only a certain area around the user's aircraft is actually simulated at any one time. As the user flies the aircraft that area (referred to in the simulator as the "reality bubble") moves along with the aircraft. Simulated objects outside of the area are removed altogether, and new AI aircraft are not created if they fall outside these bounds. The reality bubble is in fact more of a box, and is aligned to lines of latitude and longitude, so the box becomes narrower near the poles than it is as the equator. The following diagram shows how the reality bubble works. There are always nine boxes (approximately 64Km square at the equator) that are simulated, and the user aircraft is always in the center box. As the aircraft flies over a boundary line, then the areas that are simulated change. In the following diagram, the green areas are simulated (active aircraft, airports, ground vehicles, shipping traffic and so on), and the grey areas are not.

Reality1
Reality2

Note that if an aircraft, or other simulation object, falls outside this area and is deleted by the system, the client will no longer receive information on the object (typically requested by the SimConnect_RequestDataOnSimObject function). Consider using the SimConnect_SubscribeToSystemEvent function to request notifications for "ObjectRemoved" to test for these situations. No automatic notification is given when information is requested on an object, and then subsequently that object is removed.

Aircraft Flight Plans

The following table contains an example flight plan from Sea-Tac International airport (KSEA) to San Francisco International airport (KSFO), following high-altitude airways. There are six waypoints, including the departure and destination airports. A flight plan can be created by Prepar3D or created directly in XML, matching the required format. The simplest flight plan will contain only the departure and destination airports. The ATCWaypoints in a scenario file are not identical to the SIMCONNECT_DATA_WAYPOINT structures. ATCWaypoints in a flightplan can be very far apart, and the AI pilot of Prepar3D requires waypoints to be no more than around five miles apart, so a flightplan such as the one given below will be broken down by the AI component into shorter sections -- using the SIMCONNECT_DATA_WAYPOINT structures.

<?xml version="1.0" encoding="UTF-8"?>

<SimBase.Document Type="AceXML" version="1,0">
    <Descr>AceXML Document</Descr>
    <WorldBase.FlightPlan>
        <title>KSEA to KSFO</title>
        <FPType>IFR</FPType>
        <RouteType>HighAlt</RouteType>
        <CruisingAlt>31000</CruisingAlt>
        <DepartureID>KSEA</DepartureID>
        <DepartureLLA>N47 25' 53.27",W122 18' 28.83",+000433.00</DepartureLLA>
        <DestinationID>KSFO</DestinationID>
        <DestinationLLA>N37 36' 26.00",W122 22' 49.59",+000013.00</DestinationLLA>
        <Descr>KSEA, KSFO</Descr>
        <DeparturePosition>34R</DeparturePosition>
        <DepartureName>Seattle-Tacoma Intl</DepartureName>
        <DestinationName>San Francisco Intl</DestinationName>
        <AppVersion>
            <AppVersionMajor>10</AppVersionMajor>
            <AppVersionBuild>60327</AppVersionBuild>
        </AppVersion>

        <ATCWaypoint id="KSEA">
            <ATCWaypointType>Airport</ATCWaypointType>
            <WorldPosition>N47 25' 53.27",W122 18' 28.83",+000433.00</WorldPosition>
            <ICAO>
                <ICAOIdent>KSEA</ICAOIdent>
            </ICAO>
        </ATCWaypoint>

        <ATCWaypoint id="SEA">
            <ATCWaypointType>VOR</ATCWaypointType>
            <WorldPosition>N47 26' 7.36",W122 18' 34.59",+000000.00</WorldPosition>
            <ICAO>
                <ICAORegion>K1</ICAORegion>
                <ICAOIdent>SEA</ICAOIdent>
            </ICAO>
        </ATCWaypoint>

        <ATCWaypoint id="LMT">
            <ATCWaypointType>VOR</ATCWaypointType>
            <WorldPosition>N42 9' 11.34",W121 43' 39.10",+000000.00</WorldPosition>
            <ATCAirway>J65</ATCAirway>
            <ICAO>
                <ICAORegion>K1</ICAORegion>
                <ICAOIdent>LMT</ICAOIdent>
            </ICAO>
        </ATCWaypoint>

        <ATCWaypoint id="RBL">
            <ATCWaypointType>VOR</ATCWaypointType>
            <WorldPosition>N40 5' 56.07",W122 14' 10.88",+000000.00</WorldPosition>
            <ATCAirway>J65</ATCAirway>
            <ICAO>
                <ICAORegion>K2</ICAORegion>
                <ICAOIdent>RBL</ICAOIdent>
            </ICAO>
        </ATCWaypoint>

        <ATCWaypoint id="OAK">
            <ATCWaypointType>VOR</ATCWaypointType>
            <WorldPosition>N37 43' 33.30",W122 13' 24.92",+000000.00</WorldPosition>
            <ATCAirway>J3</ATCAirway>
            <ICAO>
                <ICAORegion>K2</ICAORegion>
                <ICAOIdent>OAK</ICAOIdent>
            </ICAO>
        </ATCWaypoint>

        <ATCWaypoint id="KSFO">
            <ATCWaypointType>Airport</ATCWaypointType>
            <WorldPosition>N37 36' 26.00",W122 22' 49.59",+000013.00</WorldPosition>
            <ICAO>
                <ICAOIdent>KSFO</ICAOIdent>
            </ICAO>
        </ATCWaypoint>

    </WorldBase.FlightPlan>
</SimBase.Document>

See Also


SimConnect_AICreateNonATCAircraft

The SimConnect_AICreateNonATCAircraft function is used to create an aircraft that is not flying under ATC control (so is typically flying under VFR rules).

Syntax

HRESULT SimConnect_AICreateNonATCAircraft(
  HANDLE  hSimConnect,
  const char*  szContainertitle,
  const char*  szTailNumber,
  SIMCONNECT_DATA_INITPOSITION  InitPos,
  SIMCONNECT_DATA_REQUEST_ID  RequestID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szContainertitle
[in]  Null-terminated string containing the container title. The container title is case-sensitive and can be found in the aircraft.cfg file (see the Aircraft Configuration Files document): for example: title=Airbus A321, or title= Aircreation582SL,.
szTailNumber
[in]  Null-terminated string containing the tail number. This should have a maximum of 12 characters.
InitPos
[in]  Specifies the initial position, using a SIMCONNECT_DATA_INITPOSITION structure.
RequestID
[in]  Specifies the client defined request ID.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Sample

Primary sample AI Objects and Waypoints
Managed AI Waypoints

Remarks

A non-ATC aircraft can be on the ground or airborne when it is created by this function. A number of errors, including SIMCONNECT_EXCEPTION_CREATE_AIRCRAFT_FAILED, apply to AI objects (refer to the SIMCONNECT_EXCEPTION enum for more details).

Refer to the remarks for SimConnect_AICreateEnrouteATCAircraft.

See Also


SimConnect_AICreateParkedATCAircraft

The SimConnect_AICreateParkedATCAircraft function is used to create an AI controlled aircraft that is currently parked and does not have a flight plan.

Syntax

HRESULT SimConnect_AICreateParkedATCAircraft(
  HANDLE  hSimConnect,
  const char*  szContainertitle,
  const char*  szTailNumber,
  const char*  szAirportID,
  SIMCONNECT_DATA_REQUEST_ID  RequestID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szContainertitle
[in]  Null-terminated string containing the container title. The container title is case-sensitive and can found in the aircraft.cfg file (see the Aircraft Configuration Files document): for example: title=Airbus A321, or title= Aircreation582SL.
szTailNumber
[in]  Null-terminated string containing the tail number. This should have a maximum of 12 characters.
szAirportID
[in]  Null-terminated string containing the airport ID. This is the ICAO identification string, for example, KSEA for SeaTac International.
RequestID
[in]  Specifies the client defined request ID.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Sample

Primary sample AI Traffic

Remarks

Calling this function is no guarantee that there is sufficient parking space at the specified airport. An error will be returned if there is insufficient parking space, and an aircraft will not be created. A number of errors, including SIMCONNECT_EXCEPTION_CREATE_AIRCRAFT_FAILED, apply to AI objects (refer to the SIMCONNECT_EXCEPTION enum for more details). After creating an aircraft with this function, a call to SimConnect_AISetAircraftFlightPlan will set the aircraft in motion.

When allocating a parking space to an aircraft, the simulation uses a radius based on half the wingspan defined in the [aircraft_geometry] section of the Aircraft Configuration File. Use the Dump Airport List tool (refer to the Traffic Toolbox documentation) to see what parking spaces are available at any airport.

Refer also to the remarks for SimConnect_AICreateEnrouteATCAircraft.

See Also


SimConnect_AICreateSimulatedObject

The SimConnect_AICreateSimulatedObject function is used to create AI controlled objects other than aircraft.

Syntax

HRESULT SimConnect_AICreateSimulatedObject(
  HANDLE  hSimConnect,
  const char*  szContainertitle,
  SIMCONNECT_DATA_INITPOSITION  InitPos,
  SIMCONNECT_DATA_REQUEST_ID  RequestID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szContainertitle
[in]  Null-terminated string containing the container title. The container title is case-sensitive and can be found in the sim.cfg file, for example:
Object Types Examples
Ground Vehicles title=Automobile
title=FuelTruck
title=VEH_air_bagcart1
title=VEH_air_bagcart_FlatNosed
Boats title=cargoA
title=cargoA_hoop
title=cargoB
Miscellaneous title=Flour_bomb_floating_dock
title=HumpbackWhale
InitPos
[in]  Specifies the initial position, using a SIMCONNECT_DATA_INITPOSITION structure.
RequestID
[in]  Specifies the client defined request ID.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Sample

Primary sample AI Objects and Waypoints
Managed AI Waypoints

Remarks

This function can be used to create a stationary aircraft (such as an unflyable aircraft on display outside a flight museum), but is typically intended to create simulation objects other than aircraft (such as ground vehicles, boats, and a number of special objects such as humpback whales and hot-air balloons). A number of errors apply to AI objects (refer to the SIMCONNECT_EXCEPTION enum for more details).

See Also


SimConnect_AICreateSimulatedObjectEx

The SimConnect_AICreateSimulatedObjectEx function is used to create AI controlled objects other than aircraft.

Syntax

HRESULT SimConnect_AICreateSimulatedObjectEx(
  HANDLE  hSimConnect,
  const char*  szContainertitle,
  SIMCONNECT_DATA_INITPOSITION  InitPos,
  SIMCONNECT_DATA_REQUEST_ID  RequestID
  BOOL  isDisabled = FALSE
  int  OwnerID = -1
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szContainertitle
[in]  Null-terminated string containing the container title. The container title is case-sensitive and can be found in the sim.cfg file, for example:
Object Types Examples
Ground Vehicles title=Automobile
title=FuelTruck
title=VEH_air_bagcart1
title=VEH_air_bagcart_FlatNosed
Boats title=cargoA
title=cargoA_hoop
title=cargoB
Miscellaneous title=Flour_bomb_floating_dock
title=HumpbackWhale
InitPos
[in]  Specifies the initial position, using a SIMCONNECT_DATA_INITPOSITION structure.
RequestID
[in]  Specifies the client defined request ID.

isDisabled
[in, optional]  Specifies whether the simulation starts disabled or not default value is FALSE.

OwnerID
[in, optional]  Specifies the owner of this simualted object. Default value is -1 which is an invalid object ID.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Sample

Primary sample AI Objects and Waypoints
Managed AI Waypoints

Remarks

This function can be used to create a stationary aircraft (such as an unflyable aircraft on display outside a flight museum), but is typically intended to create simulation objects other than aircraft (such as ground vehicles, boats, and a number of special objects such as humpback whales and hot-air balloons). A number of errors apply to AI objects (refer to the SIMCONNECT_EXCEPTION enum for more details).

See Also


SimConnect_AIReleaseControl

The SimConnect_AIReleaseControl function is used to clear the AI control of a simulated object, typically an aircraft, in order for it to be controlled by a SimConnect client.

Syntax

HRESULT SimConnect_AIReleaseControl(
  HANDLE  hSimConnect,
  SIMCONNECT_OBJECT_ID  ObjectID,
  SIMCONNECT_DATA_REQUEST_ID  RequestID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
ObjectID
[in]  Specifies the server defined object ID.
RequestID
[in]  Specifies the client defined request ID.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

This function should be used to transfer the control of an aircraft, or other object, from the AI system to the SimConnect client. If this is not done the AI system and client may fight each other with unpredictable results. To prevent the simulation engine from updating the latitude, longitude, altitude and attitude of an aircraft, refer to the range of KEY_FREEZE..... Event IDs.

The object ID can be obtained in a number of ways, refer to the SimConnect_RequestDataOnSimObjectType call, and also the use of the SIMCONNECT_RECV_ASSIGNED_OBJECT_ID structure.

See Also


SimConnect_AIReleaseControlEx

The SimConnect_AIReleaseControlEx function is used to clear the AI control of a simulated object, typically an aircraft, in order for it to be controlled by a SimConnect client. Optionally, this function can be used to completely remove the AI instead of clearing it. Removing the AI will allow for complete manual control of a SimConnect SimObject.

Syntax

HRESULT SimConnect_AIReleaseControlEx(
  HANDLE  hSimConnect,
  SIMCONNECT_OBJECT_ID  ObjectID,
  SIMCONNECT_DATA_REQUEST_ID  RequestID
  BOOL  destroyAI = FALSE
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
ObjectID
[in]  Specifies the server defined object ID.
RequestID
[in]  Specifies the client defined request ID.

destroyAI
[in, optional]  Specifies whether to destory the AI or not (default value = FALSE).

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

This function should be used to transfer the control of an aircraft, or other object, from the AI system to the SimConnect client. If this is not done the AI system and client may fight each other with unpredictable results. To prevent the simulation engine from updating the latitude, longitude, altitude and attitude of an aircraft, refer to the range of KEY_FREEZE..... Event IDs.

The object ID can be obtained in a number of ways, refer to the SimConnect_RequestDataOnSimObjectType call, and also the use of the SIMCONNECT_RECV_ASSIGNED_OBJECT_ID structure.

See Also


SimConnect_AIRemoveObject

The SimConnect_AIRemoveObject function is used to remove any object created by the client using one of the SimConnect AI creation functions.

Syntax

HRESULT SimConnect_AIRemoveObject(
  HANDLE  hSimConnect,
  SIMCONNECT_OBJECT_ID  ObjectID,
  SIMCONNECT_DATA_REQUEST_ID  RequestID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
ObjectID
[in]  Specifies the server defined object ID (refer to the SIMCONNECT_RECV_ASSIGNED_OBJECT_ID structure).
RequestID
[in]  Specifies the client defined request ID.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

A client application can only remove AI controlled objects that it created, not objects created by other clients, or by the simulation itself.

See Also


SimConnect_AISetAircraftFlightPlan

The SimConnect_AISetAircraftFlightPlan function is used to set or change the flight plan of an AI controlled aircraft.

Syntax

HRESULT SimConnect_AISetAircraftFlightPlan(
  HANDLE  hSimConnect,
  SIMCONNECT_OBJECT_ID  ObjectID,
  const char*  szFlightPlanPath,
  SIMCONNECT_DATA_REQUEST_ID  RequestID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
ObjectID
[in]  Specifies the server defined object ID.
szFlightPlanPath
[in]  Null-terminated string containing the path to the flight plan file. Flight plans have the extension .pln, but no need to enter an extension here. The easiest way to create flight plans is to create them from within the simulation, and then save them off for use with the AI controlled aircraft. There is no need to enter the full path (just the filename) if the flight plan is in the default Prepar3D v3 Files directory. See the section on Aircraft Flight Plans.
RequestID
[in]  Specifies client defined request ID.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Sample

Primary sample AI Traffic

Remarks

A number of errors, including SIMCONNECT_EXCEPTION_CREATE_FLIGHTPLAN_FAILED, apply to AI objects (refer to the SIMCONNECT_EXCEPTION enum for more details).

Typically this function would be used some time after the aircraft was created using the SimConnect_AICreateParkedATCAircraft call.

See Also


SimConnect_AISetGroundClamp

The SimConnect_AISetGroundClamp function is used to enable/disable ground clamping on a SimConnect owned SimObject.

Syntax

HRESULT SimConnect_AISetGroundClamp(
  HANDLE  hSimConnect,
  SIMCONNECT_OBJECT_ID  ObjectID,
  BOOL  bGroundClamp,
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
ObjectID
[in]  Specifies the server defined object ID.
bGroundClamp
[in]  Boolean value that specifies if Ground Clamping should be enabled or disabled for the specified ObjectID. Ground Clamping keeps the object from being pushed below ground level.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


Camera Specific Functions

SimConnect_CameraSetRelative6DOF

The SimConnect_CameraSetRelative6DOF function is used to adjust the user's aircraft view camera.

Syntax

HRESULT SimConnect_CameraSetRelative6DOF(
  HANDLE  hSimConnect,
  float  fDeltaX,
  float  fDeltaY,
  float  fDeltaZ,
  float  fPitchDeg,
  float  fBankDeg,
  float  fHeadingDeg
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
fDeltaX
[in]  Float containing the delta in the x-axis from the eyepoint reference point. See the [views] section of the Aircraft Configuration Files document for a description of the eyepoint.
fDeltaY
[in]  Float containing the delta in the y-axis from the eyepoint reference point.
fDeltaZ
[in]  Float containing the delta in the z-axis from the eyepoint reference point.
fPitchDeg
[in]  Float containing the pitch in degrees (rotation about the x axis). A positive value points the nose down, a negative value up. The range of allowable values is +90 to -90 degrees.
fBankDeg
[in]  Float containing the bank angle in degrees (rotation about the z axis). The range of allowable values is +180 to -180 degrees.
fHeadingDeg
[in]  Float containing the heading in degrees (rotation about the y axis). A positive value rotates the view right, a negative value left. If the user is viewing the 2D cockpit, the view will change to the Virtual Cockpit 3D view if the angle exceeds 45 degrees from the view ahead. The Virtual Cockpit view will change back to the 2D cockpit view if the heading angle drops below 45 degrees. The range of allowable values is +180 to -180 degrees.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Sample

Primary sample Cockpit Camera

Remarks

Any one of the six parameters can be set to SIMCONNECT_CAMERA_IGNORE_FIELD which indicates that the value for the camera should be taken unmodified from the reference point.

See Also


SimConnect_CameraSetRelative6DofByName

The SimConnect_CameraSetRelative6DofByName function is used to adjust the specified view's camera.

Syntax

HRESULT SimConnect_CameraSetRelative6DofByName(
  HANDLE  hSimConnect,
  const char*  szName,
  float  fDeltaX,
  float  fDeltaY,
  float  fDeltaZ,
  float  fPitchDeg,
  float  fBankDeg,
  float  fHeadingDeg
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szName
[in]  The name of the camera. This can either match the window title or the name of the camera definition. If the window title is used only the camera for that window will be modified. If the camera definition name is used and more than one window is open corresponding to that definition than all of those windows will be modified.
fDeltaX
[in]  Float containing the delta in the x-axis from the eyepoint reference point. See the [views] section of the Aircraft Configuration Files document for a description of the eyepoint.
fDeltaY
[in]  Float containing the delta in the y-axis from the eyepoint reference point.
fDeltaZ
[in]  Float containing the delta in the z-axis from the eyepoint reference point.
fPitchDeg
[in]  Float containing the pitch in degrees (rotation about the x axis). A positive value points the nose down, a negative value up. The range of allowable values is +90 to -90 degrees.
fBankDeg
[in]  Float containing the bank angle in degrees (rotation about the z axis). The range of allowable values is +180 to -180 degrees.
fHeadingDeg
[in]  Float containing the heading in degrees (rotation about the y axis). A positive value rotates the view right, a negative value left. If the user is viewing the 2D cockpit, the view will change to the Virtual Cockpit 3D view if the angle exceeds 45 degrees from the view ahead. The Virtual Cockpit view will change back to the 2D cockpit view if the heading angle drops below 45 degrees. The range of allowable values is +180 to -180 degrees.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

Any one of the six parameters can be set to SIMCONNECT_CAMERA_IGNORE_FIELD which indicates that the value for the camera should be taken unmodified from the reference point.

See Also


SimConnect_SetCameraSensorMode

The SimConnect_SetCameraSensorMode function is used to change a specific camera's sensor mode.

Syntax


HRESULT SimConnect_SetCameraSensorMode(
  HANDLE  hSimConnect,
  const char*  szName,
  SIMCONNECT_CAMERA_SENSOR_MODE  eSensorMode
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szName
[in]  The name of the camera. This should equal the camera definition name.
eSensorMode
[in]  The sensor mode.


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_SetMainCameraSensorMode

The SimConnect_SetMainCameraSensorMode function is used to change the main camera's sensor mode.

Syntax


HRESULT SimConnect_SetMainCameraSensorMode(
  HANDLE  hSimConnect,
  SIMCONNECT_CAMERA_SENSOR_MODE  eSensorMode
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
eSensorMode
[in]  The sensor mode.


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_CreateCameraDefinition

The SimConnect_CreateCameraDefinition function is used to create a new camera definition.

Syntax

HRESULT SimConnect_CreateCameraDefinition(
  HANDLE  hSimConnect,
  GUID  guidCamera,
  SIMCONNECT_CAMERA_TYPE  szViewType,
  const char*  sztitle,
  SIMCONNECT_DATA_XYZ  xyzBias,
  SIMCONNECT_DATA_PBH  pbhBias
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
guidCamera
[in]  GUID a unique identifier for a new camera defintion.
szViewType
[in]  The type of view to create. See SIMCONNECT_CAMERA_TYPE.
sztitle
[in]  Null-terminated string containing the title of the camera.
xyzBias
[in]  SIMCONNECT_DATA_XYZ containing the offset from the origin.
pbhBias
[in]  SIMCONNECT_DATA_PBH containing the orientation of the camera.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Samples

Primary samples Camera System

See Also


SimConnect_CreateCameraInstance

The SimConnect_CreateCameraInstance function is used to create a new camera instance based on a camera definition.

Syntax

HRESULT SimConnect_CreateCameraInstance(
  HANDLE  hSimConnect,
  GUID  guidCamera,
  const char*  szName,
  SIMCONNECT_OBJECT_ID  dwObjectID,
  SIMCONNECT_REQUEST_ID  RequestID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
guidCamera
[in]  GUID a unique identifier of a already created camera defintion.
szName
[in]  Null-terminated string containing the name of the camera instance.
dwObjectID
[in]  SIMCONNECT_OBJECT_ID containing the objectID of the SimObject to attach to the camera. Used with SIMCONNECT_CAMERA_TYPE SIMCONNECT_CAMERA_TYPE_OBJECT_AI_VIRTUAL.
RequestID
[in]  SIMCONNECT_REQUEST_ID containing the request ID.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Samples

Primary samples Camera System

See Also


SimConnect_DeleteCameraInstance

The SimConnect_DeleteCameraInstance function is used to remove a camera instance.

Syntax

HRESULT SimConnect_DeleteCameraInstance(
  HANDLE  hSimConnect,
  GUID  guidCamera,
  UINT32  instanceId
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
guidCamera
[in]  GUID a unique identifier of a already created camera defintion.
instanceId
[in]  UINT32 containing the camera instance identifier.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_SetCameraHorizontalFov

The SimConnect_SetCameraHorizontalFov function is used to adjust the specified camera's horizontal field of view.

Syntax

HRESULT SimConnect_SetCameraHorizontalFov(
  HANDLE  hSimConnect,
  const char*  szName,
  float  hFov
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szName
[in]  The name of the camera. This can either match the window title or the name of the camera definition. If the window title is used only the camera for that window will be modified. If the camera definition name is used and more than one window is open corresponding to that definition than all of those windows will be modified.
hFov
[in]  Float containing the new horizontal FoV. The range of allowable values is between 0 and 180 degrees.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_SetCameraVerticalFov

The SimConnect_SetCameraVerticalFov function is used to adjust the specified camera's vertical field of view.

Syntax

HRESULT SimConnect_SetCameraHorizontalFov(
  HANDLE  hSimConnect,
  const char*  szName,
  float  vFov
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szName
[in]  The name of the camera. This can either match the window title or the name of the camera definition. If the window title is used only the camera for that window will be modified. If the camera definition name is used and more than one window is open corresponding to that definition than all of those windows will be modified.
vFov
[in]  Float containing the new vertical FoV. The range of allowable values is between 0 and 180 degrees.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_SetCameraFov

The SimConnect_SetCameraFov function is used to adjust the specified camera's field of view.

Syntax

HRESULT SimConnect_SetCameraFov(
  HANDLE  hSimConnect,
  const char*  szName,
  float  hFov,
  float  vFov
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szName
[in]  The name of the camera. This can either match the window title or the name of the camera definition. If the window title is used only the camera for that window will be modified. If the camera definition name is used and more than one window is open corresponding to that definition than all of those windows will be modified.
hFov
[in]  Float containing the new horizontal FoV. The range of allowable values is between 0 and 180 degrees.
vFov
[in]  Float containing the new vertical FoV. The range of allowable values is between 0 and 180 degrees.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_SetMainCameraHorizontalFov

The SimConnect_SetMainCameraHorizontalFov function is used to adjust the main camera's horizontal field of view.

Syntax

HRESULT SimConnect_SetMainCameraHorizontalFov(
  HANDLE  hSimConnect,
  float  hFov
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
hFov
[in]  Float containing the new horizontal FoV. The range of allowable values is between 0 and 180 degrees.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_SetMainCameraVerticalFov

The SimConnect_SetMainCameraVerticalFov function is used to adjust the main camera's vertical field of view.

Syntax

HRESULT SimConnect_SetMainCameraVerticalFov(
  HANDLE  hSimConnect,
  float  vFov
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
vFov
[in]  Float containing the new vertical FoV. The range of allowable values is between 0 and 180 degrees.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_SetMainCameraFov

The SimConnect_SetMainCameraFov function is used to adjust the main camera's field of view.

Syntax

HRESULT SimConnect_SetMainCameraFov(
  HANDLE  hSimConnect,
  float  hFov,
  float  vFov
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
hFov
[in]  Float containing the new horizontal FoV. The range of allowable values is between 0 and 180 degrees.
vFov
[in]  Float containing the new vertical FoV. The range of allowable values is between 0 and 180 degrees.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_CameraZoomIn

The SimConnect_CameraZoomIn function is used to adjust the zoom of the specified camera.

Syntax

HRESULT SimConnect_CameraZoomIn(
  HANDLE  hSimConnect,
  const char*  szName
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szName
[in]  The name of the camera. This can either match the window title or the name of the camera definition. If the window title is used only the camera for that window will be modified. If the camera definition name is used and more than one window is open corresponding to that definition than all of those windows will be modified.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_CameraZoomOut

The SimConnect_CameraZoomOut function is used to adjust the zoom of the specified camera.

Syntax

HRESULT SimConnect_CameraZoomOut(
  HANDLE  hSimConnect,
  const char*  szName
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szName
[in]  The name of the camera. This can either match the window title or the name of the camera definition. If the window title is used only the camera for that window will be modified. If the camera definition name is used and more than one window is open corresponding to that definition than all of those windows will be modified.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_MainCameraZoomIn

The SimConnect_MainCameraZoomIn function is used to adjust the zoom of the main camera.

Syntax

HRESULT SimConnect_MainCameraZoomIn(
  HANDLE  hSimConnect
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_MainCameraZoomOut

The SimConnect_MainCameraZoomOut function is used to adjust the zoom of the main camera.

Syntax

HRESULT SimConnect_MainCameraZoomOut(
  HANDLE  hSimConnect
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_ChangeView

The SimConnect_ChangeView function is used to change the camera on the main view.

Syntax

HRESULT SimConnect_ChangeView(
  HANDLE  hSimConnect,
  const char*  szName
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szName
[in]  The name of the camera to switch to.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_OpenView

The SimConnect_OpenView function is used to open a new view.

Syntax

HRESULT SimConnect_OpenView(
  HANDLE  hSimConnect,
  const char*  szName
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szName
[in]  The name of the view to open.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Samples

Primary samples Camera System

See Also


SimConnect_CloseView

The SimConnect_CloseView function is used to close a view.

Syntax

HRESULT SimConnect_CloseView(
  HANDLE  hSimConnect,
  const char*  szName
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szName
[in]  The name of the view to close.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_UndockView

The SimConnect_UndockView function is used to undock a view.

Syntax

HRESULT SimConnect_UndockView(
  HANDLE  hSimConnect,
  const char*  szName
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szName
[in]  The name of the view to undock.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Samples

Primary samples Camera System

See Also


SimConnect_DockView

The SimConnect_DockView function is used to dock a view.

Syntax

HRESULT SimConnect_DockView(
  HANDLE  hSimConnect,
  const char*  szName
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szName
[in]  The name of the view to dock.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Samples

Primary samples Camera System

See Also


SimConnect_SetCameraWindowPosition

The SimConnect_SetCameraWindowPosition function is used to set the window position of a view.

Syntax

HRESULT SimConnect_SetCameraWindowPosition(
  HANDLE  hSimConnect,
  const char*  szName,
  UINT  uX,
  UINT  uY
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szName
[in]  The name of the view to move.
uX
[in]  New x position of the view.
uY
[in]  New y position of the view.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Samples

Primary samples Camera System

See Also


SimConnect_SetCameraWindowSize

The SimConnect_SetCameraWindowSize function is used to set the window size of a view.

Syntax

HRESULT SimConnect_SetCameraWindowSize(
  HANDLE  hSimConnect,
  const char*  szName,
  UINT  uWidth,
  UINT  uHeight
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szName
[in]  The name of the view to size.
uWidth
[in]  New width of the view.
uHeight
[in]  New height of the view.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Samples

Primary samples Camera System

See Also


SimConnect_AddPostProcess

The SimConnect_AddPostProcess function is used to apply a post process effect to the specified camera.

Syntax

HRESULT SimConnect_AddPostProcess(
  HANDLE  hSimConnect,
  const char*  szCameraName,
  const char*  szPostProcessName
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szCameraName
[in]  The name of the camera. This can either match the window title or the name of the camera definition. If the window title is used only the camera for that window will be modified. If the camera definition name is used and more than one window is open corresponding to that definition than all of those windows will be modified.
szPostProcessName
[in]  The name of the post process effect.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_AddPostProcessMainCamera

The SimConnect_AddPostProcessMainCamera function is used to apply a post process effect to the main camera.

Syntax

HRESULT SimConnect_AddPostProcessMainCamera(
  HANDLE  hSimConnect,
  const char*  szPostProcessName
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szPostProcessName
[in]  The name of the post process effect.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_RemovePostProcess

The SimConnect_RemovePostProcess function is used to remove a post process effect from the specified camera.

Syntax

HRESULT SimConnect_RemovePostProcess(
  HANDLE  hSimConnect,
  const char*  szCameraName,
  const char*  szPostProcessName
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szCameraName
[in]  The name of the camera. This can either match the window title or the name of the camera definition. If the window title is used only the camera for that window will be modified. If the camera definition name is used and more than one window is open corresponding to that definition than all of those windows will be modified.
szPostProcessName
[in]  The name of the post process effect.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_RemovePostProcessMainCamera

The SimConnect_RemovePostProcessMainCamera function is used to remove a post process effect from the main camera.

Syntax

HRESULT SimConnect_RemovePostProcessMainCamera(
  HANDLE  hSimConnect,
  const char*  szPostProcessName
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szPostProcessName
[in]  The name of the post process effect.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_CameraSmoothRelative6DOF

The SimConnect_CameraSmoothRelative6DOF function is used to smoothly transition the view of the main camera to the specified location.

Syntax

HRESULT SimConnect_CameraSmoothRelative6DOF(
  HANDLE  hSimConnect,
  float  fDeltaX,
  float  fDeltaY,
  float  fDeltaZ,
  float  fPitchDeg,
  float  fBankDeg,
  float  fHeadingDeg,
  float  fSmoothPanTime = 0
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
fDeltaX
[in]  The new x position of the camera relative to the origin in meters. Valid range: -100.0 - 100.0.
fDeltaY
[in]  The new y position of the camera relative to the origin in meters. Valid range: -100.0 - 100.0.
fDeltaZ
[in]  The new z position of the camera relative to the origin in meters. Valid range: -100.0 - 100.0.
fPitchDeg
[in]  The new pitch of the camera relative to the origin in degrees. Valid range: -90.0 - 90.0.
fBankDeg
[in]  The new bank of the camera relative to the origin in degrees. Valid range: -90.0 - 90.0.
fHeadingDeg
[in]  The new heading of the camera relative to the origin in degrees. Valid range: -90.0 - 90.0.
fSmoothPanTime
[in, optional]  The camera pan duration. If no value is specified the value defined in the Cameras.cfg will be used (defaults to 1.0f).

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_CameraSmoothRelative6DofByName

The SimConnect_CameraSmoothRelative6DofByName function is used to smoothly transition the view of the specified camera to the specified location.

Syntax

HRESULT SimConnect_CameraSmoothRelative6DofByName(
  HANDLE  hSimConnect,
  const char*  szCameraName,
  float  fDeltaX,
  float  fDeltaY,
  float  fDeltaZ,
  float  fPitchDeg,
  float  fBankDeg,
  float  fHeadingDeg,
  float  fSmoothPanTime = 0
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szCameraName
[in]  The name of the camera. This can either match the window title or the name of the camera definition. If the window title is used only the camera for that window will be modified. If the camera definition name is used and more than one window is open corresponding to that definition than all of those windows will be modified.
fDeltaX
[in]  The new x position of the camera relative to the origin in meters. Valid range: -100.0 - 100.0.
fDeltaY
[in]  The new y position of the camera relative to the origin in meters. Valid range: -100.0 - 100.0.
fDeltaZ
[in]  The new z position of the camera relative to the origin in meters. Valid range: -100.0 - 100.0.
fPitchDeg
[in]  The new pitch of the camera relative to the origin in degrees. Valid range: -90.0 - 90.0.
fBankDeg
[in]  The new bank of the camera relative to the origin in degrees. Valid range: -90.0 - 90.0.
fHeadingDeg
[in]  The new heading of the camera relative to the origin in degrees. Valid range: -90.0 - 90.0.
fSmoothPanTime
[in, optional]  The camera pan duration. If no value is specified the value defined in the Cameras.cfg will be used (defaults to 1.0f).

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_CameraPanToView

The SimConnect_CameraPanToView function is used to smoothly transition the view of the specified camera to the location of the specified target view.

Syntax

HRESULT SimConnect_CameraPanToView(
  HANDLE  hSimConnect,
  const char*  szCameraName,
  const char*  szTargetName,
  float  fSmoothPanTime = 0
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szCameraName
[in]  The name of the camera. This can either match the window title or the name of the camera definition. If the window title is used only the camera for that window will be modified. If the camera definition name is used and more than one window is open corresponding to that definition than all of those windows will be modified.
szTargetName
[in]  The name of the target view.
fSmoothPanTime
[in, optional]  The camera pan duration. If no value is specified the value defined in the Cameras.cfg will be used (defaults to 1.0f).

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_MainCameraPanToView

The SimConnect_MainCameraPanToView function is used to smoothly transition the view of the main camera to the location of the specified target view.

Syntax

HRESULT SimConnect_MainCameraPanToView(
  HANDLE  hSimConnect,
  const char*  szTargetName,
  float  fSmoothPanTime = 0
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szTargetName
[in]  The name of the target view.
fSmoothPanTime
[in, optional]  The camera pan duration. If no value is specified the value defined in the Cameras.cfg will be used (defaults to 1.0f).

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_SendCameraCommand

The SimConnect_SendCameraCommand function is used to simulate user inputs to control camera movement and rotation.

Syntax

HRESULT SimConnect_SendCameraCommand(
  HANDLE  hSimConnect,
  cconst GUID  guidCamera,
  SIMCONNECT_CAMERA_COMMAND  eCommand
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
guidCamera
[in]  The GUID of the camera to move/rotate.
eCommand
[in]  The SIMCONNECT_CAMERA_COMMAND that defines which user input is simulated.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_RequestCameraFov

The SimConnect_RequestCameraFov function is used to request the field-of-view of the given camera.

Syntax

HRESULT SimConnect_RequestCameraFov(
  HANDLE  hSimConnect,
  const char*  szName,
  SIMCONNECT_DATA_REQUEST_ID  RequestID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szName
[in]  The name of the camera to request data from.
RequestID
[in]  Specifies the client defined request ID.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_RequestCameraRelative6DOF

The SimConnect_RequestCameraRelative6DOF function is used to request the XYZ delta offset from the eyepoint reference point in meters, as well as the pitch, bank, and heading in degrees of the main view.

Syntax

HRESULT SimConnect_RequestCameraRelative6DOF(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
RequestID
[in]  Specifies the client defined request ID.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_RequestCameraRelative6DofByName

The SimConnect_RequestCameraRelative6DofByName function is used to request the XYZ delta offset from the eyepoint reference point in meters, as well as the pitch, bank, and heading in degrees of a given view.

Syntax

HRESULT SimConnect_RequestCameraRelative6DofByName(
  HANDLE  hSimConnect,
  const char*  szName,
  SIMCONNECT_DATA_REQUEST_ID  RequestID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szName
[in]  The name of the camera to request data from.
RequestID
[in]  Specifies the client defined request ID.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_RequestCameraSensorMode

The SimConnect_RequestCameraSensorMode function is used to request the current sensor mode of a given view.

Syntax

HRESULT SimConnect_RequestCameraSensorMode(
  HANDLE  hSimConnect,
  const char*  szName,
  SIMCONNECT_DATA_REQUEST_ID  RequestID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szName
[in]  The name of the camera to request data from.
RequestID
[in]  Specifies the client defined request ID.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_RequestCameraWindowPosition

The SimConnect_RequestCameraWindowPosition function is used to request the current window position of a given view.

Syntax

HRESULT SimConnect_RequestCameraWindowPosition(
  HANDLE  hSimConnect,
  const char*  szName,
  SIMCONNECT_DATA_REQUEST_ID  RequestID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szName
[in]  The name of the camera to request data from.
RequestID
[in]  Specifies the client defined request ID.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_RequestCameraWindowSize

The SimConnect_RequestCameraWindowSize function is used to request the current window size of a given view.

Syntax

HRESULT SimConnect_RequestCameraWindowSize(
  HANDLE  hSimConnect,
  const char*  szName,
  SIMCONNECT_DATA_REQUEST_ID  RequestID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szName
[in]  The name of the camera to request data from.
RequestID
[in]  Specifies the client defined request ID.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_RequestMainCameraFov

The SimConnect_RequestMainCameraFov is used to request the field-of-view of the main view (horizontal and vertical).

Syntax

HRESULT SimConnect_RequestMainCameraFov(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
RequestID
[in]  Specifies the client defined request ID.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_RequestMainCameraSensorMode

The SimConnect_RequestMainCameraSensorMode function is used to request teh current sensor mode of the main view.

Syntax

HRESULT SimConnect_RequestMainCameraSensorMode(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
RequestID
[in]  Specifies the client defined request ID.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_CaptureImage

The SimConnect_CaptureImage function is used to capture the image of a specific view.

Syntax

HRESULT SimConnect_CaptureImage(
  HANDLE  hSimConnect,
  const char*  szFileName,
  const char*  szFilePath,
  UINT  uImageFormat,
  const char*  szViewName
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szFileName
[in]  The name of the file to store image.
szFilePath
[in]  The path of the file, can be relative or absolute.
uImageFormat
[in]  Specifies the format of the image. Formats: 0 BMP, 1 PNG, 2 JPEG, 3 TIFF.
szViewName
[in]  The name of the window to capture the image.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_BeginVideoStream

The SimConnect_BeginVideoStream function is used to begin network streaming video of a specific view.

Syntax

SimConnect_BeginVideoStream(HANDLE hSimConnect, const char * szViewName, SIMCONNECT_DATA_VIDEO_STREAM_INFO StreamInfo) HRESULT SimConnect_BeginVideoStream(
  HANDLE  hSimConnect,
  const char *  szViewName,
  SIMCONNECT_DATA_VIDEO_STREAM_INFO  StreamInfo
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szViewName
[in]  Name of view. If null, default or active view will be used.
StreamInfo
[in]  Struct containing information about the video stream

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_EndVideoStream

The SimConnect_EndVideoStream function is used to end network streaming video of a specific view.

Syntax

HRESULT SimConnect_EndVideoStream(
  HANDLE  hSimConnect,
  const char *  szViewName,
  SIMCONNECT_DATA_VIDEO_STREAM_INFO  StreamInfo
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szViewName
[in]  Name of view. If null, default or active view will be used.
StreamInfo
[in]  Struct containing information about the video stream

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


Facilities Specific Functions

SimConnect_RequestFacilitiesList

The SimConnect_RequestFacilitiesList function is used to request a list of all the facilities of a given type currently held in the facilities cache.

Syntax

HRESULT SimConnect_RequestFacilitiesList(
  HANDLE  hSimConnect,
  SIMCONNECT_FACILITY_LIST_TYPE  type,
  SIMCONNECT_DATA_REQUEST_ID  RequestID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
type
[in]  Specifies one member of the SIMCONNECT_FACILITY_LIST_TYPE enumeration type.
RequestID
[in]  Specifies the client defined request ID. This will be returned along with the data.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Sample

Primary sample FacilitiesData
Reference sample Managed Facilities Request

Remarks

The simulation keeps a facilities cache of all the airports, waypoints, NDB, VOR, and TACAN stations within a certain radius of the user aircraft. This radius varies depending on where the aircraft is in the world, but is at least large enough to encompass the whole of the reality bubble for airports and waypoints, and can be over 200 miles for VOR and NDB stations. As the user aircraft moves facilities will be added to, and removed from, the cache. However, in the interests pf performance, hysteresis is built into the system.

To receive event notifications when a facility is added, use the SimConnect_SubscribeToFacilities function. When this function is first called, a full list from the cache will be sent, thereafter just the additions will be transmitted. No notification is given when a facility is removed from the cache. the Obviously to terminate these notifications use the SimConnect_UnsubscribeToFacilities function.

When requesting types of facility information, one function call has to be made for each of the four types of data. The data will be returned in one of the four structures:

The four list structures inherit the data from the SIMCONNECT_RECV_FACILITIES_LIST structure. Given that the list of returned facilities could be large, it may be split across several packets, and each packet must be interpreted separately by the client.

See Also


SimConnect_SubscribeToFacilities

The SimConnect_SubscribeToFacilities function is used to request notifications when a facility of a certain type is added to the facilities cache.

Syntax

HRESULT SimConnect_SubscribeToFacilities(
  HANDLE  hSimConnect,
  SIMCONNECT_FACILITY_LIST_TYPE  type,
  SIMCONNECT_DATA_REQUEST_ID  RequestID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
type
[in]  Specifies one member of the SIMCONNECT_FACILITY_LIST_TYPE enumeration type.
RequestID
[in]  Specifies the client defined request ID. This will be returned along with the data.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Sample

Primary samples FacilitiesData
Managed Facilities Request

Remarks

See the remarks for SimConnect_RequestFacilitiesList.

See Also


SimConnect_UnsubscribeToFacilities

The SimConnect_UnsubscribeToFacilities function is used to request that notifications of additions to the facilities cache are not longer sent.

Syntax

HRESULT SimConnect_UnsubscribeToFacilities(
  HANDLE  hSimConnect,
  SIMCONNECT_FACILITY_LIST_TYPE  type
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
type
[in] Specifies one member of the SIMCONNECT_FACILITY_LIST_TYPE enumeration type.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Sample

Primary samples FacilitiesData
Managed Facilities Request

Remarks

See the remarks for SimConnect_RequestFacilitiesList.

See Also


Menu Specific Functions

SimConnect_MenuAddItem

The SimConnect_MenuAddItem function is used to add a menu item, associated with a client event.

Syntax

HRESULT SimConnect_MenuAddItem(
  HANDLE  hSimConnect,
  const char*  szMenuItem,
  SIMCONNECT_CLIENT_EVENT_ID  MenuEventID,
  DWORD  dwData
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szMenuItem
[in]  Null-terminated string containing the text for the menu item.
MenuEventID
[in]  Specifies the client defined event ID, which is to be transmitted when the menu item is selected (in the uEventID parameter of the SIMCONNECT_RECV_EVENT structure).
dwData
[in]  Double word containing a data value that the client can specify for its own use (it will be returned in the dwData parameter of the SIMCONNECT_RECV_EVENT structure.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Sample

Primary sample Menu Items

Remarks

The menu item will be added to the Add-ons menu. The Add-ons menu will only appear if there is at least one menu entry. Sub-menu items can be associated with this menu item, see SimConnect_MenuAddSubItem. If the text for the menu item should change, then remove the menu item first before adding the menu item with the correct text (see SimConnect_MenuDeleteItem).

Each client can add a number of main menu items.

See Also


SimConnect_MenuAddSubItem

The SimConnect_MenuAddSubItem function is used to add a sub-menu item, associated with a client event.

Syntax

HRESULT SimConnect_MenuAddSubItem(
  HANDLE  hSimConnect,
  SIMCONNECT_CLIENT_EVENT_ID  MenuEventID,
  const char*  szMenuItem,
  SIMCONNECT_CLIENT_EVENT_ID  SubMenuEventID,
  DWORD  dwData
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
EventID
[in]  Specifies the client defined menu event ID. This is the ID of the menu item that this item should be added to.
szMenuItem
[in]  Null-terminated string containing the text for the sub-menu item.
EventID
[in]  Specifies the client defined sub-menu event ID, which is to be transmitted when the sub-menu item is selected (in the uEventID parameter of the SIMCONNECT_RECV_EVENT structure). This ID must be unique across all sub-menu items for the client.
dwData
[in]  Double word containing a data value that the client can specify for its own use (it will be returned in the dwData parameter of the SIMCONNECT_RECV_EVENT structure.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

A maximum of 16 sub-menu items may be added to any one main menu item. Sub-menu items are always added to the end of the sub-menu item list. An exception, SIMCONNECT_EXCEPTION_TOO_MANY_OBJECTS, will be returned if an attempt is made to add more than 16 sub-menu items.

See Also


SimConnect_MenuDeleteItem

The SimConnect_MenuDeleteItem function is used to remove a client defined menu item.

Syntax

HRESULT SimConnect_MenuDeleteItem(
  HANDLE  hSimConnect,
  const SIMCONNECT_CLIENT_EVENT_ID  MenuEventID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
MenuEventID
[in]  Specifies the client defined event ID.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Sample

Primary sample Menu Items

Remarks

Menu items should be removed before a client closes. Removing the main menu item will remove any associated sub-menu items. Also see the remarks for SimConnect_MenuAddItem.

See Also


SimConnect_MenuDeleteSubItem

The SimConnect_MenuDeleteSubItem function is used to remove a specified sub-menu item.

Syntax

HRESULT SimConnect_MenuDeleteSubItem(
  HANDLE  hSimConnect,
  SIMCONNECT_CLIENT_EVENT_ID  MenuEventID,
  const SIMCONNECT_CLIENT_EVENT_ID   SubMenuEventID
);

Parameters

hSimConnect
[in] Handle to a SimConnect object.
MenuEventID
 
[in] Specifies the client defined menu event ID, from which the sub-menu item is to be removed.
SubMenuEventID
 
[in] Specifies the client defined sub-menu event ID.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

If a sub-menu item is deleted from the middle of the sub-menu item list, the list will contract.

See Also


SimConnect_Text

The SimConnect_Text function is used to display a text menu, message window, or scrolling or static text, on the screen.

Syntax

HRESULT SimConnect_Text(
  HANDLE  hSimConnect,
  SIMCONNECT_TEXT_TYPE  type,
  float  fTimeSeconds,
  SIMCONNECT_CLIENT_EVENT_ID  EventID,
  DWORD  cbUnitSize,
  void*  pDataSet
);

Parameters

hSimConnect
[in] Handle to a SimConnect object.
type
[in] One member of the SIMCONNECT_TEXT_TYPE enumeration type.
fTimeSeconds
[in] The timeout value for the text, message, or menu in seconds. If zero is entered, the text, message, or menu will not timeout. For text and messages, this timeout value can be overridden if there are other text requests waiting in the queue (see the Remarks below). If the timeout requested exceeds the minimum display time, and another text request is waiting, the timeout value is overridden and the text will only be displayed for the minimum display time. The default minimum display time is two seconds for static text and 10 seconds for scrolling text, and 5 seconds for message windows. These can be changed in the [SimConnect] section of Prepar3D.cfg file using the TextMinPrintTimeSeconds, TextMinScrollTimeSeconds, and TextMinMessageWindowTimeSeconds settings.
EventID
 
[in] Specifies the client defined event ID, which will be returned along with the SIMCONNECT_TEXT_RESULT (in the dwData parameter) of a SIMCONNECT_RECV_EVENT structure.
cbUnitSize
 
[in] Specifies the size of pDataSet in bytes.
pDataSet
 
[in] Specifies the array of string data for the menu or text. For text and message windows simply enter the string. For a menu, the format of the string is a list of null-terminated string entries, with the menu title and prompt as the first two entries, for example: "Title\0Prompt\0Menu item 1\0Menu item 2\0", with a maximum of ten menu items. If an empty string is sent in pDataSet along with an EventID that matches a menu or text in the queue (see Remarks below), that entry will be removed from the queue, with the SIMCONNECT_TEXT_RESULT_REMOVED event being returned to the client. If a new set of menu items, or new text string, is sent with an EventID that matches an entry in the queue, that entry will be replaced in the queue, with the SIMCONNECT_TEXT_RESULT_REPLACED event being returned to the client. The entry will not lose its place in the queue. This change will take place even if the text or menu is being rendered on the screen.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Sample

Primary samples Text Menu
FacilitiesData

Remarks

Message windows, text, and menus can all be displayed simultaneously, however only one instance of each is allowed at any given time. Requests are queued as they are received, with only the topmost in the queue being displayed. There is one queue for menus and another for static and scrolling text. When a request is first displayed the SIMCONNECT_TEXT_RESULT_DISPLAYED event will be sent to the client. If a request joins the queue and cannot immediately be displayed the event SIMCONNECT_TEXT_RESULT_QUEUED will be sent. When it is the turn of the new request to be displayed the SIMCONNECT_TEXT_RESULT_DISPLAYED event will be sent. If the request is for a menu, and the user selects one of the menu entries, one of the SIMCONNECT_TEXT_RESULT_MENU_SELECT_N events will be returned (see the SIMCONNECT_TEXT_RESULT enumeration), and the menu closed.

The default location for message windows and static or scrolling text is along the top of the screen. A user can move and resize the window that the text is being displayed in, but it is not possible to specify an alternative location for the text programmatically.

See Also


Structured Scenario Specific Functions

SimConnect_CompleteCustomMissionAction

The SimConnect_CompleteCustomMissionAction function is used to complete the scenario action specified by a GUID.

Syntax

HRESULT SimConnect_CompleteCustomMissionAction(
  HANDLE  hSimConnect,
  const GUID  guidInstanceId
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
guidInstanceId
[in]  GUID of the custom action. The GUID should be found in the associated object XML file.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Sample

Primary sample Mission Action

Remarks

A scenario's objects are specified in an XML file. A custom action is defined within this XML file, and will look similar to the following:

<SimMission.CustomAction InstanceId="{ GUID }">
<PayLoadString>Any string goes here!</PayLoadString>
<WaitForCompletion>True</WaitForCompletion>
</SimMission.CustomAction>

Custom actions provide a mechanism to add complex processing to the basically data-driven scenario system.

The custom action would typically be triggered from within the object XML file (a trigger referencing the GUID of the custom action), though it could be called from within the SimConnect client with a call to SimConnect_ExecuteMissionAction. It is only necessary to call SimConnect_CompleteCustomMissionAction if the WaitForCompletion value is set to True.

If the client calls SimConnect_ExecuteMissionAction from within the code for a custom action, and it is important that this action completes before any other actions are started (that is, WaitForCompletion is True) then a second custom action should be defined that calls SimConnect_CompleteCustomMissionAction after that action is complete, and with the GUID of the first custom action as its parameter. The working sample shows this process.

In order to received notifications that a custom action is to be executed, the SimConnect client should use the SimConnect_SubscribeToSystemEvent call with the SystemEventName parameter set to "CustomMissionActionExecuted". This will result in the GUID of the custom action, and the PayLoadString, being sent to the client in a SIMCONNECT_RECV_CUSTOM_ACTION structure.

If a scenario requires additional processing on its completion the SimConnect client should use the SimConnect_SubscribeToSystemEvent call with the SystemEventName parameter set to "MissionCompleted".

See Also


SimConnect_ExecuteMissionAction

The SimConnect_ExecuteMissionAction function is used to execute the scenario action specified by a GUID.

Syntax

HRESULT SimConnect_ExecuteMissionAction(
  HANDLE  hSimConnect,
  const GUID  guidInstanceId
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
guidInstanceId
[in]  GUID of the Mission Action. The GUID should be found in the associated object XML file.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Sample

Primary sample Mission Action

Remarks

A scenario's objects are specified in an XML file.

In order to use SimConnect_ExecuteMissionAction, typically there should be at least one custom action within the object XML file. The custom action will initiate the sending of a notification to the SimConnect client, and the client can then both do some processing of its own and run, by calling SimConnect_ExecuteMissionAction, one or more actions (spoken text, for example) that are defined within the XML file.

See the remarks for SimConnect_CompleteCustomMissionAction.

See Also


Weather Specific Functions

SimConnect_WeatherCreateStation

The SimConnect_WeatherCreateStation function creates a weather station at the given ICAO location.

Syntax

HRESULT SimConnect_WeatherCreateStation(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID,
  const char*  szICAO,
  const char*  szName,
  float  lat,
  float  lon,
  float  alt
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.

RequestID
[in]  Specifies the client defined request ID.
szICAO
[in]  Specifies the ICAO string. This can be an existing airport ICAO string, as long as the airport does not already have a weather station, or it can be a unique new ICAO code to be used just for the purposes of this weather station.
szName
[in]  Specifies a descriptive name for the new weather station. This name will appear on the weather map in the weather dialogs of Prepar3D.
lat
[in]  Specifies the latitude of the station in degrees. The latitude, longitude and altitude parameters should be set to 0 if the ICAO code supplied is from an existing airport.
lon
[in]  Specifies the longitude of the station in degrees.
alt
[in]  Specifies the altitude of the station in feet, above ground level.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.
Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

If an attempt is made to create a weather station at an airport that already has one, the error SIMCONNECT_EXCEPTION_WEATHER_UNABLE_TO_CREATE_STATION will be returned.

Once a weather station has been successfully created, its weather output can be set with a call to SimConnect_WeatherSetObservation, and retrieved with a call to SimConnect_WeatherRequestObservationAtStation.

See Also


SimConnect_WeatherCreateThermal

The SimConnect_WeatherCreateThermal function is used to create a thermal at a specific location.

Syntax

HRESULT SimConnect_WeatherCreateThermal(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID,
  float  lat,
  float  lon,
  float  alt,
  float  radius,
  float  height,
  float  coreRate = 3.0f,
  float  coreTurbulence = 0.05f,
  float  sinkRate = 3.0f,
  float  sinkTurbulence = 0.2f,
  float  coreSize = 0.4f,
  float  coreTransitionSize = 0.1f,
  float  sinkLayerSize = 0.4f,
  float  sinkTransitionSize = 0.1f
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
RequestID
[in]  Specifies the client defined request ID.
lat
[in]  Specifies the latitude of the thermal in degrees.
lon
[in]  Specifies the longitude of the thermal in degrees.
alt
[in]  Specifies the altitude of the thermal in feet, above ground level.
radius
[in]  Specifies the radius of the thermal, in meters. The maximum radius of a thermal is 100Km.
height
[in]  Specifies the height of the thermal, in meters.
coreRate
[in, optional]  Specifies the lift value, in meters per second, within the Core layer. A positive value will provide an updraft, a negative value a downdraft. The maximum rate is 1000 meters/second. Refer to the diagram in the Remarks section.
coreTurbulence
[in, optional]  Specifies a variation in meters per second that is applied to the coreRate. For example, if a value of 1.5 is entered, and the core rate is 5 m/s, the actual core rate applied will be randomly varying between 3.5 m/s and 6.5 m/s.
sinkRate
[in, optional]  Specifies the lift value, in meters per second, within the Sink layer. A positive value will provide an updraft, a negative value a downdraft. The maximum rate is 1000 meters/second. Refer to the diagram in the Remarks section.
coreTurbulence
[in, optional]  Specifies a variation in meters per second that is applied to the sinkRate. For example, if a value of 1.5 is entered, and the sink rate is 5 m/s, the actual sink rate applied will be randomly varying between 3.5 m/s and 6.5 m/s.
coreSize
[in, optional]  Specifies the radius in meters of the Core of the thermal.
coreTransitionSize
[in, optional]  Specifies the width in meters of the transition layer between the Core and the Sink of the thermal. Half of the width of this transition will be outside the Core, and half within.
sinkSize
[in, optional]  Specifies the radius in meters of the Sink of the thermal.
sinkTransitionSize
[in, optional]  Specifies the width in meters of the transition layer between the Sink and the atmosphere outside of the thermal. Half of the width of this transition will be outside the radius of the Sink layer, and half within.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

There is no limit to the number of thermals that can be created. Within the simulator a thermal is defined as a cylinder with a Core layer and a Sink layer:

thermal

Refer also to the Weather Systems documentation.

See Also


SimConnect_WeatherRemoveStation

The SimConnect_WeatherRemoveStation function requests that the weather station identified by the given ICAO string is removed.

Syntax

HRESULT SimConnect_WeatherRemoveStation(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID,
  const char*  szICAO
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.

RequestID
[in]  Specifies the client defined request ID.
szICAO
[in]  Specifies the ICAO string of the station to remove. The station must be one that was created by the same SimConnect client.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

If a call is made to remove a weather station created by another client, or an exiting one within the simulation, the error SIMCONNECT_EXCEPTION_WEATHER_UNABLE_TO_REMOVE_STATION will be returned.

If the client is closed, then all weather stations created by the client will be removed.

See Also


SimConnect_WeatherRemoveThermal

The SimConnect_WeatherRemoveThermal function removes a thermal.

Syntax

HRESULT SimConnect_WeatherRemoveThermal(
  HANDLE  hSimConnect,
  SIMCONNECT_OBJECT_ID  ObjectID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
ObjectID
[in]  Specifies the object ID of the thermal to be removed.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

A client application can only remove thermals that it created, and not thermals created by other clients or by the simulation itself. If the client is closed, then all thermals created by the client will be removed.

See Also


SimConnect_WeatherRequestCloudState

The SimConnect_WeatherRequestCloudState function requests cloud density information on a given area.

Syntax

HRESULT SimConnect_WeatherRequestCloudState(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID,
  float  minLat,
  float  minLon,
  float  minAlt,
  float  maxLat,
  float  maxLon,
  float  maxAlt,
  DWORD  dwFlags = 0
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
RequestID
[in]  Specifies the client-defined request ID.
minLat
[in]  Specifies the minimum latitude of the required area. This should simply be the lower of the two latitude numbers.
minLon
[in]  Specifies the minimum longitude of the required area. This should simply be the lower of the two longitude numbers.
minAlt
[in]  Specifies the minimum altitude of the required area, in feet.
maxLat
[in]  Specifies the maximum latitude of the required area.
maxLon
[in]  Specifies the maximum longitude of the required area.
maxAlt
[in]  Specifies the maximum altitude of the required area, in feet.
dwFlags
[in, optional]  Double word containing any flags. Reserved for future use.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

The main purpose of this function is to enable weather radar.

If the call is successful, the cloud state information will be returned in a SIMCONNECT_RECV_CLOUD_STATE structure. This structure will contain a two dimensional array of byte data. The array will be 64 x 64 bytes in size, and each byte will contain a value indicating the cloud layer density for each cell. A value of zero would mean no cloud layers, to a maximum of 255 layers. The area defined in this call is divided into 64 by 64 cells, so the size of each cell will be determined by the values given for the parameters above. Note that the entire World's weather is not simulated all the time, but only a region around the user aircraft, with a radius of approximately 128 kilometers, is modeled at any one time. A request for cloud data outside this region will simply return zeros.

The defined area can cross the Equator or the Greenwich Meridian, but it cannot cross the Poles or the International Date Line.

See Also


SimConnect_WeatherRequestInterpolatedObservation

The SimConnect_WeatherRequestInterpolatedObservation function is used to send a request for weather data that is interpolated from the weather at the nearest three weather stations.

Syntax

HRESULT SimConnect_WeatherRequestInterpolatedObservation(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID,
  float  lat,
  float  lon,
  float  alt
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
RequestID
[in]  Specifies the ID of the client defined request. This is used later by the client to identify which data has been received.
lat
[in]  Specifies latitude in degrees.
lon
[in]  Specifies longitude in degrees.

alt
[in]  Specifies altitude in feet above sea level. This differs from most weather data altitudes, which are feet above ground level.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Example


DWORD dwRequestID = 1000;
hr = SimConnect_WeatherRequestInterpolatedObservation(hSimConnect, dwRequestID, -80.0, 44.0, 10000);

Remarks

The weather data will be returned in a SIMCONNECT_RECV_WEATHER_OBSERVATION structure. A number of errors apply specifically to weather data, see the SIMCONNECT_RECV_EXCEPTION enumeration.

Interpolated weather data can be used to identify suitable locations for thermals and other local weather systems. The process of using the three nearest stations is not without its drawbacks, as all three stations could be in one direction of the specified point, and not a reasonable spread in different directions. Weather data is returned in Metar data format.

Refer to the remarks section for SimConnect_WeatherRequestObservationAtStation for some notes on the SIMCONNECT_EXCEPTION_WEATHER_UNABLE_TO_GET_OBSERVATION exception.

See Also


SimConnect_WeatherRequestObservationAtNearestStation

The SimConnect_WeatherRequestObservationAtNearestStation function is used to send a request for the weather data from the weather station nearest to the specified lat/lon position.

Syntax

HRESULT SimConnect_WeatherRequestObservationAtNearestStation(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID,
  float  lat,
  float  lon
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
RequestID
[in]  Specifies the ID of the client defined request. This is used later by the client to identify which data has been received.
lat
[in]  Specifies latitude in degrees.
lon
[in]  Specifies longitude in degrees.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Example


DWORD dwRequestID = 1000;
hr = SimConnect_WeatherRequestObservationAtNearestStation(hSimConnect, dwRequestID, -80.0, 44.0);

Working Sample

Primary sample Weather Station

Remarks

The weather data will be returned in a SIMCONNECT_RECV_WEATHER_OBSERVATION structure. A number of errors apply specifically to weather data, see the SIMCONNECT_RECV_EXCEPTION enumeration. Weather data is returned in Metar data format.

Refer to the remarks section for SimConnect_WeatherRequestObservationAtStation for some notes on the SIMCONNECT_EXCEPTION_WEATHER_UNABLE_TO_GET_OBSERVATION exception.

See Also


SimConnect_WeatherRequestObservationAtStation

The SimConnect_WeatherRequestObservationAtStation function requests the weather data from a weather station identified by its ICAO code.

Syntax

HRESULT SimConnect_WeatherRequestObservationAtStation(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID,
  const char*  szICAO
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
RequestID
[in]  Specifies the ID of the client defined request. This is used later by the client to identify which data has been received.
szICAO[4]
[in]  Null-terminated string specifying the ICAO identification code of the weather station. Typically this is an airport. Set to GLOB to retrieve global weather.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Example

DWORD dwRequestID = 1000;
hr = SimConnect_WeatherRequestObservationAtStation(hSimConnect, dwRequestID, "ICAO");

Remarks

The weather data will be returned in a SIMCONNECT_RECV_WEATHER_OBSERVATION structure. A number of errors apply specifically to weather data, see the SIMCONNECT_RECV_EXCEPTION enumeration. Weather data is returned in Metar data format.

The exception SIMCONNECT_EXCEPTION_WEATHER_UNABLE_TO_GET_OBSERVATION is returned in a number of cases, including that the station provided as a parameter does not exist. However there is one case where this exception is returned that a client should not treat as an error, and that is when the weather station does not have any valid data to return because it has not been recently updated with its current weather. In this case a client could keep polling for a weather observation until a valid metar string is returned. This could take 10 seconds or more, as there are certain situations when a user can reset the weather through the UI that clears many of the weather stations of their current weather, and it takes some time for the weather engine to regenerate all the weather settings.

See Also


SimConnect_WeatherSetDynamicUpdateRate

The SimConnect_WeatherSetDynamicUpdateRate function is used to set the rate at which cloud formations change.

Syntax

HRESULT SimConnect_WeatherSetDynamicUpdateRate(
  HANDLE  hSimConnect,
  DWORD  dwRate
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
dwRate
[in]  Double word containing the rate. A value of zero indicates that cloud formations do not change at all. Values between 1 and 5 indicate that cloud formations should change from 1 (the slowest) to 5 (the fastest). These settings match those than can be set through the dialogs of Prepar3D.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

None.

See Also


SimConnect_WeatherSetModeCustom

The SimConnect_WeatherSetModeCustom function sets the weather mode to user-defined.

Syntax

HRESULT SimConnect_WeatherSetModeCustom(
  HANDLE  hSimConnect
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

Calling this function sets the weather mode to "User-defined weather" in the Weather dialog of Prepar3D, so whatever the user has entered for the weather will be used.

See Also


SimConnect_WeatherSetModeGlobal

The SimConnect_WeatherSetModeGlobal function sets the weather mode to global, so the same weather data is used everywhere.

Syntax

HRESULT SimConnect_WeatherSetModeGlobal(
  HANDLE  hSimConnect
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

There is not an equivalent setting in the weather dialog of Prepar3D.

See Also


SimConnect_WeatherSetModeServer

The SimConnect_WeatherSetModeServer function is used to switch to a local server for weather observation data. This has been deprecated.

Syntax

HRESULT SimConnect_WeatherSetModeServer(
  HANDLE  hSimConnect,
  DWORD  dwPort,
  DWORD  dwSeconds
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
dwPort
[in]  Double word containing the port number of the weather server. Set this to zero to reset the weather to normal operation.
dwSeconds
[in]  Double word containing the amount of time, in seconds, that should elapse between each update. There is a minimum of 60 seconds.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

Deprecated.

See Also


SimConnect_WeatherSetModeTheme

The SimConnect_WeatherSetModeTheme function is used to set the weather to a particular theme.

Syntax

HRESULT SimConnect_WeatherSetModeTheme(
  HANDLE  hSimConnect,
  const char*  szThemeName
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szThemeName

[in]  Null-terminated string containing the theme path and filename. The path can be either be:

  • an absolute path (e.g. C:/Program Files (x86)/My Company/My Product/myweathertheme)
  • a path relative to the Lockheed Martin/Prepar3D v3/ installation folder (e.g. weather/themes/grayrain)
  • a path relative to any of the weather theme folders found in any of the weather.cfg configuration files (e.g. grayrain)
  • An empty string to set clear weather

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

Calling this function sets the weather mode to "Weather themes" in the Weather dialog of Prepar3D.

There are three files associated with a weather theme, for example: grayrain.wt, grayrain.bmp and grayrain.wtb. The wt file contains the description that will appear in the Current Conditions box in the Weather dialog, the bmp file contains the image that will also appear in the weather dialog, and the wtb file contains data in a propriety format that contains the weather information.

See Also


SimConnect_WeatherSetObservation

The SimConnect_WeatherSetObservation function is used to set the weather at a specific weather station, identified from within the Metar data string.

Syntax

HRESULT SimConnect_WeatherSetObservation(
  HANDLE  hSimConnect,
  DWORD  Seconds,
  const char*  szMETAR
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
Seconds
[in]  Specifies the time in seconds that the current weather should merge into the new weather. This delay only applies to clouds in a custom weather setting, not to global or other weather settings (where the change will take place almost immediately).
pszMETAR
[in]  Null-terminated string containing the METAR data.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

Commonly, a SimConnect_WeatherSetModeGlobal or SimConnect_WeatherSetModeCustom should be called after this function. SimConnect_WeatherSetModeGlobal and SimConnect_WeatherSetModeCustom allow the Weather Settings UI to be properly set.

When setting specific station observations, it is possible for station observations nearby the specified station to be automatically adjusted. The weather system interpolates and changes weather layers for surrounding stations to create a visually appropriate and logical environment. If exact replication of the METAR data is required, the station and surrounding stations can be set multiple times to force the interpolated values to match the desired METAR data.

A number of errors apply specifically to weather data, see the SIMCONNECT_RECV_EXCEPTION enumeration.

Metar Data Format

The data format used in the simulation for setting and retrieving weather is a modification to the Metar standard. The standard format is open and is described on a number of websites. The Metar data used in the simulation follows the following format. Note that each section is separated by a space, and that spaces cannot occur within a section (with one exception noted in the table). The sections must be in the correct order, though many are optional and need not be present.

Section Format Multiple Entries
STATION ID (has an extension) CCCC - a three or four character station ID. For example KORD for O'Hare airport in Chicago. The string GLOB can be used to set global weather data.

Prepar3D extension:

Format is &ANNN
 
This gives the height of the weather station in meters. This information is returned with a get observation, but when setting this extension must not be present.
No
REPORT TYPE Either METAR or SPECI keywords. No
AUTO Optional AUTO keyword, for a fully automated report. No
COR Optional COR keyword, for a corrected report. No
DATETIME One of the following four formats (the exact number of characters must be present):
HHMM
DDHHMM
HHMMZ
DDHHMMZ
(all are UTC whether or not the Z is present).
 
Note that this parameter is ignored when setting weather data. When getting the data, if it was set originally by the user through a SimConnect client or the Weather dialog then the time that it was set to will be returned. If the data was retrieved from a weather server, then the time stamp given to it by the server will be returned.
No
NIL Optional NIL keyword, indicating that no weather report could be made. No
SURFACE WINDS (has an extension) One of the following two formats:
DDDSSSUUU (steady)
DDDSSSGXXUUU (gusts)

where:
DDD = Direction (0-360 degrees, or VRB for variable)
SSS = Speed
XX = Gust speed
UUU = Units, one of:
KMH = Kilometers per hour
KT = Knots
MPS = Meters per second
 
Prepar3D extension follows the "&" character

Format of the extension is &DNNNNTS

where
NNNN is the depth (height) in meters. The default is 1000 feet or 305m.

T part is turbulence, one of:
N - None (default)
O or L - Light
M - Moderate
H - Heavy
S - Severe

S part is wind shear, one of:
G - Gradual (default)
M - Moderate
S - Steep
I - Instantaneous

The default extension would look like this: &D305NG
No
WINDS ALOFT (this section is an optional extension) Normal Metar strings do not contain winds aloft. However, you may specify this entry is an extension. Winds aloft can be entered in one of two formats, but do not use both. This section is not a replacement for setting the surface winds. The first format is slightly more flexible than the second, and should directly follow the SURFACE WINDS, the second format should appear at the end of the metar string.
 
The altitude of a WINDS ALOFT section specifies the top of the layer in which the given wind data is to apply. The bottom of the layer will be determined by the top of any lower layer, either another WINDS ALOFT entry, or the SURFACE WINDS entry.
 
Format 1:
 
This format is the same as the surface wind data format above except for the extension portion. Instead of specifying a surface layer depth, using &DNNNNTS, it specifies the altitude above the referenced weather station's altitude in meters. The extension format is &ANNNNTS.
 
Format 2:
 
@@@ A T D S | A T D S | .....
 
where
A is altitude in 100s of feet (-1500 to 100000)
T is temperature in Celsius (-250 to 100)
D is direction in degrees (0 to 360)
S is speed in knots (0 to 400)
 
Note that there can be more than one WINDS ALOFT entry, typically giving different wind strengths and the other data, for a range of altitudes.
Yes
MIN MAX WIND DIR XXXVYYY

XXX - start of heading range, in degrees
YYY - end of heading range, in degrees
 
This entry adds a variance in wind direction to the surface wind.
No
CAVOK Optional CAVOK keyword (meaning Ceiling and Visibility OK). It indicates that no clouds exist below 5,000 feet or below the highest minimum sector altitude, whichever is greater, and no cumulonimbus are present. Also the visibility is 10 kilometers or more and, no precipitation, thunderstorms, sandstorm, duststorm, shallow fog, or low drifting dust, sand or snow is occurring. No
VISIBILITY (has an extension) Like winds aloft the visibility group can be repeated to describe multiple visibility layers. There is also an extension to the format to allow layer base and depth to be specified.
 
Use one of the following formats:
 
Statute Miles:
M1/4SM or <1/4SM (visibility is less that a quarter of a statute mile)
ISM (visibility is measured in an integer number of statue miles)
N/DSM (visibility is measured as a fraction of a statue mile)
I N/DSM (visibility is measured in a whole part and fraction of a statue mile)
 
where
I = Integer part
N = Numerator
D = Denominator
 
The minimum fraction that can be entered is 1/8. Note that this is the only exception where a space can occur (between the I and the N) within a section.
 
Kilometers: NNKM
 
Meters: NNNND
 
where
D is directional variation, one of:
NDV - no directional variation
NE, NW, SE, SW, N, S, E, W - compass point
M meters - same as NDV

Prepar3D extension:

Format is &BXXXX&DYYYY

XXXX - base of visibility layer in meters
YYYY - depth of visibility layer in meters
Yes
RUNWAY VISUAL RANGE Use one of the following two formats:
RDD/VVVVFT
RDD/XXXXVYYYYFT

where
DD = Runway ID (1-6 characters)
VVVV = Visual range in feet. May have P (above maximum) or M (below minimum) prefix (following the slash).
XXXX = Varying minimum range in feet.
YYYY = Varying maximum range in feet.
Yes
PRESENT CONDITIONS IDDPP
 
where:
I - Intensity or vicinity flag:. -, + or VC. - means light, + means severe, and VC means vicinity. The + and - can be combined with VC. Leave out a + or - to mean moderate.
 
For example: +VCTSRA means severe thunderstorm with rain in the vicinity.
 
DD - Descriptor, one of:
MI shallow
PR partial
DC patches
DR low drifting
BL blowing
SH shower
TS thunderstorm
FZ freezing

PP - Phenomena, one of:

DZ drizzle
RA rain
SN snow
SG snow grains
IC ice crystals
PE ice pellets
GR hail
GS small hail/snow pellets
UP unknown

BR mist
FG fog
FU smoke
VA volcanic ash
DU dust
SA sand
HZ haze
PY spray
 
PO dust whirls
SQ squalls
FC funnel cloud/tornado/waterspout
SS sandstorm
DS duststorm
Yes
PARTIAL OBSCURATION One of:
 
FEW///
SCT///
BKN///
FEW000
SCT000
BKN000

 
These mean few, scattered or broken clouds are obscuring the view.
No
SKY CONDITIONS (has an extension) Note cloud heights are coded: If NNN is 999 the level is 100,000 feet, otherwise it is 100 x NNN in feet.
 
CCCNNN
 
Where NNN is the coded height, and CCC is one of::
 
CLR or SKC - sky clear
FEW - few clouds
SCT - scattered clouds
BKN - broken clouds
OVC - overcast
NTT - N/8ths cloud coverage of type TT, which is one of:

CI Cirrus
CS Cirro-stratus (maps to CI)
CC Cirro-cumulus (maps to CI)
AS Alto-stratus (maps to ST)
AC Alto-cumulus (maps to CU)
SC Strato-cumulus (maps to CU)
NS Nimbo-stratus (maps to ST)
ST Stratus
CU Cumulus
CB Cumulo-nimbus
 
Note that not all of these cloud types are supported, so a number are mapped to those which are. This does mean that a write followed by a read of Metar data might not give identical strings.
 
Prepar3D extension:

&TT000FTPQBBBI

where:
TT - Cloud type, one of: the list above (for example, CI or CB). If this entry is different from the NNN entry above, this entry will take priority.
000 - Unused.
F - Top of cloud, one of: F (flat), R (round), A (anvil)
T - Turbulence, one of: N - None (default), O - Light, L - Light, M - Moderate, H - Heavy, S - Severe
P - Precipitation, one of: V (very light), L (light), M (moderate), H (heavy) D (dense)
Q - Type of precipitation, one of: N (none), R (rain), F (freezing rain), H (hail), S (snow)
BBB - Coded base height, the precipitation ends at this height, set to 0 for it to land on the ground
I - icing rate, one of: N (none), T (trace), L (light), M (moderate), S (severe)

No
TEMPERATURE
(has an extension)
TT/DD
 
TT - temperature in Celsius
DD - dewpoint in Celsius
 
Negative values should be preceded by a minus sign.
 
Prepar3D extension:
&ANNNNN - altitude of the temperatures in meters.
Yes
ALTIMETER One of:
 
ANNNN - altimeter in degrees of mercury (for example, A2992)
QNNNN - altimeter in millibars
 
No
@@@ If these three characters are entered in the string, there is a WINDS ALOFT section following the metar string.  

Examples of Metar strings
Metar String Description
KSEA 030405Z 27007KT 15SM SKC 17/13 A2992 KSEA = Station Identifier (Sea-Tac airport)
030405Z = Time (ddhhmmZ)
27007KT = Winds (270 degrees at 7 knots)
15SM = Visibility (15 statute miles)
SKC = Clear skies
17/13 = Temperature /Dewpoint in Celsius
A2992 = Altimeter setting (29.92 in Hg)
KSEA COR 030405Z 27015KT 7SM +TSRA BKN055CB 30/17 A2974 Corrected report, same time as above, with 15 knot winds, 7 miles of visibility, severe thunderstorm and rain, broken cumulo-nimbus clouds at 5500 feet.
KSEA&A131 000000Z 00000KT&D985NG 100KM&B-581&D3048 2CU053&CU000FNMN-19N 15/05 Q1013 @@@ 65 15 270 20 | 196 15 270 25 | Fair weather at Sea-Tac airport. Two eights cumulus clouds at 5300 feet, 20 knot West winds at 6500 feet, 25 knot West winds at 19600 feet.

See Also


Observer Specific Functions

SimConnect_CreateObserver

The SimConnect_CreateObserver function creates an observer using SIMCONNECT_DATA_OBSERVER.

Syntax

HRESULT SimConnect_CreateObserver(
  HANDLE  hSimConnect,
  const char*  szName,
  SIMCONNECT_DATA_OBSERVER  ObserverData,
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szName
[in]  Specifies a descriptive name for the new observer view. This name will appear on the dialogs of Prepar3D.
ObserverData
[in]  Specifies all data for the observer to be created.


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

None.

See Also


SimConnect_RequestObserverData

The SimConnect_RequestObserverData function is used to retrieve information about an observer.

Syntax

HRESULT SimConnect_RequestObserverData(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID,
  const char*  szName,
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
RequestID
[in]  Specifies the ID of the client defined request. This is used later by the client to identify which data has been received. This value should be unique for each request, re-using a RequestID will overwrite any previous request using the same ID.
szName
[in]  Name of the observer view that data is being requested.


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

This function will return a SIMCONNECT_RECV_OBSERVER_DATA structure.

See Also


SimConnect_MoveObserver

The SimConnect_MoveObserver function moves an observer using an XYZ translation.

Syntax

HRESULT SimConnect_MoveObserver(
  HANDLE  hSimConnect,
  const char*  szName,
  SIMCONNECT_DATA_XYZ  Translation,
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szName
[in]  The name of the observer view that should be updated. This name appears on the observer dialogs of Prepar3D.
Translation
[in]  The xyz translation used to move the observer.


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

None.

See Also


SimConnect_RotateObserver

The SimConnect_RotateObserver function rotates the specified observer view.

Syntax

HRESULT SimConnect_RotateObserver(
  HANDLE  hSimConnect,
  const char*  szName,
  DWORD  dwAxis,
  double  dAngleDegrees,
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szName
[in]  The name of the observer view that should be updated. This name appears on the observer dialogs of Prepar3D.
dwAxis
[in]  The axis to rotate around. SIMCONNECT_OBSERVER_AXIS_PITCH is 0, SIMCONNECT_OBSERVER_AXIS_ROLL is 1, and SIMCONNECT_OBSERVER_AXIS_YAW is 2.
dAngleDegrees
[in]  The angle in degrees to rotate.


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

None.

See Also


SimConnect_SetObserverPosition

The SimConnect_SetObserverPosition function creates an observer using SIMCONNECT_DATA_OBSERVER.

Syntax

HRESULT SimConnect_SetObserverPosition(
  HANDLE  hSimConnect,
  const char*  szName,
  SIMCONNECT_DATA_LATLONALT  Position,
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szName
[in]  The name of the observer view that should be updated. This name appears on the observer dialogs of Prepar3D.
Position
[in]  The xyz position to place the observer. In meters.


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

None.

See Also


SimConnect_SetObserverRotation

The SimConnect_SetObserverRotation function creates an observer using SIMCONNECT_DATA_OBSERVER.

Syntax

HRESULT SimConnect_SetObserverRotation(
  HANDLE  hSimConnect,
  const char*  szName,
  SIMCONNECT_DATA_PBH  RotationAngles,
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szName
[in]  The name of the observer view that should be updated. This name appears on the observer dialogs of Prepar3D.
RotationAngles
[in]  The pitch, bank, and heading for the observer.


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

Noe.

See Also


SimConnect_SetObserverLookAt

The SimConnect_SetObserverLookAt function creates an observer using SIMCONNECT_DATA_OBSERVER.

Syntax

HRESULT SimConnect_SetObserverLookAt(
  HANDLE  hSimConnect,
  const char*  szName,
  SIMCONNECT_DATA_LATLONALT  TargetPosition,
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szName
[in]  The name of the observer view that should be updated. This name appears on the observer dialogs of Prepar3D.
TargetPosition
[in]  The location that the observer should be oriented towards.


Return Values


The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.
Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

None.

See Also


SimConnect_SetObserverLookAtEx

The SimConnect_SetObserverLookAtEx function orients the observer specified to look at the round world corrected position specified. This results in a more accurate orientation at larger distances (greater than 2 miles) when compared to SimConnect_SetObserverLookAt.

Syntax

HRESULT SimConnect_SetObserverLookAtEx(
  HANDLE  hSimConnect,
  const char*  szName,
  SIMCONNECT_DATA_LATLONALT  TargetPosition,
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szName
[in]  The name of the observer view that should be updated. This name appears on the observer dialogs of Prepar3D.
TargetPosition
[in]  The location that the observer should be oriented towards.


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

None.

See Also


SimConnect_ObserverTrackLocationOn

The SimConnect_ObserverTrackLocationOn function is used to have an observer track a world position (round world corrected) using an above ground level altitude and accounting for changes in elevation.

Syntax

HRESULT SimConnect_ObserverTrackLocationOn(
  HANDLE  hSimConnect,
  const char*  szName,
  SIMCONNECT_DATA_LATLONALT  TargetPosition,
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szName
[in]  The name of the observer view that should be updated. This name appears on the observer dialogs of Prepar3D.
TargetPosition
[in]  The location that the observer should be oriented towards. Altitude is AGL. Units are radians/meters.


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

None.

See Also


SimConnect_ObserverTrackLocationOff

The SimConnect_ObserverTrackLocationOff function is used to disable continuous tracking of the previously specified world position.

Syntax

HRESULT SimConnect_ObserverTrackLocationOff(
  HANDLE  hSimConnect,
  const char*  szName,
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szName
[in]  The name of the observer view that should be updated. This name appears on the observer dialogs of Prepar3D.


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

None.

See Also


SimConnect_ObserverAttachToEntityOn

The SimConnect_ObserverAttachToEntityOn function is used to attach an observer to the specified entity at the specified offset from the entity.

Syntax

HRESULT SimConnect_ObserverAttachToEntityOn(
  HANDLE  hSimConnect,
  const char*  szName,
  DWORD  dwObjectID,
  SIMCONNECT_DATA_XYZ  relativeXYZ,
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szName
[in]  The name of the observer view that should be updated. This name appears on the observer dialogs of Prepar3D.
dwObjectID
[in]  The ID of the object to attach to.
relativeXYZ
[in]  The offset that the observer should be from the attached entity.


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

None.

See Also


SimConnect_ObserverAttachToEntityOff

The SimConnect_ObserverAttachToEntityOff function is used to detach an observer from its attached entity.

Syntax

HRESULT SimConnect_ObserverAttachToEntityOff(
  HANDLE  hSimConnect,
  const char*  szName,
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szName
[in]  The name of the observer view that should be updated. This name appears on the observer dialogs of Prepar3D.


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

None.

See Also


SimConnect_SetObserverFieldOfView

The SimConnect_SetObserverFieldOfView function creates an observer using SIMCONNECT_DATA_OBSERVER.

Syntax

HRESULT SimConnect_SetObserverFieldOfView(
  HANDLE  hSimConnect,
  const char*  szName,
  float  fHorizontal,
  float  fVertical,
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szName
[in]  The name of the observer view that should be updated. This name appears on the observer dialogs of Prepar3D.
fHorizontal
[in]  The horizontal field of view for the observer. In degrees.
fVertical
[in]  The vertical field of view for the observer. In degrees.


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

None.

See Also


SimConnect_SetObserverStepSize

The SimConnect_SetObserverStepSize function creates an observer using SIMCONNECT_DATA_OBSERVER.

Syntax

HRESULT SimConnect_SetObserverStepSize(
  HANDLE  hSimConnect,
  const char*  szName,
  float  fLinearStep,
  float  fAngularStep,
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szName
[in]  The name of the observer view that should be updated. This name appears on the observer dialogs of Prepar3D.
fLinearStep
[in]  The linear step for the observer view. In meters.
fAngularStep
[in]  The angular step for the observer view. In degrees.


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

None.

See Also


SimConnect_SetObserverFocalLength

The SimConnect_SetObserverFocalLength function creates an observer using SIMCONNECT_DATA_OBSERVER.

Syntax

HRESULT SimConnect_SetObserverFocalLength(
  HANDLE  hSimConnect,
  const char*  szName,
  float  fFocalLength,
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szName
[in]  The name of the observer view that should be updated. This name appears on the observer dialogs of Prepar3D.
fFocalLength
[in]  The focal length for the observer. In meters.


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

None.

See Also


SimConnect_SetObserverFocusFixed

The SimConnect_SetObserverFocusFixed function creates an observer using SIMCONNECT_DATA_OBSERVER.

Syntax

HRESULT SimConnect_SetObserverFocusFixed(
  HANDLE  hSimConnect,
  const char*  szName,
  BOOL  bFocusFixed,
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szName
[in]  The name of the observer view that should be updated. This name appears on the observer dialogs of Prepar3D.
bFocusFixed
[in]  Specifies the observer focal point. If false, the observer automatically shifts focal point to the world (terrain) as the observer is manipulated. If true, the observer locks the focus to a fixed distance relative to the observer's position.


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

None.

See Also


SimConnect_SetObserverRegime

The SimConnect_SetObserverRegime function creates an observer using SIMCONNECT_DATA_OBSERVER.

Syntax

HRESULT SimConnect_SetObserverRegime(
  HANDLE  hSimConnect,
  const char*  szName,
  DWORD  eRegime,
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szName
[in]  The name of the observer view that should be updated. This name appears on the observer dialogs of Prepar3D.
eRegime
[in]  The restrictions of the observer. Tellurian (earth-based) is 0, Terrestrial (land-based) is 1, and Ghost (unimpeded) is 2.


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

None.

See Also


SimConnect_SetObserverZoomLevels

The SimConnect_SetObserverZoomLevels function creates an observer using SIMCONNECT_DATA_OBSERVER.

Syntax

HRESULT SimConnect_SetObserverZoomLevels(
  HANDLE  hSimConnect,
  const char*  szName,
  DWORD  dwNumLevels,
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szName
[in]  The name of the observer view that should be updated. This name appears on the observer dialogs of Prepar3D.
dwNumLevels
[in]  The number of zoom levels to being using.


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

None.

See Also


SimConnect_ObserverTrackEntityOn

The SimConnect_ObserverTrackEntityOn function sets the observer to continuously track the specified entity.

Syntax

HRESULT SimConnect_ObserverTrackEntityOn(
  HANDLE  hSimConnect,
  const char*  szName,
  DWORD  dwObjectID,
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szName
[in]  The name of the observer view that will track the specified object.
dwObjectID
[in]  The ID of the object to track.


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

None.

See Also


SimConnect_ObserverTrackEntityOff

The SimConnect_ObserverTrackEntityOff function turns off continuous tracking of the previously specified entity.

Syntax

HRESULT SimConnect_ObserverTrackEntityOff(
  HANDLE  hSimConnect,
  const char*  szName,
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szName
[in]  The name of the observer view that will no longer track the specified object.


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

None.

See Also


SimConnect_SetObserverSceneryOrigin

The SimConnect_SetObserverSceneryOrigin function sets scenery origin mode which is used for loading scenery and traffic.

Syntax

HRESULT SimConnect_SetObserverSceneryOrigin(
  HANDLE  hSimConnect,
  const char*  szName,
  DWORD  eSceneOrigin,
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szName
[in]  The name of the observer view that should be updated. This name appears on the observer dialogs of Prepar3D.
eSceneOrigin
[in]  The observers scenery origin mode. Self (own origin) is 0, and Target (focal point) is 1.


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

Setting scenery origin to Target can impact performance and memory usage because content will page in relative to the target which can move rapidly in some modes and may be far away for other cameras used by the sim. If the observer is in world focus the target is determined by projecting the view direction to a point on the ground (even when looking at a simulated object). .

See Also


Ground Info Specific Functions


Overview

The Ground Info API functions are used to request a grid of ground data around a point. There are two API commands available, one provides a one-shot request for data around a specific point, and the other can do one-shot or repeating requests around a specific SimObject.  Both versions return a North/South East/West oriented grid.  You can have a maximum of 100 points per requested grid, but you can have more than one grid request outstanding.


SimConnect_RequestGroundInfo

The SimConnect_RequestGroundInfo function is used to request a grid of altitude points based on a bounding box.

Syntax


SimConnect_RequestGroundInfo(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID,
  double  minLat,
  double  minLon,
  double  minAlt,
  double  maxLat,
  double  maxLon,
  double  maxAlt,
  DWORD  dwGridWidth,
  DWORD  dwGridHeight,
  SIMCONNECT_GROUND_INFO_LATLON_FORMAT  eLatLonFormat,
  SIMCONNECT_GROUND_INFO_ALT_FORMAT  eAltFormat,
  SIMCONNECT_GROUND_INFO_SOURCE_FLAG  eSourceFlags
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
RequestID
[in]  Specifies the ID of the client defined request. This is used later by the client to identify which request is receiving a reply. This value should be unique, re-using a RequestID will overwrite any previous request using the same ID.
minLat
[in]  The minimum Latitude defining the bounding box of the request grid.
minLon
[in]  The minimum Longitude defining the bounding box of the request grid.
minAlt
[in]  The minimum Altitude defining the bounding box of the request grid.
maxLat
[in]  The maximum Latitude defining the bounding box of the request grid.
maxLon
[in]  The maximum Longitude defining the bounding box of the request grid.
maxAlt
[in]  The maximum Altitude defining the bounding box of the request grid.
dwGridWidth
[in]  The number of sample points left/right for the returned grid.  The product of dwGridWidth times dwGridHeight must be less than or equal to 100.
dwGridHeight
[in]  The number of sample points forward/back for the returned grid.  The product of dwGridWidth times dwGridHeight must be less than or equal to 100.
eLatLonFormat
[in]  A member of the SIMCONNECT_GROUND_INFO_LATLON_FORMAT enumeration specifying the format used for Latitude or Longitude values.
eAltFormat
[in]  A member of the SIMCONNECT_GROUND_INFO_ALT_FORMAT enumeration specifying the format used for Altitude values.
eSourceFlags
[in]  One or more members of the SIMCONNECT_GROUND_INFO_SOURCE_FLAG enumeration specifying sources of ground info to use.


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_RequestGroundInfoOnSimObject

Syntax


HRESULT SimConnect_RequestGroundInfoOnSimObject(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID,
  DWORD  ObjectID,
  double  offsetLat,
  double  offsetLon,
  double  offsetAlt,
  DWORD  dwGridWidth,
  DWORD  dwGridHeight,
  SIMCONNECT_GROUND_INFO_LATLON_FORMAT  eLatLonFormat,
  SIMCONNECT_GROUND_INFO_ALT_FORMAT  eAltFormat,
  SIMCONNECT_GROUND_INFO_SOURCE_FLAG  eSourceFlags
  SIMCONNECT_PERIOD  Period,
  SIMCONNECT_DATA_REQUEST_FLAG  Flags = 0,
  DWORD  origin = 0,
  DWORD  interval = 0,
  DWORD  limit = 0
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
RequestID
[in]  Specifies the ID of the client defined request. This is used later by the client to identify which request is receiving a reply. This value should be unique, re-using a RequestID will overwrite any previous request using the same ID.
ObjectID
[in]  Specifies the ID of the Prepar3D object that the ground info grid should be based on. This ID can be SIMCONNECT_OBJECT_ID_USER (to specify the user's aircraft) or obtained from a SIMCONNECT_RECV_SIMOBJECT_DATA_BYTYPE structure after a call to SimConnect_RequestDataOnSimObjectType.
offsetLat
[in]  Latitude offset from SimObject center point to North/South edges of bounding box.
offsetLon
[in]  Longitude offset from SimObject center point to East/West edges of bounding box.
offsetAlt
[in]  Altitude offset from SimObject center point to Top/Bottom edges of bounding box.
dwGridWidth
[in]  The number of sample points East/West for the returned grid.  The product of dwGridWidth times dwGridHeight must be less than or equal to 100.
dwGridHeight
[in]  The number of sample points North/South for the returned grid.  The product of dwGridWidth times dwGridHeight must be less than or equal to 100.
eLatLonFormat
[in]  A member of the SIMCONNECT_GROUND_INFO_LATLON_FORMAT enumeration specifying the format used for Latitude or Longitude values.
eAltFormat
[in]  A member of the SIMCONNECT_GROUND_INFO_ALT_FORMAT enumeration specifying the format used for Altitude values.
eSourceFlags
[in]  One or more members of the SIMCONNECT_GROUND_INFO_SOURCE_FLAG enumeration specifying sources of ground info to use.
Period
[in]  One member of the SIMCONNECT_PERIOD enumeration type, specifying how often the data is to be sent by the server and received by the client.
Flags
[in, optional]  A DWORD containing one or more of the following values:
Flag value Description
0 The default, data will be sent strictly according to the defined period.
SIMCONNECT_DATA_REQUEST_FLAG_CHANGED Data will only be sent to the client when the SimObject has moved.
SIMCONNECT_DATA_REQUEST_FLAG_BLOCK Requested data will be sent using a blocking callback. See SimConnect_RequestSynchronousBlock for more information.
origin
[in, optional]  The number of Period events that should elapse before transmission of the data begins. The default is zero, which means transmissions will start immediately.
interval
[in, optional]  The number of Period events that should elapse between transmissions of the data. The default is zero, which means the data is transmitted every Period.
limit
[in, optional]  The number of times the data should be transmitted before this communication is ended. The default is zero, which means the data should be transmitted endlessly.


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


Synchronous SimConnect Specific Functions

Overview

The Synchronous SimConnect API functions are used to synchronize the code running in your SimConnect add-on with the main sim.  The Synchronous APIs do this by "pausing" execution of the sim code until it receives a release command from the SimConnect client, or a timeout occurs (default timeout value is 1.5 seconds). 

The Synchronous API has 3 specific APIs that allow creating just Synchronous blocks and releases.

There are also extensions to other APIs related to Synchronous SimConnect. The External Sim API uses the Synchronous SimConnect APIs implicitly. The RequestData/SetData, RequestClientData/SetClientData, and RequestGroundInfo APIs have new _FLAG_BLOCK/_FLAG_UNBLOCK flag values to block/unblock the sim side code. There's also an extended SubscribeToSystemEventEx that includes a new flags value with a _FLAG_BLOCK.

The Synchronous API maintains a timeout check and if your add-on code hasn't released the block within the timeout value, then the block is released automatically and an exception is sent to your add-on code. The default value for this timeout is 1.5 seconds.


SimConnect_RequestSynchronousBlock

The SimConnect_RequestSynchronousBlock function is used to request a recurring callback (based on the Period) that is also a blocking callback.

Syntax


HRESULT SimConnect_RequestSynchronousBlock(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID,
  SIMCONNECT_PERIOD  Period,
  SIMCONNECT_DATA_REQUEST_FLAG  Flags = 0,
  DWORD  origin = 0,
  DWORD  interval = 0,
  DWORD  limit = 0
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
RequestID
[in]  Specifies the ID of the client defined request. This is used later by the client to identify which request is receiving a reply. This value should be unique, re-using a RequestID will overwrite any previous request using the same ID.
Period
[in]  One member of the SIMCONNECT_PERIOD enumeration type, specifying how often the reply is to be sent by the server and received by the client.
Flags
[in, optional]  A DWORD containing one or more of the following values:
Flag value Description
0 The default, will assume SIMCONNECT_DATA_REQUEST_FLAG_BLOCK was provided.
SIMCONNECT_DATA_REQUEST_FLAG_BLOCK Requested reply will be sent using a blocking callback.
origin
[in, optional]  The number of Period events that should elapse before transmission of the data begins. The default is zero, which means transmissions will start immediately.
interval
[in, optional]  The number of Period events that should elapse between transmissions of the data. The default is zero, which means the data is transmitted every Period.
limit
[in, optional]  The number of times the data should be transmitted before this communication is ended. The default is zero, which means the data should be transmitted endlessly.


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_SynchronousUnblock

The SimConnect_SynchronousUnblock function is used to release the block on any blocking callback.

Syntax


HRESULT SimConnect_SynchronousUnblock(
  HANDLE  hSimConnect
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Sample

Primary sample External Sim

See Also


SimConnect_SetSynchronousTimeout

The SimConnect_SetSynchronousTimeout function is used to set the timeout value for any blocking callbacks (if this time is exceeded without the block being released, the block is released and an exception is sent to the client).

Syntax


HRESULT SimConnect_SetSynchronousTimeout(
  HANDLE  hSimConnect
  float  fTimeSeconds
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
fTimeSeconds
[in]  New timeout value for blocking callbacks.


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


External Sim Specific Functions

Overview

The External Sim APIs are used to write your own simulation code in a SimConnect Addon.  When using an External Sim, instead of your SimObject behaving like an aircraft, helicopter, boat, ground vehicle, etc, it will behave how ever the code in your external sim add-on wants it to.

There are two primary ways to use/create an External Sim based SimObject:

  1. Define a complete SimObject container that has a Category=ExternalSim line in the [General] section of the sim.cfg/aircraft.cfg file and at least an ExternalSimID = {GUID_STRING} line in the [fltsim.n] sections, for an External Secondary Sim, you just need an ExternalSecondarySimID = {GUID_STRING} in the [fltsim.n] section.  When using this method you can use the standard Select Aircraft/Vehicle dialog to select the SimObject for use, or any of the standard AICreateXxx SimConnect functions.  There is a Sample External Sim SimObject container included in the SDK that you can use as a reference/template for creating your own External Sim related SimObjects.

  2. Use the API functions that allow creating AI objects or User objects using an existing SimObject container but providing your own external sim code to run instead of whatever would normally run for that SimObject.  When using this method, you must use one of the External Sim related create/attach functions - SimConnect_AICreateObjectWithExternalSim, SimConnect_ChangeVehicleWithExternalSim, or SimConnect_AttachExternalSecondarySimToSimObject.

There are two types of External Sims:

  1. An External Sim which provides all of the required code to simulate the vehicles movement.  This provides the primary sim code for the SimObject.

  2. An External Secondary Sim which just provides additional simulation to another SimObject (the primary sim could be one of the built in categories, or another External Sim).  You could have a tracked vehicle primary sim, and then use an External Secondary Sim to provide the simulation/drive animation vars/etc for a tank turret, and the same tank turret External Secondary Sim could also be used with a Wheeled vehicle primary sim or a Boat vehicle primary sim.

The External Sim APIs use the Synchronous SimConnect functionality implicitly (meaning you need to use one of the Unblock methods in all of the External Sim related callbacks). This is why the Register External Sim function accepts a callback mask, set this to only include the callbacks you actually implement handlers for.

The first thing an External Sim add-on needs to do is use the RegisterExternalSim/RegisterExternalSecondarySim function to let SimConnect know you want to provide External Sim services.  To register, you provide a GUID (used to reference this external sim from sim.cfg/aircraft.cfg files or other API functions), a callback mask (set to only the callbacks you actually implement handlers for), and a structure definition ID of the data structure that will be passed to the Simulate callback.

Before your add-on code exits, it should use the UnregisterExternalSim/UnregisterExternalSecondarySim function to let SimConnect know you will no longer be providing services for that GUID.

There are 5 External Sim Callbacks:

  1. Create - this is called whenever a SimObject using your External Sim is created.

  2. Destroy - this is called whenever a SimObject using your External Sim is destroyed.

  3. Simulate - this is called every simulation frame for each SimObject using your External Sim.

  4. Location Changed - this is called whenever a SimObject has potentially moved, primarily due to user UI manipulations.

  5. Event - this is called whenever a mapped event occurs. In order to map specific events be sent to your external sim add-on, you use the MapClientEventToSimEvent function.

To programmatically create AI objects that use a specific External Sim, you use the AICreateObjectWithExternalSim function to load an existing SimObject but override it to use an External Sim instead.

To programmatically create a User object that uses a specific External Sim, you use the ChangeVehicleWithExternalSim function to load an existing SimObject but override it to use an External Sim instead.

For External Secondary Sims, you don't use a create function, instead you use AttachExternalSecondarySimToSimObject/ DetachExternalSecondarySimFromSimObject to attach/detach an External Secondary sim to/from an existing Simobject.

A primary External Sim can write to any of the defined SimVars. A Secondary External Sim can write to any of the defined SimVars that aren't already being handled by the primary sim.

An External Sim can also make use of the Ground Info APIs to get a small grid of ground data around it's SimObject.

Besides providing the ability to simulate the physics for a SimObject, the External Sim APIs can also be used to create pseudo-multiplayer style add-ons allowing some external data source (an Entity Generator or another sim) to drive SimObjects around the sim world.


SimConnect_RegisterExternalSim

The SimConnect_RegisterExternalSim function is used to register a SimConnect client as an external sim provider.

Syntax


HRESULT SimConnect_RegisterExternalSim(
  HANDLE  hSimConnect,
  const GUID  guidExternalSimID,
  SIMCONNECT_EXTERNAL_SIM_CALLBACK_FLAG  CallbackMask,
  SIMCONNECT_DATA_DEFINITION_ID  DefineID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
guidExternalSimID
[in]  The GUID used to denote this external sim.
CallbackMask
[in]  One or more members of the SIMCONNECT_EXTERNAL_SIM_CALLBACK_FLAG enumeration that specify which External Sim Callbacks this client wants to receive.
DefineID
[in]  The data definition ID for any data you would like to have sent with the External Sim Simulate Callback.


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Sample

Primary sample External Sim

See Also


SimConnect_UnregisterExternalSim

The SimConnect_UnregisterExternalSim function is used to unregister a SimConnect client as an external sim provider.

Syntax


HRESULT SimConnect_UnregisterExternalSim(
  HANDLE  hSimConnect,
  const GUID  guidExternalSimID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
guidExternalSimID
[in]  The GUID used to denote this external sim.


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Working Sample

Primary sample External Sim

See Also


SimConnect_RegisterExternalSecondarySim

The SimConnect_RegisterExternalSecondarySim function is used to register a SimConnect client as an external secondary sim provider.

Syntax


HRESULT SimConnect_RegisterExternalSecondarySim(
  HANDLE  hSimConnect,
  const GUID  guidExternalSecondarySimID,
  SIMCONNECT_EXTERNAL_SIM_CALLBACK_FLAG  CallbackMask,
  SIMCONNECT_DATA_DEFINITION_ID  DefineID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
guidExternalSecondarySimID
[in]  The GUID used to denote this external secondary sim.
CallbackMask
[in]  One or more members of the SIMCONNECT_EXTERNAL_SIM_CALLBACK_FLAG enumeration that specify which External Sim Callbacks this client wants to receive.
DefineID
[in]  The data definition ID for any data you would like to have sent with the External Sim Simulate Callback.


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_UnregisterExternalSecondarySim

The SimConnect_UnregisterExternalSecondarySim function is used to unregister a SimConnect client as an external secondary sim provider.

Syntax


HRESULT SimConnect_UnregisterExternalSecondarySim(
  HANDLE  hSimConnect,
  const GUID  guidExternalSecondarySimID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
guidExternalSecondarySimID
[in]  The GUID used to denote this external secondary sim.


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_AttachExternalSecondarySimToSimObject

The SimConnect_AttachExternalSecondarySimToSimObject function is used to attach an External Secondary Sim to an existing SimObject.

Syntax


HRESULT SimConnect_AttachExternalSecondarySimToSimObject(
  HANDLE  hSimConnect,
  DWORD  dwObjectID,
  const GUID  guidExternalSecondarySimID,
  const char *  szExternalSimParams,
  DWORD  dwExternalSimVarCount
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
dwObjectID
[in]  ID of the SimObject to attach to.
guidExternalSecondarySimID
[in]  The GUID of the external secondary sim you want to attach.
szExternalSimParams
[in]  A string containing parameters to pass to the external secondary sim. Not used internally, but retrievable through the EXTERNAL PRIMARY SIM DATA simulation variable.
dwExternalSimVarCount
[in]  Number of variables to allocate for this external secondary sim to use (range 0 to 999).


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_DetachExternalSecondarySimFromSimObject

The SimConnect_DetachExternalSecondarySimFromSimObject function is used to detach an External Secondary Sim from an existing SimObject.

Syntax


HRESULT SimConnect_DetachExternalSecondarySimFromSimObject(
  HANDLE  hSimConnect,
  DWORD  dwObjectID,
  const GUID  guidExternalSecondarySimID,
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
dwObjectID
[in]  ID of the SimObject to attach to.
guidExternalSecondarySimID
[in]  The GUID of the external secondary sim you want to attach.


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_AICreateObjectWithExternalSim

The SimConnect_AICreateObjectWithExternalSim function is used to create an AI object and override the sim to use a specific external secondary sim.

Syntax


HRESULT SimConnect_AICreateObjectWithExternalSim(
  HANDLE  hSimConnect,
  const char *  szContainertitle,
  SIMCONNECT_DATA_INITPOSITION  InitPos,
  SIMCONNECT_DATA_REQUEST_ID RequestID,
  const GUID  guidExternalSimID,
  const char *  szExternalSimParams,
  DWORD  dwExternalSimVarCount
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szContainertitle
[in]  Null-terminated string containing the container title.
InitPos
[in]  Specifies the initial position, using a SIMCONNECT_DATA_INITPOSITION structure.
RequestID
[in]  Specifies the client defined request ID.
guidExternalSimID
[in]  The GUID of the external secondary sim you want to use to override the default SimObject's sim.
szExternalSimParams
[in]  A string containing parameters to pass to the external sim. Not used internally, but retrievable through the EXTERNAL PRIMARY SIM DATA simulation variable.
dwExternalSimVarCount
[in]  Number of variables to allocate for this external sim to use (range 0 to 999).


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_ChangeVehicleWithExternalSim

The SimConnect_ChangeVehicleWithExternalSim function is used to load a new user vehicle and override the sim using a specific external sim.

Syntax


HRESULT SimConnect_ChangeVehicleWithExternalSim(
  HANDLE  hSimConnect,
  const char *  szContainertitle,
  const GUID  guidExternalSimID,
  const char *  szExternalSimParams,
  DWORD  dwExternalSimVarCount
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szContainertitle
[in]  Null-terminated string containing the container title.
guidExternalSimID
[in]  The GUID of the external secondary sim you want to use to override the default SimObject's sim.
szExternalSimParams
[in]  A string containing parameters to pass to the external sim. Not used internally, but retrievable through the EXTERNAL PRIMARY SIM DATA simulation variable.
dwExternalSimVarCount
[in]  Number of variables to allocate for this external sim to use (range 0 to 999).


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


Attach Sim Specific Functions

Overview

The Attach Sim APIs are used to attach one SimObject to another SimObject.  There's no physical simulation of the attached objects (i.e. the mass of an attached object doesn't affect the object its attached to, the attached object just suspends simulation and moves with the object its attached to.  When an attached object is released, it's primary sim resumes operation.

There are two versions of the attach API, AttachObjectToSimObject will create a new AI object and attach it to the specified SimObject. AttachSimObjectToSimObject is used to attach one existing SimObject to another SimObject (you can both attach the User SimObject to another object or attach other SimObjects to a User SimObject with this function).


SimConnect_AttachObjectToSimObject

The SimConnect_AttachObjectToSimObject function is used to create a new AI SimObject and attach it to an existing SimObject.

Syntax


HRESULT SimConnect_AttachObjectToSimObject(
  HANDLE  hSimConnect,
  DWORD  dwObjectID,
  SIMCONNECT_DATA_XYZ  vecOff1,
  SIMCONNECT_DATA_PBH  rotOff1,
  const char *  szContainertitle
  SIMCONNECT_DATA_XYZ  vecOff2
  SIMCONNECT_DATA_PBH  rotOff2
  SIMCONNECT_DATA_REQUEST_ID  RequestID
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
dwObjectID
[in]  ObjectID of the existing SimObject to attach to.
vecOff1
[in]  XYZ offset from existing SimObject model center to attachment point.
rotOff1
[in]  PBH offset from existing SimObject model body axis to attachment point.
szContainertitle
[in]  Null-terminated string containing the container title of the AI SimObject you want to create and attach to the existing SimObject. The container title is found in the aircraft.cfg file (see the Aircraft Configuration Files document): for example: title=Airbus A321, or title= Aircreation582SL.
vecOff2
[in]  XYZ offset from created AI SimObject model center to attachment point..
rotOff2
[in]  PBH offset from created AI SimObject model body axis to attachment point.
RequestID
[in]  Specifies the ID of the client-defined request. This is used later by the client to identify which data has been received. This value should be unique for each request, re-using a RequestID will overwrite any previous request using the same ID.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_AttachSimObjectToSimObject

The SimConnect_AttachSimObjectToSimObject function is used to create a new AI SimObject and attach it to an existing SimObject.

Syntax


HRESULT SimConnect_AttachSimObjectToSimObject(
  HANDLE  hSimConnect,
  DWORD  dwObjectID1,
  SIMCONNECT_DATA_XYZ  vecOff1,
  SIMCONNECT_DATA_PBH  rotOff1,
  DWORD  dwObjectID2
  SIMCONNECT_DATA_XYZ  vecOff2
  SIMCONNECT_DATA_PBH  rotOff2
);

Parameters


hSimConnect
[in]  Handle to a SimConnect object.
dwObjectID1
[in]  ObjectID of the existing SimObject to attach to.
vecOff1
[in]  XYZ offset from dwObjectID1's model center to attachment point.
rotOff1
[in]  PBH offset from dwObjectID1's model body axis to attachment point.
dwObjectID2
[in]  ObjectID of the existing SimObject that is being attached to dwObjectID1.
vecOff2
[in]  XYZ offset from dwObjectID2's model center to attachment point..
rotOff2
[in]  PBH offset from dwObjectID2's model body axis to attachment point.


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_ReleaseSimObjectFromSimObject

The SimConnect_ReleaseSimObjectFromSimObject function is used to release a SimObject from the SimObject it is attached to.

Syntax


HRESULT SimConnect_ReleaseSimObjectFromSimObject(
  HANDLE  hSimConnect,
  DWORD  dwObjectID1,
  DWORD  dwObjectID2
);

Parameters


hSimConnect
[in]  Handle to a SimConnect object.
dwObjectID1
[in]  ObjectID of the existing SimObject that dwObjectID2 is being released from.
dwObjectID2
[in]  ObjectID of the existing SimObject that is being released from dwObjectID1.


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


Attach Weapon Specific Functions

Overview

The Attach Weapon APIs are used to attach one Weapon to a SimObject.  The attach call can be made multiple times to fill out the required number of weapons. The hardpoints must be setup on the SimObject in order to use the Attach Weapon APIs.


SimConnect_AttachWeaponToObject

The SimConnect_AttachWeaponToObject function is used to attach a Weapon to a SimObject.

Syntax


HRESULT SimConnect_AttachWeaponToObject(
  HANDLE  hSimConnect,
  const char*  szContainertitle,
  SIMCONNECT_OBJECT_ID  dwObjectID
  int  attachPoint
  int  numOfRounds
);

Weapon Examples
title=AIM-9M_Sidewinder
title=AGM-88_HARM
title=AIM-120_AMRAAM

Parameters


hSimConnect
[in]  Handle to a SimConnect object.
szContainertitle
[in]  null-terminated string containing title of the Weapon being attached to ObjectID.
dwObjectID
[in]  ObjectID of the existing SimObject.
attachPoint
[in]  int containing the station index from the object's Attachments.xml file.
numOfRounds
[in]  int containing the number of rounds of the weapon being attached.


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_ClearWeapons

The SimConnect_ClearWeapons function is used to remove all Weapons from a SimObject.

Syntax


HRESULT SimConnect_ClearWeapons(
  HANDLE  hSimConnect,
  SIMCONNECT_OBJECT_ID  dwObjectID
);

Parameters


hSimConnect
[in]  Handle to a SimConnect object.
dwObjectID
[in]  ObjectID of the existing SimObject.


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


Effects Specific Functions

Overview

The Effects APIs are used to create effects.  Effects can be placed at a location or attached to a SimObject. These effects can also be timed so they don't last forever.


SimConnect_CreateEffect

The SimConnect_CreateEffect function is used to create an effect.

Syntax


HRESULT SimConnect_CreateEffect(
  HANDLE  hSimConnect,
  const char*  effectName,
  SIMCONNECT_DATA_LATLONALT  TargetPosition
  SIMCONNECT_DATA_XYZ  offset
  BOOL  attachToSimObject
  DWORD  dwObjectID
  SIMCONNECT_DATA_REQUEST_ID  RequestID
  int  effectDuration
);

Parameters


hSimConnect
[in]  Handle to a SimConnect object.
effectName
[in]  null-terminated string containing the title of the effect to be created.
Effect Examples
title=fx_explosion
title=fx_flamingDebris
TargetPosition
[in]  SIMCONNECT_DATA_LATLONALT containing the location of the effect.
offset
[in]  SIMCONNECT_DATA_XYZ containing the offset from the location or the attached point of the SimObject.
attachToSimObject
[in]  BOOL determining whether to use the TargetPosition or to attach to the SimObject.
dwObjectID
[in]  ObjectID of an existing SimObject the effect should be attached to.
RequestID
[in]  RequestID containing the client defined request ID.
effectDuration
[in, optional]  int containing the number of seconds that the effect will last. (default value = -1, for unlimited)

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

The effectId, which can be used by SimConnect_RemoveEffect, will be returned as a SIMCONNECT_RECV_ASSIGNED_OBJECT_ID structure as the dwObjectID parameter.

See Also


SimConnect_RemoveEffect

The SimConnect_RemoveEffect function is used to remove an effect.

Syntax


HRESULT SimConnect_RemoveEffect(
  HANDLE  hSimConnect,
  DWORD  effectId
);

Parameters


hSimConnect
[in]  Handle to a SimConnect object.
effectId
[in]  Double Word containing the identifier of the effect to be removed.


Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


Recorder Specific Functions

Overview

The Recorder APIs are used to start and stop the Prepar3D recorder as well as playback specified recordings.


SimConnect_PlaybackRecording

The SimConnect_PlaybackRecording function is used to playback a specified recording from a specified start time to a specified end time.

Syntax

HRESULT SimConnect_PlaybackRecording(
  HANDLE  hSimConnect,
  const char *  szFileName
  double  startTimeInSeconds
  double  endTimeInSeconds
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szFileName
[in]  The file path of the recording to playback.
startTimeInSeconds
[in]  The time (in seconds) within the recording where the playback should start (0 is the start of the recording).
endTimeInSeconds
[in]  The time (in seconds) within the recording where the playback should end (-1 is the end of the recording).

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

You must specify the full path to the recording in order to play it using SimConnect_PlaybackRecording.

See Also


SimConnect_StartRecorder

The SimConnect_StartRecorder function is used to trigger the Prepar3D Recorder to start recording.

Syntax

HRESULT SimConnect_StartRecorder(
  HANDLE  hSimConnect,
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_StopRecorderAndSaveRecording

The SimConnect_StopRecorderAndSaveRecording function is used to trigger the Prepar3D Recorder to stop recording and either prompt the user or save the recording with a specified file name.

Syntax

HRESULT SimConnect_StopRecorderAndSaveRecording(
  HANDLE  hSimConnect,
  const char *  szTitle
  const char *  szDescription
  BOOL  promptUser
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
szTitle
[in]  The title and file name that the recording will be saved with.
szDescription
[in]  The description that the recording will be saved with.
promptUser
[in]  If true, rather than use the specified title and description, the user is prompted to specify the title and description for the recording.

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

See Also


SimConnect_RequestRecordingInfo

The SimConnect_RequestRecordingInfo function is used to request information on a given recording file.

Syntax

HRESULT SimConnect_RequestRecordingInfo(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID
  const char *  szFileName
  UINT  cbszFileName
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
RequestID
[in]  RequestID containing the client defined request ID.
szFileName
[in]  The file path of the recording.
cbszFileName
[in]  The size of the file path in bytes (not currently used).

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

You must specify the full path to the recording.

See Also


SimConnect_RequestBookmarkInfo

The SimConnect_RequestBookmarkInfo function is used to request bookmark information on a given recording file.

Syntax

HRESULT SimConnect_RequestBookmarkInfo(
  HANDLE  hSimConnect,
  SIMCONNECT_DATA_REQUEST_ID  RequestID
  const char *  szFileName
  UINT  cbszFileName
);

Parameters

hSimConnect
[in]  Handle to a SimConnect object.
RequestID
[in]  RequestID containing the client defined request ID.
szFileName
[in]  The file path of the recording.
cbszFileName
[in]  The size of the file path in bytes (not currently used).

Return Values

The function returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return value Description
S_OK The function succeeded.
E_FAIL The function failed.

Remarks

You must specify the full path to the recording.

See Also


SimConnect Structures and Enumerations

SimConnect uses the following structures and enumerations.

Name Structure or Enumeration Description
SIMCONNECT_CLIENT_DATA_PERIOD Enum Used with the SimConnect_RequestClientData call to specify how often data is to be sent to the client.
SIMCONNECT_DATA_RACE_RESULT Struct Used to hold multiplayer racing results.
SIMCONNECT_DATATYPE Enum Used with the SimConnect_AddToDataDefinition call to specify the data type that the server should use to return the specified data to the client.
SIMCONNECT_DATA_GROUND_INFO Struct Used to return info about one ground point entry in the array returned by a call to SimConnect_RequestGroundInfo or SimConnect_RequestGroundInfoOnSimObject
SIMCONNECT_DATA_FACILITY_AIRPORT Struct Used to return information on a single airport in the facilities cache.
SIMCONNECT_DATA_FACILITY_NDB Struct Used to return information on a single NDB station in the facilities cache.
SIMCONNECT_DATA_FACILITY_VOR Struct Used to return information on a single VOR station in the facilities cache.
SIMCONNECT_DATA_FACILITY_TACAN Struct Used to return information on a single TACAN station in the facilities cache.
SIMCONNECT_DATA_FACILITY_WAYPOINT Struct Used to return information on a single waypoint in the facilities cache.
SIMCONNECT_DATA_INITPOSITION Struct