DWDataReader 5.0.1
Reading data from Dewesoft data files
Loading...
Searching...
No Matches
DWDataReaderLibFuncs.h File Reference
#include "DWDataReaderLibDef.h"
#include "DWDataReaderLibTypes.h"

Go to the source code of this file.

Functions

DWLIB_API enum DWStatus DWGetLastStatus (enum DWStatus *status, char *statusMsg, int *statusMsgSize)
 Retrieves the status and error message from last operation.
 
DWLIB_API enum DWStatus DWInit ()
 Initializes the DWDataReader library.
 
DWLIB_API enum DWStatus DWDeInit ()
 Deinitializes the DWDataReader library.
 
DWLIB_API enum DWStatus DWAddReader ()
 Creates a new reader within the shared reader pool.
 
DWLIB_API enum DWStatus DWGetNumReaders (int *num_readers)
 Retrieves the number of readers in the shared reader pool.
 
DWLIB_API enum DWStatus DWSetActiveReader (int index)
 Sets the active reader in the shared reader pool.
 
DWLIB_API enum DWStatus DWICreateReader (READER_HANDLE *handle)
 Creates a new reader instance handle.
 
DWLIB_API enum DWStatus DWIDestroyReader (READER_HANDLE handle)
 Destroys the specified reader instance.
 
DWLIB_API int DWGetVersion ()
 Gets the version number of the DWDataReader library.
 
DWLIB_API enum DWStatus DWGetVersionEx (int *major, int *minor, int *patch)
 Gets the version number of the DWDataReader library in major, minor, and patch format.
 
DWLIB_API enum DWStatus DWOpenDataFile (char *file_name, struct DWFileInfo *file_info)
 Opens the specified file and fills the file_info structure with information about the file contents.
 
DWLIB_API enum DWStatus DWIOpenDataFile (READER_HANDLE reader, char *file_name, struct DWFileInfo *file_info)
 Opens the specified file and fills the file_info structure with information about the file contents using a specific reader instance.
 
DWLIB_API enum DWStatus DWCloseDataFile ()
 Closes the currently open data file.
 
DWLIB_API enum DWStatus DWICloseDataFile (READER_HANDLE reader)
 Closes the currently open data file for a specific reader instance.
 
DWLIB_API enum DWStatus DWGetMeasurementInfo (struct DWMeasurementInfo *measurement_info)
 Retrieves detailed information about the current measurement.
 
DWLIB_API enum DWStatus DWIGetMeasurementInfo (READER_HANDLE reader, struct DWMeasurementInfo *measurement_info)
 Retrieves detailed information about the current measurement using a specific reader instance.
 
DWLIB_API int DWGetChannelListCount ()
 Retrieves the number of available channels.
 
DWLIB_API enum DWStatus DWIGetChannelListCount (READER_HANDLE reader, int *count)
 Retrieves the number of available channels using a specific reader instance.
 
DWLIB_API int DWGetComplexChannelListCount ()
 Retrieves the number of available complex channels.
 
DWLIB_API enum DWStatus DWIGetComplexChannelListCount (READER_HANDLE reader, int *count)
 Retrieves the number of available complex channels using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetComplexChannelList (struct DWChannel *channel_list)
 Retrieves the list of available complex channels.
 
DWLIB_API enum DWStatus DWIGetComplexChannelList (READER_HANDLE reader, struct DWChannel *channel_list)
 Retrieves the list of available complex channels using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetChannelList (struct DWChannel *channel_list)
 Retrieves the list of available channels.
 
DWLIB_API enum DWStatus DWIGetChannelList (READER_HANDLE reader, struct DWChannel *channel_list)
 Retrieves the list of available channels using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetChannelFactors (int ch_index, double *scale, double *offset)
 Retrieves scaling factors for a specified channel.
 
DWLIB_API enum DWStatus DWIGetChannelFactors (READER_HANDLE reader, int ch_index, double *scale, double *offset)
 Retrieves scaling factors for a specified channel using a specific reader instance.
 
DWLIB_API __int64 DWGetScaledSamplesCount (int ch_index)
 Retrieves the count of scaled samples available for a specified channel.
 
DWLIB_API enum DWStatus DWIGetScaledSamplesCount (READER_HANDLE reader, int ch_index, __int64 *count)
 Retrieves the count of scaled samples available for a specified channel using a specific reader instance.
 
DWLIB_API __int64 DWGetComplexScaledSamplesCount (int ch_index)
 Retrieves the count of scaled samples available for a specified complex channel.
 
DWLIB_API enum DWStatus DWIGetComplexScaledSamplesCount (READER_HANDLE reader, int ch_index, __int64 *count)
 Retrieves the count of scaled samples available for a specified complex channel using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetScaledSamples (int ch_index, __int64 position, int count, double *data, double *time_stamp)
 Retrieves a series of scaled samples and their timestamps for a specified channel.
 
DWLIB_API enum DWStatus DWIGetScaledSamples (READER_HANDLE reader, int ch_index, __int64 position, int count, double *data, double *time_stamp)
 Retrieves a series of scaled samples and their timestamps for a specified channel using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetComplexScaledSamples (int ch_index, __int64 position, int count, struct DWComplex *data, double *time_stamp)
 Retrieves a series of complex scaled samples and their timestamps for a specified channel.
 
DWLIB_API enum DWStatus DWIGetComplexScaledSamples (READER_HANDLE reader, int ch_index, __int64 position, int count, struct DWComplex *data, double *time_stamp)
 Retrieves a series of complex scaled samples and their timestamps for a specified channel using a specific reader instance.
 
DWLIB_API int DWGetEventListCount ()
 Retrieves the count of events available in the current event list.
 
DWLIB_API enum DWStatus DWIGetEventListCount (READER_HANDLE reader, int *count)
 Retrieves the count of events available in the current event list using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetEventList (struct DWEvent *event_list)
 Retrieves the list of events from the current event list.
 
DWLIB_API enum DWStatus DWIGetEventList (READER_HANDLE reader, struct DWEvent *event_list)
 Retrieves the list of events from the current event list using a specific reader instance.
 
DWLIB_API enum DWStatus DWExportHeader (char *file_name)
 Exports the setup information to a specified file.
 
DWLIB_API enum DWStatus DWIExportHeader (READER_HANDLE reader, char *file_name)
 Exports the setup information to a specified file using a specific reader instance.
 
DWLIB_API int DWGetTextChannelListCount ()
 Retrieves the count of text channels available in the current context.
 
DWLIB_API enum DWStatus DWGetTextChannelList (struct DWChannel *channel_list)
 Retrieves a list of text channels available in the current context.
 
DWLIB_API __int64 DWGetTextValuesCount (int ch_index)
 Retrieves the count of text values available for a specified text channel.
 
DWLIB_API enum DWStatus DWGetTextValues (int ch_index, int position, int count, char *text_values, double *time_stamp)
 Retrieves a series of text values and their timestamps for a specified text channel.
 
DWLIB_API enum DWStatus DWGetReducedValuesCount (int ch_index, int *count, double *block_size)
 Retrieves the count of reduced values and the block size for a specified channel.
 
DWLIB_API enum DWStatus DWIGetReducedValuesCount (READER_HANDLE reader, int ch_index, int *count, double *block_size)
 Retrieves the count of reduced values and the block size using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetReducedValues (int ch_index, int position, int count, struct DWReducedValue *data)
 Retrieves a series of reduced values for a specified channel.
 
DWLIB_API enum DWStatus DWIGetReducedValues (READER_HANDLE reader, int ch_index, int position, int count, struct DWReducedValue *data)
 Retrieves a series of reduced values for a specified channel using a specific reader instance.
 
DWLIB_API int DWGetHeaderEntryCount ()
 Retrieves the count of entries in the current header.
 
DWLIB_API enum DWStatus DWIGetHeaderEntryCount (READER_HANDLE reader, int *count)
 Retrieves the count of entries in the current header using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetHeaderEntryList (struct DWChannel *channel_list)
 Retrieves the list of entries in the current header.
 
DWLIB_API enum DWStatus DWIGetHeaderEntryList (READER_HANDLE reader, struct DWChannel *entry_list)
 Retrieves the list of entries in the current header using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetHeaderEntryText (int ch_index, char *text_value, int text_value_size)
 Retrieves the textual content of a specific header entry by index.
 
DWLIB_API enum DWStatus DWIGetHeaderEntryText (READER_HANDLE reader, int ch_index, char *text_value, int text_value_size)
 Retrieves the textual content of a header entry using a specific reader instance.
 
DWLIB_API int DWGetMultiFileIndex ()
 Retrieves the index of the currently open multifile.
 
DWLIB_API enum DWStatus DWIGetMultiFileIndex (READER_HANDLE reader, int *index)
 Retrieves the index of the currently open multifile using a specific reader instance.
 
DWLIB_API int DWGetStoringType ()
 Retrieves the current data storing type.
 
DWLIB_API enum DWStatus DWIGetStoringType (READER_HANDLE reader, enum DWStoringType *storingType)
 Retrieves the current data storing type using a specific reader instance.
 
DWLIB_API int DWGetArrayInfoCount (int ch_index)
 Retrieves the count of array information entries for a specified channel.
 
DWLIB_API enum DWStatus DWIGetArrayInfoCount (READER_HANDLE reader, int ch_index, int *count)
 Retrieves the count of array information entries using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetArrayInfoList (int ch_index, struct DWArrayInfo *array_inf_list)
 Retrieves a list of array information entries for a specified channel.
 
DWLIB_API enum DWStatus DWIGetArrayInfoList (READER_HANDLE reader, int ch_index, struct DWArrayInfo *array_inf_list)
 Retrieves a list of array information entries using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetArrayIndexValue (int ch_index, int array_info_index, int array_value_index, char *value, int value_size)
 Retrieves a specific value from an array's index for a specified channel.
 
DWLIB_API enum DWStatus DWIGetArrayIndexValue (READER_HANDLE reader, int ch_index, int array_info_index, int array_value_index, char *value, int value_size)
 Retrieves a specific value from an array's index using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetChannelListItem (int array_index, int *index, char *name, char *unit, char *description, int *color, int *array_size, int max_char_size)
 Retrieves information about a specific channel from the channel list.
 
DWLIB_API enum DWStatus DWIGetChannelListItem (READER_HANDLE reader, int array_index, int *index, char *name, char *unit, char *description, int *color, int *array_size, int max_char_size)
 Retrieves information about a specific channel using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetComplexChannelListItem (int array_index, int *index, char *name, char *unit, char *description, int *color, int *array_size, int max_char_size)
 Retrieves information about a specific complex channel from the channel list.
 
DWLIB_API enum DWStatus DWIGetComplexChannelListItem (READER_HANDLE reader, int array_index, int *index, char *name, char *unit, char *description, int *color, int *array_size, int max_char_size)
 Retrieves information about a specific complex channel using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetHeaderEntryListItem (int array_index, int *index, char *name, char *unit, char *description, int *color, int *array_size, int max_char_size)
 Retrieves information about a specific header entry from the header list.
 
DWLIB_API enum DWStatus DWIGetHeaderEntryListItem (READER_HANDLE reader, int array_index, int *index, char *name, char *unit, char *description, int *color, int *array_size, int max_char_size)
 Retrieves information about a specific header entry using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetEventListItem (int event_Index, int *event_type, double *time_stamp, char *event_text, int max_char_size)
 Retrieves information about a specific event from the event list.
 
DWLIB_API enum DWStatus DWIGetEventListItem (READER_HANDLE reader, int event_Index, int *event_type, double *time_stamp, char *event_text, int max_char_size)
 Retrieves information about a specific event using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetReducedAveValues (int ch_index, int position, int count, double *data, double *time_stamp)
 Retrieves a series of average reduced values and their timestamps for a specified channel.
 
DWLIB_API enum DWStatus DWIGetReducedAveValues (READER_HANDLE reader, int ch_index, int position, int count, double *data, double *time_stamp)
 Retrieves average reduced values and timestamps using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetReducedMinValues (int ch_index, int position, int count, double *data, double *time_stamp)
 Retrieves a series of minimum reduced values and their timestamps for a specified channel.
 
DWLIB_API enum DWStatus DWIGetReducedMinValues (READER_HANDLE reader, int ch_index, int position, int count, double *data, double *time_stamp)
 Retrieves minimum reduced values and timestamps using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetReducedMaxValues (int ch_index, int position, int count, double *data, double *time_stamp)
 Retrieves a series of maximum reduced values and their timestamps for a specified channel.
 
DWLIB_API enum DWStatus DWIGetReducedMaxValues (READER_HANDLE reader, int ch_index, int position, int count, double *data, double *time_stamp)
 
DWLIB_API enum DWStatus DWGetReducedRMSValues (int ch_index, int position, int count, double *data, double *time_stamp)
 Retrieves a series of RMS reduced values and their timestamps for a specified channel.
 
DWLIB_API enum DWStatus DWIGetReducedRMSValues (READER_HANDLE reader, int ch_index, int position, int count, double *data, double *time_stamp)
 Retrieves RMS reduced values and timestamps using a specific reader instance.
 
DWLIB_API int DWGetBinChannelListCount ()
 Retrieves the number of available binary channels.
 
DWLIB_API enum DWStatus DWIGetBinChannelListCount (READER_HANDLE reader, int *count)
 Retrieves the number of available binary channels using a specific reader instance.
 
