DH_UnregisterPoint

Cogent API and Utilities: Version 4.1
Prev |  | Next

# `DH_UnregisterPoint`

`DH_UnregisterPoint` -- unregisters a point from the Cascade DataHub.

## Syntax

    #include <cogdb.h>

``ST_STATUS DH_UnregisterPoint`(IP_Task* myself, PT_pCPOINT ppoint, IP_Msg* hmsg, ER_hLIST elist);`

## Arguments

`myself`

  The task handle associated with this task. This should always be the return value from `IP_NserveInit`.

`ppoint`

  A pointer to a Cascade DataHub point structure, which must contain at least `name`. All other fields in the point structure should be `0` if this is the first call on this point, because they will be filled in by this call. Subsequent calls on the same point do not require zeroing any fields. If one point structure is used with several point names, the address field must be zeroed each time a different name is used in a call to this function.

`hmsg`

  A handle to a previously allocated message structure (using IP_MsgCreate) providing enough buffer space to handle the inter-process communication associated with the datahub transaction.

`elist`

  A return value containing error information. This is unimplemented in this version, and should be `NULL`.

## Returns

`ST_OK` on success, `ST_ERROR` on failure, or some other value of `ST_STATUS`.

## Description

This function stops the Cascade DataHub from transmitting exceptions for the `ppoint`.

## See Also

DH_RegisterPoint

Prev | Home | Next
`DH_SetTransmitFormat` | Up | `DH_WritePoint`, `DH_WriteExistingPoint`, `DH_WriteExistingPoints`

Copyright 1995-2002 by Cogent Real-Time Systems, Inc.