skip to main content
Interface Provider API : Reference : OAIP_GetLongData
 

OAIP_GetLongData

This function supports streaming for a particular column.The IP calls dam_addLOBLocatorValToRow to add the locator value. When the client requests data, the OpenAccess SDK SQL Engine invokes OAIP_GetLongData, which is exported from the IP.
int OAIP_GetLongData(
    DAM_HSTMT hstmt,
    void    * pLOBLocator,
    int        iXoType,
    int iOpType,
    void    * ioTargetValuePtr,
    long       iBufferLength,
    long    * oLenOrIndPtr)
Table 14. Parameters for OAIP_GetLongData
Parameter
Type
Description
IN
hstmt
DAM_HSTMT
Statement handle.
pLOBLocator
void *
LOB locator value, which is added in dam_addLOBLocatorValToRow.
iXoType
int
XOtype specified in dam_addLOBLocatorValToRow.
iOpType
int
Type of LOB Locator options. Valid values are:
LOB_FIRST - get data from the beginning of the LOB
LOB_NEXT - get the next buffers worth of data
LOB_CLOSE - close the LOB. The IP should release any resources it is holding for the locator.
ioTargetValuePtr
void *
The Buffer location, into which the IP can populate data.
iBufferLength
long
The ioTargetValPtr Buffer length.
oLenOrIndPtr
long
The Length or Indicator pointer.
RETURN
int
DAM_SUCCESS - on success
DAM_SUCCESS_WITH_INFO - if LOB data was copied to the buffer and more data remains to be fetched for the LOB. The value returned in oLenOrIndPtr is the number of bytes of LOB data remaining.
DAM_FAILURE - on failure

See also

*dam_addLOBLocatorValToRow