Function dds_read_next_wl¶

  • Defined in File dds.h

Function Documentation¶

dds_return_t dds_read_next_wl(dds_entity_t reader, void **buf, dds_sample_info_t *si)¶

Read and copy the status set for the loaned sample.

This operation copies the next, non-previously accessed data value and corresponding loaned sample info. As an entity, only reader is accepted.

After dds_read_next_wl function is being called and the data has been handled, dds_return_loan function must be called to possibly free memory.

Parameters
  • reader – [in] The reader entity.

  • buf – [out] An array of pointers to samples into which data is read (pointers can be NULL).

  • si – [out] The pointer to dds_sample_info_t returned for a data value.

Returns

A dds_return_t indicating success or failure.

Returns

  • DDS_RETCODE_OK – The operation was successful.

  • DDS_RETCODE_BAD_PARAMETER – The entity parameter is not a valid parameter.

  • DDS_RETCODE_ILLEGAL_OPERATION – The operation is invoked on an inappropriate object.

  • DDS_RETCODE_ALREADY_DELETED – The entity has already been deleted.

CycloneDDS

Navigation

Contents

  • Installing Eclipse Cyclone DDS
  • Building Eclipse Cyclone DDS applications
  • Hello World! in more detail
  • What’s next?
  • Uninstalling Eclipse Cyclone DDS
  • A guide to the configuration options of Eclipse Cyclone DDS
  • DDS Security
  • Shared Memory
  • Eclipse Cyclone DDS C API Reference

Related Topics

  • Documentation overview
    • Eclipse Cyclone DDS C API Reference
      • Raw C API
        • Previous: Function dds_read_next
        • Next: Function dds_read_status

Quick search

©2021, CycloneDDS committers. | Powered by Sphinx 4.3.1 & Alabaster 0.7.12 | Page source