ExportPoints Method (String, PointFileFormat, Boolean, Boolean, Boolean, ObjectId)

Exports points in specified PointGroup to a point file with advanced options.

Namespace: Autodesk.Civil.DatabaseServices
Assembly: AeccDbMgd (in AeccDbMgd.dll) Version: 13.4.208.0

Syntax

C#

public static uint ExportPoints(
	string pointFileFullName,
	PointFileFormat fileFormat,
	bool useAdjustedElevation,
	bool shouldTransformCoordinate,
	bool shouldExpandCoordinateData,
	ObjectId pointGroupId
)

Visual Basic

Public Shared Function ExportPoints ( _
	pointFileFullName As String, _
	fileFormat As PointFileFormat, _
	useAdjustedElevation As Boolean, _
	shouldTransformCoordinate As Boolean, _
	shouldExpandCoordinateData As Boolean, _
	pointGroupId As ObjectId _
) As UInteger

Visual C++

public:
static unsigned int ExportPoints(
	String^ pointFileFullName, 
	PointFileFormat^ fileFormat, 
	bool useAdjustedElevation, 
	bool shouldTransformCoordinate, 
	bool shouldExpandCoordinateData, 
	ObjectId pointGroupId
)

Parameters

pointFileFullName
Type: System.String
The full path and name of the point file.
fileFormat
Type: Autodesk.Civil.DatabaseServices.PointFileFormat
The file format for the point file. You can get a collection of supported point file formats by using PointFileFormatCollection.GetPointFileFormats().
useAdjustedElevation
Type: System.Boolean
Specifies whether to adjust the point elevation values.
shouldTransformCoordinate
Type: System.Boolean
Specifies whether to transform the points in the file.
shouldExpandCoordinateData
Type: System.Boolean
Specifies whether to calculate the coordinate data properties of the points, such as degrees, minutes, seconds, and hemisphere for latitude and longitude.
pointGroupId
Type: ObjectId
The ObjectId of the PointGroup from which the CogoPoints are exported.

Return Value

The count of CogoPoints that are exported.

Remarks

  1. useAdjustedElevation and shouldExpandCoordinateData are disregarded if they are not supported by the specified point file format.
  2. If the file specified by pointFileFullName already exists, it is overwritten.
  3. If the file specified by pointFileFullName does not exist, it is created automatically.
  4. Set the pointGroupId to ObjectId::Null to export all points.

Examples

CopyC#
 1// Get a supported PointFileFormat to use:
 2//                                       
 3string pointFileName = "c:\\tmp\\Example ExportPointsFile - PENZD.txt";
 4string pointFileFormatName = "PENZD (space delimited)";
 5PointFileFormat pointFileFormat = PointFileFormatCollection.GetPointFileFormats(_acaddoc.Database)[pointFileFormatName];
 6
 7// Export all points in the document:
 8uint result = CogoPointCollection.ExportPoints(pointFileName, pointFileFormat);
 9write("# of exported points: " + result + "\n");
10
11// Same operation, but specify options:
12bool useAdjustedElevation = true;
13bool shouldTransformCoordinate = false;
14bool shouldExpandCoordinateData = true;
15result = CogoPointCollection.ExportPoints(pointFileName, pointFileFormat, useAdjustedElevation,
16    shouldTransformCoordinate, shouldExpandCoordinateData);
17write("# of exported points: " + result + "\n");
18
19// Specify a single point group 
20ObjectId pointGroupId = _civildoc.PointGroups[0];
21pointFileFormatName = "ENZ (comma delimited)";
22pointFileName = "c:\\tmp\\Example ExportPointsFile - ENZ.csv";
23
24result = CogoPointCollection.ExportPoints(pointFileName, pointFileFormat, pointGroupId);
25write("# of exported points: " + result + "\n");
26
27// Same operation, but specify options:
28result = CogoPointCollection.ExportPoints(pointFileName, pointFileFormat, useAdjustedElevation,
29    shouldTransformCoordinate, shouldExpandCoordinateData, pointGroupId);
30write("# of exported points: " + result + "\n");
CopyVB.NET
 1' Get a supported PointFileFormat to use:
 2'                                       
 3Dim pointFileName As String = "c:\tmp\Example ExportPointsFile - PENZD.txt"
 4Dim pointFileFormatName As String = "PENZD (space delimited)"
 5Dim pointFileFormat As PointFileFormat = PointFileFormatCollection.GetPointFileFormats(_acaddoc.Database)(pointFileFormatName)
 6
 7' Export all points in the document:
 8Dim result As UInteger = CogoPointCollection.ExportPoints(pointFileName, pointFileFormat)
 9write("# of exported points: " & result & vbLf)
10
11' Same operation, but specify options:
12Dim useAdjustedElevation As Boolean = True
13Dim shouldTransformCoordinate As Boolean = False
14Dim shouldExpandCoordinateData As Boolean = True
15result = CogoPointCollection.ExportPoints(pointFileName, pointFileFormat, useAdjustedElevation, shouldTransformCoordinate, shouldExpandCoordinateData)
16write("# of exported points: " & result & vbLf)
17
18' Specify a single point group 
19Dim pointGroupId As ObjectId = _civildoc.PointGroups(0)
20pointFileFormatName = "ENZ (comma delimited)"
21pointFileName = "c:\tmp\Example ExportPointsFile - ENZ.csv"
22
23result = CogoPointCollection.ExportPoints(pointFileName, pointFileFormat, pointGroupId)
24write("# of exported points: " & result & vbLf)
25
26' Same operation, but specify options:
27result = CogoPointCollection.ExportPoints(pointFileName, pointFileFormat, useAdjustedElevation, shouldTransformCoordinate, shouldExpandCoordinateData, pointGroupId)

Exceptions

ExceptionCondition
System.ArgumentException Thrown when:
  1. The directory for pointFileFullName does not exist.
  2. The pointGroupId is invalid.
System.InvalidOperationException Thrown when there is an internal error.

See Also