Main Page   File List   Globals  

ADDON.h File Reference

Go to the source code of this file.

Typedefs

typedef void(* StateChangeAddOnCallbackV2_pf )(StateChange_e StateChange)
 This callback will be called whenever there is a state change in Tecplot. More...

typedef void(* StateChangeAddOnCallback_pf )(StateChange_e StateChange, ArbParam_t CallData)
 This is the earlier (i.e. More...

typedef Boolean_t(* MacroCommandAddOnCallback_pf )(char *CommandString, char **ErrMsg)
 Execute an addon specific macro command. More...

typedef Boolean_t(* MopupQueryAddOnCallback_pf )(void)
 This callback is called when tecplot is in the initial phases of quitting. More...

typedef Boolean_t(* ForeignLibLoader_pf )(const char *LibraryName, const char *InitFunctionName, ArbParam_t ClientData)
 This callback is not available as yet in the current API. More...


Typedef Documentation

typedef Boolean_t(* ForeignLibLoader_pf)(const char *LibraryName, const char *InitFunctionName, ArbParam_t ClientData)
 

This callback is not available as yet in the current API.

typedef Boolean_t(* MacroCommandAddOnCallback_pf)(char *CommandString, char **ErrMsg)
 

Execute an addon specific macro command.

This is the callback that is responsible for performing the macro command action when the $!ADDONCOMMAND macro command associated with the AddOnIDString is processed.

Returns:
Return TRUE if the macro command could be processed otherwise FALSE. if FALSE then you must allocate space for, and populate ErrMsg with an error message.
Parameters:
CommandString  The command string. The syntax for this string is predetermined by the addon.
ErrMsg  An error message string which is allocated and set by the callback if the callback function's result is FALSE. The error message string states the nature of the problem and assigns the value to the parameter *ErrMsg. If the callback functionhs result is TRUE then the value of the *ErrMsg parameter must be NULL. If there is an error then use the TecUtilStringAlloc function to allocate the error message so that Tecplot can release it after displaying the error.

typedef Boolean_t(* MopupQueryAddOnCallback_pf)(void)
 

This callback is called when tecplot is in the initial phases of quitting.

Returns:
Return FALSE if you want to stop tecplot from quitting. Return TRUE if your addon is ok with allowing tecplot to quit.

typedef void(* StateChangeAddOnCallback_pf)(StateChange_e StateChange, ArbParam_t CallData)
 

This is the earlier (i.e.

pre-v10) version of the State Change Callback function. This callback will be called whenever there is a state change in Tecplot.

Parameters:
StateChange  Identifies the state that changed.
CallData  Provides further information on the state change. The possible values for StateChange and the meaning of CallData for specific StateChange values are all described in the ADK Users manual.

typedef void(* StateChangeAddOnCallbackV2_pf)(StateChange_e StateChange)
 

This callback will be called whenever there is a state change in Tecplot.

Use one or more of the TecUtilStateChangeGetXXXX functions to retrieve supplemental information corresponding the the current state change. See The ADK users manual for more information.

Parameters:
StateChange  Identifies the state that changed.


Generated on Tue May 18 14:14:10 2004 for Tecplot by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002