Sql

Namespace: PPJ.Runtime.Sql

Assembly: PPJ.Web.50 (5.0.0.0)

Provides SAL-compatible database connection, statement, transaction, and error operations.

C#

public class Sql

VB.NET

Public Class Sql

Connection defaults and the reusable immediate-query handle are isolated to the current user session.

Example:

using PPJ.Runtime;
using PPJ.Runtime.Sql;

SalSqlHandle statement = new SalSqlHandle();
if (Sql.Connect(ref statement))
{
    try
    {
        // Supply SQL suitable for the configured database.
        Sql.PrepareAndExecute(statement, "SELECT CURRENT_TIMESTAMP");
    }
    finally
    {
        Sql.Disconnect(ref statement);
    }
}

Properties

Database

SalString: Gets or sets the database name used for connections. Initially an empty string.

IsolationLevel

SalString: Gets or sets the isolation-level code for new connections. Initially "RL" (release locks).

Password

SalString: Gets or sets the password used for database connections. Initially an empty string.

ResultSet

Boolean: Gets or sets whether result-set mode is enabled for new connections. Initially true.

ResultSetMode

ResultSetMode: Gets or sets the row-caching mode used when result-set mode is enabled. Initially Disconnected.

UniversalDataLink

SalString: Gets or sets the provider name or UDL file used for connection information. Initially an empty string.

User

SalString: Gets or sets the user name used for database connections. Initially an empty string.

Methods

ClearImmediate()

Disconnects the reusable handle used by immediate SQL operations.

Returns: SalBoolean. The disconnect result.

Close(hSql)

Deprecated: Retains the unsupported Close operation for source compatibility.

Parameter	Type	Description
hSql	SalSqlHandle	Ignored; the operation is not implemented.

Returns: SalBoolean. False.

Logs that the operation is unsupported. Reference arguments are left unchanged.

CloseAllSPResultSets(hSql)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.

Returns: SalBoolean.

CloseResultSet(hSql)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.

Returns: SalBoolean.

Commit(hSql)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.

Returns: SalBoolean.

Commit(hSql, errorHandler)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

CommitSession(hSession)

Parameter	Type	Description
hSession	SalSqlSessionHandle	The database session handle on which to perform the operation.

Returns: SalBoolean.

CommitSession(hSession, errorHandler)

Parameter	Type	Description
hSession	SalSqlSessionHandle	The database session handle on which to perform the operation.
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

Connect(hSql)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.

Returns: SalBoolean.

Connect(hSql, errorHandler)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

ConnectImmediate()

Ensures that the reusable immediate-query handle is connected with the current credentials.

Returns: SalBoolean. True if the existing connection can be reused or a new connection succeeds; otherwise, false.

An existing connection is reused when Database, User, and Password are unchanged. Changes to other defaults alone do not reconnect it.

ConnectTransaction(hSql, sName)

Deprecated: Retains the unsupported ConnectTransaction operation for source compatibility.

Parameter	Type	Description
hSql	SalSqlHandle	Ignored; the operation is not implemented.
sName	SalString	Ignored; the operation is not implemented.

Returns: SalBoolean. False.

Logs that the operation is unsupported. Reference arguments are left unchanged.

ConnectUsingCursor(hSql, nCursor)

Deprecated: Retains the unsupported ConnectUsingCursor operation for source compatibility.

Parameter	Type	Description
hSql	SalSqlHandle	Ignored; the operation is not implemented.
nCursor	SalNumber	Ignored; the operation is not implemented.

Returns: SalBoolean. False.

Logs that the operation is unsupported. Reference arguments are left unchanged.

ContextClear(hSql)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.

Returns: SalBoolean.

ContextSet(hSql)

Uses the current form as the SQL variable-resolution context.

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle.

Returns: SalBoolean. The result of setting the context to Sys.hWndForm.

ContextSetToForm(hSql, hWnd)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.
hWnd	SalWindowHandle

Returns: SalBoolean.

CreateSession(hSession, sSessionProperties)

