ExportToWKB(WkbExportFlags,Geometry,Byte[]) Method

In This Topic

Writes an OGC well-known binary formatted version of the input geometry to the specified buffer.

Syntax

C#
Visual Basic (Declaration)

public int ExportToWKB( 
   WkbExportFlags exportFlags,
   Geometry geometry,
   ref byte[] buffer
)

Public Overloads Function ExportToWKB( _
   ByVal exportFlags As WkbExportFlags, _
   ByVal geometry As Geometry, _
   ByRef buffer() As Byte _
) As Integer

Parameters

exportFlags: A combination of WkbExportFlags which determines how the geometry is exported.
geometry: The geometry to write to the buffer.
buffer: The buffer to which the geometry will be written. The buffer must be large enough to hold the OGC well-known binary version of the input geometry.

Return Value

The exact number of bytes written to the buffer.

Exceptions

Exception	Description
System.ArgumentNullException	Geometry is null or empty.
System.NotImplementedException	The method is not implemented for GeometryBag or Multipatch.
System.NotImplementedException	The method is not implemented for geometry with curves.

Remarks

Does not support curves. Also, note that if the contains ID information, this property will not be preserved in the export operation. The WKB OGC standard does not contain the ID property.

Example

Import and Export Geometries to well-known Binary

// create a polyline
List<Coordinate2D> coords = new List<Coordinate2D>
{
  new Coordinate2D(0, 0),
  new Coordinate2D(0, 1),
  new Coordinate2D(1, 1),
  new Coordinate2D(1, 0)
};

Polyline polyline = PolylineBuilderEx.CreatePolyline(
            coords, SpatialReferences.WGS84);

WkbExportFlags wkbExportFlags = WkbExportFlags.WkbExportDefaults;
WkbImportFlags wkbImportFlags = WkbImportFlags.WkbImportDefaults;

// export and import
byte[] buffer = GeometryEngine.Instance.ExportToWKB(wkbExportFlags, polyline);
Geometry geometry = GeometryEngine.Instance.ImportFromWKB(
               wkbImportFlags, buffer, SpatialReferences.WGS84);
Polyline importPolyline = geometry as Polyline;


// alternatively, determine the size for the buffer
int bufferSize = GeometryEngine.Instance.GetWKBSize(wkbExportFlags, polyline);
buffer = new byte[bufferSize];
// export
bufferSize = GeometryEngine.Instance.ExportToWKB(
                wkbExportFlags, polyline, ref buffer);
// import
importPolyline = GeometryEngine.Instance.ImportFromWKB(
         wkbImportFlags, buffer, SpatialReferences.WGS84) as Polyline;

Requirements

Target Platforms: Windows 11, Windows 10, Windows 8.1

Reference

GeometryEngine Class
GeometryEngine Members
Overload List

Send feedback