DSIStmtProperties Class Reference

Holds the definition of all the statement properties that DSI supports. More...

List of all members.

Public Member Functions

const std::vector
< DSIStmtPropertyKey > & 
GetPropertyList () const
 Gets the property list.
bool MapDSIStmtPropKeyToDSIStmtPropLimitations (const DSIStmtPropertyKey in_dsiPropKey, DSIStmtPropertyLimitKeys &out_dsiPropLimitKeys)
 Maps the given DSI statement property key to the corresponding structure holding the DSI statement property keys for the properties describing the minimum and maximum values for that property.
bool MapStmtAttrKeyToDSIStmtPropKey (const SQLINTEGER in_odbcAttrKey, DSIStmtPropertyKey &out_dsiPropKey)
 Maps the given ODBC attribute key to the corresponding DSI statement property key.

Static Public Member Functions

static DSIStmtPropertiesGetInstance ()
 Singleton accessor.

Protected Member Functions

 DSIStmtProperties ()
 Constructor.

Detailed Description

Holds the definition of all the statement properties that DSI supports.

It also provides a mapping service between ODBC statement attribute keys and DSI statement property keys.


Constructor & Destructor Documentation

DSIStmtProperties (  )  [protected]

Constructor.


Member Function Documentation

static DSIStmtProperties* GetInstance (  )  [static]

Singleton accessor.

Returns:
DSIStmtProperties singleton. (NOT OWN)
const std::vector<DSIStmtPropertyKey>& GetPropertyList (  )  const

Gets the property list.

Returns:
Returns a references to the list of statement properties
bool MapDSIStmtPropKeyToDSIStmtPropLimitations ( const DSIStmtPropertyKey  in_dsiPropKey,
DSIStmtPropertyLimitKeys out_dsiPropLimitKeys 
)

Maps the given DSI statement property key to the corresponding structure holding the DSI statement property keys for the properties describing the minimum and maximum values for that property.

If successful, the corresponding DSIStmtPropertyLimitsKey struct is returned in out_dsiPropLimits.

Parameters:
in_dsiPropKey DSI statement property key
out_dsiPropLimitKeys Keys for DSI properties that describe limits for in_dsiPropKey returned here on success.
Returns:
True if mapping succeeds; false otherwise.
bool MapStmtAttrKeyToDSIStmtPropKey ( const SQLINTEGER  in_odbcAttrKey,
DSIStmtPropertyKey out_dsiPropKey 
)

Maps the given ODBC attribute key to the corresponding DSI statement property key.

If successful, the DSI key is returned in out_dsiPropKey.

Parameters:
in_odbcAttrKey ODBC statement attribute key
out_dsiPropKey DSI property key is output here on success.
Returns:
True if mapping succeeds; false otherwise.

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

Generated on Wed May 17 14:21:15 2017 for SimbaEngine 10.1.3.1011 by simba