swirl
Guide to OmniMark 7   OmniMark home
docs home 
IndexConceptsTasksSyntaxLibrariesLegacy LibrariesErrors
 
      Other Library Functions  
function  

dbFieldPrepare

 
 

Library: Database access (OMDB) legacy library
Include: omdb.xin
Return type: Boolean
Returns: 

An boolean value which is TRUE if there is another parameter to be streamed in and FALSE otherwise.


Declaration

  define external switch function dbFieldPrepare
           modifiable  dbField  insert-handle

Argument definitions

insert-handle
is the dbField passed as the "with" parameter to dbStatementStreamingExecute.


Purpose

Use dbFieldPrepare to fetch the next parameter to be inserted. It returns FALSE if all parameters have been inserted, otherwise it returns TRUE.

Requirements

You must include the following line at the beginning of your OmniMark program:

  include "omdb.xin"

insert-handle must be the dbField passed as the "with" parameter to the previous dbStatementStreamingExecute call.

Usage Notes

This function is to be called repeatedly after dbStatementStreamingExecute until it returns FALSE. Each time it returns TRUE, it sets the key of insert-handle to the name of the parameter being requested, where the first parameter from the left is "1", the second is "2", and so on.

Be sure to keep calling this function until it returns FALSE since the parameters can be requested out of order by the database driver. In addition, this function performs final processing after the final parameter has been streamed in.

See the usage notes for dbStatementStreamingExecute for further details and examples.

        Other Library Functions
   dbClose
   dbCommit
   dbDatabase
   dbExecute
   dbField
   dbFieldPrepare
   dbFieldSink
   dbFieldValue
   dbIsVersionCompatible
   dbLibraryVersion
   dbLibraryVersionOCI8
   dbLibraryVersionOCI8i
   dbLibraryVersionODBC
   dbOpenOCI8
   dbOpenOCI8i
   dbOpenODBC
   dbProcedure
   dbProcedureClose
   dbProcedureExecute
   dbProcedureOpen
   dbQuery
   dbRecordExists
   dbRecordMove
   dbRecordSetMove
   dbRollback
   dbSetTransactionType
   dbStatement
   dbStatementCompile
   dbStatementDiscard
   dbStatementExecute
   dbStatementStreamingExecute
   dbTable
   dbTableClose
   dbTableDelete
   dbTableInsert
   dbTableOpen
   dbTableUpdate
 
 

Top [ INDEX ] [ CONCEPTS ] [ TASKS ] [ SYNTAX ] [ LIBRARIES ] [ LEGACYLIBRARIES ] [ ERRORS ]

OmniMark 7.1.2 Documentation Generated: June 28, 2005 at 5:45:05 pm
If you have any comments about this section of the documentation, send email to [email protected]

Copyright © Stilo Corporation, 1988-2005.