bstr_sequence_create(3) — Subroutines

Name

bstr_sequence_create − Creates and initializes a sequence.

Syntax

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

Description

The bstr_sequence_create procedure creates a sequence and returns its address in sequence.

The created sequence contains count bstr_t_sequence_element data structure elements. The data argument identifies an array whose value is used to initialize the value of the sequence elements.

The returned sequence address must be specified for any subsequent operations on the specified sequence.

Arguments

data
access: read
The start address of an array of bstr_t_sequence_element data structures whose value is used to initialize the sequence element value. The array must contain at least count elements.

count
access: read
Specifies the number of elements in the sequence.

sequence
access: write
The address of the sequence being created. This address must be specified for any subsequent operation on the sequence being examined.

Return Values

BSTR_S_BAD_ATTRIBUTE_NAME	Bad element attribute name
BSTR_S_BAD_ELEMENT_NAME	Bad element name
BSTR_S_BAD_ELEMENT_TYPE	Bad element type
BSTR_S_BAD_ELEMENT_SIZE	Bad element size
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_NORMAL	Normal successful completion
BSTR_S_NOT_INITIALIZED	BASEstar Open not initialized
Insufficient virtual memory
T}
BSTR_S_SEQUENCE_IN_USE	Sequence already in use

bstr_sequence_append_elements	#
bstr_sequence_are_equal	#
bstr_sequence_copy	#
bstr_sequence_discard	#
bstr_sequence_get_info	#
bstr_sequence_get_elements	#
bstr_sequence_insert_elements	#