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

Описания RDS

Приложения

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

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

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

А.5.25.9. rdsVSCreateByDescr – заполнить набор переменных по тексту описания

# Приложения

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

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

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

##### А.5.25.9. rdsVSCreateByDescr – заполнить набор переменных по тексту описания

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

      BOOL RDSCALL rdsVSCreateByDescrA(
        RDS_HOBJECT Vars,    // Редактор переменных
        RDSCSTR DescrString  // Текст описания (UTF8)
      );
      BOOL RDSCALL rdsVSCreateByDescrW(
        RDS_HOBJECT Vars,    // Редактор переменных
        RDSWCSTR DescrString // Текст описания (UTF16)
      );
      // Функция-псевдоним
      BOOL RDSCALL rdsVSCreateByDescr(
        RDS_HOBJECT Vars,    // Редактор переменных
        RDSXCSTR DescrString // Текст описания (кодировка по умолчанию)
      );

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

RDS_BHoS (для UTF8) или RDS_BHoWs (для UTF16)

Параметры

Vars(RDS_HOBJECT)
  Идентификатор вспомогательного объекта-редактора переменных, ранее созданного функцией rdsVSCreateEditor.
DescrString(RDSCSTR,RDSWCSTR,RDSXCSTR)
  Указатель на текст с описанием всей структуры переменных. Текст описания структуры устроен точно так же, как строка, формируемая функцией rdsCreateVarDescriptionString при StructFields==TRUE.

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

TRUE – набор переменных создан, FALSE – ошибка (например, в синтаксисе текстового описания).

Примечания

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

Пример

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

См. также

rdsVSCreateEditor, rdsVSAddVarByDescr, rdsCreateVarDescriptionString.