Приложения

Приложение А. Функции, константы и структуры RDS

А.5. Сервисные функции и макросы RDS

А.5.14. Общие функции работы с переменными блока

А.5.14.17. rdsSetBlockVarDefValueStr – установить значение переменной по умолчанию

Функция rdsSetBlockVarDefValueStr устанавливает значение по умолчанию и текущее значение для указанной переменной указанного блока согласно переданной строке.

  BOOL RDSCALL rdsSetBlockVarDefValueStrA(
    RDS_BHANDLE Block, // Идентификатор блока
    int VarNum,        // Номер переменной
    RDSCSTR DefValue   // Строка значения (UTF8)
  );
  BOOL RDSCALL rdsSetBlockVarDefValueStrW(
    RDS_BHANDLE Block, // Идентификатор блока
    int VarNum,        // Номер переменной
    RDSWCSTR DefValue  // Строка значения (UTF16)
  );
  // Функция-псевдоним
  BOOL RDSCALL rdsSetBlockVarDefValueStr(
    RDS_BHANDLE Block, // Идентификатор блока
    int VarNum,        // Номер переменной
    RDSXCSTR DefValue  // Строка значения (кодировка по умолчанию)
  );

Тип указателя на эту функцию

RDS_BBhIS (для UTF8) или RDS_BBhIWs (для UTF16)

Параметры

Block (RDS_BHANDLE)

Идентификатор блока, которому принадлежит переменная.

VarNum (int)

Порядковый номер переменной в блоке (начиная с нуля).

DefValue (RDSCSTR, RDSWCSTR, RDSXCSTR)

Указатель на строку, содержащую символьное представление значения переменной (в том виде, в котором его обычно вводит пользователь).

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

TRUE – значение переменной установлено, FALSE – в блоке нет переменной с таким номером.

Примечания

Эта функция позволяет задать текущее значение переменной и ее значение по умолчанию. Устанавливаемое значение указывается в символьном виде, соответствующем правилам RDS:

• для вещественных переменных – строка, соответствующая правилам функции rdsAtoD;
• для целых, логических и сигнальных переменных – строка, соответствующая правилам функции rdsAtoI;
• для массивов – строка вида «[N]val», где N – число элементов, val – значение элемента (одно на все элементы);
• для матриц – строка вида «[Nr,Nc]val», где Nr – число строк, Nc – число столбцов, val – значение элемента (одно на все элементы);
• для структур – строка вида «{val1,val2, … ,valN}», где val1…valN – значения полей.

Чаще всего эта функция используется для записи введенного пользователем значения одновременно в текущее значение и в значение переменной по умолчанию.

Пример

Пример использования функции rdsSetBlockVarDefValueStr приведен в §2.7.4 руководства программиста.

См. также

rdsSetBlockVarDefValueByCur, rdsGetBlockVarDefValueStr, rdsAtoD, rdsAtoI.