Приложения

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

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

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

А.5.14.9. rdsFindStructVar – найти структуру по имени типа

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

  RDS_VHANDLE RDSCALL rdsFindStructVarA(
    RDSCSTR TypeName,          // Имя типа структуры (UTF8)
    RDS_PVARDESCRIPTION pDescr // Заполняемое описание
  );
  RDS_VHANDLE RDSCALL rdsFindStructVarW(
    RDSWCSTR TypeName,         // Имя типа структуры (UTF16)
    RDS_PVARDESCRIPTION pDescr // Заполняемое описание
  );
  // Функция-псевдоним
  RDS_VHANDLE RDSCALL rdsFindStructVar(
    RDSXCSTR TypeName,         // Имя типа структуры (кодировка по умолчанию)
    RDS_PVARDESCRIPTION pDescr // Заполняемое описание
  );

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

RDS_VhSVd (для UTF8) или RDS_VhWsVd (для UTF16)

Параметры

TypeName (RDSCSTR, RDSWCSTR, RDSXCSTR): Указатель на строку с именем типа структуры.
pDescr (RDS_PVARDESCRIPTION): Указатель на структуру описания переменной RDS_VARDESCRIPTION, которую функция должна заполнить параметрами найденной структуры. Если вызывающей программе не нужно описание, в этом параметре можно передать NULL.

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

Идентификатор найденной структуры (тип RDS_VHANDLE) или NULL, если структура с именем типа TypeName не зарегистрирована в схеме.

Примечания

Эта функция позволяет найти идентификатор одной из структур в общем списке структур RDS. Каждая из этих структур представляет собой обычную переменную и, как и переменные блоков, имеет идентификатор RDS_VHANDLE.

См. также

rdsGetVarField, RDS_VARDESCRIPTION, rdsGetStructVar.