ChRemoveDataSeries Function

Microchip Graphics Library

Microchip Graphics Library
ChRemoveDataSeries Function
C
void ChRemoveDataSeries(
    CHART * pCh, 
    WORD number
);
Overview

This function removes DATASERIES object from the list of DATASERIES objects and frees the memory used of that removed object. The position of the object to be removed is specified by the number parameter. If the list has only one member, it removes the member regardless of the number given.

Input Parameters
Input Parameters 
Description 
CHART * pCh 
Pointer to the chart object. 
WORD number 
The position of the object to be removed in the list where the first object in the list is assigned a value of 1. If this parameter is set to zero, the whole list of DATA_SERIES is removed. 
Returns

none.

Preconditions

none

Side Effects

none.

Example
void ClearChartData(CHART *pCh) {
    if(pCh->pChData != NULL)
        // remove the all data series
        ChRemoveDataSeries(pCh, 0);
}
Microchip Graphics Library Version 3.06.02 - October 15, 2012
Copyright © 2012 Microchip Technology, Inc.  All rights reserved