bstr_error_stack_pop(3) — Subroutines
Name
bstr_error_stack_pop − Pops an error code from the top of an error stack.
Syntax
bstr_t_status bstr_error_stack_pop (
bstr_t_private stack,
bstr_t_status ∗error_code,
bstr_t_string error_text);
Description
The bstr_error_stack_pop procedure pops an error code from the stack whose address is specified by stack, and returns its value in error_code. If present, the user-defined string associated with the entry is also returned in error_text. Any attempt to pop an entry from an empty stack causes the BSTR_C_EMPTY_STACK status code to be returned.
Arguments
stack
access: write
The address of the stack from which an element has to be popped.
error_code
access: write
The value of the error code popped from the top of the stack.
error_text
access: write
This argument returns the user-defined string associated with the popped entry. If a null string is returned, this means that no string was specified when the entry was pushed.
The application should provide the address of a bstr_t_error_text variable to receive the text, or specify the NULL value meaning that the error text must not be returned.
Return Values
| BSTR_S_BAD_PARAMETER | Bad parameter value |
| BSTR_S_COM_PC_SIZE_MISMATCH | Number of bytes requested does not match the number of bytes returned |
| BSTR_S_EMPTY_STACK | Stack is empty |
| BSTR_S_NORMAL | Normal successful completion |
See Also
| bstr_error_stack_allocate | # |
| bstr_error_stack_clear | # |
| bstr_error_stack_free | # |
| bstr_error_stack_push | # |