Parameter	Type	Description
hSession	SalSqlSessionHandle	The database session handle on which to perform the operation.
sSessionProperties	SalString

Returns: SalBoolean.

CreateSession(hSession, sSessionProperties, errorHandler)

Parameter	Type	Description
hSession	SalSqlSessionHandle	The database session handle on which to perform the operation.
sSessionProperties	SalString
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

CreateStatement(hSession, hSql)

Parameter	Type	Description
hSession	SalSqlSessionHandle	The database session handle on which to perform the operation.
hSql	SalSqlHandle

Returns: SalBoolean.

DirectoryByName(sServerName, sArrayNames)

Copies the database names exposed by a server into a SAL array.

Parameter	Type	Description
sServerName	SalString	The server to query.
sArrayNames	SalArray<SalString>	Receives names at consecutive indices starting at zero.

Returns: SalBoolean. True if the provider returns a name array; false if it returns null.

Existing elements beyond the returned names are not removed.

Disconnect(hSql)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.

Returns: SalBoolean.

Disconnect(hSql, errorHandler)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

DisconnectWithoutCursor(hSql)

Deprecated: Retains the unsupported DisconnectWithoutCursor operation for source compatibility.

Parameter	Type	Description
hSql	SalSqlHandle	Ignored; the operation is not implemented.

Returns: SalBoolean. False.

Logs that the operation is unsupported. Reference arguments are left unchanged.

DropStoredCmd(hSql, sName)

Deprecated: Retains the unsupported DropStoredCmd operation for source compatibility.

Parameter	Type	Description
hSql	SalSqlHandle	Ignored; the operation is not implemented.
sName	SalString	Ignored; the operation is not implemented.

Returns: SalBoolean. False.

Logs that the operation is unsupported. Reference arguments are left unchanged.

Error(hSql)

Returns the most recent error code recorded by a statement handle.

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle.

Returns: SalNumber. The handle's LastErrorCode value.

ErrorText(nError, nType, sError, nLength, nRealLength)

Retrieves and truncates a SQL error message.

Parameter	Type	Description
nError	SalNumber	The error code.
nType	SalNumber	The requested text category. SQLERROR_Remedy produces an empty result.
sError	SalString	Receives the truncated message, or an empty string for remedy text.
nLength	SalNumber	The maximum message length.
nRealLength	SalNumber	Receives the length after truncation, rather than the original message length.

Returns: SalBoolean. True, including when the error code has no message.

If lookup fails, both receive arguments remain unchanged. Remedy text is unsupported and produces an empty string with length zero.

Execute(hSql)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.

Returns: SalBoolean.

Execute(hSql, errorHandler)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

ExecutionPlan(hSql, sString, nLength)

Deprecated: Retains the unsupported ExecutionPlan operation for source compatibility.

Parameter	Type	Description
hSql	SalSqlHandle	Ignored; the operation is not implemented.
sString	SalString	Ignored; the operation is not implemented.
nLength	SalNumber	Ignored; the operation is not implemented.

Returns: SalBoolean. False.

Logs that the operation is unsupported. Reference arguments are left unchanged.

Exists(sSelect, bExists)

Executes a query on the immediate handle and attempts to fetch its first row.

Parameter	Type	Description
sSelect	SalString	The SELECT statement.
bExists	SalBoolean	Receives the FetchNext result after successful preparation and execution; unchanged if an earlier step fails.

Returns: SalBoolean. False if connecting, preparing, or executing fails; otherwise, true.

The return value does not indicate that a row exists. Read the receive argument for that result. Bind variables are cleared after the fetch.

Exists(sSelect, bExists, errorHandler)

Executes a query on the immediate handle and attempts to fetch its first row.

Parameter	Type	Description
sSelect	SalString	The SELECT statement.
bExists	SalBoolean	Receives the FetchNext result after successful preparation and execution; unchanged if an earlier step fails.
errorHandler	WhenSqlErrorHandler	The SQL error handler installed for this operation.

Returns: SalBoolean. False if connecting, preparing, or executing fails; otherwise, true.

