std::ios_base::pword

void*& pword( int index );

Сначала выделяет или перераспределяет частное хранилище (динамический массив void* или другой индексируемой структуры данных) достаточно, чтобы index был допустимым индексом, затем возвращает ссылку на элемент void* частного хранилища с индексом index.

Ссылка может быть аннулирована любой операцией над этим объектом ios_base, включая другой вызов pword(), но сохранённые значения остаются, так что чтение из pword(index) с тем же индексом позже даст то же значение до следующего вызова std::basic_ios::copyfmt(). Значение можно использовать для любых целей. Индекс элемента должен быть получен с помощью xalloc(), в противном случае поведение не определено. Новые элементы инициализируются нулевым указателем.

Если функция завершается неудачно (возможно, из-за ошибки выделения памяти) и *this является подобъектом базового класса объекта или подобъекта basic_ios<>, вызывается std::basic_ios<>::setstate(badbit), которая может выбросить std::ios_base::failure.

Параметры

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

Ссылка на элемент.

Исключения

Может выбросить std::ios_base::failure при установке флага badbit.

Примечания

Если указатели, хранящиеся в pword, требуют управления, можно использовать register_callback() для установки обработчиков, которые выполняют глубокое копирование или освобождение памяти по мере необходимости.

Пример

#include <iostream>
 
template<class CharT, class Traits = std::char_traits<CharT>>
class mystream : public std::basic_ostream<CharT, Traits>
{
public:
    static const int xindex;
 
    mystream(std::basic_ostream<CharT, Traits>& ostr) :
        std::basic_ostream<CharT, Traits>(ostr.rdbuf())
    {
        this->pword(xindex) = this;
    }
 
    void myfn()
    {
        *this << "[special handling for mystream]";
    }
};
 
// Each specialization of mystream obtains a unique index from xalloc()
template<class CharT, class Traits>
const int mystream<CharT, Traits>::xindex = std::ios_base::xalloc();
 
// This I/O manipulator will be able to recognize ostreams that are mystreams
// by looking up the pointer stored in pword
template<class CharT, class Traits>
std::basic_ostream<CharT, Traits>& mymanip(std::basic_ostream<CharT, Traits>& os)
{
    if (os.pword(mystream<CharT, Traits>::xindex) == &os)
        static_cast<mystream<CharT, Traits>&>(os).myfn();
    return os;
}
 
int main()
{
    std::cout << "cout, narrow-character test " << mymanip << '\n';
 
    mystream<char> myout(std::cout);
    myout << "myout, narrow-character test " << mymanip << '\n';
 
    std::wcout << "wcout, wide-character test " << mymanip << '\n';
 
    mystream<wchar_t> mywout(std::wcout);
    mywout << "mywout, wide-character test " << mymanip << '\n';
}

cout, narrow-character test
myout, narrow-character test [special handling for mystream]
wcout, wide-character test
mywout, wide-character test [special handling for mystream]

Отчёты о дефектах

Следующие отчёты о дефектах, изменяющие поведение, были применены ретроактивно к ранее опубликованным стандартам C++.

См. также