DH_RegisterAllPoints
DH_RegisterAllPoints — registers with the Cascade DataHub for all points.
Syntax
#include <cogent.h>
ST_STATUS DH_RegisterAllPoints( | IP_hTASK | myself, |
| | char* | domain, |
| | int | future, |
| | IP_hMSG | hmsg, |
| | ER_hLIST | elist); |
Arguments
- myself
- The
task handle associated with this task. This should always be
the return value from IP_NserveInit.
- domain
- The
DataHub domain on which to register. If the domain is NULL,
then the current domain is used and all exceptions will be
transmitted with unqualified names. If a valid domain is
specified, then all exceptions will be transmitted with
qualified names, even if the domain is the current domain for
the application.
- future
- A flag indicating whether points which
are created on the DataHub subsequent to
this call should also be registered
automatically. 0 = do not automatically
register future points. 1 = automatically
register future points
- 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 informs the
DataHub that this task should receive exceptions on all
points. If the future flag is set, then the DataHub will
automatically begin to inform the task of any points which are
created on the DataHub subsequent to this call. This call will
cause an exception to be generated from the DataHub for every point,
specifically to this task (not to other tasks that may also be
registered).
