Data type for a Arrow C array. Include ogr\_recordbatch.h to get the definition

Data type for a Arrow C stream. Include ogr\_recordbatch.h to get the definition

Data type for a Arrow C schema. Include ogr\_recordbatch.h to get the definition

CPLErr

Error category

Callback for a custom error handler

Error number

Callback for CPLPushFileFinder

Callback for CPLSubscribeToSetConfigOption()

CPLSharedFileInfo

Information on a shared file

CPLVirtualMemAccessMode

Access mode of a virtual memory mapping.

Callback triggered when a still unmapped page of virtual memory is accessed. The callback has the responsibility of filling the page with relevant values

Arguments

• ctxt: virtual memory handle.
• nOffset: offset of the page in the memory mapping.
• pPageToFill: address of the page to fill. Note that the address might be a temporary location, and not at CPLVirtualMemGetAddr() + nOffset.
• nToFill: number of bytes of the page.
• pUserData: user data that was passed to CPLVirtualMemNew().

Callback triggered when a virtual memory mapping is destroyed.

Arguments

• pUserData: user data that was passed to CPLVirtualMemNew().

Callback triggered when a dirty mapped page is going to be freed. (saturation of cache, or termination of the virtual memory mapping).

Arguments

• ctxt: virtual memory handle.
• nOffset: offset of the page in the memory mapping.
• pPageToBeEvicted: address of the page that will be flushed. Note that the address might be a temporary location, and not at CPLVirtualMemGetAddr() + nOffset.
• nToBeEvicted: number of bytes of the page.
• pUserData: user data that was passed to CPLVirtualMemNew().

CPLXMLNode

Document node structure.

This C structure is used to hold a single text fragment representing a component of the document when parsed. It should be allocated with the appropriate CPL function, and freed with CPLDestroyXMLNode(). The structure contents should not normally be altered by application code, but may be freely examined by application code.

Using the psChild and psNext pointers, a hierarchical tree structure for a document can be represented as a tree of CPLXMLNode structures.

CPLXMLNodeType

XML node type

Type of a constant null-terminated list of nul terminated strings. Seen as char** from C and const char* const* from C++

Type for boolean values (alias to int)

Unsigned byte type

GDALAccess

Flag indicating read/write, or read-only access to data.

Opaque type used for the C bindings of the C++ GDALAsyncReader class

GDALAsyncStatusType

status of the asynchronous stream

Opaque type for C++ GDALAttribute

GDALColorEntry

Color tuple

GDALColorInterp

Types of color interpretation for raster bands.

Opaque type used for the C bindings of the C++ GDALColorTable class

Contour generator opaque type

Contour writer callback type

GDALDataType

Pixel data types

Opaque type used for the C bindings of the C++ GDALDataset class

Type of functions to pass to GDALAddDerivedBandPixelFunc.

\since GDAL 2.2

Type of functions to pass to GDALAddDerivedBandPixelFuncWithArgs.

\since GDAL 3.4

Opaque type for C++ GDALDimension

Opaque type used for the C bindings of the C++ GDALDriver class

Opaque type for C++ GDALEDTComponent

GDALExtendedDataTypeClass

Enumeration giving the class of a GDALExtendedDataType.

\since GDAL 3.1

Opaque type for C++ GDALExtendedDataType

GDALExtendedDataTypeSubType

Enumeration giving the subtype of a GDALExtendedDataType.

\since GDAL 3.4

GDALGridAlgorithm

Gridding Algorithms

GDALGridDataMetricsOptions

Data metrics method control options

GDALGridInverseDistanceToAPowerNearestNeighborOptions

Inverse distance to a power, with nearest neighbour search, control options

GDALGridInverseDistanceToAPowerOptions

Inverse distance to a power method control options

GDALGridLinearOptions

Linear method control options

GDALGridMovingAverageOptions

Moving average method control options

GDALGridNearestNeighborOptions

Nearest neighbor method control options

Opaque type for C++ GDALGroup

Opaque type for C++ GDALMDArray

Opaque type used for the C bindings of the C++ GDALMajorObject class

Doxygen_Suppress

GDALPaletteInterp

Types of color interpretations for a GDALColorTable.

Type of functions to pass to GDALDatasetSetQueryLoggerFunc

\since GDAL 3.7

GDALRATFieldType

Field type of raster attribute table

GDALRATFieldUsage

Field usage of raster attribute table

GDALRATTableType

RAT table type (thematic or athematic)

\since GDAL 2.4

GDALRIOResampleAlg

RasterIO() resampling method.

\since GDAL 2.0

GDALRPCInfoV1

GDALRPCInfoV2

Structure to store Rational Polynomial Coefficients / Rigorous Projection Model. See http://geotiff.maptools.org/rpc_prop.html

GDALRWFlag

Read/Write flag for RasterIO() method

Opaque type used for the C bindings of the C++ GDALRasterAttributeTable class

Opaque type used for the C bindings of the C++ GDALRasterBand class

GDALRasterIOExtraArg

Structure to pass extra arguments to RasterIO() method, must be initialized with INIT_RASTERIO_EXTRA_ARG

\since GDAL 2.0

GDALRelationshipCardinality

Cardinality of relationship.

\since GDAL 3.6

Opaque type used for the C bindings of the C++ GDALRelationship class

\since GDAL 3.6

GDALRelationshipType

Type of relationship.

\since GDAL 3.6

GDALResampleAlg

Warp Resampling Algorithm

Opaque type used for the C bindings of the C++ GDALSubdatasetInfo class

\since GDAL 3.8

GDALTileOrganization

! Enumeration to describe the tile organization

GDALTriBarycentricCoefficients

Triangle barycentric coefficients.

Conversion from cartesian (x,y) to barycentric (l1,l2,l3) with : l1 = dfMul1X * (x - dfCxtX) + dfMul1Y * (y - dfCstY) l2 = dfMul2X * (x - dfCxtX) + dfMul2Y * (y - dfCstY) l3 = 1 - l1 - l2

GDALTriFacet

Triangle fact

GDALTriangulation

Triangulation structure

Free function to pass to GDALVRTRegisterProcessedDatasetFunc.

\since GDAL 3.9

Arguments

• pszFuncName: Function name. Must be unique and not null.
• pUserData: User data. May be nullptr. Must remain valid during the lifetime of GDAL.
• pWorkingData: Value of the *ppWorkingData output parameter of GDALVRTProcessedDatasetFuncInit.

Initialization function to pass to GDALVRTRegisterProcessedDatasetFunc.

This initialization function is called for each step of a VRTProcessedDataset that uses the related algorithm. The initialization function returns the output data type, output band count and potentially initializes a working structure, typically parsing arguments.

\since GDAL 3.9

Arguments

• pszFuncName: Function name. Must be unique and not null.
• pUserData: User data. May be nullptr. Must remain valid during the lifetime of GDAL.
• papszFunctionArgs: Function arguments as a list of key=value pairs.
• nInBands: Number of input bands.
• eInDT: Input data type.
• padfInNoData:[in,out] Array of nInBands values for the input nodata value. The init function may also override them.
• pnOutBands:[in,out] Pointer whose value must be set to the number of output bands. This will be set to 0 by the caller when calling the function, unless this is the final step, in which case it will be initialized with the number of expected output bands.
• peOutDT:[out] Pointer whose value must be set to the output data type.
• ppadfOutNoData:[in,out] Pointer to an array of *pnOutBands values for the output nodata value that the function must set. For non-final steps, *ppadfOutNoData will be nullptr and it is the responsibility of the function to CPLMalloc()'ate it. If this is the final step, it will be already allocated and initialized with the expected nodata values from the output dataset (if the init function need to reallocate it, it must use CPLRealloc())
• pszVRTPath: Directory of the VRT
• ppWorkingData:[out] Pointer whose value must be set to a working structure, or nullptr.

Returns

CE_None in case of success, error otherwise.

Processing function to pass to GDALVRTRegisterProcessedDatasetFunc.

\since GDAL 3.9

Arguments

• pszFuncName: Function name. Must be unique and not null.
• pUserData: User data. May be nullptr. Must remain valid during the lifetime of GDAL.
• pWorkingData: Value of the *ppWorkingData output parameter of GDALVRTProcessedDatasetFuncInit.
• papszFunctionArgs: Function arguments as a list of key=value pairs.
• nBufXSize: Width in pixels of pInBuffer and pOutBuffer
• nBufYSize: Height in pixels of pInBuffer and pOutBuffer
• pInBuffer: Input buffer. It is pixel-interleaved (i.e. R00,G00,B00,R01,G01,B01, etc.)
• nInBufferSize: Size in bytes of pInBuffer
• eInDT: Data type of pInBuffer
• nInBands: Number of bands in pInBuffer.
• padfInNoData: Input nodata values.
• pOutBuffer: Output buffer. It is pixel-interleaved (i.e. R00,G00,B00,R01,G01,B01, etc.)
• nOutBufferSize: Size in bytes of pOutBuffer
• eOutDT: Data type of pOutBuffer
• nOutBands: Number of bands in pOutBuffer.
• padfOutNoData: Input nodata values.
• dfSrcXOff: Source X coordinate in pixel of the top-left of the region
• dfSrcYOff: Source Y coordinate in pixel of the top-left of the region
• dfSrcXSize: Width in pixels of the region
• dfSrcYSize: Height in pixels of the region
• adfSrcGT: Source geotransform
• pszVRTPath: Directory of the VRT
• papszExtra: Extra arguments (unused for now)

GDALViewshedMode

Viewshed Modes

GDALViewshedOutputType

Viewshed output types

Opaque type representing a GDALWarpOperation object

GDALWarpOptions

Warp control options for use with GDALWarpOperation::Initialize()

GDAL_GCP

Ground Control Point

Int16 type

Int32 type

Signed 64 bit integer type

Signed int8 type

Large signed integer type (generally 64-bit integer type). Use GInt64 when exactly 64 bit is needed

Integer type large enough to hold the difference between 2 addresses

Type to express pixel, line or band spacing. Signed 64 bit integer

Unsigned int16 type

Unsigned int32 type

Unsigned 64 bit integer type

Large unsigned integer type (generally 64-bit unsigned integer type). Use GUInt64 when exactly 64 bit is needed

GWKAverageOrModeAlg

GWKAverageOrMode Algorithm

OGRAxisOrientation

Axis orientations (corresponds to CS_AxisOrientationEnum).

Type for a OGR boolean

OGRCodedValue

Associates a code and a value

\since GDAL 3.3

OGRContourWriterInfo

Doxygen_Suppress

Opaque type for a coordinate transformation object

Coordinate transformation options

Opaque type for a OGR datasource (OGRDataSource)

Type for a OGR error

Opaque type for a feature definition (OGRFeatureDefn)

Opaque type for a feature (OGRFeature)

OGRField

OGRFeature field attribute value union.

Opaque type for a field definition (OGRFieldDefn)

Opaque type for a field domain definition (OGRFieldDomain)

OGRFieldDomainMergePolicy

Merge policy for field domains.

When a feature is built by merging two features, defines how the value of attributes following the domain are computed.

\since GDAL 3.3

OGRFieldDomainSplitPolicy

Split policy for field domains.

When a feature is split in two, defines how the value of attributes following the domain are computed.

\since GDAL 3.3

OGRFieldDomainType

Type of field domain.

\since GDAL 3.3

OGRFieldSubType

List of field subtypes. A subtype represents a hint, a restriction of the main type, that is not strictly necessary to consult. This list is likely to be extended in the future ... avoid coding applications based on the assumption that all field types can be known. Most subtypes only make sense for a restricted set of main types.

\since GDAL 2.0

OGRFieldType

List of feature field types. This list is likely to be extended in the future ... avoid coding applications based on the assumption that all field types can be known.

Opaque type for OGRGeomCoordinatePrecision

Opaque type for a geometry field definition (OGRGeomFieldDefn)

Opaque type for a geometry transformer

Opaque type for a geometry

OGRGeometryTypeCounter

