bstr_enbox_receive_notification(3) — Subroutines

Name

bstr_enbox_receive_notification − Receives an Event notification queued at an Enbox (VODB only).

Syntax

bstr_t_status   bstr_enbox_receive_notification (
                              bstr_t_reference             ∗enbox,
                              bstr_t_rcb                   ∗control,
                              bstr_t_event_notification    ∗message);

Description

The bstr_enbox_receive_notification procedure allows an application to receive an Event Notification pending at the Enbox specified by enbox. The information associated with the Event notification is returned in the data structure addressed by message.

The bstr_enbox_receive_notification procedure can only be invoked for an Enbox if the application previously issued the bstr_enbox_connect procedure for that Enbox.

Only one call to the bstr_enbox_receive_notification procedure can be queued at an Enbox at any given time.

Arguments

enbox
access: read
The reference to the Enbox from which the Event notification is to be received.

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

message
access: read/write
The address of a bstr_t_event_notification type data structure, in which the procedure returns the information associated with the received Event notification.

Return Values

BSTR_S_ABORTED	Operation aborted
BSTR_S_ALREADY_ACTIVE	Operation already active
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_OPERATION	Invalid operation
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_REFERENCE_IN_USE	Reference already in use
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