cli_8h-source.html

来自「一个功能强大的内存数据库源代码,c++编写,有详细的注释」· HTML 代码 · 共 537 行 · 第 1/3 页

00172 <font class="comment"> *     statement  - statememt descriptor returned by cli_statement</font>
00173 <font class="comment"> *     param_name - zero terminated string with parameter name  </font>
00174 <font class="comment"> *                  Paramter name should start with '%'</font>
00175 <font class="comment"> *     var_type   - type of variable as described in cli_var_type enum.</font>
00176 <font class="comment"> *                  Only scalar and zero terminated string types are supported.</font>
00177 <font class="comment"> *     var_ptr    - pointer to the variable</font>
00178 <font class="comment"> * Returns:</font>
00179 <font class="comment"> *     result code as described in cli_result_code enum</font>
00180 <font class="comment"> */</font>
00181 <font class="keywordtype">int</font> FASTDB_DLL_ENTRY cli_parameter(<font class="keywordtype">int</font>         statement,
00182                                    <font class="keywordtype">char</font> <font class="keyword">const</font>* param_name, 
00183                                    <font class="keywordtype">int</font>         var_type,
00184                                    <font class="keywordtype">void</font>*       var_ptr);
00185 
00186 <font class="comment">/*********************************************************************</font>
00187 <font class="comment"> * cli_column</font>
00188 <font class="comment"> *     Bind extracted column of select or insert statement</font>
00189 <font class="comment"> * Parameters:</font>
00190 <font class="comment"> *     statement   - statememt descriptor returned by cli_statement</font>
00191 <font class="comment"> *     column_name - zero terminated string with column name  </font>
00192 <font class="comment"> *     var_type    - type of variable as described in cli_var_type enum</font>
00193 <font class="comment"> *     var_len     - pointer to the variable to hold length of array variable.</font>
00194 <font class="comment"> *                   This variable should be assigned the maximal length</font>
00195 <font class="comment"> *                   of the array/string buffer, pointed by var_ptr.</font>
00196 <font class="comment"> *                   After the execution of the statement it is assigned the </font>
00197 <font class="comment"> *                   real length of the fetched array/string. If it is large </font>
00198 <font class="comment"> *                   than length of the buffer, then only part of the array</font>
00199 <font class="comment"> *                   will be placed in the buffer, but var_len still will </font>
00200 <font class="comment"> *                   contain the actual array length. </font>
00201 <font class="comment"> *     var_ptr     - pointer to the variable</font>
00202 <font class="comment"> * Returns:</font>
00203 <font class="comment"> *     result code as described in cli_result_code enum</font>
00204 <font class="comment"> */</font>
00205 <font class="keywordtype">int</font> FASTDB_DLL_ENTRY cli_column(<font class="keywordtype">int</font>         statement,
00206                                 <font class="keywordtype">char</font> <font class="keyword">const</font>* column_name, 
00207                                 <font class="keywordtype">int</font>         var_type, 
00208                                 <font class="keywordtype">int</font>*        var_len, 
00209                                 <font class="keywordtype">void</font>*       var_ptr);
00210 
00211 
00212 <font class="keyword">typedef</font> <font class="keywordtype">void</font>* (*cli_column_set)(<font class="keywordtype">int</font> var_type, <font class="keywordtype">void</font>* var_ptr, <font class="keywordtype">int</font> len);
00213 <font class="keyword">typedef</font> <font class="keywordtype">void</font>* (*cli_column_get)(<font class="keywordtype">int</font> var_type, <font class="keywordtype">void</font>* var_ptr, <font class="keywordtype">int</font>* len);
00214 
00215 <font class="keyword">typedef</font> <font class="keywordtype">void</font>* (*cli_column_set_ex)(<font class="keywordtype">int</font> var_type, <font class="keywordtype">void</font>* var_ptr, <font class="keywordtype">int</font> len, 
00216                                    <font class="keywordtype">char</font> <font class="keyword">const</font>* column_name, <font class="keywordtype">int</font> statement, <font class="keywordtype">void</font> <font class="keyword">const</font>* data_ptr);
00217 <font class="keyword">typedef</font> <font class="keywordtype">void</font>* (*cli_column_get_ex)(<font class="keywordtype">int</font> var_type, <font class="keywordtype">void</font>* var_ptr, <font class="keywordtype">int</font>* len, 
00218                                    <font class="keywordtype">char</font> <font class="keyword">const</font>* column_name, <font class="keywordtype">int</font> statemen);
00219 
00220 <font class="comment">/*********************************************************************</font>
00221 <font class="comment"> * cli_array_column</font>
00222 <font class="comment"> *     Specify get/set functions for the array column</font>
00223 <font class="comment"> * Parameters:</font>
00224 <font class="comment"> *     statement   - statememt descriptor returned by cli_statement</font>
00225 <font class="comment"> *     column_name - zero terminated string with column name  </font>
00226 <font class="comment"> *     var_type    - type of variable as described in cli_var_type enum</font>
00227 <font class="comment"> *     var_ptr     - pointer to the variable</font>
00228 <font class="comment"> *     set         - function which will be called to construct fetched </font>
00229 <font class="comment"> *                   field. It receives pointer to the variable, </font>
00230 <font class="comment"> *                   length of the fetched array and returns pointer to th </font>
00231 <font class="comment"> *                   array's elements</font>
00232 <font class="comment"> *     get         - function which will be called to update the field in the </font>
00233 <font class="comment"> *                   database. Given pointer to the variable, it should return </font>
00234 <font class="comment"> *                   pointer to the array elements and store length of the</font>
00235 <font class="comment"> *                   array to the variable pointer by len parameter</font>
00236 <font class="comment"> * Returns:</font>
00237 <font class="comment"> *     result code as described in cli_result_code enum</font>
00238 <font class="comment"> */</font>
00239 <font class="keywordtype">int</font> FASTDB_DLL_ENTRY cli_array_column(<font class="keywordtype">int</font>            statement,
00240                                       <font class="keywordtype">char</font> <font class="keyword">const</font>*    column_name, 
00241                                       <font class="keywordtype">int</font>            var_type,
00242                                       <font class="keywordtype">void</font>*          var_ptr,
00243                                       cli_column_set set,
00244                                       cli_column_get get);
00245     
00246 <font class="keywordtype">int</font> FASTDB_DLL_ENTRY cli_array_column_ex(<font class="keywordtype">int</font>               statement,
00247                                          <font class="keywordtype">char</font> <font class="keyword">const</font>*       column_name, 
00248                                          <font class="keywordtype">int</font>               var_type,
00249                                          <font class="keywordtype">void</font>*             var_ptr,
00250                                          cli_column_set_ex set,
00251                                          cli_column_get_ex get);
00252     
00253 <font class="keyword">enum</font> { 
00254     cli_view_only, 
00255     cli_for_update
00256 };
00257 
00258 <font class="comment">/*********************************************************************</font>
00259 <font class="comment"> * cli_fetch</font>
00260 <font class="comment"> *     Execute select statement.</font>
00261 <font class="comment"> * Parameters:</font>
00262 <font class="comment"> *     statement  - statememt descriptor returned by cli_statement</font>
00263 <font class="comment"> *     for_update - not zero if fetched rows will be updated </font>
00264 <font class="comment"> * Returns:</font>
00265 <font class="comment"> *     &gt;= 0 - success, for select statements number of fetched rows is returned</font>
00266 <font class="comment"> *     &lt;  0 - error code as described in cli_result_code enum</font>
00267 <font class="comment"> */</font>
00268 <font class="keywordtype">int</font> FASTDB_DLL_ENTRY cli_fetch(<font class="keywordtype">int</font> statement, <font class="keywordtype">int</font> for_update);
00269 
00270 <font class="comment">/*********************************************************************</font>
00271 <font class="comment"> * cli_insert</font>
00272 <font class="comment"> *     Execute insert statement.</font>
00273 <font class="comment"> * Parameters:</font>
00274 <font class="comment"> *     statement  - statememt descriptor returned by cli_statement</font>
00275 <font class="comment"> *     oid        - object identifier of created record. </font>
00276 <font class="comment"> * Returns:</font>
00277 <font class="comment"> *     status code as described in cli_result_code enum</font>
00278 <font class="comment"> */</font>
00279 <font class="keywordtype">int</font> FASTDB_DLL_ENTRY cli_insert(<font class="keywordtype">int</font> statement, cli_oid_t* oid);
00280 
00281 <font class="comment">/*********************************************************************</font>
00282 <font class="comment"> * cli_get_first</font>
00283 <font class="comment"> *     Get first row of the selection.</font>
00284 <font class="comment"> * Parameters:</font>
00285 <font class="comment"> *     statement  - statememt descriptor returned by cli_statement</font>
00286 <font class="comment"> * Returns:</font>
00287 <font class="comment"> *     result code as described in cli_result_code enum</font>
00288 <font class="comment"> */</font>
00289 <font class="keywordtype">int</font> FASTDB_DLL_ENTRY cli_get_first(<font class="keywordtype">int</font> statement);
00290 
00291 <font class="comment">/*********************************************************************</font>
00292 <font class="comment"> * cli_get_last</font>
00293 <font class="comment"> *     Get last row of the selection.</font>
00294 <font class="comment"> * Parameters:</font>
00295 <font class="comment"> *     statement  - statememt descriptor returned by cli_statement</font>
00296 <font class="comment"> * Returns:</font>
00297 <font class="comment"> *     result code as described in cli_result_code enum</font>
00298 <font class="comment"> */</font>
00299 <font class="keywordtype">int</font> FASTDB_DLL_ENTRY cli_get_last(<font class="keywordtype">int</font> statement);
00300 
00301 <font class="comment">/*********************************************************************</font>
00302 <font class="comment"> * cli_get_next</font>
00303 <font class="comment"> *     Get next row of the selection. If get_next records is called</font>
00304 <font class="comment"> *     exactly after cli_fetch function call, is will fetch the first record</font>
00305 <font class="comment"> *     in selection.</font>
00306 <font class="comment"> * Parameters:</font>
00307 <font class="comment"> *     statement  - statememt descriptor returned by cli_statement</font>
00308 <font class="comment"> * Returns:</font>
00309 <font class="comment"> *     result code as described in cli_result_code enum</font>
00310 <font class="comment"> */</font>
00311 <font class="keywordtype">int</font> FASTDB_DLL_ENTRY cli_get_next(<font class="keywordtype">int</font> statement);
00312 
00313 <font class="comment">/*********************************************************************</font>
00314 <font class="comment"> * cli_get_prev</font>
00315 <font class="comment"> *     Get previous row of the selection. If get_next records is called</font>
00316 <font class="comment"> *     exactly after cli_fetch function call, is will fetch the last record</font>
00317 <font class="comment"> *     in selection.</font>
00318 <font class="comment"> * Parameters:</font>
00319 <font class="comment"> *     statement  - statememt descriptor returned by cli_statement</font>
00320 <font class="comment"> * Returns:</font>
00321 <font class="comment"> *     result code as described in cli_result_code enum</font>
00322 <font class="comment"> */</font>
00323 <font class="keywordtype">int</font> FASTDB_DLL_ENTRY cli_get_prev(<font class="keywordtype">int</font> statement);
00324 
00325 <font class="comment">/*********************************************************************</font>
00326 <font class="comment"> * cli_get_oid</font>
00327 <font class="comment"> *     Get object identifier of the current record</font>
00328 <font class="comment"> * Parameters:</font>
00329 <font class="comment"> *     statement  - statememt descriptor returned by cli_statement</font>
00330 <font class="comment"> * Returns:</font>
00331 <font class="comment"> *     object identifier or 0 if no object is seleected</font>
00332 <font class="comment"> */</font>
00333 cli_oid_t FASTDB_DLL_ENTRY cli_get_oid(<font class="keywordtype">int</font> statement);
00334 
00335 <font class="comment">/*********************************************************************</font>
00336 <font class="comment"> * cli_update</font>
00337 <font class="comment"> *     Update the current row in the selection. You have to set</font>
00338 <font class="comment"> *     for_update parameter of cli_fetch to 1 in order to be able </font>
00339 <font class="comment"> *     to perform updates. Updated value of row fields will be taken</font>
00340 <font class="comment"> *     from bound column variables. </font>
00341 <font class="comment"> * Parameters:</font>
00342 <font class="comment"> *     statement   - statememt descriptor returned by cli_statement</font>
00343 <font class="comment"> * Returns:</font>
00344 <font class="comment"> *     result code as described in cli_result_code enum</font>
00345 <font class="comment"> */</font>
00346 <font class="keywordtype">int</font> FASTDB_DLL_ENTRY cli_update(<font class="keywordtype">int</font> statement);
00347 
00348 <font class="comment">/*********************************************************************</font>
00349 <font class="comment"> * cli_remove</font>
00350 <font class="comment"> *     Remove all selected records. You have to set</font>