Result item of OGR_L_GetGeometryTypes

OGRJustification

Display justification for field values.

Opaque type for a layer (OGRLayer)

Opaque type for a prepared geometry

Opaque type for a OGR driver (OGRSFDriver)

List of parameters for use with OGRStyleBrush

OGRStyleTool derived class types (returned by GetType())

List of parameters for use with OGRStyleLabel

List of parameters for use with OGRStylePen

List of parameters for use with OGRStyleSymbol

List of units supported by OGRStyleTools

Opaque type for a spatial reference system

Style manager opaque type

Opaque type for a style table (OGRStyleTable)

Style tool opaque type

OGRwkbByteOrder

Enumeration to describe byte order

OGRwkbGeometryType

List of well known binary geometry types. These are used within the BLOBs but are also returned from OGRGeometry::getGeometryType() to identify the type of a geometry object.

OGRwkbVariant

Output variants of WKB we support.

99-402 was a short-lived extension to SFSQL 1.1 that used a high-bit flag to indicate the presence of Z coordinates in a WKB geometry.

SQL/MM Part 3 and SFSQL 1.2 use offsets of 1000 (Z), 2000 (M) and 3000 (ZM) to indicate the present of higher dimensional coordinates in a WKB geometry. Reference: <a href="https://portal.opengeospatial.org/files/?artifactid=320243"> 09-009\Committee_Draft_ISOIEC_CD_13249-3_SQLMM_Spatial.pdf</a>, ISO/IEC JTC 1/SC 32 N 1820, ISO/IEC CD 13249-3:201x(E), Date: 2009-01-16. The codes are also found in §8.2.3 of <a href="http://portal.opengeospatial.org/files/?artifact_id=25355"> OGC 06-103r4 "OpenGIS® Implementation Standard for Geographic information - Simple feature access - Part 1: Common architecture", v1.2.1</a>

OSRAxisMappingStrategy

Data axis to CRS axis mapping strategy.

OSRCRSInfo

Structure given overall description of a CRS.

This structure may grow over time, and should not be directly allocated by client code.

OSRCRSType

Type of Coordinate Reference System (CRS).

Doxygen_Suppress

Opaque type for a VRT dataset

Type for a function that returns the pixel data in a provided window

Generic pointer for the working structure of VRTProcessedDataset function

Opaque type for a VRT sourced raster band

VSIDIREntry

Directory entry.

This optional method is called when code plans to access soon one or several ranges in a file. Some file systems may be able to use this hint to for example asynchronously start such requests.

Offsets may be given in a non-increasing order, and may potentially overlap.

\since GDAL 3.7

Arguments

• pFile: File handle.
• nRanges: Size of the panOffsets and panSizes arrays.
• panOffsets: Array containing the start offset of each range.
• panSizes: Array containing the size (in bytes) of each range.

VSIFilesystemPluginCallbacksStruct

struct containing callbacks to used by the handler. (rw), (r), (w) or () at the end indicate whether the given callback is mandatory for reading and or writing handlers. A (?) indicates that the callback might be mandatory for certain drivers only.

\since GDAL 3.0

Close file handle. Optional

\since GDAL 3.0

Has end of file been reached. Mandatory? for read handles.

\since GDAL 3.0

Sync written bytes. Optional

\since GDAL 3.0

Get empty ranges. Optional

\since GDAL 3.0

Create Directory. Optional

\since GDAL 3.0

Open a handle. Mandatory. Returns an opaque pointer that will be used in subsequent file I/O calls. Should return null and/or set errno if the handle does not exist or the access mode is incorrect.

\since GDAL 3.0

Read data from current position, returns the number of blocks correctly read. Mandatory except for write only handles

\since GDAL 3.0

List directory content. Optional

\since GDAL 3.0

Read from multiple offsets. Optional, will be replaced by multiple calls to Read() if not provided

\since GDAL 3.0

Rename handle. Optional

\since GDAL 3.0

Delete Directory. Optional

\since GDAL 3.0

Seek to position in handle. Mandatory except for write only handles

\since GDAL 3.0

List related files. Must return NULL if unknown, or a list of relative filenames that can be opened along the main file. If no other file than pszFilename needs to be opened, return static_cast<char**> (CPLCalloc(1,sizeof(char*)));

Optional

\since GDAL 3.2

Return information about a handle. Optional (driver dependent)

\since GDAL 3.0

Return current position in handle. Mandatory

\since GDAL 3.0

Truncate handle. Mandatory (driver dependent?) for write handles

Remove handle by name. Optional

\since GDAL 3.0

Write bytes at current offset. Mandatory for writable handles

\since GDAL 3.0

Opaque type for a FILE that implements the VSIVirtualHandle API

VSIRangeStatus

Range status

Doxygen_Suppress

Type for VSIStatL()

Callback used by VSIStdoutSetRedirection()

ogr_style_tool_class_id

OGRStyleTool derived class types (returned by GetType()).

ogr_style_tool_param_brush_id

List of parameters for use with OGRStyleBrush.

ogr_style_tool_param_label_id

List of parameters for use with OGRStyleLabel.

ogr_style_tool_param_pen_id

List of parameters for use with OGRStylePen.

ogr_style_tool_param_symbol_id

List of parameters for use with OGRStyleSymbol.

ogr_style_tool_units_id

List of units supported by OGRStyleTools.

Type for a file offset

_CPLAssert(const char * pszExpression,
           const char * pszFile,
           int iLine) -> void

Report failure of a logical assertion.

Handle anything returned from GDAL

When values are returned from GDAL, always check if there was a failure using maybe_throw. If the failure was thrown by GDAL itself, it will not even get to aftercare and end up in gdaljl_errorhandler. However in many cases even though GDAL sets the error state to CE_Failure it will not throw the error. However we always do, to make sure not failure goes unnoticed. If an error might be expected, one can use try .. catch to handle this.

Depending on the return type, we do extra work.

For string pointers, load them to String, and free them if we should.

For string list pointers, load them to Vector{String}

That is it expects a StringList, in the sense of the CPL functions, as a null-terminated array of strings.

CPLAcquireLock(CPLLock * psLock) -> int

CPLAcquireMutex(CPLMutex * hMutexIn,
                double) -> int

CPLAddFileInZip(void * hZip,
                const char * pszArchiveFilename,
                const char * pszInputFilename,
                VSILFILE * fpInput,
                CSLConstList papszOptions,
                GDALProgressFunc pProgressFunc,
                void * pProgressData) -> CPLErr

Add a file inside a ZIP file opened/created with CPLCreateZip().

Parameters

• hZip: ZIP file handle
• pszArchiveFilename: Filename (in UTF-8) stored in the archive.
• pszInputFilename: Filename of the file to add. If NULL, fpInput must not be NULL
• fpInput: File handle opened on the file to add. May be NULL if pszInputFilename is provided.
• papszOptions: Options.
• pProgressFunc: Progress callback, or NULL.
• pProgressData: User data of progress callback, or NULL.

Returns

CE_None in case of success.

CPLAddXMLAttributeAndValue(CPLXMLNode * psParent,
                           const char * pszName,
                           const char * pszValue) -> void

Create an attribute and text value.

Parameters

• psParent: the parent node to which the resulting node should be attached. Must not be NULL.
• pszName: the attribute name to create.
• pszValue: the text to attach to the attribute. Must not be NULL.

CPLAddXMLChild(CPLXMLNode * psParent,
               CPLXMLNode * psChild) -> void

Add child node to parent.

Parameters

• psParent: the node to attach the child to. May not be NULL.
• psChild: the child to add to the parent. May not be NULL. Should not be a child of any other parent.

CPLAddXMLSibling(CPLXMLNode * psOlderSibling,
                 CPLXMLNode * psNewSibling) -> void

Add new sibling.

Parameters

• psOlderSibling: the node to attach the sibling after.
• psNewSibling: the node to add at the end of psOlderSiblings psNext chain.

CPLAtof(const char * nptr) -> double

Converts ASCII string to floating point number.

Parameters

• nptr: Pointer to string to convert.

Returns

Converted value, if any.

CPLAtofDelim(const char * nptr,
             char point) -> double

Converts ASCII string to floating point number.

Parameters

• nptr: Pointer to string to convert.
• point: Decimal delimiter.

Returns

Converted value, if any.

CPLAtofM(const char * nptr) -> double

Converts ASCII string to floating point number using any numeric locale.

Parameters

• nptr: The string to convert.

Returns

Converted value, if any. Zero on failure.

CPLAtoGIntBig(const char * pszString) -> GIntBig

Convert a string to a 64 bit signed integer.

Parameters

• pszString: String containing 64 bit signed integer.

Returns

64 bit signed integer.

CPLAtoGIntBigEx(const char * pszString,
                int bWarn,
                int * pbOverflow) -> GIntBig

Convert a string to a 64 bit signed integer.

Parameters

• pszString: String containing 64 bit signed integer.
• bWarn: Issue a warning if an overflow occurs during conversion
• pbOverflow: Pointer to an integer to store if an overflow occurred, or NULL

Returns

64 bit signed integer.

CPLCalloc(size_t nCount,
          size_t nSize) -> void *

Safe version of calloc().

Parameters

• nCount: number of objects to allocate.
• nSize: size (in bytes) of object to allocate.

Returns

pointer to newly allocated memory, only NULL if nSize * nCount is NULL.

CPLCallPreviousHandler(CPLErr eErrClass,
                       CPLErrorNum err_no,
                       const char * pszMsg) -> void

Call the previously installed error handler in the error handler stack.

CPLCheckForFile(char * pszFilename,
                char ** papszSiblingFiles) -> int

Check for file existence.

Parameters

• pszFilename: name of file to check for - filename case updated in some cases.
• papszSiblingFiles: a list of files in the same directory as pszFilename if available, or NULL. This list should have no path components.

Returns

TRUE if a match is found, or FALSE if not.

CPLCleanTrailingSlash(const char * pszPath) -> const char *

Remove trailing forward/backward slash from the path for UNIX/Windows resp.

Parameters

• pszPath: the path to be cleaned up

Returns

Path in an internal string which must not be freed. The string may be destroyed by the next CPL filename handling call.

cplcleanuperrormutex()

Doxygen_Suppress

CPLCleanupMasterMutex() -> void

cplcleanupsetlocalemutex()

Doxygen_Suppress

cplcleanupsharedfilemutex()

Doxygen_Suppress

CPLCleanupTLS() -> void

CPLCleanXMLElementName(char * pszTarget) -> void

Make string into safe XML token.

Parameters

• pszTarget: the string to be adjusted. It is altered in place.

CPLCloneXMLTree(const CPLXMLNode * psTree) -> CPLXMLNode *

Copy tree.

Parameters

• psTree: the tree to duplicate.

Returns

a copy of the whole tree.

CPLCloseFileInZip(void *) -> CPLErr

CPLCloseShared(FILE * fp) -> void

Close shared file.

Parameters

• fp: file handle from CPLOpenShared() to deaccess.

CPLCloseZip(void *) -> CPLErr

CPLCondBroadcast(CPLCond * hCond) -> void

CPLCondSignal(CPLCond * hCond) -> void

CPLCondTimedWait(CPLCond * hCond,
                 CPLMutex * hMutex,
                 double dfWaitInSeconds) -> CPLCondTimedWaitReason

CPLCondWait(CPLCond * hCond,
            CPLMutex * hMutex) -> void

CPLCopyFile(const char * pszNewPath,
            const char * pszOldPath) -> int

Copy a file.

CPLCopyTree(const char * pszNewPath,
            const char * pszOldPath) -> int

Recursively copy a tree.

CPLCorrespondingPaths(const char * pszOldFilename,
                      const char * pszNewFilename,
                      char ** papszFileList) -> char **

Identify corresponding paths.

Parameters

• pszOldFilename: path to old prototype file.
• pszNewFilename: path to new prototype file.
• papszFileList: list of other files associated with pszOldFilename to rename similarly.

Returns

