17.10 - Syntax - Advanced SQL Engine - Teradata Database

Teradata Vantage™ - SQL External Routine Programming

Product
Advanced SQL Engine
Teradata Database
Release Number
17.10
Release Date
July 2021
Content Type
Programming Reference
Publication ID
B035-1147-171K
Language
English (United States)
void
FNC_SetNullBitVectorByElemIndex ( NullBitVecType *NullBitVector,
                                  int             indexValue[],
                                  int             presenceValue,
                                  long            bufSize,
                                  bounds_t       *arrayScope,
                                  int             numDimensions)

Syntax Elements

NullBitVector
a NullBitVector array previously allocated by the caller.
The data type used to access the NullBitVector is defined in sqltypes_td.h as:
typedef unsigned char NullBitVecType;
indexValue[]
the index to the ARRAY element whose corresponding presence bit in the NullBitVector is to be set. For a 1-D ARRAY, the index to the last present element is provided as indexValue[0]. If the ARRAY type is n-D, then the complete dimension information for this index is placed in cells indexValue[1], indexValue[2], indexValue[3] ... indexValue[FNC_ARRAYMAXDIMENSIONS] as needed, where FNC_ARRAYMAXDIMENSIONS specifies the maximum number of dimensions in an ARRAY type as defined in sqltypes_td.h:
#define FNC_ARRAYMAXDIMENSIONS 5
presenceValue
the value that the presence bit (indicated by indexValue) should be set to. The valid values are 1 or 0.
bufSize
the size in bytes of the NullBitVector as allocated by the caller prior to initialization of the NullBitVector by setting all bytes to 0.
arrayScope
an array of bounds_t structures that provides the scope information for the ARRAY which the NullBitVector describes. You can call FNC_GetArrayTypeInfo to get this information. See FNC_GetArrayTypeInfo [Deprecated].
numDimensions
the number of dimensions defined for the ARRAY which the NullBitVector describes. You can call FNC_GetArrayTypeInfo to get this information. See FNC_GetArrayTypeInfo [Deprecated].