|
Описание библиотеки farlng:
Библиотека farlng версия 1.1 от 11.05.05
1. Описание
Библиотека farlng предназначена для добавления в плагины/приложения
возможности читать языковые файлы в формате Far Manager (.lng файлы). Библиотека
поставляется в виде библиотечного файла (.lib) в формате Microsoft Visual Studio .NET
с исходными текстами.
2. Использование библиотеки
Библиотека farlng предоставляет следующие функции для загрузки и работы
с .lng файлами:
2.1. Функция LoadLanguageFile
bool LoadLanguageFile ( const char *lpFileName, const char *lpLanguage, char **&pStrings, int &nStringsCount );
Описание
Функция загружает и обрабатывает языковой файл.
Параметры
| lpFileName |
полное имя языкового файла |
| lpLanguage |
требуемый язык языкового файла. Этот параметр может быть NULL,
если язык языкового файла может быть любым.
|
| pStrings |
возвращаемый массив строк из языкового файла |
| nStringsCount |
количество строк в массиве строк языкового файла |
Возвращаемое значение
Если функция смогла найти и прочесть языковой файл и его язык соответствует
языку, переданному в параметре lpLanguage, то функция возвращает true, иначе возвращается
false.
2.2. Функция SearchAndLoadLanguageFile
bool SearchAndLoadLanguageFile ( const char *lpPath, const char *lpLanguage, char **&pStrings, int &nStringsCount );
Описание
Функция ищет в заданной папке и загружает языковой файл содержащий строки на требуемом языке.
Параметры
| lpPath |
папка, в которой будет осуществляться поиск языковых файлов |
| lpLanguage |
требуемый язык языкового файла. Этот параметр может быть NULL,
если язык языкового файла может быть любым, в этом случае будет
загружен первый найденный языковой файл.
|
| pStrings |
возвращаемый массив строк из языкового файла |
| nStringsCount |
количество строк в массиве строк языкового файла |
Возвращаемое значение
Если функция смогла найти в заданной папке языковой файл требуемого языка и смогла
его прочесть, то функция возвращает true, иначе возвращается false.
2.3. Функция FinalizeLanguageStrings
void FinalizeLanguageStrings ( char **pStrings, int nStringsCount );
Описание
Функция освобождает массив память, выделенную под массив строк языкового файла.
Эту функцию следует вызывать только в случае успешной загрузки языкового файла
функциями LoadLanguageFile или SearchAndLoadLanguageFile.
Параметры
| pStrings |
массив строк языкового файла |
| nStringsCount |
количество строк в массиве строк языкового файла |
Возвращаемое значение
Нет.
3. Распространение и использование
Данный программный модуль (а равно и исходный текст) распространяется
бесплатно и без каких-либо ограничений на использование (хотя мне будет приятно,
если при использовании данного модуля вы будете добавлять
соответствующую ссылку в документации вашего плагина/программы),
а равно без ответственности автора за ошибки в нем содержащиеся,
а также за последствия правильного/неправильного использования
продукта.
|