CartoType iOS API 8.10-3-g0075538f6
for development in Swift and Objective C for iOS and Mac OS
Typedefs | Enumerations
CartoTypeResultCode.h File Reference

Go to the source code of this file.

Typedefs

typedef enum CartoTypeResultCode CartoTypeResultCode
 
typedef uint32_t CTResult
 

Enumerations

enum  CartoTypeResultCode {
  CTErrorNone = 0 , CTErrorGeneral = 1 , CTErrorNoMemory = 2 , CTErrorEndOfData = 3 ,
  CTErrorTextUnmodifiable = 4 , CTErrorTextTruncated = 5 , CTErrorNotFound = 6 , CTErrorUnimplemented = 7 ,
  CTErrorInvalidOutline = 8 , CTErrorIo = 9 , CTErrorCorrupt = 10 , CTErrorUnknownDataFormat = 11 ,
  CTErrorNoInverse = 12 , CTErrorProjectionOverflow = 13 , CTErrorCancel = 14 , CTErrorInvalidArgument = 15 ,
  CTErrorUnknownVersion = 16 , CTErrorOverflow = 17 , CTErrorParallelLines = 19 , CTErrorNoPalette = 22 ,
  CTErrorDuplicate = 23 , CTErrorNoProjection = 24 , CTErrorPaletteFull = 25 , CTErrorInvalidDashArray = 26 ,
  CTErrorCentralPath = 27 , CTErrorNoRoute = 28 , CTErrorZoomLimitReached = 29 , CTErrorAlreadyProjected = 30 ,
  CTErrorConditionsTooDeeplyNested = 31 , CTErrorNullFont = 32 , CTErrorInternetIo = 33 , CTErrorDivideByZero = 34 ,
  CTErrorTransformFailed = 35 , CTErrorPngRead = 36 , CTErrorJpgRead = 37 , CTErrorNoIntersection = 38 ,
  CTErrorInterrupt = 39 , CTErrorMapDataBaseFormatMismatch = 40 , CTErrorEncryptionKeyTooShort = 41 , CTErrorNoEncryptionKey = 42 ,
  CTErrorEmergencyMessage = 43 , CTErrorAlertMessage = 44 , CTErrorCriticalMessage = 45 , CTErrorErrorMessage = 46 ,
  CTErrorWarningMessage = 47 , CTErrorNoticeMessage = 48 , CTErrorInfoMessage = 49 , CTErrorDebugMessage = 50 ,
  CTErrorNotNavigating = 51 , CTErrorNoFramework = 52 , CTErrorFrameworkAlreadyExists = 53 , CTErrorUntransliterable = 54 ,
  CTErrorPngWrite = 55 , CTErrorReadOnlyMapDataBase = 56 , CTErrorProj4 = 57 , CTErrorNoRoadsNearStartOfRoute = 59 ,
  CTErrorNoRoadsNearEndOfRoute = 60 , CTErrorNoRouteConnectivity = 61 , CTErrorXmlFeatureNotSupported = 62 , CTErrorMapNotFound = 63 ,
  CTErrorFontNotFound = 64 , CTErrorStyleSheetNotFound = 65 , CTErrorFeatureInfoIsNotRoute = 66 , CTErrorFeatureInfoIsRoute = 67 ,
  CTErrorNoRouteData = 68 , CTErrorTooManyFontsInStyleSheet = 69 , CTErrorTooManyBoxStylesInStyleSheet = 70 , CTErrorNoRoad = 71 ,
  CTStandardErrorCodeCount = 72 , CTErrorXmlRangeStart = 0x10000000 , CTErrorXmlRangeEnd = 0x2AFFFFFF , CTErrorSQLite = 0x30000000
}
 

Detailed Description

CartoType result codes and the result type.

Typedef Documentation

◆ CartoTypeResultCode

CartoType result codes. CartoType functions actually return integers typed as CTResult, which may be compared with these values.

◆ CTResult

typedef uint32_t CTResult

A result code typed as an integer.

Enumeration Type Documentation

◆ CartoTypeResultCode

CartoType result codes. CartoType functions actually return integers typed as CTResult, which may be compared with these values.

Enumerator
CTErrorNone 

No error, a successful result.

CTErrorGeneral 

CTErrorGeneral is used where an error has occurred but no other CartoType error is applicable. For example, this error code can be used when FreeType returns an error code for illegal TrueType hinting instructions.

CTErrorNoMemory 

Use CTErrorNoMemory when an attempted memory allocation fails.

CTErrorEndOfData 

CTErrorEndOfData is returned by iterators and streams when no more data is available. It may be treated as an error or not depending on the circumstances.

CTErrorTextUnmodifiable 

CTErrorTextUnmodifiable is returned when an attempt is made to modify an unmodifiable string.

CTErrorTextTruncated 

CTErrorTextTruncated is returned when text inserted into a string is too long for a fixed-size buffer.

CTErrorNotFound 

CTErrorNotFound is returned whenever a resource like a file is not found, or a search fails. It may be treated as an error or not depending on the circumstances.

CTErrorUnimplemented 

The code CTErrorUnimplemented is used for functions that have not yet been implemented, or for circumstances or options within functions that remain unimplemented because they are deemed to be either rarely or never useful.

CTErrorInvalidOutline 

If the graphics system detects an invalid outline, such as one that starts with a cubic control point, it returns CTErrorInvalidOutline.

CTErrorIo 

The code CTErrorIo should be used for unexpected read or write errors on files or other data streams. This is for where you attempt to read data that should be there, but the OS says it's unavailable (e.g., someone has taken the CD out of the drive or the network is down).

CTErrorCorrupt 

