msclr::interop Namespace Reference

Namespaces
	details

Classes
class	context_node
class	context_node< BSTR, System::String^>
class	context_node< const char *, System::String^>
class	context_node< const wchar_t *, System::String^>
class	context_node_base
class	error_reporting_helper
class	error_reporting_helper< _To_Type, _From_Type, false >
class	error_reporting_helper< _To_Type, _From_Type, true >
class	marshal_context

Functions
template<class _To_Type >
_To_Type	marshal_as (_In_z_ const char _from_object[])
template<class _To_Type >
_To_Type	marshal_as (_In_z_ const wchar_t _from_object[])
template<class _To_Type , class _From_Type >
_To_Type	marshal_as (const _From_Type &)
template<>
System::String	marshal_as (_In_z_ const char *const &_from_object)
template<>
System::String	marshal_as (_In_z_ char *const &_from_object)
template<>
System::String	marshal_as (_In_z_ const wchar_t *const &_from_object)
template<>
System::String	marshal_as (_In_z_ wchar_t *const &_from_object)
template<>
System::String	marshal_as (const CComBSTR &_from_object)
template<>
CComBSTR	marshal_as (System::String^const &_from_object)
template<>
System::String	marshal_as (const CStringA &_from_obj)
template<>
System::String	marshal_as (const CStringW &_from_obj)
template<>
CStringA	marshal_as (System::String^const &_from_obj)
template<>
CStringW	marshal_as (System::String^const &_from_obj)
template<>
System::String	marshal_as (const std::string &_from_obj)
template<>
std::string	marshal_as (System::String^const &_from_obj)
template<>
System::String	marshal_as (const std::wstring &_from_obj)
template<>
std::wstring	marshal_as (System::String^const &_from_obj)
template<>
System::String	marshal_as (const _bstr_t &_from_object)
template<>
_bstr_t	marshal_as (System::String^const &_from_object)
template<>
System::IntPtr	marshal_as (const HANDLE &_from_object)
template<class _To_Type >
_To_Type	marshal_as (System::IntPtr _from_object)
template<>
HANDLE	marshal_as (System::IntPtr _from_object)

Function Documentation

template<>

System::String msclr::interop::marshal_as ( const std::string &  _from_obj )

inline

{
        return details::InternalAnsiToStringHelper(_from_obj.c_str(), _from_obj.length());
}

template<>

System::String msclr::interop::marshal_as ( const CComBSTR &  _from_object )

inline

{
        if (_from_object.m_str == NULL)
        {
                return nullptr;
        }
        // Using PtrToStringBSTR here instead of marshal_as<String^, BSTR>() because we want to perserve the embedded NULLs
        return System::Runtime::InteropServices::Marshal::PtrToStringBSTR(System::IntPtr(_from_object.m_str));
}

template<>

System::String msclr::interop::marshal_as ( const _bstr_t &  _from_object )

inline

{
        BSTR _bstr = _from_object.copy(false);
        if (_bstr == NULL)
        {
                return nullptr;
        }
        // Using PtrToStringBSTR here instead of marshal_as<String^, BSTR>() because we want to perserve the embedded NULLs
        return System::Runtime::InteropServices::Marshal::PtrToStringBSTR(System::IntPtr(_bstr));
}

template<>

std::string msclr::interop::marshal_as ( System::String^const &  _from_obj )

inline

{
        if (_from_obj == nullptr)
        {
                throw gcnew System::ArgumentNullException(_EXCEPTION_NULLPTR);
        }
        std::string _to_obj;
        size_t _size = details::GetAnsiStringSize(_from_obj);

        if (_size > 1)
        {
                // -1 because resize will automatically +1 for the NULL
                _to_obj.resize(_size-1);
                char *_dest_buf = &(_to_obj[0]);

                details::WriteAnsiString(_dest_buf, _size, _from_obj);
        }

        return _to_obj;
}

template<>

CComBSTR msclr::interop::marshal_as ( System::String^const &  _from_object )

inline

{
        if (_from_object == nullptr)
        {
                return CComBSTR(static_cast<const wchar_t*>(NULL));
        }
        if(_from_object->Length == 0)
        {
                return CComBSTR(static_cast<const wchar_t*>(L""));
        }

        cli::pin_ptr<const wchar_t> _pinned_ptr = PtrToStringChars(_from_object);
        return  CComBSTR( _from_object->Length, static_cast<const wchar_t *>(_pinned_ptr));
}

template<>

_bstr_t msclr::interop::marshal_as ( System::String^const &  _from_object )

inline

{
        if (_from_object == nullptr)
        {
                return _bstr_t(static_cast<BSTR>(NULL));
        }

        _bstr_t _ret_bstr_t;
        cli::pin_ptr<const wchar_t> _pinned_ptr = PtrToStringChars(_from_object);
        _ret_bstr_t.Attach(::SysAllocStringLen(_pinned_ptr, _from_object->Length));
        if (!_ret_bstr_t)
        {
                throw gcnew System::InsufficientMemoryException();
        }
        return _ret_bstr_t;
}

