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

Описания RDS

Приложения

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

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

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

А.5.25.8. rdsVSApplyToBlock – создать структуру переменных блока

# Приложения

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

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

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

##### А.5.25.8. rdsVSApplyToBlock – создать структуру переменных блока

Функция rdsVSApplyToBlock создает в указанном блоке структуру статических переменных согласно данным объекта-редактора.

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

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

RDS_BHoBhpI

Параметры

Vars(RDS_HOBJECT)
  Идентификатор вспомогательного объекта-редактора переменных, ранее созданного функцией rdsVSCreateEditor.
Block(RDS_BHANDLE)
  Идентификатор простого блока, структуру статических переменных которого нужно заменить. Если в этом параметре передано значение NULL, структура переменных будет изменена у блока, модель которого вызвала функцию rdsVSApplyToBlock.
pRresult(int*)
  Указатель на целую переменную, в которую функция запишет код ошибки. Если код ошибки не нужен вызывающей программе, в этом параметре можно передать NULL.
  Код ошибки может принимать следующие значения:

  RDS_HVAR_ROK | Структура переменных успешно создана.
  RDS_HVAR_RVARCHECKERR | Модель блока Block не может работать с данной структурой переменных, то есть не прошла проверка типа переменных в событии RDS_BFM_VARCHECK.
  RDS_HVAR_REMPTYVARSET | Набор переменных в объекте Vars пуст.
  RDS_HVAR_RBADBLOCKTYPE | Блок Block – не простой, и ему нельзя назначить произвольную структуру переменных
  RDS_HVAR_RNOBLKSIGNALS | Первые две переменных в объекте Vars – не сигнальный вход и сигнальный выход, поэтому этот набор переменных не может быть назначен простому блоку.

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

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

Примечания

Эта функция создает в блоке Block структуру статических переменных согласно объекту Vars. Прежняя структура переменных блока уничтожается, связи остаются подключенными к переменным с теми же именами. Если вызовами rdsVSAddVarRename в Vars записаны какие-либо переименования переменных, связи переименованных переменных будут переключены на новые имена.

Пример

Примеры использования функции rdsVSApplyToBlock приведены в §2.16.1 и §3.4 руководства программиста.

См. также

rdsVSCreateEditor, rdsVSAddVarRename, rdsVSInstallStruct, rdsVSCreateFromBlock.