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_GRAPHIC</refentrytitle>">
30  <!ENTITY funcname    "PX_get_data_graphic">
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>2004-2005</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 graphic data field</refpurpose>
61  </refnamediv>
62  <refsynopsisdiv>
63    <para>#include &lt;paradox.h&gt;</para>
64		<para>int &funcname;(pxdoc_t *pxdoc, char *data, int len, int *mod, int *blobsize, char **value)</para>
65  </refsynopsisdiv>
66  <refsect1>
67    <title>DESCRIPTION</title>
68
69    <para>Reads a graphic data field. This function may be used only for
70		  blobs of type pxfGraphic.</para>
71		<para><option>data</option> points to the start of the data field in the
72		  record. It must be calculated by summing up all field length before
73			the field to operate on and add it to the base pointer of the
74			record. You should use this function instead of accessing the data
75			directly.</para>
76		<para>&funcname; returns blob data stored in the record itself, or in
77		  an MB files which must have been set with
78			<function>PX_set_blob_file(3)</function>.</para>
79		<para>The function allocates memory for the data returned in
80		  <option>*value</option>. This memory has to be freed by the application.
81			The amount of memory for the blob is returned in
82			<option>*blobsize</option>. <option>*mod</option> returns the so called
83			modification number of the blob which can often be used as an unique
84			id for creating file names, if the data is saved in a file.
85			</para>
86		<note><para>This function is deprecated and obsolete if
87		  <function>PX_retrieve_record(3)</function> is used.</para></note>
88
89  </refsect1>
90  <refsect1>
91    <title>RETURN VALUE</title>
92    <para>Returns 0 if the value is NULL, -1 in case of an error and 1
93		  otherwise.</para>
94  </refsect1>
95  <refsect1>
96    <title>SEE ALSO</title>
97
98    <para>PX_get_data_blob(3), PX_get_data_bcd(3), PX_get_data_byte(3), PX_get_data_long(3), PX_get_data_short(3), PX_get_data_double(3), PX_get_data_byte(3), PX_get_data_bytes(3)</para>
99
100  </refsect1>
101  <refsect1>
102    <title>AUTHOR</title>
103
104    <para>This manual page was written by &dhusername; &dhemail;.</para>
105
106  </refsect1>
107</refentry>
108
109<!-- Keep this comment at the end of the file
110Local variables:
111mode: sgml
112sgml-omittag:t
113sgml-shorttag:t
114sgml-minimize-attributes:nil
115sgml-always-quote-attributes:t
116sgml-indent-step:2
117sgml-indent-data:t
118sgml-parent-document:nil
119sgml-default-dtd-file:nil
120sgml-exposed-tags:nil
121sgml-local-catalogs:nil
122sgml-local-ecat-files:nil
123End:
124-->
125