Home
Client APIs and toolsYou can use the HCL OneDB™ implementation of client APIs to develop applications for HCL OneDB™ database servers.
ESQL/C GuideThe HCL OneDB™ ESQL/C Programmer's Manual explains how to use , the HCL OneDB™ implementation of Embedded Structured Query Language (SQL) for C (ESQL/C), to create client applications with database-management capabilities.
AppendixesThis section contains additional reference information.
The ESQL/C function libraryThese topics describe the syntax and behavior of all the library functions provided with HCL® OneDB® ESQL/C.
The ifx_var_getlen() functionThe ifx_var_getlen() function returns the length of the data in an lvarchar pointer or var binary host variable.

The ifx_var_getlen() function

The ifx_var_getlen() function returns the length of the data in an lvarchar pointer or var binary host variable.

Syntax

var binary

mint ifx_var_getlen(var_bin)
   var binary **var_bin;

lvarchar

mint ifx_var_getlen(lvar)
   lvarchar **lvar;

var_bin: The address of the var binary host variable whose length is returned.
lvar: The address of the lvarchar pointer host variable whose length is returned.

Usage

The length that the ifx_var_getlen() function returns is the number of bytes that have been allocated for the data buffer of the lvar or var_bin host variable.

If you get an lvarchar pointer or var binary from a descriptor area by using the DATA clause of a GET DESCRIPTOR statement, the value is null terminated. If you use ifx_var_getlen() on such a variable, the length returned includes the null terminator. To get the correct length use the LENGTH clause of the GET DESCRIPTOR statement.

Return codes

>=0: The length of the data buffer for the var_bin host variable.
<0: The function was not successful.