Приложения

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

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

А.5.22. Общие функции вспомогательных объектов

А.5.22.12. rdsSetObjectStr – установить строку

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

  void RDSCALL rdsSetObjectStrA(
    RDS_HOBJECT Object, // Идентификатор объекта
    int ValueId,        // Идентификатор параметра
    int ValueNum,       // Номер параметра
    RDSCSTR Value       // Значение параметра (UTF8)
  );
  void RDSCALL rdsSetObjectStrW(
    RDS_HOBJECT Object, // Идентификатор объекта
    int ValueId,        // Идентификатор параметра
    int ValueNum,       // Номер параметра
    RDSWCSTR Value      // Значение параметра (UTF16)
  );
  // Функция-псевдоним
  void RDSCALL rdsSetObjectStr(
    RDS_HOBJECT Object, // Идентификатор объекта
    int ValueId,        // Идентификатор параметра
    int ValueNum,       // Номер параметра
    RDSXCSTR Value      // Значение параметра (кодировка по умолчанию)
  );

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

RDS_VHoIIS (для UTF8) или RDS_VHoIIWs (для UTF16)

Параметры

Object (RDS_HOBJECT)

Идентификатор вспомогательного объекта RDS, строку которого нужно установить.

ValueId (int)

Идентификатор строки (зависит от конкретного типа объекта Object).

ValueNum (int)

Номер строки, если в объекте несколько строк с идентификатором ValueId (например, ValueId может быть идентификатором массива строк, а ValueNum – индексом в этом массиве).

Value (RDSCSTR, RDSWCSTR, RDSXCSTR)

Передаваемая в объект строка, соответствующая сочетанию параметров (ValueId,ValueNum).

Примечания

Эта функция устанавливает какую-либо строку объекта Object. Смысл и структура этой строки, а также допустимые значения ValueId и ValueNum зависят от конкретного типа объекта.

Пример

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

См. также

Вспомогательные объекты, rdsGetObjectStr