A class that handles communication and data transfer to and from Pete Dowson's FSUIPC or WideFS. More...

Static Public Member Functions

static FSUIPCVersion FSUIPCVersionForClass (byte ClassInstance)

Returns the version of FSUIPC we are connected to for a specific class instance.

Parameters

ClassInstance The number of the Class Instance for which you want the FSUIPC Version

static AirportsDatabase AirportsDatabaseForClass (byte ClassInstance)

The active Airports Database object for the specified class instance. Use this object to access data about airports More...

static AITrafficServices AITrafficServicesForClass (byte ClassInstance)

The active AI Traffic Services object for the specified class instance. Use this object to access data about AI aircraft. More...

static UserInputServices UserInputServicesForClass (Byte ClassInstance)

The active UserInputServices object for the specified Class Instance. Use this object to access facilities to set up Keystrokes and Joystick Button presses for your application. Also allows you to add a menu item into Flight Sim. More...

static PayloadServices PayloadServicesForClass (byte ClassInstance)

The active PayloadServices object for the specified Class Instance. Use this object to access Payload and Fuel information on the current aircraft More...

static WeatherServices WeatherServicesForClass (byte ClassInstance)

The active WeatherServices object for the specified Class Instance. Use this object to read and write weather. More...

static Statistics StatisticsForClass (byte ClassInstance)

The statistics object for a specified Class Instance. Use this object to read various statistics about the connection More...

static bool WideClientForClass (byte ClassInstance)

A boolean indicating if the connection is to WideClient.exe More...

static bool IsConnectionOpen ()

DEPRECATED: Use the property IsOpen instead. More...

static bool IsConnectionOpenForClass (byte ClassInstance)

Lets you test if the connection to FSUIPC has been opened for a specific class instance. More...

static FsVersion FlightSimVersionForClass (byte ClassInstance)

The version of Flight Simulator that FSUIPC is running in, or that WideFS is connected to. More...

static void Open ()

Opens a connection to FSUIPC or WideFS. Call this once when your application starts. More...

static void Open (int RequiredFlightSimVersion)

Opens communication to FSUIPC or WideFS. Call this once when your application starts. More...

static void Open (FlightSim RequiredFlightSimVersion)

Opens communication to FSUIPC or WideFS. Call this once when your application starts. More...

static void Open (byte ClassInstance, FlightSim RequiredFlightSimVersion)

Opens communication to a specific class instance of WideClient.exe. Call this for each instance you want to communicate with. More...

static void Open (byte ClassInstance, int RequiredFlightSimVersion)

Opens communication to a specific class instance of WideClient.exe. Call this for each instance you want to communicate with. More...

static void DisconnectGroup (string groupName)

Use DeleteGroup() instead. Does the same thing but is a better name More...

static void DeleteGroup (string groupName)

Deletes an entire group of Offsets from the FSUIPCConnection class. Process() can no longer be called on for this group. Only use this method if you will never need to use the offsets in the group again. More...

static void Close ()

Closes all open connections with FSUIPC or WideFS and cleans up the memory used. More...

static void Close (byte ClassInstance)

Closes the connections to a specific class instance of WideClient.exe and cleans up the memory used. More...

static void Process ()

Processes all the Offsets in the default group. To process a specific group of Offsets pass the name of the Group as a parameter. More...

static void Process (string GroupName)

Processes all the Offsets in the specified group. More...

static void Process (IEnumerable< string > GroupNames)

Processes all the Offsets in the groups passed in. More...

static void Process (byte ClassInstance)

Processes all the Offsets in the default group for the specified class instance of WidwClient.exe. To process a specific group of Offsets pass the name of the Group as a parameter. More...

static void Process (byte ClassInstance, string GroupName)

Processes all the Offsets in the specified group for the specified class instance of WideClient.exe. More...

static void Process (byte ClassInstance, IEnumerable< string > GroupNames)