DWLIB_API __int64 DWGetBinarySamplesCount (int ch_index)
 Retrieves the count of samples available for a specified binary channel.
 
DWLIB_API enum DWStatus DWIGetBinarySamplesCount (READER_HANDLE reader, int ch_index, __int64 *count)
 Retrieves the count of samples available for a specified binary channel using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetBinarySamples (int ch_index, __int64 sampleIndex, char *data, double *time_stamp, int *datalen)
 Retrieves a single binary sample and its timestamp for a specified channel.
 
DWLIB_API enum DWStatus DWIGetBinarySamples (READER_HANDLE reader, int ch_index, __int64 sampleIndex, char *data, double *time_stamp, int *datalen)
 Retrieves a single binary sample and its timestamp using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetBinarySamplesEx (int ch_index, __int64 position, int count, char *data, double *time_stamp, int *datalen)
 Retrieves multiple binary samples and their timestamps for a specified channel.
 
DWLIB_API enum DWStatus DWIGetBinarySamplesEx (READER_HANDLE reader, int ch_index, __int64 position, int count, char *data, double *time_stamp, int *datalen)
 Retrieves multiple binary samples and their timestamps using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetBinRecSamples (int ch_index, __int64 sampleIndex, int count, char *data, double *time_stamp)
 Retrieves binary record samples and their timestamps for a specified channel.
 
DWLIB_API enum DWStatus DWIGetBinRecSamples (READER_HANDLE reader, int ch_index, __int64 sampleIndex, int count, struct DWBinarySample *data, double *time_stamp)
 Retrieves binary record samples and their timestamps using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetBinData (int ch_index, char *sample, char *data, __int64 *absPos, int binBufSize)
 Retrieves binary data for a specified channel and sample.
 
DWLIB_API enum DWStatus DWIGetBinData (READER_HANDLE reader, int ch_index, struct DWBinarySample *sample, char *data, __int64 *absPos, int binBufSize)
 Retrieves binary data for a specified channel and sample using a specific reader instance.
 
DWLIB_API __int64 DWGetRawSamplesCount (int ch_index)
 Retrieves the count of raw samples available for a specified channel.
 
DWLIB_API enum DWStatus DWIGetRawSamplesCount (READER_HANDLE reader, int ch_index, __int64 *count)
 Retrieves the count of raw samples using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetRawSamples (int ch_index, __int64 position, int count, void *data, double *time_stamp)
 Retrieves a series of raw samples and their timestamps for a specified channel.
 
DWLIB_API enum DWStatus DWIGetRawSamples (READER_HANDLE reader, int ch_index, __int64 position, int count, void *data, double *time_stamp)
 Retrieves a series of raw samples and timestamps using a specific reader instance.
 
DWLIB_API __int64 DWGetComplexRawSamplesCount (int ch_index)
 Retrieves the count of complex raw samples available for a specified channel.
 
DWLIB_API enum DWStatus DWIGetComplexRawSamplesCount (READER_HANDLE reader, int ch_index, __int64 *count)
 Retrieves the count of complex raw samples using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetComplexRawSamples (int ch_index, __int64 position, int count, struct DWComplex *data, double *time_stamp)
 Retrieves a series of complex raw samples and their timestamps for a specified channel.
 
DWLIB_API enum DWStatus DWIGetComplexRawSamples (READER_HANDLE reader, int ch_index, __int64 position, int count, struct DWComplex *data, double *time_stamp)
 Retrieves complex raw samples and timestamps using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetStream (char *stream_name, char *buffer, int *max_len)
 Retrieves a stream by name.
 
DWLIB_API enum DWStatus DWIGetStream (READER_HANDLE reader, char *stream_name, char *buffer, int *max_len)
 Retrieves a stream by name using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetReducedValuesBlock (int *ch_ids, int ch_count, int position, int count, int ib_level, struct DWReducedValue *data)
 Retrieves a block of reduced values for multiple channels.
 
DWLIB_API enum DWStatus DWIGetReducedValuesBlock (READER_HANDLE reader, int *ch_ids, int ch_count, int position, int count, int ib_level, struct DWReducedValue *data)
 Retrieves a block of reduced values for multiple channels using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetArrayIndexValueF (int ch_index, int array_info_index, int array_value_index, double *value)
 Retrieves a numeric value from an array's index for a specified channel.
 
DWLIB_API enum DWStatus DWIGetArrayIndexValueF (READER_HANDLE reader, int ch_index, int array_info_index, int array_value_index, double *value)
 Retrieves a numeric value from an array's index using a specific reader instance.
 
DWLIB_API int DWGetEventTypeF (int event_number)
 Retrieves the type of a specific event by event number.
 
DWLIB_API enum DWStatus DWIGetEventTypeF (READER_HANDLE reader, int event_number, enum DWEventType *event_type)
 Retrieves the type of a specific event using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetRecudedYDataF (int Channel_Number, double *Y_Axis, int position, int count)
 Retrieves Y-axis reduced data for a specified channel.
 
DWLIB_API enum DWStatus DWIGetRecudedYDataF (READER_HANDLE reader, int Channel_Number, double *Y_Axis, int position, int count)
 Retrieves Y-axis reduced data using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetRecudedDataAllF (int Channel_Number, double *Y_MIN_Axis, double *Y_AVE_Axis, double *Y_MAX_Axis, double *Y_RMS_Axis, int position, int count)
 Retrieves all reduced data types (MIN, AVE, MAX, RMS) for a specified channel.
 
DWLIB_API enum DWStatus DWIGetRecudedDataAllF (READER_HANDLE reader, int Channel_Number, double *Y_MIN_Axis, double *Y_AVE_Axis, double *Y_MAX_Axis, double *Y_RMS_Axis, int position, int count)
 Retrieves all reduced data types using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetBinChannelList (struct DWChannel *channel_list)
 Retrieves a list of available binary channels.
 
DWLIB_API enum DWStatus DWIGetBinChannelList (READER_HANDLE reader, struct DWChannel *channel_list)
 Retrieves a list of available binary channels using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetChannelProps (int ch_index, enum DWChannelProps ch_prop, void *buffer, int *max_len)
 Retrieves a specific property of a channel.
 
DWLIB_API enum DWStatus DWIGetChannelProps (READER_HANDLE reader, int ch_index, enum DWChannelProps ch_prop, void *buffer, int *max_len)
 Retrieves a specific property of a channel using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetHeaderEntryTextF (int entry_number, char *text_value, int text_value_size)
 Retrieves the text value of a header entry by its entry number.
 
DWLIB_API enum DWStatus DWIGetHeaderEntryTextF (READER_HANDLE reader, int entry_number, char *text_value, int text_value_size)
 Retrieves the text value of a header entry using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetHeaderEntryNameF (int entry_number, char *name, int name_size)
 Retrieves the name of a header entry by its entry number.
 
DWLIB_API enum DWStatus DWIGetHeaderEntryNameF (READER_HANDLE reader, int entry_number, char *name, int name_size)
 Retrieves the name of a header entry using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetHeaderEntryIDF (int entry_number, char *ID, int name_size)
 Retrieves the identifier (ID) of a header entry by its entry number.
 
DWLIB_API enum DWStatus DWIGetHeaderEntryIDF (READER_HANDLE reader, int entry_number, char *ID, int name_size)
 Retrieves the identifier (ID) of a header entry using a specific reader instance.
 
DWLIB_API double DWGetEventTimeF (int event_number)
 Retrieves the timestamp of a specific event by event number.
 
DWLIB_API enum DWStatus DWIGetEventTimeF (READER_HANDLE reader, int event_number, double *time_stamp)
 Retrieves the timestamp of a specific event using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetEventTextF (int event_number, char *text, int text_size)
 Retrieves the text description of a specific event by event number.
 
DWLIB_API enum DWStatus DWIGetEventTextF (READER_HANDLE reader, int event_number, char *text, int text_size)
 Retrieves the text description of an event using a specific reader instance.
 
DWLIB_API int DWGetReducedDataChannelCountF ()
 Retrieves the number of channels available for reduced data.
 
DWLIB_API enum DWStatus DWIGetReducedDataChannelCountF (READER_HANDLE reader, int *count)
 Retrieves the number of channels available for reduced data using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetReducedDataChannelNameF (int Channel_Number, char *name, int name_size)
 Retrieves the name of a reduced data channel by its number.
 
DWLIB_API enum DWStatus DWIGetReducedDataChannelNameF (READER_HANDLE reader, int Channel_Number, char *name, int name_size)
 Retrieves the name of a reduced data channel using a specific reader instance.
 
DWLIB_API int DWGetReducedDataChannelIndexF (char *name)
 Retrieves the index of a reduced data channel by its name.
 
DWLIB_API enum DWStatus DWIGetReducedDataChannelIndexF (READER_HANDLE reader, char *name, int *index)
 Retrieves the index of a reduced data channel by its name using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetRecudedDataChannelInfoF (int Channel_Number, char *X_Axis_Units, int X_Axis_Units_size, char *Y_Axis_Units, int Y_Axis_Units_size, double *Chn_Offset, int *Channel_Length, double *ch_rate)
 Retrieves detailed information about a reduced data channel.
 
DWLIB_API enum DWStatus DWIGetRecudedDataChannelInfoF (READER_HANDLE reader, int Channel_Number, char *X_Axis_Units, int X_Axis_Units_size, char *Y_Axis_Units, int Y_Axis_Units_size, double *Chn_Offset, int *Channel_Length, double *ch_rate)
 Retrieves detailed information about a reduced data channel using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetRecudedDataF (int Channel_Number, double *X_Axis, double *Y_Axis, int position, int count)
 Retrieves X and Y axis data for a reduced data channel.
 
DWLIB_API enum DWStatus DWIGetRecudedDataF (READER_HANDLE reader, int Channel_Number, double *X_Axis, double *Y_Axis, int position, int count)
 Retrieves X and Y axis data for a reduced data channel using a specific reader instance.
 
DWLIB_API int DWGetTriggerDataTriggerCountF ()
 Retrieves the number of triggers in the trigger data.
 
DWLIB_API enum DWStatus DWIGetTriggerDataTriggerCountF (READER_HANDLE reader, int *count)
 Retrieves the number of triggers using a specific reader instance.
 
DWLIB_API double DWGetTriggerDataTriggerTimeF (int Trigger_Number)
 Retrieves the timestamp of a specific trigger by its number.
 
DWLIB_API enum DWStatus DWIGetTriggerDataTriggerTimeF (READER_HANDLE reader, int Trigger_Number, double *time_stamp)
 Retrieves the timestamp of a specific trigger using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetTriggerDataChannelNameF (int Channel_Number, char *name, int name_size)
 Retrieves the name of a trigger data channel by its number.
 
DWLIB_API enum DWStatus DWIGetTriggerDataChannelNameF (READER_HANDLE reader, int Channel_Number, char *name, int name_size)
 Retrieves the name of a trigger data channel using a specific reader instance.
 
DWLIB_API int DWGetTriggerDataChannelIndexF (char *name)
 Retrieves the index of a trigger data channel by its name.
 
DWLIB_API enum DWStatus DWIGetTriggerDataChannelIndexF (READER_HANDLE reader, char *name, int *index)
 Retrieves the index of a trigger data channel by its name using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetTriggerDataChannelInfoF (int Trigger_Number, int Channel_Number, char *X_Axis_Units, int X_Axis_Units_size, char *Y_Axis_Units, int Y_Axis_Units_size, double *Chn_Offset, double *Channel_Length, double *ch_rate, int *ch_type)
 Retrieves detailed information about a trigger data channel.
 
DWLIB_API enum DWStatus DWIGetTriggerDataChannelInfoF (READER_HANDLE reader, int Trigger_Number, int Channel_Number, char *X_Axis_Units, int X_Axis_Units_size, char *Y_Axis_Units, int Y_Axis_Units_size, double *Chn_Offset, double *Channel_Length, double *ch_rate, int *ch_type)
 Retrieves detailed information about a trigger data channel using a specific reader instance.
 
DWLIB_API enum DWStatus DWGetTriggerDataF (int Trigger_Number, int Channel_Number, double *Y_Axis, double *X_Axis, double position, int count)
 Retrieves trigger data for a specific trigger and channel.
 
DWLIB_API enum DWStatus DWIGetTriggerDataF (READER_HANDLE reader, int Trigger_Number, int Channel_Number, double *Y_Axis, double *X_Axis, double position, int count)
 Retrieves trigger data using a specific reader instance.
 

Detailed Description

Functions exposed from DWDataReader library.

Function Documentation

◆ DWAddReader()

DWLIB_API enum DWStatus DWAddReader ( )

Creates a new reader within the shared reader pool.

This function creates a new reader instance in the application's shared reader pool and sets it as the active reader. The DWInit function must be called before using this function.

Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWICreateReader instead to create independent reader instances.

◆ DWCloseDataFile()

DWLIB_API enum DWStatus DWCloseDataFile ( )

Closes the currently open data file.

This function is used to close a data file that has been previously opened. It ensures that all resources associated with the file are properly released before opening a new file.

Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWICloseDataFile instead.

◆ DWDeInit()

DWLIB_API enum DWStatus DWDeInit ( )

Deinitializes the DWDataReader library.

This function should be called when the application is finished using the DWDataReader library to properly release all resources and perform cleanup.

Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIDestroyReader instead to destroy specific reader instances.

◆ DWExportHeader()

