Приложения

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

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

А.5.25. Вспомогательный объект для изменения структуры переменных блока

А.5.25.5. rdsVSAddVarByDescr – добавить переменную по строке описания

Функция rdsVSAddVarByDescr добавляет в объект-редактор новую переменную, соответствующую указанной строке описания.

  int RDSCALL rdsVSAddVarByDescrA(
    RDS_HOBJECT Vars,    // Редактор переменных
    int Index,           // Номер переменной или -1
    RDSCSTR DescrString  // Строка описания (UTF8)
  );
  int RDSCALL rdsVSAddVarByDescrW(
    RDS_HOBJECT Vars,    // Редактор переменных
    int Index,           // Номер переменной или -1
    RDSWCSTR DescrString // Строка описания (UTF16)
  );
  // Функция-псевдоним
  int RDSCALL rdsVSAddVarByDescr(
    RDS_HOBJECT Vars,    // Редактор переменных
    int Index,           // Номер переменной или -1
    RDSXCSTR DescrString // Строка описания (кодировка по умолчанию)
  );

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

RDS_IHoIS (для UTF8) или RDS_IHoIWs (для UTF16)

Параметры

Vars (RDS_HOBJECT): Идентификатор вспомогательного объекта-редактора переменных, ранее созданного функцией rdsVSCreateEditor.
Index (int): Начинающийся с нуля номер, который будет иметь эта переменная (уже существующие в наборе переменные начиная с этого номера сдвинутся на одну позицию вниз), или −1 для добавления переменной в конец списка.
DescrString (RDSCSTR, RDSWCSTR, RDSXCSTR): Указатель на строку с описанием переменной. Строка описания устроена точно так же, как строка, формируемая функцией rdsCreateVarDescriptionString при StructFields==FALSE.

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

Номер добавленной переменной или −1 в случае ошибки.

Примечания

Эта функция добавляет в набор переменных объекта-редактора Vars новую переменную с описанием DescrString в позицию Index. Строка описания содержит тип, и имя переменной, ее значение по умолчанию и прочие параметры.

См. также

rdsVSCreateEditor, rdsVSAddVar, rdsVSAddVarByTypeText, rdsVSCreateByDescr, rdsCreateVarDescriptionString.