#include <scoped_bstr.h>

Public Member Functions
	ScopedBstr ()=default

	ScopedBstr (std::wstring_view non_bstr)

	~ScopedBstr ()

BSTR	Get () const

void	Reset (BSTR bstr=nullptr)

BSTR	Release ()

BSTR	Allocate (std::wstring_view str)

BSTR	AllocateBytes (size_t bytes)

void	SetByteLen (size_t bytes)

void	Swap (ScopedBstr &bstr2)

BSTR *	Receive ()

size_t	Length () const

size_t	ByteLength () const

bool	operator== (const ScopedBstr &bstr2) const =delete

bool	operator!= (const ScopedBstr &bstr2) const =delete

Detailed Description

Definition at line 22 of file scoped_bstr.h.

Constructor & Destructor Documentation

◆ ScopedBstr() [1/2]

base::win::ScopedBstr::ScopedBstr ( )

default

Referenced by ~ScopedBstr().

◆ ScopedBstr() [2/2]

base::win::ScopedBstr::ScopedBstr ( std::wstring_view non_bstr )

explicit

Definition at line 34 of file scoped_bstr.cc.

35 : bstr_(AllocBstrOrDie(non_bstr)) {}

◆ ~ScopedBstr()

base::win::ScopedBstr::~ScopedBstr ( )

Definition at line 37 of file scoped_bstr.cc.

                        {
  static_assert(sizeof(ScopedBstr) == sizeof(BSTR), "ScopedBstrSize");
  ::SysFreeString(bstr_);
}

References ScopedBstr().

Member Function Documentation

◆ Allocate()

BSTR base::win::ScopedBstr::Allocate ( std::wstring_view str )

Definition at line 67 of file scoped_bstr.cc.

                                             {
  Reset(AllocBstrOrDie(str));
  return bstr_;
}

References Reset().

◆ AllocateBytes()

BSTR base::win::ScopedBstr::AllocateBytes ( size_t bytes )

Definition at line 72 of file scoped_bstr.cc.

                                           {
  Reset(AllocBstrBytesOrDie(bytes));
  return bstr_;
}

References Reset().

◆ ByteLength()

size_t base::win::ScopedBstr::ByteLength ( ) const

Definition at line 87 of file scoped_bstr.cc.

                                    {
  return ::SysStringByteLen(bstr_);
}

◆ Get()

BSTR base::win::ScopedBstr::Get ( ) const

inline

Definition at line 33 of file scoped_bstr.h.

33{ return bstr_; }

Referenced by base::win::TEST(), ui::TEST_F(), ui::TEST_F(), ui::TEST_F(), ui::TEST_F(), ui::TEST_F(), ui::TEST_F(), ui::TEST_F(), ui::TEST_F(), ui::TEST_F(), ui::TEST_F(), ui::TEST_F(), and ui::TEST_F().

◆ Length()

size_t base::win::ScopedBstr::Length ( ) const

Definition at line 83 of file scoped_bstr.cc.

                                {
  return ::SysStringLen(bstr_);
}

Referenced by base::win::TEST(), and ui::TEST_F().

◆ operator!=()

bool base::win::ScopedBstr::operator!= ( const ScopedBstr & bstr2 ) const

delete

◆ operator==()

bool base::win::ScopedBstr::operator== ( const ScopedBstr & bstr2 ) const

delete

◆ Receive()

BSTR * base::win::ScopedBstr::Receive ( )

Definition at line 62 of file scoped_bstr.cc.

                          {
  BASE_DCHECK(!bstr_) << "BSTR leak.";
  return &bstr_;
}

References BASE_DCHECK.

Referenced by ui::TEST_F(), ui::TEST_F(), ui::TEST_F(), ui::TEST_F(), ui::TEST_F(), ui::TEST_F(), ui::TEST_F(), ui::TEST_F(), ui::TEST_F(), ui::TEST_F(), ui::TEST_F(), ui::TEST_F(), and ui::TEST_F().

◆ Release()

BSTR base::win::ScopedBstr::Release ( )

Definition at line 50 of file scoped_bstr.cc.

                         {
  BSTR bstr = bstr_;
  bstr_ = nullptr;
  return bstr;
}

Referenced by base::win::TEST(), and ui::TEST_F().

◆ Reset()

void base::win::ScopedBstr::Reset ( BSTR bstr = nullptr )

Definition at line 42 of file scoped_bstr.cc.

                                {
  if (bstr != bstr_) {
    // SysFreeString handles null properly.
    ::SysFreeString(bstr_);
    bstr_ = bstr;
  }
}

Referenced by Allocate(), AllocateBytes(), ui::TEST_F(), ui::TEST_F(), ui::TEST_F(), and ui::TEST_F().

◆ SetByteLen()

void base::win::ScopedBstr::SetByteLen ( size_t bytes )

Definition at line 77 of file scoped_bstr.cc.

                                        {
  BASE_DCHECK(bstr_);
  uint32_t* data = reinterpret_cast<uint32_t*>(bstr_);
  data[-1] = checked_cast<uint32_t>(bytes);
}

References BASE_DCHECK, and data.

◆ Swap()

void base::win::ScopedBstr::Swap ( ScopedBstr & bstr2 )

Definition at line 56 of file scoped_bstr.cc.

                                       {
  BSTR tmp = bstr_;
  bstr_ = bstr2.bstr_;
  bstr2.bstr_ = tmp;
}

Referenced by base::win::TEST().

The documentation for this class was generated from the following files:

third_party/accessibility/base/win/scoped_bstr.h
third_party/accessibility/base/win/scoped_bstr.cc

Public Member Functions