DWLIB_API enum DWStatus DWExportHeader ( char * file_name)

Exports the setup information to a specified file.

This function exports the setup XML structure of the currently opened datafile to a new file specified by the file_name parameter.

Parameters
[in]file_nameA pointer to a null-terminated string specifying the path and name of the file to which the header information will be exported.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIExportHeader instead.

◆ DWGetArrayIndexValue()

DWLIB_API enum DWStatus DWGetArrayIndexValue ( int ch_index,
int array_info_index,
int array_value_index,
char * value,
int value_size )

Retrieves a specific value from an array's index for a specified channel.

This function retrieves the value at a specified index from an array associated with a channel. The array is identified by array_info_index, and the exact value is located using array_value_index. The retrieved value is copied into the provided value buffer, ensuring it does not exceed the allocated size.

Parameters
[in]ch_indexThe index of the channel associated with the array.
[in]array_info_indexThe index of the array information entry from which to retrieve the value.
[in]array_value_indexThe index within the array to retrieve the value.
[out]valueA pointer to a char buffer where the retrieved value will be stored. This buffer must be pre-allocated.
[in]value_sizeThe size of the value buffer, indicating the maximum number of characters (including null-terminator) that can be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetArrayIndexValue instead.

◆ DWGetArrayIndexValueF()

DWLIB_API enum DWStatus DWGetArrayIndexValueF ( int ch_index,
int array_info_index,
int array_value_index,
double * value )

Retrieves a numeric value from an array's index for a specified channel.

This function retrieves a double-precision floating-point value at a specified index from an array associated with a channel. The array is identified by array_info_index, and the exact value is located using array_value_index.

Parameters
[in]ch_indexThe index of the channel associated with the array.
[in]array_info_indexThe index of the array information entry from which to retrieve the value.
[in]array_value_indexThe index within the array to retrieve the value.
[out]valueA pointer to a double where the retrieved value will be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetArrayIndexValueF instead.

◆ DWGetArrayInfoCount()

DWLIB_API int DWGetArrayInfoCount ( int ch_index)

Retrieves the count of array information entries for a specified channel.

This function returns the number of array information entries available for the channel identified by ch_index.

Parameters
[in]ch_indexThe index of the channel for which to retrieve the array information count.
Returns
The number of array information entries for the specified channel.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetArrayInfoCount instead.

◆ DWGetArrayInfoList()

DWLIB_API enum DWStatus DWGetArrayInfoList ( int ch_index,
struct DWArrayInfo * array_inf_list )

Retrieves a list of array information entries for a specified channel.

This function populates an array of DWArrayInfo structures with metadata about each array dimension or axis of the channel identified by ch_index.

Parameters
[in]ch_indexThe index of the channel for which to retrieve the array information list.
[out]array_inf_listA pointer to an array of DWArrayInfo structures that will be filled with the array information. The array must be pre-allocated and should have enough capacity to store all the entries retrieved, based on DWGetArrayInfoCount().
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetArrayInfoList instead.

◆ DWGetBinarySamples()

DWLIB_API enum DWStatus DWGetBinarySamples ( int ch_index,
__int64 sampleIndex,
char * data,
double * time_stamp,
int * datalen )

Retrieves a single binary sample and its timestamp for a specified channel.

This function fetches a binary sample at the specified sampleIndex for the channel identified by ch_index. The binary data is stored in the provided data buffer, and the timestamp is stored in the time_stamp parameter.

Parameters
[in]ch_indexThe index of the channel from which to retrieve the binary sample.
[in]sampleIndexThe index of the sample to retrieve.
[out]dataA pointer to a buffer where the binary data will be stored. This buffer must be pre-allocated.
[out]time_stampA pointer to a double where the timestamp of the sample will be stored.
[out]datalenA pointer to an integer where the length of the retrieved binary data will be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetBinarySamples instead.

◆ DWGetBinarySamplesCount()

DWLIB_API __int64 DWGetBinarySamplesCount ( int ch_index)

Retrieves the count of samples available for a specified binary channel.

This function returns the total number of binary samples currently available for the given channel index. Binary samples contain structured binary data that may represent complex information or formatting.

Parameters
[in]ch_indexThe index of the binary channel for which to retrieve the sample count.
Returns
The number of binary samples available for the specified channel.
Return values
-1if an error occurs.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetBinarySamplesCount instead.

◆ DWGetBinarySamplesEx()

DWLIB_API enum DWStatus DWGetBinarySamplesEx ( int ch_index,
__int64 position,
int count,
char * data,
double * time_stamp,
int * datalen )

Retrieves multiple binary samples and their timestamps for a specified channel.

This function fetches a specified number of binary samples starting from a given position for the channel identified by ch_index. The binary data is stored in the provided data buffer, and the timestamps are stored in the time_stamp array.

Parameters
[in]ch_indexThe index of the channel from which to retrieve binary samples.
[in]positionThe starting position within the channel's data to begin retrieval.
[in]countThe number of binary samples to retrieve.
[out]dataA pointer to a buffer where the binary data will be stored. This buffer must be pre-allocated.
[out]time_stampA pointer to an array where the timestamps will be stored. This array must be pre-allocated to hold at least count timestamps.
[out]datalenA pointer to an integer where the total length of all retrieved binary data will be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetBinarySamplesEx instead.

◆ DWGetBinChannelList()

DWLIB_API enum DWStatus DWGetBinChannelList ( struct DWChannel * channel_list)

Retrieves a list of available binary channels.

This function populates an array of DWChannel structures with information about the available binary channels. Binary channels typically handle structured binary data or binary formats like video, images, or specialized data streams.

Parameters
[out]channel_listA pointer to an array of DWChannel structures to be filled with binary channel information. The array must be pre-allocated with sufficient size to hold the data.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetBinChannelList instead.

◆ DWGetBinChannelListCount()

DWLIB_API int DWGetBinChannelListCount ( )

Retrieves the number of available binary channels.

This function returns the total number of binary channels currently available in the system. Binary channels typically handle raw binary data or structured binary formats.

Returns
The number of binary channels available.
Return values
-1if an error occurs.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetBinChannelListCount instead.

◆ DWGetBinData()

DWLIB_API enum DWStatus DWGetBinData ( int ch_index,
char * sample,
char * data,
__int64 * absPos,
int binBufSize )

Retrieves binary data for a specified channel and sample.

This function retrieves the binary data associated with a specific sample in the channel identified by ch_index. The data is stored in the provided data buffer, and the absolute position is updated in the absPos parameter.

Parameters
[in]ch_indexThe index of the channel from which to retrieve binary data.
[in]sampleA pointer to a sample descriptor that identifies the target sample.
[out]dataA pointer to a buffer where the binary data will be stored. This buffer must be pre-allocated.
[in,out]absPosA pointer to an __int64 that will be updated with the absolute position of the data.
[in]binBufSizeThe size of the data buffer in bytes.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetBinData instead.

◆ DWGetBinRecSamples()

DWLIB_API enum DWStatus DWGetBinRecSamples ( int ch_index,
__int64 sampleIndex,
int count,
char * data,
double * time_stamp )

Retrieves binary record samples and their timestamps for a specified channel.

This function fetches a specified number of binary record samples starting from the given sampleIndex for the channel identified by ch_index. The records are stored in the provided data buffer, and the timestamps are stored in the time_stamp array.

Parameters
[in]ch_indexThe index of the channel from which to retrieve the binary record samples.
[in]sampleIndexThe starting sample index to begin retrieval.
[in]countThe number of record samples to retrieve.
[out]dataA pointer to a buffer where the binary record data will be stored. This buffer must be pre-allocated.
[out]time_stampA pointer to an array where the timestamps will be stored. This array must be pre-allocated to hold at least count timestamps.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetBinRecSamples instead.

◆ DWGetChannelFactors()

DWLIB_API enum DWStatus DWGetChannelFactors ( int ch_index,
double * scale,
double * offset )

Retrieves scaling factors for a specified channel.

This function retrieves the scale and offset values associated with a channel identified by ch_index. These values are used for converting raw data to scaled units through the formula: scaled_value = (raw_value * scale) + offset

Parameters
[in]ch_indexThe index of the channel for which to retrieve scaling factors.
[out]scaleA pointer to a double where the scale factor will be stored. This must be pre-allocated before calling this function.
[out]offsetA pointer to a double where the offset value will be stored. This must be pre-allocated before calling this function.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetChannelFactors instead.

◆ DWGetChannelList()

DWLIB_API enum DWStatus DWGetChannelList ( struct DWChannel * channel_list)

Retrieves the list of available channels.

This function populates an array of DWChannel structures with information about the available channels.

Parameters
[out]channel_listA pointer to an array of DWChannel structures to be filled with channel information. The array must be pre-allocated with sufficient size to hold the data.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Remarks
Size of channel_list can be determined by calling the DWGetChannelListCount() function.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetChannelList instead.

◆ DWGetChannelListCount()

DWLIB_API int DWGetChannelListCount ( )

Retrieves the number of available channels.

Returns
The number of channels available.
Return values
-1if an error occurs.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetChannelListCount instead.

◆ DWGetChannelListItem()

DWLIB_API enum DWStatus DWGetChannelListItem ( int array_index,
int * index,
char * name,
char * unit,
char * description,
int * color,
int * array_size,
int max_char_size )

Retrieves information about a specific channel from the channel list.

This function provides detailed information about a channel identified by array_index. The channel's properties such as index, name, unit, description, color, and array size are populated into the provided parameters.

Parameters
[in]array_indexThe index of the channel in the channel list to retrieve information for.
[out]indexA pointer to an integer where the channel's unique identifier will be stored.
[out]nameA pointer to a char buffer where the channel's name will be stored. This buffer must be pre-allocated and have enough space to store the name, including null-terminator.
[out]unitA pointer to a char buffer where the channel's unit will be stored. This buffer must be pre-allocated and have enough space to store the unit, including null-terminator.
[out]descriptionA pointer to a char buffer where the channel's description will be stored. This buffer must be pre-allocated and have enough space to store the description, including null-terminator.
[out]colorA pointer to an integer where the channel's color will be stored.
[out]array_sizeA pointer to an integer where the channel's array size will be stored.
[in]max_char_sizeThe maximum size of the char buffers for name, unit, and description, including the null-terminator.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetChannelListItem instead.

◆ DWGetChannelProps()

DWLIB_API enum DWStatus DWGetChannelProps ( int ch_index,
enum DWChannelProps ch_prop,
void * buffer,
int * max_len )

Retrieves a specific property of a channel.

This function fetches a specific property identified by ch_prop for the channel identified by ch_index. The property value is stored in the provided buffer.

Parameters
[in]ch_indexThe index of the channel for which to retrieve the property.
[in]ch_propThe channel property to retrieve, specified as a DWChannelProps enum value.
[out]bufferA pointer to a buffer where the property value will be stored. This buffer must be pre-allocated and of appropriate type for the property.
[in,out]max_lenA pointer to an integer that, on input, indicates the maximum size of the buffer. On output, it contains the actual size of the retrieved property data.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetChannelProps instead.

◆ DWGetComplexChannelList()

DWLIB_API enum DWStatus DWGetComplexChannelList ( struct DWChannel * channel_list)

Retrieves the list of available complex channels.

This function populates an array of DWChannel structures with information about the available complex channels. Each DWChannel structure contains details such as the channel's index, name, unit, description, and other properties.

Parameters
[out]channel_listA pointer to an array of DWChannel structures to be filled with channel information. The array must be pre-allocated with sufficient size to hold the data.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Remarks
Size of channel_list can be determined by calling the DWGetComplexChannelListCount function.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetComplexChannelList instead.

◆ DWGetComplexChannelListCount()

DWLIB_API int DWGetComplexChannelListCount ( )

Retrieves the number of available complex channels.

Returns
The number of complex channels available.
Return values
-1if an error occurs.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetComplexChannelListCount instead.

◆ DWGetComplexChannelListItem()

DWLIB_API enum DWStatus DWGetComplexChannelListItem ( int array_index,
int * index,
char * name,
char * unit,
char * description,
int * color,
int * array_size,
int max_char_size )

Retrieves information about a specific complex channel from the channel list.

This function provides detailed information about a complex channel identified by array_index. Complex channels typically involve data with both real and imaginary components, and this function retrieves properties such as index, name, unit, description, color, and array size.

Parameters
[in]array_indexThe index of the complex channel in the channel list to retrieve information for.
[out]indexA pointer to an integer where the channel's unique identifier will be stored.
[out]nameA pointer to a char buffer where the channel's name will be stored. This buffer must be pre-allocated and be large enough to include the null-terminator.
[out]unitA pointer to a char buffer where the channel's unit will be stored. This buffer must be pre-allocated and include space for the null-terminator.
[out]descriptionA pointer to a char buffer where the channel's description will be stored. This buffer must be pre-allocated and have space for the null-terminator.
[out]colorA pointer to an integer where the channel's display color will be stored.
[out]array_sizeA pointer to an integer where the channel's array size will be stored.
[in]max_char_sizeThe maximum allowable size for char buffers name, unit, and description, including the null-terminator.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetComplexChannelListItem instead.

◆ DWGetComplexRawSamples()

DWLIB_API enum DWStatus DWGetComplexRawSamples ( int ch_index,
__int64 position,
int count,
struct DWComplex * data,
double * time_stamp )

Retrieves a series of complex raw samples and their timestamps for a specified channel.

