1<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [ 2 3<!-- Process this file with docbook-to-man to generate an nroff manual 4 page: `docbook-to-man manpage.sgml > manpage.1'. You may view 5 the manual page with: `docbook-to-man manpage.sgml | nroff -man | 6 less'. A typical entry in a Makefile or Makefile.am is: 7 8manpage.1: manpage.sgml 9 docbook-to-man $< > $@ 10 11 12 The docbook-to-man binary is found in the docbook-to-man package. 13 Please remember that if you create the nroff version in one of the 14 debian/rules file targets (such as build), you will need to include 15 docbook-to-man in your Build-Depends control field. 16 17 --> 18 19 <!-- Fill in your name for FIRSTNAME and SURNAME. --> 20 <!ENTITY dhfirstname "<firstname>UWE</firstname>"> 21 <!ENTITY dhsurname "<surname>STEINMANN</surname>"> 22 <!-- Please adjust the date whenever revising the manpage. --> 23 <!ENTITY dhdate "<date>August 29, 2005</date>"> 24 <!-- SECTION should be 1-8, maybe w/ subsection other parameters are 25 allowed: see man(7), man(1). --> 26 <!ENTITY dhsection "<manvolnum>3</manvolnum>"> 27 <!ENTITY dhemail "<email>uwe@steinmann.cx</email>"> 28 <!ENTITY dhusername "Uwe Steinmann"> 29 <!ENTITY dhucpackage "<refentrytitle>PX_GET_DATA_BCD</refentrytitle>"> 30 <!ENTITY funcname "PX_get_data_bcd"> 31 32 <!ENTITY debian "<productname>Debian</productname>"> 33 <!ENTITY gnu "<acronym>GNU</acronym>"> 34 <!ENTITY gpl "&gnu; <acronym>GPL</acronym>"> 35]> 36 37<refentry> 38 <refentryinfo> 39 <address> 40 &dhemail; 41 </address> 42 <author> 43 &dhfirstname; 44 &dhsurname; 45 </author> 46 <copyright> 47 <year>2003</year> 48 <holder>&dhusername;</holder> 49 </copyright> 50 &dhdate; 51 </refentryinfo> 52 <refmeta> 53 &dhucpackage; 54 55 &dhsection; 56 </refmeta> 57 <refnamediv> 58 <refname>&funcname;</refname> 59 60 <refpurpose>Get bcd data field</refpurpose> 61 </refnamediv> 62 <refsynopsisdiv> 63 <para>#include <paradox.h></para> 64 <para>int &funcname;(pxdoc_t *pxdoc, char *data, int len, char **value)</para> 65 </refsynopsisdiv> 66 <refsect1> 67 <title>DESCRIPTION</title> 68 69 <para>Converts a data field as it stored in the database file into 70 a bcd string. The string will not be longer than 20 chars including 71 the final 0. It contains only the characters `+', `-', `0-9', and `.'. 72 You should use this function 73 instead of accessing the data directly.</para> 74 <para><option>data</option> points to the start of the data field in the 75 record. It must be calculated by summing up all field length before 76 the field to operate on and add it to the base pointer of the 77 record. <option>len</option> is the number of digits after the decimal 78 point.</para> 79 <para>The function allocates memory for the string returned in 80 <option>*value</option>. This memory has to be freed by the application. 81 </para> 82 <note><para>This function is deprecated and obsolete if 83 <function>PX_retrieve_record(3)</function> is used.</para></note> 84 85 </refsect1> 86 <refsect1> 87 <title>RETURN VALUE</title> 88 <para>Returns 0 if the value is NULL, -1 in case of an error and 1 89 otherwise.</para> 90 </refsect1> 91 <refsect1> 92 <title>SEE ALSO</title> 93 94 <para>PX_get_data_alpha(3), PX_get_data_byte(3), PX_get_data_long(3), PX_get_data_short(3), PX_get_data_double(3)</para> 95 96 </refsect1> 97 <refsect1> 98 <title>AUTHOR</title> 99 100 <para>This manual page was written by &dhusername; &dhemail;.</para> 101 102 </refsect1> 103</refentry> 104 105<!-- Keep this comment at the end of the file 106Local variables: 107mode: sgml 108sgml-omittag:t 109sgml-shorttag:t 110sgml-minimize-attributes:nil 111sgml-always-quote-attributes:t 112sgml-indent-step:2 113sgml-indent-data:t 114sgml-parent-document:nil 115sgml-default-dtd-file:nil 116sgml-exposed-tags:nil 117sgml-local-catalogs:nil 118sgml-local-ecat-files:nil 119End: 120--> 121 122 123