rt_mh_appl.h

Go to the documentation of this file.

/*
 * ProviewR   Open Source Process Control.
 * Copyright (C) 2005-2025 SSAB EMEA AB.
 *
 * This file is part of ProviewR.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 2 of
 * the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with ProviewR. If not, see <http://www.gnu.org/licenses/>
 *
 * Linking ProviewR statically or dynamically with other modules is
 * making a combined work based on ProviewR. Thus, the terms and
 * conditions of the GNU General Public License cover the whole
 * combination.
 *
 * In addition, as a special exception, the copyright holders of
 * ProviewR give you permission to, from the build function in the
 * ProviewR Configurator, combine ProviewR with modules generated by the
 * ProviewR PLC Editor to a PLC program, regardless of the license
 * terms of these modules. You may copy and distribute the resulting
 * combined work under the terms of your choice, provided that every
 * copy of the combined work is accompanied by a complete copy of
 * the source code of ProviewR (the version used to produce the
 * combined work), being distributed under the terms of the GNU
 * General Public License plus this exception.
 */
 
#ifndef rt_mh_appl_h
#define rt_mh_appl_h
 
#define RS_MH_APPL_VERSION "X2.3.1"
 
#include "rt_mh.h"
#include "rt_mh_net.h"
 
#if defined __cplusplus
extern "C" {
#endif
 
/* Structures */
 
typedef struct mhs_ApplMessage mh_sApplMessage;
 
typedef enum {
  mh_mApplFlags_NoAbortCleanUp
  = (1 << 0), 
  mh_mApplFlags_NoAbortMsg
  = (1 << 1) 
} mh_mApplFlags;
 
struct mhs_ApplMessage {
  pwr_tUInt32 Id; 
  pwr_tObjid
      Object; 
  pwr_tObjid SupObject; 
  pwr_tObjid Outunit; 
  mh_mEventFlags
      EventFlags; 
  pwr_tTime EventTime; 
  pwr_tString80 EventName; 
  mh_eEvent
      EventType; 
  pwr_tString80 EventText; 
  mh_eEventPrio
      EventPrio; 
  mh_mEventStatus EventStatus; 
  mh_uSupInfo SupInfo; 
  pwr_sAttrRef
      EventSound; 
  pwr_tString256 EventMoreText; 
};
 
pwr_tStatus mh_ApplCancel(pwr_tUInt32 id, pwr_tString80* cancelText);
 
/*------------------------------------------------------------------------------
* Connects this application to the local Handler.
*/
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);
 
/*------------------------------------------------------------------------------
* Informs the local Handler to remove this Application from its list of known
* applications.
*/
pwr_tStatus mh_ApplDisconnect();
 
/*------------------------------------------------------------------------------
* Send a message to the local Handler.
*/
pwr_tStatus mh_ApplMessage(pwr_tUInt32* Id, mh_sApplMessage* Message);
 
/*------------------------------------------------------------------------------
* This function returnes a message previously created by this application.
*/
pwr_tStatus mh_ApplReturn(pwr_tUInt32 Id, pwr_tString80* ReturnText);
 
/*------------------------------------------------------------------------------
*/
pwr_tStatus mh_ApplGetMsgInfo(pwr_tUInt32 Id, mh_sApplMessage* Message);
 
#if defined __cplusplus
}
#endif
 
#endif