Функции и константы библиотеки расчета расстояний версии 4.0
Значком * помечены функции, сбрасывающие кэш, двумя значками * функции, сбрасывающие и наполняющие кэш. Кэширование используют только ресурсозатратные и поисковые функции.
Функции версий 1-3.
1.1. Измененные функции.
LastDistError() : integer
Содержит ошибку последней операции.
*LoadDistanceList
Загружает данные из файла.
**GetDistance
Функция
расчета расстояний, оставлена для совместимости вызовов с предыдущими версиями; в версии 4.0 ее заменяет
GetDistanceA.
**GetDistanceEx
Расширенная функция
расчета расстояний, оставлена для совместимости с предыдущими версиями.
От
GetDistance отличается наличием еще одной возвращаемой, а также форматом буфера маршрута
GetPointSizes
Функция предназначена для
получения размеров под буфера, заполняемые функцией
ExtractPoint. Функция возвращает код города выбираемой точки
GetPointSizesEx
Функция аналогична
GetPointSize, но для получения размеров под буфера расширенной функции
ExtractPointEx. Функция возвращает код города выбираемой точки
1.2. Функции, оставшиеся без изменений.
ExtractPoint
Функция предназначена для извлечения одной точки из буфера маршрута.
ExtractPointEx
Функция аналогична
ExtractPoint, но применяется для буфера, возвращаемого расширенной функцией расчета маршрута
GetDistanceEx.
*FreeDistanceList
Выгружает данные из памяти.
** GetCitiesList
Получает кода и имена городов. Оставлена
для совместимости, в версии 4 заменяема функциями
GetCitiesListA, GetCitiesListByRegionsA
GetCityIDByName
Возвращает код города
GetCityNameByID
Заполняет название города по его коду.
**GetCountriesList
Заполняет буфер списком стран.
**GetCountriesListEx
Аналогична GetCountriesList, но заполняет буфер списком стран в другом формате
GetCountryIDByName
Возвращает код страны по названию или международному сокращению
GetCountryNameByID
Заполняет название страны по ее коду.
GetMaxCitiesListSize, GetMaxCityNameSize, GetMaxCountriesListExSize, GetMaxCountriesListSize, GetMaxCountryNameSize.
Возвращают максимально необходимые размеры буферов под данные для GetCitiesList, GetCityNameById, GetCountriesListEx, GetCountriesList, GetCountryNameByID соответственно.
Оставлены для совместимости с предыдущими версиями.
GetVersionInfo
Получить информацию о версии библиотеки расчета расстояний.
GetWayTime
Функция заполняет время в пути последнего расчета. Аналогична времени в пути от первой точки маршрута до последней.
**SpeedsForRoadsTypes
Заполняет буфер значениями скоростей для разных типов трасс.
Функция оставлена для совместимости вызовов с предыдущими версиями, в версии 4 ей адекватны функции SpeedsForRoadTypesA и DelaysForTimesA.
Новые функции
**DelaysForTimesA
Заполняет массив предустановленными задержками во
времени в населенных пунктах, на таможнях и погрузках/выгрузках паромов.
**GetCitiesListA
Заполняет массив списком городов
**GetCitiesListByRegionsA
Заполняет массив списком городов, отфильтрованным по регионам.
GetCityByIdA
Заполняет массив полной информацией о городе по его коду.
GetCountryByIdA
Заполняет массив полной информацией о стране по ее коду.
**GetDistanceA
Функция заполняет массив информацией о пути между пунктами.
Функция аналогична старым функциям GetDistance, GetDistanceEx, но имеет существенное отличие в дополнительном параметре, устанавливающем, как форматировать возвращаемую строку.
GetItemDataSeparator
Возвращает ASCII-код разделителя данных в элементах списков.
GetRegionByIdA
Заполняет массив полной информацией о регионе по его коду
GetRegionIDByNameA
Возвращает код региона по его названию.
**GetRegionListA
Заполняет массив списком регионов.
GetRegionNameByIDA
Заполняет массив названием региона по его коду.
LastDistErrorMessageA
Заполняет массив текстом последней ошибки вызова функций библиотеки.
PointStrFormatIndexA
Устанавливает номер формата данных библиотеки и возвращает текущий формат
ReFormatPointStrA
Переформатирует элемент маршрута из текущего формата библиотеки в формат с определенным индексом и заполняет результатом.
**SpeedsForRoadTypesA
Заполняет массив значениями текущих расчетных скоростей библиотеки.
*LoadDistanceListA
Функция загрузки базы данных в память.
UserDefinedFormatA
Заполняет массив строкой форматирования пунктов маршрута для расчета расстояний.