| RMC_COLine function. | ||
| Add a CustomObject Line or alter an existing CustomObject. | ||
| Syntax | ||
| nResult (LONG) = RMC_COLine( ByVal nCtrlId (LONG), ByVal nCOIndex (LONG), ByRef nXPoints (LONG), ByRef nYPoints (LONG), ByVal nPointsCount (LONG), Optional ByVal nStyle (LONG), Optional ByVal nColor (LONG), Optional ByVal nAsSpline (LONG), Optional ByVal nLineWidth (LONG), Optional ByVal nStartCap (LONG), Optional ByVal nEndCap (LONG) ) |
||
| Parameter | ||
| nCtrlId (LONG) | ||
| Unique ID of the chart control. | ||
| nCOIndex (LONG) | ||
| Index of the CustomObject. If a CustomObject with this index exists, it will be overwritten, if not, a new CustomOject will be created. | ||
| nXPoints (LONG) | ||
| The first element of an one-dimensional array, which holds the X points for the line. This array must have the same number of elements as the one for the Y points. | ||
| nYPoints (LONG) | ||
| The first element of an one-dimensional array, which holds the Y points for the line. This array must have the same number of elements as the one for the X points. | ||
| nPointsCount (LONG) | ||
| Number of elements in each X- and Y-points array. | ||
| nStyle (LONG) | ||
| Style of the Line as a line style constant (only 2D lines). If omitted or 0: RMC_LINE_FLAT | ||
| nColor (LONG) | ||
| Color for the Line as a Color...constant or as a RGB value. If omitted or 0: ColorBlue. | ||
| nAsSpline (LONG) | ||
| If TRUE, the Line will be painted as a Spline. | ||
| nLineWidth (LONG) | ||
| Width of the Line in pixel. Maximum width can be 5. If omitted or 0: 2. | ||
| nStartCap (LONG) | ||
| Start cap of the Line as a Line cap style constant. If omitted or 0: no start cap. | ||
| nEndCap (LONG) | ||
| End cap of the Line as a Line cap style constant. If omitted or 0: no end cap. | ||
| Return value | ||
| 0 | ||
| No error, function succeeded. | ||
| RMC_ERROR_CTRLID | ||
| Wrong control ID (0 or no chart with this control ID was found). | ||
| RMC_ERROR_CUSTOMINDEX | ||
| Parameter nCOIndex is not valid (either 0 or it exceeds the maximum number of CustomObjects (200). | ||
| RMC_ERROR_ALLOC | ||
| Error while allocating memory for the CustomObject. | ||