FSUIPC Developer's Kit, Release 15:            February 2002
============================================================

This is the 15th release of the Developer's Kit for FSUIPC.

You will need FSUIPC.ZIP as well with FSUIPC Version 2.96 or
later, as many of the facilities described in the
Programmer's Guide need the latest version.

Network users will need WideFS version 4.01 or later, and it should
always match the version of FSUIPC being used, according to the
documentation for both. The current version is 5.40.

Changes in this Release are many. Please peruse the
Programmer's Guide and the FSUIPC History document (available in
the FSUIPC Zip).

IMPORTANT NOTE FOR FS GAUGE AND MODULE WRITERS
==============================================

If you are wanting to access FSUIPC's facilities from INSIDE FS, rather
than from an external application, please PLEASE note that using the
external users library is most definitely NOT recommended. It is VERY
inefficient. You are inside the FS process, so why use complex
inter-process communications? (IPC == Inter-Process Communication!).

Also, if you do use this slow method, you may get failures on Open which
will recover, eventually, on retries. This is because, following Adam
Szofran's original method, the "unique" ID string, used to identify the
mapped memory, is generated using the Process ID. This ID is unique for
all separate Processes, but obviously it is the same for ALL gauges and
modules running inside FS.

FSUIPC deliberately provides an entry for Gauges and Modules to use.
It is very efficient, it uses a simple message with no memory mapping.
YOU, the user, have to provide the memory for the data, but there are
simple rules for calculating how much. The code is almost identical to
using the external library -- only the Open call is changed to provide
the memory pointer and size!

Please see the "C library for FS Internal Access" ZIP.


Contents of SDK
===============

Readme.txt
	This is it.

FSUIPC for Programmers.doc
	General information and reference tables
	
C Library for FS Internal Access
	A special version of the library for internal FS parts like
	gauges and other modules to read and write FSUIPC
	data.

UIPC_SDK_C.zip
	The Library and source for MSVC/C++ users, by yours truly.
UIPC_SDK_CSHARP.zip
	All the details and examples for C# users, thanks to Scott McCrory
UIPC_SDK_MFC.zip
	Sources and data for C++ MFC users, supplied by Brent Vernon.
UIPC_SDK_Delphi.zip
	Sources and data for Delphi users, supplied by Pelle Liljendal, with
	update work done by Chris Brett.
UIPC_SDK_VisualBasic.zip
	Sources and data for VB users, supplied by Chris Brett, with update
	work done by Enrico Schiratti and notes from Stuart Browne and a
	contribution from Mark Schilberg.
UIPC_SDK VB .NET Shell.zip
	A revised version of the Visual Basic interface for VB.NET, kindly
	supplied by Bob Scott.
UIPC_SDK_ASM.zip
	Sources and data for ASM users, supplied by Andrea Brunori.
		
	Each of these Zips contains the stuff you need to write your own
	appplication interfacing to FS through FSUIPC. A ready compiled
	example, basically an FSUIPC version of the standard simple
	"Hello World" program, complete  with source, is provided in
	each case.
	
UIPC_SDK_BCB5.zip
	This is a version of the C example code revised and compiled
	with Borland C++ Builder 5: supplied by Alan Dyer.
	
UIPCAWI.zip
	Some basic information about the FSUIPC Advanced 
	Weather Interface. This is only applicable to FS2000 and
	CFS2. It may be expanded at a later date.

FSLook.exe
	A program which displays FS "Token Variables" (as in the MS
	Panels SDK). This does not work via WideFS as it uses a special
	private interface into FSUIPC.
	
FSLook2.exe
	A program which displays all the "extra" Token Variables in FS2000
	and CFS2, which are mapped into the 0x2000-3FFF offset range by
	FSUIPC. Some of FS2002's values are also mapped here.
	(See table at end of Programmers Document.
	
	Where there's a choice, use the FS98-compatible values as shown
	in the main table in the Programmers document.
	
FSInterrogate.exe
FSInterrogate_Manual.zip
	A very useful program written by and copyright (c) Pelle Liljendal.
	
FSUIPC.fsi
	A database/project for use with FSInterrogate which includes most
	if not all of the data in the tables in the Programmers document.
	
==============================================================
Peter Dowson, 1st February 2003

with thanks to Scott McCrory, Bob Scott, Stuart Browne,
Andrea Brunori, Brent Vernon, Pelle Liljendal,
Enrico Schiratti, Chris Brett, Mark Schilberg and Alan Dyer.
==============================================================