This function fetches a specified number of complex raw samples starting from a given position for the channel identified by ch_index. The retrieved samples, each with real and imaginary components, are stored in the provided data array along with their corresponding timestamps.

Parameters
[in]ch_indexThe index of the complex channel from which to retrieve raw samples.
[in]positionThe starting position within the channel's data to begin retrieval.
[in]countThe number of complex samples to retrieve.
[out]dataA pointer to an array of DWComplex structures where the retrieved sample values will be stored. This array must be pre-allocated to hold at least count samples.
[out]time_stampA pointer to an array where the corresponding timestamps will be stored. This array must also be pre-allocated and match the size of the data array.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetComplexRawSamples instead.

◆ DWGetComplexRawSamplesCount()

DWLIB_API __int64 DWGetComplexRawSamplesCount ( int ch_index)

Retrieves the count of complex raw samples available for a specified channel.

This function returns the total number of complex raw samples currently available for the given channel index. Complex raw samples contain unprocessed data with both real and imaginary components.

Parameters
[in]ch_indexThe index of the channel for which to retrieve the complex raw sample count.
Returns
The number of complex raw samples available for the specified channel.
Return values
-1if an error occurs.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetComplexRawSamplesCount instead.

◆ DWGetComplexScaledSamples()

DWLIB_API enum DWStatus DWGetComplexScaledSamples ( int ch_index,
__int64 position,
int count,
struct DWComplex * data,
double * time_stamp )

Retrieves a series of complex scaled samples and their timestamps for a specified channel.

This function fetches a specified number of complex scaled samples starting from a given position for the channel identified by ch_index. The retrieved samples, each with real and imaginary components, are stored in the provided data array along with their corresponding timestamps in the time_stamp array.

Parameters
[in]ch_indexThe index of the complex channel from which to retrieve scaled samples.
[in]positionThe starting position within the channel's data to begin retrieval.
[in]countThe number of complex samples to retrieve.
[out]dataA pointer to an array of DWComplex structures where the retrieved sample values will be stored. This array must be pre-allocated to hold at least count samples.
[out]time_stampA pointer to an array where the corresponding timestamps for each sample will be stored. This array must also be pre-allocated and match the size of the data array.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetComplexScaledSamples instead.

◆ DWGetComplexScaledSamplesCount()

DWLIB_API __int64 DWGetComplexScaledSamplesCount ( int ch_index)

Retrieves the count of scaled samples available for a specified complex channel.

This function returns the total number of scaled samples available for a complex data channel, identified by its channel index. Complex scaled samples include both real and imaginary components that have been processed and scaled from their raw form into meaningful units.

Parameters
[in]ch_indexThe index of the complex channel for which to retrieve the scaled sample count.
Returns
The number of scaled complex samples available for the specified channel.
Return values
-1if an error occurs.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetComplexScaledSamplesCount instead.

◆ DWGetEventList()

DWLIB_API enum DWStatus DWGetEventList ( struct DWEvent * event_list)

Retrieves the list of events from the current event list.

This function fills an array of DWEvent structures with information about each event recorded in the system. Events typically contain details such as event type, timestamp, and descriptive text.

Parameters
[out]event_listA pointer to an array of DWEvent structures that will be filled with the event data. The array must be pre-allocated and sized based on the number of events (retrievable via DWGetEventListCount).
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetEventList instead.

◆ DWGetEventListCount()

DWLIB_API int DWGetEventListCount ( )

Retrieves the count of events available in the current event list.

This function returns the total number of events currently recorded in the system's event list. This count can be used to determine the number of events that can be accessed or processed in subsequent operations.

Returns
The number of events available in the event list.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetEventListCount instead.

◆ DWGetEventListItem()

DWLIB_API enum DWStatus DWGetEventListItem ( int event_Index,
int * event_type,
double * time_stamp,
char * event_text,
int max_char_size )

Retrieves information about a specific event from the event list.

This function extracts detailed information about an event identified by event_Index. The function provides details such as event type, timestamp, and associated text description.

Parameters
[in]event_IndexThe index of the event in the event list to retrieve details for.
[out]event_typeA pointer to an integer where the type of the event will be stored. Event types typically correspond to predefined constants (e.g., start, stop).
[out]time_stampA pointer to a double where the timestamp of the event will be stored, representing the time relative to the start of data recording.
[out]event_textA pointer to a char buffer where the event's text description will be stored. This buffer must be pre-allocated and should be large enough to store the text, including the null-terminator.
[in]max_char_sizeThe maximum size of the event_text buffer, including the null-terminator, to prevent buffer overflow.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetEventListItem instead.

◆ DWGetEventTextF()

DWLIB_API enum DWStatus DWGetEventTextF ( int event_number,
char * text,
int text_size )

Retrieves the text description of a specific event by event number.

This function fetches the descriptive text associated with an event identified by event_number. The text is copied into the provided buffer, ensuring it does not exceed the allocated size.

Parameters
[in]event_numberThe number of the event for which to retrieve the text description.
[out]textA pointer to a char buffer where the event text will be stored. This buffer must be pre-allocated.
[in]text_sizeThe size of the text buffer, indicating the maximum number of characters (including null-terminator) that can be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetEventTextF instead.

◆ DWGetEventTimeF()

DWLIB_API double DWGetEventTimeF ( int event_number)

Retrieves the timestamp of a specific event by event number.

This function returns the timestamp associated with a particular event identified by event_number. The timestamp represents the time at which the event occurred, relative to the start of data recording.

Parameters
[in]event_numberThe number of the event for which to retrieve the timestamp.
Returns
A double-precision floating-point value representing the event timestamp in seconds.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetEventTimeF instead.

◆ DWGetEventTypeF()

DWLIB_API int DWGetEventTypeF ( int event_number)

Retrieves the type of a specific event by event number.

This function returns the event type value associated with a particular event identified by event_number. The event type indicates the category or nature of the event.

Parameters
[in]event_numberThe number of the event for which the type is to be retrieved.
Returns
An integer value representing the event type.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetEventTypeF instead.

◆ DWGetHeaderEntryCount()

DWLIB_API int DWGetHeaderEntryCount ( )

Retrieves the count of entries in the current header.

This function returns the total number of entries in the header of the current context. Header entries typically contain metadata or configuration information about the data being processed or analyzed.

Returns
The number of entries in the header.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetHeaderEntryCount instead.

◆ DWGetHeaderEntryIDF()

DWLIB_API enum DWStatus DWGetHeaderEntryIDF ( int entry_number,
char * ID,
int name_size )

Retrieves the identifier (ID) of a header entry by its entry number.

This function fetches the ID of a header entry identified by entry_number. The ID is copied into the provided buffer, ensuring it does not exceed the allocated size.

Parameters
[in]entry_numberThe number of the header entry for which to retrieve the ID.
[out]IDA pointer to a char buffer where the entry ID will be stored. This buffer must be pre-allocated.
[in]name_sizeThe size of the ID buffer, indicating the maximum number of characters (including null-terminator) that can be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetHeaderEntryIDF instead.

◆ DWGetHeaderEntryList()

DWLIB_API enum DWStatus DWGetHeaderEntryList ( struct DWChannel * channel_list)

Retrieves the list of entries in the current header.

This function populates an array with information about each entry in the header of the current context. Header entries typically contain metadata or configuration information that describes the data's properties, structure, or context.

Parameters
[out]entry_listA pointer to an array or buffer that will be filled with the header entries. This must be pre-allocated and should have sufficient capacity to store all header entries, based on the count retrieved from DWGetHeaderEntryCount().
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetHeaderEntryList instead.

◆ DWGetHeaderEntryListItem()

DWLIB_API enum DWStatus DWGetHeaderEntryListItem ( int array_index,
int * index,
char * name,
char * unit,
char * description,
int * color,
int * array_size,
int max_char_size )

Retrieves information about a specific header entry from the header list.

This function retrieves detailed information about a header entry identified by array_index. Header entries typically contain metadata such as names, units, descriptions, and possibly display attributes.

Parameters
[in]array_indexThe index of the header entry in the header list to retrieve information for.
[out]indexA pointer to an integer where the header entry's identifier will be stored.
[out]nameA pointer to a char buffer where the header entry's name will be stored. This buffer must be pre-allocated and sized to accommodate the name, including the null-terminator.
[out]unitA pointer to a char buffer where the header entry's unit will be stored. This buffer must be pre-allocated and accommodate the unit, including the null-terminator.
[out]descriptionA pointer to a char buffer where the header entry's description will be stored. This buffer must be pre-allocated and accommodate the description, including the null-terminator.
[out]colorA pointer to an integer where the header entry's color (if applicable) will be stored.
[out]array_sizeA pointer to an integer where the header entry's array size will be stored, if applicable.
[in]max_char_sizeThe maximum size for the char buffers name, unit, and description, including the null-terminator.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetHeaderEntryListItem instead.

◆ DWGetHeaderEntryNameF()

DWLIB_API enum DWStatus DWGetHeaderEntryNameF ( int entry_number,
char * name,
int name_size )

Retrieves the name of a header entry by its entry number.

This function fetches the name of a header entry identified by entry_number. The name is copied into the provided buffer, ensuring it does not exceed the allocated size.

Parameters
[in]entry_numberThe number of the header entry for which to retrieve the name.
[out]nameA pointer to a char buffer where the entry name will be stored. This buffer must be pre-allocated.
[in]name_sizeThe size of the name buffer, indicating the maximum number of characters (including null-terminator) that can be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetHeaderEntryNameF instead.

◆ DWGetHeaderEntryText()

DWLIB_API enum DWStatus DWGetHeaderEntryText ( int ch_index,
char * text_value,
int text_value_size )

Retrieves the textual content of a specific header entry by index.

This function retrieves the text value associated with a particular header entry identified by ch_index. The text is copied into the provided buffer, ensuring that it does not exceed the buffer's allocated size.

Parameters
[in]ch_indexThe index of the header entry to retrieve.
[out]text_valueA pointer to a char buffer where the text value of the header entry will be stored. This buffer must be pre-allocated.
[in]text_value_sizeThe size of the text_value buffer, indicating the maximum number of characters (including null-terminator) that can be safely stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetHeaderEntryText instead.

◆ DWGetHeaderEntryTextF()

DWLIB_API enum DWStatus DWGetHeaderEntryTextF ( int entry_number,
char * text_value,
int text_value_size )

Retrieves the text value of a header entry by its entry number.

This function fetches the text value for a header entry identified by entry_number. The text is copied into the provided buffer, ensuring it does not exceed the allocated size.

Parameters
[in]entry_numberThe number of the header entry to retrieve.
[out]text_valueA pointer to a char buffer where the text value will be stored. This buffer must be pre-allocated.
[in]text_value_sizeThe size of the text_value buffer, indicating the maximum number of characters (including null-terminator) that can be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetHeaderEntryTextF instead.

◆ DWGetLastStatus()

DWLIB_API enum DWStatus DWGetLastStatus ( enum DWStatus * status,
char * statusMsg,
int * statusMsgSize )

Retrieves the status and error message from last operation.

This function can be used to check for errors or other status information after performing operations with the library.

Parameters
[out]statusPointer to an enum DWStatus where the last status will be stored.
[out]statusMsgPointer to a character array where the status message will be stored.
[in,out]statusMsgSizePointer to an integer representing the size of the status message buffer. The function will update this value with the actual size of the message.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWGetMeasurementInfo()

DWLIB_API enum DWStatus DWGetMeasurementInfo ( struct DWMeasurementInfo * measurement_info)

Retrieves detailed information about the current measurement.

This function populates a DWMeasurementInfo structure with details such as the sample rate, start times for measurement and storage, and the duration of the measurement. This information is useful for understanding the timing and scale of recorded data.

Parameters
[out]measurement_infoA pointer to a DWMeasurementInfo structure that will be filled with the measurement details. The structure must be pre-allocated before calling this function.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetMeasurementInfo instead.

◆ DWGetMultiFileIndex()

DWLIB_API int DWGetMultiFileIndex ( )

Retrieves the index of the currently open multifile.

Returns
The index of the current multi-file data set.
Return values
-1if an error occurs.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetMultiFileIndex instead.

◆ DWGetNumReaders()

DWLIB_API enum DWStatus DWGetNumReaders ( int * num_readers)

Retrieves the number of readers in the shared reader pool.

This function returns the count of reader instances that have been created in the application's shared reader pool.

Parameters
[out]num_readersPointer to an integer where the number of readers will be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use instance-based readers with DWICreateReader instead of the shared reader pool.

◆ DWGetRawSamples()

DWLIB_API enum DWStatus DWGetRawSamples ( int ch_index,
__int64 position,
int count,
void * data,
double * time_stamp )

Retrieves a series of raw samples and their timestamps for a specified channel.

This function fetches a specified number of raw samples starting from a given position for the channel identified by ch_index. The retrieved samples are stored in the provided data array along with their corresponding timestamps in the time_stamp array.

Parameters
[in]ch_indexThe index of the channel from which to retrieve raw samples.
[in]positionThe starting position within the channel's data to begin retrieval.
[in]countThe number of samples to retrieve.
[out]dataA pointer to a buffer where the retrieved sample values will be stored. This buffer must be pre-allocated to hold at least count samples.
[out]time_stampA pointer to an array where the corresponding timestamps will be stored. This array must also be pre-allocated and match the size of the data array.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetRawSamples instead.

◆ DWGetRawSamplesCount()

