Standard DAM Statement Properties

The properties listed here are standard properties of DAM statement objects. DAM statements which have a standard property only include the property name in their property table - please use the entry here to read about the property.

$batchsizeThe number of rows to retrieve simultaneously- enables batch fetching. Some databases do not support batch fetching in which case the value reverts to 1
$columncountThe number of columns in the current result set (read-only)
$columndelimiterThe character which delimits column values when using $fetchtofile
$errorcodeThe Omnis error code generated by last statement command (read-only)
kDAMFileOpenFailed kDAMFileReadFailed kDAMInternalError kDAMInvalidFileName kDAMInvalidIndexType kDAMInvalidMapType kDAMInvalidTableType kDAMInvalidTranMode kDAMNativeErrorFailed kDAMNoClientLibrary kDAMNoError kDAMNoPendingError kDAMNotSerialised kDAMNotUnicode kDAMParameterError kDAMParameterNumError kDAMParameterTypeError kDAMServerMethodFailed kDAMServerPropertyFailed kDAMSqlError kDAMUnknownError kDAMWrongOmnisVersion kSessionBeginFailed kSessionBindMarkerFailed kSessionClearFailed kSessionColTextFailed kSessionCommitFailed kSessionInvalidSQLSeparator kSessionLobChunkSizeOutOfRange kSessionLobThresholdOutOfRange kSessionLogoffFailed kSessionLogonFailed kSessionNewStatementFailed kSessionNoDriverManager kSessionNoMapTable kSessionNotLoggedOn kSessionNoTranSupport kSessionNotTranManual kSessionRegisterFailed kSessionRollbackFailed kSessionRpcDefineFailed kSessionRpcNotDefined kSessionSetCharMapFailed kSessionSetMapTableFailed kSessionSetTranModeFailed kSessionUsesAutoBegin kStatementBindInputVarFailed kStatementBindResultColFailed kStatementBufferAllocationFailed kStatementClearFailed kStatementCloseFailed kStatementDescribeFailed kStatementDropFailed kStatementExecDirectFailed kStatementExecuteFailed kStatementFetchFailed kStatementFetchMemoryExceeded kStatementHasNoSession kStatementInputVarFailed kStatementInsertRowFailed kStatementNoFetchList kStatementNoFilename kStatementNoResults kStatementNotPrepared kStatementPrepareFailed kStatementResultColFailed kStatementReturnedInfo kStatementRpcGetParamValuesError kStatementRpcPrepareParamsError kStatementSendInputVarFailed kStatementSendResultVarFailed kStatementServerColumnsFailed kStatementServerIndexesFailed kStatementServerResultsFailed kStatementServerRpcParametersFailed kStatementServerRpcProceduresFailed kStatementServerTablesFailed
$errortextThe Omnis error text generated by last statement command (read-only)
$maxbuffersizeSets the maximum buffer size per column- used when batch fetching. If a $fetch() exceeds this value; $effectivebatchsize receives the value that was used
$nativeerrorcodeThe DBMS-specific native error code generated by last statement command (read-only)
$nativeerrorpendingkTrue if further native errors are available for the statement (read-only)
$nativeerrortextThe DBMS-specific native error text generated by last statement command (read-only)
$resultspendingkTrue if a result set exists (read-only)
$rowcountThe number of rows in the current result set (read-only)
$rowdelimiterThe character which delimits row values when using $fetchtofile
$rowsaffectedRows affected by last executed INSERT or UPDATE statement. Some databases do not support this property in which case the value will be -1 (read-only)
$rowsfetchedThe number of rows retrieved by the last $fetch() (read-only)
$rpcreturnvalueReceives the return value of the most recent call to a remote procedure (read-only)
$sqlstripspacesIf kTrue, trailing spaces stripped from any fetched character data
$sqltextThe currently assigned SQL text (read-only)
$stateThe current state of statement object, one of the kStatementState... constants (read-only)
kStatementStateClear kStatementStateExecDirect kStatementStateExecuted kStatementStateFetching kStatementStatePrepared
$statementnameName of the statement object (read-only)
$usecursorSetting $usecursor to kTrue enables the use of a cursor for this statement (if the database supports cursors). $transactionmode should also be kSessionTranManual