a list of files corresponding to papszFileList but renamed to correspond to pszNewFilename.

CPLCreateCond() -> CPLCond *

CPLCreateFileInZip(void *,
                   const char *,
                   char **) -> CPLErr

CPLCreateJoinableThread(CPLThreadFunc pfnMain,
                        void * pThreadArg) -> CPLJoinableThread *

CPLCreateLock(CPLLockType eType) -> CPLLock *

CPLCreateMutex() -> CPLMutex *

CPLCreateMutexEx(int nOptions) -> CPLMutex *

CPLCreateOrAcquireLock(CPLLock ** ppsLock,
                       CPLLockType eType) -> int

CPLCreateOrAcquireMutex(CPLMutex ** phMutex,
                        double dfWaitInSeconds) -> int

CPLCreateOrAcquireMutexEx(CPLMutex ** phMutex,
                          double dfWaitInSeconds,
                          int nOptions) -> int

CPLCreateThread(CPLThreadFunc pfnMain,
                void * pThreadArg) -> int

CPLCreateXMLElementAndValue(CPLXMLNode * psParent,
                            const char * pszName,
                            const char * pszValue) -> CPLXMLNode *

Create an element and text value.

Parameters

• psParent: the parent node to which the resulting node should be attached. May be NULL to keep as freestanding.
• pszName: the element name to create.
• pszValue: the text to attach to the element. Must not be NULL.

Returns

the pointer to the new element node.

CPLCreateXMLNode(CPLXMLNode * poParent,
                 CPLXMLNodeType eType,
                 const char * pszText) -> CPLXMLNode *

Create an document tree item.

Parameters

• poParent: the parent to which this node should be attached as a child. May be NULL to keep as free standing.
• eType: the type of the newly created node
• pszText: the value of the newly created node

Returns

the newly created node, now owned by the caller (or parent node).

cplcreatezip(pszZipFilename, papszOptions)

CPLDecToDMS(double dfAngle,
            const char * pszAxis,
            int nPrecision) -> const char *

Translate a decimal degrees value to a DMS string with hemisphere.

CPLDecToPackedDMS(double dfDec) -> double

Convert decimal degrees into packed DMS value (DDDMMMSSS.SS).

Parameters

• dfDec: Angle in decimal degrees.

Returns

Angle in packed DMS format.

CPLDefaultFindFile(const char * pszClass,
                   const char * pszBasename) -> const char *

CPLDefaultFindFile.

CPLDestroyCond(CPLCond * hCond) -> void

CPLDestroyLock(CPLLock * psLock) -> void

CPLDestroyMutex(CPLMutex * hMutexIn) -> void

CPLDestroyXMLNode(CPLXMLNode * psNode) -> void

Destroy a tree.

Parameters

• psNode: the tree to free.

cpldmstodec(is)

CPLDumpSharedList(FILE * fp) -> void

Report open shared files.

Parameters

• fp: File handle to write to.

CPLExpandTilde(const char * pszFilename) -> const char *

Expands ~/ at start of filename.

Parameters

• pszFilename: filename potentially starting with ~/

Returns

an expanded filename.

CPLExtractRelativePath(const char * pszBaseDir,
                       const char * pszTarget,
                       int * pbGotRelative) -> const char *

Get relative path from directory to target file.

Parameters

• pszBaseDir: the name of the directory relative to which the path should be computed. pszBaseDir may be NULL in which case the original target is returned without relativizing.
• pszTarget: the filename to be changed to be relative to pszBaseDir.
• pbGotRelative: Pointer to location in which a flag is placed indicating that the returned path is relative to the basename (TRUE) or not (FALSE). This pointer may be NULL if flag is not desired.

Returns

an adjusted path or the original if it could not be made relative to the pszBaseFile's path.

CPLFGets(char * pszBuffer,
         int nBufferSize,
         FILE * fp) -> char *

Reads in at most one less than nBufferSize characters from the fp stream and stores them into the buffer pointed to by pszBuffer.

Parameters

• pszBuffer: pointer to the targeting character buffer.
• nBufferSize: maximum size of the string to read (not including terminating '\0').
• fp: file pointer to read from.

Returns

pointer to the pszBuffer containing a string read from the file or NULL if the error or end of file was encountered.

CPLFinderClean() -> void

CPLFinderClean.

CPLFindFile(const char * pszClass,
            const char * pszBasename) -> const char *

CPLFindFile.

CPLFormCIFilename(const char * pszPath,
                  const char * pszBasename,
                  const char * pszExtension) -> const char *

Case insensitive file searching, returning full path.

Parameters

• pszPath: directory path to the directory containing the file. This may be relative or absolute, and may have a trailing path separator or not. May be NULL.
• pszBasename: file basename. May optionally have path and/or extension. May not be NULL.
• pszExtension: file extension, optionally including the period. May be NULL.

Returns

a fully formed filename in an internal static string. Do not modify or free the returned string. The string may be destroyed by the next CPL call.

CPLFormFilename(const char * pszPath,
                const char * pszBasename,
                const char * pszExtension) -> const char *

Build a full file path from a passed path, file basename and extension.

Parameters

• pszPath: directory path to the directory containing the file. This may be relative or absolute, and may have a trailing path separator or not. May be NULL.
• pszBasename: file basename. May optionally have path and/or extension. Must NOT be NULL.
• pszExtension: file extension, optionally including the period. May be NULL.

Returns

a fully formed filename in an internal static string. Do not modify or free the returned string. The string may be destroyed by the next CPL call.

cplfreeconfig()

Doxygen_Suppress

CPLGenerateTempFilename(const char * pszStem) -> const char *

Generate temporary file name.

Parameters

• pszStem: if non-NULL this will be part of the filename.

Returns

a filename which is valid till the next CPL call in this thread.

CPLGetBasename(const char * pszFullFilename) -> const char *

Extract basename (non-directory, non-extension) portion of filename.

Parameters

• pszFullFilename: the full filename potentially including a path.

Returns

just the non-directory, non-extension portion of the path in an internal string which must not be freed. The string may be destroyed by the next CPL filename handling call.

cplgetconfigoption(arg1, arg2)

cplgetconfigoptions()

CPLGetCurrentDir() -> char *

Get the current working directory name.

Returns

a pointer to buffer, containing current working directory path or NULL in case of error. User is responsible to free that buffer after usage with CPLFree() function. If HAVE_GETCWD macro is not defined, the function returns NULL.

CPLGetCurrentProcessID() -> int

CPLGetDirname(const char * pszFilename) -> const char *

Extract directory path portion of filename.

Parameters

• pszFilename: the filename potentially including a path.

Returns

Path in an internal string which must not be freed. The string may be destroyed by the next CPL filename handling call. The returned will generally not contain a trailing path separator.

CPLGetExecPath(char * pszPathBuf,
               int nMaxLength) -> int

Fetch path of executable.

Parameters

• pszPathBuf: the buffer into which the path is placed.
• nMaxLength: the buffer size (including the nul-terminating character). MAX_PATH+1 is suggested.

Returns

FALSE on failure or TRUE on success.

CPLGetExtension(const char * pszFullFilename) -> const char *

Extract filename extension from full filename.

Parameters

• pszFullFilename: the full filename potentially including a path.

Returns

just the extension portion of the path in an internal string which must not be freed. The string may be destroyed by the next CPL filename handling call.

CPLGetFilename(const char * pszFullFilename) -> const char *

Extract non-directory portion of filename.

Parameters

• pszFullFilename: the full filename potentially including a path.

Returns

just the non-directory portion of the path (points back into original string).

CPLGetGlobalConfigOption(const char * pszKey,
                         const char * pszDefault) -> const char *

Same as CPLGetConfigOption() but excludes environment variables and options set with CPLSetThreadLocalConfigOption().

CPLGetHomeDir() -> const char *

Return the path to the home directory.

Returns

the home directory, or NULL.

CPLGetLastErrorMsg() -> const char *

Get the last error message.

Returns

the last error message, or an empty string ("") if there is no posted error message.

CPLGetNumCPUs() -> int

cplgetpagesize()

Return the size of a page of virtual memory.

\since GDAL 1.11

Returns

the page size.

CPLGetPath(const char * pszFilename) -> const char *

Extract directory path portion of filename.

Parameters

• pszFilename: the filename potentially including a path.

Returns

Path in an internal string which must not be freed. The string may be destroyed by the next CPL filename handling call. The returned will generally not contain a trailing path separator.

CPLGetPhysicalRAM(void) -> GIntBig

Return the total physical RAM in bytes.

Returns

the total physical RAM in bytes (or 0 in case of failure).

cplgetpid()

Contrary to what its name suggests, CPLGetPID() actually returns the thread id

CPLGetSharedList(int * pnCount) -> CPLSharedFileInfo *

Fetch list of open shared files.

Parameters

• pnCount: place to put the count of entries.

Returns

the pointer to the first in the array of shared file info structures.

CPLGetSymbol(const char * pszLibrary,
             const char * pszSymbolName) -> void *

Fetch a function pointer from a shared library / DLL.

Parameters

• pszLibrary: the name of the shared library or DLL containing the function. May contain path to file. If not system supplies search paths will be used.
• pszSymbolName: the name of the function to fetch a pointer to.

Returns

A pointer to the function if found, or NULL if the function isn't found, or the shared library can't be loaded.

CPLGetThreadingModel() -> const char *

CPLGetThreadLocalConfigOption(const char * pszKey,
                              const char * pszDefault) -> const char *

Same as CPLGetConfigOption() but only with options set with CPLSetThreadLocalConfigOption()

CPLGetThreadLocalConfigOptions(void) -> char **

Return the list of thread local configuration options as KEY=VALUE pairs.

Returns

a copy of the list, to be freed with CSLDestroy().

CPLGetTLS(int nIndex) -> void *

CPLGetTLSEx(int nIndex,
            int * pbMemoryErrorOccurred) -> void *

CPLGetUsablePhysicalRAM(void) -> GIntBig

Return the total physical RAM, usable by a process, in bytes.

Returns

the total physical RAM, usable by a process, in bytes (or 0 in case of failure).

CPLGetXMLNode(CPLXMLNode * psRoot,
              const char * pszPath) -> CPLXMLNode *

Find node by path.

Parameters

• psRoot: the subtree in which to search. This should be a node of type CXT_Element. NULL is safe.
• pszPath: the list of element names in the path (dot separated).

Returns

the requested element node, or NULL if not found.

CPLGetXMLValue(const CPLXMLNode * psRoot,
               const char * pszPath,
               const char * pszDefault) -> const char *

Fetch element/attribute value.

Parameters

• psRoot: the subtree in which to search. This should be a node of type CXT_Element. NULL is safe.
• pszPath: the list of element names in the path (dot separated). An empty path means get the value of the psRoot node.
• pszDefault: the value to return if a corresponding value is not found, may be NULL.

Returns

the requested value or pszDefault if not found.

CPLIsFilenameRelative(const char * pszFilename) -> int

Is filename relative or absolute?

Parameters

• pszFilename: the filename with path to test.

Returns

TRUE if the filename is relative or FALSE if it is absolute.

cplispoweroftwo(i)

CPLIsPowerOfTwo()

Arguments

• i: - tested number

Returns

TRUE if i is power of two otherwise return FALSE

cplisvirtualmemfilemapavailable()

Return if virtual memory mapping of a file is available.

\since GDAL 1.11

Returns

TRUE if virtual memory mapping of a file is available.

CPLJoinThread(CPLJoinableThread * hJoinableThread) -> void

CPLLaunderForFilename(const char * pszName,
                      const char * pszOutputPath) -> const char *

Launder a string to be compatible of a filename.

Parameters

• pszName: The input string to launder.
• pszOutputPath: The directory where the file would be created. Unused for now. May be NULL.

Returns

the laundered name.

CPLLoadConfigOptionsFromFile(const char * pszFilename,
                             int bOverrideEnvVars) -> void

Load configuration from a given configuration file.

Parameters

