paCfgReadValueDflt()

Функция возвращает либо значение обнаруженного параметра, либо значение по умолчанию.

Краткое описание

<type> paCfgReadValueDflt(string filename, string section, string key, <type> dfltValue[, bool & isDflt [,string host]]);

Параметры

ПараметрОписание
filenameИмя конфигурационного файла (включая путь к файлу), например: «C:\KASKAD_Proj\MyProject\config\config» или с использованием getPath():getPath(CONFIG_REL_PATH, «config»)
sectionСекция конфигурационного файла, например «general»
keyПараметр конфигурации, чье значение считывается, например «langs»
dfltValueЗначение по умолчанию.
isDfltЛожный параметр (возвращается значение «ЛОЖЬ») означает, что запись обнаружена. Истинный параметр означает, что запись не была обнаружена и применяется значение по умолчанию.
hostВ случае указания данного параметра считываются только параметры с этим узлом, например «$host1». В случае если запись пустая «» считываются только параметры без имени хоста. В случае отсутствия определений хоста параметры хостов не считываются.

Возвращаемое значение

Обнаруженная конфигурационная запись.

Ошибки

Недостающие или ошибочные аргументы.

Описание

Функция считывает указанное значение по молчанию в случае отсутствия параметра конфигурации. Таким образом функция возвращает либо значение обнаруженного параметра, либо значение по умолчанию.
ВНИМАНИЕ
В общую часть кода необходимо включить «CtrlPv2Admin DLL» (для обеспечения возможности использования функции «paCfgInsertValue»): #uses «CtrlPv2Admin»

ЗначокПРИМЕР
Следующий пример считывает значение параметра «langs», если он обнаружен. Если же параметр не обнаружен, отображается указанное значение по умолчанию.

main()
{
string val;
string filename = «c:/KASKAD_Proj/test/config/config»;
string section = «general»;
string dfltValue = «Sprache»;
bool isDflt;
val = paCfgReadValueDflt(filename,section, «langs»,dfltValue,isDflt);
if (!isDflt)
{
  DebugN(«Return value is:»,val);
}
else
{
  DebugN(«Default value is:»,dfltValue);
}
}

ПРИМЕЧАНИЕ
Следует отметить, что максимальное количество символов в строке конфигурационного файла ограничено 511 символами (также см. Configuration file). В случае превышения данного числа, возвращается -1.

Используется для объекта

Функции администрирования проектов

Доступность

CTRL

См. также

paCfgReadValue(),paCfgReadValueList()paCfgInsertValue()

Добавить комментарий

Ваш адрес email не будет опубликован. Обязательные поля помечены *