The return value does not indicate that a row exists. Read the receive argument for that result. Bind variables are cleared after the fetch.

ExtractArgs(wParam, lParam, hSql, nErrorCode, nErrorPosition)

Decodes the arguments of a SAM_SqlError message.

Parameter	Type	Description
wParam	SalNumber	The message argument containing the statement handle.
lParam	SalNumber	The packed error code and position.
hSql	SalSqlHandle	Receives the decoded SQL handle.
nErrorCode	SalNumber	Receives the low 16 bits of lParam.
nErrorPosition	SalNumber	Receives lParam shifted right by 16 bits.

Returns: SalBoolean. True if the decoded SQL handle is non-null; otherwise, false.

FetchNext(hSql, nInd)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.
nInd	SalNumber

Returns: SalBoolean.

FetchNext(hSql, nInd, errorHandler)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.
nInd	SalNumber
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

FetchPrevious(hSql, nInd)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.
nInd	SalNumber

Returns: SalBoolean.

FetchPrevious(hSql, nInd, errorHandler)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.
nInd	SalNumber
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

FetchRow(hSql, nRow, nInd)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.
nRow	SalNumber
nInd	SalNumber

Returns: SalBoolean.

FetchRow(hSql, nRow, nInd, errorHandler)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.
nRow	SalNumber
nInd	SalNumber
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

FreeSession(hSession)

Parameter	Type	Description
hSession	SalSqlSessionHandle	The database session handle on which to perform the operation.

Returns: SalBoolean.

FreeSession(hSession, errorHandler)

Parameter	Type	Description
hSession	SalSqlSessionHandle	The database session handle on which to perform the operation.
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

GetCmdOrRowsetPtr(hSql, bCmdOrRowset, numOLEDBPtr)

Deprecated: Retains the unsupported GetCmdOrRowsetPtr operation for source compatibility.

Parameter	Type	Description
hSql	SalSqlHandle	Ignored; the operation is not implemented.
bCmdOrRowset	SalBoolean	Ignored; the operation is not implemented.
numOLEDBPtr	SalNumber	Ignored; the operation is not implemented.

Returns: SalBoolean. False.

Logs that the operation is unsupported. Reference arguments are left unchanged.

GetCursor(hSql)

Deprecated: Retains the unsupported GetCursor operation for source compatibility.

Parameter	Type	Description
hSql	SalSqlHandle	Ignored; the operation is not implemented.

Returns: SalNumber. Zero.

Logs that the operation is unsupported. Reference arguments are left unchanged.

GetDSOrSessionPtr(hSql, bDSOrSession, numOLEDBPtr)

Deprecated: Retains the unsupported GetDSOrSessionPtr operation for source compatibility.

Parameter	Type	Description
hSql	SalSqlHandle	Ignored; the operation is not implemented.
bDSOrSession	SalBoolean	Ignored; the operation is not implemented.
numOLEDBPtr	SalNumber	Ignored; the operation is not implemented.

Returns: SalBoolean. False.

Logs that the operation is unsupported. Reference arguments are left unchanged.

GetError(hSql, nError, sError)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.
nError	SalNumber
sError	SalString

Returns: SalBoolean.

GetErrorPosition(hSql, nPos)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.
nPos	SalNumber

Returns: SalBoolean.

GetErrorText(nError, sError)

Looks up the message associated with a SQL error code.

Parameter	Type	Description
nError	SalNumber	The error code.
sError	SalString	Receives the message if found; otherwise remains unchanged.

Returns: SalBoolean. True if a message is available; otherwise, false.

GetErrorTextX(nError)

Returns the message associated with a SQL error code.

Parameter	Type	Description
nError	SalNumber	The error code.

Returns: SalString. The message, or SalString.Null if no message is available.

GetLastStatement()

Returns the most recently recorded SQL statement.

Returns: SalString. The statement text maintained by SalSqlHandle.GetLastStatement.

GetModifiedRows(hSql, nCount)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.
nCount	SalNumber

Returns: SalBoolean.