• pszFilename: File where to load configuration from.
• bOverrideEnvVars: Whether configuration options from the configuration file should override environment variables.

CPLLoadConfigOptionsFromPredefinedFiles() -> void

Load configuration from a set of predefined files.

CPLLockFile(const char * pszPath,
            double dfWaitInSeconds) -> void *

CPLLockSetDebugPerf(CPLLock *,
                    int bEnableIn) -> void

CPLMalloc(size_t nSize) -> void *

Safe version of malloc().

Parameters

• nSize: size (in bytes) of memory block to allocate.

Returns

pointer to newly allocated memory, only NULL if nSize is zero.

CPLMoveFile(const char * pszNewPath,
            const char * pszOldPath) -> int

Move a file.

CPLOpenShared(const char * pszFilename,
              const char * pszAccess,
              int bLargeIn) -> FILE *

Open a shared file handle.

Parameters

• pszFilename: the name of the file to open.
• pszAccess: the normal fopen()/VSIFOpen() style access string.
• bLargeIn: If TRUE VSIFOpenL() (for large files) will be used instead of VSIFOpen().

Returns

a file handle or NULL if opening fails.

CPLPackedDMSToDec(double dfPacked) -> double

Convert a packed DMS value (DDDMMMSSS.SS) into decimal degrees.

Parameters

• dfPacked: Angle in packed DMS format.

Returns

Angle in decimal degrees.

CPLParseXMLFile(const char * pszFilename) -> CPLXMLNode *

Parse XML file into tree.

Parameters

• pszFilename: the file to open.

Returns

NULL on failure, or the document tree on success.

CPLParseXMLString(const char * pszString) -> CPLXMLNode *

Parse an XML string into tree form.

Parameters

• pszString: the document to parse.

Returns

parsed tree or NULL on error.

CPLPopFileFinder() -> CPLFileFinder

CPLPopFileFinder.

CPLPopFinderLocation() -> void

CPLPopFinderLocation.

CPLPrintDouble(char * pszBuffer,
               const char * pszFormat,
               double dfValue,
               const char * pszLocale) -> int

Print double value into specified string buffer.

Parameters

• pszBuffer: Pointer to the destination string buffer. Should be large enough to hold the resulting string. Note, that the string will not be NULL-terminated, so user should do this himself, if needed.
• pszFormat: Format specifier (for example, "%16.9E").
• dfValue: Numerical value to print.
• pszLocale: Unused.

Returns

Number of characters printed.

CPLPrintInt32(char * pszBuffer,
              GInt32 iValue,
              int nMaxLen) -> int

Print GInt32 value into specified string buffer.

Parameters

• pszBuffer: Pointer to the destination string buffer. Should be large enough to hold the resulting string. Note, that the string will not be NULL-terminated, so user should do this himself, if needed.
• iValue: Numerical value to print.
• nMaxLen: Maximum length of the resulting string. If string length is greater than nMaxLen, it will be truncated.

Returns

Number of characters printed.

CPLPrintPointer(char * pszBuffer,
                void * pValue,
                int nMaxLen) -> int

Print pointer value into specified string buffer.

Parameters

• pszBuffer: Pointer to the destination string buffer. Should be large enough to hold the resulting string. Note, that the string will not be NULL-terminated, so user should do this himself, if needed.
• pValue: Pointer to ASCII encode.
• nMaxLen: Maximum length of the resulting string. If string length is greater than nMaxLen, it will be truncated.

Returns

Number of characters printed.

CPLPrintString(char * pszDest,
               const char * pszSrc,
               int nMaxLen) -> int

Copy the string pointed to by pszSrc, NOT including the terminating \0 character, to the array pointed to by pszDest.

Parameters

• pszDest: Pointer to the destination string buffer. Should be large enough to hold the resulting string.
• pszSrc: Pointer to the source buffer.
• nMaxLen: Maximum length of the resulting string. If string length is greater than nMaxLen, it will be truncated.

Returns

Number of characters printed.

CPLPrintStringFill(char * pszDest,
                   const char * pszSrc,
                   int nMaxLen) -> int

Copy the string pointed to by pszSrc, NOT including the terminating \0 character, to the array pointed to by pszDest.

Parameters

• pszDest: Pointer to the destination string buffer. Should be large enough to hold the resulting string.
• pszSrc: Pointer to the source buffer.
• nMaxLen: Maximum length of the resulting string. If string length is greater than nMaxLen, it will be truncated.

Returns

Number of characters printed.

CPLPrintTime(char * pszBuffer,
             int nMaxLen,
             const char * pszFormat,
             const struct tm * poBrokenTime,
             const char * pszLocale) -> int

Print specified time value accordingly to the format options and specified locale name.

Parameters

• pszBuffer: Pointer to the destination string buffer. Should be large enough to hold the resulting string. Note, that the string will not be NULL-terminated, so user should do this himself, if needed.
• nMaxLen: Maximum length of the resulting string. If string length is greater than nMaxLen, it will be truncated.
• pszFormat: Controls the output format. Options are the same as for strftime(3) function.
• poBrokenTime: Pointer to the broken-down time structure. May be requested with the VSIGMTime() and VSILocalTime() functions.
• pszLocale: Pointer to a character string containing locale name ("C", "POSIX", "usUS", "ruRU.KOI8-R" etc.). If NULL we will not manipulate with locale settings and current process locale will be used for printing. Be aware that it may be unsuitable to use current locale for printing time, because all names will be printed in your native language, as well as time format settings also may be adjusted differently from the C/POSIX defaults. To solve these problems this option was introduced.

Returns

Number of characters printed.

CPLPrintUIntBig(char * pszBuffer,
                GUIntBig iValue,
                int nMaxLen) -> int

Print GUIntBig value into specified string buffer.

Parameters

• pszBuffer: Pointer to the destination string buffer. Should be large enough to hold the resulting string. Note, that the string will not be NULL-terminated, so user should do this himself, if needed.
• iValue: Numerical value to print.
• nMaxLen: Maximum length of the resulting string. If string length is greater than nMaxLen, it will be truncated.

Returns

Number of characters printed.

CPLProjectRelativeFilename(const char * pszProjectDir,
                           const char * pszSecondaryFilename) -> const char *

Find a file relative to a project file.

Parameters

• pszProjectDir: the directory relative to which the secondary files path should be interpreted.
• pszSecondaryFilename: the filename (potentially with path) that is to be interpreted relative to the project directory.

Returns

a composed path to the secondary file. The returned string is internal and should not be altered, freed, or depending on past the next CPL call.

CPLPushFileFinder(CPLFileFinder pfnFinder) -> void

CPLPushFileFinder.

CPLPushFinderLocation(const char * pszLocation) -> void

CPLPushFinderLocation.

CPLReadLine(FILE * fp) -> const char *

Simplified line reading from text file.

Parameters

• fp: file pointer opened with VSIFOpen().

Returns

pointer to an internal buffer containing a line of text read from the file or NULL if the end of file was encountered.

CPLReadLine2L(VSILFILE * fp,
              int nMaxCars,
              CSLConstList papszOptions) -> const char *

Simplified line reading from text file.

Parameters

• fp: file pointer opened with VSIFOpenL().
• nMaxCars: maximum number of characters allowed, or -1 for no limit.
• papszOptions: NULL-terminated array of options. Unused for now.

Returns

pointer to an internal buffer containing a line of text read from the file or NULL if the end of file was encountered or the maximum number of characters allowed reached.

CPLReadLine3L(VSILFILE * fp,
              int nMaxCars,
              int * pnBufLength,
              CSLConstList papszOptions) -> const char *

Simplified line reading from text file.

Parameters

• fp: file pointer opened with VSIFOpenL().
• nMaxCars: maximum number of characters allowed, or -1 for no limit.
• papszOptions: NULL-terminated array of options. Unused for now.
• pnBufLength: size of output string (must be non-NULL)

Returns

pointer to an internal buffer containing a line of text read from the file or NULL if the end of file was encountered or the maximum number of characters allowed reached.

CPLReadLineL(VSILFILE * fp) -> const char *

Simplified line reading from text file.

Parameters

• fp: file pointer opened with VSIFOpenL().

Returns

pointer to an internal buffer containing a line of text read from the file or NULL if the end of file was encountered.

CPLRealloc(void * pData,
           size_t nNewSize) -> void *

Safe version of realloc().

Parameters

• pData: existing memory block which should be copied to the new block.
• nNewSize: new size (in bytes) of memory block to allocate.

Returns

pointer to allocated memory, only NULL if nNewSize is zero.

CPLReleaseLock(CPLLock * psLock) -> void

CPLReleaseMutex(CPLMutex * hMutexIn) -> void

CPLRemoveXMLChild(CPLXMLNode * psParent,
                  CPLXMLNode * psChild) -> int

Remove child node from parent.

Parameters

• psParent: the node to the child is attached to.
• psChild: the child to remove.

Returns

TRUE on success or FALSE if the child was not found.

CPLResetExtension(const char * pszPath,
                  const char * pszExt) -> const char *

Replace the extension with the provided one.

Parameters

• pszPath: the input path, this string is not altered.
• pszExt: the new extension to apply to the given path.

Returns

an altered filename with the new extension. Do not modify or free the returned string. The string may be destroyed by the next CPL call.

CPLScanDouble(const char * pszString,
              int nMaxLength) -> double

Extract double from string.

Parameters

• pszString: String containing characters to be scanned. It may be terminated with a null character.
• nMaxLength: The maximum number of character to consider as part of the number. Less characters will be considered if a null character is encountered.

Returns

Double value, converted from its ASCII form.

CPLScanLong(const char * pszString,
            int nMaxLength) -> long

Scan up to a maximum number of characters from a string and convert the result to a long.

Parameters

• pszString: String containing characters to be scanned. It may be terminated with a null character.
• nMaxLength: The maximum number of character to consider as part of the number. Less characters will be considered if a null character is encountered.

Returns

Long value, converted from its ASCII form.

CPLScanPointer(const char * pszString,
               int nMaxLength) -> void *

Extract pointer from string.

Parameters

• pszString: String containing characters to be scanned. It may be terminated with a null character.
• nMaxLength: The maximum number of character to consider as part of the number. Less characters will be considered if a null character is encountered.

Returns

pointer value, converted from its ASCII form.

CPLScanString(const char * pszString,
              int nMaxLength,
              int bTrimSpaces,
              int bNormalize) -> char *

Scan up to a maximum number of characters from a given string, allocate a buffer for a new string and fill it with scanned characters.

Parameters

• pszString: String containing characters to be scanned. It may be terminated with a null character.
• nMaxLength: The maximum number of character to read. Less characters will be read if a null character is encountered.
• bTrimSpaces: If TRUE, trim ending spaces from the input string. Character considered as empty using isspace(3) function.
• bNormalize: If TRUE, replace ':' symbol with the '_'. It is needed if resulting string will be used in CPL dictionaries.

Returns

Pointer to the resulting string buffer. Caller responsible to free this buffer with CPLFree().

CPLScanUIntBig(const char * pszString,
               int nMaxLength) -> GUIntBig

Extract big integer from string.

Parameters

• pszString: String containing characters to be scanned. It may be terminated with a null character.
• nMaxLength: The maximum number of character to consider as part of the number. Less characters will be considered if a null character is encountered.

Returns

GUIntBig value, converted from its ASCII form.

CPLScanULong(const char * pszString,
             int nMaxLength) -> unsigned long

Scan up to a maximum number of characters from a string and convert the result to a unsigned long.

Parameters

• pszString: String containing characters to be scanned. It may be terminated with a null character.
• nMaxLength: The maximum number of character to consider as part of the number. Less characters will be considered if a null character is encountered.

Returns

Unsigned long value, converted from its ASCII form.

CPLSearchXMLNode(CPLXMLNode * psRoot,
                 const char * pszElement) -> CPLXMLNode *

Search for a node in document.

Parameters

• psRoot: the subtree to search. This should be a node of type CXT_Element. NULL is safe.
• pszElement: the name of the element or attribute to search for.

