DBPowerSuite 7.9 Application Programming Interface
ODBC

#

Inline

Pure Virtual

Virtual

Method

Description

1

OStatement(OConnection& o_conn)

Constructor

2

ps_int32 osCancel()

Cancel a Currently Executing Statement

3

ps_int32 osClearBindings(ps_int8 keep_pending_results_in_tact_sw = 0)

Clear ODBC Parameter and Column Bindings

4

ps_int32 osCommitTransaction()

Commit a Transaction

5

ps_int32 osError(ps_int32 odbc_return_code)

Write Errors on the ODBC Statement and Translate the ODBC Return Code to a DBPowerSuite Return Code

6

ps_int32 osErrorLoop(ps_int32 message_code)

Write All ODBC Messages Pending on an ODBC Statement

7

ps_int32 osExecute(ps_int32* number_of_rows = NULL)

Execute an Adhoc SQL Statement

8

ps_int32 osExecute(OParameter column[], ps_int32 number_of_columns, ps_int32* number_of_rows = NULL)

Execute an Adhoc SQL Statement

9

ps_int32 osExecute(OParameter parameter[], ps_int32 number_of_parameters, OParameter column[], ps_int32 number_of_columns, ps_int32* number_of_rows = NULL)

Execute an Adhoc SQL Statement

10

ps_int32 osExecutePreparedSQL(ps_int32* number_of_rows = NULL)

Execute a Prepared SQL Statement

11

ps_int32 osExecutePreparedSQL(OParameter column[], ps_int32 number_of_columns, ps_int32* number_of_rows = NULL)

Execute a Prepared SQL Statement

12

ps_int32 osExecutePreparedSQL(OParameter parameter[], ps_int32 number_of_parameters, OParameter column[], ps_int32 number_of_columns, ps_int32* number_of_rows = NULL)

Execute a Prepared SQL Statement

13

ps_int32 osExecuteSQL(const ps_char* sql, ps_int32* number_of_rows = NULL)

Execute a SQL Statement

14

ps_int32 osExecuteSQL(const ps_char* sql, OParameter column[], ps_int32 number_of_columns, ps_int32* number_of_rows = NULL)

Execute a SQL Statement

15

ps_int32 osExecuteSQL(const ps_char* sql, OParameter parameter[], ps_int32 number_of_parameters, OParameter column[], ps_int32 number_of_columns, ps_int32* number_of_rows = NULL)

Execute a SQL Statement

16

ps_int32 osFinalize()

Finalize an OStatement

17

ps_int8 osGetCancelSw() const

Get the Cancel Switch

18

OConnection & osGetConnection() const

19

HDBC osGetConnectionHandle() const

20

ps_int8 osGetDeadlockVictimSw() const

Get the Deadlock Victim Switch

21

ps_int32 osGetDeadlockWaitTimeBetweenRetries() const

22

ps_int8 osGetDiscardResultsSw() const

23

OEnvironment & osGetEnvironment() const

24

HENV osGetEnvironmentHandle() const

25

ps_int32 osGetMaximumRowsPerSet() const

26

Messages * osGetMessages() const

27

ps_int32 osGetNumberOfDeadlockRetries() const

28

ps_int32 osGetNumberOfODBCErrors() const

29

ps_int32 osGetNumberOfParameterSets() const

30

ps_int32 osGetSQLState(ps_char* sql_state) const

Get the SQLState for the OStatement

31

ps_int8 osGetSQLStateSw(const ps_char* sql_state) const

Get SQL State Switch

32

HSTMT osGetStatementHandle() const

33

ps_int32 osGetStatementType() const

34

ps_int32 osGetStructureSizeForParameterRowWiseBinding() const

35

ps_int32 osGetStructureSizeForRowWiseBinding() const

36

ps_int8 osGetUseTimeoutsSw() const

37

ps_int32 osInitialize()

Allocate a ODBC Statement

38

ps_int32 osInitialize(HSTMT hstmt)

Allocate a ODBC Statement

39

ps_int8 osIsStatementAllocatedSw() const

40

ps_int32 osPrepareSQL(const ps_char* sql)

Prepare a Statement

41

ps_int32 osRollbackTransaction()

Rollback a Transaction

42

ps_int32 osSetAlwaysClearBindingsSw(ps_int8 sw = 1)

Turn Off/On Always Clear Bindings

43

ps_int32 osSetColumnDescriptionsCallback(OColumnDescriptionsCallback fptr, ODBC_COLUMN* column_descriptions, ps_int32 max_number_of_column_descriptions)

Set the Column Descriptions Callback Method

44

ps_int32 osSetColumns(ps_int32 number_of_columns = 0, OParameter column[] = NULL)

Assign Each Result Row Set Column to an OParameter

45

ps_int32 osSetDeadlockCallback(ODeadlockCallback fptr)

Set the Method Which is Executed Every Time a Deadlock Condition is Received From the ODBC Data Source

46

ps_int32 osSetDeadlockWaitTimeBetweenRetries(ps_int32 number_of_microseconds = ODBC_OSTMT_DEADLOCK_WAIT_TIME)

Set Wait Time Before Resending a SQL Command After Deadlocked

47

ps_int32 osSetDiscardResultsSw(ps_int8 sw = 1)

Turn On/Off Discarding of Results

48

ps_int32 osSetMaximumRowsPerSet(ps_int32 max_rows_in_a_set = 1, ps_uint16* row_status_array = NULL)

Set the Maximums Rows Per Set

49

ps_int32 osSetNumberOfDeadlockRetries(ps_int32 number_of_retries = ODBC_OSTMT_DEADLOCK_RETRIES)

Set the Number of Times This Class Resends a SQL Command Upon Receiving a Deadlock Victim Error

50

ps_int32 osSetNumberOfParameterSets(ps_int32 max_rows_in_a_set = 1)

Set the Number of Parameter Sets

51

ps_int32 osSetParameters(ps_int32 number_of_parameters = 0, OParameter parameter[] = NULL)

Set the Parameters for a SQL Query

52

ps_int32 osSetQueryTimeout(ps_int32 timeout_seconds = ODBC_OSTMT_QUERY_TIMEOUT)

Set the Timeout for a SQL Statement to Execute

53

ps_int32 osSetRowCallback(ORowCallback fptr, ps_void* row_results_list_struct = NULL, ps_void* single_row_result_struct = NULL)

Set the Method Which is Executed Every Time a Row is Received From the ODBC Data Source

54

ps_int32 osSetRowsAffectedCallback(ORowsAffectedCallback fptr, ps_void* user_data = NULL)

Set the Method Called Every Time the ODBC Data Source Finishes Sending a Result Set

55

ps_int32 osSetSQLState(const ps_char* sql_state = NULL)

Set the SQLState for the OStatement

56

ps_int32 osSetSQLStatement(const ps_char* sql)

Set the SQL Query

57

ps_int32 osSetStructureSizeForParameterRowWiseBinding(ps_int32 structure_size_in_bytes = 0)

Set Structure Size for Parameter Row-Wise Binding

58

ps_int32 osSetStructureSizeForRowWiseBinding(ps_int32 structure_size_in_bytes = 0)

Set Structure Size for Row-Wise Binding

59

~OStatement()

Destructor