Приложения

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

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

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

А.5.25.13. rdsVSGetVarDefValueStr – получить строку значения переменной по умолчанию

Функция rdsVSGetVarDefValueStr возвращает динамически сформированную строку со значением по умолчанию переменной с указанным номером в объекте-редакторе.

  RDSSTR RDSCALL rdsVSGetVarDefValueStrA(
    RDS_HOBJECT Vars, // Редактор переменных
    int Index,        // Номер переменной
    int *pLength      // Возвращаемая длина строки
  );
  RDSWSTR RDSCALL rdsVSGetVarDefValueStrW(
    RDS_HOBJECT Vars, // Редактор переменных
    int Index,        // Номер переменной
    int *pLength      // Возвращаемая длина строки
  );
  // Функция-псевдоним
  RDSXSTR RDSCALL rdsVSGetVarDefValueStr(
    RDS_HOBJECT Vars, // Редактор переменных
    int Index,        // Номер переменной
    int *pLength      // Возвращаемая длина строки
  );

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

RDS_SHoIpI (для UTF8) или RDS_WsHoIpI (для UTF16)

Параметры

Vars (RDS_HOBJECT)

Идентификатор вспомогательного объекта-редактора переменных, ранее созданного функцией rdsVSCreateEditor.

Index (int)

Начинающийся с нуля номер переменной.

pLength (int*)

Указатель на целую переменную, в которую функция должна записать длину получившейся строки. Если вызывающей программе не нужна длина строки, в этом параметре можно передать NULL.

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

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

Примечания

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

См. также

rdsVSCreateEditor, rdsGetBlockVarDefValueStr.