TraceBufferClientTryRead Method |
Namespace: RAYLASE.SPICE3.TraceBufferAssembly: RAYLASE.SPICE3.TraceBufferLib (in RAYLASE.SPICE3.TraceBufferLib.dll) Version: 3.5.2
Syntax public int TryRead(
TraceEvent[] buffer,
int index,
int count
)
Parameters
- buffer TraceEvent
- Buffer where the events will be written to.
- index Int32
- First position inside buffer where the events will be written to.
- count Int32
- Maximum number of events that will be written to buffer.
Return Value
Int32The actual number of
TraceEvent that were written to
bufferRemarks
Reads a maximum of
count available
TraceEvent that were received from the card since the last call to this function. If at least one
TraceEvent is available
it will directly return with only the number of currently available events.
This call blocks until either new data is available, or the
ReadTimeout period has elapsed in which case 0 is returned.
Note that receiving of events has to be enabled using
Start in order to receive
TraceEvents from the card.
See Also