← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to libdrizzle-2.0/column_client.h

merge lp:~hingo/drizzle/drizzle-auth_ldap-fix-and-docs

Show diffs side-by-side

added added

removed removed

Lines of Context:
libdrizzle-2.0/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
#pragma once
 
44
 
 
45
#ifdef __cplusplus
 
46
extern "C" {
 
47
#endif
 
48
 
 
49
/**
 
50
 * @addtogroup drizzle_column_client Column Declarations for Clients
 
51
 * @ingroup drizzle_client_interface
 
52
 *
 
53
 * These functions are used to get detailed column information. This information
 
54
 * is usually sent as the first part of a result set. There are both buffered
 
55
 * and unbuffered functions provided.
 
56
 * @{
 
57
 */
 
58
 
 
59
/**
 
60
 * Skip a column in result.
 
61
 */
 
62
DRIZZLE_API
 
63
drizzle_return_t drizzle_column_skip(drizzle_result_st *result);
 
64
 
 
65
/**
 
66
 * Skip all columns in a result.
 
67
 */
 
68
DRIZZLE_API
 
69
drizzle_return_t drizzle_column_skip_all(drizzle_result_st *result);
 
70
 
 
71
/**
 
72
 * Read column information.
 
73
 *
 
74
 * @param[in,out] result pointer to the structure to read from.
 
75
 * @param[out] column pointer to the structure to contain the information.
 
76
 * @param[out] ret_ptr Standard libdrizzle return value.
 
77
 * @return column if there is valid data, NULL if there are no more columns.
 
78
 */
 
79
DRIZZLE_API
 
80
drizzle_column_st *drizzle_column_read(drizzle_result_st *result,
 
81
                                       drizzle_column_st *column,
 
82
                                       drizzle_return_t *ret_ptr);
 
83
 
 
84
/**
 
85
 * Buffer all columns in result structure.
 
86
 */
 
87
DRIZZLE_API
 
88
drizzle_return_t drizzle_column_buffer(drizzle_result_st *result);
 
89
 
 
90
/**
 
91
 * Get next buffered column from a result structure.
 
92
 */
 
93
DRIZZLE_API
 
94
drizzle_column_st *drizzle_column_next(drizzle_result_st *result);
 
95
 
 
96
/**
 
97
 * Get previous buffered column from a result structure.
 
98
 */
 
99
DRIZZLE_API
 
100
drizzle_column_st *drizzle_column_prev(drizzle_result_st *result);
 
101
 
 
102
/**
 
103
 * Seek to the given buffered column in a result structure.
 
104
 */
 
105
DRIZZLE_API
 
106
void drizzle_column_seek(drizzle_result_st *result, uint16_t column);
 
107
 
 
108
/**
 
109
 * Get the given buffered column from a result structure.
 
110
 */
 
111
DRIZZLE_API
 
112
drizzle_column_st *drizzle_column_index(drizzle_result_st *result,
 
113
                                        uint16_t column);
 
114
 
 
115
/**
 
116
 * Get current column number in a buffered or unbuffered result.
 
117
 */
 
118
DRIZZLE_API
 
119
uint16_t drizzle_column_current(drizzle_result_st *result);
 
120
 
 
121
/** @} */
 
122
 
 
123
#ifdef __cplusplus
 
124
}
 
125
#endif