long createLine(string ck, string fc, string xArray, string yArray, string array3)
This method creates a new line feature with CARIS Key and Feature Code given by ck and fc, respectively, and passing through locations given by xArray, yArray, and optionally array3. The arguments xArray and yArray must be comma-separated lists of corresponding x and y locations, respectively, in the current Exchange Coordinate System, unless the map type is NRMR (See Map Types). If the line is to be 2-dimensional, the argument array3 must be empty, i.e. ""; otherwise, it may contain either a comma-separated list of corresponding z-coordinates or time values. (See 2D Vs. 3D Lines.)
The line feature is created with the current defaults for weight, style, and color, as well as the current default restriction. These defaults can be modified by the LineAPI methods:
respectively, by calling one or more of them prior to createLine.
The method returns 0 upon success, and returns error codes for the following conditions:
The input arrays contain invalid coordinates,
The input arrays contain less than two points,
xArray and yArray are not all the same length,
array3 is not empty, but is not the same length as xArray and yArray.
Placement is restricted (the default) and one or more of the given locations lie outside the map’s cover
Placement is restricted and the map has no cover (this occurs if the map has no features)
A CSF error occurred when trying to create the feature. (This should normally not occur, and would most likely indicate a corrupted map dataset.)
Migration
note for v2.5 developers: create
corresponds to createNewLineFeature and createNewLineFeatureEx, where the
weight, style, color, and restrict property are determined by the current
default settings. Use
overrideDefaultWeight, overrideDefaultStyle, overrideDefaultColor, and
overrideDefaultRestrictProperty as needed.