← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to docs/libdrizzle/field.rst

  • Committer: Monty Taylor
  • Date: 2010-10-11 06:27:10 UTC
  • mto: (1843.1.1 build)
  • mto: This revision was merged to the branch mainline in revision 1844.
  • Revision ID: mordred@inaugust.com-20101011062710-hw270dnron7sojwe
Removed libdrizzle doxygen. Put in function stubs in sphinx. Someone can
quite easily and mechanically go in and transfer the descriptions in -
especially if they decide on a proper way to describe arguments.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/libdrizzle/field.rst
 
1
 
 
2
 
 
3
.. highlightlang:: c
 
4
 
 
5
Field Object
 
6
------------
 
7
 
 
8
.. index:: object: drizzle_field_st
 
9
 
 
10
Client Functions
 
11
^^^^^^^^^^^^^^^^
 
12
 
 
13
These functions allow you to access fields in a result set if the result is
 
14
unbuffered. If the result is buffered, you can access the fields through the
 
15
row functions.
 
16
 
 
17
 
 
18
.. c:function:: drizzle_field_t   drizzle_field_read (drizzle_result_st *result, size_t *offset, size_t *size, size_t *total, drizzle_return_t *ret_ptr)
 
19
 
 
20
.. c:function:: drizzle_field_t   drizzle_field_buffer (drizzle_result_st *result, size_t *total, drizzle_return_t *ret_ptr)
 
21
 
 
22
.. c:function:: void  drizzle_field_free (drizzle_field_t field)
 
23
 
 
24
Server Functions
 
25
^^^^^^^^^^^^^^^^
 
26
 
 
27
These functions allow you to send a field over a connection.
 
28
 
 
29
 
 
30
.. c:function:: drizzle_return_t  drizzle_field_write (drizzle_result_st *result, const drizzle_field_t field, size_t size, size_t total)
 
31