Processes all the Offsets in the groups passed in for specified class instance of WidwClient.exe. More...

static void SendKeyToFS (Keys Key)

Sends a set of key strokes to the Flight Sim window. More...

static void SendKeyToFS (byte ClassInstance, Keys Key)

Sends a set of key strokes to the specified Class Instance of Flight Sim. More...

static void SendKeyToFS (Keys Key, SendModifierKeys Modifiers)

Sends a set of key strokes to the Flight Sim window. More...

static void SendKeyToFS (byte ClassInstance, Keys Key, SendModifierKeys Modifiers)

Sends a set of key strokes to the specified Class Instance of Flight Sim. More...

static void SendKeyToFS (Keys Key, Form ReturnFocusToForm)

Sends a set of key strokes to the Flight Sim window. More...

static void SendKeyToFS (byte ClassInstance, Keys Key, Form ReturnFocusToForm)

Sends a set of key strokes to the specified Class Instance of Flight Sim. More...

static void SendKeyToFS (Keys Key, SendModifierKeys Modifiers, Form ReturnFocusToForm)

Sends a set of key strokes to the Flight Sim window. More...

static void SendKeyToFS (byte ClassInstance, Keys Key, SendModifierKeys Modifiers, Form ReturnFocusToForm)

Sends a set of key strokes to the specified Class Instance of Flight Sim. More...

static void SendControlToFS (FsControl Control, int ParameterValue)

Sends a control to FS with an optional parameter. More...

static void SendControlToFS (FSUIPCControl Control, int ParameterValue)

Sends a control to FS with an optional parameter. More...

static void SendControlToFS (FSUIPCAxisControl Control, int ParameterValue)

Sends a control to FS with an optional parameter. More...

static void SendControlToFS (PMControl Control, int ParameterValue)

Sends a control to FS with an optional parameter. More...

static void SendControlToFS (FSUIPCAutoPilotControl Control, int ParameterValue)

Sends a control to FS with an optional parameter. More...

static void SendControlToFS (PMDG_737_NGX_Control Control, int ParameterValue)

Sends a control to FS with an optional parameter. More...

static void SendControlToFS (PMDG_777X_Control Control, int ParameterValue)

Sends a control to FS with an optional parameter. More...

static void SendControlToFS (PMDG_747QOTSII_Control Control, int ParameterValue)

Sends a control to FS with an optional parameter. More...

static void SendControlToFS (byte ClassInstance, FsControl Control, int ParameterValue)

Sends a control to FS with an optional parameter. More...

static void SendControlToFS (byte ClassInstance, FSUIPCControl Control, int ParameterValue)

Sends a control to FS with an optional parameter. More...

static void SendControlToFS (byte ClassInstance, FSUIPCAxisControl Control, int ParameterValue)

Sends a control to FS with an optional parameter. More...

static void SendControlToFS (byte ClassInstance, PMControl Control, int ParameterValue)

Sends a control to FS with an optional parameter. More...

static void SendControlToFS (byte ClassInstance, FSUIPCAutoPilotControl Control, int ParameterValue)

Sends a control to FS with an optional parameter. More...

static void SendControlToFS (byte ClassInstance, PMDG_737_NGX_Control Control, int ParameterValue)

Sends a control to FS with an optional parameter. More...

static void SendControlToFS (byte ClassInstance, PMDG_777X_Control Control, int ParameterValue)

Sends a control to FS with an optional parameter. More...

static void SendControlToFS (byte ClassInstance, PMDG_747QOTSII_Control Control, int ParameterValue)

Sends a control to FS with an optional parameter. More...

static void SendControlToFS (int ControlNumber, int ParameterValue)

Sends a control to FS with an optional parameter. More...

static void SendControlToFS (byte ClassInstance, int ControlNumber, int ParameterValue)

Sends a control to FS with an optional parameter. More...

static double ReadLVar (string LVAR)

Reads a local panel variable (L:VAR) from the flight sim. More...

