Приложения

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

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

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

А.5.25.15. rdsVSInstallStruct – добавить структуру в общий список структур

Функция rdsVSInstallStruct добавляет набор переменных объекта-редактора в общий список структур RDS.

  BOOL RDSCALL rdsVSInstallStruct(
    RDS_HOBJECT Vars,  // Редактор переменных
    int *pRresult      // Результат операции
  );

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

RDS_BHopI

Параметры

Vars (RDS_HOBJECT)

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

pRresult (int*)

Указатель на целую переменную, в которую функция запишет код ошибки. Если код ошибки не нужен вызывающей программе, в этом параметре можно передать NULL.
Код ошибки может принимать следующие значения:

RDS_HVAR_ROK	Структура успешно добавлена.
RDS_HVAR_ROKRENAMED	Структура добавлена, но ее имя изменено на другое.
RDS_HVAR_RNOTYPENAME	В объекте Vars не указано имя структуры (см. команду RDS_HVAR_SETTYPENAME).
RDS_HVAR_REMPTYVARSET	Набор переменных в объекте Vars пуст или Vars – не объект-редактор переменных.

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

TRUE – структура добавлена, FALSE – ошибка. Конкретный код ошибки возвращается через pResult.

Примечания

Эта функция позволяет зарегистрировать в общем списке структур RDS новую структуру, описание которой находится в объекте Vars. Если структура с таким именем уже есть в списке, данная структура будет добавлена с другим, автоматически выбранным именем. Имя структуры в объекте Vars в этом случае тоже изменится, новое имя можно будет считать командой RDS_HVAR_GETTYPENAME.

См. также

rdsVSCreateEditor, RDS_HVAR_SETTYPENAME, RDS_HVAR_GETTYPENAME.