bstr_error_stack_push(3) — Subroutines
Name
bstr_error_stack_push − Pushes an error code to the top of an error stack.
Syntax
bstr_t_status bstr_error_stack_push (
bstr_t_private stack,
bstr_t_status error_code,
bstr_t_string error_text);
Description
The bstr_error_stack_push procedure pushes the error code whose value is specified in error_code to the top of the error stack indicated by stack. A user-defined string associated with the entry can be stored in error_text (optional).
Arguments
stack
access: write
The address of the error stack onto which an error code is being pushed. This address must be specified in subsequent operations on the same error stack.
error_code
access: read
The value of the error code to be pushed onto the top of the error stack.
error_text
access: read
The address of an optional bstr_t_error_text variable which contains the user-defined string to be associated with the entry pushed in the error stack.
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_FULL_STACK | Stack is full |
| BSTR_S_NORMAL | Normal successful completion |
See Also
| bstr_error_stack_allocate | # |
| bstr_error_stack_clear | # |
| bstr_error_stack_free | # |
| bstr_error_stack_pop | # |