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

Описания RDS

Приложения

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

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

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

А.5.25.27. Команда RDS_HVAR_GETTYPESTRING – получить строку типа всей структуры переменных

# Приложения

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

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

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

##### А.5.25.27. Команда RDS_HVAR_GETTYPESTRING – получить строку типа всей структуры переменных

Команда RDS_HVAR_GETTYPESTRING возвращает строку типа всей структуры переменных объекта-редактора. Строка типа состоит из последовательности символов, каждый из которых соответствует типу переменной.

Вызов команды

      RDSCSTR strType=rdsGetObjectStrA(Vars,RDS_HVAR_GETTYPESTRING,0); // UTF8

или

      RDSWCSTR strType=rdsGetObjectStrW(Vars,RDS_HVAR_GETTYPESTRING,0); // UTF16

или (через функцию-псевдоним)

      RDSXCSTR strType=rdsGetObjectStr(Vars,RDS_HVAR_GETTYPESTRING,0); // Кодировка по умолчанию

Параметры и результат

Vars(RDS_HOBJECT)
  Идентификатор вспомогательного объекта-редактора переменных, ранее созданного функцией rdsVSCreateEditor.
strType(RDSCSTR,RDSWCSTR,RDSXCSTR)
  Указатель на строку во внутренней памяти RDS, в которой находится сформированная командой строка типа структуры переменных, или NULL, если структура переменных в объекте Vars пуста.

Примечания

Строка типа каждый раз формируется заново при выполнении команды RDS_HVAR_GETTYPESTRING. Она хранится во внутренней памяти объекта Vars, указателем на нее, возвращенным командой, можно пользоваться до следующего вызова этой же команды для этого объекта. При добавлении и удалении переменных тип всей структуры меняется, но строка типа, хранящаяся в объекте Vars, будет обновлена только при очередном вызове команды RDS_HVAR_GETTYPESTRING.

Пример

Пример использования этой команды приведен в §3.4 руководства программиста.

См. также

rdsVSCreateEditor, rdsGetObjectStr.