DWLIB_API __int64 DWGetRawSamplesCount ( int ch_index)

Retrieves the count of raw samples available for a specified channel.

This function returns the total number of raw samples currently available for the given channel index. Raw samples contain unprocessed data directly from the data acquisition device.

Parameters
[in]ch_indexThe index of the channel for which to retrieve the raw sample count.
Returns
The number of raw samples available for the specified channel.
Return values
-1if an error occurs.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetRawSamplesCount instead.

◆ DWGetRecudedDataAllF()

DWLIB_API enum DWStatus DWGetRecudedDataAllF ( int Channel_Number,
double * Y_MIN_Axis,
double * Y_AVE_Axis,
double * Y_MAX_Axis,
double * Y_RMS_Axis,
int position,
int count )

Retrieves all reduced data types (MIN, AVE, MAX, RMS) for a specified channel.

This function fetches a series of reduced data points for a channel identified by Channel_Number, including minimum, average, maximum, and RMS values. The data is retrieved starting at a specified position and fills the provided arrays.

Parameters
[in]Channel_NumberThe number of the channel from which to retrieve data.
[out]Y_MIN_AxisA pointer to an array where the minimum values will be stored. This array must be pre-allocated to hold at least count values.
[out]Y_AVE_AxisA pointer to an array where the average values will be stored. This array must be pre-allocated to hold at least count values.
[out]Y_MAX_AxisA pointer to an array where the maximum values will be stored. This array must be pre-allocated to hold at least count values.
[out]Y_RMS_AxisA pointer to an array where the RMS values will be stored. This array must be pre-allocated to hold at least count values.
[in]positionThe starting position within the channel's data from which to begin retrieval.
[in]countThe number of data points to retrieve.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetRecudedDataAllF instead.

◆ DWGetRecudedDataChannelInfoF()

DWLIB_API enum DWStatus DWGetRecudedDataChannelInfoF ( int Channel_Number,
char * X_Axis_Units,
int X_Axis_Units_size,
char * Y_Axis_Units,
int Y_Axis_Units_size,
double * Chn_Offset,
int * Channel_Length,
double * ch_rate )

Retrieves detailed information about a reduced data channel.

This function provides information about a reduced data channel identified by Channel_Number, including its axis units, offset, length, and sample rate.

Parameters
[in]Channel_NumberThe number of the reduced data channel to query.
[out]X_Axis_UnitsA buffer to store the X-axis units. Must be pre-allocated.
[in]X_Axis_Units_sizeThe size of the X_Axis_Units buffer.
[out]Y_Axis_UnitsA buffer to store the Y-axis units. Must be pre-allocated.
[in]Y_Axis_Units_sizeThe size of the Y_Axis_Units buffer.
[out]Chn_OffsetA pointer to a double where the channel offset will be stored.
[out]Channel_LengthA pointer to an integer where the channel length will be stored.
[out]ch_rateA pointer to a double where the channel sample rate will be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetRecudedDataChannelInfoF instead.

◆ DWGetRecudedDataF()

DWLIB_API enum DWStatus DWGetRecudedDataF ( int Channel_Number,
double * X_Axis,
double * Y_Axis,
int position,
int count )

Retrieves X and Y axis data for a reduced data channel.

This function fetches both X and Y axis values for a reduced data channel identified by Channel_Number. The data is retrieved starting at a specified position and fills the provided X_Axis and Y_Axis arrays.

Parameters
[in]Channel_NumberThe number of the reduced data channel from which to retrieve data.
[out]X_AxisA pointer to an array where X-axis values will be stored. Must be pre-allocated.
[out]Y_AxisA pointer to an array where Y-axis values will be stored. Must be pre-allocated.
[in]positionThe starting position within the channel's data.
[in]countThe number of data points to retrieve.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetRecudedDataF instead.

◆ DWGetRecudedYDataF()

DWLIB_API enum DWStatus DWGetRecudedYDataF ( int Channel_Number,
double * Y_Axis,
int position,
int count )

Retrieves Y-axis reduced data for a specified channel.

This function fetches a series of Y-axis reduced data points for a channel identified by Channel_Number. The data is retrieved starting at a specified position and fills the provided Y_Axis array with the retrieved values.

Parameters
[in]Channel_NumberThe number of the channel from which to retrieve data.
[out]Y_AxisA pointer to an array where the Y-axis values will be stored. This array must be pre-allocated to hold at least count values.
[in]positionThe starting position within the channel's data from which to begin retrieval.
[in]countThe number of data points to retrieve.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetRecudedYDataF instead.

◆ DWGetReducedAveValues()

DWLIB_API enum DWStatus DWGetReducedAveValues ( int ch_index,
int position,
int count,
double * data,
double * time_stamp )

Retrieves a series of average reduced values and their timestamps for a specified channel.

This function fetches a specified number of average reduced values, starting from a given position, for the channel identified by ch_index. The average values are stored in the provided data array, while the corresponding timestamps are stored in the time_stamp array.

Parameters
[in]ch_indexThe index of the channel from which to retrieve average reduced values.
[in]positionThe starting position within the channel's reduced data to begin retrieval.
[in]countThe number of average reduced values to retrieve.
[out]dataA pointer to an array where the retrieved average values will be stored. This array must be pre-allocated to hold at least count values.
[out]time_stampA pointer to an array where the corresponding timestamps will be stored. This array must also be pre-allocated and match the size of the data array.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetReducedAveValues instead.

◆ DWGetReducedDataChannelCountF()

DWLIB_API int DWGetReducedDataChannelCountF ( )

Retrieves the number of channels available for reduced data.

This function returns the total number of channels that have reduced data available. Reduced data channels contain summarized data for visualization and analysis.

Returns
The number of reduced data channels available.
Return values
-1if an error occurs.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetReducedDataChannelCountF instead.

◆ DWGetReducedDataChannelIndexF()

DWLIB_API int DWGetReducedDataChannelIndexF ( char * name)

Retrieves the index of a reduced data channel by its name.

This function searches for a reduced data channel with the specified name and returns its corresponding index. This index can then be used in other functions that accept a channel index parameter.

Parameters
[in]nameA pointer to a null-terminated string containing the name of the reduced data channel to find.
Returns
The index of the reduced data channel if found.
Return values
-1if the channel is not found or an error occurs.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetReducedDataChannelIndexF instead.

◆ DWGetReducedDataChannelNameF()

DWLIB_API enum DWStatus DWGetReducedDataChannelNameF ( int Channel_Number,
char * name,
int name_size )

Retrieves the name of a reduced data channel by its number.

This function fetches the name of a reduced data channel identified by Channel_Number. The name is copied into the provided buffer, ensuring it does not exceed the allocated size.

Parameters
[in]Channel_NumberThe number of the reduced data channel for which to retrieve the name.
[out]nameA pointer to a char buffer where the channel name will be stored. This buffer must be pre-allocated.
[in]name_sizeThe size of the name buffer, indicating the maximum number of characters (including null-terminator) that can be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetReducedDataChannelNameF instead.

◆ DWGetReducedMaxValues()

DWLIB_API enum DWStatus DWGetReducedMaxValues ( int ch_index,
int position,
int count,
double * data,
double * time_stamp )

Retrieves a series of maximum reduced values and their timestamps for a specified channel.

This function fetches a specified number of maximum reduced values, starting from a given position, for the channel identified by ch_index. The maximum values are stored in the provided data array, while the corresponding timestamps are stored in the time_stamp array.

Parameters
[in]ch_indexThe index of the channel from which to retrieve maximum reduced values.
[in]positionThe starting position within the channel's reduced data to begin retrieval.
[in]countThe number of maximum reduced values to retrieve.
[out]dataA pointer to an array where the retrieved maximum values will be stored. This array must be pre-allocated to hold at least count values.
[out]time_stampA pointer to an array where the corresponding timestamps will be stored. This array must also be pre-allocated and match the size of the data array.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetReducedMaxValues instead.

◆ DWGetReducedMinValues()

DWLIB_API enum DWStatus DWGetReducedMinValues ( int ch_index,
int position,
int count,
double * data,
double * time_stamp )

Retrieves a series of minimum reduced values and their timestamps for a specified channel.

This function fetches a specified number of minimum reduced values, starting from a given position, for the channel identified by ch_index. The minimum values are stored in the provided data array, while the corresponding timestamps are stored in the time_stamp array.

Parameters
[in]ch_indexThe index of the channel from which to retrieve minimum reduced values.
[in]positionThe starting position within the channel's reduced data to begin retrieval.
[in]countThe number of minimum reduced values to retrieve.
[out]dataA pointer to an array where the retrieved minimum values will be stored. This array must be pre-allocated to hold at least count values.
[out]time_stampA pointer to an array where the corresponding timestamps will be stored. This array must also be pre-allocated and match the size of the data array.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetReducedMinValues instead.

◆ DWGetReducedRMSValues()

DWLIB_API enum DWStatus DWGetReducedRMSValues ( int ch_index,
int position,
int count,
double * data,
double * time_stamp )

Retrieves a series of RMS reduced values and their timestamps for a specified channel.

This function fetches a specified number of RMS reduced values, starting from a given position, for the channel identified by ch_index. The RMS values are stored in the provided data array, while the corresponding timestamps are stored in the time_stamp array.

Parameters
[in]ch_indexThe index of the channel from which to retrieve RMS reduced values.
[in]positionThe starting position within the channel's reduced data to begin retrieval.
[in]countThe number of RMS reduced values to retrieve.
[out]dataA pointer to an array where the retrieved RMS values will be stored. This array must be pre-allocated to hold at least count values.
[out]time_stampA pointer to an array where the corresponding timestamps will be stored. This array must also be pre-allocated and match the size of the data array.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetReducedRMSValues instead.

◆ DWGetReducedValues()

DWLIB_API enum DWStatus DWGetReducedValues ( int ch_index,
int position,
int count,
struct DWReducedValue * data )

Retrieves a series of reduced values for a specified channel.

This function fetches a specified number of reduced values starting from a given position for the channel identified by ch_index. Reduced values provide summarized statistics such as average, minimum, maximum, and RMS over defined intervals, and are stored in the provided data array.

Parameters
[in]ch_indexThe index of the channel from which to retrieve reduced values.
[in]positionThe starting position within the channel's reduced data to begin retrieval.
[in]countThe number of reduced values to retrieve.
[out]dataA pointer to an array of DWReducedValue structures where the function will store the retrieved reduced values. This array must be allocated to hold at least count elements.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetReducedValues instead.

◆ DWGetReducedValuesBlock()

DWLIB_API enum DWStatus DWGetReducedValuesBlock ( int * ch_ids,
int ch_count,
int position,
int count,
int ib_level,
struct DWReducedValue * data )

Retrieves a block of reduced values for multiple channels.

This function fetches a specified number of reduced values for multiple channels identified by the array of channel IDs. The data is stored in the provided data array.

Parameters
[in]ch_idsA pointer to an array of channel IDs for which to retrieve reduced values.
[in]ch_countThe number of channels in the ch_ids array.
[in]positionThe starting position within the channels' reduced data to begin retrieval.
[in]countThe number of reduced values to retrieve for each channel.
[in]ib_levelThe interpolation block level to use.
[out]dataA pointer to an array of DWReducedValue structures where the retrieved values will be stored. This array must be pre-allocated to hold at least ch_count * count elements.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetReducedValuesBlock instead.

◆ DWGetReducedValuesCount()

DWLIB_API enum DWStatus DWGetReducedValuesCount ( int ch_index,
int * count,
double * block_size )

Retrieves the count of reduced values and the block size for a specified channel.

This function provides the number of reduced values available for a given channel identified by ch_index. It also returns the block size, which indicates the size of data blocks used when calculating reduced values. Reduced values typically summarize data over intervals using statistical measures, such as average, min, max, etc.

Parameters
[in]ch_indexThe index of the channel for which to retrieve the reduced value count.
[out]countA pointer to an integer where the function will store the number of reduced values available.
[out]block_sizeA pointer to a double where the function will store the size of data blocks, in seconds, used for calculating reduced values.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetReducedValuesCount instead.

◆ DWGetScaledSamples()

DWLIB_API enum DWStatus DWGetScaledSamples ( int ch_index,
__int64 position,
int count,
double * data,
double * time_stamp )

Retrieves a series of scaled samples and their timestamps for a specified channel.

This function fetches a specified number of scaled samples starting from a given position for the channel identified by ch_index. The retrieved samples are stored in the provided data array along with their corresponding timestamps in the time_stamp array.

Parameters
[in]ch_indexThe index of the channel from which to retrieve scaled samples.
[in]positionThe starting position within the channel's data to begin retrieval.
[in]countThe number of samples to retrieve.
[out]dataA pointer to an array where the retrieved sample values will be stored. This array must be pre-allocated to hold at least count samples.
[out]time_stampA pointer to an array where the corresponding timestamps will be stored. This array must also be pre-allocated and match the size of the data array.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetScaledSamples instead.

◆ DWGetScaledSamplesCount()

DWLIB_API __int64 DWGetScaledSamplesCount ( int ch_index)

Retrieves the count of scaled samples available for a specified channel.

This function returns the total number of scaled samples currently available for the given channel index. Scaled samples refer to data that has been processed to apply calibration or scaling factors, converting raw data into meaningful engineering units.

