dacs_reserve_children

NAME

dacs_reserve_children - Reserve children of a specified type.

SYNOPSIS

DACS_ERR_T dacs_reserve_children ( DACS_DE_TYPE_T type, uint32_t *num_children , de_id_t *de_list )

Call parameters  
type The type of children to report. In SDK 3.0 this must be:
  • DACS_DE_SPE.
*num_children A pointer to the number of children requested.
Return parameters  
*num_children A pointer to the number of children actually reserved. This may be less than or equal to the number requested.
*de_list A pointer to a location where the list of reserved children is returned. The space for this list must be allocated by the caller and must have enough room for num_children entries.

DESCRIPTION

The dacs_reserve_children service attempts to reserve the requested number of children of the specified type. The actual number reserved may be less than or equal to the number requested. The actual number and list of reserved children is returned to the caller.

RETURN VALUE

The dacs_reserve_children service returns an error indicator defined as:
  • DACS_SUCCESS: normal return.
  • DACS_ERR_INVALID_ATTR: invalid flag or enumerated constant.
  • DACS_ERR_INVALID_ADDR: invalid pointer.
  • DACS_ERR_INVALID_SIZE: number of children requested must be greater than zero.

SEE ALSO

dacs_get_num_avail_children(3), dacs_release_de_list(3)