dbFieldSink

function

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

Returns: an external output to which data can be written for the parameter currently being streamed in to the database

Declaration

define external string sink function dbFieldSink
         value       dbField  insert-handle

Argument definitions

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

Purpose

Use dbFieldSink to obtain an external output object for the current parameter of a dbStatementStreamingExecute operation.

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.

This function can only be called once following each call to dbFieldPrepare (else external exception OMDB307).

The streaming execute operation must not have been completed (else external exception OMDB711).

Usage Notes

After dbFieldPrepare returns TRUE, this function can be called to get an external output object for the parameter which is currently being requested. Any data written to the external output is then streamed in to the database.

To indicate a NULL value, either do not call this function or do not write any data to the returned external output.

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