Parameters
[in]ch_indexThe index of the channel for which to retrieve the sample count.
Returns
The number of scaled samples available for the specified channel.
Return values
-1if an error occurs.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetScaledSamplesCount instead.

◆ DWGetStoringType()

DWLIB_API int DWGetStoringType ( )

Retrieves the current data storing type.

This function returns the mode or type of data storing currently in use. The data storing type indicates how data is being recorded or managed, such as whether it is stored continuously, on a trigger, or with other specific conditions.

Returns
An integer value indicating StoringTypes.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetStoringType instead.

◆ DWGetStream()

DWLIB_API enum DWStatus DWGetStream ( char * stream_name,
char * buffer,
int * max_len )

Retrieves a stream by name.

This function retrieves a stream of data identified by stream_name. The stream data is copied into the provided buffer, and the length of the data is updated in the max_len parameter.

Parameters
[in]stream_nameThe name of the stream to retrieve.
[out]bufferA pointer to a buffer where the stream data will be stored. This buffer must be pre-allocated.
[in,out]max_lenA pointer to an integer that, on input, indicates the maximum length of the buffer. On output, it contains the actual length of the retrieved stream data.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetStream instead.

◆ DWGetTextChannelList()

DWLIB_API enum DWStatus DWGetTextChannelList ( struct DWChannel * channel_list)

Retrieves a list of text channels available in the current context.

This function populates an array of DWChannel structures with information about each available text channel. Text channels are typically used for non-numeric data, such as strings or descriptive metadata associated with data streams.

Parameters
[out]channel_listA pointer to an array of DWChannel structures that will be filled with the text channel information. The array must be pre-allocated and should have enough space to store information for the available text channels.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
Text channels are no longer used in DewesoftX. They have been replaced with binary channels. See DWGetBinChannelListCount for binary channels.

◆ DWGetTextChannelListCount()

DWLIB_API int DWGetTextChannelListCount ( )

Retrieves the count of text channels available in the current context.

This function returns the total number of text channels that are currently available. Text channels typically refer to channels handling non-numeric data, such as strings or textual metadata.

Returns
The number of text channels available.
Deprecated
Text channels are no longer used in DewesoftX. They have been replaced with binary channels. See DWGetBinChannelListCount for binary channels.

◆ DWGetTextValues()

DWLIB_API enum DWStatus DWGetTextValues ( int ch_index,
int position,
int count,
char * text_values,
double * time_stamp )

Retrieves a series of text values and their timestamps for a specified text channel.

This function fetches a specified number of text values starting from a given position for the channel identified by ch_index. The retrieved text values are stored in the text_values buffer, and their corresponding timestamps are stored in the time_stamp array.

Parameters
[in]ch_indexThe index of the text channel from which to retrieve text values.
[in]positionThe starting position within the channel's data to begin retrieval.
[in]countThe number of text values to retrieve.
[out]text_valuesA pointer to a buffer where the retrieved text values will be stored. The buffer should be large enough to hold all text values. Text values might be null-terminated strings depending on the format.
[out]time_stampA pointer to an array where the corresponding timestamps for each text value will be stored. This array must be pre-allocated and should match the size of the count parameter.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
Text channels are no longer used in DewesoftX. They have been replaced with binary channels. See DWGetBinarySamples and DWGetBinarySamplesEx for binary channels.

◆ DWGetTextValuesCount()

DWLIB_API __int64 DWGetTextValuesCount ( int ch_index)

Retrieves the count of text values available for a specified text channel.

This function returns the total number of text values currently available for the text channel identified by ch_index. Text channels handle non-numeric data, such as strings or textual metadata.

Parameters
[in]ch_indexThe index of the text channel for which to retrieve the text value count.
Returns
The number of text values available for the specified channel.
Deprecated
Text channels are no longer used in DewesoftX. They have been replaced with binary channels. See DWGetBinarySamplesCount for binary channels.

◆ DWGetTriggerDataChannelIndexF()

DWLIB_API int DWGetTriggerDataChannelIndexF ( char * name)

Retrieves the index of a trigger data channel by its name.

This function searches for a trigger data channel with the specified name and returns its corresponding index. This index can then be used in other functions that accept a channel index parameter.

Parameters
[in]nameA pointer to a null-terminated string containing the name of the trigger data channel to find.
Returns
The index of the trigger data channel if found.
Return values
-1if the channel is not found or an error occurs.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetTriggerDataChannelIndexF instead.

◆ DWGetTriggerDataChannelInfoF()

DWLIB_API enum DWStatus DWGetTriggerDataChannelInfoF ( int Trigger_Number,
int Channel_Number,
char * X_Axis_Units,
int X_Axis_Units_size,
char * Y_Axis_Units,
int Y_Axis_Units_size,
double * Chn_Offset,
double * Channel_Length,
double * ch_rate,
int * ch_type )

Retrieves detailed information about a trigger data channel.

This function provides information about a trigger data channel for a specific trigger, including its axis units, offset, length, sample rate, and channel type.

Parameters
[in]Trigger_NumberThe number of the trigger for which to retrieve channel information.
[in]Channel_NumberThe number of the channel within the trigger data.
[out]X_Axis_UnitsA buffer to store the X-axis units. Must be pre-allocated.
[in]X_Axis_Units_sizeThe size of the X_Axis_Units buffer.
[out]Y_Axis_UnitsA buffer to store the Y-axis units. Must be pre-allocated.
[in]Y_Axis_Units_sizeThe size of the Y_Axis_Units buffer.
[out]Chn_OffsetA pointer to a double where the channel offset will be stored.
[out]Channel_LengthA pointer to a double where the channel length will be stored.
[out]ch_rateA pointer to a double where the channel sample rate will be stored.
[out]ch_typeA pointer to an integer where the channel type will be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetTriggerDataChannelInfoF instead.

◆ DWGetTriggerDataChannelNameF()

DWLIB_API enum DWStatus DWGetTriggerDataChannelNameF ( int Channel_Number,
char * name,
int name_size )

Retrieves the name of a trigger data channel by its number.

This function fetches the name of a trigger data channel identified by Channel_Number. The name is copied into the provided buffer, ensuring it does not exceed the allocated size.

Parameters
[in]Channel_NumberThe number of the trigger data channel for which to retrieve the name.
[out]nameA pointer to a char buffer where the channel name will be stored. This buffer must be pre-allocated.
[in]name_sizeThe size of the name buffer, indicating the maximum number of characters (including null-terminator) that can be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetTriggerDataChannelNameF instead.

◆ DWGetTriggerDataF()

DWLIB_API enum DWStatus DWGetTriggerDataF ( int Trigger_Number,
int Channel_Number,
double * Y_Axis,
double * X_Axis,
double position,
int count )

Retrieves trigger data for a specific trigger and channel.

This function fetches data for a specific channel within a trigger's data set. The data includes both Y-axis values and their corresponding X-axis values.

Parameters
[in]Trigger_NumberThe number of the trigger for which to retrieve data.
[in]Channel_NumberThe number of the channel within the trigger data.
[out]Y_AxisA pointer to an array where Y-axis values will be stored. Must be pre-allocated.
[out]X_AxisA pointer to an array where X-axis values will be stored. Must be pre-allocated.
[in]positionThe starting position within the trigger data.
[in]countThe number of data points to retrieve.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetTriggerDataF instead.

◆ DWGetTriggerDataTriggerCountF()

DWLIB_API int DWGetTriggerDataTriggerCountF ( )

Retrieves the number of triggers in the trigger data.

This function returns the total number of triggers currently recorded in the data. Triggers typically mark important events or conditions in the recorded data.

Returns
The number of triggers available.
Return values
-1if an error occurs.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetTriggerDataTriggerCountF instead.

◆ DWGetTriggerDataTriggerTimeF()

DWLIB_API double DWGetTriggerDataTriggerTimeF ( int Trigger_Number)

Retrieves the timestamp of a specific trigger by its number.

This function returns the timestamp associated with a trigger identified by Trigger_Number. The timestamp represents the time at which the trigger occurred, relative to the start of data recording.

Parameters
[in]Trigger_NumberThe number of the trigger for which to retrieve the timestamp.
Returns
A double-precision floating-point value representing the trigger timestamp in seconds.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIGetTriggerDataTriggerTimeF instead.

◆ DWGetVersion()

DWLIB_API int DWGetVersion ( )

Gets the version number of the DWDataReader library.

Returns the version number of the currently loaded DWDataReader library. The version format depends on the library implementation.

Returns
An integer representing the library version.
Remarks
Version is hashed into an integer value in the manner of MAJOR * 1.000.000 + MINOR * 1.000 + PATCH
Deprecated
This function is deprecated and will be removed in a future release. Please use DWGetVersionEx instead.

◆ DWGetVersionEx()

DWLIB_API enum DWStatus DWGetVersionEx ( int * major,
int * minor,
int * patch )

Gets the version number of the DWDataReader library in major, minor, and patch format.

Returns the version number of the currently loaded DWDataReader library. The version format is split into major, minor, and patch components.

Parameters
[out]majorPointer to an integer where the major version will be stored.
[out]minorPointer to an integer where the minor version will be stored.
[out]patchPointer to an integer where the patch version will be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWICloseDataFile()

DWLIB_API enum DWStatus DWICloseDataFile ( READER_HANDLE reader)

Closes the currently open data file for a specific reader instance.

This function closes a data file that has been previously opened with the specified reader instance. It ensures that all resources associated with the file are properly released.

Parameters
[in]readerThe reader instance handle associated with the file to close.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWICreateReader()

DWLIB_API enum DWStatus DWICreateReader ( READER_HANDLE * handle)

Creates a new reader instance handle.

The handle can be used to perform various operations on the data file with instanced functions.

Parameters
[out]handleA pointer to a READER_HANDLE where the created instance will be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIDestroyReader()

DWLIB_API enum DWStatus DWIDestroyReader ( READER_HANDLE handle)

Destroys the specified reader instance.

This function releases all resources associated with the specified reader instance.

Parameters
[in]handleThe READER_HANDLE of the instance to be destroyed.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIExportHeader()

DWLIB_API enum DWStatus DWIExportHeader ( READER_HANDLE reader,
char * file_name )

Exports the setup information to a specified file using a specific reader instance.

This function exports the setup XML structure using the specified reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]file_nameA pointer to a null-terminated string specifying the export file path.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetArrayIndexValue()

DWLIB_API enum DWStatus DWIGetArrayIndexValue ( READER_HANDLE reader,
int ch_index,
int array_info_index,
int array_value_index,
char * value,
int value_size )

Retrieves a specific value from an array's index using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]ch_indexThe index of the channel associated with the array.
[in]array_info_indexThe index of the array information entry.
[in]array_value_indexThe index within the array to retrieve the value.
[out]valueA pointer to a char buffer to store the retrieved value.
[in]value_sizeThe size of the value buffer.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetArrayIndexValueF()

DWLIB_API enum DWStatus DWIGetArrayIndexValueF ( READER_HANDLE reader,
int ch_index,
int array_info_index,
int array_value_index,
double * value )

Retrieves a numeric value from an array's index using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]ch_indexThe index of the channel associated with the array.
[in]array_info_indexThe index of the array information entry.
[in]array_value_indexThe index within the array for the value.
[out]valueA pointer to a double where the retrieved value will be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetArrayInfoCount()

DWLIB_API enum DWStatus DWIGetArrayInfoCount ( READER_HANDLE reader,
int ch_index,
int * count )

Retrieves the count of array information entries using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]ch_indexThe index of the channel to query.
[out]countPointer to an integer where the array info count will be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetArrayInfoList()

DWLIB_API enum DWStatus DWIGetArrayInfoList ( READER_HANDLE reader,
int ch_index,
struct DWArrayInfo * array_inf_list )

Retrieves a list of array information entries using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]ch_indexThe index of the channel for array information retrieval.
[out]array_inf_listA pointer to an array of DWArrayInfo structures to be filled.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetBinarySamples()

DWLIB_API enum DWStatus DWIGetBinarySamples ( READER_HANDLE reader,
int ch_index,
__int64 sampleIndex,
char * data,
double * time_stamp,
int * datalen )

Retrieves a single binary sample and its timestamp using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]ch_indexThe index of the channel from which to retrieve the binary sample.
[in]sampleIndexThe index of the sample to retrieve.
[out]dataA pointer to a buffer where the binary data will be stored.
[out]time_stampA pointer to a double where the timestamp will be stored.
[out]datalenA pointer to an integer where the data length will be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetBinarySamplesCount()

DWLIB_API enum DWStatus DWIGetBinarySamplesCount ( READER_HANDLE reader,
int ch_index,
__int64 * count )

Retrieves the count of samples available for a specified binary channel using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]ch_indexThe index of the binary channel to query.
[out]countPointer to an __int64 where the binary sample count will be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetBinarySamplesEx()

DWLIB_API enum DWStatus DWIGetBinarySamplesEx ( READER_HANDLE reader,
int ch_index,
__int64 position,
int count,
char * data,
double * time_stamp,
int * datalen )

Retrieves multiple binary samples and their timestamps using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]ch_indexThe index of the channel from which to retrieve the binary samples.
[in]positionThe starting position within the channel's data.
[in]countThe number of samples to retrieve.
[out]dataA pointer to a buffer where the binary data will be stored.
[out]time_stampA pointer to an array where the timestamps will be stored.
[out]datalenA pointer to an integer where the total data length will be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetBinChannelList()

