ora-lob-read-foreign-buffer

ora-lob-read-foreign-buffer Function

Summary

Reads from a LOB into a foreign buffer.

Package

sql

Signature

ora-lob-read-foreign-buffer lob-locator offset amount foreign-buffer buffer-length &key buffer-offset csid => amount-read, eof-or-error-p

Arguments

`lob-locator`⇩	A LOB locator.
`offset`⇩	A non-negative integer or `nil`.
`amount`⇩	A non-negative integer.
`foreign-buffer`⇩	A FLI pointer.
`buffer-length`⇩	A non-negative integer.
`buffer-offset`⇩	A non-negative integer.
`csid`⇩	A.Character Set ID.

Values

`amount-read`	A non-negative integer.
`eof-or-error-p`	A boolean or an error object.

Description

The function ora-lob-read-foreign-buffer reads from the LOB pointed to by lob-locator into the foreign buffer foreign-buffer.

This is just like ora-lob-read-buffer except that it reads from the LOB locator into a foreign buffer. See ora-lob-read-buffer for details of offset, amount, buffer-offset and csid.

foreign-buffer is a FLI pointer to a buffer, which must be of size at least buffer-length.

Notes

This is a direct call to OCILobRead, without callback.
ora-lob-read-foreign-buffer is available only when the "oracle" module is loaded. See the section 23.11 Oracle LOB interface for more information.