Home page  
Help >
ddlAdviseCallback() - post advisory callback
Version 7.11
ddlAdviseCallback() - post advisory callback ddlAdviseCallback() - post advisory callback

Prototype:
   void ddlAdviseCallback(
      CONTROL *ctl,
      WtCastPtr UserWord,
      AdviseRtn UserAdvise);
 
      typedef void (STDCALL *AdviseRtn)(
         WtCastPtr UserWord,           /* [IN] UserWord from ddlAdviseCallback() */
         char *AdviseMessage);    /* [IN] Advisory message */
Description:
ddlAdviseCallback() posts a callback to be used with subsequent calls to Thunderbolt API functions. In general, the Advise messages are used to notify the caller of circumstances that may be considered aberrant and/or that may delay the execution of the current command.

The ddlAdviseCallback() function with a null UserAdvise parameter cancels any advisory callback.

The AdviseMessage parameter to the callback is non-null when an advisory is being initiated. The AdviseMessage parameter is null when the advisory is being terminated.

Note that there may be multiple advisory messages before an advisory terminate is sent.

There are five categories of events that produce an Advise message:
       1) Non-keyed queries
                   Message Format: Searching ...
       2) File locks
                   Message Format: LOCK <table-name>
                   Message Format: LOCK <key-name>
       3) SPOOL
                   Message Format: spool <key-name>;
       4) Ripple of Fripple (foreward ripple)
                   Message Format: ripple <key-name>;
                   Message Format: fripple <key-name>;
       5) Converting an RTL index node to RTB;
                   Message Format: Convert RTL-<key-name>;


Values returned in Control Structure:
Control.Ans1 NA
Control.Ans2 Previous Advise Callback pointer (cast as 32 bit int)
Control.Ans3 Previous Advise Callback UserWord (cast as 32 bit int)
Control.Ans2L Previous Advise Callback pointer (cast as 64 bit int)
Control.Ans3L Previous Advise Callback UserWord (cast as 64 bit int)

Copyright © 2019 , WhamTech, Inc.  All rights reserved. This document is provided for information purposes only and the contents hereof are subject to change without notice. Names may be trademarks of their respective owners.