ProviewR Programmer's Reference Manual  V6.1.4
Classes | Typedefs | Enumerations | Functions
rt_mh_appl.h File Reference

Include file for MhAppl MessageHandler API. More...

#include "rt_mh.h"
#include "rt_mh_net.h"

Go to the source code of this file.

Classes

struct  mhs_ApplMessage
 The structure describing an application message. More...
 

Typedefs

typedef struct mhs_ApplMessage mh_sApplMessage
 

Enumerations

enum  mh_mApplFlags { mh_mApplFlags_NoAbortCleanUp = (1 << 0) , mh_mApplFlags_NoAbortMsg = (1 << 1) }
 Flags governing how mh interacts with the application. More...
 

Functions

pwr_tStatus mh_ApplCancel (pwr_tUInt32 id, pwr_tString80 *cancelText)
 Cancel a message previously created by this application. More...
 
pwr_tStatus mh_ApplConnect (pwr_tObjid ApplObject, mh_mApplFlags Flags, const pwr_tString80 AbortEventName, mh_eEvent AbortEventType, mh_eEventPrio AbortEventPrio, mh_mEventFlags AbortEventFlags, const pwr_tString80 AbortEventText, pwr_tUInt32 *NoOfActMessages)
 Connects this application to the local Handler. More...
 
pwr_tStatus mh_ApplDisconnect ()
 Informs the local Handler to remove this Application from its list of known applications. More...
 
pwr_tStatus mh_ApplMessage (pwr_tUInt32 *Id, mh_sApplMessage *Message)
 This routine is called by an application to create and send a message. More...
 
pwr_tStatus mh_ApplReturn (pwr_tUInt32 Id, pwr_tString80 *ReturnText)
 Set return status on a message previously created by this application. More...
 
pwr_tStatus mh_ApplGetMsgInfo (pwr_tUInt32 Id, mh_sApplMessage *Message)
 Fetches the properties of an earlier sent message. More...
 

Detailed Description

Include file for MhAppl MessageHandler API.

Definition in file rt_mh_appl.h.