| General Functions | |
| Client Event Specific Function Name | |
AddClientEventToNotificationGroup(GroupID as [Enum], EventID as [Enum], bMaskable as Boolean)Used to add an individual client defined event to a notification group. | |
MapInputEventToClientEvent(GroupID as [Enum], szInputDefinition as String, DownEventID as [Enum], DownValue as UInteger, UpEventID as [Enum], UpValue as UInteger, bMaskable as Boolean) Used to connect input events (such as keystrokes, joystick or mouse movements) with the sending of appropriate event notifications. | |
MapClientEventToSimEvent(EventID as [Enum], EventName as String)Used to associate a client defined event ID with an Prepar3D event name. | |
RemoveClientEvent(GroupID as [Enum], EventID as [Enum])Used to remove a client defined event from a notification group. | |
TransmitClientEvent(ObjectID as UInteger, EventID as [Enum], dwData as UInteger, GroupID as [Enum], Flags as SIMCONNECT_EVENT_FLAG) {{-32 bit-}}Used to request that the Prepar3D server transmit to all SimConnect clients the specified client event. This version of the function provides a 32-bit context data field. | |
TransmitClientEvent64(ObjectID as UInteger, EventID as [Enum], dwData as UInteger, GroupID as [Enum], Flags as SIMCONNECT_EVENT_FLAG) {{-64 bit-}}Used to request that the Prepar3D server transmit to all SimConnect clients the specified client event. This version of the function provides a 64-bit context data field. |
| Client Data Specific Function Name | |
AddToClientDataDefinition(DefineID as [Enum, dwOffset as UInteger, dwSizeOrType as UInteger, fEpsilon as Single, DatumID as UInteger])Used to add an offset and a size in bytes, or a type, to a client data definition. | |
CreateClientData(ClientDataID as [Enum, dwSize as UInteger, Flags as SIMCONNECT_CREATE_CLIENT_DATA_FLAG])Used to request the creation of a reserved data area for this client. | |
MapClientDataNameToID(szClientDataName as string, ClientDataID as [Enum])Used to associate an ID with a named client date area. | |
RequestClientData(ClientDataID as [Enum], RequestID as [Enum], DefineID as [Enum], Period as SIMCONNECT_CLIENT_DATA_PERIOD, Flags as SIMCONNECT_CLIENT_DATA_REQUEST_FLAG, Origin as UInteger, Interval as UInteger, Limit as UInteger)Used to request that the data in an area created by another client be sent to this client. | |
SetClientData(ClientDataID as [Enum], DefineID as [Enum], Flags as SIMCONNECT_DATA_SET_FLAG, dwReserved as UInteger, pDataSet as Object)Used to write one or more units of data to a client data area. | |
ClearClientDataDefinition(DefineID as [Enum])Used to clear the definition of the specified client data. |
| Notification Group Specific Function Name | |
AddClientEventToNotificationGroup(GroupID as [Enum], EventID as [Enum], bMaskable as Boolean)Used to add an individual client defined event to a notification group. | |
ClearNotificationGroup(GroupID as [Enum])Used to remove all the client defined events from a notification group. | |
RequestNotificationGroup(GroupID as [Enum]), dwReserved as UInteger, Flags as UInteger)Used to request events are transmitted from a notification group, when the simulationis in Dialog Mode. | |
SetNotificationGroupPriority(GroupID as [Enum], uPriority as UInteger) Used to set the priority of a notification group. |
| Input Event Specific Function Name | |
MapInputEventToClientEvent(GroupID as [Enum], szInputDefinition as String, DownEventID as [Enum], DownValue as UInteger, UpEventID as [Enum], UpValue as UInteger, bMaskable as Boolean))Used to connect input events (such as keystrokes, joystick or mouse movements) with the sending of appropriate event notifications. | |
RemoveInputEvent(GroupID as [Enum], szinputDefinition as String)Used to remove an input event from a specified input group object. | |
RequestJoystickDeviceInfo(RequestID as [Enum])Used to request the name and number of currently connected joystick devices. | |
RequestReservedKey(EventID as [Enum], szKeyChoice1 as String, szKeyChoice2 as String szKeyChoice3 as String) Used to request a specific keyboard TAB-key combination applies only to this client |
| Input Group Specific Function Name | |
ClearInputGroup(GroupID as [Enum]Used to remove all the input events from a specified input group object. | |
SetInputGroupPriority(GroupID as [Enum], uPriority as UInteger)Used to set the priority for a specified input group object. | |
SetInputGroupState(GroupID as [Enum], dwState as UInteger)Used to turn requests for input event information from the server on and off. |
| System Event Function Name | |
SetSystemEventState(EventID as [Enum]), dwState as SIMCONNECT_STATEUsed to turn requests for event information from the server on and off. | |
SubscribeToSystemEvent(EventID as [Enum], EventName as String)Used to request that a specific system event is notified to the client. | |
SubscribeToSystemEventEx(EventID as [Enum], EventName as String, Flags as SIMCONNECT_EVENT_SUBSCRIPTION_FLAG)Used to request that a specific system event is notified to the client. Flags allowyou to request a blocking callback. | |
SubscribeToSystemEventW(EventID as [Enum], EventName as String, Flags as SIMCONNECT_EVENT_SUBSCRIPTION_FLAG)d to request that a specific system event is notified to the client. Flags allowyou to request a blocking callback. This version of the function supports unicode string results. | |
UnsubscribeToSystemEvent(EventID as [Enum], EventName as String)Used to request that notifications are no longer received for the specified systemevent. |
| System State Function Name | |
SetSystemState(szState as String, dwInteger as UInteger. fFloat as Single, szString as String)Used to access a number of Prepar3D system components. | |
RequestSystemState(RequestID as [Enum, szState as String])Used to request information from a number of Prepar3D system components. | |
RequestSystemStateW(RequestID as [Enum, szState as String]) Used to request information from a number of Prepar3D system components. Unicode. |
| Data Definition Specific Function Name | |
AddToDataDefinition(DefineID as [Enum], DatumName as String, UnitsName as String, DatumType as SimConnect_Datatype, fEpsilon as Float, DatumID as DWORD, DatumID as UInteger)Used to add a Prepar3D simulation variable name to a client defined objectdefinition. | |
ClearDataDefinition(DefineID as Enum)Used to remove all simulation variables from a client defined object. |
| Misc Function Name | |
GetLastSentPacketID() {{-Function Not Available-}}Function not available | |
RequestSessionDuration(RequestID as [Enum])Used to request the duration of the current scenario in seconds. | |
RequestVersion(RequestID as [Enum])Used to request license type and version numbers of P3D and SimConnect. | |
RequestResponseTimes(ElapsedSeconds as Single())Used to provide some data on the performance of the client-server connection |
| String Specific Function Name | |
InsertString() {{-Function Not Available-}}Function not available | |
InsertStringW() {{-Function Not Available-}}Function not available | |
ReceiveString() {{-Function Not Available-}}Function not available | |
ReceiveStringW() {{-Function Not Available-}}Function not available |
| Synchronous SimConnect Specific Function Name | |
RequestSynchronousBlock(RequestID as [Enum], Period as SIMCONNECT_PERIOD, Flags as SIMCONNECT_DATA_REQUEST_FLAG, Origin as UInteger, Interval as UInteger, Limit as UInteger)Used to request a blocking callback. | |
SynchronousUnblock() Used to release a blocking callback. | |
SetSynchronousTimeout(iTimeSeconds as Single)Used to set the error timeout length for blocking callbacks. | |
SubscribeToSystemEventEx(EventID as [Enum], SystemEventName as String, Flags as SIMCONNECT_EVENT_SUBSCRIPTION_FLAG)Used to request that a specific system event is notified to the client. Flags allow you to request a blocking callback. |
| Menu Function Name | |
MenuAddItem(szMenuItem as String, MenuEventID as [Enum], dwData as UInteger) {{-32 bit-}}Used to add a menu item, associated with a client event. This version of the function provides a 32-bit context data field. | |
MenuAddItemW(szMenuItem as String, MenuEventID as [Enum], dwData as UInteger) {{-64 bit-}}Used to add a menu item, associated with a client event. This version of the function provides a 64-bit context data field. | |
MenuAddSubItem(MenuEventID as [Enum],szMenuItem as String, SubMenuEventID as [Enum], dwData as UInteger) {{-32 bit-}}Used to add a sub-menu item, associated with a client event. This version of the function provides a 32-bit context data field. e | |
MenuAddSubItemW(MenuEventID as [Enum],szMenuItem as String, SubMenuEventID as [Enum], dwData as UInteger) {{-64 bit-}}Used to add a sub-menu item, associated with a client event. This version of the function provides a 64-bit context data field. | |
MenuDeleteItem(MenuEventID as [Enum])Used to remove a client defined menu item. | |
MenuDeleteSubItem(MenuEventID as [Enum], SubMenuEventID as [Enum])Used to remove a specified sub-menu item. | |
Text(Type as SIMCONNECT_TEXT_TYPE, fTimeSeconds as Single(), EventID as [Enum], pDataSet as Object) Used to display a text menu, message window, or scrolling or static text, on the screen. |