Запросить указатель на вновь выделенную переменную типа numeric.

numeric *PGTYPESnumeric_new(void);

Освободить переменную типа numeric и высвободить всю занимаемую ей память.

void PGTYPESnumeric_free(numeric *var);

Выполнить синтаксический разбор типа numeric из его строкового представления.

numeric *PGTYPESnumeric_from_asc(char *str, char **endptr);

Допустимыми форматами являются, например: -2, .794, +3.44, 592.49E07 или -32.84e-4. Если синтаксический разбор значения прошел успешно, возвращается корректный указатель, в противном случае — указатель NULL. В настоящее время препроцессор ECPG всегда выполняет полный синтаксический анализ строки, поэтому сейчас он не поддерживает сохранение адреса первого недопустимого символа в *endptr. Вы можете безопасно установить параметр endptr в значение NULL.

Возвращает указатель на строку, выделенную при помощи функции malloc , которая содержит строковое представление значения типа numeric num.

char *PGTYPESnumeric_to_asc(numeric *num, int dscale);

Значение типа numeric будет выведено с количеством десятичных знаков dscale тип данных decimal цифр, с применением округления при необходимости. Результат должен быть освобожден с помощью функции PGTYPESchar_free().

Сложение двух переменных типа numeric и сохранение результата в третью.

int PGTYPESnumeric_add(numeric *var1, numeric *var2, numeric *result);

Функция складывает значения переменных var1 и var2 в результирующую переменную result. Функция возвращает 0 при успешном выполнении и -1 в случае ошибки.

Вычитание одной переменной типа numeric из другой с возвратом результата в третью переменную.

int PGTYPESnumeric_sub(numeric *var1, numeric *var2, numeric *result);

Функция вычитает значение переменной var2 из значения переменной var1. Результатом операции является сохраняется в переменной result. Функция возвращает 0 при успешном выполнении и -1 в случае ошибки.

Умножает две переменные типа numeric и возвращает результат в третьей переменной.

int PGTYPESnumeric_mul(numeric *var1, numeric *var2, numeric *result);

Данная функция перемножает значения переменных var1 и var2. Результат операции сохраняется в переменной переменная result. Функция возвращает 0 при успешном выполнении и -1 в случае ошибки.

Делит две переменные типа numeric и возвращает результат в третьей переменной.

int PGTYPESnumeric_div(numeric *var1, numeric *var2, numeric *result);

Данная функция делит значение переменной var1 на var2. Результат операции сохраняется в переменной переменная result. Функция возвращает 0 при успешном выполнении и -1 в случае ошибки.

Сравнивает две переменные типа numeric.

int PGTYPESnumeric_cmp(numeric *var1, numeric *var2)

Данная функция сравнивает две переменные типа numeric. В случае ошибки INT_MAX возвращается значение. При успешном выполнении функция возвращает один из трех возможных результатов:

Преобразование переменной типа int в переменную типа numeric.

int PGTYPESnumeric_from_int(signed int int_val, numeric *var);

Эта функция принимает переменную типа signed int и сохраняет её значение в переменную типа numeric var. При успешном выполнении возвращается 0, а -1 — в случае ошибки.

Преобразование переменной типа long int в переменную типа numeric.

int PGTYPESnumeric_from_long(signed long int long_val, numeric *var);

Эта функция принимает переменную типа signed long int и сохраняет её значение в переменную типа numeric var. При успешном выполнении возвращается 0, а -1 — в случае ошибки.

Копирование одной переменной типа numeric в другую.

int PGTYPESnumeric_copy(numeric *src, numeric *dst);

Эта функция копирует значение переменной src указывает на переменную, в которую dst указывает. Функция возвращает 0 в случае успеха и -1 при возникновении ошибки.

Преобразование переменной типа данных double в тип numeric.

int  PGTYPESnumeric_from_double(double d, numeric *dst);

Эта функция принимает переменную типа данных double и сохраняет результат в переменную, на которую dst указывает параметр. Функция возвращает 0 в случае успеха и -1 при возникновении ошибки.

Преобразование переменной типа numeric в тип данных double.

int PGTYPESnumeric_to_double(numeric *nv, double *dp)

Функция преобразует значение типа numeric из переменной, на которую nv указывает, в переменную типа данных double, на которую dp указывает параметр. Функция возвращает 0 в случае успеха и -1 при возникновении ошибки, включая переполнение. При переполнении глобальная переменная errno принимает значение в PGTYPES_NUM_OVERFLOW дополнительно.

Преобразование переменной типа тип numeric в тип int.

int PGTYPESnumeric_to_int(numeric *nv, int *ip);