Returns

The matching node or NULL on failure.

CPLSerializeXMLTree(const CPLXMLNode * psNode) -> char *

Convert tree into string document.

Parameters

• psNode: the node to serialize.

Returns

the document on success or NULL on failure.

CPLSerializeXMLTreeToFile(const CPLXMLNode * psTree,
                          const char * pszFilename) -> int

Write document tree to a file.

Parameters

• psTree: the document tree to write.
• pszFilename: the name of the file to write to.

Returns

TRUE on success, FALSE otherwise.

CPLSetConfigOption(const char * pszKey,
                   const char * pszValue) -> void

Set a configuration option for GDAL/OGR use.

Parameters

• pszKey: the key of the option
• pszValue: the value of the option, or NULL to clear a setting.

CPLSetConfigOptions(const char *const * papszConfigOptions) -> void

Replace the full list of configuration options with the passed list of KEY=VALUE pairs.

Parameters

• papszConfigOptions: the new list (or NULL).

CPLsetlocale(int category,
             const char * locale) -> char *

Prevents parallel executions of setlocale().

Parameters

• category: See your compiler's documentation on setlocale.
• locale: See your compiler's documentation on setlocale.

Returns

See your compiler's documentation on setlocale.

CPLSetThreadLocalConfigOption(const char * pszKey,
                              const char * pszValue) -> void

Set a configuration option for GDAL/OGR use.

Parameters

• pszKey: the key of the option
• pszValue: the value of the option, or NULL to clear a setting.

CPLSetThreadLocalConfigOptions(const char *const * papszConfigOptions) -> void

Replace the full list of thread local configuration options with the passed list of KEY=VALUE pairs.

Parameters

• papszConfigOptions: the new list (or NULL).

CPLSetTLS(int nIndex,
          void * pData,
          int bFreeOnExit) -> void

CPLSetTLSWithFreeFunc(int nIndex,
                      void * pData,
                      CPLTLSFreeFunc pfnFree) -> void

CPLSetTLSWithFreeFuncEx(int nIndex,
                        void * pData,
                        CPLTLSFreeFunc pfnFree,
                        int * pbMemoryErrorOccurred) -> void

CPLSetXMLValue(CPLXMLNode * psRoot,
               const char * pszPath,
               const char * pszValue) -> int

Set element value by path.

Parameters

• psRoot: the subdocument to be updated.
• pszPath: the dot separated path to the target element/attribute.
• pszValue: the text value to assign.

Returns

TRUE on success.

CPLSleep(double dfWaitInSeconds) -> void

CPLStat(const char * pszPath,
        VSIStatBuf * psStatBuf) -> int

Same as VSIStat() except it works on "C:" as if it were "C:\".

CPLStrdup(const char * pszString) -> char *

Safe version of strdup() function.

Parameters

• pszString: input string to be duplicated. May be NULL.

Returns

pointer to a newly allocated copy of the string. Free with CPLFree() or VSIFree().

CPLStringToComplex(const char * pszString,
                   double * pdfReal,
                   double * pdfImag) -> void

Fetch the real and imaginary part of a serialized complex number.

CPLStripXMLNamespace(CPLXMLNode * psRoot,
                     const char * pszNamespace,
                     int bRecurse) -> void

Strip indicated namespaces.

Parameters

• psRoot: the document to operate on.
• pszNamespace: the name space prefix (not including colon), or NULL.
• bRecurse: TRUE to recurse over whole document, or FALSE to only operate on the passed node.

CPLStrlwr(char * pszString) -> char *

Convert each characters of the string to lower case.

Parameters

• pszString: input string to be converted.

Returns

pointer to the same string, pszString.

CPLStrtod(const char * nptr,
          char ** endptr) -> double

Converts ASCII string to floating point number.

Parameters

• nptr: Pointer to string to convert.
• endptr: If is not NULL, a pointer to the character after the last character used in the conversion is stored in the location referenced by endptr.

Returns

Converted value, if any.

CPLStrtodDelim(const char * nptr,
               char ** endptr,
               char point) -> double

Converts ASCII string to floating point number using specified delimiter.

Parameters

• nptr: Pointer to string to convert.
• endptr: If is not NULL, a pointer to the character after the last character used in the conversion is stored in the location referenced by endptr.
• point: Decimal delimiter.

Returns

Converted value, if any.

CPLStrtodM(const char * nptr,
           char ** endptr) -> double

Converts ASCII string to floating point number.

Parameters

• nptr: Pointer to string to convert.
• endptr: If is not NULL, a pointer to the character after the last character used in the conversion is stored in the location referenced by endptr.

Returns

Converted value, if any.

CPLStrtof(const char * nptr,
          char ** endptr) -> float

Converts ASCII string to floating point number.

Parameters

• nptr: Pointer to string to convert.
• endptr: If is not NULL, a pointer to the character after the last character used in the conversion is stored in the location referenced by endptr.

Returns

Converted value, if any.

CPLStrtofDelim(const char * nptr,
               char ** endptr,
               char point) -> float

Converts ASCII string to floating point number using specified delimiter.

Parameters

• nptr: Pointer to string to convert.
• endptr: If is not NULL, a pointer to the character after the last character used in the conversion is stored in the location referenced by endptr.
• point: Decimal delimiter.

Returns

Converted value, if any.

CPLSubscribeToSetConfigOption(CPLSetConfigOptionSubscriber pfnCallback,
                              void * pUserData) -> int

Install a callback that will be notified of calls to CPLSetConfigOption()/ CPLSetThreadLocalConfigOption()

Parameters

• pfnCallback: Callback. Must not be NULL
• pUserData: Callback user data. May be NULL.

Returns

subscriber ID that can be used with CPLUnsubscribeToSetConfigOption()

CPLSymlink(const char * pszOldPath,
           const char * pszNewPath,
           CSLConstList) -> int

Create a symbolic link.

CPLTurnFailureIntoWarning(int bOn) -> void

Whether failures should be turned into warnings.

CPLUnlinkTree(const char * pszPath) -> int

Recursively unlink a directory.

Returns

0 on successful completion, -1 if function fails.

CPLUnlockFile(void * hLock) -> void

CPLUnsubscribeToSetConfigOption(int nId) -> void

Remove a subscriber installed with CPLSubscribeToSetConfigOption()

Parameters

• nId: Subscriber id returned by CPLSubscribeToSetConfigOption()

CPLValidateXML(const char * pszXMLFilename,
               const char * pszXSDFilename,
               CSLConstList papszOptions) -> int

Validate a XML file against a XML schema.

Parameters

• pszXMLFilename: the filename of the XML file to validate.
• pszXSDFilename: the filename of the XSD schema.
• papszOptions: unused for now. Set to NULL.

Returns

TRUE if the XML file validates against the XML schema.

cplverifyconfiguration()

Doxygen_Suppress

cplvirtualmemdeclarethread(ctxt)

Declare that a thread will access a virtual memory mapping.

This function must be called by a thread that wants to access the content of a virtual memory mapping, except if the virtual memory mapping has been created with bSingleThreadUsage = TRUE.

This function must be paired with CPLVirtualMemUnDeclareThread().

\since GDAL 1.11

Arguments

• ctxt: context returned by CPLVirtualMemNew().

cplvirtualmemderivednew(pVMemBase, nOffset, nSize, pfnFreeUserData, pCbkUserData)

Create a new virtual memory mapping derived from an other virtual memory mapping.

This may be useful in case of creating mapping for pixel interleaved data.

The new mapping takes a reference on the base mapping.

\since GDAL 1.11

Arguments

• pVMemBase: Base virtual memory mapping
• nOffset: Offset in the base virtual memory mapping from which to start the new mapping.
• nSize: Size of the base virtual memory mapping to expose in the the new mapping.
• pfnFreeUserData: callback that is called when the object is destroyed.
• pCbkUserData: user data passed to pfnFreeUserData.

Returns

a virtual memory object that must be freed by CPLVirtualMemFree(), or NULL in case of failure.

cplvirtualmemfilemapnew(fp, nOffset, nLength, eAccessMode, pfnFreeUserData, pCbkUserData)

Create a new virtual memory mapping from a file.

The file must be a "real" file recognized by the operating system, and not a VSI extended virtual file.

In VIRTUALMEM_READWRITE mode, updates to the memory mapping will be written in the file.

On Linux AMD64 platforms, the maximum value for nLength is 128 TB. On Linux x86 platforms, the maximum value for nLength is 2 GB.

Supported on Linux only in GDAL <= 2.0, and all POSIX systems supporting mmap() in GDAL >= 2.1

\since GDAL 1.11

Arguments

• fp: Virtual file handle.
• nOffset: Offset in the file to start the mapping from.
• nLength: Length of the portion of the file to map into memory.
• eAccessMode: Permission to use for the virtual memory mapping. This must be consistent with how the file has been opened.
• pfnFreeUserData: callback that is called when the object is destroyed.
• pCbkUserData: user data passed to pfnFreeUserData.

Returns

a virtual memory object that must be freed by CPLVirtualMemFree(), or NULL in case of failure.

cplvirtualmemfree(ctxt)

Free a virtual memory mapping.

The pointer returned by CPLVirtualMemGetAddr() will no longer be valid. If the virtual memory mapping was created with read/write permissions and that they are dirty (i.e. modified) pages, they will be flushed through the pfnUnCachePage callback before being freed.

\since GDAL 1.11

Arguments

• ctxt: context returned by CPLVirtualMemNew().

cplvirtualmemgetaccessmode(ctxt)

Return the access mode of the virtual memory mapping.

\since GDAL 1.11

Arguments

• ctxt: context returned by CPLVirtualMemNew().

Returns

the access mode of the virtual memory mapping.

cplvirtualmemgetaddr(ctxt)

Return the pointer to the start of a virtual memory mapping.

The bytes in the range [p:p+CPLVirtualMemGetSize()-1] where p is the pointer returned by this function will be valid, until CPLVirtualMemFree() is called.

Note that if a range of bytes used as an argument of a system call (such as read() or write()) contains pages that have not been "realized", the system call will fail with EFAULT. CPLVirtualMemPin() can be used to work around this issue.

\since GDAL 1.11

Arguments

• ctxt: context returned by CPLVirtualMemNew().

Returns

the pointer to the start of a virtual memory mapping.

cplvirtualmemgetpagesize(ctxt)

Return the page size associated to a virtual memory mapping.

The value returned will be at least CPLGetPageSize(), but potentially larger.

\since GDAL 1.11

Arguments

• ctxt: context returned by CPLVirtualMemNew().

Returns

the page size

cplvirtualmemgetsize(ctxt)

Return the size of the virtual memory mapping.

\since GDAL 1.11

Arguments

• ctxt: context returned by CPLVirtualMemNew().

Returns

the size of the virtual memory mapping.

cplvirtualmemisaccessthreadsafe(ctxt)

Return TRUE if this memory mapping can be accessed safely from concurrent threads.

The situation that can cause problems is when several threads try to access a page of the mapping that is not yet mapped.

The return value of this function depends on whether bSingleThreadUsage has been set of not in CPLVirtualMemNew() and/or the implementation.

On Linux, this will always return TRUE if bSingleThreadUsage = FALSE.

\since GDAL 1.11

Arguments

• ctxt: context returned by CPLVirtualMemNew().

Returns

TRUE if this memory mapping can be accessed safely from concurrent threads.

cplvirtualmemisfilemapping(ctxt)

Return if the virtual memory mapping is a direct file mapping.

\since GDAL 1.11

Arguments

• ctxt: context returned by CPLVirtualMemNew().

Returns

TRUE if the virtual memory mapping is a direct file mapping.

cplvirtualmemmanagerterminate()

Cleanup any resource and handlers related to virtual memory.

This function must be called after the last CPLVirtualMem object has been freed.

\since GDAL 2.0

cplvirtualmemnew(nSize, nCacheSize, nPageSizeHint, bSingleThreadUsage, eAccessMode, pfnCachePage, pfnUnCachePage, pfnFreeUserData, pCbkUserData)

