DrawGraph Control Reference 14.0
Methods

Functions

long AddBufferValue (__int3264 lHandle, long *lpvValue, long lPosition)
 Inserts a value to a buffer of the Draw Graph Control.
The buffer can be allocated externally and added to the Draw Graph Control with the AddDataBuffer method or can be created with the CreateDataBuffer method where the buffer is allocated from the Draw Graph Control. More...
 
long AddBufferValueVB (__int3264 lHandle, VARIANT Value, long lPosition)
 Inserts a value to a buffer of the Draw Graph Control. The buffer can be allocated externally and added to the Draw Graph Control with the AddDataBuffer method or can be created with the CreateDataBuffer method where the buffer is allocated from the Draw Graph Control. More...
 
long AddDataBuffer (__int3264 *lHandle, __int3264 lDataBuffer, long lDataBufferEntries, long lDataBufferEntrySize, OLE_COLOR OCColor)
 Adds a data buffer to the tool. More...
 
long AddDataBufferVBDouble (__int3264 *lHandle, double *dDataBuffer, long lDataBufferEntries, long lDataBufferEntrySize, OLE_COLOR OCColor)
 Adds a data buffer of Double values to the tool. More...
 
long AddDataBufferVBLong (__int3264 *lHandle, long *lDataBuffer, long lDataBufferEntries, long lDataBufferEntrySize, OLE_COLOR OCColor)
 Adds a data buffer of Long values to the tool. More...
 
long AddFIFOValue (__int3264 lHandle, long *lpvValue)
 Inserts a value to a FIFO style buffer of the Draw Graph Control.
The buffer can be allocated externally and added to the Draw Graph Control with the AddDataBuffer method or can be created with the CreateDataBuffer method where the buffer is allocated from the Draw Graph Control. More...
 
long AddFIFOValueVB (__int3264 lHandle, VARIANT Value)
 Inserts a value to a FIFO style buffer of the Draw Graph Control.
The buffer can be allocated externally and added to the Draw Graph Control with the AddDataBuffer method or can be created with the CreateDataBuffer method where the buffer is allocated from the Draw Graph Control. More...
 
long ConnectDGSList (__int3264 lHandle)
 This function connects a DGSList from another DrawGraph object or LightMeter object to the control. More...
 
long CreateDataBuffer (__int3264 *lHandle, __int3264 *lDataBuffer, long lDataBufferEntries, long lDataBufferEntrySize, OLE_COLOR OCColor)
 Creates a data buffer which is allocated from the Draw Graph Control.
More...
 
long DeleteAllDataBuffers ()
 Remove all data buffers from the control. This function removes only buffers which are attached with any of the AddDataBuffer* methods. A connected DGSList is not influenced. More...
 
long DeleteDataBuffer (__int3264 *lHandle)
 Deletes a data buffer attached to the control. The method gets the handle which was returned from any of the AddDataBuffer* functions to disconnect the data buffer. More...
 
long DisconnectDGSList (__int3264 lDGSList)
 Disconnects a formerly connected DGSList from the control. More...
 
long GetFIFOPosition (__int3264 lHandle, long *lPosition)
 Get the current position in the FIFO ring buffer. More...
 
long GetGraphColor (__int3264 lHandle, OLE_COLOR *OCColor)
 Returns the draw color of a specific data buffer. More...
 
long GetProcessFlag (__int3264 lHandle, boolean *boProcessFlag)
 Returns the process flag of a specific data buffer. More...
 
double GetStopWatch (long lIndex)
 Measures the time between two calls of the function with the same Index value. A call to this function returns the time when the function with the same index was called last. More than one stopwatch can be used at the same time to measure time interval. The index specifies which stopwatch to use. The first call to a stopwatch returns a undefined value. More...
 
void Refresh ()
 Executes the DrawGraph Control and refreshes the display. This initiates a painting of all data buffers attached. More...
 
long SetAllFIFOPositions (long lPosition)
 Set the current position of all available the FIFO ring buffers. This function is useful to reset all buffers to a value e.g. 0. More...
 
