Function dds_data_allocator_init_heap

Function Documentation

dds_return_t dds_data_allocator_init_heap(dds_data_allocator_t *data_allocator)

Initialize an object for performing standard allocations/frees on the heap.

Parameters

  • data_allocator – [out] opaque allocator object to initialize

Return values

  • DDS_RETCODE_OK – the allocator object was successfully initialized

  • DDS_RETCODE_BAD_PARAMETER – entity is invalid, data_allocator is a null pointer

  • DDS_RETCODE_PRECONDITION_NOT_MET – Cyclone DDS is not initialized

  • DDS_RETCODE_ILLEGAL_OPERATION – operation not supported on this entity

Returns

success or a generic error indication