Функция преобразует значение типа numeric из переменной, на которую nv указывает, в целочисленную переменную, на которую указывает параметр ip . Функция возвращает 0 в случае успеха и -1 при возникновении ошибки, включая переполнение. При переполнении глобальная переменная errno принимает значение в PGTYPES_NUM_OVERFLOW дополнительно.

Преобразование переменной типа тип numeric в тип long.

int PGTYPESnumeric_to_long(numeric *nv, long *lp);

Функция преобразует значение типа numeric из переменной, на которую nv указывает, в переменную типа long integer, на которую указывает параметр lp . Функция возвращает 0 в случае успеха и -1 при возникновении ошибки, включая переполнение и потерю значимости. При переполнении глобальная переменная errno будет установлено в PGTYPES_NUM_OVERFLOW и при потере значимости errno будет установлено в PGTYPES_NUM_UNDERFLOW.

Преобразование переменной типа numeric в тип данных decimal.

int PGTYPESnumeric_to_decimal(numeric *src, decimal *dst);

Функция преобразует значение типа numeric из переменной, на которую src указывает на переменную типа данных decimal, в которую dst . Функция возвращает 0 в случае успеха и -1 при возникновении ошибки, происходит, включая переполнение. При переполнении глобальная переменная errno будет установлено в PGTYPES_NUM_OVERFLOW дополнительно.

Преобразование переменной типа данных decimal в тип numeric.

int PGTYPESnumeric_from_decimal(decimal *src, numeric *dst);

Данная функция преобразует значение типа данных decimal из переменной, на которую src указывает указатель, в переменную типа numeric, на которую dst . Функция возвращает 0 в случае успеха и -1 при возникновении ошибки, происходит. Поскольку тип данных decimal реализован как ограниченная версия типа numeric, переполнение при данном преобразовании невозможно.

Извлечение даты из значения типа timestamp.

date PGTYPESdate_from_timestamp(timestamp dt);

Функция принимает значение timestamp в качестве единственного аргумента и возвращает извлеченную дату из этого значения.

Разбор даты из ее текстового представления.

date PGTYPESdate_from_asc(char *str, char **endptr);

Функция принимает строку (тип char* в языке C) str и указатель на строку (тип char* в языке C) endptr. В настоящий момент препроцессор ECPG всегда выполняет разбор всей строки целиком, поэтому сейчас он не поддерживает сохранение адреса первого недопустимого символа в *endptr. Вы можете безопасно установить параметр endptr в значение NULL.

Обратите внимание, что функция всегда предполагает использование формата даты MDY, и в настоящее время в препроцессоре ECPG нет переменной для изменения этой настройки.

Таблица 4.3.2 показывает допустимые форматы ввода.

Возврат текстового представления переменной типа date.

char *PGTYPESdate_to_asc(date dDate);

Данная функция принимает значение даты dDate в качестве единственного параметра. Она возвращает дату в виде строки 1999-01-18, то есть в YYYY-MM-DD формате. Результат должен быть освобожден с помощью функции PGTYPESchar_free().

Извлечение значений дня, месяца и года из переменной типа date.

void PGTYPESdate_julmdy(date d, int *mdy);

Данная функция принимает значение даты d и указатель на массив из трех целочисленных значений mdy. Имя переменной указывает на последовательный порядок: mdy[0] будет содержать порядковый номер месяца, mdy[1] будет содержать значение дня, а mdy[2] будет содержать значение года.

Создает значение даты из массива из 3 целых чисел, которые задают день, месяц и год даты.

void PGTYPESdate_mdyjul(int *mdy, date *jdate);

Функция принимает массив из 3 целых чисел (mdy) в качестве первого аргумента, а в качестве второго — указатель на переменную типа date, в которой должен быть сохранен результат операции.

Возвращает число, представляющее день недели для заданного значения даты.

int PGTYPESdate_dayofweek(date d);

Функция принимает переменную типа date d в качестве единственного аргумента и возвращает целое число, обозначающее день недели для этой даты.

Получение текущей даты.

void PGTYPESdate_today(date *d);

Функция PGTYPESdate_today принимает указатель на переменную типа date (d) которую она устанавливает равной текущей дате.

Преобразование переменной типа date в её текстовое представление с использованием маска формата.

int PGTYPESdate_fmt_asc(date dDate, char *fmtstring, char *outbuf);

Функция принимает дату для преобразования (dDate), the маску формата (fmtstring) и строку, которая будет содержать текстовое представление даты (outbuf).

При успешном завершении возвращается 0, при возникновении ошибки — отрицательное значение.

Для спецификации полей можно использовать следующие литералы:

Все остальные символы копируются в выходную строку без изменений (1:1).

Таблица 4.3.3 указывает несколько возможных форматов. Это даст представление о том, как использовать данную функцию. Все выходные строки сформированы на основе одной и той же даты: 23 ноября 1959 года.