long SetFIFOPosition (__int3264 lHandle, long lPosition)
 Set the current position in the FIFO ring buffer. More...
 
long SetGraphColor (__int3264 lHandle, OLE_COLOR OCColor)
 Sets the draw color of a specific data buffer. This initiates a painting of all data buffers attached. More...
 
long SetProcessFlag (__int3264 lHandle, boolean boProcessFlag)
 Sets the process flag of a specific data buffer. This flag is used to enable or disable the drawing of a specific data buffer included in the control. More...
 

Detailed Description

Function Documentation

◆ AddBufferValue()

long AddBufferValue ( __int3264  lHandle,
long *  lpvValue,
long  lPosition 
)

Inserts a value to a buffer of the Draw Graph Control.
The buffer can be allocated externally and added to the Draw Graph Control with the AddDataBuffer method or can be created with the CreateDataBuffer method where the buffer is allocated from the Draw Graph Control.

Attention
Because Visual Basic does not support explicit type casting you can not use this function in Visual Basic. For this reason use in Visual Basic the AddBufferValueVB method instead.
Parameters
[in]lHandleHandle to the buffer in the DrawGraph Control.
[in]lpvValuePointer to the value to insert.
[in]lPositionPosition in the data buffer array where the value is inserted.
Returns
0 if succeeded.
Supported platforms:
Win32
Win64

◆ AddBufferValueVB()

long AddBufferValueVB ( __int3264  lHandle,
VARIANT  Value,
long  lPosition 
)

Inserts a value to a buffer of the Draw Graph Control. The buffer can be allocated externally and added to the Draw Graph Control with the AddDataBuffer method or can be created with the CreateDataBuffer method where the buffer is allocated from the Draw Graph Control.

Attention
It is recommended to use this function in VB only. For this reason use in Visual Basic the AddBufferValueVB method instead.
Parameters
[in]lHandleHandle to the buffer in the DrawGraph Control.
[in]ValueValue to insert as Variant.
[in]lPositionPosition in the data buffer array where the value is inserted.
Returns
0 if succeeded.
Supported platforms:
Win32
Win64

◆ AddDataBuffer()

long AddDataBuffer ( __int3264 *  lHandle,
__int3264  lDataBuffer,
long  lDataBufferEntries,
long  lDataBufferEntrySize,
OLE_COLOR  OCColor 
)

Adds a data buffer to the tool.

Attention
Because Visual Basic does not support explicit type casting you can not use this function to pass over a buffer allocated in Visual Basic with this function. For this reason use in Visual Basic AddDataBufferVBLong or AddDataBufferVBDouble instead. With Visual C and Delphi this is the recommended function to pass over any data buffer to the DrawGraph Control.
Parameters
[out]lHandleHandle returned to access the buffer in the DrawGraph Control.
[in]lDataBufferPointer to the first element of the data buffer.
[in]lDataBufferEntriesNumber of entries in the data buffer.
[in]lDataBufferEntrySizeSize of a single entry in the data buffer in byte.
[in]OCColorColor of the graph as RGB(x,x,x).
Returns
0 if succeeded.
Supported platforms:
Win32
Win64

◆ AddDataBufferVBDouble()

long AddDataBufferVBDouble ( __int3264 *  lHandle,
double *  dDataBuffer,
long  lDataBufferEntries,
long  lDataBufferEntrySize,
OLE_COLOR  OCColor 
)

Adds a data buffer of Double values to the tool.

Attention
In Visual Basic the first array entry must passed over to the function (dDataBuffer(0)).
Parameters
[out]lHandleHandle returned to access the buffer in the DrawGraph Control.
[in]dDataBufferPointer to the first element of the data buffer.
[in]lDataBufferEntriesNumber of entries in the data buffer.
[in]lDataBufferEntrySizeSize of a single entry in the data buffer in byte.
[in]OCColorColor of the graph as RGB(x,x,x).
Returns
0 if succeeded.
Supported platforms:
Win32
Win64

◆ AddDataBufferVBLong()

