Creating an AppHelp Message

Applies To: Windows 7, Windows Vista

The Compatibility Administrator enables you to create an AppHelp text message. This is a blocking or non-blocking message that appears when a user starts an application that you know has major functionality issues on the Windows® operating system.

Blocking Versus Non-Blocking AppHelp Messages

If the AppHelp message is blocking, it displays a message to the user and prevents the application from starting. In this situation, you can define a specific URL where the user can download an updated driver or other fix to resolve the issue. When using a blocking AppHelp message, you must also define the file-matching information to identify the problematic version of the application and enable the corrected version to continue.

Non-blocking AppHelp messages also provide messages to the user, such as information about security issues, updates to the application, or changes to the location of network resources, but they do not prevent the application from starting.

Searching for Existing Compatibility Fixes

The Compatibility Administrator has preloaded many common applications, including any known AppHelp messages, compatibility fixes, and compatibility modes. Before you create a new AppHelp message, you can search for an existing application and then copy and paste the known fixes into your custom database.

Important

The Application Compatibility Toolkit (ACT) installs a 32-bit and a 64-bit version of the Compatibility Administrator. You must use the 32-bit version to create custom databases for 32-bit applications and the 64-bit version to create custom databases for 64-bit applications. If you create a custom database by using the wrong version of the Compatibility Administrator, the database will not open.

To search for an existing application

  1. In the left pane of the Compatibility Administrator, expand the Applications folder and search for your application name.

  2. Click the application name to view the preloaded AppHelp messages, compatibility fixes, and compatibility modes.

Creating a New AppHelp Message

If you are unable to find a preloaded AppHelp message for your application, you can create a new one for use by your custom database.

To create a new AppHelp message

  1. In the left pane of the Compatibility Administrator, below the Custom Databases heading, right-click the name of the database to which you will apply the AppHelp message, click Create New, and then click AppHelp Message.

    The Create a Custom AppHelp Message Wizard appears.

  2. Type the name of the application to which this AppHelp message applies, type the name of the application vendor, browse to the location of the application file (.exe) on your computer, and then click Next.

    The wizard shows the known Matching Information, used for program identification.

  3. Select any additional criteria to use to match your applications to the AppHelp message, and then click Next.

Note

By default, the Compatibility Administrator automatically selects the basic matching criteria for your application.

The wizard shows the **Enter Message Type** options.
  1. Click one of the following options:

    • Display a message and allow this program to run. This is a non-blocking message, which means that you can alert the user that there might be a problem, but you do not stop the application from starting.

    • Display a message and do not allow this program to run. This is a blocking message, which means that the application will not start. Instead, this message points the user to a location that provides more information about fixing the issue.

  2. Click Next.

    The wizard alters to show the Enter Message Information fields.

  3. Type the Web site URL and the message text to appear when the user starts the application, and then click Finish.

Issues with AppHelp Messages and Computers Running Windows 2000

The following issues might occur with computers running Windows 2000:

  • You might be unable to create a custom AppHelp message.

  • The AppHelp message text used for system database entries might not appear.

  • Copying an AppHelp entry for a system database or a custom-compatibility fix from a system database might cause the Compatibility Administrator to hide the descriptive text.

See Also

Concepts

Compatibility Administrator Tool
Known Compatibility Fixes, Compatibility Modes, and AppHelp Messages

Other Resources

Testing and Mitigating Issues by Using the Development Tools