GetPolylineData Method [Visio 2003 SDK Documentation]
Returns the points recorded in a polyline row.
object**.GetPolylineData**flags, xyArray
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.
Version added
2000
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 visGeomWHPct, visGeomXYLocal, or a combination of either of those values with visGeomExcludeLastPoint. If neither visGeomWHPct nor visGeomXYLocal is passed as part of the flags argument, an error will be generated.
Constant | Value | Description |
---|---|---|
visGeomExcludeLastPoint |
&H1 |
Optional. 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. |
Applies to | Row object
See Also | RowType property