Using the EXITPARAM Structure

Function prototype

The function to be executed must be a function in a library with the following prototype:

void MyFunc(LPEXITPARAM lpep);

Definition of the EXITPARAM structure

The definition of the EXITPARAM structure is as follows:

struct tagExitParamStruct
{
   DWORD         dwSize;
   DWORD         dwToLen;
   DWORD         dwFromLen;
   DWORD         dwMapInstance;
   void FAR *    lpv;
   LPSTR         lpszCmdLine;
   BYTE HUGE *   lpDataToApp;
   BYTE HUGE *   lpDataFromApp;
   UINT          uRetryCount;
   UINT          uRetryInterval;
   BOOL          bRollback;
   BOOL          bCleanup;
   int           nReturn;
   char          szErrMsg[100];
   char          szFile[260];
   void FAR *    lpMapHandle;
   void FAR *    lpInternal;
   void FAR *    lpCmdStruct;
   void FAR *    lpAdaptParms;
   void FAR *    lpContext;
   void FAR *    lpWildcard;
   void FAR *    lpfnMS;
   void FAR *    lpMS;
   DWORD         dwWildcardSize;
   LPSTR         lpszMapDirectory;
   WORD          wCardNum;
   WORD          wCleanupAction;
   WORD          wScope;
   UINT          uUnitSize;
   BOOL          bBurst;
   BOOL          bFromRule;
   BOOL          bSource;
   DWORD         dwRecords;
};
typedef struct tagExitParamStruct EXITPARAM;
typedef struct tagExitParamStruct FAR * LPEXITPARAM;

The engine environment sets up the EXITPARAM structure and the function should fill in the result. The engine will allocate and free the memory associated with lpDataToApp. The function must allocate the memory for lpDataFromApp. For all Windows operating systems, use the Windows macro GlobalAllocPtr defined in windowsx.h. For all other operating systems, use the C-runtime malloc function. The engine will free this memory.

There is no interaction with the nReturn or szErrMsg fields. However, this might change in a future release.