long AddDataBufferVBLong ( __int3264 *  lHandle,
long *  lDataBuffer,
long  lDataBufferEntries,
long  lDataBufferEntrySize,
OLE_COLOR  OCColor 
)

Adds a data buffer of Long values to the tool.

Attention
In Visual Basic the first array entry must passed over to the function (lDataBuffer(0)).
Parameters
[out]lHandleHandle returned to access the buffer in the DrawGraph Control.
[in]lDataBufferPointer to the first element of the data buffer.
[in]lDataBufferEntriesNumber of entries in the data buffer.
[in]lDataBufferEntrySizeSize of a single entry in the data buffer in byte.
[in]OCColorColor of the graph as RGB(x,x,x).
Returns
0 if succeeded.
Supported platforms:
Win32
Win64

◆ AddFIFOValue()

long AddFIFOValue ( __int3264  lHandle,
long *  lpvValue 
)

Inserts a value to a FIFO style buffer of the Draw Graph Control.
The buffer can be allocated externally and added to the Draw Graph Control with the AddDataBuffer method or can be created with the CreateDataBuffer method where the buffer is allocated from the Draw Graph Control.

Attention
Because Visual Basic does not support explicit type casting you can not use this function in Visual Basic. For this reason use in Visual Basic the AddFIFOValueVB method instead.
Parameters
[in]lHandleHandle to the buffer in the DrawGraph Control.
[in]lpvValuePointer to the value to insert.
Returns
0 if succeeded.
Supported platforms:
Win32
Win64

◆ AddFIFOValueVB()

long AddFIFOValueVB ( __int3264  lHandle,
VARIANT  Value 
)

Inserts a value to a FIFO style buffer of the Draw Graph Control.
The buffer can be allocated externally and added to the Draw Graph Control with the AddDataBuffer method or can be created with the CreateDataBuffer method where the buffer is allocated from the Draw Graph Control.

Attention
It is recommended to use this function in VB only. For this reason use in Visual Basic the AddFIFOValueVB method instead.
Parameters
[in]lHandleHandle to the buffer in the DrawGraph Control.
[in]ValueValue to insert as Variant.
Returns
0 if succeeded.
Supported platforms:
Win32
Win64

◆ ConnectDGSList()

long ConnectDGSList ( __int3264  lHandle)

This function connects a DGSList from another DrawGraph object or LightMeter object to the control.

Parameters
[in]lHandleHandle to a valid DGSList from another control.
Returns
0 if succeeded.
Supported platforms:
Win32
Win64

◆ CreateDataBuffer()

long CreateDataBuffer ( __int3264 *  lHandle,
__int3264 *  lDataBuffer,
long  lDataBufferEntries,
long  lDataBufferEntrySize,
OLE_COLOR  OCColor 
)

Creates a data buffer which is allocated from the Draw Graph Control.

Some functions described later in this chapter are used to do this in Visual Basic.

Parameters
[out]lHandleHandle returned to access the buffer in the DrawGraph Control.
[in]lDataBufferPointer to the first element of the data buffer.
[in]lDataBufferEntriesNumber of entries in the data buffer.
[in]lDataBufferEntrySizeSize of a single entry in the data buffer in byte.
[in]OCColorColor of the graph as RGB(x,x,x).
Returns
0 if succeeded.
Supported platforms:
Win32
Win64

◆ DeleteAllDataBuffers()

long DeleteAllDataBuffers ( )

Remove all data buffers from the control. This function removes only buffers which are attached with any of the AddDataBuffer* methods. A connected DGSList is not influenced.

Returns
0 if succeeded.
Supported platforms:
Win32
Win64
Related Topics:
AddDataBuffer, AddDataBufferVBDouble, AddDataBufferVBLong

◆ DeleteDataBuffer()

long DeleteDataBuffer ( __int3264 *  lHandle)

Deletes a data buffer attached to the control. The method gets the handle which was returned from any of the AddDataBuffer* functions to disconnect the data buffer.

Attention
The handle is set to 0 by the function.
Parameters
[in]lHandleHandle to the data buffer object.
Returns
0 if succeeded.
Supported platforms:
Win32
Win64
Related Topics:
AddDataBuffer, AddDataBufferVBDouble, AddDataBufferVBLong

