Приложения
Приложение А. Функции, константы и структуры RDS
А.5. Сервисные функции и макросы RDS
А.5.25. Вспомогательный объект для изменения структуры переменных блока
А.5.25.14. rdsVSGetVarDescription – получить описание переменной
Функция rdsVSGetVarDescription заполняет структуру RDS_VARDESCRIPTION описанием указанной переменной объекта-редактора или описанием всего набора переменных этого объекта.
BOOL RDSCALL rdsVSGetVarDescription( RDS_HOBJECT Vars, // Редактор переменных int Index, // Номер переменной или -1 RDS_PVARDESCRIPTION pDescr // Заполняемая структура );
Тип указателя на эту функцию
RDS_BHoIVd
Параметры
- Vars (RDS_HOBJECT)
- Идентификатор вспомогательного объекта-редактора переменных, ранее созданного функцией rdsVSCreateEditor.
- Index (int)
- Начинающийся с нуля номер переменной или −1, если нужно заполнить RDS_VARDESCRIPTION описанием всего набора переменных объекта Vars как одной большой структуры.
- pDescr (RDS_PVARDESCRIPTION)
- Указатель на структуру описания переменной RDS_VARDESCRIPTION, которую функция должна заполнить параметрами переменной с указанным номером.
Возвращаемое значение
TRUE – структура описания заполнена, FALSE – ошибка (нет такой переменной или поле servSize структуры RDS_VARDESCRIPTION неверно инициализировано).
Примечания
Эта функция позволяет получить описание одной из внутренних переменных объекта Vars или всего объекта как одной переменной структурного типа.
Пример
Пример использования функции rdsVSGetVarDescription приведен в §2.16.1 руководства программиста.
См. также