dbFieldPrepare

function

Library: Database access (OMDB legacy)
Include: omdb.xin

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.