Механизм контроля версий Document API

Константы версии Document API Major и Minor позволяют проверить совместимость предыдущей и текущей версии Document API.

Если была изменена константа Major версии Document API, то в Document API произошли обратно несовместимые изменения, и программный код должен быть пересмотрен и обновлен. Обратно несовместимыми изменениями считаются: переименование, удаление или несовместимое изменение подписи существующих классов или методов, а также добавление новых методов, типов и полей класса.

Если была изменена константа Minor версии Document API, то в Document API произошли только обратно совместимые изменения, и нет необходимости менять программный код, чтобы он работал с более новой версией Document API. Но гарантируется совместимость только на уровне исходного кода C#, поэтому необходимо перекомпилировать программный код приложения с более новой версией Document API.

Рекомендуется проверить версию Document API до инициализации, как указано ниже:

 uint ExpectedMajorAPIVersion **=** 1**;** <br/>uint ExpectedMinorAPIVersion **=** 0**;**<br/>**if** **(!**DocumentAPI**.**isAPIVersionCompatible**(**ExpectedMajorAPIVersion**,** ExpectedMinorAPIVersion**)) {**<br/> // Вывод сообщения о несовместимости версии библиотеки Document API и выход из программы<br/>**}**

Пример проверки совместимости указанной версии Document API с текущей:

 public class DocumentAPI 
 {
    public static bool isAPIVersionCompatible(uint major, uint minor);
 }