← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to libdrizzle/column_client.h

Reverted 1103

Show diffs side-by-side

added added

removed removed

Lines of Context:
libdrizzle/column_client.h
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
 
/**
39
 
 * @file
40
 
 * @brief Column Declarations for Clients
41
 
 */
42
 
 
43
 
#ifndef __DRIZZLE_COLUMN_CLIENT_H
44
 
#define __DRIZZLE_COLUMN_CLIENT_H
45
 
 
46
 
#ifdef __cplusplus
47
 
extern "C" {
48
 
#endif
49
 
 
50
 
/**
51
 
 * @addtogroup drizzle_column_client Column Declarations for Clients
52
 
 * @ingroup drizzle_client_interface
53
 
 *
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.
57
 
 * @{
58
 
 */
59
 
 
60
 
/**
61
 
 * Skip all columns in result.
62
 
 */
63
 
DRIZZLE_API
64
 
drizzle_return_t drizzle_column_skip(drizzle_result_st *result);
65
 
 
66
 
/**
67
 
 * Read column information.
68
 
 *
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.
73
 
 */
74
 
DRIZZLE_API
75
 
drizzle_column_st *drizzle_column_read(drizzle_result_st *result,
76
 
                                       drizzle_column_st *column,
77
 
                                       drizzle_return_t *ret_ptr);
78
 
 
79
 
/**
80
 
 * Buffer all columns in result structure.
81
 
 */
82
 
DRIZZLE_API
83
 
drizzle_return_t drizzle_column_buffer(drizzle_result_st *result);
84
 
 
85
 
/**
86
 
 * Get next buffered column from a result structure.
87
 
 */
88
 
DRIZZLE_API
89
 
drizzle_column_st *drizzle_column_next(drizzle_result_st *result);
90
 
 
91
 
/**
92
 
 * Get previous buffered column from a result structure.
93
 
 */
94
 
DRIZZLE_API
95
 
drizzle_column_st *drizzle_column_prev(drizzle_result_st *result);
96
 
 
97
 
/**
98
 
 * Seek to the given buffered column in a result structure.
99
 
 */
100
 
DRIZZLE_API
101
 
void drizzle_column_seek(drizzle_result_st *result, uint16_t column);
102
 
 
103
 
/**
104
 
 * Get the given buffered column from a result structure.
105
 
 */
106
 
DRIZZLE_API
107
 
drizzle_column_st *drizzle_column_index(drizzle_result_st *result,
108
 
                                        uint16_t column);
109
 
 
110
 
/**
111
 
 * Get current column number in a buffered or unbuffered result.
112
 
 */
113
 
DRIZZLE_API
114
 
uint16_t drizzle_column_current(drizzle_result_st *result);
115
 
 
116
 
/** @} */
117
 
 
118
 
#ifdef __cplusplus
119
 
}
120
 
#endif
121
 
 
122
 
#endif /* __DRIZZLE_COLUMN_CLIENT_H */