ADDON.h File Reference

Go to the source code of this file.

Typedefs
typedef void(*	StateChangeAddOnCallbackWithClient_pf )(StateChange_e StateChange, ArbParam_t ClientData)
	Use this statechange callback API if you want the callback function to receive client data.
typedef void(*	StateChangeAddOnCallbackV2_pf )(StateChange_e StateChange)
	This callback will be called whenever there is a state change in Tecplot.
typedef void(*	StateChangeAddOnCallback_pf )(StateChange_e StateChange, ArbParam_t CallData)
	This is the earlier version (before version 10) of the State Change Callback function.
typedef Boolean_t(*	MacroCommandExtCallback_pf )(char *CommandString, char **ErrMsg)
	Execute an extended macro command.
typedef Boolean_t(*	MacroCommandAddOnCallback_pf )(char *CommandString, char **ErrMsg)
typedef Boolean_t(*	MopupQueryAddOnCallback_pf )(void)
	This callback is called when tecplot is in the initial phases of quitting.
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 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)

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

Execute an extended macro command.

This is the callback that is responsible for performing the macro command action when the $!EXTENDEDCOMMAND macro command associated with the CommandProcessorIDString 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 function's 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.

Fortran Syntax:

    INTEGER*4 FUNCTION MyMacroCommandCallback(
   &                   CommandString,
   &                   ErrMsgString)
    CHARACTER*(*)   CommandString
    CHARACTER*(*)   ErrMsgString

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.

Fortran Syntax:

 INTEGER*4 FUNCTION MyMopupQueryAddOnCallback()

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

This is the earlier version (before version 10) 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.

Fortran Syntax:

   SUBROUTINE MyStateChangeCallback(
  &            StateChange,
  &            CallDataPtr)
   INTEGER*4 StateChange
   POINTER   (CallDataPtr, DummyCallData)

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.

Fortran Syntax:

   SUBROUTINE MyStateChangeV2Callback(
  &            StateChange)
   INTEGER*4 StateChange

typedef void(* StateChangeAddOnCallbackWithClient_pf)(StateChange_e StateChange, ArbParam_t ClientData)

Use this statechange callback API if you want the callback function to receive client data.

Parameters:

	StateChange	Identifies the state that changed.
	ClientData	Client data supplied in TecUtilStateChangeAddCallbackX.

Fortran Syntax:

   SUBROUTINE MyStateChangeCallback(
  &            StateChange,
  &            CallDataPtr)
   INTEGER*4 StateChange
   POINTER   (CallDataPtr, DummyClientData)