summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--src/lib/tng_io.h10
1 files changed, 4 insertions, 6 deletions
diff --git a/src/lib/tng_io.h b/src/lib/tng_io.h
index 885b8c2..4357285 100644
--- a/src/lib/tng_io.h
+++ b/src/lib/tng_io.h
@@ -698,9 +698,8 @@ tng_function_status tng_frame_write_interval(tng_trajectory_t tng_data,
file to read from. If the file (input_file) is not open it will be opened.
block_id is the id number of the data block to read.
***values is a pointer to a 2-dimensional array (memory unallocated), which will
- be filled with data. The array will be sized (n_frames * n_values_per_frame).
- Since ***values is allocated in this function it is the callers responsibility
- to free the memory.
+ point to the data of the requested data block. The array will be sized
+ (n_frames * n_values_per_frame).
Returns TNG_SUCCESS (0) if successful, TNG_FAILURE (1) if a minor error
has occurred or TNG_CRITICAL (2) if a major error has occured. */
tng_function_status tng_data_get(tng_trajectory_t tng_data,
@@ -730,9 +729,8 @@ tng_function_status tng_data_interval_get(tng_trajectory_t tng_data,
file to read from. If the file (input_file) is not open it will be opened.
block_id is the id number of the particle data block to read.
****values is a pointer to a 3-dimensional array (memory unallocated), which will
- be filled with data. The array will be sized (n_frames * n_particles * n_values_per_frame).
- Since ****values is allocated in this function it is the callers responsibility
- to free the memory.
+ point to the data of the requested data block. The array will be sized
+ (n_frames * n_particles * n_values_per_frame).
Returns TNG_SUCCESS (0) if successful, TNG_FAILURE (1) if a minor error
has occurred or TNG_CRITICAL (2) if a major error has occured. */
tng_function_status tng_particle_data_get(tng_trajectory_t tng_data,
contact: Jan Huwald // Impressum