Create a new virtual memory mapping.

This will reserve an area of virtual memory of size nSize, whose size might be potentially much larger than the physical memory available. Initially, no physical memory will be allocated. As soon as memory pages will be accessed, they will be allocated transparently and filled with the pfnCachePage callback. When the allowed cache size is reached, the least recently used pages will be unallocated.

On Linux AMD64 platforms, the maximum value for nSize is 128 TB. On Linux x86 platforms, the maximum value for nSize is 2 GB.

Only supported on Linux for now.

Note that on Linux, this function will install a SIGSEGV handler. The original handler will be restored by CPLVirtualMemManagerTerminate().

\since GDAL 1.11

Arguments

• nSize: size in bytes of the virtual memory mapping.
• nCacheSize: size in bytes of the maximum memory that will be really allocated (must ideally fit into RAM).
• nPageSizeHint: hint for the page size. Must be a multiple of the system page size, returned by CPLGetPageSize(). Minimum value is generally 4096. Might be set to 0 to let the function determine a default page size.
• bSingleThreadUsage: set to TRUE if there will be no concurrent threads that will access the virtual memory mapping. This can optimize performance a bit.
• eAccessMode: permission to use for the virtual memory mapping.
• pfnCachePage: callback triggered when a still unmapped page of virtual memory is accessed. The callback has the responsibility of filling the page with relevant values.
• pfnUnCachePage: callback triggered when a dirty mapped page is going to be freed (saturation of cache, or termination of the virtual memory mapping). Might be NULL.
• pfnFreeUserData: callback that can be used to free pCbkUserData. Might be NULL
• pCbkUserData: user data passed to pfnCachePage and pfnUnCachePage.

Returns

a virtual memory object that must be freed by CPLVirtualMemFree(), or NULL in case of failure.

cplvirtualmempin(ctxt, pAddr, nSize, bWriteOp)

Make sure that a region of virtual memory will be realized.

Calling this function is not required, but might be useful when debugging a process with tools like gdb or valgrind that do not naturally like segmentation fault signals.

It is also needed when wanting to provide part of virtual memory mapping to a system call such as read() or write(). If read() or write() is called on a memory region not yet realized, the call will fail with EFAULT.

\since GDAL 1.11

Arguments

• ctxt: context returned by CPLVirtualMemNew().
• pAddr: the memory region to pin.
• nSize: the size of the memory region.
• bWriteOp: set to TRUE if the memory are will be accessed in write mode.

cplvirtualmemundeclarethread(ctxt)

Declare that a thread will stop accessing a virtual memory mapping.

This function must be called by a thread that will no longer access the content of a virtual memory mapping, except if the virtual memory mapping has been created with bSingleThreadUsage = TRUE.

This function must be paired with CPLVirtualMemDeclareThread().

\since GDAL 1.11

Arguments

• ctxt: context returned by CPLVirtualMemNew().

CPLWriteFileInZip(void *,
                  const void *,
                  int) -> CPLErr

CPLXMLNodeGetRAMUsageEstimate(const CPLXMLNode * psNode,
                              bool bVisitSiblings) -> size_t

CPLZLibDeflate(const void *,
               size_t,
               int,
               void *,
               size_t,
               size_t * pnOutBytes) -> void *

CPLZLibInflate(const void *,
               size_t,
               void *,
               size_t,
               size_t * pnOutBytes) -> void *

CPLZLibInflateEx(const void * ptr,
                 size_t nBytes,
                 void * outptr,
                 size_t nOutAvailableBytes,
                 bool bAllowResizeOutptr,
                 size_t * pnOutBytes) -> void *

Uncompress a buffer compressed with ZLib compression.

Parameters

• ptr: input buffer.
• nBytes: size of input buffer in bytes.
• outptr: output buffer, or NULL to let the function allocate it.
• nOutAvailableBytes: size of output buffer if provided, or ignored.
• bAllowResizeOutptr: whether the function is allowed to grow outptr (using VSIRealloc) if its initial capacity provided by nOutAvailableBytes is not large enough. Ignored if outptr is NULL.
• pnOutBytes: pointer to a size_t, where to store the size of the output buffer.

Returns

the output buffer (to be freed with VSIFree() if not provided) or NULL in case of error. If bAllowResizeOutptr is set to true, only the returned pointer should be freed by the caller, as outptr might have been reallocated or freed.

GDAL_CG_Create(int nWidth,
               int nHeight,
               int bNoDataSet,
               double dfNoDataValue,
               double dfContourInterval,
               double dfContourBase,
               GDALContourWriter pfnWriter,
               void * pCBData) -> GDALContourGeneratorH

Create contour generator.

GDAL_CG_Destroy(GDALContourGeneratorH hCG) -> void

Destroy contour generator.

GDAL_CG_FeedLine(GDALContourGeneratorH hCG,
                 double * padfScanline) -> CPLErr

Feed a line to the contour generator.

GDALAddBand(GDALDatasetH hDataset,
            GDALDataType eType,
            CSLConstList papszOptions) -> CPLErr

Add a band to a dataset.

GDALAddDerivedBandPixelFunc(const char * pszName,
                            GDALDerivedPixelFunc pfnNewFunction) -> CPLErr

This adds a pixel function to the global list of available pixel functions for derived bands.

Parameters

• pszName: Name used to access pixel function
• pfnNewFunction: Pixel function associated with name. An existing pixel function registered with the same name will be replaced with the new one.

Returns

CE_None, invalid (NULL) parameters are currently ignored.

GDALAddDerivedBandPixelFuncWithArgs(const char * pszName,
                                    GDALDerivedPixelFuncWithArgs pfnNewFunction,
                                    const char * pszMetadata) -> CPLErr

This adds a pixel function to the global list of available pixel functions for derived bands.

Parameters

• pszName: Name used to access pixel function
• pfnNewFunction: Pixel function associated with name. An existing pixel function registered with the same name will be replaced with the new one.
• pszMetadata: Pixel function metadata (not currently implemented)

Returns

CE_None, invalid (NULL) parameters are currently ignored.

GDALAdjustValueToDataType(GDALDataType eDT,
                          double dfValue,
                          int * pbClamped,
                          int * pbRounded) -> double

Adjust a value to the output data type.

Parameters

• eDT: target data type.
• dfValue: value to adjust.
• pbClamped: pointer to a integer(boolean) to indicate if clamping has been made, or NULL
• pbRounded: pointer to a integer(boolean) to indicate if rounding has been made, or NULL

Returns

adjusted value

GDALAllRegister() -> void

Register all known configured GDAL drivers.

GDALApplyGeoTransform(const double * padfGeoTransform,
                      double dfPixel,
                      double dfLine,
                      double * pdfGeoX,
                      double * pdfGeoY) -> void

Apply GeoTransform to x/y coordinate.

Parameters

• padfGeoTransform: Six coefficient GeoTransform to apply.
• dfPixel: Input pixel position.
• dfLine: Input line position.
• pdfGeoX: output location where geo_x (easting/longitude) location is placed.
• pdfGeoY: output location where geo_y (northing/latitude) location is placed.

gdalapplyverticalshiftgrid(hSrcDataset, hGridDataset, bInverse, dfSrcUnitToMeter, dfDstUnitToMeter, papszOptions)

GDALApproxTransform(void * pCBData,
                    int bDstToSrc,
                    int nPoints,
                    double * x,
                    double * y,
                    double * z,
                    int * panSuccess) -> int

Perform approximate transformation.

GDALApproxTransformerOwnsSubtransformer(void * pCBData,
                                        int bOwnFlag) -> void

Set bOwnSubtransformer flag.

GDALARGetNextUpdatedRegion(GDALAsyncReaderH hARIO,
                           double dfTimeout,
                           int * pnBufXOff,
                           int * pnBufYOff,
                           int * pnBufXSize,
                           int * pnBufYSize) -> GDALAsyncStatusType

Get async IO update.

Parameters

• hARIO: handle to the async reader.
• dfTimeout: the number of seconds to wait for additional updates. Use -1 to wait indefinitely, or zero to not wait at all if there is no data available.
• pnBufXOff: location to return the X offset of the area of the request buffer that has been updated.
• pnBufYOff: location to return the Y offset of the area of the request buffer that has been updated.
• pnBufXSize: location to return the X size of the area of the request buffer that has been updated.
• pnBufYSize: location to return the Y size of the area of the request buffer that has been updated.

Returns

GARIO_ status, details described above.

GDALARLockBuffer(GDALAsyncReaderH hARIO,
                 double dfTimeout) -> int

Lock image buffer.

Parameters

• hARIO: handle to async reader.
• dfTimeout: the time in seconds to wait attempting to lock the buffer. -1.0 to wait indefinitely and 0 to not wait at all if it can't be acquired immediately. Default is -1.0 (infinite wait).

Returns

TRUE if successful, or FALSE on an error.

GDALARUnlockBuffer(GDALAsyncReaderH hARIO) -> void

Unlock image buffer.

Parameters

• hARIO: handle to async reader.

GDALAttributeFreeRawResult(GDALAttributeH hAttr,
                           GByte * raw,
                           size_t nSize) -> void

Free the return of GDALAttributeAsRaw()

GDALAttributeGetDataType(GDALAttributeH hAttr) -> GDALExtendedDataTypeH

Return the data type.

GDALAttributeGetDimensionCount(GDALAttributeH hAttr) -> size_t

Return the number of dimensions.

GDALAttributeGetDimensionsSize(GDALAttributeH hAttr,
                               size_t * pnCount) -> GUInt64 *

Return the dimension sizes of the attribute.

Parameters

• hAttr: Attribute.
• pnCount: Pointer to the number of values returned. Must NOT be NULL.

Returns

an array of *pnCount values.

GDALAttributeGetFullName(GDALAttributeH hAttr) -> const char *

Return the full name of the attribute.

GDALAttributeGetName(GDALAttributeH hAttr) -> const char *

Return the name of the attribute.

GDALAttributeGetTotalElementsCount(GDALAttributeH hAttr) -> GUInt64

Return the total number of values in the attribute.

GDALAttributeReadAsDouble(GDALAttributeH hAttr) -> double

Return the value of an attribute as a double.

Returns

a double value.

GDALAttributeReadAsDoubleArray(GDALAttributeH hAttr,
                               size_t * pnCount) -> double *

Return the value of an attribute as an array of doubles.

Parameters

• hAttr: Attribute
• pnCount: Pointer to the number of values returned. Must NOT be NULL.

Returns

array to be freed with CPLFree(), or nullptr.

GDALAttributeReadAsInt(GDALAttributeH hAttr) -> int

Return the value of an attribute as a integer.

Returns

a integer, or INT_MIN in case of error.

GDALAttributeReadAsIntArray(GDALAttributeH hAttr,
                            size_t * pnCount) -> int *

Return the value of an attribute as an array of integers.

Parameters

• hAttr: Attribute
• pnCount: Pointer to the number of values returned. Must NOT be NULL.

Returns

array to be freed with CPLFree(), or nullptr.

GDALAttributeReadAsRaw(GDALAttributeH hAttr,
                       size_t * pnSize) -> GByte *

Return the raw value of an attribute.

Parameters

• hAttr: Attribute.
• pnSize: Pointer to the number of bytes returned. Must NOT be NULL.

Returns

a buffer of *pnSize bytes.

GDALAttributeReadAsString(GDALAttributeH hAttr) -> const char *

Return the value of an attribute as a string.

Returns

a string, or nullptr.

GDALAttributeReadAsStringArray(GDALAttributeH hAttr) -> char **

Return the value of an attribute as an array of strings.

GDALAttributeRelease(GDALAttributeH hAttr) -> void

Release the GDAL in-memory object associated with a GDALAttribute.

GDALAttributeRename(GDALAttributeH hAttr,
                    const char * pszNewName) -> bool

Rename the attribute.

Returns

true in case of success

