Version 2024 Upgrade Guide

Upgrading from a previous version is usually as simple as referencing the updated library versions. We have minimized breaking changes to ensure a straightforward upgrade process. The sections below offer helpful details for upgrading your project.

Download Products

This guide discusses changes to the 2024 version with technical details. For a more general overview, read the Version 2024 Overview.

Class and Namespace Capitalization
Exception Classes
Removal of Deprecated Properties
Included .NET Platforms
API Changes

Upgrade Guide

Class and Namespace Capitalization

Class names have been capitalized in a standard way. In many editions no changes are required. Only affected editions have been listed. Please see below for details about the impact to each edition.

.NET

Component class names have been renamed to use a standard capitalization. For instance Cbfs has been renamed to CBFS.

Java

Component class names have been renamed to use a standard capitalization. For instance Cbfs has been renamed to CBFS.

Exception Classes

In editions such as .NET where exception objects are instances of a class defined by the library, the exception classes have been consolidated to a single type. Previously exception classes existed for both individual components and the toolkit as a whole. The individual component exception classes have been removed across the board to simplify exception handling.

In addition, a new Source property has been added to all exception classes which reports the name of the component from which the exception was thrown.

The component specific exception classes such as CBFSConnectCbfsException have been removed. Update code to use CBFSConnectException. For instance:

The component specific exception classes such as CBFSException have been removed. Update code to use product-wide exception classes instead, such as CBFSConnectException. For instance:


catch (CBFSConnectException ex) {
  Console.WriteLine(ex.Message);
  Console.WriteLine(ex.Code);
  Console.WriteLine(ex.Source); //Outputs "CBFS"
}

Java editions did not previously make use of component specific exceptions. However, the Source property is now available. For instance:


catch (cbfsconnect.CBFSConnectException ex) {
  System.out.println(ex.getMessage());
  System.out.println(ex.getCode());
  System.out.println(ex.getSource());
}

Component specific exception classes such as EcbcCBFS have been removed. Update code to use ECBFSConnect. For instance:


except on E:ECBFSConnect do begin
  ShowMessage(E.Message);
  ShowMessage(E.Code);
  ShowMessage(E.Source);  //Outputs "CBFS"
end;

Component specific exception classes such as CBFSConnectCbfsError have been removed. Update code to use CBFSConnectError. For instance:


except CBFSConnectError as e:
  print(e.message)
  print(e.code)
  print(e.source)

PHP is not affected by this change. Exceptions thrown by the component are of the standard Exception type. For instance:


catch (Exception $ex)
{
  echo $ex->getMessage();
}

Component specific exception classes such as CbfsError have been removed. Update code to use CBFSConnectError. For instance:


catch CBFSConnectError.Error(let errorCode, let errorMessage, let source)
{
  print(errorCode)
  print(errorMessage)
  print(source)  //Outputs "CBFS"
}

C++ does not use exception objects, instead error handling is performed by checking the return code of methods, or by calling the component.GetLastError() and component.GetLastErrorCode() methods.


if (cbfs.GetLastErrorCode()) {
  printf("[%i] %s\n", cbfs.GetLastErrorCode(), cbfs.GetLastError());
}

Removal of Deprecated Properties

Properties which were deprecated in version 2022 have been removed in version 2024. In most cases the deprecated property has been replaced by a corresponding method that performs the same functionality.

Included .NET Platforms

In version 2024 the lib\net40 directory contains a .NET 4.0 library suitable for Windows development and includes design-time support for Visual Studio. The lib\net6.0 directory contains a .NET 6.0 library designed for cross-platform support. The lib\netstandard2.0 directory contains a .NET Standard 2.0 library for use with older cross-platform applications.

The .NET Framework 2.0 library is no longer included by default, but is available on demand for legacy projects.

API Changes

In most cases upgrading is seamless and requires no code changes, as efforts have been made to maintain backwards compatibility. However, the latest release includes several API changes that may require code changes. The articles linked below detail major changes between the previous and latest release.

Upgrading to the latest version is designed to be a quick process and involve only minimal code changes while offering additional functionality and options for new and existing users. Please contact us at support@callback.com with any questions or comments.

We appreciate your feedback. If you have any questions, comments, or suggestions about this article please contact our support team at support@callback.com.