GetNextSPResultSet(hSql, sIntoList, bEndOfRS)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.
sIntoList	SalString
bEndOfRS	SalBoolean

Returns: SalBoolean.

GetParameter(hSql, nParameter, nNumber, sString)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.
nParameter	SalNumber
nNumber	SalNumber
sString	SalString

Returns: SalBoolean.

GetParameterAll(hSql, nParameter, nNumber, sString, bNumber)

Deprecated: Retains the unsupported GetParameterAll operation for source compatibility.

Parameter	Type	Description
hSql	SalSqlHandle	Ignored; the operation is not implemented.
nParameter	SalNumber	Ignored; the operation is not implemented.
nNumber	SalNumber	Ignored; the operation is not implemented.
sString	SalString	Ignored; the operation is not implemented.
bNumber	SalBoolean	Ignored; the operation is not implemented.

Returns: SalBoolean. False.

Logs that the operation is unsupported. Reference arguments are left unchanged.

GetResultSetCount(hSql, nCount)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.
nCount	SalNumber

Returns: SalBoolean.

GetResultSetCount(hSql, nCount, errorHandler)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.
nCount	SalNumber
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

GetRollbackFlag(hSql, bRollbackFlag)

Deprecated: Retains the unsupported GetRollbackFlag operation for source compatibility.

Parameter	Type	Description
hSql	SalSqlHandle	Ignored; the operation is not implemented.
bRollbackFlag	SalBoolean	Ignored; the operation is not implemented.

Returns: SalBoolean. False.

Logs that the operation is unsupported. Reference arguments are left unchanged.

GetSessionErrorInfo(hSession, nErrorNumber, sErrorDescription, sSqlState)

Parameter	Type	Description
hSession	SalSqlSessionHandle	The database session handle on which to perform the operation.
nErrorNumber	SalNumber
sErrorDescription	SalString
sSqlState	SalString

Returns: SalBoolean.

GetSessionHandle(hSql, hSession)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.
hSession	SalSqlSessionHandle

Returns: SalBoolean.

GetSessionParameter(hSession, nParameter, nValue, sValue)

Parameter	Type	Description
hSession	SalSqlSessionHandle	The database session handle on which to perform the operation.
nParameter	SalNumber
nValue	SalNumber
sValue	SalString

Returns: SalBoolean.

GetSqlHandle(Number)

Deprecated: Retains the unsupported GetSqlHandle operation for source compatibility.

Parameter	Type	Description
Number	SalNumber	Ignored; the operation is not implemented.

Returns: SalSqlHandle. Null.

Logs that the operation is unsupported. Reference arguments are left unchanged.

GetStatementErrorInfo(hSql, nErrorNumber, sErrorDescription, sSqlState)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.
nErrorNumber	SalNumber
sErrorDescription	SalString
sSqlState	SalString

Returns: SalBoolean.

Immediate(sSqlCommand)

Prepares and executes SQL using the reusable immediate-query handle.

Parameter	Type	Description
sSqlCommand	SalString	The SQL command.

Returns: SalBoolean. False if connecting, preparing, or executing fails; otherwise, true.

For queries and procedures, attempts to fetch one row and closes the result set. The fetch result does not affect the return value. Clears bind variables after execution.

Immediate(sSqlCommand, errorHandler)

Prepares and executes SQL using the reusable immediate-query handle.

Parameter	Type	Description
sSqlCommand	SalString	The SQL command.
errorHandler	WhenSqlErrorHandler	The SQL error handler installed for this operation.

Returns: SalBoolean. False if connecting, preparing, or executing fails; otherwise, true.

For queries and procedures, attempts to fetch one row and closes the result set. The fetch result does not affect the return value. Clears bind variables after execution.

ImmediateContext(command, context)

Executes an immediate command using an explicit variable-resolution context.

Parameter	Type	Description
command	SalString	The SQL command.
context	Object	The context used to resolve bind and receive variables.

Returns: SalBoolean. The immediate execution result, or false if connection fails.

