Home
Extending HCL OneDB™Beyond standard relational database objects, HCL OneDB™ can be extended to handle specialized data types, access methods, routines, and other objects. HCL OneDB™ includes many built-in extensions that are fully integrated in the database server. HCL OneDB™ also provides DataBlade® modules, which are packages of extended database objects for a particular purpose and that are installed separately from the database server. Alternatively, you can create your own user-defined objects for HCL OneDB™.
Creating extensionsYou can create user-defined data types, routines, access methods, and other database objects to suit your needs. You can use application programming interfaces to write user-defined routines and applications that access data in HCL OneDB™ databases.
DataBlade® API Function ReferenceThe HCL OneDB™ DataBlade® API Function Reference describes the DataBlade® API functions and the subset of functions that the DataBlade® API supports.
Function descriptionsThis section gives comprehensive reference information about the functions that are valid within DataBlade® API modules. It lists the function descriptions in alphabetical order, with syntax, usage information, and return values for the functions.
The rstrdate() functionThe rstrdate() function converts a character string to an internal DATE.

The rstrdate() function

The rstrdate() function converts a character string to an internal DATE.

Syntax

mint rstrdate(inbuf, jdate)
   char *inbuf;
   int4 *jdate;

inbuf: A pointer to the string that contains the date to convert.
jdate: A pointer to an int4 variable to contain the internal DATE value for the inbuf string.

Usage

For the default locale, U.S. English, the rstrdate() function determines how to format the character string with the following precedence:

The format that the DBDATE environment variable specifies (if DBDATE is set)
For more information, see the HCL OneDB™ Guide to SQL: Reference.
The format that the GL_DATE environment variable specifies (if GL_DATE is set)
For more information, see the HCL OneDB GLS User's Guide.
The default date form: mm/dd/yyyy
You can use any nonnumeric character as a separator between the month, day, and year. You can express the year as four digits (2007) or as two digits (95).

For GLS, when you use a nondefault locale and do not set the DBDATE or GL_DATE environment variable, rstrdate() uses the date end-user format that the client locale defines. For more information, see the HCL OneDB GLS User's Guide.

When you use a two-digit year in the date string, the rstrdate() function uses the value of the DBCENTURY environment variable to determine which century to use. If you do not set DBCENTURY, rstrdate() assumes the current century for two-digit years. For information about how to set DBCENTURY, see the HCL OneDB Guide to SQL: Reference.

Return values

0: The conversion was successful.
< 0: The conversion failed.
-1204: The inbuf parameter specifies an invalid year.
-1205: The inbuf parameter specifies an invalid month.
-1206: The inbuf parameter specifies an invalid day.
-1212: Data conversion format must contain a month, day, or year component. DBDATE specifies the data conversion format.
-1218: The date specified by the inbuf argument does not properly represent a date.