bstr_event_get_subscriptions(3) — Subroutines

Name

bstr_event_get_subscriptions − Retrieves all the subscriptions associated with an Event or an Event_Set.

Syntax

bstr_t_status   bstr_event_get_subscriptions (
                                  bstr_t_reference   ∗event,
                                  bstr_t_rcb         ∗control,
                                  bstr_t_sequence    ∗subscriptions);

Description

The bstr_event_get_subscriptions procedure returns in subscriptions a sequence of zero or more elements. Each element contains information about a subscription to the Event (or Event_Set) indicated by Event.

Arguments

event
access: read
The reference to the Event (or Event_Set) whose associated subscriptions you wish to retrieve.

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

subscriptions
access: write
The address of the sequence which returns the existing subscriptions to the specified Event condition or Event_Set.

The significant fields in each element of the sequence are as follows:

•type
Set to BSTR_C_EVENT_SUBSCRIPTION.

•size
The size of the bstr_t_event_subscription data structure.

•value
The address of a bstr_t_event_subscription data structure.

Return Values

BSTR_S_ABORTED	Operation aborted
BSTR_S_BAD_BUFFER	Bad sequence buffer
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_INITIALIZED	BASEstar Open not initialized
BSTR_S_NOT_IMPLEMENTED	Not yet implemented
BSTR_S_NO_MEMORY	Insufficient virtual memory
BSTR_S_SEQUENCE_IN_USE	Sequence already in use
BSTR_S_SERVER_NOT_REACHABLE	Server not reachable
BSTR_S_TIMEOUT	Timeout expired
BSTR_S_TOO_MANY_REQUESTS	Too many pending requests

bstr_event_add_subscription	#
bstr_event_disable_subscription	#
bstr_event_enable_subscription	#
bstr_event_remove_subscription	#