Приложения

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

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

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

А.5.25.3. rdsVSAddTypeRename – добавить переименование типов структур

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

  int RDSCALL rdsVSAddTypeRenameA(
    RDS_HOBJECT Vars,       // Редактор переменных
    RDSCSTR OldStructType,  // Старое имя типа (UTF8)
    RDSCSTR NewStructType   // Новое имя типа (UTF8)
  );
  int RDSCALL rdsVSAddTypeRenameW(
    RDS_HOBJECT Vars,       // Редактор переменных
    RDSWCSTR OldStructType, // Старое имя типа (UTF16)
    RDSWCSTR NewStructType  // Новое имя типа (UTF16)
  );
  // Функция-псевдоним
  int RDSCALL rdsVSAddTypeRename(
    RDS_HOBJECT Vars,       // Редактор переменных
    RDSXCSTR OldStructType, // Старое имя типа (кодировка по умолчанию)
    RDSXCSTR NewStructType  // Новое имя типа (кодировка по умолчанию)
  );

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

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

Параметры

Vars (RDS_HOBJECT)

Идентификатор вспомогательного объекта-редактора переменных, ранее созданного функцией rdsVSCreateEditor.

OldStructType (RDSCSTR, RDSWCSTR, RDSXCSTR)

Указатель на строку с именем типа структуры до переименования.

NewStructType (RDSCSTR, RDSWCSTR, RDSXCSTR)

Указатель на строку с именем типа структуры после переименования.

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

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

Примечания

Эта функция запоминает в объекте-редакторе переменных Vars информацию о том, что структура OldStructType переименована в NewStructType. После этого при добавлении переменных в объект функциями rdsVSAddVar, rdsVSAddVarByTypeText, rdsVSAddVarByDescr и rdsVSCreateByDescr все встреченные структуры типа OldStructType будут автоматически заменяться на NewStructType.

См. также

rdsVSCreateEditor, RDS_HVAR_CLEARTYPEREN, rdsVSAddVar, rdsVSAddVarByTypeText, rdsVSAddVarByDescr, rdsVSCreateByDescr.