static double ReadLVar (byte ClassInstance, string LVAR)

Reads a local panel variable (L:VAR) from the flight sim More...

static void WriteLVar (string LVAR, double NewValue)

Writes a new value to a local panel variable (L:VAR) in the flight sim More...

static void WriteLVar (byte ClassInstance, string LVAR, double NewValue)

Writes a new value to a local panel variable (L:VAR) in the flight sim More...

static void MoveAircraft (FsGate Gate, bool LeavePaused)

Moves the player aircraft to a Gate from the Airports Database. More...

static void MoveAircraft (FsPositionSnapshot PositionSnapshot, bool LeavePaused)

Moves the player aircraft according to the values in the position snapshot. More...

static void MoveAircraft (FsRunway Runway, bool LeavePaused)

Moves the player aircraft to a Runway from the Airports Database. More...

static void MoveAircraft (FsHelipad Helipad, bool LeavePaused)

Moves the player aircraft to a Helipad from the Airports Database. More...

static void MoveAircraft (FsLatLonPoint NewLocation, bool OnGround, FsAltitude? Alt, double? HeadingTrue, double? Pitch, double? Bank, double? IndicatedAirSpeedKnots, bool LeavePaused)

Moves the player aircraft to a new lon/lat location. You may optionally specify new Altitude, Indicated Airspeed, Pitch, Bank or Heading values. More...

static void MoveAircraft (byte ClassInstance, FsLatLonPoint NewLocation, bool OnGround, FsAltitude? Alt, double? HeadingTrue, double? Pitch, double? Bank, double? IndicatedAirSpeedKnots, bool LeavePaused)

Moves the player aircraft to a new lon/lat location. You may optionally specify new Altitude, Indicated Airspeed, Pitch, Bank or Heading values. More...

static FsPositionSnapshot GetPositionSnapshot ()

Takes a snapshot of the current position of the aircraft including: Location, altitude, heading, pitch, bank, onGround and IAS. More...

static FsPositionSnapshot GetPositionSnapshot (byte ClassInstance)

Takes a snapshot of the current position of the aircraft including: Location, altitude, heading, pitch, bank, onGround and IAS. More...

static DateTime GetUTCDateTimeForClass (byte ClassInstance)

Gets the current UTC date and time set in the Flight Sim. (aka ZULU time and GMT) for a specific WideClient Instance. More...

static void SetUTCDateTimeForClass (byte ClassInstance, DateTime NewDateTime)

Sets the current UTC date and time set in the Flight Sim. (aka ZULU time and GMT) for a specific WideClient Instance. More...

static DateTime GetLocalDateTimeForClass (byte ClassInstance)

Gets the current Local date and time set in the Flight Sim for a specific WideClient Instance. More...

static void SetLocalDateTimeForClass (byte ClassInstance, DateTime NewDateTime)

Sets the current Local date and time set in the Flight Sim for a specific WideClient Instance. More...

Properties
static bool	GroupsIsolatedToThread `[get, set]`
	Sets/Gets whether or not groups are unique to threads or can be accessed via any thread. More...

static Version	DLLVersion `[get]`
	Returns the version of the FSUIPC Client DLL. More...

static FSUIPCVersion	FSUIPCVersion `[get]`
	Returns the version of FSUIPC we are connected to. More...

static AirportsDatabase	AirportsDatabase `[get]`
	The active Airports Database object. Use this object to access data about airports More...

static AITrafficServices	AITrafficServices `[get]`
	The active AI Traffic Services object. Use this object to access data about AI aircraft. More...

static UserInputServices	UserInputServices `[get]`
	The active UserInputServices object. Use this object to access facilities to set up Keystrokes and Joystick Button presses for your application. Also allows you to add a menu item into Flight Sim. More...

static PayloadServices	PayloadServices `[get]`
	The active PayloadServices object. Use this object to access Payload and Fuel information on the current aircraft More...

