Текущий раздел:

Описания RDS

Приложения

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

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

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

А.5.25.7. rdsVSAddVarRename – добавить переименование переменной

# Приложения

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

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

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

##### А.5.25.7. rdsVSAddVarRename – добавить переименование переменной

Функция rdsVSAddVarRename добавляет в объект-редактор переменных информацию об изменении имени переменной.

      int RDSCALL rdsVSAddVarRenameA(
        RDS_HOBJECT Vars,    // Редактор переменных
        RDSCSTR OldVarName,  // Старое имя переменной (UTF8)
        RDSCSTR NewVarName   // Новое имя переменной (UTF8)
      );
      int RDSCALL rdsVSAddVarRenameW(
        RDS_HOBJECT Vars,    // Редактор переменных
        RDSWCSTR OldVarName, // Старое имя переменной (UTF16)
        RDSWCSTR NewVarName  // Новое имя переменной (UTF16)
      );
      // Функция-псевдоним
      int RDSCALL rdsVSAddVarRename(
        RDS_HOBJECT Vars,    // Редактор переменных
        RDSXCSTR OldVarName, // Старое имя переменной (кодировка по умолчанию)
        RDSXCSTR NewVarName  // Новое имя переменной (кодировка по умолчанию)
      );

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

RDS_IHoSS (для UTF8) или RDS_IHoWsWs (для UTF16)

Параметры

Vars(RDS_HOBJECT)
  Идентификатор вспомогательного объекта-редактора переменных, ранее созданного функцией rdsVSCreateEditor.
OldVarName(RDSCSTR,RDSWCSTR,RDSXCSTR)
  Указатель на строку с именем переменной до переименования.
NewVarName(RDSCSTR,RDSWCSTR,RDSXCSTR)
  Указатель на строку с именем переменной после переименования.

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

Номер добавленного переименования или −1 в случае ошибки (новое имя совпадает со старым или Vars – не объект-редактор переменных).

Примечания

Эта функция запоминает в объекте-редакторе переменных Vars информацию о том, что переменная OldVarName переименована в NewVarName. Эта информация будет использована при создании структуры статических переменных блока функцией rdsVSApplyToBlock: все связи, подключенные к OldVarName после замены структуры переменных будут подключены к NewVarName.

См. также

rdsVSCreateEditor, rdsVSApplyToBlock.