Используйте маску формата для преобразования строки C char* в значение типа данных date.

int PGTYPESdate_defmt_asc(date *d, char *fmt, char *str);

Функция принимает указатель на значение даты, которое должно содержать результат операции (d), маску формата, используемую для разбора даты (fmt) и строку типа char* в языке C, содержащую текстовое представление даты (str). Текстовое представление должно соответствовать маске формата. При этом нет необходимости в строгом соответствии 1:1 строки и маски формата. Данная функция анализирует только последовательность и ищет литералы, yy или yyyy которые определяют позицию года, mm для указания позиции месяца и dd для указания позиции дня.

Таблица 4.3.4 указывает несколько возможных форматов. Это даст вам представление о том, как использовать данную функцию.

Выполняет синтаксический анализ метки времени из её текстового представления в переменную типа timestamp.

timestamp PGTYPEStimestamp_from_asc(char *str, char **endptr);

Функция принимает строку для анализа (str) и указатель на тип char* в языке C (endptr). В настоящий момент препроцессор ECPG всегда выполняет разбор всей строки целиком, поэтому сейчас он не поддерживает сохранение адреса первого недопустимого символа в *endptr. Вы можете безопасно установить параметр endptr в значение NULL.

В случае успешного выполнения функция возвращает полученную метку времени. В случае ошибки возвращается PGTYPESInvalidTimestamp возвращается, а параметр errno принимает значение устанавливается в PGTYPES_TS_BAD_TIMESTAMP. См. раздел PGTYPESInvalidTimestamp для ознакомления с важными примечаниями по данному значению.

В общем случае входная строка может содержать любую комбинацию допустимой спецификации даты, пробельного символа и допустимой спецификации времени. Обратите внимание, что препроцессор ECPG не поддерживает часовые пояса. Он может выполнять их синтаксический анализ, но не производит никаких вычислений, которые, Digital Q.DataBase например, выполняет сервер. Спецификаторы часовых поясов игнорируются без вывода предупреждений.

Таблица 4.3.5 содержит несколько примеров входных строк.

Преобразует дату в строку типа char* в языке C.

char *PGTYPEStimestamp_to_asc(timestamp tstamp);

Функция принимает временную метку tstamp в качестве единственного аргумента и возвращает выделенную строку, содержащую текстовое представление временной метки. Результат должен быть освобожден с помощью функции PGTYPESchar_free().

Получение текущей временной метки.

void PGTYPEStimestamp_current(timestamp *ts);

Функция считывает текущую временную метку и сохраняет её в переменную типа timestamp, на которую ts указывает.

Преобразование переменной типа timestamp в строку типа char* в языке C с использованием маски формата.

int PGTYPEStimestamp_fmt_asc(timestamp *ts, char *output, int str_len, char *fmtstr);

Функция принимает указатель на преобразуемую временную метку в качестве первого аргумента (ts), указатель на выходной буфер (вывод), максимальная длина, выделенная для выходного буфера (str_len) и маска формата для использования при преобразовании (fmtstr).

В случае успеха функция возвращает 0, а если возникла ошибка — отрицательное значение.

Для маски формата можно использовать следующие спецификаторы формата. Эти спецификаторы формата идентичны тем, что используются в strftime функции из libc. Любой символ, не являющийся спецификатором формата, будет скопирован в выходной буфер.

Вычитает одно значение timestamp из другого и сохраняет результат в переменную типа данных interval.

int PGTYPEStimestamp_sub(timestamp *ts1, timestamp *ts2, interval *iv);

Данная функция вычитает значение переменной типа timestamp, на которую ts2 указывает параметр, из значения переменной типа timestamp, на которую ts1 указывает параметр, и сохраняет результат в переменной типа данных interval, на которую iv указывает параметр.

В случае успеха функция возвращает 0, а если возникла ошибка — отрицательное значение.

Выполняет разбор значения метки времени из его текстового представления с использованием маски форматирования.

int PGTYPEStimestamp_defmt_asc(char *str, char *fmt, timestamp *d);

Функция получает текстовое представление метки времени в параметре переменная str а также маску форматирования для использования в параметре переменная fmt. Результат будет сохранен в переменной которая d указывает.

Если маска форматирования fmt имеет значение NULL, функция вернется к маске форматирования по умолчанию, а именно %Y-%m-%d %H:%M:%S.

Данная функция является обратной по отношению к функции PGTYPEStimestamp_fmt_asc. Обратитесь к документации по указанной функции, чтобы ознакомиться с возможными элементами маски форматирования.

Прибавляет значение переменной типа данных interval к переменной метки времени.

int PGTYPEStimestamp_add_interval(timestamp *tin, interval *span, timestamp *tout);

