Skip to content

Commit 51e36ff

Browse files
Correct documentation as noted by Felipe Noronha in #156.
1 parent 6815f23 commit 51e36ff

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

doc/src/functions/dpiContext.rst

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,12 +66,14 @@ using the function :func:`dpiContext_destroy()`.
6666
handle is NULL or invalid an error is returned.
6767

6868

69-
.. function:: void dpiContext_getClientVersion(const dpiContext* context, \
69+
.. function:: int dpiContext_getClientVersion(const dpiContext* context, \
7070
dpiVersionInfo* versionInfo)
7171

7272
Return information about the version of the Oracle Client that is being
7373
used.
7474

75+
The function returns DPI_SUCCESS for success and DPI_FAILURE for failure.
76+
7577
**context** [IN] -- the context handle created earlier using the function
7678
:func:`dpiContext_createWithParams()`. If the handle is NULL or invalid an
7779
error is returned.
@@ -108,6 +110,8 @@ using the function :func:`dpiContext_destroy()`.
108110
Initializes the :ref:`dpiCommonCreateParams<dpiCommonCreateParams>`
109111
structure to default values.
110112

113+
The function returns DPI_SUCCESS for success and DPI_FAILURE for failure.
114+
111115
**context** [IN] -- the context handle created earlier using the function
112116
:func:`dpiContext_createWithParams()`. If the handle is NULL or invalid an
113117
error is returned.
@@ -122,6 +126,8 @@ using the function :func:`dpiContext_destroy()`.
122126
Initializes the :ref:`dpiConnCreateParams<dpiConnCreateParams>` structure
123127
to default values.
124128

129+
The function returns DPI_SUCCESS for success and DPI_FAILURE for failure.
130+
125131
**context** [IN] -- the context handle created earlier using the function
126132
:func:`dpiContext_createWithParams()`. If the handle is NULL or invalid an
127133
error is returned.
@@ -137,6 +143,8 @@ using the function :func:`dpiContext_destroy()`.
137143
Initializes the :ref:`dpiPoolCreateParams<dpiPoolCreateParams>` structure
138144
to default values.
139145

146+
The function returns DPI_SUCCESS for success and DPI_FAILURE for failure.
147+
140148
**context** [IN] -- the context handle created earlier using the function
141149
:func:`dpiContext_createWithParams()`. If the handle is NULL or invalid an
142150
error is returned.
@@ -152,6 +160,8 @@ using the function :func:`dpiContext_destroy()`.
152160
Initializes the :ref:`dpiSodaOperOptions<dpiSodaOperOptions>`
153161
structure to default values.
154162

163+
The function returns DPI_SUCCESS for success and DPI_FAILURE for failure.
164+
155165
**context** [IN] -- the context handle created earlier using the function
156166
:func:`dpiContext_createWithParams()`. If the handle is NULL or invalid an
157167
error is returned.
@@ -167,6 +177,8 @@ using the function :func:`dpiContext_destroy()`.
167177
Initializes the :ref:`dpiSubscrCreateParams<dpiSubscrCreateParams>`
168178
structure to default values.
169179

180+
The function returns DPI_SUCCESS for success and DPI_FAILURE for failure.
181+
170182
**context** [IN] -- the context handle created earlier using the function
171183
:func:`dpiContext_createWithParams()`. If the handle is NULL or invalid an
172184
error is returned.

doc/src/structs/dpiVersionInfo.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Oracle Client (:func:`dpiContext_getClientVersion()`) and Oracle Database
2929
Specifies the port specific update version of the Oracle Client or
3030
Database.
3131

32-
.. member:: int dpiVersionInfo.fullVersionNum
32+
.. member:: uint32_t dpiVersionInfo.fullVersionNum
3333

3434
Specifies the full version (all five components) as a number that is
3535
suitable for comparison with the result of the macro

0 commit comments

Comments
 (0)