DWLIB_API enum DWStatus DWIGetBinChannelList ( READER_HANDLE reader,
struct DWChannel * channel_list )

Retrieves a list of available binary channels using a specific reader instance.

This function populates an array of DWChannel structures with information about the available binary channels using the specified reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[out]channel_listA pointer to an array of DWChannel structures to be filled with binary channel information. The array must be pre-allocated.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetBinChannelListCount()

DWLIB_API enum DWStatus DWIGetBinChannelListCount ( READER_HANDLE reader,
int * count )

Retrieves the number of available binary channels using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[out]countPointer to an integer where the binary channel count will be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetBinData()

DWLIB_API enum DWStatus DWIGetBinData ( READER_HANDLE reader,
int ch_index,
struct DWBinarySample * sample,
char * data,
__int64 * absPos,
int binBufSize )

Retrieves binary data for a specified channel and sample using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]ch_indexThe index of the channel from which to retrieve binary data.
[in]sampleA pointer to a DWBinarySample structure that identifies the target sample.
[out]dataA pointer to a buffer where the binary data will be stored.
[in,out]absPosA pointer to an __int64 that will be updated with the absolute position.
[in]binBufSizeThe size of the data buffer in bytes.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetBinRecSamples()

DWLIB_API enum DWStatus DWIGetBinRecSamples ( READER_HANDLE reader,
int ch_index,
__int64 sampleIndex,
int count,
struct DWBinarySample * data,
double * time_stamp )

Retrieves binary record samples and their timestamps using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]ch_indexThe index of the channel from which to retrieve the binary records.
[in]sampleIndexThe starting sample index.
[in]countThe number of record samples to retrieve.
[out]dataA pointer to an array of DWBinarySample structures to store the binary records.
[out]time_stampA pointer to an array where the timestamps will be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetChannelFactors()

DWLIB_API enum DWStatus DWIGetChannelFactors ( READER_HANDLE reader,
int ch_index,
double * scale,
double * offset )

Retrieves scaling factors for a specified channel using a specific reader instance.

This function retrieves the scale and offset values associated with a channel using the specified reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]ch_indexThe index of the channel for which to retrieve scaling factors.
[out]scaleA pointer to a double where the scale factor will be stored.
[out]offsetA pointer to a double where the offset value will be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetChannelList()

DWLIB_API enum DWStatus DWIGetChannelList ( READER_HANDLE reader,
struct DWChannel * channel_list )

Retrieves the list of available channels using a specific reader instance.

This function populates an array of DWChannel structures with information about the available channels using the specified reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[out]channel_listA pointer to an array of DWChannel structures to be filled with channel information. The array must be pre-allocated.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetChannelListCount()

DWLIB_API enum DWStatus DWIGetChannelListCount ( READER_HANDLE reader,
int * count )

Retrieves the number of available channels using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[out]countPointer to an integer where the channel count will be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetChannelListItem()

DWLIB_API enum DWStatus DWIGetChannelListItem ( READER_HANDLE reader,
int array_index,
int * index,
char * name,
char * unit,
char * description,
int * color,
int * array_size,
int max_char_size )

Retrieves information about a specific channel using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]array_indexThe index of the channel in the list.
[out]indexPointer to store the channel's unique identifier.
[out]nameBuffer to store the channel's name.
[out]unitBuffer to store the channel's unit.
[out]descriptionBuffer to store the channel's description.
[out]colorPointer to store the channel's color.
[out]array_sizePointer to store the channel's array size.
[in]max_char_sizeMaximum size for the string buffers.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetChannelProps()

DWLIB_API enum DWStatus DWIGetChannelProps ( READER_HANDLE reader,
int ch_index,
enum DWChannelProps ch_prop,
void * buffer,
int * max_len )

Retrieves a specific property of a channel using a specific reader instance.

This function fetches a specific property for a channel using the specified reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]ch_indexThe index of the channel for which to retrieve the property.
[in]ch_propThe channel property to retrieve, specified as a DWChannelProps enum value.
[out]bufferA pointer to a buffer where the property value will be stored.
[in,out]max_lenA pointer to an integer for the buffer's max/actual size.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetComplexChannelList()

DWLIB_API enum DWStatus DWIGetComplexChannelList ( READER_HANDLE reader,
struct DWChannel * channel_list )

Retrieves the list of available complex channels using a specific reader instance.

This function populates an array of DWChannel structures with information about the available complex channels using the specified reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[out]channel_listA pointer to an array of DWChannel structures to be filled with channel information. The array must be pre-allocated.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetComplexChannelListCount()

DWLIB_API enum DWStatus DWIGetComplexChannelListCount ( READER_HANDLE reader,
int * count )

Retrieves the number of available complex channels using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[out]countPointer to an integer where the complex channel count will be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetComplexChannelListItem()

DWLIB_API enum DWStatus DWIGetComplexChannelListItem ( READER_HANDLE reader,
int array_index,
int * index,
char * name,
char * unit,
char * description,
int * color,
int * array_size,
int max_char_size )

Retrieves information about a specific complex channel using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]array_indexThe index of the complex channel in the list.
[out]indexPointer to store the channel's identifier.
[out]nameBuffer to store the channel's name.
[out]unitBuffer to store the channel's unit.
[out]descriptionBuffer to store the channel's description.
[out]colorPointer to store the channel's color.
[out]array_sizePointer to store the channel's array size.
[in]max_char_sizeMaximum size for the string buffers.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetComplexRawSamples()

DWLIB_API enum DWStatus DWIGetComplexRawSamples ( READER_HANDLE reader,
int ch_index,
__int64 position,
int count,
struct DWComplex * data,
double * time_stamp )

Retrieves complex raw samples and timestamps using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]ch_indexThe index of the complex channel to retrieve samples from.
[in]positionThe starting position within the channel's data.
[in]countThe number of complex samples to retrieve.
[out]dataA pointer to an array of DWComplex structures for the sample values.
[out]time_stampA pointer to an array where the timestamps will be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetComplexRawSamplesCount()

DWLIB_API enum DWStatus DWIGetComplexRawSamplesCount ( READER_HANDLE reader,
int ch_index,
__int64 * count )

Retrieves the count of complex raw samples using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]ch_indexThe index of the channel to query.
[out]countPointer to an __int64 where the complex raw sample count will be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetComplexScaledSamples()

DWLIB_API enum DWStatus DWIGetComplexScaledSamples ( READER_HANDLE reader,
int ch_index,
__int64 position,
int count,
struct DWComplex * data,
double * time_stamp )

Retrieves a series of complex scaled samples and their timestamps for a specified channel using a specific reader instance.

This function fetches complex scaled samples using the specified reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]ch_indexThe index of the complex channel from which to retrieve scaled samples.
[in]positionThe starting position within the channel's data to begin retrieval.
[in]countThe number of complex samples to retrieve.
[out]dataA pointer to an array of DWComplex structures where the sample values will be stored.
[out]time_stampA pointer to an array where the timestamps will be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetComplexScaledSamplesCount()

DWLIB_API enum DWStatus DWIGetComplexScaledSamplesCount ( READER_HANDLE reader,
int ch_index,
__int64 * count )

Retrieves the count of scaled samples available for a specified complex channel using a specific reader instance.

This function returns the total number of scaled samples available for a complex data channel using the specified reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]ch_indexThe index of the complex channel for which to retrieve the scaled sample count.
[out]countPointer to an __int64 where the sample count will be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetEventList()

DWLIB_API enum DWStatus DWIGetEventList ( READER_HANDLE reader,
struct DWEvent * event_list )

Retrieves the list of events from the current event list using a specific reader instance.

This function fills an array of DWEvent structures with event information using the specified reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[out]event_listA pointer to an array of DWEvent structures to be filled with event data.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetEventListCount()

DWLIB_API enum DWStatus DWIGetEventListCount ( READER_HANDLE reader,
int * count )

Retrieves the count of events available in the current event list using a specific reader instance.

This function returns the number of events using the specified reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[out]countPointer to an integer where the event count will be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetEventListItem()

DWLIB_API enum DWStatus DWIGetEventListItem ( READER_HANDLE reader,
int event_Index,
int * event_type,
double * time_stamp,
char * event_text,
int max_char_size )

Retrieves information about a specific event using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]event_IndexThe index of the event in the event list.
[out]event_typePointer to store the event type.
[out]time_stampPointer to store the event timestamp.
[out]event_textBuffer to store the event's text description.
[in]max_char_sizeMaximum size of the event_text buffer.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetEventTextF()

DWLIB_API enum DWStatus DWIGetEventTextF ( READER_HANDLE reader,
int event_number,
char * text,
int text_size )

Retrieves the text description of an event using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]event_numberThe number of the event to query.
[out]textA pointer to a char buffer for the event text.
[in]text_sizeThe maximum size of the text buffer.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetEventTimeF()

DWLIB_API enum DWStatus DWIGetEventTimeF ( READER_HANDLE reader,
int event_number,
double * time_stamp )

Retrieves the timestamp of a specific event using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]event_numberThe number of the event to query.
[out]time_stampPointer to a double where the event timestamp will be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetEventTypeF()

DWLIB_API enum DWStatus DWIGetEventTypeF ( READER_HANDLE reader,
int event_number,
enum DWEventType * event_type )

Retrieves the type of a specific event using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]event_numberThe number of the event to query.
[out]event_typePointer to an enum DWEventType where the event type will be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetHeaderEntryCount()

DWLIB_API enum DWStatus DWIGetHeaderEntryCount ( READER_HANDLE reader,
int * count )

Retrieves the count of entries in the current header using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[out]countPointer to an integer where the header entry count will be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetHeaderEntryIDF()

DWLIB_API enum DWStatus DWIGetHeaderEntryIDF ( READER_HANDLE reader,
int entry_number,
char * ID,
int name_size )

Retrieves the identifier (ID) of a header entry using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]entry_numberThe number of the header entry.
[out]IDA pointer to a char buffer for the entry ID.
[in]name_sizeThe maximum size of the ID buffer.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetHeaderEntryList()

DWLIB_API enum DWStatus DWIGetHeaderEntryList ( READER_HANDLE reader,
struct DWChannel * entry_list )

Retrieves the list of entries in the current header using a specific reader instance.

This function populates an array with header entry information using the specified reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[out]entry_listA pointer to an array to be filled with the header entries.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetHeaderEntryListItem()

DWLIB_API enum DWStatus DWIGetHeaderEntryListItem ( READER_HANDLE reader,
int array_index,
int * index,
char * name,
char * unit,
char * description,
int * color,
int * array_size,
int max_char_size )

Retrieves information about a specific header entry using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]array_indexThe index of the header entry in the list.
[out]indexPointer to store the entry's identifier.
[out]nameBuffer to store the entry's name.
[out]unitBuffer to store the entry's unit.
[out]descriptionBuffer to store the entry's description.
[out]colorPointer to store the entry's color.
[out]array_sizePointer to store the entry's array size.
[in]max_char_sizeMaximum size for the string buffers.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetHeaderEntryNameF()

DWLIB_API enum DWStatus DWIGetHeaderEntryNameF ( READER_HANDLE reader,
int entry_number,
char * name,
int name_size )

Retrieves the name of a header entry using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]entry_numberThe number of the header entry.
[out]nameA pointer to a char buffer for the entry name.
[in]name_sizeThe maximum size of the name buffer.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetHeaderEntryText()

DWLIB_API enum DWStatus DWIGetHeaderEntryText ( READER_HANDLE reader,
int ch_index,
char * text_value,
int text_value_size )

Retrieves the textual content of a header entry using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]ch_indexThe index of the header entry to retrieve.
[out]text_valueA pointer to a char buffer where the text value will be stored.
[in]text_value_sizeThe maximum size of the text_value buffer.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetHeaderEntryTextF()

DWLIB_API enum DWStatus DWIGetHeaderEntryTextF ( READER_HANDLE reader,
int entry_number,
char * text_value,
int text_value_size )

Retrieves the text value of a header entry using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]entry_numberThe number of the header entry to retrieve.
[out]text_valueA pointer to a char buffer for the text value.
[in]text_value_sizeThe maximum size of the text_value buffer.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetMeasurementInfo()

DWLIB_API enum DWStatus DWIGetMeasurementInfo ( READER_HANDLE reader,
struct DWMeasurementInfo * measurement_info )

Retrieves detailed information about the current measurement using a specific reader instance.

This function populates a DWMeasurementInfo structure with details such as sample rate, start times for measurement and storage, and duration using the specified reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[out]measurement_infoA pointer to a DWMeasurementInfo structure that will be filled with the measurement details. The structure must be pre-allocated before calling this function.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetMultiFileIndex()

DWLIB_API enum DWStatus DWIGetMultiFileIndex ( READER_HANDLE reader,
int * index )

Retrieves the index of the currently open multifile using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[out]indexPointer to an integer where the multifile index will be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetRawSamples()

DWLIB_API enum DWStatus DWIGetRawSamples ( READER_HANDLE reader,
int ch_index,
__int64 position,
int count,
void * data,
double * time_stamp )

Retrieves a series of raw samples and timestamps using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]ch_indexThe index of the channel from which to retrieve raw samples.
[in]positionThe starting position within the channel's data.
[in]countThe number of samples to retrieve.
[out]dataA pointer to a buffer where the sample values will be stored.
[out]time_stampA pointer to an array where the timestamps will be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetRawSamplesCount()

