dacs_get_num_avail_children

NAME

dacs_get_num_avail_children - Return the number of children of the specified type available to be reserved.

SYNOPSIS

DACS_ERR_T dacs_get_num_avail_children ( DACS_DE_TYPE_T type, uint32_t *num_children )

Call parameter  
type The type of children to report. In SDK 3.0 this must be:
  • DACS_DE_SPE.
Return parameter  
*num_children The number of available children. This may be zero if either no children of the requested type exist, or children exist but cannot be reserved.

DESCRIPTION

The dacs_get_num_avail_children service returns the number of children of the caller of the specified type that are available for reservation.

Note: This service returns the number of children that were available at the time of the call. The actual number can change any time after the call. The number of children is only returned upon success.

RETURN VALUE

The dacs_get_num_avail_children service returns an error indicator defined as:
  • DACS_SUCCESS: normal return.
  • DACS_ERR_INVALID_ADDR: invalid pointer.
  • DACS_ERR_INVALID_ATTR: invalid flag or enumerated constant.

SEE ALSO

dacs_reserve_children(3), dacs_release_de_list(3)