Приложения

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

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

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

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

Функция rdsVSAddVarByTypeText добавляет в объект-редактор новую переменную, при этом ее тип задается текстом, понятным пользователю.

  int RDSCALL rdsVSAddVarByTypeTextA(
    RDS_HOBJECT Vars,     // Редактор переменных
    int Index,            // Номер переменной или -1
    RDSCSTR VarName,      // Имя переменной (UTF8)
    RDSCSTR VarTypeText,  // Текстовое описание типа (UTF8)
    DWORD Flags,          // Флаги переменной (RDS_VARFLAG_*)
    RDSCSTR DefVal        // Значение по умолчанию (UTF8)
  );
  int RDSCALL rdsVSAddVarByTypeTextW(
    RDS_HOBJECT Vars,     // Редактор переменных
    int Index,            // Номер переменной или -1
    RDSWCSTR VarName,     // Имя переменной (UTF16)
    RDSWCSTR VarTypeText, // Текстовое описание типа (UTF16)
    DWORD Flags,          // Флаги переменной (RDS_VARFLAG_*)
    RDSWCSTR DefVal       // Значение по умолчанию (UTF16)
  );
  // Функция-псевдоним
  int RDSCALL rdsVSAddVarByTypeText(
    RDS_HOBJECT Vars,     // Редактор переменных
    int Index,            // Номер переменной или -1
    RDSXCSTR VarName,     // Имя переменной (кодировка по умолчанию)
    RDSXCSTR VarTypeText, // Текстовое описание типа (кодировка по умолчанию)
    DWORD Flags,          // Флаги переменной (RDS_VARFLAG_*)
    RDSXCSTR DefVal       // Значение по умолчанию (кодировка по умолчанию)
  );

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

RDS_IHoISSDwS (для UTF8) или RDS_IHoIWsWsDwWs (для UTF16)

Параметры

Vars (RDS_HOBJECT): Идентификатор вспомогательного объекта-редактора переменных, ранее созданного функцией rdsVSCreateEditor.
Index (int): Начинающийся с нуля номер, который будет иметь эта переменная (уже существующие в наборе переменные начиная с этого номера сдвинутся на одну позицию вниз), или −1 для добавления переменной в конец списка.
VarName (RDSCSTR, RDSWCSTR, RDSXCSTR): Указатель на строку с именем переменной.
VarTypeText (RDSCSTR, RDSWCSTR, RDSXCSTR): Указатель на строку с текстовым описанием типа переменной, аналогичную формируемой функцией rdsCreateVarTypeText.
Flags (DWORD): Набор битовых флагов переменной (аналогично полю Flags структуры описания переменной RDS_VARDESCRIPTION). В этой функции не используется флаг RDS_VARFLAG_ONEINDEX: будет переменная матрицей или массивом, определяется словами, использованными для задания ее типа в параметре VarTypeText (если первое слово в тексте – «массив», переменная будет массивом, если «матрица» – матрицей).
DefVal (RDSCSTR, RDSWCSTR, RDSXCSTR): Указатель на строку значения переменной по умолчанию (аналогично функции rdsSetBlockVarDefValueStr).

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

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

Примечания

Эта функция добавляет в набор переменных объекта-редактора Vars новую переменную с именем VarName, флагами Flags и значением по умолчанию DefVal. Тип переменной задается текстом VarTypeText. При разборе текста берутся названия типов переменных для текущего установленного языка.

См. также

rdsVSCreateEditor, rdsVSAddVar, rdsVSAddVarByDescr, rdsVSCreateByDescr, rdsCreateVarDescriptionString, rdsCreateVarTypeText, rdsSetBlockVarDefValueStr, названия типов переменных.