File
File: dtsearch.h
Syntax
C++
long DLLFUNC dtssIntArrayGetItemRange(dtsIntArrayHandle hArray, int nFirstItem, int nLastItem, long * pDest);
Group
Parameters
|
Parameters |
Description |
|---|---|
|
int nFirstItem |
Zero-based first index of items to retrieve from array |
|
int nLastItem |
Zero-based last index of items to retrieve from array |
|
long * pDest |
Buffer to receive the integer data, which must have space for nLastItem-nFirstItem+1 integers |
|
hStr |
Handle to the array |
Returns
Number of integers copied to pDest, which may be less than the number requested if the array does not contain sufficient items.
Description
Get partial contents of an integer array represented by a dtsStringHandle
Remarks
dtsIntArrayHandles are used to return variable-length integer arrays from certain dtSearch Engine API functions. To obtain the contents of the array:
- Use dtssIntArrayGetLength to get the length of the array,
- Allocate a buffer large enough for the array,
- Call dtssIntArrayGetItemRange to obtain the contents of the array, and
- Call dtssIntArrayDelete to free the memory that was allocated for the string.