← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to libdrizzle-2.0/libdrizzle/result.h

  • Committer: Monty Taylor
  • Date: 2011-03-22 18:39:54 UTC
  • mto: (2246.1.1 build)
  • mto: This revision was merged to the branch mainline in revision 2247.
  • Revision ID: mordred@inaugust.com-20110322183954-fz8ciuywjz2llbyo
Split libdrizzle into 1.0 and 2.0. Applied the C++ changes to 2.0 branch.

Show diffs side-by-side

added added

removed removed

Lines of Context:
libdrizzle-2.0/libdrizzle/result.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
 * @file
 
39
 * @brief Result Declarations
 
40
 */
 
41
 
 
42
#ifndef __DRIZZLE_RESULT_H
 
43
#define __DRIZZLE_RESULT_H
 
44
 
 
45
#ifdef __cplusplus
 
46
extern "C" {
 
47
#endif
 
48
 
 
49
/**
 
50
 * @addtogroup drizzle_result Result Declarations
 
51
 * @ingroup drizzle_client_interface
 
52
 * @ingroup drizzle_server_interface
 
53
 *
 
54
 * These are core result functions used by both clients and servers.
 
55
 * @{
 
56
 */
 
57
 
 
58
/**
 
59
 * Initialize a result structure.
 
60
 */
 
61
DRIZZLE_API
 
62
drizzle_result_st *drizzle_result_create(drizzle_con_st *con,
 
63
                                         drizzle_result_st *result);
 
64
 
 
65
/**
 
66
 * Clone a connection structure.
 
67
 */
 
68
DRIZZLE_API
 
69
drizzle_result_st *drizzle_result_clone(drizzle_con_st *con,
 
70
                                        drizzle_result_st *result,
 
71
                                        drizzle_result_st *from);
 
72
 
 
73
/**
 
74
 * Free a result structure.
 
75
 */
 
76
DRIZZLE_API
 
77
void drizzle_result_free(drizzle_result_st *result);
 
78
 
 
79
/**
 
80
 * Free all result structures.
 
81
 */
 
82
DRIZZLE_API
 
83
void drizzle_result_free_all(drizzle_con_st *con);
 
84
 
 
85
/**
 
86
 * Get the drizzle_con_st struct that the result belongs to.
 
87
 */
 
88
DRIZZLE_API
 
89
drizzle_con_st *drizzle_result_drizzle_con(drizzle_result_st *result);
 
90
 
 
91
/**
 
92
 * Get EOF flag for a result.
 
93
 */
 
94
DRIZZLE_API
 
95
bool drizzle_result_eof(drizzle_result_st *result);
 
96
 
 
97
/**
 
98
 * Get information string for a result.
 
99
 */
 
100
DRIZZLE_API
 
101
const char *drizzle_result_info(drizzle_result_st *result);
 
102
 
 
103
/**
 
104
 * Get error string for a result.
 
105
 */
 
106
DRIZZLE_API
 
107
const char *drizzle_result_error(drizzle_result_st *result);
 
108
 
 
109
/**
 
110
 * Get server defined error code for a result.
 
111
 */
 
112
DRIZZLE_API
 
113
uint16_t drizzle_result_error_code(drizzle_result_st *result);
 
114
 
 
115
/**
 
116
 * Get SQL state code for a result.
 
117
 */
 
118
DRIZZLE_API
 
119
const char *drizzle_result_sqlstate(drizzle_result_st *result);
 
120
 
 
121
/**
 
122
 * Get the number of warnings encounted during a command.
 
123
 */
 
124
DRIZZLE_API
 
125
uint16_t drizzle_result_warning_count(drizzle_result_st *result);
 
126
 
 
127
/**
 
128
 * Get inet ID of the last command, if any.
 
129
 */
 
130
DRIZZLE_API
 
131
uint64_t drizzle_result_insert_id(drizzle_result_st *result);
 
132
 
 
133
/**
 
134
 * Get the number of affected rows during the command.
 
135
 */
 
136
DRIZZLE_API
 
137
uint64_t drizzle_result_affected_rows(drizzle_result_st *result);
 
138
 
 
139
/**
 
140
 * Get the number of columns in a result set.
 
141
 */
 
142
DRIZZLE_API
 
143
uint16_t drizzle_result_column_count(drizzle_result_st *result);
 
144
 
 
145
/**
 
146
 * Get the number of rows returned for the command.
 
147
 */
 
148
DRIZZLE_API
 
149
uint64_t drizzle_result_row_count(drizzle_result_st *result);
 
150
 
 
151
/** @} */
 
152
 
 
153
#ifdef __cplusplus
 
154
}
 
155
#endif
 
156
 
 
157
#endif /* __DRIZZLE_RESULT_H */