sptk::CParam Class Reference
[Database Support]

SQL query parameter. More...

#include <CParams.h>

Inheritance diagram for sptk::CParam:

List of all members.

Public Member Functions
void	bindClear ()
	Clears internal parameter binding index.
void	bindAdd (uint32_t bindIndex)
	Adds internal parameter binding index.
uint32_t	bindCount ()
	Returns internal parameter binding count.
uint32_t	bindIndex (uint32_t ind)
	Returns the parameter bing position by index in the binding list.
char *	conversionBuffer ()
int32_t &	callbackLength ()
	An integer reserved to callback parameter data length.
	CParam (char *name)
	~CParam ()
	Destructor.
std::string	name () const
	Returns parameter name.
CParam &	operator= (const CParam &param)
	Assign operator.
CParam &	operator= (const CVariant &param)
	Assign operator.
CParam &	operator= (int16_t v)
	Assign operator.
CParam &	operator= (uint16_t v)
	Assign operator.
CParam &	operator= (int32_t v)
	Assign operator.
CParam &	operator= (uint32_t v)
	Assign operator.
CParam &	operator= (int64_t v)
	Assign operator.
CParam &	operator= (uint64_t v)
	Assign operator.
CParam &	operator= (float v)
	Assign operator.
CParam &	operator= (double v)
	Assign operator.
CParam &	operator= (const char *s)
	Assign operator.
CParam &	operator= (const std::string &s)
	Assign operator.
CParam &	operator= (CDateTime dt)
	Assign operator.
virtual CParam &	operator= (const void *value)
	Assignment operator.
CParam &	operator= (const CBuffer &buffer)
	Assign operator.
std::string	asXML () const
	Returns parameter info as XML.
virtual void	setString (const char *value, uint32_t maxlen=0)
	String assignment method.
virtual void	setString (const std::string &value)
	String assignment method.
Public Attributes
CParamBinding	m_binding
	The last successfull binding information.
Protected Attributes
std::string	m_name
	Parameter name.
CIntList	m_bindParamIndexes
	The list of SQL query parameter numbers with this name.
char *	m_timeData
	Special memory allocated for time structures.
int32_t	m_callbackLength
	An integer reserved to callback parameter data length.
Friends
class	CQuery
class	CParamList

---

Detailed Description

SQL query parameter.

Simplifies the ODBC parameter binding. Automatically handles most of the data conversions on assignments.

---

Constructor & Destructor Documentation

sptk::CParam::CParam

(

char *

name

)

Constructor

Parameters:

name

char *, parameter name

---

Member Function Documentation

char* sptk::CParam::conversionBuffer

(

)

[inline]

Returns the internal small conversion buffer used to convert the date structure to SPTK. Please, don't use it.

virtual void sptk::CParam::setString

(

const std::string &

value

)

[inline, virtual]

String assignment method.

In contrast to CVariant::setString() method, this method tries not to decrease the allocated buffer.

Parameters:

value

const string&, string to assign

Reimplemented from sptk::CVariant.

virtual void sptk::CParam::setString	(	const char *	value,
		uint32_t	maxlen = 0
	)			[virtual]

String assignment method.

In contrast to CVariant::setString() method, this method tries not to decrease the allocated buffer.

Parameters:

	value	const char*, string to assign
	maxlen	uint32_t, maximum length of the assigned string

Reimplemented from sptk::CVariant.

---

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

• CParams.h