The context is reset to null only after a successful Immediate call. A failed call can leave the supplied context installed.

Open(hSql, sCursorName)

Deprecated: Retains the unsupported Open operation for source compatibility.

Parameter	Type	Description
hSql	SalSqlHandle	Ignored; the operation is not implemented.
sCursorName	SalString	Ignored; the operation is not implemented.

Returns: SalBoolean. False.

Logs that the operation is unsupported. Reference arguments are left unchanged.

OraPLSQLCommand(hSql, sCommand)

Prepares and executes an Oracle PL/SQL stored-procedure command.

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle.
sCommand	SalString	The stored-procedure command, including its argument list.

Returns: SalBoolean. The result of the corresponding SqlOra operation.

OraPLSQLCommand(hSql, sCommand, errorHandler)

Prepares and executes an Oracle PL/SQL stored-procedure command.

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle.
sCommand	SalString	The stored-procedure command, including its argument list.
errorHandler	WhenSqlErrorHandler	The SQL error handler installed for this operation.

Returns: SalBoolean. The result of the corresponding SqlOra operation.

OraPLSQLExecute(hSql)

Executes a previously prepared anonymous Oracle PL/SQL block.

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle.

Returns: SalBoolean. The result of the corresponding SqlOra operation.

OraPLSQLExecute(hSql, errorHandler)

Executes a previously prepared anonymous Oracle PL/SQL block.

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle.
errorHandler	WhenSqlErrorHandler	The SQL error handler installed for this operation.

Returns: SalBoolean. The result of the corresponding SqlOra operation.

OraPLSQLPrepare(hSql, sAnonymousPLSQLBlock)

Prepares an anonymous Oracle PL/SQL block and its bind variables.

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle.
sAnonymousPLSQLBlock	SalString	The anonymous PL/SQL block.

Returns: SalBoolean. The result of the corresponding SqlOra operation.

OraPLSQLPrepare(hSql, sAnonymousPLSQLBlock, errorHandler)

Prepares an anonymous Oracle PL/SQL block and its bind variables.

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle.
sAnonymousPLSQLBlock	SalString	The anonymous PL/SQL block.
errorHandler	WhenSqlErrorHandler	The SQL error handler installed for this operation.

Returns: SalBoolean. The result of the corresponding SqlOra operation.

OraPLSQLStringBindType(hSql, sBindName, nBindType)

Deprecated: Retains the unsupported OraPLSQLStringBindType operation for source compatibility.

Parameter	Type	Description
hSql	SalSqlHandle	Ignored; the operation is not implemented.
sBindName	SalString	Ignored; the operation is not implemented.
nBindType	SalNumber	Ignored; the operation is not implemented.

Returns: SalBoolean. False.

Logs that the operation is unsupported. Reference arguments are left unchanged.

Prepare(hSql, sSqlStatement)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.
sSqlStatement	SalString

Returns: SalBoolean.

Prepare(hSql, sSqlStatement, errorHandler)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.
sSqlStatement	SalString
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

PrepareAndExecute(hSql, sSqlStatement)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.
sSqlStatement	SalString

Returns: SalBoolean.

PrepareAndExecute(hSql, sSqlStatement, errorHandler)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.
sSqlStatement	SalString
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

PrepareSP(hSql, sStoredProc, sIntoList)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.
sStoredProc	SalString
sIntoList	SalString

Returns: SalBoolean.

PrepareSP(hSql, sStoredProc, sIntoList, errorHandler)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.
sStoredProc	SalString
sIntoList	SalString
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

Retrieve(hSql, sName, sBindList, sIntoList)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.
sName	SalString
sBindList	SalString
sIntoList	SalString

Returns: SalBoolean.

Retrieve(hSql, sName, sBindList, sIntoList, errorHandler)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.
sName	SalString
sBindList	SalString
sIntoList	SalString
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

Rollback(hSql)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.

Returns: SalBoolean.

Rollback(hSql, errorHandler)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

RollbackSession(hSession)

Parameter	Type	Description
hSession	SalSqlSessionHandle	The database session handle on which to perform the operation.