template<>

System::String msclr::interop::marshal_as ( const std::wstring &  _from_obj )

inline

{
        return details::InternalUnicodeToStringHelper(_from_obj.c_str(), _from_obj.length());
}

template<>

System::String msclr::interop::marshal_as ( const CStringA &  _from_obj )

inline

{
        return details::InternalAnsiToStringHelper(_from_obj.operator LPCSTR(), _from_obj.GetLength());
}

template<>

std::wstring msclr::interop::marshal_as ( System::String^const &  _from_obj )

inline

{
        if(_from_obj != nullptr)
        {
                cli::pin_ptr<const wchar_t> _pinned_ptr = PtrToStringChars(_from_obj);
                std::wstring _to_obj(static_cast<const wchar_t *>(_pinned_ptr), _from_obj->Length);

                return _to_obj;
        }
        else
        {
                throw gcnew System::ArgumentNullException(_EXCEPTION_NULLPTR);
        }
}

template<>

System::String msclr::interop::marshal_as ( const CStringW &  _from_obj )

inline

{
        // this will perserve the embedded nulls
        return details::InternalUnicodeToStringHelper(_from_obj.operator LPCWSTR(), _from_obj.GetLength());
}

template<>

System::IntPtr msclr::interop::marshal_as ( const HANDLE &  _from_object )

inline

{
        return System::IntPtr(_from_object);
}

template<class _To_Type >

_To_Type msclr::interop::marshal_as ( System::IntPtr  _from_object )

inline

{
        return static_cast<HANDLE>(_from_object.ToPointer());
}

template<>

CStringA msclr::interop::marshal_as ( System::String^const &  _from_obj )

inline

{
        if (_from_obj == nullptr)
        {
                throw gcnew System::ArgumentNullException(_EXCEPTION_NULLPTR);
        }
        CStringA _to_obj;
        size_t _size = details::GetAnsiStringSize(_from_obj);

        //checking for overflow
        if (_size > INT_MAX)
        {
                throw gcnew System::ArgumentOutOfRangeException(_EXCEPTION_NULLPTR);
        }

        int _length = static_cast<int>(_size)-1;

        //GetBuffer() throws, so we don't need to check for NULL
        char* _dest_buf = _to_obj.GetBuffer(_length);

        details::WriteAnsiString(_dest_buf, _size, _from_obj);
        _to_obj.ReleaseBuffer(_length); // We don't want to include the NULL.  This call will set the length to _length

        return _to_obj;
}

template<>

HANDLE msclr::interop::marshal_as ( System::IntPtr  _from_object )

inline

{
        return static_cast<HANDLE>(_from_object.ToPointer());
}

template<>

CStringW msclr::interop::marshal_as ( System::String^const &  _from_obj )

inline

{
        if (_from_obj == nullptr)
        {
                throw gcnew System::ArgumentNullException(_EXCEPTION_NULLPTR);
        }
        cli::pin_ptr<const wchar_t> _pinned_ptr = PtrToStringChars(_from_obj);
        return CStringW(static_cast<const wchar_t *>(_pinned_ptr), _from_obj->Length);
}

template<class _To_Type >

_To_Type msclr::interop::marshal_as ( _In_z_ const char  _from_object[] )

inline

{
        const char* _ptr = _from_object;
        return marshal_as<_To_Type, const char *>(_ptr);
}

template<class _To_Type >

_To_Type msclr::interop::marshal_as ( _In_z_ const wchar_t  _from_object[] )

inline

{
        const wchar_t* _ptr = _from_object;
        return marshal_as<_To_Type, const wchar_t*>(_ptr);
}

template<class _To_Type , class _From_Type >

_To_Type msclr::interop::marshal_as ( const _From_Type &  _from_object )

inline

{
        return error_reporting_helper<_To_Type, _From_Type>::marshal_as(_from_object);
}

template<>

System::String msclr::interop::marshal_as ( _In_z_ const char *const &  _from_object )

inline

{
        if (!_from_object)
        {
                return nullptr;
        }
        return details::InternalAnsiToStringHelper(_from_object, strlen(_from_object));
}

template<>

System::String msclr::interop::marshal_as ( _In_z_ char *const &  _from_object )

inline

{
        return marshal_as<System::String^, const char *>(_from_object);
}

template<>

System::String msclr::interop::marshal_as ( _In_z_ const wchar_t *const &  _from_object )

inline

{
        if (_from_object == NULL)
        {
                return nullptr;
        }
        return gcnew System::String(_from_object);
}

template<>

System::String msclr::interop::marshal_as ( _In_z_ wchar_t *const &  _from_object )

inline

{
        return marshal_as<System::String^, const wchar_t *>(_from_object);
}