Приложения

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

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

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

А.5.14.12. rdsGetBlockVarDefValueStr – получить значение переменной блока по умолчанию

Функция rdsGetBlockVarDefValueStr возвращает динамическую строку, содержащую текстовое представление значения по умолчанию указанной переменной в указанном блоке.

  RDSSTR RDSCALL rdsGetBlockVarDefValueStrA( // UTF8
    RDS_BHANDLE Block, // Идентификатор блока
    int VarNum,        // Номер переменной
    int *pLength       // Возвращаемая длина строки
  );
  RDSWSTR RDSCALL rdsGetBlockVarDefValueStrW( // UTF16
    RDS_BHANDLE Block, // Идентификатор блока
    int VarNum,        // Номер переменной
    int *pLength       // Возвращаемая длина строки
  );
  // Функция-псевдоним
  RDSXSTR RDSCALL rdsGetBlockVarDefValueStr( // Кодировка по умолчанию
    RDS_BHANDLE Block, // Идентификатор блока
    int VarNum,        // Номер переменной
    int *pLength       // Возвращаемая длина строки
  );

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

RDS_SBhIpI (для UTF8) или RDS_WsBhIpI (для UTF16)

Параметры

Block (RDS_BHANDLE): Идентификатор блока, в котором нужно найти переменную.
VarNum (int): Порядковый номер переменной (начиная с нуля).
pLength (int*): Указатель на целую переменную, в которую функция должна записать длину получившейся строки. Если вызывающей программе не нужна длина строки, в этом параметре можно передать NULL.

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

Указатель на созданную в динамической памяти строку со значением по умолчанию указанной переменной, или NULL, если такой переменной нет.

Примечания

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

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

Пример

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

См. также

rdsSetBlockVarDefValueStr, rdsSetBlockVarDefValueByCur, rdsVSGetVarDefValueStr, rdsFree.