← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to libdrizzle/field_client.h

  • Committer: Monty Taylor
  • Date: 2010-08-12 20:27:32 UTC
  • mto: (1720.1.5 build)
  • mto: This revision was merged to the branch mainline in revision 1722.
  • Revision ID: mordred@inaugust.com-20100812202732-9kzchbkvkyki4n3u
Merged libdrizzle directly into tree.

Show diffs side-by-side

added added

removed removed

Lines of Context:
libdrizzle/field_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 Field Declarations for Clients
 
14
 */
 
15
 
 
16
#ifndef __DRIZZLE_FIELD_CLIENT_H
 
17
#define __DRIZZLE_FIELD_CLIENT_H
 
18
 
 
19
#ifdef __cplusplus
 
20
extern "C" {
 
21
#endif
 
22
 
 
23
/**
 
24
 * @addtogroup drizzle_field_client Field Declarations for Clients
 
25
 * @ingroup drizzle_client_interface
 
26
 *
 
27
 * These functions allow you to access fields in a result set if the result is
 
28
 * unbuffered. If the result is buffered, you can access the fields through the
 
29
 * row functions.
 
30
 * @{
 
31
 */
 
32
 
 
33
/**
 
34
 * Read field for unbuffered result, possibly in parts. This is especially
 
35
 * useful for blob streaming, since the client does not need to buffer the
 
36
 * entire blob.
 
37
 */
 
38
DRIZZLE_API
 
39
drizzle_field_t drizzle_field_read(drizzle_result_st *result, size_t *offset,
 
40
                                   size_t *size, size_t *total,
 
41
                                   drizzle_return_t *ret_ptr);
 
42
 
 
43
/**
 
44
 * Buffer one field.
 
45
 */
 
46
DRIZZLE_API
 
47
drizzle_field_t drizzle_field_buffer(drizzle_result_st *result, size_t *total,
 
48
                                     drizzle_return_t *ret_ptr);
 
49
 
 
50
/**
 
51
 * Free a buffered field.
 
52
 */
 
53
DRIZZLE_API
 
54
void drizzle_field_free(drizzle_field_t field);
 
55
 
 
56
/** @} */
 
57
 
 
58
#ifdef __cplusplus
 
59
}
 
60
#endif
 
61
 
 
62
#endif /* __DRIZZLE_FIELD_CLIENT_H */