#docslug#/obci/obci/V2.0.1/ds6ff5
OCIDateSysDate
Description : You can call this function to get the current system date and time of the client.
Function prototype :
sword OCIDateSysDate (
OCIError *err,
OCIDate *sys_date );
Parameters :
Parameter |
Description |
|---|---|
| err(IN/OUT) | An error handle. |
| sys_date(OUT) | The current system date and time of the client. |
Return value : OCI_SUCCESS if succeeded, or OCI_ERROR if failed.
OCIDateToText
Description : You can call this function to convert a date type to a character string.
Function prototype :
sword OCIDateToText (
OCIError *err,
const OCIDate *date,
const OraText *fmt,
ub1 fmt_length,
const OraText *lang_name,
ub4 lang_length,
ub4 *buf_size,
OraText *buf );
Parameters :
Parameter |
Description |
|---|---|
| err(IN/OUT) | An error handle. |
| date(IN) | The date to be converted. |
| fmt(IN) | The conversion format. If it is NULL and (text *) 0, the date is converted to a string in the default date format, which is DD-MON-YY. |
| fmt_length(IN) | The length of the fmt parameter. |
| lang_name(IN) | Specifies the language in which names and abbreviations for months and days are returned. The default language of the session is used if lang_name is NULL ((text *) 0). |
| lang_length(IN) | The length of the lang_name parameter. |
| buf_size(IN/OUT) | The size of the buffer (IN). The size of the resulting string is returned by using this parameter (OUT). |
| buf(OUT) | The buffer where the converted string is placed. |
Return value : OCI_SUCCESS if succeeded, or OCI_ERROR if failed.
OCIDateFromText
Description : You can call this function to convert a string to a date type in the specified format.
Function prototype :
sword OCIDateFromText (
OCIError *err,
const OraText *date_str,
ub4 d_str_length,
const OraText *fmt,
ub1 fmt_length,
const OraText *lang_name,
ub4 lang_length,
OCIDate *date );
Parameters :
Parameter |
Description |
|---|---|
| err(IN/OUT) | An error handle. |
| date_str(IN) | The date to be converted. |
| d_str_length(IN) | The size of the input string. The date_str parameter is considered as a string that ends with NULL if the length is -1. |
| fmt(IN) | The conversion format. If fmt is a NULL pointer, the string must be in DD-MON-YY format. |
| fmt_length(IN) | The length of the fmt parameter. |
| lang_name(IN) | Specifies the language in which names and abbreviations for months and days are returned. The default language of the session is used if lang_name is NULL. |
| lang_length(IN) | The length of the lang_name parameter. |
| date(OUT) | The given string that is converted to date. |
Return value : OCI_SUCCESS if succeeded, or OCI_ERROR if failed.
OCIDateTimeToText
Description : You can call this function to convert a given date to a string in the specified format.
Function prototype :
sword OCIDateTimeToText (
void *hndl,
OCIError *err,
const OCIDateTime *date,
const OraText *fmt,
ub1 fmt_length,
ub1 fsprec,
const OraText *lang_name,
size_t lang_length,
ub4 *buf_size,
OraText *buf );
Parameters :
Parameter |
Description |
|---|---|
| hndl(IN) | An OCI user session handle or environment handle. If the user session handle is passed in, the conversion takes place in NLS_LANGUAGE and NLS_CALENDAR of the session. Otherwise, the default value is used. |
| err(IN/OUT) | An error handle. |
| date(IN) | The date to be converted. |
| fmt(IN) | The conversion format. If fmt is a NULL pointer, the result must be in the default format of the DATETIME type. |
| fmt_length(IN) | The length of the fmt parameter. |
| fsprec(IN) | Specifies the fractional second precision. |
| lang_name(IN) | Specifies the language in which names and abbreviations for months and days are returned. The default language of the session is used if lang_name is NULL. |
| lang_length(IN) | The length of the lang_name parameter. |
| buf_size(IN/OUT) | The size of the buffer (IN). The size of the converted string (the result of the conversion) is returned (OUT). |
| buf(OUT) | The buffer where the converted string is placed. |
Return value : OCI_SUCCESS if succeeded, or OCI_ERROR if failed.
OCIDateTimeFromText
Description : You can call this function to convert a given string to the datetime type in the specified format.
Function prototype :
sword OCIDateTimeFromText (
void *hndl,
OCIError *err,
const OraText *date_str,
size_t dstr_length,
const OraText *fmt,
ub1 fmt_length,
const OraText *lang_name,
size_t lang_length,
OCIDateTime *datetime );
Parameters :
Parameter |
Description |
|---|---|
| hndl(IN) | An OCI user session handle or environment handle. If the user session handle is passed in, the conversion takes place in NLS_LANGUAGE and NLS_CALENDAR of the session. Otherwise, the default value is used. |
| err(IN/OUT) | An error handle. |
| date_str(IN) | The input string to be converted to Oracle datetime. |
| dstr_length(IN) | The size of the input string. The date_str parameter is considered as a string that ends with NULL if the length is -1. |
| fmt(IN) | The conversion format. If fmt is a NULL pointer, the result must be in the default format of the DATETIME type. |
| fmt_length(IN) | The length of the fmt parameter. |
| lang_name(IN) | Specifies the language in which names and abbreviations for months and days are returned. The default language of the session is used if lang_name is NULL. |
| lang_length(IN) | The length of the lang_name parameter. |
| datetime(OUT) | The given string that needs to be converted to date. |
Return value : OCI_SUCCESS if succeeded, or OCI_ERROR if failed.
OCIDateTimeConstruct
Description : You can call this function to construct a datetime descriptor.
Function prototype :
sword OCIDateTimeConstruct (
void *hndl,
OCIError *err,
OCIDateTime *datetime,
sb2 year,
ub1 month,
ub1 day,
ub1 hour,
ub1 min,
ub1 sec,
ub4 fsec,
OraText *timezone,
size_t timezone_length );
Parameters :
Parameter |
Description |
|---|---|
| hndl(IN) | An OCI user session handle or environment handle. If the user session handle is passed in, the conversion takes place in NLS_LANGUAGE and NLS_CALENDAR of the session. Otherwise, the default value is used. |
| err(IN/OUT) | An error handle. |
| datetime(IN) | The pointer to an OCIDateTime descriptor. |
| year(IN) | The value for year. |
| month(IN) | The value for month. |
| day(IN) | The value for day. |
| hour(IN) | The value for hour. |
| min(IN) | The value for minute. |
| sec(IN) | The value for second. |
| fsec(IN) | The value for fractional second. |
| timezone(IN) | Time zone string. The time zone offset of a particular time zone from GMT in the format of [[+|-][HH:MM]. For example: -08:00. |
| timezone_length(IN) | The length of the time zone string. |
Return value : OCI_SUCCESS if succeeded, or OCI_ERROR if failed.
OCIDateTimeGetTime
Description : You can call this function to fetch the time (including the values for hour, minute, second, and fractional second) out of a datetime value.
Function prototype :
void OCIDateTimeGetTime (
void *hndl,
OCIError *err,
OCIDateTime *datetime,
ub1 *hour,
ub1 *min,
ub1 *sec,
ub4 *fsec );
Parameters :
Parameter |
Description |
|---|---|
| hndl(IN) | An OCI user session handle or environment handle. If the user session handle is passed in, the conversion takes place in NLS_LANGUAGE and NLS_CALENDAR of the session. Otherwise, the default value is used. |
| err(IN/OUT) | An error handle. |
| datetime(IN) | The pointer to an OCIDateTime descriptor. |
| hour(OUT) | The value for hour. |
| min(OUT) | The value for minute. |
| sec(OUT) | The value for second. |
| fsec(OUT) | The value for fractional second. |
Return value : NULL.
OCIDateTimeGetDate
Description : You can call this function to fetch the date (including values for the year, month, and the day) out of a datetime value.
Function prototype :
void OCIDateTimeGetDate (
void *hndl,
OCIError *err,
const OCIDateTime *datetime,
sb2 *year,
ub1 *month,
ub1 *day );
Parameters :
Parameter |
Description |
|---|---|
| hndl(IN) | An OCI user session handle or environment handle. If the user session handle is passed in, the conversion takes place in NLS_LANGUAGE and NLS_CALENDAR of the session. Otherwise, the default value is used. |
| err(IN/OUT) | An error handle. |
| datetime(IN) | The pointer to an OCIDateTime descriptor. |
| year(OUT) | The value for year. |
| month(OUT) | The value for month. |
| day(OUT) | The value for day. |
Return value : NULL.
OCIDateTimeGetTimeZoneOffset
Description : You can call this function to fetch the time zone offset (including the values for hour and minute) out of a datetime value.
Function prototype :
void OCIDateTimeGetTimeZoneOffset (
void *hndl,
OCIError *err,
const OCIDateTime *datetime,
sb1 *hour,
sb1 *min);
Parameters :
Parameter |
Description |
|---|---|
| hndl(IN) | An OCI user session handle or environment handle. If the user session handle is passed in, the conversion takes place in NLS_LANGUAGE and NLS_CALENDAR of the session. Otherwise, the default value is used. |
| err(IN/OUT) | An error handle. |
| datetime(IN) | The pointer to an OCIDateTime descriptor. |
| hour(OUT) | The retrieved hour value in a time zone. |
| min(OUT) | The retrieved minute value in a time zone |
Return value : NULL.