GDALAttributeWriteDouble(GDALAttributeH hAttr,
                         double dfVal) -> int

Write an attribute from a double value.

Parameters

• hAttr: Attribute
• dfVal: Value.

Returns

TRUE in case of success.

GDALAttributeWriteDoubleArray(GDALAttributeH hAttr,
                              const double * padfValues,
                              size_t nCount) -> int

Write an attribute from an array of double.

Parameters

• hAttr: Attribute
• padfValues: Array of double.
• nCount: Should be equal to GetTotalElementsCount().

Returns

TRUE in case of success.

GDALAttributeWriteInt(GDALAttributeH hAttr,
                      int nVal) -> int

Write an attribute from a integer value.

Parameters

• hAttr: Attribute
• nVal: Value.

Returns

TRUE in case of success.

GDALAttributeWriteRaw(GDALAttributeH hAttr,
                      const void * pabyValue,
                      size_t nLength) -> int

Write an attribute from raw values expressed in GetDataType()

Parameters

• hAttr: Attribute
• pabyValue: Buffer of nLen bytes.
• nLength: Size of pabyValue in bytes. Should be equal to GetTotalElementsCount() * GetDataType().GetSize()

Returns

TRUE in case of success.

GDALAttributeWriteString(GDALAttributeH hAttr,
                         const char * pszVal) -> int

Write an attribute from a string value.

Parameters

• hAttr: Attribute
• pszVal: Pointer to a string.

Returns

TRUE in case of success.

GDALAttributeWriteStringArray(GDALAttributeH hAttr,
                              CSLConstList papszValues) -> int

Write an attribute from an array of strings.

Parameters

• hAttr: Attribute
• papszValues: Array of strings.

Returns

TRUE in case of success.

gdalautocreatewarpedvrt(hSrcDS, pszSrcWKT, pszDstWKT, eResampleAlg, dfMaxError, psOptions)

GDALAutoCreateWarpedVRTEx(GDALDatasetH hSrcDS,
                          const char * pszSrcWKT,
                          const char * pszDstWKT,
                          GDALResampleAlg eResampleAlg,
                          double dfMaxError,
                          const GDALWarpOptions * psOptionsIn,
                          CSLConstList papszTransformerOptions) -> GDALDatasetH

Create virtual warped dataset automatically.

GDALBeginAsyncReader(GDALDatasetH hDS,
                     int nXOff,
                     int nYOff,
                     int nXSize,
                     int nYSize,
                     void * pBuf,
                     int nBufXSize,
                     int nBufYSize,
                     GDALDataType eBufType,
                     int nBandCount,
                     int * panBandMap,
                     int nPixelSpace,
                     int nLineSpace,
                     int nBandSpace,
                     CSLConstList papszOptions) -> GDALAsyncReaderH

Sets up an asynchronous data request.

Parameters

• hDS: handle to the dataset object.
• nXOff: The pixel offset to the top left corner of the region of the band to be accessed. This would be zero to start from the left side.
• nYOff: The line offset to the top left corner of the region of the band to be accessed. This would be zero to start from the top.
• nXSize: The width of the region of the band to be accessed in pixels.
• nYSize: The height of the region of the band to be accessed in lines.
• pBuf: The buffer into which the data should be read. This buffer must contain at least nBufXSize * nBufYSize * nBandCount words of type eBufType. It is organized in left to right,top to bottom pixel order. Spacing is controlled by the nPixelSpace, and nLineSpace parameters.
• nBufXSize: the width of the buffer image into which the desired region is to be read, or from which it is to be written.
• nBufYSize: the height of the buffer image into which the desired region is to be read, or from which it is to be written.
• eBufType: the type of the pixel values in the pData data buffer. The pixel values will automatically be translated to/from the GDALRasterBand data type as needed.
• nBandCount: the number of bands being read or written.
• panBandMap: the list of nBandCount band numbers being read/written. Note band numbers are 1 based. This may be NULL to select the first nBandCount bands.
• nPixelSpace: The byte offset from the start of one pixel value in pData to the start of the next pixel value within a scanline. If defaulted (0) the size of the datatype eBufType is used.
• nLineSpace: The byte offset from the start of one scanline in pData to the start of the next. If defaulted the size of the datatype eBufType * nBufXSize is used.
• nBandSpace: the byte offset from the start of one bands data to the start of the next. If defaulted (zero) the value will be nLineSpace * nBufYSize implying band sequential organization of the data buffer.
• papszOptions: Driver specific control options in a string list or NULL. Consult driver documentation for options supported.

Returns

handle representing the request.

GDALBuildOverviews(GDALDatasetH hDataset,
                   const char * pszResampling,
                   int nOverviews,
                   const int * panOverviewList,
                   int nListBands,
                   const int * panBandList,
                   GDALProgressFunc pfnProgress,
                   void * pProgressData) -> CPLErr

Build raster overview(s)

GDALBuildOverviewsEx(GDALDatasetH hDataset,
                     const char * pszResampling,
                     int nOverviews,
                     const int * panOverviewList,
                     int nListBands,
                     const int * panBandList,
                     GDALProgressFunc pfnProgress,
                     void * pProgressData,
                     CSLConstList papszOptions) -> CPLErr

Build raster overview(s)

GDALBuildVRT(const char * pszDest,
             int nSrcCount,
             GDALDatasetH * pahSrcDS,
             const char *const * papszSrcDSNames,
             const GDALBuildVRTOptions * psOptionsIn,
             int * pbUsageError) -> GDALDatasetH

Build a VRT from a list of datasets.

Parameters

• pszDest: the destination dataset path.
• nSrcCount: the number of input datasets.
• pahSrcDS: the list of input datasets (or NULL, exclusive with papszSrcDSNames). For practical purposes, the type of this argument should be considered as "const GDALDatasetH* const*", that is neither the array nor its values are mutated by this function.
• papszSrcDSNames: the list of input dataset names (or NULL, exclusive with pahSrcDS)
• psOptionsIn: the options struct returned by GDALBuildVRTOptionsNew() or NULL.
• pbUsageError: pointer to a integer output variable to store if any usage error has occurred.

Returns

the output dataset (new dataset that must be closed using GDALClose()) or NULL in case of error. If using pahSrcDS, the returned VRT dataset has a reference to each pahSrcDS[] element. Hence pahSrcDS[] elements should be closed after the returned dataset if using GDALClose(). A safer alternative is to use GDALReleaseDataset() instead of using GDALClose(), in which case you can close datasets in any order.

GDALBuildVRTOptionsFree(GDALBuildVRTOptions * psOptions) -> void

Frees the GDALBuildVRTOptions struct.

Parameters

• psOptions: the options struct for GDALBuildVRT().

GDALBuildVRTOptionsNew(char ** papszArgv,
                       GDALBuildVRTOptionsForBinary * psOptionsForBinary) -> GDALBuildVRTOptions *

Allocates a GDALBuildVRTOptions struct.

Parameters

• papszArgv: NULL terminated list of options (potentially including filename and open options too), or NULL. The accepted options are the ones of the gdalbuildvrt utility.
• psOptionsForBinary: (output) may be NULL (and should generally be NULL), otherwise (gdalbuildvrt_bin.cpp use case) must be allocated with GDALBuildVRTOptionsForBinaryNew() prior to this function. Will be filled with potentially present filename, open options,...

Returns

pointer to the allocated GDALBuildVRTOptions struct. Must be freed with GDALBuildVRTOptionsFree().

GDALBuildVRTOptionsSetProgress(GDALBuildVRTOptions * psOptions,
                               GDALProgressFunc pfnProgress,
                               void * pProgressData) -> void

Set a progress function.

Parameters

• psOptions: the options struct for GDALBuildVRT().
• pfnProgress: the progress callback.
• pProgressData: the user data for the progress callback.

GDALChecksumImage(GDALRasterBandH hBand,
                  int nXOff,
                  int nYOff,
                  int nXSize,
                  int nYSize) -> int

Compute checksum for image region.

Parameters

• hBand: the raster band to read from.
• nXOff: pixel offset of window to read.
• nYOff: line offset of window to read.
• nXSize: pixel size of window to read.
• nYSize: line size of window to read.

Returns

Checksum value, or -1 in case of error (starting with GDAL 3.6)

gdalcheckversion(nVersionMajor, nVersionMinor, pszCallingComponentName)

Return TRUE if GDAL library version at runtime matches nVersionMajor.nVersionMinor.

The purpose of this method is to ensure that calling code will run with the GDAL version it is compiled for. It is primarily indented for external plugins.

Arguments

• nVersionMajor: Major version to be tested against
• nVersionMinor: Minor version to be tested against
• pszCallingComponentName: If not NULL, in case of version mismatch, the method will issue a failure mentioning the name of the calling component.

GDALChunkAndWarpImage(GDALWarpOperationH hOperation,
                      int nDstXOff,
                      int nDstYOff,
                      int nDstXSize,
                      int nDstYSize) -> CPLErr

GDALChunkAndWarpMulti(GDALWarpOperationH hOperation,
                      int nDstXOff,
                      int nDstYOff,
                      int nDstXSize,
                      int nDstYSize) -> CPLErr

GDALCloneColorTable(GDALColorTableH hTable) -> GDALColorTableH

Make a copy of a color table.

GDALCloneWarpOptions(const GDALWarpOptions * psSrcOptions) -> GDALWarpOptions *

Clone a warp options structure.

GDALClose(GDALDatasetH hDS) -> CPLErr

Close GDAL dataset.

Parameters

• hDS: The dataset to close. May be cast from a "GDALDataset *".

Returns

CENone in case of success (return value since GDAL 3.7). On a shared dataset whose reference count is not dropped below 1, CENone will be returned.

GDALComposeGeoTransforms(const double * padfGT1,
                         const double * padfGT2,
                         double * padfGTOut) -> void

Compose two geotransforms.

Parameters

• padfGT1: the first geotransform, six values.
• padfGT2: the second geotransform, six values.
• padfGTOut: the output geotransform, six values, may safely be the same array as padfGT1 or padfGT2.

GDALComputeBandStats(GDALRasterBandH hSrcBand,
                     int nSampleStep,
                     double * pdfMean,
                     double * pdfStdDev,
                     GDALProgressFunc pfnProgress,
                     void * pProgressData) -> CPLErr

Undocumented.

Parameters

• hSrcBand: undocumented.
• nSampleStep: Step between scanlines used to compute statistics. When nSampleStep is equal to 1, all scanlines will be processed.
• pdfMean: undocumented.
• pdfStdDev: undocumented.
• pfnProgress: undocumented.
• pProgressData: undocumented.

Returns

undocumented

GDALComputeMatchingPoints(GDALDatasetH hFirstImage,
                          GDALDatasetH hSecondImage,
                          char ** papszOptions,
                          int * pnGCPCount) -> GDAL_GCP *

GDALComputeMatchingPoints.

GDALComputeMedianCutPCT(GDALRasterBandH hRed,
                        GDALRasterBandH hGreen,
                        GDALRasterBandH hBlue,
                        int(*)(int, int, void *) pfnIncludePixel,
                        int nColors,
                        GDALColorTableH hColorTable,
                        GDALProgressFunc pfnProgress,
                        void * pProgressArg) -> int

Compute optimal PCT for RGB image.

Parameters

• hRed: Red input band.
• hGreen: Green input band.
• hBlue: Blue input band.
• pfnIncludePixel: function used to test which pixels should be included in the analysis. At this time this argument is ignored and all pixels are utilized. This should normally be NULL.
• nColors: the desired number of colors to be returned (2-256).
• hColorTable: the colors will be returned in this color table object.
• pfnProgress: callback for reporting algorithm progress matching the GDALProgressFunc() semantics. May be NULL.
• pProgressArg: callback argument passed to pfnProgress.

Returns

returns CENone on success or CEFailure if an error occurs.

GDALComputeProximity(GDALRasterBandH hSrcBand,
                     GDALRasterBandH hProximityBand,
                     char ** papszOptions,
                     GDALProgressFunc pfnProgress,
                     void * pProgressArg) -> CPLErr

