bstr_enbox_connect(3) — Subroutines

Name

bstr_enbox_connect − Connects the application to an Enbox (VODB only).

Syntax

bstr_t_status   bstr_enbox_connect (
                                 bstr_t_reference ∗enbox,
                                 bstr_t_boolean    flush,);
                                 bstr_t_dcb        delivery,
                                 bstr_t_rcb        ∗control);

Description

The bstr_enbox_connect procedure connects the calling application to the Enbox indicated by enbox. Once connected, the calling application has exclusive access and can receive notifications of Events to which the Enbox is subscribed.

For system buffering Enboxes only, the flush argument indicates whether any Event notifications pending on the system buffering Enbox are to be discarded or retained.

Arguments

enbox
access: read
The reference to the Enbox to be connected.

flush
access: read
For system buffering Enboxes, only. Indicates whether any Event notifications pending on the system buffering Enbox are to be discarded or retained. Possible values are:

•
BSTR_C_TRUE. Discard pending Event notifications.

•
BSTR_C_FALSE. Retain pending Event notifications.

delivery
access: read
Reserved for future use.

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

Return Values

BSTR_S_ABORTED	Operation aborted
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_SERVER_NOT_REACHABLE	Server not reachable
BSTR_S_TOO_MANY_REQUESTS	Too many pending requests
BSTR_S_TIMEOUT	Timeout expired

Museum