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

Описания RDS

Приложения

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

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

А.5.14. Общие функции работы с переменными блока

А.5.14.10. rdsGetBlockVar – переменная блока по номеру

# Приложения

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

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

#### А.5.14. Общие функции работы с переменными блока

##### А.5.14.10. rdsGetBlockVar – переменная блока по номеру

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

      RDS_VHANDLE RDSCALL rdsGetBlockVar(
        RDS_BHANDLE Block,          // Идентификатор блока
        int VarNum,                 // Номер переменной или -1
        RDS_PVARDESCRIPTION pDescr  // Заполняемое описание
      );

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

RDS_VhBhiVd

Параметры

Block(RDS_BHANDLE)
  Идентификатор блока, в котором нужно найти переменную. Если в этом параметре передано значение NULL, функция будет работать с блоком, из модели которого она вызвана.
VarNum(int)
  Порядковый номер переменной (начиная с нуля) или −1, если нужно получить идентификатор всей структуры переменных блока как единого целого.
pDescr(RDS_PVARDESCRIPTION)
  Указатель на структуру описания переменной RDS_VARDESCRIPTION, которую функция должна заполнить параметрами переменной с указанным номером. Если вызывающей программе не нужно описание переменной, в этом параметре можно передать NULL.

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

Идентификатор найденной переменной (тип RDS_VHANDLE) или NULL, если переменная с номером VarNum отсутствует в блоке Block.

Примечания

Эта функция позволяет найти идентификатор переменной с заданным номером и заполнить структуру ее описания. Для того, чтобы определить общее число переменных в блоке, следует вызвать эту функцию с параметром VarNum=–1, передав в параметре pDescr указатель на структуру RDS_VARDESCRIPTION, при этом в этой структуре окажется описание всей структуры переменных блока как одной большой переменной, и в ее поле StructFields будет содержаться общее число переменных в этом блоке.

Пример

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

См. также

rdsFindBlockVar, rdsGetVarField, RDS_VARDESCRIPTION.