/**************************************************************************/
/*                                                                        */
/*              IBM OS/2(tm) Local Area Network (LAN) Server              */
/*                            Version 3.0                                 */
/* (c) Copyright International Business Machines Corporation, 1988, 1992  */
/*                                                                        */
/**************************************************************************/


/********************************************************************
 *
 *  About this file ...  ALERT.H
 *
 *  This file contains information about the NetAlert APIs.
 *
 *	Function prototypes.
 *
 *	Data structure templates.
 *
 *	Definition of special values.
 *
 *
 *  NOTE:  You must include NETCONS.H before this file, since this
 *	   file	depends on values defined in NETCONS.H.
 *
 *  NOTE:  ALERT.H includes ALERTMSG.H, which defines the alert message
 *	   numbers.
 *
 ********************************************************************/


#ifdef  INCL_32
#pragma pack(1)
#endif


#ifndef NETALERT_INCLUDED

#define NETALERT_INCLUDED


#include "alertmsg.h"


/****************************************************************
 *                                                              *
 *              Function prototypes                             *
 *                                                              *
 ****************************************************************/

extern API_FUNCTION
  NetAlertRaise ( const char LSFAR * pszEvent,
                  const char LSFAR * pbBuffer,
                  unsigned short     cbBuffer,
                  unsigned long      ulTimeout );

extern API_FUNCTION
  NetAlertStart ( const char LSFAR * pszEvent,
                  const char LSFAR * pszRecipient,
                  unsigned short     cbMaxData );

extern API_FUNCTION
  NetAlertStop ( const char LSFAR * pszEvent,
                 const char LSFAR * pszRecipient );


/****************************************************************
 *								*
 *	  	Data structure templates			*
 *								*
 ****************************************************************/


/***   Standard alert structure
 */

struct std_alert
{
        long    alrt_timestamp;
        char    alrt_eventname[EVLEN+1];
	char	alrt_pad1;
        char    alrt_servicename[SNLEN+1];
};

/*
 *	The following macro gives a pointer to the other_info data.
 *	It takes a "struct std_alert *" and returns a "char *".
 */

#define ALERT_OTHER_INFO(x)    ((char *)(x)     + sizeof(struct std_alert))
#define ALERT_OTHER_INFO_F(x)  ((char LSFAR *)(x) + sizeof(struct std_alert))

/*
 *	The following macro gives a pointer to the variable-length data.
 *	It takes a pointer to one of the other-info structs and
 *	returns a "char *".
 */

#define ALERT_VAR_DATA(p)      ((char *)(p)     + sizeof(*p))
#define ALERT_VAR_DATA_F(p)    ((char LSFAR *)(p) + sizeof(*p))


/***   Print alert other-info structure
 */

struct print_other_info {
        short   alrtpr_jobid;       /* Job ID for job */
        short   alrtpr_status;      /* Status word from job info struct */
				    /* bit 15 == 1 means job deleted */
        long    alrtpr_submitted;   /* When submitted */
        long    alrtpr_size;        /* Bytes in job */
};

/*	Followed by (consecutive ASCIIZ strings) ...
 *
 *		computername
 *		username
 *		queuename
 *		destination
 *		status string
 */

/***   Error log alert other-info structure
 */

struct errlog_other_info {
	short	alrter_errcode;
	long	alrter_offset;
};

/***   Admin alert other-info structure
 */

struct admin_other_info {
	short	alrtad_errcode;		/* code for message in net error message file */
	short	alrtad_numstrings;	/* the number of merge strings 0-9 */
};

/*	Followed by merge strings (consecutive ASCIIZ strings, count
 *	is in alrtad_numstrings field).
 */


/***   User alert other-info structure
 */

struct user_other_info {
	short	alrtus_errcode;	/* code for message in net error message file */
	short	alrtus_numstrings;	 /* the number of merge strings 0-9 */
};

/*	Followed by merge strings (consecutive ASCIIZ strings, count
 *	is in alrtus_numstrings field).
 *
 *	Further followed by (consecutive ASCIIZ strings) ...
 *
 *		username
 *		computername
 */




/***	Time set alert other-info structure.
 *
 *	Provides detailed information about a change in the system clock.
 */

struct timeset_other_info {
	unsigned long	alrtts_old_time;
	unsigned long	alrtts_new_time;
	unsigned long	alrtts_old_msec;
	unsigned long	alrtts_new_msec;
	unsigned char	alrtts_old_hsec;
	unsigned char	alrtts_new_hsec;
	unsigned short	alrtts_old_tz;
	unsigned short	alrtts_new_tz;
};


/****************************************************************
 *								*
 *	  	Special values and constants			*
 *								*
 ****************************************************************/

/*
 *	Names of standard Microsoft-defined alert events.
 */

#define ALERT_PRINT_EVENT	"PRINTING"
#define ALERT_MESSAGE_EVENT	"MESSAGE"
#define ALERT_ERRORLOG_EVENT	"ERRORLOG"
#define ALERT_ADMIN_EVENT	"ADMIN"
#define ALERT_USER_EVENT	"USER"

/*
 * 	Three suggested timeouts (in milliseconds) for NetAlertRaise.
 */

#define ALERT_SHORT_WAIT	100L
#define ALERT_MED_WAIT		1000L
#define ALERT_LONG_WAIT		10000L



#endif /* NETALERT_INCLUDED */

#ifdef  INCL_32
#pragma linkage (NetAlertRaise, far16 pascal)
#pragma linkage (NetAlertStart, far16 pascal)
#pragma linkage (NetAlertStop, far16 pascal)
#pragma pack()
#endif