◆ DisconnectDGSList()

long DisconnectDGSList ( __int3264  lDGSList)

Disconnects a formerly connected DGSList from the control.

Parameters
[in]lDGSListHandle of a DGSList which should be disconnected.
Returns
0 if succeeded.
Supported platforms:
Win32
Win64

◆ GetFIFOPosition()

long GetFIFOPosition ( __int3264  lHandle,
long *  lPosition 
)

Get the current position in the FIFO ring buffer.

Parameters
[in]lHandleHandle to a buffer in the DrawGraph Control.
[out]lPositionPosition of the current FIFO ring buffer.
Returns
0 if succeeded.
Supported platforms:
Win32
Win64
Related Topics:
SetFIFOPosition

◆ GetGraphColor()

long GetGraphColor ( __int3264  lHandle,
OLE_COLOR *  OCColor 
)

Returns the draw color of a specific data buffer.

Parameters
[in]lHandleHandle to a buffer in the DrawGraph Control.
[out]OCColorDraw color as RGB(x,x,x).
Returns
0 if succeeded.
Supported platforms:
Win32
Win64
Related Topics:
SetGraphColor

◆ GetProcessFlag()

long GetProcessFlag ( __int3264  lHandle,
boolean *  boProcessFlag 
)

Returns the process flag of a specific data buffer.

Parameters
[in]lHandleHandle to a buffer in the DrawGraph Control.
[out]boProcessFlagProcess Flag.
Returns
0 if succeeded.
Supported platforms:
Win32
Win64
Related Topics:
SetProcessFlag

◆ GetStopWatch()

double GetStopWatch ( long  lIndex)

Measures the time between two calls of the function with the same Index value. A call to this function returns the time when the function with the same index was called last. More than one stopwatch can be used at the same time to measure time interval. The index specifies which stopwatch to use. The first call to a stopwatch returns a undefined value.

Parameters
[in]lIndexIndex of the stopwatch to read (0 - 49).
Returns
Time in milliseconds.
Supported platforms:
Win32
Win64

◆ Refresh()

void Refresh ( )

Executes the DrawGraph Control and refreshes the display. This initiates a painting of all data buffers attached.

Returns
0 if succeeded.
Supported platforms:
Win32
Win64

◆ SetAllFIFOPositions()

long SetAllFIFOPositions ( long  lPosition)

Set the current position of all available the FIFO ring buffers. This function is useful to reset all buffers to a value e.g. 0.

Parameters
[in]lPositionPosition of the current FIFO ring buffer.
Returns
0 if succeeded.
Supported platforms:
Win32
Win64
Related Topics:
GetFIFOPosition

◆ SetFIFOPosition()

long SetFIFOPosition ( __int3264  lHandle,
long  lPosition 
)

Set the current position in the FIFO ring buffer.

Parameters
[in]lHandleHandle to a buffer in the DrawGraph Control.
[in]lPositionPosition of the current FIFO ring buffer.
Returns
0 if succeeded.
Supported platforms:
Win32
Win64
Related Topics:
GetFIFOPosition

◆ SetGraphColor()

long SetGraphColor ( __int3264  lHandle,
OLE_COLOR  OCColor 
)

Sets the draw color of a specific data buffer. This initiates a painting of all data buffers attached.

Parameters
[in]lHandleHandle to a buffer in the DrawGraph Control.
[in]OCColorDraw color as RGB(x,x,x).
Returns
0 if succeeded.
Supported platforms:
Win32
Win64
Related Topics:
GetGraphColor

◆ SetProcessFlag()

long SetProcessFlag ( __int3264  lHandle,
boolean  boProcessFlag 
)

Sets the process flag of a specific data buffer. This flag is used to enable or disable the drawing of a specific data buffer included in the control.

Parameters
[in]lHandleHandle to a buffer in the DrawGraph Control.
[in]boProcessFlagProcess Flag.
Returns
0 if succeeded.
Supported platforms:
Win32
Win64
Related Topics:
GetProcessFlag