Gx3748EventCaptureClearMemory

Purpose

Clear the specified event capture memory content and set the memory counter to zero.

Syntax

Gx3748EventCaptureClearMemory (nHandle, nMemory, pnStatus)

Parameters

Name
Type
Comments
nHandle
SHORT
Handle to a GX3748 board.
nMemory
SHORT
Specified memory number, memory number are as follows:
0.      GX3748_EVENT_CAPTURE_MEMORY0: memory number 0.
1.      GX3748_EVENT_CAPTURE_MEMORY1: memory number 1.
2.    GX3748_EVENT_CAPTURE_MEMORY2: memory number 2.  
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

The function clears the specified event capture memory content and set the memory counter to zero.

There are 3 independent event capture memories. Each memory can record input events from any of the channels’ groups by setting the memory source, Gx3748EventCaptureSetSource() API. The user can read any number of elements from any of the memories using the Gx3748EventCaptureReadMemory() API., as well as the number of recorded elements by calling the Gx3748EventCaptureReadMemoryCount() API. Whenever the user changes the specified event capture memory input source (group and channel), the content of that memory and the recorded element counter will be cleared. Whenever the user changes the specified event capture memory mode, Gx3748EventCaptureSetMode() API , the content of that memory and the recorded element counter will be cleared.

Example

The following example clears event capture memory 0, and returns the memory count:

 

SHORT nHandle, nStatus;

SHORT nCounter;

 

Gx3748EventCaptureClearMemory(nHandle, GX3748_EVENT_CAPTURE_MEMORY0, &nStatus);

Gx3748EventCaptureReadMemoryCount(nHandle, GX3748_EVENT_CAPTURE_MEMORY0, &nCounter, &nStatus);

 

See Also

Gx3748EventCaptureReadMemory, Gx3748EventCaptureReadMemoryCount, Gx3748EventCaptureReadTimestampCounter, Gx3748EventCaptureResetTimestampCounter, Gx3748EventCaptureSetMode,  Gx3748EventCaptureSetSampleRate, Gx3748EventCaptureSetSource, Gx3748EventCaptureSetState, Gx3748EventCaptureSoftwareTrigger, Gx3748EventCaptureSetHoldoffTime, GxFpgaGetErrorString