Name

bstr_sequence_get_elements − Retrieves one or more elements from a sequence. 

Syntax

bstr_t_status   bstr_sequence_get_elements (
                                 bstr_t_sequence           ∗sequence,
                                 bstr_t_natural32          count,
                                 bstr_t_natural32          index,
                                 bstr_t_sequence_element   ∗data);

Description

The bstr_sequence_get_elements procedure retrieves count elements  from the specified sequence. Elements are extracted starting from the index position. Retrieved elements are stored in the array specified by data. The array must be large enough to store at least count elements. The first element in the array corresponds to the element at the index position. 

Arguments

sequence
access: read
 The address of the sequence from which the elements are to be retrieved.
 

count
access: read
  The number of elements to be retrieved from the sequence. To retrieve all the sequence elements,  the maximum number of elements that the sequence can contain must be specified.

index
access: read
  The position within the sequence from which to begin extracting elements. The first element is extracted from the index position. The first position from which an element can be extracted is position 1.
 

data
access: write
  The start address of an array of bstr_t_sequence_element data structures (allocated by the application) used to store the retrieved elements.  The array must have at least count elements. The first element returned in the array corresponds to the element at position index. 

Return Values