GetPolylineData method
Returns the points recorded in a polyline row.
Version added
2000
Syntax
| |
|
object |
Required. An expression that returns a Row object. |
|
flags |
Required Integer. Flags that influence the points returned. |
|
xyArray |
Required Double. Returns an array of alternating x and y values specifying the points recorded in the row. |
Remarks
If the row's type is not visTagPolylineTo, an exception is raised.
If the GetPolylineData method succeeds, xyArray returns a one-dimensional array of n doubles (VT_R8) indexed from 0 to n - 1. The argument xyArray is an out argument that is allocated by the GetPolylineData method, which passes ownership back to the caller. The caller should eventually perform SafeArrayDestroy on the returned array. (Microsoft Visual Basic and Visual Basic for Applications manage this for you.)
The flags argument is a bit mask that specifies options for returning points. Its value should be a combination of zero or more of the following values.
|
Constant |
Value |
Description |
|
visGeomExcludeLastPoint |
&H1 |
The last point of the polyline (the X and Y cells in the row) will not be included in xyArray. |
|
visGeomWHPct |
&H10 |
The values returned in xyArray will be percentages of width/height. |
|
visGeomXYLocal |
&H20 |
The values returned in xyArray will be local, internal units in the drawing. |