← Back to branch summary

~ubuntu-branches/ubuntu/saucy/drizzle/saucy-proposed

« back to all changes in this revision

Viewing changes to libdrizzle-1.0/result.h

  • Committer: Package Import Robot
  • Author(s): Clint Byrum
  • Date: 2012-06-19 10:46:49 UTC
  • mfrom: (1.1.6)
  • mto: This revision was merged to the branch mainline in revision 29.
  • Revision ID: package-import@ubuntu.com-20120619104649-e2l0ggd4oz3um0f4
Tags: upstream-7.1.36-stable
Import upstream version 7.1.36-stable

Show diffs side-by-side

added added

removed removed

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