HCL OneDB ESQL/C library functions
The following table lists the library functions in alphabetical order.
| Function name | Description | See |
|---|---|---|
| bigintcvasc() | Converts a C char type value to a BIGINT type number. | The bigintcvasc() function |
| bigintcvdbl() | Converts a double type number to a BIGINT type number. | The bigintcvdbl() function |
| bigintcvdec() | Converts a decimal type number to a BIGINT type number. | The bigintcvdec() function |
| bigintcvflt() | Converts a float type number to a BIGINT type number. | The bigintcvflt() function |
| bigintcvifx_int8() | Converts and int8 type number to a BIGINT type number. | The bigintcvifx_int8() function |
| bigintcvint2() | Converts an int2 type number to a BIGINT type number. | The bigintcvint2() function |
| bigintcvint4() | Converts an int4 type number to a BIGINT type number. | The bigintcvint4() function |
| biginttoasc() | Converts a BIGINT type value to a C char type value. | The biginttoasc() function |
| biginttodbl() | Converts a BIGINT type number to a double type number. | The biginttodbl() function |
| biginttodec() | Converts a BIGINT type number to a decimal type number. | The biginttodec() function |
| biginttoflt() | Converts a BIGINT type number to a float type number. | The biginttoflt() function |
| biginttoifx_int8() | Converts a BIGINT type number to an int8 type number. | The biginttoifx_int8() function |
| biginttoint2() | Converts a BIGINT type number to an int2 type number. | The biginttoint2() function |
| biginttoint4() | Converts a BIGINT type number to an int4 type number. | The biginttoint4() function |
| bycmpr() | Compares two groups of contiguous bytes | The bycmpr() function |
| bycopy() | Copies bytes from one area to another | The bycopy() function |
| byfill() | Fills the specified area with a character | The byfill() function |
| byleng() | Counts the number of bytes in a string | The byleng() function |
| decadd() | Adds two decimal numbers | The decadd() function |
| deccmp() | Compares two decimal numbers | The deccmp() function |
| deccopy() | Copies a decimal number | The deccopy() function |
| deccvasc() | Converts a C char type to a decimal type | The deccvasc() function |
| deccvdbl() | Converts a C double type to a decimal type | The deccvdbl() function |
| deccvint() | Converts a C int2 type to a decimal type | The deccvint() function |
| deccvlong() | Converts a C int4 type to a decimal type | The deccvlong() function |
| decdiv() | Divides two decimal numbers | The decdiv() function |
| dececvt() | Converts a decimal value to an ASCII string | The dececvt() and decfcvt() functions |
| decfcvt() | Converts a decimal value to an ASCII string | The dececvt() and decfcvt() functions |
| decmul() | Multiplies two decimal numbers | The decmul() function |
| decround() | Rounds a decimal number | The decround() function |
| decsub() | Subtracts two decimal numbers | The decsub() function |
| dectoasc() | Converts a decimal type to an ASCII string | The dectoasc() function |
| dectodbl() | Converts a decimal type to a C double type | The dectodbl() function |
| dectoint() | Converts a decimal type to a C int type | The dectoint() function |
| dectolong() | Converts a decimal type to a C long type | The dectolong() function |
| dectrunc() | Truncates a decimal number | The dectrunc() function |
| dtaddinv() | Adds an interval value to a datetime value | The dtaddinv() function |
| dtcurrent() | Gets current date and time | The dtcurrent() function |
| dtcvasc() | Converts an ANSI-compliant character string to datetime | The dtcvasc() function |
| dtcvfmtasc() | Converts a character string to a datetime value | The dtcvfmtasc() function |
| dtextend() | Changes the qualifier of a datetime | The dtextend() function |
| dtsub() | Subtracts one datetime value from another | The dtsub() function |
| dtsubinv() | Subtracts an interval value from a datetime value | The dtsubinv() function |
| dttoasc() | Converts a datetime value to an ANSI-compliant character string | The dttoasc() function |
| dttofmtasc() | Converts a datetime value to a character string | The dttofmtasc() function |
| GetConnect() | Requests an explicit connection and returns a pointer to the connection information | The GetConnect() function (Windows) |
| ifx_cl_card() | Returns the cardinality of the specified collection type host variable | The ifx_cl_card() function |
| ifx_dececvt() | Converts a decimal value to an ASCII string (thread-safe version) | The ifx_dececvt() and ifx_decfcvt() function |
| ifx_decfcvt() | Converts a decimal value to an ASCII string (thread-safe version) | The ifx_dececvt() and ifx_decfcvt() function |
| ifx_getcur_conn_name() | Returns the name of the current connection | The ifx_getcur_conn_name() function |
| ifx_getenv() | Retrieves the value of an environment variable | The ifx_getenv() function |
| ifx_getserial8() | Returns an inserted SERIAL8 value | The ifx_getserial8() function |
| ifx_int8add() | Adds two int8 numbers | The ifx_int8add() function |
| ifx_int8cmp() | Compares two int8 numbers | The ifx_int8cmp() function |
| ifx_int8copy() | Copies an int8 number | The ifx_int8copy() function |
| ifx_int8cvasc() | Converts a C char type value to an int8 type value | The ifx_int8cvasc() function |
| ifx_int8cvdbl() | Converts a C double type value to an int8 type value | The ifx_int8cvdbl() function |
| ifx_int8cvdec() | Converts a C decimal type value to an int8 type value | The ifx_int8cvdec() function |
| ifx_int8cvflt() | Converts a C float type value to an int8 type value | The ifx_int8cvflt() function |
| ifx_int8cvint() | Converts a C int2 type value to an int8 type value | The ifx_int8cvint() function |
| ifx_int8cvlong() | Converts a C int4 type value to an int8 type value | The ifx_int8cvlong() function |
| ifx_int8div() | Divides two int8 numbers | The ifx_int8div() function |
| ifx_int8mul() | Multiplies two int8 numbers | The ifx_int8mul() function |
| ifx_int8sub() | Subtracts two int8 numbers | The ifx_int8sub() function |
| ifx_int8toasc() | Converts an int8 type value to a text string | The ifx_int8toasc() function |
| ifx_int8todbl() | Converts an int8 type value to a C double type value | The ifx_int8todbl() function |
| ifx_int8todec() | Converts an int8 type value to a decimal type value | The ifx_int8todec() function |
| ifx_int8toflt() | Converts an int8 type value to a C float type value | The ifx_int8toflt() function |
| ifx_int8toint() | Converts an int8 type value to a C int2 type value | The ifx_int8toint() function |
| ifx_int8tolong() | Converts an int8 type value to a C int4 type value | The ifx_int8tolong() function |
| ifx_lo_alter() | Alters the storage characteristics of an existing smart large object | The ifx_lo_alter() function |
| ifx_lo_close() | Closes an open smart large object | The ifx_lo_close() function |
| ifx_lo_col_info() | Obtains column-level storage characteristics into an LO-specification structure | The ifx_lo_col_info() function |
| ifx_lo_copy_to_file() | Copies a smart large object to an operating-system file | The ifx_lo_copy_to_file() function |
| ifx_lo_copy_to_lo() | Copies an operating-system file to an open smart large object | The ifx_lo_copy_to_lo() function |
| ifx_lo_create() | Creates an LO descriptor for a smart large object | The ifx_lo_create() function |
| ifx_lo_def_create_spec() | Allocates an LO-specification structure and initializes its fields to null values | The ifx_lo_def_create_spec() function |
| ifx_lo_filename() | Returns the generated file name, given an LO descriptor and a file specification | The ifx_lo_filename() function |
| ifx_lo_from_buffer() | Copies bytes from a user-defined buffer to a smart large object | The ifx_lo_from_buffer() function |
| ifx_lo_open() | Opens an existing smart large object | The ifx_lo_open() function |
| ifx_lo_read() | Reads a specified number of bytes from an open smart large object | The ifx_lo_read() function |
| ifx_lo_readwithseek() | Seeks to a specified position in an open smart large object and reads a specified number of bytes | The ifx_lo_readwithseek() function |
| ifx_lo_release() | Releases resources associated with a temporary smart large object | The ifx_lo_release() function |
| ifx_lo_seek() | Sets the seek position for the next read or write on an open smart large object | The ifx_lo_seek() function |
| ifx_lo_spec_free() | Frees the resources allocated to an LO-specification structure | The ifx_lo_spec_free() function |
| ifx_lo_specget_estbytes() | Gets the estimated number of bytes from the LO-specification structure | The ifx_lo_specget_estbytes() function |
| ifx_lo_specget_extsz() | Gets the allocation extent size from the LO-specification structure | The ifx_lo_specget_extsz() function |
| ifx_lo_specget_flags() | Gets the create-time flags from the LO-specification structure | The ifx_lo_specget_flags() function |
| ifx_lo_specget_maxbytes() | Gets the maximum number of bytes from the LO-specification structure | The ifx_lo_specget_maxbytes() function |
| ifx_lo_specget_sbspace() | Gets the name of the sbspace from the LO-specification structure | The ifx_lo_specget_sbspace() function |
| ifx_lo_specset_estbytes() | Sets the estimated number of bytes from the LO-specification structure | The ifx_lo_specset_estbytes() function |
| ifx_lo_specset_extsz() | Sets the allocation extent size in the LO-specification structure | The ifx_lo_specset_extsz() function |
| ifx_lo_specset_flags() | Sets the create-time flags in the LO-specification structure | The ifx_lo_specset_flags() function |
| ifx_lo_specset_maxbytes() | Sets the maximum number of bytes in the LO-specification structure | The ifx_lo_specset_maxbytes() function |
| ifx_lo_specset_sbspace() | Sets the name of the sbspace in the LO-specification structure | The ifx_lo_specset_sbspace() function |
| ifx_lo_stat() | Returns status information about an open smart large object | The ifx_lo_stat() function |
| ifx_lo_stat_atime() | Returns the last access time for a smart large object | The ifx_lo_stat_atime() function |
| ifx_lo_stat_cspec() | Returns the storage characteristics into the LO-specification structure for a specified smart large object | The ifx_lo_stat_cspec() function |
| ifx_lo_stat_ctime() | Returns the last change-in-status time for the smart large object | The ifx_lo_stat_ctime() function |
| ifx_lo_stat_free() | Frees the resources allocated to an LO-status structure | The ifx_lo_stat_free() function |
| ifx_lo_stat_mtime_sec() | Returns the last modification time, in seconds, for the smart large object | The ifx_lo_stat_mtime_sec() function |
| ifx_lo_stat_refcnt() | Returns the reference count for the smart large object | The ifx_lo_stat_refcnt() function |
| ifx_lo_stat_size() | Returns the size of the smart large object | The ifx_lo_stat_size() function |
| ifx_lo_tell() | Returns the current seek position of an open smart large object | The ifx_lo_tell() function |
| ifx_lo_to_buffer | Copies bytes from a smart large object into a user-defined buffer | The ifx_lo_to_buffer() function |
| ifx_lo_truncate() | Truncates a smart large object to a specific offset | The ifx_lo_truncate() function |
| ifx_lo_write() | Writes a specified number of bytes to an open smart large object | The ifx_lo_write() function |
| ifx_lo_writewithseek() | Seeks to a specified position in an open smart large object and writes a specified number of bytes | The ifx_lo_writewithseek() function |
| ifx_lvar_alloc() | Specifies whether to allocate memory when fetching lvarchar data | The ifx_lvar_alloc() function |
| ifx_putenv() | Modifies or removes an existing environment variable or creates a new one | The ifx_putenv() function |
| ifx_var_alloc() | Allocates memory for the data buffer | The ifx_var_alloc() function |
| ifx_var_dealloc() | Deallocates memory for the data buffer | The ifx_var_dealloc() function |
| ifx_var_flag() | Determines whether or the application handles memory allocation for the data buffer | The ifx_var_flag() function |
| ifx_var_getdata() | Returns the contents of the data buffer | The ifx_var_getdata() function |
| ifx_var_getlen() | Returns the length of the data buffer | The ifx_var_getlen() function |
| ifx_var_isnull() | Checks whether the data in the data buffer is null | The ifx_var_isnull() function |
| ifx_var_setdata() | Sets the data for the data buffer | The ifx_var_setdata() function |
| ifx_var_setlen() | Sets the length of the data buffer | The ifx_var_setlen() function |
| ifx_var_setnull() | Sets the data in the data buffer to a null value | The ifx_var_setnull() function |
| incvasc() | Converts an ANSI-compliant character string to an interval value | The incvasc() function |
| incvfmtasc() | Converts a character string to an interval value | The incvfmtasc() function |
| intoasc() | Converts an interval value to an ANSI-compliant character string | The intoasc() function |
| intofmtasc() | Converts an interval value to a string | The intofmtasc() function |
| invdivdbl() | Divides an interval value by a numeric value | The invdivdbl() function |
| invdivinv() | Divides an interval value by an interval value | The invdivinv() function |
| invextend() | Copies an interval value under a different qualifier | The invextend() function |
| invmuldbl() | Multiplies an interval value by a numeric value | The invmuldbl() function |
| ldchar() | Copies a fixed-length string to a null-terminated string | The ldchar() function |
| rdatestr() | Converts an internal format to string | The rdatestr() function |
| rdayofweek() | Returns the day of the week | The rdayofweek() function |
| rdefmtdate() | Converts a string to an internal format | The rdefmtdate() function |
| rdownshift() | Converts all letters to lowercase | The rdownshift() function |
| ReleaseConnect() | Closes an established explicit connection | The ReleaseConnect() function (Windows) |
| rfmtdate() | Converts an internal format to a string | The rfmtdate() function |
| rfmtdec() | Converts a decimal type to a formatted string | ids_esqlc_0821.html#ids_esqlc_0821 |
| rfmtdouble() | Converts a double type to a string | ids_esqlc_0822.html#ids_esqlc_0822 |
| rfmtlong() | Converts an int4 to a formatted string | ids_esqlc_0823.html#ids_esqlc_0823 |
| rgetlmsg() | Retrieves the error message for a large error number | The rgetlmsg() function |
| rgetmsg() | Retrieves the error message for an error number | The rgetmsg() function |
| risnull() | Checks whether a C variable is null | The risnull() function |
| rjulmdy() | Returns month, day, and year from an internal format | The rjulmdy() function |
| rleapyear() | Determines whether a specified year is a leap year | The rleapyear() function |
| rmdyjul() | Returns an internal format from month, day, and year | The rmdyjul() function |
| rsetnull() | Sets a C variable to null | The rsetnull() function |
| rstod() | Converts a string to a double type | The rstod() function |
| rstoi() | Converts a null-terminated string to an int2 | The rstoi() function |
| rstol() | Converts a string to an int4 | The rstol() function |
| rstrdate() | Converts a string to an internal format | The rstrdate() function |
| rtoday() | Returns a system date in internal format | The rtoday() function |
| rtypalign() | Aligns data on a proper type boundary | The rtypalign() function |
| rtypmsize() | Gives the byte size of SQL data types | The rtypmsize() function |
| rtypname() | Returns the name of a specified SQL type | The rtypname() function |
| rtypwidth() | Gives minimum conversion byte size | The rtypwidth() function |
| rupshift() | Converts all letters to uppercase | The rtypmsize() function |
| SetConnect() | Switches the connection to an established (dormant) explicit connection | The SetConnect() function (Windows) |
| sqgetdbs() | Returns the names of the databases that a database server can access | The sqgetdbs() function |
| sqlbreak() | Sends the database server a request to stop processing | The sqlbreak() function |
| sqlbreakcallback() | Provides a method of returning control to the application while it is waiting for the database server to process an SQL request | The sqlbreakcallback() function |
| sqldetach() | Detaches a child process from a parent process | The sqldetach() function |
| sqldone() | Determines whether the database server is currently processing an SQL request | The sqldone() function |
| sqlexit() | Terminates a database server process | The sqlexit() function |
| sqlsignal() | Performs signal handling and child-processes cleanup | The sqlsignal() function |
| sqlstart() | Starts a database server process | The sqlstart() function |
| stcat() | Concatenates one string to another | The stcat() function |
| stchar() | Copies a null-terminated string to a fixed-length string | The stchar() function |
| stcmpr() | Compares two strings | The stcmpr() function |
| stcopy() | Copies one string to another string | The stcopy() function |
| stleng() | Counts the number of bytes in a string | The stleng() function |