Migrating to the Current Version

The following sections give instructions for migrating a plugin that was written for ODTK version 4 to version 5. For further information, see the ODTK plugin samples included with this product.

For plugins written in C# or VB.NET

  1. Make a copy of your plugin source code for backup purposes. This will be useful if you run into problems while migrating your source code, or if you want to use your plugin with ODTK 4 again.
  2. Open your plugin in Visual Studio and update your project references. To do this, you will have to remove the existing AGI.* references from your project and then add the references back to your project using the updated type libraries.
  3. Locate the existing ODTK 4 catalog IDs in your C# or VB.Net source files (.csor.vb). Replace them with the new ODTK 5 catalog IDs provided here:
    New HPOP Catalog ID: {5DE400B4-9F1B-4654-AC7B-3A5CDEE0E3D1}
    New GPS Catalog ID: {27B453F9-CBF9-4dbf-906F-C0BBBBFE4213}
  4. Save and compile your plugin source code.

For plugins written in C++

  1. Make a copy of your plugin source code for backup purposes. This will be useful if you run into problems while migrating your source code, or if you want to use your plugin with ODTK 4 again.
  2. Open your project file (.vcproj) in Visual Studio. Open your plugin project's Properties page. Go to the C++ properties folder in the left navigation pane and select "General" from the submenu. Update your "Additional Include Directories" to include the current location of your ODTK 5 binaries. Select MIDL from the left navigation pane, and add the location of your ODTK 5 binaries to the "Additional Include Directories" entry there as well.
  3. Save the changes to the project and exit Visual Studio.
  4. Open the.rgsfile for your plugin implementation in a text editor.
  5. Locate the "Implemented Categories" section and replace the existing catalog ID with the new catalog ID supplied here:
    New HPOP Catalog ID: {5DE400B4-9F1B-4654-AC7B-3A5CDEE0E3D1
    New GPS Catalog ID: {27B453F9-CBF9-4dbf-906F-C0BBBBFE4213}
  6. Save the changes to your.rgsfile and open your project in Visual Studio. Compile your plugin source code.

For plugins written in VBScript, JavaScript, or another late-bound scripting language

  1. Make a copy of your.regfile for backup purposes.
  2. Open your.regfile in a text editor.
  3. Copy the following lines into your.regfile:

    For adding a GPS plugin

    [HKEY_CLASSES_ROOT\CLSID\{ < Your GUID Here > }\Implemented Categories\{27B453F9-CBF9-4dbf-906F-C0BBBBFE4213}]

    For adding an HPOP plugin

    [HKEY_CLASSES_ROOT\CLSID\{ < Your GUID Here > }\Implemented Categories\{5DE400B4-9F1B-4654-AC7B-3A5CDEE0E3D1}]

    and insert your plugin GUID at the location labeled "Your GUID Here".
  4. Save the changes to your.regfile. Run your.regfile to update your registry. You can now use your late-bound plugin.

ODTK 6.5