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