ATL::CComBSTR Class Reference

#include <atlcomcli.h>

Public Member Functions
	CComBSTR ()
	CComBSTR (LPCOLESTR pSrc)
	CComBSTR (int length)
	CComBSTR (int length, LPCOLESTR pSrc)
	CComBSTR (PCSTR pSrc)
	CComBSTR (const CComBSTR &other)
	CComBSTR (REFGUID guid)
	~CComBSTR ()
	operator BSTR () const
BSTR *	operator& ()
CComBSTR &	operator= (const CComBSTR &other)
void	Attach (BSTR bstr)
BSTR	Detach ()
BSTR	Copy () const
HRESULT	CopyTo (BSTR *other) const
bool	LoadString (HMODULE module, DWORD uID)
unsigned int	Length () const
unsigned int	ByteLength () const

Public Attributes
BSTR	m_str

Detailed Description

Definition at line 287 of file atlcomcli.h.

Constructor & Destructor Documentation

CComBSTR() [1/7]

ATL::CComBSTR::CComBSTR ( )

inline

Definition at line 292 of file atlcomcli.h.

               :
        m_str(NULL)
    {
    }

CComBSTR() [2/7]

ATL::CComBSTR::CComBSTR ( LPCOLESTR  pSrc )

inline

Definition at line 297 of file atlcomcli.h.

    {
        if (pSrc == NULL)
            m_str = NULL;
        else
            m_str = ::SysAllocString(pSrc);
    }

CComBSTR() [3/7]

ATL::CComBSTR::CComBSTR ( int  length )

inline

Definition at line 305 of file atlcomcli.h.

    {
        if (length == 0)
            m_str = NULL;
        else
            m_str = ::SysAllocStringLen(NULL, length);
    }

CComBSTR() [4/7]

ATL::CComBSTR::CComBSTR ( int  length, LPCOLESTR  pSrc  )

inline

Definition at line 313 of file atlcomcli.h.

    {
        if (length == 0)
            m_str = NULL;
        else
            m_str = ::SysAllocStringLen(pSrc, length);
    }

CComBSTR() [5/7]

ATL::CComBSTR::CComBSTR ( PCSTR  pSrc )

inline

Definition at line 321 of file atlcomcli.h.

    {
        if (pSrc)
        {
            int len = MultiByteToWideChar(CP_THREAD_ACP, 0, pSrc, -1, NULL, 0);
            m_str = ::SysAllocStringLen(NULL, len - 1);
            if (m_str)
            {
                int res = MultiByteToWideChar(CP_THREAD_ACP, 0, pSrc, -1, m_str, len);
                ATLASSERT(res == len);
                if (res != len)
                {
                    ::SysFreeString(m_str);
                    m_str = NULL;
                }
            }
        }
        else
        {
            m_str = NULL;
        }
    }

CComBSTR() [6/7]

ATL::CComBSTR::CComBSTR ( const CComBSTR &  other )

inline

Definition at line 344 of file atlcomcli.h.

    {
        m_str = other.Copy();
    }

CComBSTR() [7/7]

ATL::CComBSTR::CComBSTR ( REFGUID  guid )

inline

Definition at line 349 of file atlcomcli.h.

    {
        OLECHAR szGuid[40];
        ::StringFromGUID2(guid, szGuid, 40);
        m_str = ::SysAllocString(szGuid);
    }

~CComBSTR()

ATL::CComBSTR::~CComBSTR ( )

inline

Definition at line 356 of file atlcomcli.h.

    {
        ::SysFreeString(m_str);
        m_str = NULL;
    }

Member Function Documentation

Attach()

void ATL::CComBSTR::Attach ( BSTR  bstr )

inline

Definition at line 379 of file atlcomcli.h.

    {
        ::SysFreeString(m_str);
        m_str = bstr;
    }

ByteLength()

unsigned int ATL::CComBSTR::ByteLength ( ) const

inline

Definition at line 423 of file atlcomcli.h.

    {
        return ::SysStringByteLen(m_str);
    }

Copy()

BSTR ATL::CComBSTR::Copy ( ) const

inline

Definition at line 392 of file atlcomcli.h.

    {
        if (!m_str)
            return NULL;
        return ::SysAllocStringLen(m_str, ::SysStringLen(m_str));
    }

Referenced by CopyTo().

CopyTo()

HRESULT ATL::CComBSTR::CopyTo ( BSTR *  other ) const

inline

Definition at line 399 of file atlcomcli.h.

    {
        if (!other)
            return E_POINTER;
        *other = Copy();
        return S_OK;
    }

Detach()

BSTR ATL::CComBSTR::Detach ( )

inline

Definition at line 385 of file atlcomcli.h.

    {
        BSTR str = m_str;
        m_str = NULL;
        return str;
    }

Length()

unsigned int ATL::CComBSTR::Length ( ) const

inline

Definition at line 418 of file atlcomcli.h.

    {
        return ::SysStringLen(m_str);
    }

LoadString()

bool ATL::CComBSTR::LoadString ( HMODULE  module, DWORD  uID  )

inline

Definition at line 407 of file atlcomcli.h.

    {
        ::SysFreeString(m_str);
        m_str = NULL;
        const wchar_t *ptr = NULL;
        int len = ::LoadStringW(module, uID, (PWSTR)&ptr, 0);
        if (len)
            m_str = ::SysAllocStringLen(ptr, len);
        return m_str != NULL;
    }

operator BSTR()

ATL::CComBSTR::operator BSTR ( ) const

inline

Definition at line 362 of file atlcomcli.h.

    {
        return m_str;
    }

operator&()

BSTR * ATL::CComBSTR::operator& ( )

inline

Definition at line 367 of file atlcomcli.h.

    {
        return &m_str;
    }

operator=()

CComBSTR & ATL::CComBSTR::operator= ( const CComBSTR &  other )

inline

Definition at line 372 of file atlcomcli.h.

    {
        ::SysFreeString(m_str);
        m_str = other.Copy();
        return *this;
    }

Member Data Documentation

m_str

BSTR ATL::CComBSTR::m_str

Definition at line 290 of file atlcomcli.h.

Referenced by Attach(), ByteLength(), CComBSTR(), Copy(), Detach(), CShellBrowser::FireNavigateComplete(), CFolderItemVerb::Init(), Length(), LoadString(), operator BSTR(), operator&(), operator=(), and ~CComBSTR().

---

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

• sdk/lib/atl/atlcomcli.h