Environment.h

Go to the documentation of this file.

/******************************************************************************
*
* Copyright Saab AB, 2005-2013 (http://safir.sourceforge.net)
*
* Created by: Jörgen Johansson / stjrjo
*
*******************************************************************************
*
* This file is part of Safir SDK Core.
*
* Safir SDK Core is free software: you can redistribute it and/or modify
* it under the terms of version 3 of the GNU General Public License as
* published by the Free Software Foundation.
*
* Safir SDK Core is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Safir SDK Core.  If not, see <http://www.gnu.org/licenses/>.
*
******************************************************************************/
#ifndef Safir_Databases_Environment_h
#define Safir_Databases_Environment_h

#include "Safir/Databases/Odbc/Defs.h"
#include "Safir/Databases/Odbc/Internal/InternalDefs.h"
#include <Safir/Dob/Typesystem/Defs.h>
#include <boost/noncopyable.hpp>

namespace Safir
{
namespace Databases
{
namespace Odbc
{

#ifdef _MSC_VER
#pragma warning(push)
#pragma warning(disable: 4275)
#endif

class OLIB_API Environment : private boost::noncopyable
{
public:
    Environment(void);

    ~Environment(void);

    void Alloc();

    void Free();

    void SetEnvAttr(long lAttribute, long lValue);

    void SetEnvAttr(long lAttribute, const std::wstring & wszValue, unsigned long ulLength);

    void GetEnvAttr(long lAttribute, long & lValue) const;

    void GetEnvAttr(long lAttribute, wchar_t * wszValue, unsigned long ulLength) const;

    bool GetDiagRec(short sRecNumber,
                    std::wstring & SqlState,
                    boost::int32_t & NativeError,
                    std::wstring & MessageText,
                    bool & bDataRead) const;

    bool IsValid() const;

    SQLHENV Handle() const;
private:
    SQLHENV m_hEnv;
    bool bSetOdbcVersion;

    void ThrowReconnectException(   const std::wstring & fileName,
                                    const Safir::Dob::Typesystem::Int64 lineNumber) const;
    void ThrowReconnectException(   SQLHENV hEnv,
                                    const std::wstring & fileName,
                                    const Safir::Dob::Typesystem::Int64 lineNumber) const;
};

#ifdef _MSC_VER
#pragma warning(pop)
#endif

inline
bool Environment::IsValid() const
{
    return m_hEnv != SQL_NULL_HENV;
}

inline
SQLHENV Environment::Handle() const
{
    return m_hEnv;
}

} // End namespace Odbc

} // End namespace Databases

} // End namespace Safir

#endif // Safir_Databases_Environment_h