bstr_event_add_subscription(3) — Subroutines
Name
bstr_event_add_subscription − Adds a subscription to an Enbox.
Syntax
bstr_t_status bstr_event_add_subscription (
bstr_t_reference ∗event,
bstr_t_reference ∗enbox,
bstr_t_confirmation confirmation,
bstr_t_boolean delete_notify,
bstr_t_boolean enabled,
bstr_t_natural priority,
bstr_t_notification_format notification_format,
bstr_t_natural user_parameter,
bstr_t_rcb ∗control);
Description
The bstr_event_add_subscription procedure adds a subscription to enbox, for the Event (or Event_Set) specified by event.
An application does not need to be connected to an Enbox in order to add subscriptions.
The event and enbox objects or definitions must exist.
Arguments
event
access: read
The reference to the Event or Event_Set being subscribed to.
enbox
access: read
The reference to the Enbox to which notifications for the subscribed Event will be delivered.
confirmation
access: read
Reserved for future use. Must be set to BSTR_C_NOT_CONFIRMED.
delete_notify
access: read
Reserved for future use. Must be set to BSTR_C_FALSE.
enabled
access: read
Indicates whether the subscription is to be considered as enabled by Event Services. The following values are permitted:
•BSTR_C_TRUE. The subscription is enabled. <LEBSTR_C_FALSE. The subscription is disabled.
priority
access: read
Reserved for future use.
notification_format
access: read
Specifies how Event Services is to format the data field in the associated Event notifications. The data field of the Event notification returns the value of the parameters that are specified by the user when the Event is declared. Possible values for notification_format are as follows:
•BSTR_C_PARAMETERS_LIST. The data field is a sequence. Each element in the sequence contains the value, size and optionally the name of the corresponding Event parameter.
•BSTR_C_FORMATTED_STRING. The data field is a sequence which returns only one element. The element value is an ASCII string that is obtained by actualizing the occurrences of the formal parameters inside the template string with the value of the corresponding Event parameters. The template string is that taken from the Event format attribute.
user_parameter
access: read
A user-specified value that Event Services returns in the associated Event notification(s). Specify any data value allowed by the UNSIGNED_32 Simple_Datatype.
control
access: read
The address of an optional request control block.
Return Values
| BSTR_S_ABORTED | Operation aborted |
| BSTR_S_ALREADY_EXIST | Object/Relation already exist |
| BSTR_S_BAD_PARAMETER | Bad parameter value |
| BSTR_S_BAD_REFERENCE | Bad reference |
| BSTR_S_COMMUNICATION_ERROR | Communication error |
| BSTR_S_COM_PC_SIZE_MISMATCH | Number of bytes requested does not match the number of bytes returned |
| BSTR_S_FINISH | Request aborted by bstr_finish |
| BSTR_S_INTERNAL_ERROR | Internal error |
| BSTR_S_INTR | Operation interrupted |
| BSTR_S_INVALID_RCB | Invalid Request Control Block |
| BSTR_S_INVALID_USAGE | Invalid reference usage |
| BSTR_S_NORMAL | Normal successful completion |
| BSTR_S_NOT_IMPLEMENTED | Not yet implemented |
| BSTR_S_NOT_INITIALIZED | BASEstar Open not initialized |
| BSTR_S_NO_MEMORY | Insufficient virtual memory |
| BSTR_S_SERVER_NOT_REACHABLE | Server not reachable |
| BSTR_S_TIMEOUT | Timeout expired |
| BSTR_S_TOO_MANY_REQUESTS | Too many pending requests |
See Also
| bstr_event_disable_subscription | # |
| bstr_event_enable_subscription | # |
| bstr_event_get_subscriptions | # |
| bstr_event_remove_subscription | # |