Функция получает указатель на переменную метки времени tin и указатель на переменную типа данных interval span. Она добавляет значение типа данных interval к значению типа timestamp и сохраняет полученный результат в переменную, на которую указывает параметр tout указывает.

В случае успеха функция возвращает 0, а если возникла ошибка — отрицательное значение.

Вычитание значения переменной типа данных interval из значения переменной типа timestamp.

int PGTYPEStimestamp_sub_interval(timestamp *tin, interval *span, timestamp *tout);

Данная функция вычитает значение переменной типа данных interval, на которую указывает параметр span указывает параметр, из значения переменной типа timestamp, на которую tin указывает параметр, и сохраняет результат в переменную, на которую указывает параметр tout указывает указывает параметр.

В случае успеха функция возвращает 0, а если возникла ошибка — отрицательное значение.

Возвращает указатель на новую выделенную переменную типа данных interval.

interval *PGTYPESinterval_new(void);

Освобождает память, ранее выделенную для переменной типа данных interval.

void PGTYPESinterval_free(interval *intvl);

Выполняет разбор значения типа данных interval из его текстового представления.

interval *PGTYPESinterval_from_asc(char *str, char **endptr);

Функция анализирует входную строку str и возвращает указатель на выделенную переменную типа данных interval. В настоящий момент препроцессор ECPG всегда выполняет разбор всей строки целиком, поэтому сейчас он не поддерживает сохранение адреса первого недопустимого символа в *endptr. Вы можете безопасно установить параметр endptr в значение NULL.

Преобразует переменную типа данных interval в её текстовое представление.

char *PGTYPESinterval_to_asc(interval *span);

Функция преобразует переменную типа данных interval, на которую span указывает параметр, в тип char* в языке C. Выходные данные выглядят как в этом примере: @ 1 day 12 hours 59 mins 10 secs. Результат должен быть освобожден с помощью функции PGTYPESchar_free().

Копирует переменную типа данных interval.

int PGTYPESinterval_copy(interval *intvlsrc, interval *intvldest);

Функция копирует переменную типа данных interval, на которую intvlsrc указывает, в переменную, на которую intvldest указывает. Примечание что необходимо выделить память для целевой переменной заранее.

Запросить указатель на новую выделенную переменную типа данных decimal.

decimal *PGTYPESdecimal_new(void);

Удалить тип данных decimal, освободив всю занимаемую им память.

void PGTYPESdecimal_free(decimal *var);

Аргумент должен содержать переменную типа numeric (или указывать на переменную типа numeric), но её фактическое представление в памяти оказалось недопустимым.

Произошло переполнение. Поскольку тип numeric позволяет работать с практически произвольной точностью, преобразование переменной типа numeric в другие типы может привести к переполнению.

Произошло антипереполнение. Поскольку тип numeric позволяет работать с практически произвольной точностью, преобразование переменной типа numeric в другие типы может привести к антипереполнению.

Была предпринята попытка деления на ноль.

В функцию была передана PGTYPESdate_from_asc недопустимая строка даты.

В функцию были переданы недопустимые аргументы. PGTYPESdate_defmt_asc недопустимая строка даты.

Во входной строке обнаружен недопустимый токен функцией PGTYPESdate_defmt_asc недопустимая строка даты.

В функцию была передана недопустимая строка типа данных interval, либо PGTYPESinterval_from_asc в функцию было передано недопустимое значение типа данных interval. PGTYPESinterval_to_asc недопустимая строка даты.

Обнаружено несоответствие при назначении дня/месяца/года в функции PGTYPESdate_defmt_asc недопустимая строка даты.

Обнаружено недопустимое значение дня месяца в была передана PGTYPESdate_defmt_asc недопустимая строка даты.

Обнаружено недопустимое значение месяца в была передана PGTYPESdate_defmt_asc недопустимая строка даты.

В функцию передана недопустимая строка метки времени была передана PGTYPEStimestamp_from_asc функция, или функции передано недопустимое значение метки времени была передана PGTYPEStimestamp_to_asc недопустимая строка даты.

Обнаружено бесконечное значение метки времени в контексте, который не может его обработать.

Значение типа timestamp, представляющее недопустимую метку времени. Оно возвращается функцией PGTYPEStimestamp_from_asc при ошибке разбора. Обратите внимание, что из-за внутреннего представления timestamp типа данных, PGTYPESInvalidTimestamp также является допустимой меткой времени в то же время. Оно установлено в 1899-12-31 23:59:59. Чтобы обнаружить ошибки, убедитесь, что ваше приложение проверяет не только для PGTYPESInvalidTimestamp но также и для errno != 0 после каждого вызова функции PGTYPEStimestamp_from_asc.