You are here: C++ API > Functions > dtssIntArrayGetItems Function
Close
dtSearch Text Retrieval Engine Programmer's Reference
dtssIntArrayGetItems Function

File: dtsearch.h

Syntax
C++
long DLLFUNC dtssIntArrayGetItems(dtsIntArrayHandle hArray, long * pDest, long maxItems);
Parameters
Description
long * pDest
Buffer to receive the integer data
long maxItems
Size of the pDest buffer, in 32-bit integers
hStr
Handle to the array

Length of the array.

Get the contents of an integer array represented by a dtsStringHandle

dtsIntArrayHandles are used to return variable-length integer arrays from certain dtSearch Engine API functions. To obtain the contents of the array:

  1. Use dtssIntArrayGetLength to get the length of the array,
  2. Allocate a buffer large enough for the array,
  3. Call dtssIntArrayGetItems to obtain the contents of the array, and
  4. Call dtssIntArrayDelete to free the memory that was allocated for the string.
Copyright (c) 1995-2022 dtSearch Corp. All rights reserved.