2
* Drizzle Client & Protocol Library
4
* Copyright (C) 2008 Eric Day (eday@oddments.org)
7
* Redistribution and use in source and binary forms, with or without
8
* modification, are permitted provided that the following conditions are
11
* * Redistributions of source code must retain the above copyright
12
* notice, this list of conditions and the following disclaimer.
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
19
* * The names of its contributors may not be used to endorse or
20
* promote products derived from this software without specific prior
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.
40
* @brief Column Declarations for Clients
43
#ifndef __DRIZZLE_COLUMN_CLIENT_H
44
#define __DRIZZLE_COLUMN_CLIENT_H
51
* @addtogroup drizzle_column_client Column Declarations for Clients
52
* @ingroup drizzle_client_interface
54
* These functions are used to get detailed column information. This information
55
* is usually sent as the first part of a result set. There are both buffered
56
* and unbuffered functions provided.
61
* Skip all columns in result.
64
drizzle_return_t drizzle_column_skip(drizzle_result_st *result);
67
* Read column information.
69
* @param[in,out] result pointer to the structure to read from.
70
* @param[out] column pointer to the structure to contain the information.
71
* @param[out] ret_ptr Standard libdrizzle return value.
72
* @return column if there is valid data, NULL if there are no more columns.
75
drizzle_column_st *drizzle_column_read(drizzle_result_st *result,
76
drizzle_column_st *column,
77
drizzle_return_t *ret_ptr);
80
* Buffer all columns in result structure.
83
drizzle_return_t drizzle_column_buffer(drizzle_result_st *result);
86
* Get next buffered column from a result structure.
89
drizzle_column_st *drizzle_column_next(drizzle_result_st *result);
92
* Get previous buffered column from a result structure.
95
drizzle_column_st *drizzle_column_prev(drizzle_result_st *result);
98
* Seek to the given buffered column in a result structure.
101
void drizzle_column_seek(drizzle_result_st *result, uint16_t column);
104
* Get the given buffered column from a result structure.
107
drizzle_column_st *drizzle_column_index(drizzle_result_st *result,
111
* Get current column number in a buffered or unbuffered result.
114
uint16_t drizzle_column_current(drizzle_result_st *result);
122
#endif /* __DRIZZLE_COLUMN_CLIENT_H */
added
removed
libdrizzle-2.0/libdrizzle/column_client.h
