Basic, atomic types

Typedefs
typedef signed char	SDK_INT1
typedef unsigned char	SDK_UINT1
typedef signed short	SDK_INT2
typedef unsigned short	SDK_UINT2
typedef signed int	SDK_INT4
typedef unsigned int	SDK_UINT4
typedef signed long long	SDK_INT8
typedef unsigned long long	SDK_UINT8
typedef float	SDK_FLOAT
typedef double	SDK_DOUBLE
typedef SDK_INT4	SDK_USER_PARAM
typedef wchar_t	SDK_WCHAR_T
typedef char	SDK_CHAR_T
typedef const void *	SDK_BINDATAPTR
typedef SDK_INT4(SDK_API *	SDK_ProgressCBFuncT )(SDK_INT4 current, SDK_INT4 total, SDK_INT4 job)
typedef const SDK_WCHAR_T *(SDK_API *	SDK_StringCBFuncT )(SDK_INT4 id)
typedef SDK_INT4(SDK_API *	SDK_TrafficProgressCBFuncT )(SDK_INT4 current, SDK_INT4 total, SDK_INT4 job, SDK_ERROR error)

Detailed Description

Atomic types, i.e. the basic types which need to be mapped for each language binding/development environment.

Typedef Documentation

typedef signed char SDK_INT1

SDK_INT1 1-byte signed integer

typedef unsigned char SDK_UINT1

2-byte unsigned integer

typedef signed short SDK_INT2

2-byte signed integer

typedef unsigned short SDK_UINT2

2-byte unsigned integer

typedef signed int SDK_INT4

4-byte signed integer

typedef unsigned int SDK_UINT4

4-byte unsigned integer

typedef signed long long SDK_INT8

8-byte signed integer

typedef unsigned long long SDK_UINT8

8-byte unsigned integer

typedef float SDK_FLOAT

4-byte signed floating point number

typedef double SDK_DOUBLE

8-byte signed floating point number

typedef wchar_t SDK_WCHAR_T

Basic string type (Windows Unicode version). On Windows using Visual Studio 6 (VS6) this wchar_t is actually of type "unsigned short", i.e. an integral type which size is two bytes. Starting with VS7/.net 2003 there is an option to use a built-in type for this. As from the object code the difference shouldn't matter given that the clients themselves use consistent settings.

typedef char SDK_CHAR_T

Basic string. Used only for few APIs where a wide string would be uncomfortable to use.

typedef const void* SDK_BINDATAPTR

Generic pointer type. context sensitive. It is unlikely that the NavigationSDK will ever export void* data, so that type got already implicit [in] and "const" semantics.

typedef SDK_INT4(SDK_API * SDK_ProgressCBFuncT)(SDK_INT4 current, SDK_INT4 total, SDK_INT4 job)

Generic signature of progress Event/callback routines If it is non-trivial maybe for another language except C/C++ to define callbacks one may use an equivalent pointer type to represent a NULL-pointer.

Parameters

[in]	current	Current step
[in]	total	Total number of steps
[in]	job	Reserved for future implementations

Returns

Has to return 0 if process should be cancelled, 1 to continue. Other values are reserved for future purposes and should not be used unless documented somewhere!

typedef const SDK_WCHAR_T*(SDK_API * SDK_StringCBFuncT)(SDK_INT4 id)

Generic signature of the maneuver generator string retriever callback This function is called by the maneuver generator to get a localized string for the current needed string id and has to be implemented by the user. The maneuver generator uses internally string IDs to be independent from localization and grammar. The generator reads the grammar and the sentence portions with this callback, giving a string ID as parameter, so the callee can determine which string should be returned. The returned string will be internally copied after the function was called. For details of the mapping of string IDs to maneuver types, see the examples and Maneuver generator constants.

Parameters

[in]

current

ID of the needed string

Returns

the decoded string

typedef SDK_INT4(SDK_API * SDK_TrafficProgressCBFuncT)(SDK_INT4 current, SDK_INT4 total, SDK_INT4 job, SDK_ERROR error)

Generic signature of the traffic progress event/callback routines This function is called by the traffic fetching routines to signal the progress and the type of fetch

Parameters

[in]	current	Current step
[in]	total	Total number of steps
[in]	job	The type of fetch
[in]	error	The error value

Returns

Has to return 0 if process should be cancelled, 1 to continue.