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
|
/*
* Drizzle Client & Protocol Library
*
* Copyright (C) 2008-2013 Drizzle Developer Group
* Copyright (C) 2008 Eric Day (eday@oddments.org)
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
*
* * The names of its contributors may not be used to endorse or
* promote products derived from this software without specific prior
* written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*/
#pragma once
/**
* @file
* @brief Column Declarations for Clients
*/
#ifdef __cplusplus
extern "C" {
#endif
/**
* @addtogroup drizzle_column_client Column Declarations for Clients
* @ingroup drizzle_client_interface
*
* These functions are used to get detailed column information. This information
* is usually sent as the first part of a result set. There are both buffered
* and unbuffered functions provided.
* @{
*/
/**
* Skip a column in result.
*/
DRIZZLE_API
drizzle_return_t drizzle_column_skip(drizzle_result_st *result);
/**
* Skip all columns in a result
*/
DRIZZLE_API
drizzle_return_t drizzle_column_skip_all(drizzle_result_st *result);
/**
* Read column information.
*
* @param[in,out] result pointer to the structure to read from.
* @param[out] ret_ptr Standard libdrizzle return value.
* @return column if there is valid data, NULL if there are no more columns.
*/
DRIZZLE_API
drizzle_column_st *drizzle_column_read(drizzle_result_st *result,
drizzle_return_t *ret_ptr);
/**
* Buffer all columns in result structure.
*/
DRIZZLE_API
drizzle_return_t drizzle_column_buffer(drizzle_result_st *result);
/**
* Get next buffered column from a result structure.
*/
DRIZZLE_API
drizzle_column_st *drizzle_column_next(drizzle_result_st *result);
/**
* Get previous buffered column from a result structure.
*/
DRIZZLE_API
drizzle_column_st *drizzle_column_prev(drizzle_result_st *result);
/**
* Seek to the given buffered column in a result structure.
*/
DRIZZLE_API
void drizzle_column_seek(drizzle_result_st *result, uint16_t column);
/**
* Get the given buffered column from a result structure.
*/
DRIZZLE_API
drizzle_column_st *drizzle_column_index(drizzle_result_st *result,
uint16_t column);
/**
* Get current column number in a buffered or unbuffered result.
*/
DRIZZLE_API
uint16_t drizzle_column_current(drizzle_result_st *result);
/** @} */
#ifdef __cplusplus
}
#endif
|