ARDeregisterForAlerts

Note

You can continue to use C APIs to customize your application, but C APIs are not enhanced to support new capabilities provided by Java APIs and REST APIs.

Description

Cancels registration for the specified user on the specified and port. The system deletes the user from the active list and stops delivering alerts.

Privileges

All users.

Synopsis

#include "ar.h"
#include "arerrno.h"
#include "arextern.h"
#include "arstruct.h"

int ARDeregisterForAlerts
  ARControlStruct *control,
  int clientPort,
  ARStatusList *status)

Input arguments

control

The control record for the operation. It contains information about the user requesting the operation, where that operation is to be performed, and which session is used to perform it. The user and server fields are required.

clientPort

The TCP port that the client uses. Client programs can use different port numbers to register with the same server multiple times, but must deregister individually.

Return values

status

A list of zero or more notes, warnings, or errors generated from a call to this function. For a description of all possible values, see Error-checking.