| Prototype: |
| int ewdb_api_GetWaveformListByEvent( |
EWDBid IN_idEvent, EWDB_WaveformStruct pWaveformBuffer, EWDB_WaveformStruct pStationBuffer, int bIncludeStationInfo, int * pWaveformDescsFound, int * pWaveformDescsRetrieved, int BufferRecLen); |
|
| Description: |
The function retrieves a list of waveforms that are associated with a given event. See EWDB_WaveformStruct for a description of the information retrieved for each associated waveform. If bIncludeStationInfo is set to TRUE, then the function also retrieves station/component information for each waveform and writes it into the pStationBuffer buffer, in matching order with the waveforms. |
| Note: |
This function only retrieves the waveform DESCRIPTORS, it does not actually retrieve the binary waveform. |
RETURN CODE INFO |
| Return Type: |
int |
|
PARAMETER INFO |
| Parameter |
Type |
Description |
| IN_idEvent |
EWDBid |
Database ID of the Event whose waveform snippets the caller is interested in. |
| pWaveformBuffer |
EWDB_WaveformStruct |
Pointer to a caller allocated buffer of waveform structs which will be filled by this function. |
| pStationBuffer |
EWDB_WaveformStruct |
Pointer to a caller allocated buffer of station structs which will be filled by this function. NOTE: This buffer is only filled if bIncludeStationInfo is set to TRUE. This param can be set to NULL if bIncludeStationInfo is FALSE. |
| bIncludeStationInfo |
int |
Flag(TRUE/FALSE) indicating whether the function should retrieve station/component information for each waveform found. |
| pWaveformDescsFound |
int * |
Pointer to an integer where the function will write the number of waveforms found. |
| pWaveformDescsRetrieved |
int * |
Pointer to an integer where the function will write the number of waveform descriptors placed in the caller's buffer(pWaveformBuffer). |
| BufferRecLen |
int |
Size of the pWaveformBuffer buffer as a multiple of EWDB_WaveformStruct. (example: 15 structs) The pStationBuffer is also assumed to be of atleast this size if bIncludeStationInfo is set to TRUE. |
|
|
| Group: |
EWDB_API_LIB |
| Sub Group: |
WAVEFORM_API |
| Language: |
C |
| Location: |
./src/oracle/schema-working/src/include/ewdb_ora_api.h |