Приложения

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

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

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

А.5.22.9. rdsGetObjectStr – получить строку

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

  RDSSTR RDSCALL rdsGetObjectStrA( // UTF8
    RDS_HOBJECT Object, // Идентификатор объекта
    int ValueId,        // Идентификатор параметра
    int ValueNum        // Номер параметра
  );
  RDSWSTR RDSCALL rdsGetObjectStrW( // UTF16
    RDS_HOBJECT Object, // Идентификатор объекта
    int ValueId,        // Идентификатор параметра
    int ValueNum        // Номер параметра
  );
  // Функция-псевдоним
  RDSXSTR RDSCALL rdsGetObjectStr( // Кодировка по умолчанию
    RDS_HOBJECT Object, // Идентификатор объекта
    int ValueId,        // Идентификатор параметра
    int ValueNum        // Номер параметра
  );

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

RDS_SHoII (для UTF8) или RDS_WsHoII (для UTF16)

Параметры

Object (RDS_HOBJECT)

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

ValueId (int)

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

ValueNum (int)

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

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

Указатель на строку (char* или wchar_t*, в зависимости от версии функции), соответствующую сочетанию параметров (ValueId,ValueNum). Это может быть как строка во внутренней памяти объекта, так и динамически созданная строка – в последнем случае ее нужно освобождать функцией rdsFree. Как именно устроена возвращаемая строка и нужно ли ее освобождать, указывается в описаниях конкретных объектов.

Примечания

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

Пример

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

См. также

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