Compute the proximity of all pixels in the image to a set of pixels in the source image.

GDALComputeRasterMinMax(GDALRasterBandH hBand,
                        int bApproxOK,
                        double adfMinMax) -> CPLErr

Compute the min/max values for a band.

GDALComputeRasterStatistics(GDALRasterBandH hBand,
                            int bApproxOK,
                            double * pdfMin,
                            double * pdfMax,
                            double * pdfMean,
                            double * pdfStdDev,
                            GDALProgressFunc pfnProgress,
                            void * pProgressData) -> CPLErr

Compute image statistics.

gdalcontourgenerate(hBand, dfContourInterval, dfContourBase, nFixedLevelCount, padfFixedLevels, bUseNoData, dfNoDataValue, hLayer, iIDField, iElevField, pfnProgress, pProgressArg)

GDALContourGenerateEx(GDALRasterBandH hBand,
                      void * hLayer,
                      CSLConstList options,
                      GDALProgressFunc pfnProgress,
                      void * pProgressArg) -> CPLErr

Create vector contours from raster DEM.

Parameters

• hBand: The band to read raster data from. The whole band will be processed.
• hLayer: The layer to which new contour vectors will be written. Each contour will have a LINESTRING geometry attached to it (or POLYGON if POLYGONIZE=YES). This is really of type OGRLayerH, but void * is used to avoid pulling the ogr_api.h file in here.
• pfnProgress: A GDALProgressFunc that may be used to report progress to the user, or to interrupt the algorithm. May be NULL if not required.
• pProgressArg: The callback data for the pfnProgress function.
• options: List of options

Returns

CENone on success or CEFailure if an error occurs.

GDALCopyBits(const GByte * pabySrcData,
             int nSrcOffset,
             int nSrcStep,
             GByte * pabyDstData,
             int nDstOffset,
             int nDstStep,
             int nBitCount,
             int nStepCount) -> void

Bitwise word copying.

Parameters

• pabySrcData: the source data buffer.
• nSrcOffset: the offset (in bits) in pabySrcData to the start of the first word to copy.
• nSrcStep: the offset in bits from the start one source word to the start of the next.
• pabyDstData: the destination data buffer.
• nDstOffset: the offset (in bits) in pabyDstData to the start of the first word to copy over.
• nDstStep: the offset in bits from the start one word to the start of the next.
• nBitCount: the number of bits in a word to be copied.
• nStepCount: the number of words to copy.

GDALCopyDatasetFiles(GDALDriverH hDriver,
                     const char * pszNewName,
                     const char * pszOldName) -> CPLErr

Copy the files of a dataset.

GDALCopyWords(const void * pSrcData,
              GDALDataType eSrcType,
              int nSrcPixelStride,
              void * pDstData,
              GDALDataType eDstType,
              int nDstPixelStride,
              int nWordCount) -> void

Copy pixel words from buffer to buffer.

GDALCopyWords64(const void * pSrcData,
                GDALDataType eSrcType,
                int nSrcPixelStride,
                void * pDstData,
                GDALDataType eDstType,
                int nDstPixelStride,
                GPtrDiff_t nWordCount) -> void

Copy pixel words from buffer to buffer.

Parameters

• pSrcData: Pointer to source data to be converted.
• eSrcType: the source data type (see GDALDataType enum)
• nSrcPixelStride: Source pixel stride (i.e. distance between 2 words), in bytes
• pDstData: Pointer to buffer where destination data should go
• eDstType: the destination data type (see GDALDataType enum)
• nDstPixelStride: Destination pixel stride (i.e. distance between 2 words), in bytes
• nWordCount: number of words to be copied

GDALCreate(GDALDriverH hDriver,
           const char * pszFilename,
           int nXSize,
           int nYSize,
           int nBands,
           GDALDataType eBandType,
           CSLConstList papszOptions) -> GDALDatasetH

Create a new dataset with this driver.

GDALCreateAndReprojectImage(GDALDatasetH hSrcDS,
                            const char * pszSrcWKT,
                            const char * pszDstFilename,
                            const char * pszDstWKT,
                            GDALDriverH hDstDriver,
                            char ** papszCreateOptions,
                            GDALResampleAlg eResampleAlg,
                            double dfWarpMemoryLimit,
                            double dfMaxError,
                            GDALProgressFunc pfnProgress,
                            void * pProgressArg,
                            GDALWarpOptions * psOptions) -> CPLErr

Reproject an image and create the target reprojected image.

GDALCreateApproxTransformer(GDALTransformerFunc pfnBaseTransformer,
                            void * pBaseTransformArg,
                            double dfMaxError) -> void *

Create an approximating transformer.

Parameters

• pfnBaseTransformer: the high precision transformer which should be approximated.
• pBaseTransformArg: the callback argument for the high precision transformer.
• dfMaxError: the maximum cartesian error in the "output" space that is to be accepted in the linear approximation.

Returns

callback pointer suitable for use with GDALApproxTransform(). It should be deallocated with GDALDestroyApproxTransformer().

GDALCreateColorRamp(GDALColorTableH hTable,
                    int nStartIndex,
                    const GDALColorEntry * psStartColor,
                    int nEndIndex,
                    const GDALColorEntry * psEndColor) -> void

Create color ramp.

GDALCreateColorTable(GDALPaletteInterp eInterp) -> GDALColorTableH

Construct a new color table.

GDALCreateCopy(GDALDriverH hDriver,
               const char * pszFilename,
               GDALDatasetH hSrcDS,
               int bStrict,
               CSLConstList papszOptions,
               GDALProgressFunc pfnProgress,
               void * pProgressData) -> GDALDatasetH

Create a copy of a dataset.

GDALCreateDatasetMaskBand(GDALDatasetH hDS,
                          int nFlags) -> CPLErr

Adds a mask band to the dataset.

GDALCreateDriver() -> GDALDriverH

Create a GDALDriver.

GDALCreateGCPRefineTransformer(int nGCPCount,
                               const GDAL_GCP * pasGCPList,
                               int nReqOrder,
                               int bReversed,
                               double dfTolerance,
                               int nMinimumGcps) -> void *

Create GCP based polynomial transformer, with a tolerance threshold to discard GCPs that transform badly.

GDALCreateGCPTransformer(int nGCPCount,
                         const GDAL_GCP * pasGCPList,
                         int nReqOrder,
                         int bReversed) -> void *

Create GCP based polynomial transformer.

Parameters

• nGCPCount: the number of GCPs in pasGCPList.
• pasGCPList: an array of GCPs to be used as input.
• nReqOrder: the requested polynomial order. It should be 1, 2 or 3. Using 3 is not recommended due to potential numeric instabilities issues.
• bReversed: set it to TRUE to compute the reversed transformation.

Returns

the transform argument or nullptr if creation fails.

gdalcreategenimgprojtransformer(hSrcDS, pszSrcWKT, hDstDS, pszDstWKT, bGCPUseOK, dfGCPErrorThreshold, nOrder)

GDALCreateGenImgProjTransformer2(GDALDatasetH hSrcDS,
                                 GDALDatasetH hDstDS,
                                 char ** papszOptions) -> void *

Create image to image transformer.

Parameters

• hSrcDS: source dataset, or NULL.
• hDstDS: destination dataset (or NULL).
• papszOptions: NULL-terminated list of string options (or NULL).

Returns

handle suitable for use GDALGenImgProjTransform(), and to be deallocated with GDALDestroyGenImgProjTransformer() or NULL on failure.

GDALCreateGenImgProjTransformer3(const char * pszSrcWKT,
                                 const double * padfSrcGeoTransform,
                                 const char * pszDstWKT,
                                 const double * padfDstGeoTransform) -> void *

Create image to image transformer.

Parameters

• pszSrcWKT: source WKT (or NULL).
• padfSrcGeoTransform: source geotransform (or NULL).
• pszDstWKT: destination WKT (or NULL).
• padfDstGeoTransform: destination geotransform (or NULL).

Returns

handle suitable for use GDALGenImgProjTransform(), and to be deallocated with GDALDestroyGenImgProjTransformer() or NULL on failure.

GDALCreateGenImgProjTransformer4(OGRSpatialReferenceH hSrcSRS,
                                 const double * padfSrcGeoTransform,
                                 OGRSpatialReferenceH hDstSRS,
                                 const double * padfDstGeoTransform,
                                 const char *const * papszOptions) -> void *

Create image to image transformer.

GDALCreateGeoLocTransformer(GDALDatasetH hBaseDS,
                            char ** papszGeolocationInfo,
                            int bReversed) -> void *

Create GeoLocation transformer.

GDALCreateMaskBand(GDALRasterBandH hBand,
                   int nFlags) -> CPLErr

Adds a mask band to the current band.

GDALCreateMultiDimensional(GDALDriverH hDriver,
                           const char * pszName,
                           CSLConstList papszRootGroupOptions,
                           CSLConstList papszOptions) -> GDALDatasetH

Create a new multidimensional dataset with this driver.

GDALCreatePansharpenedVRT(const char * pszXML,
                          GDALRasterBandH hPanchroBand,
                          int nInputSpectralBands,
                          GDALRasterBandH * pahInputSpectralBands) -> GDALDatasetH

Create a virtual pansharpened dataset.

Parameters

• pszXML: Pansharpened VRT XML where <SpectralBand> elements have no explicit SourceFilename and SourceBand. The spectral bands in the XML will be assigned the successive values of the pahInputSpectralBands array. Must not be NULL.
• hPanchroBand: Panchromatic band. Must not be NULL.
• nInputSpectralBands: Number of input spectral bands. Must be greater than zero.
• pahInputSpectralBands: Array of nInputSpectralBands spectral bands.

Returns

NULL on failure, or a new virtual dataset handle on success to be closed with GDALClose().

GDALCreateRasterAttributeTable() -> GDALRasterAttributeTableH

Construct empty table.

GDALCreateRasterAttributeTableFromMDArrays(GDALRATTableType eTableType,
                                           const std::vector< std::shared_ptr< GDALMDArray > > & apoArrays,
                                           const std::vector< GDALRATFieldUsage > & aeUsages) -> GDALRasterAttributeTable *

Return a virtual Raster Attribute Table from several GDALMDArray's.

Parameters

• eTableType: RAT table type
• apoArrays: Vector of GDALMDArray's (none of them should be nullptr)
• aeUsages: Vector of GDALRATFieldUsage (of the same size as apoArrays if non-empty), or empty vector to use defaults

Returns

a new Raster Attribute Table to free with delete, or nullptr in case of error

GDALCreateReprojectionTransformer(const char * pszSrcWKT,
                                  const char * pszDstWKT) -> void *

Create reprojection transformer.

Parameters

• pszSrcWKT: the coordinate system for the source coordinate system.
• pszDstWKT: the coordinate system for the destination coordinate system.

Returns

Handle for use with GDALReprojectionTransform(), or NULL if the system fails to initialize the reprojection.

GDALCreateReprojectionTransformerEx(OGRSpatialReferenceH hSrcSRS,
                                    OGRSpatialReferenceH hDstSRS,
                                    const char *const * papszOptions) -> void *

Create reprojection transformer.

Parameters

• hSrcSRS: the coordinate system for the source coordinate system.
• hDstSRS: the coordinate system for the destination coordinate system.
• papszOptions: NULL-terminated list of options, or NULL. Currently supported options are:

AREAOFINTEREST=westlong,southlat,eastlong,northlat: Values in degrees. longitudes in [-180,180], latitudes in [-90,90].

COORDINATE_OPERATION=string: PROJ or WKT string representing a coordinate operation, overriding the default computed transformation.

COORDINATEEPOCH=decimalyear: Coordinate epoch, expressed as a decimal year. Useful for time-dependant coordinate operations.

SRCCOORDINATEEPOCH: (GDAL >= 3.4) Coordinate epoch of source CRS, expressed as a decimal year. Useful for time-dependant coordinate operations.