SQL API Proprietary Functions

All the fuctions here are located in RDM SQL API Library. Linker option: More...

Collaboration diagram for SQL API Proprietary Functions:

Functions

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

Detailed Description

All the fuctions here are located in RDM SQL API Library. Linker option:

    -lrdmrdbc

.

Function Documentation

SQLDescribeStmt()

SQLRETURN SQLDescribeStmt ( SQLHSTMT StatementHandle,
SQLUSMALLINT * pStmtType
)

#include <sqlrext.h>

Obtain the type of the latest executed statement.

SQLExtendedTran()

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()

SQLRETURN SQLGetStatementType ( SQLHSTMT StatementHandle,
SQLUSMALLINT * pStmtType
)

#include <sqlrext.h>

Obtain the RDM SQL statement type.

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

SQLRowId()

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

#include <sqlrext.h>

Retrieve the ROWID value of the current row.

SQLSetError()

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()

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()

SQLRETURN SQLShowPlan ( SQLHSTMT StatementHandle,
SQLHSTMT QueryHandle
)

#include <sqlrext.h>

Return the command execution plan chosen by the query optimizer.

SQLTransactStatus()

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

#include <sqlrext.h>

Return the status of an ongoing transaction.