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 ipGetLongData(
int64 dam_hstmt,
Object locator,
int iXOType,
int iOpType,
char() Buffer,
long IBufferLen,
int64 piLenOrInd)
If the IP specifies that the type of stream is binary, the OpenAccess SDK SQL Engine uses following syntax in the IP:
int ipGetLongData(
int64 dam_hstmt,
Object locator,
int iXOType,
int iOpType,
byte() Buffer,
long IBufferLen,
int64 piLenOrInd)
Parameters for ipGetLongData
| Parameter | Type | Description |
| IN | ||
| hstmt | int64 | 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. |
| OUT | ||
| piLenOrInd | int64 | The Length or Indicator pointer. |
| RETURN | ||
| int | DAM_SUCCESS – on success DAM_SUCCESS_WITH_INFO - if LOB data was copied to the buffer and there is more data to fetch for the LOB. DAM_FAILURE – on failure |