Приложения

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

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

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

А.5.14.7. rdsCreateVarTypeText – название типа переменной

Функция rdsCreateVarTypeText формирует в памяти динамическую строку с названием типа переменной, которое можно показывать пользователю.

  RDSSTR RDSCALL rdsCreateVarTypeTextA( // UTF8
    RDS_VHANDLE Var // Идентификатор переменной
  );
  RDSWSTR RDSCALL rdsCreateVarTypeTextW( // UTF16
    RDS_VHANDLE Var // Идентификатор переменной
  );
  // Функция-псевдоним
  RDSXSTR RDSCALL rdsCreateVarTypeText( // Кодировка по умолчанию
    RDS_VHANDLE Var // Идентификатор переменной
  );

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

RDS_SVh (для UTF8) или RDS_WsVh (для UTF16)

Параметр

Var (RDS_VHANDLE)

Идентификатор переменной.

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

Указатель на созданную в динамической памяти строку, в которой сформировано название типа переменной Var. Для описания используются те же слова, что и в функции rdsProcessText с параметром RDS_PT_VARTYPETEXT. В случае ошибки возвращается NULL.

Если переменная Var – матрица, название типа будет состоять из нескольких строк: сначала будет несколько раз (по числу вложенности матриц) повторено слово «Матрица», а затем – тип элемента. Например:

Примечания

Эта функция чаще всего используется для индикации типа переменной в понятном пользователю виде.

Динамическая строка, созданная функцией rdsCreateVarTypeText, должна быть обязательно освобождена функцией rdsFree.

См. также

RDS_PT_VARTYPETEXT, rdsFree.