Citrix XenApp Management SDK, Version 5.0

Readme

Readme Version: 1.0

Notes:

The XenApp Management SDK is also known as MPSSDK or MFCOM, and those two terms are still used throughout the documentation (this readme and the help files).
For information about new features and system requirements, see the XenApp Management SDK help files or the Citrix XenApp Administrator's Guide.

Finding Documentation

The XenApp Management SDK help is installed automatically when you install the SDK (default location: %SystemDrive%\Program Files\Citrix\MPSSDK\Docs). To open the help, double-click the mfcom.chm file.

Getting Support

Citrix provides technical support primarily through Citrix Solutions Advisor. Contact your supplier for first-line support or use Citrix Online Technical Support to find the nearest Citrix Solutions Advisor.

Citrix offers online technical support services on the Citrix Support Web site. The Support page includes links to downloads, the Citrix Knowledge Center, Citrix Consulting Services, and other useful support pages.

What's New in This Release

Support for many of the new features of XenApp 5.0 for Microsoft Windows Server 2008
New interfaces for existing objects, to support additional functionality
Resolution of many known issues that existed in the Presentation Server 4.5 release of MFCOM

Known Issues in This Release.

The examples included in this SDK have not been fully tested on Windows Vista systems, although most of them should work correctly. If you are unable to run an example, try the following:

Ensure that the user has sufficient permission to run the example. For example, an administrator's permissions may also need to include the permission to launch an application from a command-line window.
Ensure that the DCOM impersonation level is set to impersonate. Other DCOM settings may also need to be adjusted.

Some examples are provided with only source code. You may need to compile the examples using the makefiles provided, or in your own Visual Studio project.

Installation Information

Installing the MPSSDK

Run mpssdk.msi.

The installation program starts. The following tasks are completed during installation:

Accepting the license agreement
Specifying a destination folder for the MPSSDK; the default installation directory is %SystemDrive%\Program Files\Citrix\MPSSDK
Optionally registering MFCOM for remote access

To develop applications, the MPSSDK does not need to be installed on a server running XenApp, but programs developed using MPSSDK functions work only on servers running XenApp (Presentation Server), or on a system that has MFCOM registered for remote access.

The following directories are copied to the MPSSDK installation directory during MPSSDK installation.

Directory	Description
ASP	Active Server Pages (ASP) examples using MFCOM.
Bin.Net	Binaries compiled from the VisualStudio.NET examples.
CS	Examples written in C#.
Docs	Help system and readme.
CS\CSCMC	Simplified version of the Management Console for Presentation Server, written in C# and MFCOM; most of the object interfaces are exercised in this example.
CS\Leinfo	Applications that gets load evaluators and rules.
CS\PolicyAdm	Policy management tool.
CS\Dashboard	Application that displays basic farm and server information on the desktop.
CS\PubApp	Application publishing utility.
CS\QueryId	Application that queries for an application, server, or folder for a given ID.
Perl	Perl scripts using MFCOM.
typelib	Directory that contains the Mfcom.tlb file.
Utils	Directory that contains Mfreg.exe. This directory is created only if XenApp is not installed on the system; otherwise, Mfreg.exe is found in the Program Files\Citrix\System32 directory.
vb	Visual Basic examples.
vb\cincom	Visual Basic example that uses many of the exposed MFCOM objects and interfaces.
vb\events	Visual Basic example demonstrating how to receive XenApp events using MFCOM.
VB\QAdmin	Administrator management utility for XenApp.
vb\qshadow	Shadow utility based on MFCOM and WFAPI.
VB.Net	Visual Basic 7 examples written in Visual Basic 7.
VB.Net\FarmInfo	Visual Basic 7 examples using farm and session objects.
vc	Visual C++ examples.
vc\addserver	Visual C++ example that adds a server to an application, using MFCOM.
vc\appexp	Visual C++ example that exports an application to AppFile, ICAFile, or HTML.file.
vc\appicon	Visual C++ example that takes the application's name and creates an icon file for it.
vc\apps	Visual C++ example that enumerates applications in a farm using MFCOM.
vc\ctxping	Visual C++ example that demonstrates the XenApp virtual channel object and interfaces; this example requires the Citrix Virtual Channel SDK.
vc\events	Multithreaded Visual C++ program that demonstrates the use of the MFCOM event interface properties and methods.
vc\farm	Visual C++ example that displays the farm's name.
vc\getapp	Visual C++ example that exercises several interfaces for accessing XenApp applications.
vc\inc	Directory that contains the Mfcom.h file.
vc\Isadmin	Visual C++ example that uses MFCOM to check whether or not a given administrator is a Citrix administrator.
vc\lib	Directory that contains the Mfcom.lib file.
vc\smc	Visual C++ example to monitor server, session, and virtual channel counters.
vc\smc\Console	Main executable (Mfcomsmcconsole.exe) that displays the counters data.
vc\smc\DLL	Support DLL that performs background processing for the Session Monitoring and Control (SMC) Console.
vc\smc\inc	Include files for the SMC DLL and console (Mfcomsmcapi.h and Ctxsmcdrv.h files).
WSH	WSH scripts using MFCOM.

Upgrading the MPSSDK

Uninstall any previous version of the MPSSDK prior to installing this version. To remove a previous version, use the utility for adding/removing programs in the Windows Control Panel.

Registering MFCOM for Remote Access

You must register MFCOM for remote access to an MFCOM server. You cannot register MFCOM for local and remote access simultaneously. To modify the registration, see the "Accessing the MFCOM Server Remotely" topic of the MPSSDK Help.

Important: If you registered MFCOM for remote access using MFREG from a previous version of the MPSSDK, you must remove the registration prior to installing this version. If you do not remove the previous registration first, you may encounter errors when you use this version.

Readme Citrix XenApp Management SDK 5.0