cli_8h-source.html

最新版本！fastdb是高效的内存数据库系统

00333                                          <span class="keywordtype">void</span>*             var_ptr,
00334                                          cli_column_set_ex set,
00335                                          cli_column_get_ex get, 
00336                                          <span class="keywordtype">void</span>*             user_data);
00337     
00338 <span class="keyword">enum</span> { 
00339     cli_view_only, 
00340     cli_for_update
00341 };
00342 
00343 <span class="comment">/*********************************************************************</span>
00344 <span class="comment"> * cli_fetch</span>
00345 <span class="comment"> *     Execute select statement.</span>
00346 <span class="comment"> * Parameters:</span>
00347 <span class="comment"> *     statement  - statememt descriptor returned by cli_statement</span>
00348 <span class="comment"> *     for_update - not zero if fetched rows will be updated </span>
00349 <span class="comment"> * Returns:</span>
00350 <span class="comment"> *     &gt;= 0 - success, for select statements number of fetched rows is returned</span>
00351 <span class="comment"> *     &lt;  0 - error code as described in cli_result_code enum</span>
00352 <span class="comment"> */</span>
00353 <span class="keywordtype">int</span> FASTDB_DLL_ENTRY cli_fetch(<span class="keywordtype">int</span> statement, <span class="keywordtype">int</span> for_update);
00354 
00355 <span class="comment">/*********************************************************************</span>
00356 <span class="comment"> * cli_insert</span>
00357 <span class="comment"> *     Execute insert statement.</span>
00358 <span class="comment"> * Parameters:</span>
00359 <span class="comment"> *     statement  - statememt descriptor returned by cli_statement</span>
00360 <span class="comment"> *     oid        - object identifier of created record. </span>
00361 <span class="comment"> * Returns:</span>
00362 <span class="comment"> *     status code as described in cli_result_code enum</span>
00363 <span class="comment"> */</span>
00364 <span class="keywordtype">int</span> FASTDB_DLL_ENTRY cli_insert(<span class="keywordtype">int</span> statement, cli_oid_t* oid);
00365 
00366 <span class="comment">/*********************************************************************</span>
00367 <span class="comment"> * cli_get_first</span>
00368 <span class="comment"> *     Get first row of the selection.</span>
00369 <span class="comment"> * Parameters:</span>
00370 <span class="comment"> *     statement  - statememt descriptor returned by cli_statement</span>
00371 <span class="comment"> * Returns:</span>
00372 <span class="comment"> *     result code as described in cli_result_code enum</span>
00373 <span class="comment"> */</span>
00374 <span class="keywordtype">int</span> FASTDB_DLL_ENTRY cli_get_first(<span class="keywordtype">int</span> statement);
00375 
00376 <span class="comment">/*********************************************************************</span>
00377 <span class="comment"> * cli_get_last</span>
00378 <span class="comment"> *     Get last row of the selection.</span>
00379 <span class="comment"> * Parameters:</span>
00380 <span class="comment"> *     statement  - statememt descriptor returned by cli_statement</span>
00381 <span class="comment"> * Returns:</span>
00382 <span class="comment"> *     result code as described in cli_result_code enum</span>
00383 <span class="comment"> */</span>
00384 <span class="keywordtype">int</span> FASTDB_DLL_ENTRY cli_get_last(<span class="keywordtype">int</span> statement);
00385 
00386 <span class="comment">/*********************************************************************</span>
00387 <span class="comment"> * cli_get_next</span>
00388 <span class="comment"> *     Get next row of the selection. If get_next records is called</span>
00389 <span class="comment"> *     exactly after cli_fetch function call, is will fetch the first record</span>
00390 <span class="comment"> *     in selection.</span>
00391 <span class="comment"> * Parameters:</span>
00392 <span class="comment"> *     statement  - statememt descriptor returned by cli_statement</span>
00393 <span class="comment"> * Returns:</span>
00394 <span class="comment"> *     result code as described in cli_result_code enum</span>
00395 <span class="comment"> */</span>
00396 <span class="keywordtype">int</span> FASTDB_DLL_ENTRY cli_get_next(<span class="keywordtype">int</span> statement);
00397 
00398 <span class="comment">/*********************************************************************</span>
00399 <span class="comment"> * cli_get_prev</span>
00400 <span class="comment"> *     Get previous row of the selection. If get_next records is called</span>
00401 <span class="comment"> *     exactly after cli_fetch function call, is will fetch the last record</span>
00402 <span class="comment"> *     in selection.</span>
00403 <span class="comment"> * Parameters:</span>
00404 <span class="comment"> *     statement  - statememt descriptor returned by cli_statement</span>
00405 <span class="comment"> * Returns:</span>
00406 <span class="comment"> *     result code as described in cli_result_code enum</span>
00407 <span class="comment"> */</span>
00408 <span class="keywordtype">int</span> FASTDB_DLL_ENTRY cli_get_prev(<span class="keywordtype">int</span> statement);
00409 
00410 <span class="comment">/*********************************************************************</span>
00411 <span class="comment"> * cli_skip</span>
00412 <span class="comment"> *     Skip specified number of rows. </span>
00413 <span class="comment"> * Parameters:</span>
00414 <span class="comment"> *     statement  - statememt descriptor returned by cli_statement</span>
00415 <span class="comment"> *     n          - number of objects to be skipped</span>
00416 <span class="comment"> *                - if "n" is positive, then this function has the same effect as</span>
00417 <span class="comment"> *                     executing cli_get_next() function "n" times.</span>
00418 <span class="comment"> *                - if "n" is negative, then this function has the same effect as</span>
00419 <span class="comment"> *                     executing cli_get_prev() function "-n" times.</span>
00420 <span class="comment"> *                - if "n"  is zero, this method just reloads current record</span>
00421 <span class="comment"> * Returns:</span>
00422 <span class="comment"> *     result code as described in cli_result_code enum</span>
00423 <span class="comment"> */</span>
00424 <span class="keywordtype">int</span> FASTDB_DLL_ENTRY cli_skip(<span class="keywordtype">int</span> statement, <span class="keywordtype">int</span> n);
00425 
00426 <span class="comment">/*********************************************************************</span>
00427 <span class="comment"> * cli_seek</span>
00428 <span class="comment"> *    Position cursor to the record with specified OID</span>
00429 <span class="comment"> * Parameters:</span>
00430 <span class="comment"> *     statement   - statememt descriptor returned by cli_statement</span>
00431 <span class="comment"> *     oid         - object identifier of the record to which cursor should be positioned</span>
00432 <span class="comment"> * Returns:</span>
00433 <span class="comment"> *     &gt;= 0 - success, position of the record in the selection</span>
00434 <span class="comment"> *     &lt;  0 - error code as described in cli_result_code enum</span>
00435 <span class="comment"> */</span>
00436 <span class="keywordtype">int</span> FASTDB_DLL_ENTRY cli_seek(<span class="keywordtype">int</span> statement, cli_oid_t oid);
00437 
00438 
00439 <span class="comment">/*********************************************************************</span>
00440 <span class="comment"> * cli_get_oid</span>
00441 <span class="comment"> *     Get object identifier of the current record</span>
00442 <span class="comment"> * Parameters:</span>
00443 <span class="comment"> *     statement  - statememt descriptor returned by cli_statement</span>
00444 <span class="comment"> * Returns:</span>
00445 <span class="comment"> *     object identifier or 0 if no object is seleected</span>
00446 <span class="comment"> */</span>
00447 cli_oid_t FASTDB_DLL_ENTRY cli_get_oid(<span class="keywordtype">int</span> statement);
00448 
00449 <span class="comment">/*********************************************************************</span>
00450 <span class="comment"> * cli_update</span>
00451 <span class="comment"> *     Update the current row in the selection. You have to set</span>
00452 <span class="comment"> *     for_update parameter of cli_fetch to 1 in order to be able </span>
00453 <span class="comment"> *     to perform updates. Updated value of row fields will be taken</span>
00454 <span class="comment"> *     from bound column variables. </span>
00455 <span class="comment"> * Parameters:</span>
00456 <span class="comment"> *     statement   - statememt descriptor returned by cli_statement</span>
00457 <span class="comment"> * Returns:</span>
00458 <span class="comment"> *     result code as described in cli_result_code enum</span>
00459 <span class="comment"> */</span>
00460 <span class="keywordtype">int</span> FASTDB_DLL_ENTRY cli_update(<span class="keywordtype">int</span> statement);
00461 
00462 <span class="comment">/*********************************************************************</span>
00463 <span class="comment"> * cli_remove</span>
00464 <span class="comment"> *     Remove all selected records. You have to set</span>
00465 <span class="comment"> *     for_update parameter of cli_fetch to 1 in order to be able </span>
00466 <span class="comment"> *     to remove records. </span>
00467 <span class="comment"> * Parameters:</span>
00468 <span class="comment"> *     statement   - statememt descriptor returned by cli_statement</span>
00469 <span class="comment"> * Returns:</span>
00470 <span class="comment"> *     result code as described in cli_result_code enum</span>
00471 <span class="comment"> */</span>
00472 <span class="keywordtype">int</span> FASTDB_DLL_ENTRY cli_remove(<span class="keywordtype">int</span> statement);
00473 
00474 <span class="comment">/*********************************************************************</span>
00475 <span class="comment"> * cli_remove_current</span>
00476 <span class="comment"> *     Remove currently selected record. You have to set</span>
00477 <span class="comment"> *     for_update parameter of cli_fetch to 1 in order to be able</span>
00478 <span class="comment"> *     to remove records.</span>
00479 <span class="comment"> * Parameters:</span>
00480 <span class="comment"> *     statement   - statememt descriptor returned by cli_statement</span>
00481 <span class="comment"> * Returns:</span>
00482 <span class="comment"> *     result code as described in cli_result_code enum</span>
00483 <span class="comment"> */</span>
00484 <span class="keywordtype">int</span> FASTDB_DLL_ENTRY cli_remove_current(<span class="keywordtype">int</span> statement);
00485 
00486 <span class="comment">/*********************************************************************</span>
00487 <span class="comment"> * cli_free</span>
00488 <span class="comment"> *     Deallocate statement and all associated data</span>
00489 <span class="comment"> * Parameters:</span>
00490 <span class="comment"> *     statement   - statememt descriptor returned by cli_statement</span>
00491 <span class="comment"> * Returns:</span>
00492 <span class="comment"> *     result code as described in cli_result_code enum</span>
00493 <span class="comment"> */</span>
00494 <span class="keywordtype">int</span> FASTDB_DLL_ENTRY cli_free(<span class="keywordtype">int</span> statement);
00495 
00496 <span class="comment">/*********************************************************************</span>
00497 <span class="comment"> * cli_close_cursor</span>
00498 <span class="comment"> *     Close current cursor</span>
00499 <span class="comment"> * Parameters:</span>
00500 <span class="comment"> *     statement   - statememt descriptor returned by cli_statement</span>
00501 <span class="comment"> * Returns:</span>
00502 <span class="comment"> *     result code as described in cli_result_code enum</span>