Name

bstr_event_declare − Declares an Event (VODB only). 

Syntax

bstr_t_status   bstr_event_declare (
                                  bstr_t_reference   ∗event
                                  bstr_t_string      origin,
                                  bstr_t_descriptor  ∗parameters,
                                  bstr_t_rcb         ∗control);

Description

The bstr_event_declare procedure declares the Event specified by event. As a result, an Event notification is delivered to all the Enboxes for which subscriptions exist for the declared Event. 

Context information can be passed using the associated parameters argument. 

Arguments

event
access: read
The reference to the Event condition being declared.

origin
access: read
A string containing a user-defined message (maximum length BSTR_C_BUFFER_LEN.

parameters
access: read
The address of a bstr_t_descriptor data structure that specifies the number of elements and the address of an array containing the parameter’s value. Each array element contains a pointer to a bstr_t_named_value data structure. 

The parameters argument is set to NULL if no context parameter values are to be supplied. The same applies if the length or data argument in the descriptor is set to zero or NULL, respectively. If an array element contains NULL, it means that the value of the corresponding parameter has not been supplied. 

Each bstr_t_named_value data structure contains the value, size and the name of the corresponding Event parameter (optional). The correspondence of a passed value to a parameter name is based on the position of the value in the parameter list. 

control
access: read
The address of an optional request control block.

Return Values