Returns: SalBoolean.

RollbackSession(hSession, errorHandler)

Parameter	Type	Description
hSession	SalSqlSessionHandle	The database session handle on which to perform the operation.
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

SetInMessage(hSql, nSize)

Deprecated: Retains the unsupported SetInMessage operation for source compatibility.

Parameter	Type	Description
hSql	SalSqlHandle	Ignored; the operation is not implemented.
nSize	SalNumber	Ignored; the operation is not implemented.

Returns: SalBoolean. False.

Logs that the operation is unsupported. Reference arguments are left unchanged.

SetIsolationLevel(hSql, sIsolation)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.
sIsolation	SalString

Returns: SalBoolean.

SetLockTimeout(hSql, nTimeout)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.
nTimeout	SalNumber

Returns: SalBoolean.

SetLongBindDatatype(nBindVarNumber, nDatatype)

Deprecated: Retains the unsupported SetLongBindDatatype operation for source compatibility.

Parameter	Type	Description
nBindVarNumber	SalNumber	Ignored; the operation is not implemented.
nDatatype	SalNumber	Ignored; the operation is not implemented.

Returns: SalBoolean. False.

Logs that the operation is unsupported. Reference arguments are left unchanged.

SetOutMessage(hSql, nSize)

Deprecated: Retains the unsupported SetOutMessage operation for source compatibility.

Parameter	Type	Description
hSql	SalSqlHandle	Ignored; the operation is not implemented.
nSize	SalNumber	Ignored; the operation is not implemented.

Returns: SalBoolean. False.

Logs that the operation is unsupported. Reference arguments are left unchanged.

SetParameter(hSql, nParameter, nNumber, sString)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.
nParameter	SalNumber
nNumber	SalNumber
sString	SalString

Returns: SalBoolean.

SetParameterAll(hSql, nParameter, nValue, sValue, bNumber)

Deprecated: Retains the unsupported SetParameterAll operation for source compatibility.

Parameter	Type	Description
hSql	SalSqlHandle	Ignored; the operation is not implemented.
nParameter	SalNumber	Ignored; the operation is not implemented.
nValue	SalNumber	Ignored; the operation is not implemented.
sValue	SalString	Ignored; the operation is not implemented.
bNumber	SalBoolean	Ignored; the operation is not implemented.

Returns: SalBoolean. False.

Logs that the operation is unsupported. Reference arguments are left unchanged.

SetResultSet(hSql, bSet)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.
bSet	SalBoolean

Returns: SalBoolean.

SetSessionParameter(hSession, nParameter, nValue, sValue)

Parameter	Type	Description
hSession	SalSqlSessionHandle	The database session handle on which to perform the operation.
nParameter	SalNumber
nValue	SalNumber
sValue	SalString

Returns: SalBoolean.

Store(hSql, sName, sSqlCommand)

Deprecated: Retains the unsupported Store operation for source compatibility.

Parameter	Type	Description
hSql	SalSqlHandle	Ignored; the operation is not implemented.
sName	SalString	Ignored; the operation is not implemented.
sSqlCommand	SalString	Ignored; the operation is not implemented.

Returns: SalBoolean. False.

Logs that the operation is unsupported. Reference arguments are left unchanged.

VarSetup(hSql, context)

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle on which to perform the operation.
context	Object

Returns: SalBoolean.

VarSetup(hSql)

Captures bind-variable context using the current compile-and-evaluate context.

Parameter	Type	Description
hSql	SalSqlHandle	The SQL statement handle.

Returns: SalBoolean. The result of VarSetup on the handle with a null explicit context.

XDirectory(nServer, sDatabases)

Deprecated: Retains the unsupported XDirectory operation for source compatibility.

Parameter	Type	Description
nServer	SalNumber	Ignored; the operation is not implemented.
sDatabases	SalArray<SalString>	Ignored; the operation is not implemented.

Returns: SalBoolean. False.

Logs that the operation is unsupported. Reference arguments are left unchanged.