Powered by Zoomin Software. For more details please contactZoomin

DataDirect OpenAccess SDK Help

ipGetLongData

  • Last Updated: May 12, 2026
  • 1 minute read
    • OpenAccess SDK
    • Version 8.1
    • Documentation

This function support 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.

If the IP specifies that the type of stream is CHAR, the OpenAccess SDK SQL Engine uses following syntax in the IP:

int ip_GetLongData(
    long    dam_hstmt,
    Object  Locator, 
    int     iXOType, 
    int     iOpType, 
    char()  Buffer, 
    long    IBufferLen,
    xo_long piLenOrInd)

If the IP specifies that the type of stream is binary, the OpenAccess SDK SQL Engine uses following syntax in the IP:

int ip_GetLongData(
    long    dam_hstmt,
    Object  Locator, 
    int     iXOType, 
    int     iOpType, 
    byte()  Buffer, 
    long    IBufferLen,
    xo_long piLenOrInd)

Parameters for ipGetLongData

Parameter Type Description
INPUT
hstmt dam_hstmt Statement handle.
Locator Object 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, LOB_NEXT, and LOB_CLOSE.
Buffer char()byte() The Buffer location, into which the IP can populate data.
IBufferLen long The ioTargetValPtr buffer length.
piLenOrInd xo_long The Length or Indicator pointer.
RETURN
int DAM_SUCCESS - on success
DAM_SUCCESS_WITH_INFO - on success, but more data still must be fetched for the LOB
DAM_FAILURE - on failure

See also

dam_addLOBLocatorValToRow

TitleResults for “How to create a CRG?”Also Available inAlert