|
2244.1.1
by Monty Taylor
Split libdrizzle into 1.0 and 2.0. Applied the C++ changes to 2.0 branch. |
1 |
/*
|
2 |
* Drizzle Client & Protocol Library
|
|
3 |
*
|
|
4 |
* Copyright (C) 2008 Eric Day (eday@oddments.org)
|
|
5 |
* All rights reserved.
|
|
6 |
*
|
|
7 |
* Redistribution and use in source and binary forms, with or without
|
|
8 |
* modification, are permitted provided that the following conditions are
|
|
9 |
* met:
|
|
10 |
*
|
|
11 |
* * Redistributions of source code must retain the above copyright
|
|
12 |
* notice, this list of conditions and the following disclaimer.
|
|
13 |
*
|
|
14 |
* * Redistributions in binary form must reproduce the above
|
|
15 |
* copyright notice, this list of conditions and the following disclaimer
|
|
16 |
* in the documentation and/or other materials provided with the
|
|
17 |
* distribution.
|
|
18 |
*
|
|
19 |
* * The names of its contributors may not be used to endorse or
|
|
20 |
* promote products derived from this software without specific prior
|
|
21 |
* written permission.
|
|
22 |
*
|
|
23 |
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
24 |
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
25 |
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
26 |
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
27 |
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
28 |
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
29 |
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
30 |
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
31 |
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
32 |
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
33 |
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
34 |
*
|
|
35 |
*/
|
|
36 |
||
37 |
/**
|
|
38 |
* @file
|
|
39 |
* @brief Field Declarations for Clients
|
|
40 |
*/
|
|
41 |
||
42 |
#ifndef __DRIZZLE_FIELD_CLIENT_H
|
|
43 |
#define __DRIZZLE_FIELD_CLIENT_H
|
|
44 |
||
45 |
#ifdef __cplusplus
|
|
46 |
extern "C" { |
|
47 |
#endif
|
|
48 |
||
49 |
/**
|
|
50 |
* @addtogroup drizzle_field_client Field Declarations for Clients
|
|
51 |
* @ingroup drizzle_client_interface
|
|
52 |
*
|
|
53 |
* These functions allow you to access fields in a result set if the result is
|
|
54 |
* unbuffered. If the result is buffered, you can access the fields through the
|
|
55 |
* row functions.
|
|
56 |
* @{
|
|
57 |
*/
|
|
58 |
||
59 |
/**
|
|
60 |
* Read field for unbuffered result, possibly in parts. This is especially
|
|
61 |
* useful for blob streaming, since the client does not need to buffer the
|
|
62 |
* entire blob.
|
|
63 |
*/
|
|
64 |
DRIZZLE_API
|
|
65 |
drizzle_field_t drizzle_field_read(drizzle_result_st *result, size_t *offset, |
|
66 |
size_t *size, size_t *total, |
|
67 |
drizzle_return_t *ret_ptr); |
|
68 |
||
69 |
/**
|
|
70 |
* Buffer one field.
|
|
71 |
*/
|
|
72 |
DRIZZLE_API
|
|
73 |
drizzle_field_t drizzle_field_buffer(drizzle_result_st *result, size_t *total, |
|
74 |
drizzle_return_t *ret_ptr); |
|
75 |
||
76 |
/**
|
|
77 |
* Free a buffered field.
|
|
78 |
*/
|
|
79 |
DRIZZLE_API
|
|
80 |
void drizzle_field_free(drizzle_field_t field); |
|
81 |
||
82 |
/** @} */
|
|
83 |
||
84 |
#ifdef __cplusplus
|
|
85 |
}
|
|
86 |
#endif
|
|
87 |
||
88 |
#endif /* __DRIZZLE_FIELD_CLIENT_H */ |