← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to docs/libdrizzle/result.rst

  • Committer: lbieber at stabletransit
  • Date: 2010-10-13 16:01:40 UTC
  • mfrom: (1836.3.1 more-docs)
  • mto: This revision was merged to the branch mainline in revision 1844.
  • Revision ID: lbieber@drizzle-build-n02.wc1.dfw1.stabletransit.com-20101013160140-vft253sh5ljmcl6n
Merge Monty - Moved libdrizzle api listings from doxygen to sphinx

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/libdrizzle/result.rst
 
1
 
 
2
.. highlightlang:: c
 
3
 
 
4
Result Object
 
5
------------
 
6
 
 
7
.. index:: object: drizzle_result_st
 
8
 
 
9
General Functions
 
10
^^^^^^^^^^^^^^^^^
 
11
 
 
12
These are core result functions used by both clients and servers.
 
13
 
 
14
 
 
15
.. c:function:: drizzle_result_st *   drizzle_result_create (drizzle_con_st *con, drizzle_result_st *result)
 
16
 
 
17
.. c:function:: drizzle_result_st *   drizzle_result_clone (drizzle_con_st *con, drizzle_result_st *result, drizzle_result_st *from)
 
18
 
 
19
.. c:function:: void  drizzle_result_free (drizzle_result_st *result)
 
20
 
 
21
.. c:function:: void  drizzle_result_free_all (drizzle_con_st *con)
 
22
 
 
23
.. c:function:: drizzle_con_st *  drizzle_result_drizzle_con (drizzle_result_st *result)
 
24
 
 
25
.. c:function:: bool  drizzle_result_eof (drizzle_result_st *result)
 
26
 
 
27
.. c:function:: const char *  drizzle_result_info (drizzle_result_st *result)
 
28
 
 
29
.. c:function:: const char *  drizzle_result_error (drizzle_result_st *result)
 
30
 
 
31
.. c:function:: uint16_t  drizzle_result_error_code (drizzle_result_st *result)
 
32
 
 
33
.. c:function:: const char *  drizzle_result_sqlstate (drizzle_result_st *result)
 
34
 
 
35
.. c:function:: uint16_t  drizzle_result_warning_count (drizzle_result_st *result)
 
36
 
 
37
.. c:function:: uint64_t  drizzle_result_insert_id (drizzle_result_st *result)
 
38
 
 
39
.. c:function:: uint64_t  drizzle_result_affected_rows (drizzle_result_st *result)
 
40
 
 
41
.. c:function:: uint16_t  drizzle_result_column_count (drizzle_result_st *result)
 
42
 
 
43
.. c:function:: uint64_t  drizzle_result_row_count (drizzle_result_st *result)
 
44
 
 
45
Client Functions
 
46
^^^^^^^^^^^^^^^^
 
47
 
 
48
These functions read or buffer the result for a client command.
 
49
 
 
50
.. c:function:: drizzle_result_st *   drizzle_result_read (drizzle_con_st *con, drizzle_result_st *result, drizzle_return_t *ret_ptr)
 
51
 
 
52
.. c:function:: drizzle_return_t  drizzle_result_buffer (drizzle_result_st *result)
 
53
 
 
54
.. c:function:: size_t  drizzle_result_row_size (drizzle_result_st *result)
 
55
 
 
56
Server Functions
 
57
^^^^^^^^^^^^^^^^
 
58
 
 
59
These functions allow you to send result packets over a connection.
 
60
 
 
61
 
 
62
.. c:function:: drizzle_return_t  drizzle_result_write (drizzle_con_st *con, drizzle_result_st *result, bool flush)
 
63
 
 
64
.. c:function:: void  drizzle_result_set_row_size (drizzle_result_st *result, size_t size)
 
65
 
 
66
.. c:function:: void  drizzle_result_calc_row_size (drizzle_result_st *result, const
 
67
 
 
68
.. c:function:: drizzle_field_t *field, const size_t *size)
 
69
 
 
70
.. c:function:: void  drizzle_result_set_eof (drizzle_result_st *result, bool eof)
 
71
 
 
72
.. c:function:: void  drizzle_result_set_info (drizzle_result_st *result, const char *info)
 
73
 
 
74
.. c:function:: void  drizzle_result_set_error (drizzle_result_st *result, const char *error)
 
75
 
 
76
.. c:function:: void  drizzle_result_set_error_code (drizzle_result_st *result, uint16_t error_code)
 
77
 
 
78
.. c:function:: void  drizzle_result_set_sqlstate (drizzle_result_st *result, const char *sqlstate)
 
79
 
 
80
.. c:function:: void  drizzle_result_set_warning_count (drizzle_result_st *result, uint16_t warning_count)
 
81
 
 
82
.. c:function:: void  drizzle_result_set_insert_id (drizzle_result_st *result, uint64_t insert_id)
 
83
 
 
84
.. c:function:: void  drizzle_result_set_affected_rows (drizzle_result_st *result, uint64_t affected_rows)
 
85
 
 
86
.. c:function:: void  drizzle_result_set_column_count (drizzle_result_st *result, uint16_t column_count)