DWLIB_API enum DWStatus DWIGetRawSamplesCount ( READER_HANDLE reader,
int ch_index,
__int64 * count )

Retrieves the count of raw samples using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]ch_indexThe index of the channel to query.
[out]countPointer to an __int64 where the raw sample count will be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetRecudedDataAllF()

DWLIB_API enum DWStatus DWIGetRecudedDataAllF ( READER_HANDLE reader,
int Channel_Number,
double * Y_MIN_Axis,
double * Y_AVE_Axis,
double * Y_MAX_Axis,
double * Y_RMS_Axis,
int position,
int count )

Retrieves all reduced data types using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]Channel_NumberThe channel number to retrieve data from.
[out]Y_MIN_AxisA pointer to an array for the minimum values.
[out]Y_AVE_AxisA pointer to an array for the average values.
[out]Y_MAX_AxisA pointer to an array for the maximum values.
[out]Y_RMS_AxisA pointer to an array for the RMS values.
[in]positionThe starting position for data retrieval.
[in]countThe number of data points to retrieve.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetRecudedDataChannelInfoF()

DWLIB_API enum DWStatus DWIGetRecudedDataChannelInfoF ( READER_HANDLE reader,
int Channel_Number,
char * X_Axis_Units,
int X_Axis_Units_size,
char * Y_Axis_Units,
int Y_Axis_Units_size,
double * Chn_Offset,
int * Channel_Length,
double * ch_rate )

Retrieves detailed information about a reduced data channel using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]Channel_NumberThe number of the reduced data channel to query.
[out]X_Axis_UnitsA buffer to store the X-axis units.
[in]X_Axis_Units_sizeThe size of the X_Axis_Units buffer.
[out]Y_Axis_UnitsA buffer to store the Y-axis units.
[in]Y_Axis_Units_sizeThe size of the Y_Axis_Units buffer.
[out]Chn_OffsetA pointer to a double for the channel offset.
[out]Channel_LengthA pointer to an integer for the channel length.
[out]ch_rateA pointer to a double for the channel sample rate.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetRecudedDataF()

DWLIB_API enum DWStatus DWIGetRecudedDataF ( READER_HANDLE reader,
int Channel_Number,
double * X_Axis,
double * Y_Axis,
int position,
int count )

Retrieves X and Y axis data for a reduced data channel using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]Channel_NumberThe number of the reduced data channel.
[out]X_AxisA pointer to an array for X-axis values.
[out]Y_AxisA pointer to an array for Y-axis values.
[in]positionThe starting position within the channel's data.
[in]countThe number of data points to retrieve.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetRecudedYDataF()

DWLIB_API enum DWStatus DWIGetRecudedYDataF ( READER_HANDLE reader,
int Channel_Number,
double * Y_Axis,
int position,
int count )

Retrieves Y-axis reduced data using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]Channel_NumberThe channel number to retrieve data from.
[out]Y_AxisA pointer to an array where the Y-axis values will be stored.
[in]positionThe starting position for data retrieval.
[in]countThe number of data points to retrieve.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetReducedAveValues()

DWLIB_API enum DWStatus DWIGetReducedAveValues ( READER_HANDLE reader,
int ch_index,
int position,
int count,
double * data,
double * time_stamp )

Retrieves average reduced values and timestamps using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]ch_indexThe index of the channel.
[in]positionThe starting position for retrieval.
[in]countThe number of values to retrieve.
[out]dataArray to store the average values.
[out]time_stampArray to store the timestamps.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetReducedDataChannelCountF()

DWLIB_API enum DWStatus DWIGetReducedDataChannelCountF ( READER_HANDLE reader,
int * count )

Retrieves the number of channels available for reduced data using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[out]countPointer to an integer where the reduced data channel count will be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetReducedDataChannelIndexF()

DWLIB_API enum DWStatus DWIGetReducedDataChannelIndexF ( READER_HANDLE reader,
char * name,
int * index )

Retrieves the index of a reduced data channel by its name using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]nameA pointer to a null-terminated string with the channel name to find.
[out]indexPointer to an integer where the channel index will be stored if found.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetReducedDataChannelNameF()

DWLIB_API enum DWStatus DWIGetReducedDataChannelNameF ( READER_HANDLE reader,
int Channel_Number,
char * name,
int name_size )

Retrieves the name of a reduced data channel using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]Channel_NumberThe number of the reduced data channel.
[out]nameA pointer to a char buffer for the channel name.
[in]name_sizeThe maximum size of the name buffer.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetReducedMinValues()

DWLIB_API enum DWStatus DWIGetReducedMinValues ( READER_HANDLE reader,
int ch_index,
int position,
int count,
double * data,
double * time_stamp )

Retrieves minimum reduced values and timestamps using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]ch_indexThe index of the channel.
[in]positionThe starting position for retrieval.
[in]countThe number of values to retrieve.
[out]dataArray to store the minimum values.
[out]time_stampArray to store the timestamps.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetReducedRMSValues()

DWLIB_API enum DWStatus DWIGetReducedRMSValues ( READER_HANDLE reader,
int ch_index,
int position,
int count,
double * data,
double * time_stamp )

Retrieves RMS reduced values and timestamps using a specific reader instance.

This function fetches RMS reduced values using the specified reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]ch_indexThe index of the channel from which to retrieve RMS values.
[in]positionThe starting position for retrieval.
[in]countThe number of values to retrieve.
[out]dataArray to store the RMS values.
[out]time_stampArray to store the timestamps.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetReducedValues()

DWLIB_API enum DWStatus DWIGetReducedValues ( READER_HANDLE reader,
int ch_index,
int position,
int count,
struct DWReducedValue * data )

Retrieves a series of reduced values for a specified channel using a specific reader instance.

This function fetches reduced values using the specified reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]ch_indexThe index of the channel from which to retrieve reduced values.
[in]positionThe starting position within the channel's reduced data.
[in]countThe number of reduced values to retrieve.
[out]dataA pointer to an array of DWReducedValue structures for the retrieved values.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetReducedValuesBlock()

DWLIB_API enum DWStatus DWIGetReducedValuesBlock ( READER_HANDLE reader,
int * ch_ids,
int ch_count,
int position,
int count,
int ib_level,
struct DWReducedValue * data )

Retrieves a block of reduced values for multiple channels using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]ch_idsA pointer to an array of channel IDs to retrieve values for.
[in]ch_countThe number of channels in the ch_ids array.
[in]positionThe starting position within the reduced data.
[in]countThe number of reduced values to retrieve per channel.
[in]ib_levelThe interpolation block level.
[out]dataA pointer to an array of DWReducedValue structures for the values.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetReducedValuesCount()

DWLIB_API enum DWStatus DWIGetReducedValuesCount ( READER_HANDLE reader,
int ch_index,
int * count,
double * block_size )

Retrieves the count of reduced values and the block size using a specific reader instance.

This function provides the number of reduced values and block size using the specified reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]ch_indexThe index of the channel for which to retrieve the reduced value count.
[out]countA pointer to an integer where the number of reduced values will be stored.
[out]block_sizeA pointer to a double where the block size will be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetScaledSamples()

DWLIB_API enum DWStatus DWIGetScaledSamples ( READER_HANDLE reader,
int ch_index,
__int64 position,
int count,
double * data,
double * time_stamp )

Retrieves a series of scaled samples and their timestamps for a specified channel using a specific reader instance.

This function fetches scaled samples using the specified reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]ch_indexThe index of the channel from which to retrieve scaled samples.
[in]positionThe starting position within the channel's data to begin retrieval.
[in]countThe number of samples to retrieve.
[out]dataA pointer to an array where the retrieved sample values will be stored.
[out]time_stampA pointer to an array where the corresponding timestamps will be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetScaledSamplesCount()

DWLIB_API enum DWStatus DWIGetScaledSamplesCount ( READER_HANDLE reader,
int ch_index,
__int64 * count )

Retrieves the count of scaled samples available for a specified channel using a specific reader instance.

This function returns the total number of scaled samples currently available for the given channel index using the specified reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]ch_indexThe index of the channel for which to retrieve the sample count.
[out]countPointer to an __int64 where the sample count will be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetStoringType()

DWLIB_API enum DWStatus DWIGetStoringType ( READER_HANDLE reader,
enum DWStoringType * storingType )

Retrieves the current data storing type using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[out]storingTypePointer to a DWStoringType enum where the storing type will be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetStream()

DWLIB_API enum DWStatus DWIGetStream ( READER_HANDLE reader,
char * stream_name,
char * buffer,
int * max_len )

Retrieves a stream by name using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]stream_nameThe name of the stream to retrieve.
[out]bufferA pointer to a buffer where the stream data will be stored.
[in,out]max_lenA pointer to an integer for the buffer's max length/actual length.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetTriggerDataChannelIndexF()

DWLIB_API enum DWStatus DWIGetTriggerDataChannelIndexF ( READER_HANDLE reader,
char * name,
int * index )

Retrieves the index of a trigger data channel by its name using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]nameA pointer to a null-terminated string with the channel name to find.
[out]indexPointer to an integer where the channel index will be stored if found.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetTriggerDataChannelInfoF()

DWLIB_API enum DWStatus DWIGetTriggerDataChannelInfoF ( READER_HANDLE reader,
int Trigger_Number,
int Channel_Number,
char * X_Axis_Units,
int X_Axis_Units_size,
char * Y_Axis_Units,
int Y_Axis_Units_size,
double * Chn_Offset,
double * Channel_Length,
double * ch_rate,
int * ch_type )

Retrieves detailed information about a trigger data channel using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]Trigger_NumberThe number of the trigger.
[in]Channel_NumberThe number of the channel within the trigger data.
[out]X_Axis_UnitsA buffer to store the X-axis units.
[in]X_Axis_Units_sizeThe size of the X_Axis_Units buffer.
[out]Y_Axis_UnitsA buffer to store the Y-axis units.
[in]Y_Axis_Units_sizeThe size of the Y_Axis_Units buffer.
[out]Chn_OffsetA pointer to a double for the channel offset.
[out]Channel_LengthA pointer to a double for the channel length.
[out]ch_rateA pointer to a double for the channel sample rate.
[out]ch_typeA pointer to an integer for the channel type.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetTriggerDataChannelNameF()

DWLIB_API enum DWStatus DWIGetTriggerDataChannelNameF ( READER_HANDLE reader,
int Channel_Number,
char * name,
int name_size )

Retrieves the name of a trigger data channel using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]Channel_NumberThe number of the trigger data channel.
[out]nameA pointer to a char buffer for the channel name.
[in]name_sizeThe maximum size of the name buffer.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetTriggerDataF()

DWLIB_API enum DWStatus DWIGetTriggerDataF ( READER_HANDLE reader,
int Trigger_Number,
int Channel_Number,
double * Y_Axis,
double * X_Axis,
double position,
int count )

Retrieves trigger data using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]Trigger_NumberThe number of the trigger.
[in]Channel_NumberThe number of the channel within the trigger data.
[out]Y_AxisA pointer to an array for Y-axis values.
[out]X_AxisA pointer to an array for X-axis values.
[in]positionThe starting position within the trigger data.
[in]countThe number of data points to retrieve.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetTriggerDataTriggerCountF()

DWLIB_API enum DWStatus DWIGetTriggerDataTriggerCountF ( READER_HANDLE reader,
int * count )

Retrieves the number of triggers using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[out]countPointer to an integer where the trigger count will be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWIGetTriggerDataTriggerTimeF()

DWLIB_API enum DWStatus DWIGetTriggerDataTriggerTimeF ( READER_HANDLE reader,
int Trigger_Number,
double * time_stamp )

Retrieves the timestamp of a specific trigger using a specific reader instance.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]Trigger_NumberThe number of the trigger to query.
[out]time_stampPointer to a double where the trigger timestamp will be stored.
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWInit()

DWLIB_API enum DWStatus DWInit ( )

Initializes the DWDataReader library.

This function must be called before any other DWDataReader library functions. It performs necessary setup and initialization of internal resources.

Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWICreateReader instead to create instance-based readers.

◆ DWIOpenDataFile()

DWLIB_API enum DWStatus DWIOpenDataFile ( READER_HANDLE reader,
char * file_name,
struct DWFileInfo * file_info )

Opens the specified file and fills the file_info structure with information about the file contents using a specific reader instance.

This function opens a data file specified by file_name using the provided reader instance and populates the file_info structure with details about the file contents.

Parameters
[in]readerThe reader instance handle to use for this operation.
[in]file_namePath to the file to be opened
[out]file_infoPointer to a preallocated DWFileInfo structure to read file information
Returns
An enumeration value of type DWStatus indicating the result of the operation.

◆ DWOpenDataFile()

DWLIB_API enum DWStatus DWOpenDataFile ( char * file_name,
struct DWFileInfo * file_info )

Opens the specified file and fills the file_info structure with information about the file contents.

Parameters
[in]file_namePath to the file to be opened
[out]file_infoPointer to a preallocated DWFileInfo structure to read file information
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use DWIOpenDataFile instead.

◆ DWSetActiveReader()

DWLIB_API enum DWStatus DWSetActiveReader ( int index)

Sets the active reader in the shared reader pool.

Parameters
[in]indexThe reader index from the shared reader pool to be set as active.
Returns
An enumeration value of type DWStatus indicating the result of the operation.
Deprecated
This function is deprecated and will be removed in a future release. Please use instance-based readers with DWICreateReader instead of the shared reader pool.