CTErrorCorrupt is returned when illegal values are found when reading data from a file or other serialized form.

CTErrorUnknownDataFormat 

This error is returned by database accessors, typeface accessors, etc., to indicate that this data format is unknown to a particular accessor. It is not really an error but tells the caller to try the next accessor in the list.

CTErrorNoInverse 

This error is returned by transformation inversion if the transformation has no inverse.

CTErrorProjectionOverflow 

This error is returned by the projection system if the projection causes overflow.

CTErrorCancel 

The code CTErrorCancel is returned to cancel an asynchronous operation that uses callbacks. The callback or virtual function returns this code. the caller must terminate further processing on receipt of any error, but this one indicates that there has been no actual error, but the handler has canceled the operation.

CTErrorInvalidArgument 

This error is returned when an invalid argument has been given to a function.

CTErrorUnknownVersion 

This error is returned by a data reader when it can not deal with the data version.

CTErrorOverflow 

This error is returned by the base library when reading data or calculations result in overflow.

CTErrorParallelLines 

The error code returned by line intersection algorithms when the lines are parallel.

CTErrorNoPalette 

An attempt was made to draw a bitmap needing a color palette but no palette was provided.

CTErrorDuplicate 

An attempt was made to insert a duplicate object into a collection class that does not allow duplicates.

CTErrorNoProjection 

The projection for converting latitude and longitude to map coordinates is unknown or unavailable.

CTErrorPaletteFull 

A palette is full and no new entries can be added.

CTErrorInvalidDashArray 

The dash array for drawing strokes is invalid.

CTErrorCentralPath 

The central-path system failed to create a usable path.

CTErrorNoRoute 

A route was needed by the navigation system but no route was available.

CTErrorZoomLimitReached 

There was an attempt to zoom beyond the legal zoom limits for a map.

CTErrorAlreadyProjected 

There was an attempt to project a map object that had already been projected.

CTErrorConditionsTooDeeplyNested 

Conditions are too deeply nested in the style sheet.

CTErrorNullFont 

There was an attempt to use a null font for drawing text.

CTErrorInternetIo 

An attempt to read data from the internet failed.

CTErrorDivideByZero 

Division by zero in an interpreted expression.

CTErrorTransformFailed 

A transform failed because an argument or result was out of range.

CTErrorPngRead 

Reading a bitmap from PNG format failed.

CTErrorJpgRead 

Reading a bitmap from JPG format failed.

CTErrorNoIntersection 

An object did not intersect a specified region.

CTErrorInterrupt 

An operation was interrupted, for example by another thread writing to a shared flag.

CTErrorMapDataBaseFormatMismatch 

There was an attempt to use map databases of incompatible point format, datum or axis orientations to draw a map or find objects in a map.

CTErrorEncryptionKeyTooShort 

A key supplied for encryption was too short.

CTErrorNoEncryptionKey 

No encryption key has been set.

CTErrorEmergencyMessage 

A code for standard emergency messages.

CTErrorAlertMessage 

A code for standard alert messages.

CTErrorCriticalMessage 

A code for standard critical messages.

CTErrorErrorMessage 

A code for standard error messages.

CTErrorWarningMessage 

A code for standard warning messages.

CTErrorNoticeMessage 

A code for standard notice messages.

CTErrorInfoMessage 

A code for standard information messages.

CTErrorDebugMessage 

A code for standard debug messages.

CTErrorNotNavigating 

A function has been called which is available only when navigating.

CTErrorNoFramework 

The global framework object does not exist.

CTErrorFrameworkAlreadyExists 

The global framework object already exists.

CTErrorUntransliterable 

A string was not transliterable.

CTErrorPngWrite 

Writing a bitmap to PNG format failed.

CTErrorReadOnlyMapDataBase 

There was an attempt to write to a read-only map database.

CTErrorProj4 

There was an error in the PROJ.4 projection library error other than a projection overflow.

CTErrorNoRoadsNearStartOfRoute 

No route could be created because there were no roads near the start point of a route section.

CTErrorNoRoadsNearEndOfRoute 

No route could be created because there were no roads near the end point of a route section.

CTErrorNoRouteConnectivity 

No route could be created because the start and end point were not connected.

CTErrorXmlFeatureNotSupported 

An unsupported feature was requested from the XML parser.

CTErrorMapNotFound 

A map file was not found.

CTErrorFontNotFound 

A font file was not found.

CTErrorStyleSheetNotFound 

A style sheet was not found.

CTErrorFeatureInfoIsNotRoute 

An attempt was made to set a route attribute on a feature info object that is not a route.

CTErrorFeatureInfoIsRoute 

An attempt was made to set a non-route attribute on a feature info object that is a route.

CTErrorNoRouteData 

No route data is available.

CTErrorTooManyFontsInStyleSheet 

Too many fonts are used in a style sheet.

CTErrorTooManyBoxStylesInStyleSheet 

Too many box styles are used in a style sheet.

CTErrorNoRoad 

No road or other routable segment was found near one or more route points when calculating a route.

CTStandardErrorCodeCount 

The number of standard error codes.

CTErrorXmlRangeStart 

The start of the range of errors in XML parsing or in the style sheet format, such as a syntactically incorrect dimension or color. The top byte is 0x10 for style sheet errors, or in the range 0x11 to 0x2A for Expat XML parser error codes.

The low three bytes give the error location: one byte for the column number (clamped to 0...255) two bytes for the line number (clamped to 0...65535).

CTErrorXmlRangeEnd 

The end of the range of errors in XML parsing or in the style sheet format.

CTErrorSQLite 

The base of error codes for returning SQLite errors. The SQLite error code is placed in the lower two bytes.