bstr_sequence_discard(3) — Subroutines
Name
bstr_sequence_discard − Discards the specified sequence.
Syntax
bstr_t_status bstr_sequence_discard (
bstr_t_sequence ∗sequence);
Description
The bstr_sequence_discard procedure discards the sequence whose address is specified in sequence. Any elements in the sequence are discarded and the memory used to store them is released. The sequence address stored in sequence is set to NULL, to ensure that it can no longer be used.
References or sequences nested in the sequence being discarded are unset or discarded.
Arguments
sequence
access: read/write
The address of the sequence to be discarded.
Return Values
| BSTR_S_BAD_PARAMETER | Bad parameter value |
| BSTR_S_BAD_SEQUENCE | Bad sequence |
| BSTR_S_COM_PC_SIZE_MISMATCH | Number of bytes requested does not match the number of bytes returned |
| BSTR_S_NORMAL | Normal successful completion |
| BSTR_S_NOT_INITIALIZED | BASEstar Open not initialized |