ScyllaDB University Live | Free Virtual Training Event
Learn more
ScyllaDB Documentation Logo Documentation
  • Server
  • Cloud
  • Tools
    • ScyllaDB Manager
    • ScyllaDB Monitoring Stack
    • ScyllaDB Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
  • Resources
    • ScyllaDB University
    • Community Forum
    • Tutorials
Download
ScyllaDB Docs Scylla C/C++ Driver API Documentation DsePolygon

DsePolygon¶

struct DsePolygon¶

Public Functions

DsePolygon *dse_polygon_new()¶

Creates a new polygon iterator.

See also

dse_polygon_iterator_free()

Returns:

Returns an polygon that must be freed.

void dse_polygon_free(DsePolygon *polygon)¶

Frees a polygon instance.

Parameters:

polygon – [in]

void dse_polygon_reset(DsePolygon *polygon)¶

Resets a polygon so that it can be reused.

Parameters:

polygon – [in]

void dse_polygon_reserve(DsePolygon *polygon, cass_uint32_t num_rings, cass_uint32_t total_num_points)¶

Reserves enough memory to contain the provided number rings and points. This can be use to reduce memory allocations, but it is not required.

Parameters:
  • polygon – [in]

  • num_rings – [in]

  • total_num_points – [in]

CassError dse_polygon_start_ring(DsePolygon *polygon)¶

Starts a new ring.

Note: This will finish the previous ring.

Parameters:

polygon – [in]

Returns:

CASS_OK if successful, otherwise an error occurred.

CassError dse_polygon_add_point(DsePolygon *polygon, cass_double_t x, cass_double_t y)¶

Adds a point to the current ring.

Parameters:
  • polygon – [in]

  • x – [in]

  • y – [in]

Returns:

CASS_OK if successful, otherwise an error occurred.

CassError dse_polygon_finish(DsePolygon *polygon)¶

Finishes the contruction of a polygon.

Parameters:

polygon – [in]

Returns:

CASS_OK if successful, otherwise an error occurred.

Was this page helpful?

PREVIOUS
DseLineStringIterator
NEXT
DsePolygonIterator
  • Create an issue
  • Edit this page

On this page

  • DsePolygon
    • DsePolygon
      • DsePolygon::dse_polygon_new()
      • DsePolygon::dse_polygon_free()
      • DsePolygon::dse_polygon_reset()
      • DsePolygon::dse_polygon_reserve()
      • DsePolygon::dse_polygon_start_ring()
      • DsePolygon::dse_polygon_add_point()
      • DsePolygon::dse_polygon_finish()
Scylla C/C++ Driver
  • master
    • master
  • C/C++ Driver for ScyllaDB
  • API Documentation
    • CassAggregateMeta
    • CassAuthenticator
    • CassAuthenticatorCallbacks
    • CassBatch
    • CassCluster
    • CassCollection
    • CassColumnMeta
    • CassCustomPayload
    • CassDataType
    • CassErrorResult
    • CassExecProfile
    • CassFunctionMeta
    • CassFuture
    • CassIndexMeta
    • CassInet
    • CassIterator
    • CassKeyspaceMeta
    • CassLogMessage
    • CassMaterializedViewMeta
    • CassMetrics
    • CassNode
    • CassPrepared
    • CassResult
    • CassRetryPolicy
    • CassRow
    • CassSchemaMeta
    • CassSession
    • CassSpeculativeExecutionMetrics
    • CassSsl
    • CassStatement
    • CassTableMeta
    • CassTimestampGen
    • CassTuple
    • CassUserType
    • CassUuid
    • CassUuidGen
    • CassValue
    • CassVersion
    • DseDateRange
    • DseDateRangeBound
    • DseLineString
    • DseLineStringIterator
    • DsePolygon
    • DsePolygonIterator
  • Features
    • Basics
      • Batches
      • Binding Parameters
      • Client-side timestamps
      • Consistency
      • Data Types
      • The date and time Types
      • Futures
      • Handling Results
      • Keyspaces
      • Prepared Statements
      • Schema Metadata
      • Tuples
      • User-Defined Types (UDTs)
      • UUIDs
    • Building
    • Client Configuration
    • Cloud
    • Configuration
      • Retry policies
    • Execution Profiles
    • FAQ
    • Installation
    • Logging
    • Metrics
    • Scylla Specific Features
    • Security
      • SSL
    • Testing
      • Cassandra Cluster Manager (CCM)
    • Tracing
  • DSE Features
    • Authentication
    • Geospatial types
Docs Tutorials University Contact Us About Us
© 2025, ScyllaDB. All rights reserved. | Terms of Service | Privacy Policy | ScyllaDB, and ScyllaDB Cloud, are registered trademarks of ScyllaDB, Inc.
Last updated on 28 April 2025.
Powered by Sphinx 7.4.7 & ScyllaDB Theme 1.8.6