From 96164aba77052629088692b4c6173363e54b5007 Mon Sep 17 00:00:00 2001 From: AlexPeshkoff Date: Mon, 27 Jun 2022 16:43:29 +0300 Subject: [PATCH] Docs --- doc/Using_OO_API.html | 45 +++++++++++++++++++++++++++++-------------- 1 file changed, 31 insertions(+), 14 deletions(-) diff --git a/doc/Using_OO_API.html b/doc/Using_OO_API.html index 25b16da5e5..6cd1eca49a 100644 --- a/doc/Using_OO_API.html +++ b/doc/Using_OO_API.html @@ -3,10 +3,10 @@ - + - + @@ -1332,6 +1332,16 @@ finishing with services tasks do not forget to close an interface:

svc->detach(&status);


+

+

+IService interface also +contains method cancel(). It’s needed to cancel wait in a query() +and is used internally by network server. Current implementation is +restricted – IService::cancel() is not supported by remote +redirector, only engine provider supports it. That means one can use +it only in embedded connections.

+


+

Writing @@ -1799,12 +1809,12 @@ interface – replaces isc_db_handle:

  • IBatch* createBatch(StatusType* status, ITransaction* transaction, unsigned stmtLength, const char* sqlStmt, unsigned dialect, IMessageMetadata* - inMetadata, unsigned parLength, - const unsigned char* par) – prepares sqlStmt and creates Batch - interface ready to accept multiple sets of input parameters in - inMetadata format. Leaving inMetadata NULL - makes batch use default format for sqlStmt. Parameters block may be - passed to createBatch() making it possible to adjust batch behavior.

    + inMetadata, unsigned parLength, const unsigned char* par) – + prepares sqlStmt and creates Batch interface + ready to accept multiple sets of input parameters in inMetadata + format. Leaving inMetadata NULL makes batch use default format for + sqlStmt. Parameters block may be passed to createBatch() making it + possible to adjust batch behavior.

  • IEvents* queEvents(StatusType* status, IEventCallback* callback, unsigned length, const unsigned char* events) – replaces isc_que_events() @@ -2380,9 +2390,10 @@ with execution of SQL statements.

    getAlignment(StatusType* status) – returns alignment required for message buffer.

  • unsigned - getAlignedLength(StatusType* status) – returns length of message buffer taking into an account - alignment requirements (use it to allocate memory for an array of - buffers and navigate through that array).

    + getAlignedLength(StatusType* status) – returns length of message + buffer taking into an account alignment requirements (use it to + allocate memory for an array of buffers and navigate through that + array).


    @@ -2640,8 +2651,11 @@ All fetch calls except fetchNext() work only for bidirectional

    Items accepted in getInfo() call:

    INF_RECORD_COUNT -– number of records stored inside a scrollable cursor, or -1 for a uni-directional cursor.

    +– number of records stored inside a scrollable cursor, or -1 for a +uni-directional cursor.


    + +

    1. int fetchNext(StatusType* status, void* message) – fetch next record, @@ -2704,6 +2718,9 @@ interface – replaces isc_svc_handle.

      start(StatusType* status, unsigned spbLength, const unsigned char* spb) – start utility in services manager. Replaces isc_service_start().

      +

    2. void + cancel(StatusType* status) – cancel wait of current query() call. + Supported only for embedded connections.


    @@ -2760,7 +2777,7 @@ interface – replaces (partially) isc_stmt_handle.

    behavior.

  • void setCursorName(StatusType* status, const char* name) – replaces - isc_dsql_set_cursor_name(). + isc_dsql_set_cursor_name().

  • void free(StatusType* status) – free statement, releases interface on @@ -3800,4 +3817,4 @@ release of it.

    - + \ No newline at end of file