Приложения

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

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

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

А.5.14.20. rdsVarUsesStructType – проверить использование структуры внутри переменной

Функция rdsVarUsesStructType проверяет, используется ли где-нибудь внутри указанной переменной (в элементах матриц или в полях структур) структура указанного типа.

  BOOL RDSCALL rdsVarUsesStructTypeA(
    RDS_VHANDLE Var,    // Переменная
    RDSCSTR StructName  // Имя типа структуры (UTF8)
  );
  BOOL RDSCALL rdsVarUsesStructTypeW(
    RDS_VHANDLE Var,    // Переменная
    RDSWCSTR StructName // Имя типа структуры (UTF16)
  );
  // Функция-псевдоним
  BOOL RDSCALL rdsVarUsesStructType(
    RDS_VHANDLE Var,    // Переменная
    RDSXCSTR StructName // Имя типа структуры (кодировка по умолчанию)
  );

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

RDS_BVhS (для UTF8) или RDS_BVhWs (для UTF16)

Параметры

Var (RDS_VHANDLE)

Идентификатор переменной, внутри которой ищется структура с указанным именем типа. Очевидно, эта переменная должна быть массивом, матрицей или структурой – внутри простых переменных не может быть других переменных, а, значит, никакая структура в них заведомо не используется.

StructName (RDSCSTR, RDSWCSTR, RDSXCSTR)

Указатель на строку с именем типа, под которым структура зарегистрирована в RDS.

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

TRUE – структура StructName используется где-то внутри переменной Var. FALSE – структура не используется.

Примечания

С помощью этой функции можно проверить, требуется ли описание структуры с типом StructName для работы с переменной Var. Она может применяться в модулях автокомпиляции (см. главу 3 руководства программиста) для поиска структур RDS, описания которых нужны для работы блока.

См. также

rdsFindStructVar, rdsGetStructVar, rdsVSUsesStructType.