← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to libdrizzle/column_client.h

  • Committer: Monty Taylor
  • Date: 2010-08-20 15:05:54 UTC
  • mfrom: (1720.1.7 build)
  • Revision ID: mordred@inaugust.com-20100820150554-fuwf8zs8qpzhpx6y
Added libdrizzle to the tree.

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
 * Use and distribution licensed under the BSD license.  See
 
8
 * the COPYING file in this directory for full text.
 
9
 */
 
10
 
 
11
/**
 
12
 * @file
 
13
 * @brief Column Declarations for Clients
 
14
 */
 
15
 
 
16
#ifndef __DRIZZLE_COLUMN_CLIENT_H
 
17
#define __DRIZZLE_COLUMN_CLIENT_H
 
18
 
 
19
#ifdef __cplusplus
 
20
extern "C" {
 
21
#endif
 
22
 
 
23
/**
 
24
 * @addtogroup drizzle_column_client Column Declarations for Clients
 
25
 * @ingroup drizzle_client_interface
 
26
 *
 
27
 * These functions are used to get detailed column information. This information
 
28
 * is usually sent as the first part of a result set. There are both buffered
 
29
 * and unbuffered functions provided.
 
30
 * @{
 
31
 */
 
32
 
 
33
/**
 
34
 * Skip all columns in result.
 
35
 */
 
36
DRIZZLE_API
 
37
drizzle_return_t drizzle_column_skip(drizzle_result_st *result);
 
38
 
 
39
/**
 
40
 * Read column information.
 
41
 */
 
42
DRIZZLE_API
 
43
drizzle_column_st *drizzle_column_read(drizzle_result_st *result,
 
44
                                       drizzle_column_st *column,
 
45
                                       drizzle_return_t *ret_ptr);
 
46
 
 
47
/**
 
48
 * Buffer all columns in result structure.
 
49
 */
 
50
DRIZZLE_API
 
51
drizzle_return_t drizzle_column_buffer(drizzle_result_st *result);
 
52
 
 
53
/**
 
54
 * Get next buffered column from a result structure.
 
55
 */
 
56
DRIZZLE_API
 
57
drizzle_column_st *drizzle_column_next(drizzle_result_st *result);
 
58
 
 
59
/**
 
60
 * Get previous buffered column from a result structure.
 
61
 */
 
62
DRIZZLE_API
 
63
drizzle_column_st *drizzle_column_prev(drizzle_result_st *result);
 
64
 
 
65
/**
 
66
 * Seek to the given buffered column in a result structure.
 
67
 */
 
68
DRIZZLE_API
 
69
void drizzle_column_seek(drizzle_result_st *result, uint16_t column);
 
70
 
 
71
/**
 
72
 * Get the given buffered column from a result structure.
 
73
 */
 
74
DRIZZLE_API
 
75
drizzle_column_st *drizzle_column_index(drizzle_result_st *result,
 
76
                                        uint16_t column);
 
77
 
 
78
/**
 
79
 * Get current column number in a buffered or unbuffered result.
 
80
 */
 
81
DRIZZLE_API
 
82
uint16_t drizzle_column_current(drizzle_result_st *result);
 
83
 
 
84
/** @} */
 
85
 
 
86
#ifdef __cplusplus
 
87
}
 
88
#endif
 
89
 
 
90
#endif /* __DRIZZLE_COLUMN_CLIENT_H */