MemCom Reference Manual > MemCom C API Manual Pages > Database Manager Functions > mcDBgetStream

Name

mcDBgetStream — Read from stream

Synopsis

#include <memcom.h>

int mcDBgetStream(int handle, char* type, mcOff address, mcSize size,
                  void* buffer);

Description

mcDBgetStream reads a contiguous array data from a database in a user buffer. Data are copied from the database starting at a given byte address. If the start address plus the number of bytes specified exceed the current file size, the exceeding bytes of the array are set to 0. Upon successful completion of the operation, the status value 0 is returned. A negative value is returned, if an error has been detected. A positive value is returned, if a warning has been issued.

Parameters

handle

Database handle (input).

type

Dataset type (input). Must be one of K (char), I (mcInt32), J (mcInt64), E (mcFloat32), F (mcFloat64).

address

Byte address on database where the array starts (input). The byte address must be greater or equal to 0.

size

Number of elements to be read from the file to buffer (input).

buffer

Buffer containing data to be transferred (input). The data must correspond to the dataset type specified by the type parameter.

See also

mcDBputStream