bstr_sequence_get_info(3) — Subroutines
Name
bstr_sequence_get_info − Retrieves information on a specified sequence.
Syntax
bstr_t_status bstr_sequence_get_info (
bstr_t_sequence ∗sequence,
bstr_t_natural32 ∗length,
bstr_t_natural32 ∗total_size,
bstr_t_natural32 ∗element_size);
Description
The bstr_sequence_get_info procedure returns the following information about the sequence whose address is specified by sequence:
•Number of elements in the sequence
•Size of the biggest element
•Total memory space used to store the sequence.
Arguments
sequence
access: read
The address of the sequence on which information is required.
length
access: write
The number of elements in the sequence. If you do not wish to retrieve this value, specify a NULL pointer.
total_size
access: write
The total number of bytes needed to store the entire sequence. If you do not wish to retrieve this value, specify a NULL pointer.
element_size
access: write
The number of bytes needed to store the biggest element in the sequence.
Return Values
| BSTR_S_BAD_DATA_ELEMENTS | Bad data elements |
| 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 |