NetAlertStop or Net32AlertStop

The NetAlertStop API removes a registered client from the alert table.

Restrictions

A call to this API can be issued only from an OS/2 application to the local computer.

Syntax

#include <netcons.h>
#include <alert.h>
 
NetAlertStop(pAlertType, pszRecipient);     /* 16 bit */
 
Net32AlertStop(pAlertType, pszRecipient);     /* 32 bit */

Parameters

See Common Parameter Definitions for descriptions of parameters not defined here.

pAlertType

(const unsigned char LSFAR *) points to an ASCIIZ string indicating the type of alert to raise. The ALERT.H header file defines the following types of alerts: ┌────────────────────┬─────────────────┬───────────────────────────────────────┐
│ SYMBOLIC CONSTANT │ ASCIIZ STRING │ MEANING │
├────────────────────┼─────────────────┼───────────────────────────────────────┤
│ ALERT_ADMIN_EVENT │ "ADMIN" │ Notify an administrator. │
├────────────────────┼─────────────────┼───────────────────────────────────────┤
│ ALERT_ERRORLOG_EVEN│ "ERRORLOG" │ Entry added to error log file. │
├────────────────────┼─────────────────┼───────────────────────────────────────┤
│ ALERT_MESSAGE_EVENT│ "MESSAGE" │ User or application received a │
│ │ │ message. │
├────────────────────┼─────────────────┼───────────────────────────────────────┤
│ ALERT_PRINT_EVENT │ "PRINTING" │ Print job completed or print error. │
├────────────────────┼─────────────────┼───────────────────────────────────────┤
│ ALERT_USER_EVENT │ "USER" │ Application or resource used. │
├────────────────────┴─────────────────┴───────────────────────────────────────┤
│ NOTE: Other types of events can be defined as necessary. │
└──────────────────────────────────────────────────────────────────────────────┘

pszRecipient
(const unsigned char LSFAR *) points to an ASCIIZ string specifying the mailslot or semaphore client to receive the alerts.
Return Codes

The following table lists the return codes most significant to this API. (See API Return Codes for a complete list of return codes.) ┌─────────────────────────────┬───────┬────────────────────────────────────────┐│SYMBOLICCONSTANT │VALUE│MEANING │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_Success │ 0 │ No errors were encountered. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ ERROR_INVALID_PARAMETER │ 87 │ At least one parameter value is not │
│ │ │ valid. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_NetNotStarted │ 2102 │ The redirector NETWKSTA.200 has not │
│ │ │ been started. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_ShareMem │ 2104 │ An internal error occurred-the network │
│ │ │ cannot access a shared memory segment. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_WkstaNotStarted │ 2138 │ The Requester service has not been │
│ │ │ started. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_NoSuchAlert │ 2432 │ An incorrect or nonexistent alert name │
│ │ │ was raised. │
└─────────────────────────────┴───────┴────────────────────────────────────────┘


Other codes could be returned from the following functions:

• DosFsRamSemRequest
  
• DosFsCtl
  
• DosGetShrSeg
  
• DosSemRequest
Related Information

For information about registering a client to watch for a particular event, see Alert - NetAlertStart.

---

[Back: NetAlertStart or Net32AlertStart]
[Next: Alias Category]