Skip to content

Commit

Permalink
Docs for #7951: Make it possible to handle attach errors in key holde…
Browse files Browse the repository at this point in the history
…r plugin.
  • Loading branch information
AlexPeshkoff committed Jan 11, 2024
1 parent c223890 commit 3912346
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion doc/Using_OO_API.html
Original file line number Diff line number Diff line change
Expand Up @@ -2308,7 +2308,7 @@ <h1><font size="4" style="font-size: 14pt">Generic interfaces.</font></h1>
firebird API.</font></p>
<ol>
<li><p style="margin-bottom: 0cm"><font size="4" style="font-size: 14pt">IStatus*
getStatus() - get instance if <a href="#Status">Status</a>
getStatus() - get instance of <a href="#Status">Status</a>
interface.</font></p>
<li><p style="margin-bottom: 0cm"><font size="4" style="font-size: 14pt">IProvider*
getDispatcher() - get instance of <a href="#Provider">Provider</a>
Expand Down Expand Up @@ -3615,6 +3615,20 @@ <h1><font size="4" style="font-size: 14pt">Database encryption
is passed in both directions. The source of a key receives
dataLength bytes of data and may send up to bufferLength bytes into
buffer returning actual number of bytes placed into buffer.</font></p>
<li><p style="margin-bottom: 0cm"><font size="4" style="font-size: 14pt">
void dispose() - invoked when interface is not needed any more. Helps
to avoid memory leaks in statefull inrefaces.
</font></p>
<li><p style="margin-bottom: 0cm"><font size="4" style="font-size: 14pt">
unsigned afterAttach(StatusType* status, const char* dbName, const IStatus* attStatus) -
invoked after attach on client system. NULL in attStatus means attach was successful
but afterAttach() is anyway invoked in order to let plugin perform required cleanup.
The following values may be returned by this function:
<p style="margin-bottom: 0cm"><font size="4" style="font-size: 14pt">NO_RETRY -
do not repeat attempts to attach to database.</font></p>
<p style="margin-bottom: 0cm"><font size="4" style="font-size: 14pt">DO_RETRY -
retry attach (ignored when function was called without attStatus).</font></p>
</font></p>
</ol>
<p style="margin-bottom: 0cm"><br/>

Expand Down

0 comments on commit 3912346

Please sign in to comment.