SQL API Proprietary Functions

Collaboration diagram for SQL API Proprietary Functions:

Functions
RDBC_EXPORT SQLRETURN	SQLDescribeStmt (SQLHSTMT StatementHandle, SQLUSMALLINT *pStmtType)
	Obtain the type of the latest executed statement. More...
RDBC_EXPORT SQLRETURN	SQLExtendedTran (SQLSMALLINT HandleType, SQLHANDLE Handle, SQLSMALLINT OperationType, SQLSMALLINT TransactionType, const SQLCHAR *TransactionID, SQLSMALLINT StringLengthPtr)
	Perform an RDM specific transaction (start, mark, etc.) More...
RDBC_EXPORT SQLRETURN	SQLGetStatementType (SQLHSTMT StatementHandle, SQLUSMALLINT *pStmtType)
	Obtain the RDM SQL statement type. More...
RDBC_EXPORT SQLRETURN	SQLRowId (SQLHSTMT StatementHandle, const SQLCHAR *TableName, SQLROWID *pRowid)
	Retrieve the ROWID value of the current row. More...
RDBC_EXPORT SQLRETURN	SQLSetError (SQLSMALLINT HandleType, SQLHANDLE Handle, SQLRETURN ErrorCode, ECALLBACK ErrorHandler)
	Set the user-defined error handling routine for the specified handle. More...
RDBC_EXPORT SQLRETURN	SQLSetErrorEx (SQLSMALLINT HandleType, SQLHANDLE Handle, SQLRETURN ErrorCode, ECALLBACK ErrorHandler, void *pCtx)
	Set the user-defined error handling routine for the specified handle. More...
RDBC_EXPORT SQLRETURN	SQLShowPlan (SQLHSTMT StatementHandle, SQLHSTMT QueryHandle)
	Return the command execution plan chosen by the query optimizer. More...
RDBC_EXPORT SQLRETURN	SQLTransactStatus (SQLSMALLINT HandleType, SQLHANDLE Handle, SQLSMALLINT *pActive)
	Return the status of an ongoing transaction. More...

Detailed Description

Function Documentation

SQLDescribeStmt()

RDBC_EXPORT SQLRETURN SQLDescribeStmt	(	SQLHSTMT	StatementHandle,
		SQLUSMALLINT *	pStmtType
	)

#include <sqlrext.h>

Obtain the type of the latest executed statement.

SQLExtendedTran()

RDBC_EXPORT SQLRETURN SQLExtendedTran	(	SQLSMALLINT	HandleType,
		SQLHANDLE	Handle,
		SQLSMALLINT	OperationType,
		SQLSMALLINT	TransactionType,
		const SQLCHAR *	TransactionID,
		SQLSMALLINT	StringLengthPtr
	)

#include <sqlrext.h>

Perform an RDM specific transaction (start, mark, etc.)

SQLGetStatementType()

RDBC_EXPORT SQLRETURN SQLGetStatementType	(	SQLHSTMT	StatementHandle,
		SQLUSMALLINT *	pStmtType
	)

#include <sqlrext.h>

Obtain the RDM SQL statement type.

Parameters

[in]	StatementHandle	SQL API statement handle
[out]	pStmtType	statement type (STMT_TYPE)

SQLRowId()

RDBC_EXPORT SQLRETURN SQLRowId	(	SQLHSTMT	StatementHandle,
		const SQLCHAR *	TableName,
		SQLROWID *	pRowid
	)

#include <sqlrext.h>

Retrieve the ROWID value of the current row.

SQLSetError()

RDBC_EXPORT SQLRETURN SQLSetError	(	SQLSMALLINT	HandleType,
		SQLHANDLE	Handle,
		SQLRETURN	ErrorCode,
		ECALLBACK	ErrorHandler
	)

#include <sqlrext.h>

Set the user-defined error handling routine for the specified handle.

SQLSetErrorEx()

RDBC_EXPORT SQLRETURN SQLSetErrorEx	(	SQLSMALLINT	HandleType,
		SQLHANDLE	Handle,
		SQLRETURN	ErrorCode,
		ECALLBACK	ErrorHandler,
		void *	pCtx
	)

#include <sqlrext.h>

Set the user-defined error handling routine for the specified handle.

SQLShowPlan()

RDBC_EXPORT SQLRETURN SQLShowPlan	(	SQLHSTMT	StatementHandle,
		SQLHSTMT	QueryHandle
	)

#include <sqlrext.h>

Return the command execution plan chosen by the query optimizer.

SQLTransactStatus()

RDBC_EXPORT SQLRETURN SQLTransactStatus	(	SQLSMALLINT	HandleType,
		SQLHANDLE	Handle,
		SQLSMALLINT *	pActive
	)

#include <sqlrext.h>

Return the status of an ongoing transaction.