static WeatherServices	WeatherServices `[get]`
	The active WeatherServices object. Use this object to read and write weather information More...

static Statistics	Statistics `[get]`
	The statistics object. Use this object to read various statistics about the connection More...

static int	SendKeyFocusWaitTime = 150 `[get, set]`
	Sets the time (in milliseconds) that SendKeyToFS will wait for the focus to change to/from the Flight Sim window. More...

static bool	IsOpen `[get]`
	Returns true is the connection is currently open. More...

static bool	IsConnectedToWideClient `[get]`
	A boolean indicating if the connection is to WideClient.exe More...

static FsVersion	FlightSimVersionConnected `[get]`
	The version of Flight Simulator that FSUIPC is running in, or that WideFS is connected to. More...

static DateTime	UTCDateTime `[get, set]`
	The current UTC date and time set in the Flight Sim. (aka ZULU time and GMT). Setting a new value changes the date/time in the simulator. More...

static DateTime	LocalDateTime `[get, set]`
	The current Local date and time set in the Flight Sim. Setting a new value changes the date/time in the simulator. More...

Detailed Description

static DateTime GetLocalDateTimeForClass ( byte ClassInstance )

inlinestatic

Gets the current Local date and time set in the Flight Sim for a specific WideClient Instance.

Usually use the property "UTCDateTime".

Parameters

ClassInstance The number of the Class Instance of WideClient you want to talk to.

Returns

◆ GetPositionSnapshot() [1/2]

static FsPositionSnapshot GetPositionSnapshot ( )

inlinestatic

Takes a snapshot of the current position of the aircraft including: Location, altitude, heading, pitch, bank, onGround and IAS.

Note that this information can be passed directly to the MoveAircraft method.

Returns: A FsPositionSnapshot class holding the position values

◆ GetPositionSnapshot() [2/2]

static FsPositionSnapshot GetPositionSnapshot ( byte ClassInstance )

inlinestatic

Takes a snapshot of the current position of the aircraft including: Location, altitude, heading, pitch, bank, onGround and IAS.

Note that this information can be passed directly to the MoveAircraft method.

Parameters

ClassInstance The number of the Class Instance of WideClient you want to talk to.

Returns: A FsPositionSnapshot class holding the position values

◆ GetUTCDateTimeForClass()

static DateTime GetUTCDateTimeForClass ( byte ClassInstance )

inlinestatic

Gets the current UTC date and time set in the Flight Sim. (aka ZULU time and GMT) for a specific WideClient Instance.

Usually use the property "UTCDateTime".

Parameters

ClassInstance The number of the Class Instance of WideClient you want to talk to.

Returns

◆ IsConnectionOpen()

static bool IsConnectionOpen ( )

inlinestatic

DEPRECATED: Use the property IsOpen instead.

Returns

◆ IsConnectionOpenForClass()

static bool IsConnectionOpenForClass ( byte ClassInstance )

inlinestatic

Lets you test if the connection to FSUIPC has been opened for a specific class instance.

Note that you cannot use this to see if FS is still connected.

Parameters

ClassInstance The number of the Class Instance to test for an open connection.

Returns: True is the connection has been opened. False if it has not.

◆ MoveAircraft() [1/6]

static void MoveAircraft	(	FsGate	Gate,
		bool	LeavePaused
	)

inlinestatic

Moves the player aircraft to a Gate from the Airports Database.

Only works with FSX and above

Parameters

Gate	The FsGate object representing the gate to move the player aircraft to
LeavePaused	If set to true, the sim will be paused after moving the aircraft

◆ MoveAircraft() [2/6]

static void MoveAircraft	(	FsPositionSnapshot	PositionSnapshot,
		bool	LeavePaused
	)

inlinestatic

Moves the player aircraft according to the values in the position snapshot.

A position snapshot can be created manually, or automatically using the FSUIPConnection.GetPositionSnapshot() method.

Only works with FSX and above

Parameters

