SQL functions
RedshiftCreateConnection
Declaration
RedshiftConnection RedshiftCreateConnection(string connectionString)
Description
Creates a connection to an Amazon Redshift database.
Supported Runtime Versions
2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
connectionString
|
A connection string specifying the connection to be created. |
Return Value
A connection to the database specified in the connection string.
RedshiftDisconnect
Declaration
void RedshiftDisconnect(RedshiftConnection connection)
Description
Disconnects a Redshift database connection.
Supported Runtime Versions
2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
connection
|
Database connection to be disconnected. |
Return Value
Does not return a value.
RedshiftExecuteNonQuery
Declaration
int RedshiftExecuteNonQuery(RedshiftConnection connection, string statement)
Description
Executes a non-query SQL statement on a Redshift connection.
Supported Runtime Versions
2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
connection
|
Database connection to be used for executing the query. |
statement
|
Statement to be executed. |
Return Value
The number of affected rows.
RedshiftExecuteNonQuery
Declaration
int RedshiftExecuteNonQuery(RedshiftConnection connection, string statement, int commandTimeout, string commandType)
Description
Executes a non-query SQL statement on a Redshift connection.
Supported Runtime Versions
4.0, 5.0
Parameters
|
Description |
|---|---|
connection
|
Database connection to be used for executing the query. |
statement
|
Statement to be executed. |
commandTimeout
|
Timeout (in seconds). Set to 0 to wait indefinitely. |
commandType
|
Can be StoredProcedure, TableDirect, or Text. |
Return Value
The number of affected rows.
RedshiftExecuteQuery
Declaration
SQLData RedshiftExecuteQuery(RedshiftConnection connection, string statement)
Description
Executes a query on a Redshift database.
Supported Runtime Versions
2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
connection
|
Database connection to be used for executing the query. |
statement
|
Statement to be executed. |
Return Value
The result of the database query.
RedshiftExecuteQuery
Declaration
SQLData RedshiftExecuteQuery(RedshiftConnection connection, string statement, int commandTimeout)
Description
Executes a query on a Redshift database.
Supported Runtime Versions
4.0, 5.0
Parameters
|
Description |
|---|---|
connection
|
Database connection to be used for executing the query. |
statement
|
Statement to be executed. |
commandTimeout
|
Timeout (in seconds). Set to 0 to wait indefinitely. |
Return Value
The result of the database query.
SQLBindBooleanInputOutputParameter
Declaration
void SQLBindBooleanInputOutputParameter(SQLPreparedCommand command, string name, bool value)
Description
Binds a Boolean input/output parameter to a prepared command.
Supported Runtime Versions
5.0
Parameters
|
Description |
|---|---|
command
|
Prepared command to bind parameter to. |
name
|
Name of the parameter to be bound. |
value
|
The parameter's value. |
Return Value
Does not return a value.
SQLBindBooleanInputOutputParameter
Declaration
void SQLBindBooleanInputOutputParameter(SQLPreparedCommand command, string name, bool value, int size)
Description
Binds a Boolean input/output parameter to a prepared command.
Supported Runtime Versions
5.0
Parameters
|
Description |
|---|---|
command
|
Prepared command to bind parameter to. |
name
|
Name of the parameter to be bound. |
value
|
The parameter's value. |
size
|
The parameter's size. |
Return Value
Does not return a value.
SQLBindBooleanOutputParameter
Declaration
void SQLBindBooleanOutputParameter(SQLPreparedCommand command, string name)
Description
Binds a Boolean output parameter to a prepared command.
Supported Runtime Versions
5.0
Parameters
|
Description |
|---|---|
command
|
Prepared command to bind parameter to. |
name
|
Name of the parameter to be bound. |
Return Value
Does not return a value.
SQLBindBooleanOutputParameter
Declaration
void SQLBindBooleanOutputParameter(SQLPreparedCommand command, string name, int size)
Description
Binds a Boolean output parameter to a prepared command.
Supported Runtime Versions
5.0
Parameters
|
Description |
|---|---|
command
|
Prepared command to bind parameter to. |
name
|
Name of the parameter to be bound. |
size
|
The parameter's size. |
Return Value
Does not return a value.
SQLBindBooleanParameter
Declaration
void SQLBindBooleanParameter(SQLPreparedCommand command, string name, bool value)
Description
Binds a Boolean parameter to a prepared command.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
command
|
Prepared command to bind parameter to. |
name
|
Name of the parameter to be bound. |
value
|
The parameter's value. |
Return Value
Does not return a value.
SQLBindBooleanParameter
Declaration
void SQLBindBooleanParameter(SQLPreparedCommand command, string name, bool value, int size)
Description
Binds a Boolean parameter to a prepared command.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
command
|
Prepared command to bind parameter to. |
name
|
Name of the parameter to be bound. |
value
|
The parameter's value. |
size
|
The parameter's size. |
Return Value
Does not return a value.
SQLBindBooleanReturnValue
Declaration
void SQLBindBooleanReturnValue(SQLPreparedCommand command, string name)
Description
Binds a boolean return value to the prepared command.
Supported Runtime Versions
5.0
Parameters
|
Description |
|---|---|
command
|
Prepared command to bind return value to. |
name
|
Name of the return value. |
Return Value
Does not return a value.
SQLBindDateTimeInputOutputParameter
Declaration
void SQLBindDateTimeInputOutputParameter(SQLPreparedCommand command, string name, DateTime value)
Description
Binds a DateTime input/output parameter to a prepared command.
Supported Runtime Versions
5.0
Parameters
|
Description |
|---|---|
command
|
Prepared command to bind parameter to. |
name
|
Name of the parameter to be bound. |
value
|
The parameter's value. |
Return Value
Does not return a value.
SQLBindDateTimeInputOutputParameter
Declaration
void SQLBindDateTimeInputOutputParameter(SQLPreparedCommand command, string name, DateTime value, int size)
Description
Binds a DateTime input/output parameter to a prepared command.
Supported Runtime Versions
5.0
Parameters
|
Description |
|---|---|
command
|
Prepared command to bind parameter to. |
name
|
Name of the parameter to be bound. |
value
|
The parameter's value. |
size
|
The parameter's size. |
Return Value
Does not return a value.
SQLBindDateTimeOutputParameter
Declaration
void SQLBindDateTimeOutputParameter(SQLPreparedCommand command, string name)
Description
Binds a DateTime output parameter to a prepared command.
Supported Runtime Versions
5.0
Parameters
|
Description |
|---|---|
command
|
Prepared command to bind parameter to. |
name
|
Name of the parameter to be bound. |
Return Value
Does not return a value.
SQLBindDateTimeOutputParameter
Declaration
void SQLBindDateTimeOutputParameter(SQLPreparedCommand command, string name, int size)
Description
Binds a DateTime output parameter to a prepared command.
Supported Runtime Versions
5.0
Parameters
|
Description |
|---|---|
command
|
Prepared command to bind parameter to. |
name
|
Name of the parameter to be bound. |
size
|
The parameter's size. |
Return Value
Does not return a value.
SQLBindDateTimeParameter
Declaration
void SQLBindDateTimeParameter(SQLPreparedCommand command, string name, DateTime value)
Description
Binds a DateTime parameter to a prepared command.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
command
|
Prepared command to bind parameter to. |
name
|
Name of the parameter to be bound. |
value
|
The parameter's value. |
Return Value
Does not return a value.
SQLBindDateTimeParameter
Declaration
void SQLBindDateTimeParameter(SQLPreparedCommand command, string name, DateTime value, int size)
Description
Binds a DateTime parameter to a prepared command.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
command
|
Prepared command to bind parameter to. |
name
|
Name of the parameter to be bound. |
value
|
The parameter's value. |
size
|
The parameter's size. |
Return Value
Does not return a value.
SQLBindDateTimeReturnValue
Declaration
void SQLBindDateTimeReturnValue(SQLPreparedCommand command, string name)
Description
Binds a DateTime return value to the prepared command.
Supported Runtime Versions
5.0
Parameters
|
Description |
|---|---|
command
|
Prepared command to bind return value to. |
name
|
Name of the return value. |
Return Value
Does not return a value.
SQLBindDoubleInputOutputParameter
Declaration
void SQLBindDoubleInputOutputParameter(SQLPreparedCommand command, string name, double value)
Description
Binds a double input/output parameter to a prepared command.
Supported Runtime Versions
5.0
Parameters
|
Description |
|---|---|
command
|
Prepared command to bind parameter to. |
name
|
Name of the parameter to be bound. |
value
|
The parameter's value. |
Return Value
Does not return a value.
SQLBindDoubleInputOutputParameter
Declaration
void SQLBindDoubleInputOutputParameter(SQLPreparedCommand command, string name, double value, int size)
Description
Binds a double input/output parameter to a prepared command.
Supported Runtime Versions
5.0
Parameters
|
Description |
|---|---|
command
|
Prepared command to bind parameter to. |
name
|
Name of the parameter to be bound. |
value
|
The parameter's value. |
size
|
The parameter's size. |
Return Value
Does not return a value.
SQLBindDoubleOutputParameter
Declaration
void SQLBindDoubleOutputParameter(SQLPreparedCommand command, string name)
Description
Binds a double output parameter to a prepared command.
Supported Runtime Versions
5.0
Parameters
|
Description |
|---|---|
command
|
Prepared command to bind parameter to. |
name
|
Name of the parameter to be bound. |
Return Value
Does not return a value.
SQLBindDoubleOutputParameter
Declaration
void SQLBindDoubleOutputParameter(SQLPreparedCommand command, string name, int size)
Description
Binds a double output parameter to a prepared command.
Supported Runtime Versions
5.0
Parameters
|
Description |
|---|---|
command
|
Prepared command to bind parameter to. |
name
|
Name of the parameter to be bound. |
size
|
The parameter's size. |
Return Value
Does not return a value.
SQLBindDoubleParameter
Declaration
void SQLBindDoubleParameter(SQLPreparedCommand command, string name, double value)
Description
Binds a double parameter to a prepared command.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
command
|
Prepared command to bind parameter to. |
name
|
Name of the parameter to be bound. |
value
|
The parameter's value. |
Return Value
Does not return a value.
SQLBindDoubleParameter
Declaration
void SQLBindDoubleParameter(SQLPreparedCommand command, string name, double value, int size)
Description
Binds a double parameter to a prepared command.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
command
|
Prepared command to bind parameter to. |
name
|
Name of the parameter to be bound. |
value
|
The parameter's value. |
size
|
The parameter's size. |
Return Value
Does not return a value.
SQLBindDoubleReturnValue
Declaration
void SQLBindDoubleReturnValue(SQLPreparedCommand command, string name)
Description
Binds a double return value to the prepared command.
Supported Runtime Versions
5.0
Parameters
|
Description |
|---|---|
command
|
Prepared command to bind return value to. |
name
|
Name of the return value. |
Return Value
Does not return a value.
SQLBindIntegerInputOutputParameter
Declaration
void SQLBindIntegerInputOutputParameter(SQLPreparedCommand command, string name, int value)
Description
Binds an integer input/output parameter to a prepared command.
Supported Runtime Versions
5.0
Parameters
|
Description |
|---|---|
command
|
Prepared command to bind parameter to. |
name
|
Name of the parameter to be bound. |
value
|
The parameter's value. |
Return Value
Does not return a value.
SQLBindIntegerInputOutputParameter
Declaration
void SQLBindIntegerInputOutputParameter(SQLPreparedCommand command, string name, int value, int size)
Description
Binds an integer input/output parameter to a prepared command.
Supported Runtime Versions
5.0
Parameters
|
Description |
|---|---|
command
|
Prepared command to bind parameter to. |
name
|
Name of the parameter to be bound. |
value
|
The parameter's value. |
size
|
The parameter's size. |
Return Value
Does not return a value.
SQLBindIntegerOutputParameter
Declaration
void SQLBindIntegerOutputParameter(SQLPreparedCommand command, string name)
Description
Binds an integer output parameter to a prepared command.
Supported Runtime Versions
5.0
Parameters
|
Description |
|---|---|
command
|
Prepared command to bind parameter to. |
name
|
Name of the parameter to be bound. |
Return Value
Does not return a value.
SQLBindIntegerOutputParameter
Declaration
void SQLBindIntegerOutputParameter(SQLPreparedCommand command, string name, int size)
Description
Binds an integer output parameter to a prepared command.
Supported Runtime Versions
5.0
Parameters
|
Description |
|---|---|
command
|
Prepared command to bind parameter to. |
name
|
Name of the parameter to be bound. |
size
|
The parameter's size. |
Return Value
Does not return a value.
SQLBindIntegerParameter
Declaration
void SQLBindIntegerParameter(SQLPreparedCommand command, string name, int value)
Description
Binds an integer parameter to a prepared command.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
command
|
Prepared command to bind parameter to. |
name
|
Name of the parameter to be bound. |
value
|
The parameter's value. |
Return Value
Does not return a value.
SQLBindIntegerParameter
Declaration
void SQLBindIntegerParameter(SQLPreparedCommand command, string name, int value, int size)
Description
Binds an integer parameter to a prepared command.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
command
|
Prepared command to bind parameter to. |
name
|
Name of the parameter to be bound. |
value
|
The parameter's value. |
size
|
The parameter's size. |
Return Value
Does not return a value.
SQLBindIntegerReturnValue
Declaration
void SQLBindIntegerReturnValue(SQLPreparedCommand command, string name)
Description
Binds an integer return value to the prepared command.
Supported Runtime Versions
5.0
Parameters
|
Description |
|---|---|
command
|
Prepared command to bind return value to. |
name
|
Name of the return value. |
Return Value
Does not return a value.
SQLBindStringInputOutputParameter
Declaration
void SQLBindStringInputOutputParameter(SQLPreparedCommand command, string name, string value)
Description
Binds a string input/output parameter to a prepared command.
Supported Runtime Versions
5.0
Parameters
|
Description |
|---|---|
command
|
Prepared command to bind parameter to. |
name
|
Name of the parameter to be bound. |
value
|
The parameter's value. |
Return Value
Does not return a value.
SQLBindStringInputOutputParameter
Declaration
void SQLBindStringInputOutputParameter(SQLPreparedCommand command, string name, string value, int size)
Description
Binds a string input/output parameter to a prepared command.
Supported Runtime Versions
5.0
Parameters
|
Description |
|---|---|
command
|
Prepared command to bind parameter to. |
name
|
Name of the parameter to be bound. |
value
|
The parameter's value. |
size
|
The parameter's size. |
Return Value
Does not return a value.
SQLBindStringOutputParameter
Declaration
void SQLBindStringOutputParameter(SQLPreparedCommand command, string name)
Description
Binds a string output parameter to a prepared command.
Supported Runtime Versions
5.0
Parameters
|
Description |
|---|---|
command
|
Prepared command to bind parameter to. |
name
|
Name of the parameter to be bound. |
Return Value
Does not return a value.
SQLBindStringOutputParameter
Declaration
void SQLBindStringOutputParameter(SQLPreparedCommand command, string name, int size)
Description
Binds a string output parameter to a prepared command.
Supported Runtime Versions
5.0
Parameters
|
Description |
|---|---|
command
|
Prepared command to bind parameter to. |
name
|
Name of the parameter to be bound. |
size
|
The parameter's size. |
Return Value
Does not return a value.
SQLBindStringParameter
Declaration
void SQLBindStringParameter(SQLPreparedCommand command, string name, string value)
Description
Binds a string parameter to a prepared command.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
command
|
Prepared command to bind parameter to. |
name
|
Name of the parameter to be bound. |
value
|
The parameter's value. |
Return Value
Does not return a value.
SQLBindStringParameter
Declaration
void SQLBindStringParameter(SQLPreparedCommand command, string name, string value, int size)
Description
Binds a string parameter to a prepared command.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
command
|
Prepared command to bind parameter to. |
name
|
Name of the parameter to be bound. |
value
|
The parameter's value. |
size
|
The parameter's size. |
Return Value
Does not return a value.
SQLBindStringReturnValue
Declaration
void SQLBindStringReturnValue(SQLPreparedCommand command, string name)
Description
Binds a string return value to the prepared command.
Supported Runtime Versions
5.0
Parameters
|
Description |
|---|---|
command
|
Prepared command to bind return value to. |
name
|
Name of the return value. |
Return Value
Does not return a value.
SQLCreateConnection
Declaration
SQLConnection SQLCreateConnection(string connectionString)
Description
Creates a connection to a relational database.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
connectionString
|
Connection string specifying the connection to be created. |
Return Value
A connection to the database specified in the connection string.
SQLCreateConnection
Declaration
SQLConnection SQLCreateConnection(string connectionString, bool oracleConnection)
Description
Creates a connection to a relational database.
Supported Runtime Versions
2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
connectionString
|
Connection string specifying the connection to be created. |
oracleConnection
|
If true, a connection to a Oracle database will be used. If false, a SQL Server connection will be used. |
Return Value
A connection to the database specified in the connection string.
SQLCreatePostgreSQLConnection
Declaration
SQLConnection SQLCreatePostgreSQLConnection(string connectionString)
Description
Creates a connection to a PostgreSQL database.
Supported Runtime Versions
4.0, 5.0
Parameters
|
Description |
|---|---|
connectionString
|
Connection string specifying the connection to be created. |
Return Value
A connection to the database specified in the connection string.
SQLCreatePreparedCommand
Declaration
SQLPreparedCommand SQLCreatePreparedCommand(SQLConnection connection, string statement)
Description
Creates a prepared SQL command.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
connection
|
Database connection to be used for creating the command. |
statement
|
Statement to be executed by the command. |
Return Value
A prepared SQL command.
SQLDataRowGetBoolean
Declaration
bool SQLDataRowGetBoolean(SQLDataRow row, string column)
Description
Returns a certain column value in a result row as a bool.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
row
|
Result row to return value from. |
column
|
Name of the column to return value of. |
Return Value
The value of the specified column.
SQLDataRowGetDateTime
Declaration
DateTime SQLDataRowGetDateTime(SQLDataRow row, string column)
Description
Returns a certain column value in a result row as a DateTime.
Supported Runtime Versions
2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
row
|
Result row to return value from. |
column
|
Name of the column to return value of. |
Return Value
The value of the specified column.
SQLDataRowGetDouble
Declaration
double SQLDataRowGetDouble(SQLDataRow row, string column)
Description
Returns a certain column value in a result row as a double.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
row
|
Result row to return value from. |
column
|
Name of the column to return value of. |
Return Value
The value of the specified column.
SQLDataRowGetInteger
Declaration
int SQLDataRowGetInteger(SQLDataRow row, string column)
Description
Returns a certain column value in a result row as an integer.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
row
|
Result row to return value from. |
column
|
Name of the column to return value of. |
Return Value
The value of the specified column.
SQLDataRowGetString
Declaration
string SQLDataRowGetString(SQLDataRow row, string column)
Description
Returns a certain column value in a result row as a string.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
row
|
Result row to return value from. |
column
|
Name of the column to return value of. |
Return Value
The value of the specified column.
SQLDisconnect
Declaration
SQLConnection SQLDisconnect(SQLConnection connection)
Description
Disconnects a database connection.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
connection
|
Database connection to be disconnected. |
Return Value
Does not return a value.
SQLExecuteNonQuery
Declaration
int SQLExecuteNonQuery(SQLPreparedCommand command)
Description
Executes a prepared command representing a non-query statement.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
command
|
The prepared command to be executed. |
Return Value
The number of rows affected by the command.
SQLExecuteNonQuery
Declaration
int SQLExecuteNonQuery(SQLPreparedCommand command, int commandTimeout)
Description
Executes a prepared command representing a non-query statement.
Supported Runtime Versions
4.0, 5.0
Parameters
|
Description |
|---|---|
command
|
The prepared command to be executed. |
commandTimeout
|
Timeout (in seconds). Set to 0 to wait indefinitely. |
Return Value
The number of rows affected by the command.
SQLExecuteNonQuery
Declaration
int SQLExecuteNonQuery(SQLConnection connection, string statement)
Description
Executes a non-query SQL statement.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
connection
|
Database connection to be used for executing the query. |
statement
|
Statement to be executed. |
Return Value
The number of affected rows.
SQLExecuteNonQuery
Declaration
int SQLExecuteNonQuery(SQLConnection connection, string statement, int commandTimeout)
Description
Executes a non-query SQL statement.
Supported Runtime Versions
4.0, 5.0
Parameters
|
Description |
|---|---|
connection
|
Database connection to be used for executing the query. |
statement
|
Statement to be executed. |
commandTimeout
|
Timeout (in seconds). Set to 0 to wait indefinitely. |
Return Value
The number of affected rows.
SQLExecuteNonQuery
Declaration
int SQLExecuteNonQuery(SQLConnection connection, string statement, int commandTimeout, string commandType)
Description
Executes a non-query SQL statement.
Supported Runtime Versions
4.0, 5.0
Parameters
|
Description |
|---|---|
connection
|
Database connection to be used for executing the query. |
statement
|
Statement to be executed. |
commandTimeout
|
Timeout (in seconds). Set to 0 to wait indefinitely. |
commandType
|
Can be StoredProcedure, TableDirect, or Text. |
Return Value
The number of affected rows.
SQLExecuteQuery
Declaration
SQLData SQLExecuteQuery(SQLPreparedCommand command)
Description
Executes a prepared command representing a query statement.
Supported Runtime Versions
3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
command
|
The prepared command to be executed. |
Return Value
The result of the database query.
SQLExecuteQuery
Declaration
SQLData SQLExecuteQuery(SQLPreparedCommand command, int commandTimeout)
Description
Executes a prepared command representing a query statement.
Supported Runtime Versions
4.0, 5.0
Parameters
|
Description |
|---|---|
command
|
The prepared command to be executed. |
commandTimeout
|
Timeout (in seconds). Set to 0 to wait indefinitely. |
Return Value
The result of the database query.
SQLExecuteQuery
Declaration
SQLData SQLExecuteQuery(SQLConnection connection, string statement)
Description
Executes an SQL query statement.
Supported Runtime Versions
1.0, 2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
connection
|
Database connection to be used for executing the query. |
statement
|
Statement to be executed. |
Return Value
The result of the database query.
SQLExecuteQuery
Declaration
SQLData SQLExecuteQuery(SQLConnection connection, string statement, int commandTimeout)
Description
Executes an SQL query statement.
Supported Runtime Versions
4.0, 5.0
Parameters
|
Description |
|---|---|
connection
|
Database connection to be used for executing the query. |
statement
|
Statement to be executed. |
commandTimeout
|
Timeout (in seconds). Set to 0 to wait indefinitely. |
Return Value
The result of the database query.
SQLExecuteStoredProcedure
Declaration
int SQLExecuteStoredProcedure(SQLConnection connection, string procedureName, int commandTimeout)
Description
Executes a stored procedure.
Supported Runtime Versions
4.0, 5.0
Parameters
|
Description |
|---|---|
connection
|
Database connection to be used for executing the query. |
procedureName
|
Name of the stored procedure to be executed. |
commandTimeout
|
Timeout (in seconds). Set to 0 to wait indefinitely. |
Return Value
The number of affected rows.
SQLGetBooleanParameterValue
Declaration
bool SQLGetBooleanParameterValue(SQLPreparedCommand command, string name)
Description
Returns the value of a boolean parameter.
Supported Runtime Versions
5.0
Parameters
|
Description |
|---|---|
command
|
The prepared command to return the value for. |
name
|
Name of the parameter to return the value for. |
Return Value
The value of the parameter specified.
SQLGetDateTimeParameterValue
Declaration
DateTime SQLGetDateTimeParameterValue(SQLPreparedCommand command, string name)
Description
Returns the value of a DateTime parameter.
Supported Runtime Versions
5.0
Parameters
|
Description |
|---|---|
command
|
The prepared command to return the value for. |
name
|
Name of the parameter to return the value for. |
Return Value
The value of the parameter specified.
SQLGetDoubleParameterValue
Declaration
double SQLGetDoubleParameterValue(SQLPreparedCommand command, string name)
Description
Returns the value of a double parameter.
Supported Runtime Versions
5.0
Parameters
|
Description |
|---|---|
command
|
The prepared command to return the value for. |
name
|
Name of the parameter to return the value for. |
Return Value
The value of the parameter specified.
SQLGetIntegerParameterValue
Declaration
int SQLGetIntegerParameterValue(SQLPreparedCommand command, string name)
Description
Returns the value of an integer parameter.
Supported Runtime Versions
5.0
Parameters
|
Description |
|---|---|
command
|
The prepared command to return the value for. |
name
|
Name of the parameter to return the value for. |
Return Value
The value of the parameter specified.
SQLGetStringParameterValue
Declaration
string SQLGetStringParameterValue(SQLPreparedCommand command, string name)
Description
Returns the value of a string parameter.
Supported Runtime Versions
5.0
Parameters
|
Description |
|---|---|
command
|
The prepared command to return the value for. |
name
|
Name of the parameter to return the value for. |
Return Value
The value of the parameter specified.
SQLIsNull
Declaration
bool SQLIsNull(SQLDataRow row, string column)
Description
Checks whether a certain database column is NULL.
Supported Runtime Versions
2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
row
|
Row containing the column to be checked. |
column
|
Name of the column to be checked. |
Return Value
True, if column is NULL, false otherwise.
SQLPrepareStoredProcedure
Declaration
SQLPreparedCommand SQLPrepareStoredProcedure(SQLConnection connection, string name)
Description
Creates a prepared stored procedure command.
Supported Runtime Versions
5.0
Parameters
|
Description |
|---|---|
connection
|
Database connection to be used for creating the command. |
name
|
Name of the stored procedure to be invoked. |
Return Value
A prepared SQL command.
SQLQuoteString
Declaration
string SQLQuoteString(string text)
Description
Quotes a string, so it can be safely used in SQL statements.
Supported Runtime Versions
5.0
Parameters
|
Description |
|---|---|
text
|
Text to be quoted. |
Return Value
The quoted string.
SQLQuoteString
Declaration
string SQLQuoteString(SQLConnection connection, string text)
Description
Quotes a string, so it can be safely used in SQL statements.
Supported Runtime Versions
2.0, 3.0, 4.0, 5.0
Parameters
|
Description |
|---|---|
connection
|
The current database connection. |
text
|
Text to be quoted. |
Return Value
The quoted string.
SQLSetBooleanParameterValue
Declaration
void SQLSetBooleanParameterValue(SQLPreparedCommand command, string name, bool value)
Description
Sets the value of a boolean parameter.
Supported Runtime Versions
5.0
Parameters
|
Description |
|---|---|
command
|
The prepared command to set the value for. |
name
|
Name of the parameter to be set. |
value
|
The value to be set. |
Return Value
Does not return a value.
SQLSetDateTimeParameterValue
Declaration
void SQLSetDateTimeParameterValue(SQLPreparedCommand command, string name, DateTime value)
Description
Sets the value of a DateTime parameter.
Supported Runtime Versions
5.0
Parameters
|
Description |
|---|---|
command
|
The prepared command to set the value for. |
name
|
Name of the parameter to be set. |
value
|
The value to be set. |
Return Value
Does not return a value.
SQLSetDoubleParameterValue
Declaration
void SQLSetDoubleParameterValue(SQLPreparedCommand command, string name, double value)
Description
Sets the value of a double parameter.
Supported Runtime Versions
5.0
Parameters
|
Description |
|---|---|
command
|
The prepared command to set the value for. |
name
|
Name of the parameter to be set. |
value
|
The value to be set. |
Return Value
Does not return a value.
SQLSetIntegerParameterValue
Declaration
void SQLSetIntegerParameterValue(SQLPreparedCommand command, string name, int value)
Description
Sets the value of an integer parameter.
Supported Runtime Versions
5.0
Parameters
|
Description |
|---|---|
command
|
The prepared command to set the value for. |
name
|
Name of the parameter to be set. |
value
|
The value to be set. |
Return Value
Does not return a value.
SQLSetStringParameterValue
Declaration
void SQLSetStringParameterValue(SQLPreparedCommand command, string name, string value)
Description
Sets the value of a string parameter.
Supported Runtime Versions
5.0
Parameters
|
Description |
|---|---|
command
|
The prepared command to set the value for. |
name
|
Name of the parameter to be set. |
value
|
The value to be set. |
Return Value
Does not return a value.