bstr_enbox_get_info(3) — Subroutines
Name
bstr_enbox_get_info − Returns run-time information on a specified Enbox (VODB only).
Syntax
bstr_t_status bstr_enbox_get_info (
bstr_t_reference ∗enbox,
bstr_t_rcb ∗control,
bstr_t_enbox_info ∗info);
Description
The bstr_enbox_get_info procedure returns run-time information on the specified SYSTEM_BUFFERING enbox. It stores the information in a bstr_t_enbox_info type structure.
The bstr_enbox_get_info procedure does not support USER_BUFFERING Enboxes.
Arguments
enbox
access: read
The reference to the Enbox object whose run-time information is to be obtained.
control
access: read
The address of an optional request control block.
info
access: write
The address of a bstr_t_enbox_info structure which returns the retrieved run-time information.
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_INITIALIZED | BASEstar Open not initialized |
| BSTR_S_SERVER_NOT_REACHABLE | Server not reachable |
| BSTR_S_TIMEOUT | Timeout expired |
| BSTR_S_TOO_MANY_REQUESTS | Too many pending requests |