PositionSnapshot	The FsGate object representing the gate to move the player aircraft to
LeavePaused	If set to true, the sim will be paused after moving the aircraft

◆ MoveAircraft() [3/6]

static void MoveAircraft	(	FsRunway	Runway,
		bool	LeavePaused
	)

inlinestatic

Moves the player aircraft to a Runway from the Airports Database.

Only works with FSX and above

Parameters

Runway	The FsRunway object representing the runway to move the player aircraft to. The player will be moves to the runway's start location with the correct heading.
LeavePaused	If set to true, the sim will be paused after moving the aircraft

◆ MoveAircraft() [4/6]

static void MoveAircraft	(	FsHelipad	Helipad,
		bool	LeavePaused
	)

inlinestatic

Moves the player aircraft to a Helipad from the Airports Database.

Only works with FSX and above

Parameters

Helipad	The FsHelipad object representing the helipad to move the player aircraft to.
LeavePaused	If set to true, the sim will be paused after moving the aircraft

◆ MoveAircraft() [5/6]

static void MoveAircraft	(	FsLatLonPoint	NewLocation,
		bool	OnGround,
		FsAltitude?	Alt,
		double?	HeadingTrue,
		double?	Pitch,
		double?	Bank,
		double?	IndicatedAirSpeedKnots,
		bool	LeavePaused
	)

inlinestatic

Moves the player aircraft to a new lon/lat location. You may optionally specify new Altitude, Indicated Airspeed, Pitch, Bank or Heading values.

Only works with FSX and above

Parameters

NewLocation	The new FsLatLonPoint to move to
OnGround	Pass true if you want the aircraft on the ground after moving. (Speed and Altitude are ignored in this case)
Alt	The new altitude passed as a FsAltitude class. (e.g. FsAltitude.FromFeet(3000))

Pass null (Nothing in VB) to keep the current altitude)

Parameters

HeadingTrue	The new heading in degrees true<para>Pass null (Nothing in VB) to keep the current heading)
Pitch	The new pitch angle of the aircraft in degrees<para>Pass null (Nothing in VB) to keep the current pitch angle)
Bank	The new bank angle of the aircraft in degrees true<para>Pass null (Nothing in VB) to keep the current bank angle)
IndicatedAirSpeedKnots	The new indicated airspeed of the aircraft in knots<para>Pass null (Nothing in VB) to keep the current airspeed)
LeavePaused	If set to true, the sim will be paused after moving the aircraft

◆ MoveAircraft() [6/6]

static void MoveAircraft	(	byte	ClassInstance,
		FsLatLonPoint	NewLocation,
		bool	OnGround,
		FsAltitude?	Alt,
		double?	HeadingTrue,
		double?	Pitch,
		double?	Bank,
		double?	IndicatedAirSpeedKnots,
		bool	LeavePaused
	)

inlinestatic

Moves the player aircraft to a new lon/lat location. You may optionally specify new Altitude, Indicated Airspeed, Pitch, Bank or Heading values.

Only works with FSX and above

Parameters

ClassInstance	The number of the Class Instance of WideClient you want to talk to.
NewLocation	The new FsLatLonPoint to move to
OnGround	Pass true if you want the aircraft on the ground after moving. (Speed and Altitude are ignored in this case)
Alt	The new altitude passed as a FsAltitude class. (e.g. FsAltitude.FromFeet(3000))

Pass null (Nothing in VB) to keep the current altitude)

Parameters

HeadingTrue	The new heading in degrees true<para>Pass null (Nothing in VB) to keep the current heading)
Pitch	The new pitch angle of the aircraft in degrees<para>Pass null (Nothing in VB) to keep the current pitch angle)
Bank	The new bank angle of the aircraft in degrees true<para>Pass null (Nothing in VB) to keep the current bank angle)
IndicatedAirSpeedKnots	The new indicated airspeed of the aircraft in knots<para>Pass null (Nothing in VB) to keep the current airspeed)
LeavePaused	If set to true, the sim will be paused after moving the aircraft

◆ Open() [1/5]

static void Open ( )

inlinestatic

Opens a connection to FSUIPC or WideFS. Call this once when your application starts.

◆ Open() [2/5]

static void Open ( int RequiredFlightSimVersion )

inlinestatic

Opens communication to FSUIPC or WideFS. Call this once when your application starts.

Parameters

RequiredFlightSimVersion Specify a version of Flight Sim if you want to limit your application to run only on that version.

◆ Open() [3/5]

static void Open ( FlightSim RequiredFlightSimVersion )

inlinestatic

Opens communication to FSUIPC or WideFS. Call this once when your application starts.

Parameters

RequiredFlightSimVersion Specify a version of Flight Sim if you want to limit your application to run only on that version.

◆ Open() [4/5]

static void Open	(	byte	ClassInstance,
		FlightSim	RequiredFlightSimVersion
	)

inlinestatic

Opens communication to a specific class instance of WideClient.exe. Call this for each instance you want to communicate with.

Parameters

ClassInstance	Specify a specific class instance of wideclient to connect to. (See WideFS documentation for details)
RequiredFlightSimVersion	Specify a version of Flight Sim if you want to limit your application to run only on that version.

◆ Open() [5/5]

static void Open	(	byte	ClassInstance,
		int	RequiredFlightSimVersion
	)

inlinestatic

Opens communication to a specific class instance of WideClient.exe. Call this for each instance you want to communicate with.

Parameters

ClassInstance	Specify a specific class instance of wideclient to connect to. (See WideFS documentation for details)
RequiredFlightSimVersion	Specify a version of Flight Sim if you want to limit your application to run only on that version.

◆ PayloadServicesForClass()

static PayloadServices PayloadServicesForClass ( byte ClassInstance )

inlinestatic

The active PayloadServices object for the specified Class Instance. Use this object to access Payload and Fuel information on the current aircraft

Parameters

ClassInstance The number of the Class Instance for which you want the payload services

Returns: The PayloadServices for the given class instance

inlinestatic

Processes all the Offsets in the default group for the specified class instance of WidwClient.exe. To process a specific group of Offsets pass the name of the Group as a parameter.

All Offsets will either have their value updated from FSUIPC, or have their value written to FSUIPC as appropriate.

Parameters

ClassInstance The number of the Class Instance of WideClient you want to talk to.

◆ Process() [5/6]

static void Process	(	byte	ClassInstance,
		string	GroupName
	)

inlinestatic

Processes all the Offsets in the specified group for the specified class instance of WideClient.exe.

All Offsets will either have their value updated from FSUIPC, or have their value written to FSUIPC as appropriate.

Parameters

ClassInstance	The number of the Class Instance of WideClient you want to talk to.
GroupName	The name of the group to process.

◆ Process() [6/6]

static void Process	(	byte	ClassInstance,
		IEnumerable< string >	GroupNames
	)

inlinestatic

Processes all the Offsets in the groups passed in for specified class instance of WidwClient.exe.

All Offsets will either have their value updated from FSUIPC, or have their value written to FSUIPC as appropriate.

Parameters

ClassInstance	The number of the Class Instance of WideClient you want to talk to.
GroupNames	The names of the groups to process.

◆ ReadLVar() [1/2]

static double ReadLVar ( string LVAR )

inlinestatic

Reads a local panel variable (L:VAR) from the flight sim.

Parameters

LVAR	The name of the variable to read. With or without the "L:" prefix

Returns

◆ ReadLVar() [2/2]

static double ReadLVar	(	byte	ClassInstance,
		string	LVAR
	)

inlinestatic

Reads a local panel variable (L:VAR) from the flight sim

Parameters

ClassInstance	The number of the Class Instance of WideClient you want to talk to.
LVAR	The name of the variable to read. With or without the "L:" prefix

Returns