Miscellaneous Functions

Functions
SDK_ERROR SDK_API	SDK_TransformCoordinates (SDK_INT4 MapView, SDK_INT4 SourceFormat, SDK_INT4 SourceX, SDK_INT4 SourceY, SDK_INT4 DestinationFormat, SDK_INT4 *pDestinationX, SDK_INT4 *pDestinationY)
SDK_ERROR SDK_API	SDK_TransformCountryCodeToPtvCode (SDK_INT4 SourceFormat, const SDK_WCHAR_T *cc, SDK_UINT2 *ptvCode)
SDK_ERROR SDK_API	SDK_TransformPtvCodeToCountryCode (SDK_INT4 DestinationFormat, SDK_UINT2 ptvCode, const SDK_WCHAR_T **cc)
SDK_ERROR SDK_API	SDK_GetErrorDescription (SDK_INT4 ErrCode, SDK_WCHAR_T const **ppDesc)
SDK_ERROR SDK_API	SDK_FreeString (SDK_WCHAR_T *pString)
SDK_USER_PARAM SDK_API	SDK_GetUserParam (SDK_INT4 param, SDK_INT4 *pParam1, SDK_INT4 *pParam2, SDK_INT4 *pParam3, SDK_INT4 *pParam4)
SDK_USER_PARAM SDK_API	SDK_SetUserParam (SDK_INT4 param, SDK_USER_PARAM param1, SDK_USER_PARAM param2, SDK_USER_PARAM param3, SDK_USER_PARAM param4)

Detailed Description

Misc Functions.

Function Documentation

SDK_ERROR SDK_API SDK_TransformCoordinates	(	SDK_INT4	MapView,
		SDK_INT4	SourceFormat,
		SDK_INT4	SourceX,
		SDK_INT4	SourceY,
		SDK_INT4	DestinationFormat,
		SDK_INT4 *	pDestinationX,
		SDK_INT4 *	pDestinationY
	)

Transforms coordinates from source format to the specified destination format.

Parameters

[in]	MapView	Map view where the tranformation takes place. This argument is ignored until a mapview is required for the conversion. So in case no mapview/mapdc was created, just use -1.
[in]	SourceFormat	The enum value of the source format (see Coordinate formats). This can be a pixel value of the actual Mapview or specific coordinates (geodecimal, mercator).
[in]	SourceX	X coordinate to transform.
[in]	SourceY	Y coordinate to transform.
[in]	DestinationFormat	The enum value of the destination format of the transformation.
[out]	pDestinationX	Pointer to the X destination variable.
[out]	pDestinationY	Pointer to the Y destination variable.

Returns

Error code (Errorcodes). SDK_ERROR_NoMap may be returned to indicate an internal error here. Please report this error! SDK_ERROR_MapOutOfSync is returned if the map view was changed since the last repaint and the request was referring to pixel coordinates. Since the transformation data is specific to a single map rendering status those results are most likely incorrect.

SDK_ERROR SDK_API SDK_TransformCountryCodeToPtvCode	(	SDK_INT4	SourceFormat,
		const SDK_WCHAR_T *	cc,
		SDK_UINT2 *	ptvCode
	)

Convert given country code in a PTV-countrycode.

Parameters

[in]	cc	country code
[out]	ptvCode	numerical ptv country code

Returns

Error code (Errorcodes).

SDK_ERROR SDK_API SDK_TransformPtvCodeToCountryCode	(	SDK_INT4	DestinationFormat,
		SDK_UINT2	ptvCode,
		const SDK_WCHAR_T **	cc
	)

Convert a PTV-countrycode into given country code.

Parameters

[in]	ptvCode	numerical ptv country code
[out]	cc	country code, or "" if it can't be converted or NULL if the entry is not available in that encoding

Returns

Error code (Errorcodes).

SDK_ERROR SDK_API SDK_GetErrorDescription	(	SDK_INT4	ErrCode,
		SDK_WCHAR_T const **	ppDesc
	)

Return description to a given error code.

Currently it just returns the name of the error code.

Parameters

[in]	ErrCode	Error code (one of Errorcodes)
[out]	ppDesc	will be set to a pointer to the description string. This memory buffer must not be modified or released.

Returns

Error code (Errorcodes)

SDK_ERROR SDK_API SDK_FreeString

(

SDK_WCHAR_T *

pString

)

Generic interface to free string buffers.

Parameters

[in]

pString

Pointer to string buffer to be freed. Ensure to only supply buffers which are explicitly allowed to be used here!

Returns

Error code (Errorcodes)

SDK_USER_PARAM SDK_API SDK_GetUserParam	(	SDK_INT4	param,
		SDK_INT4 *	pParam1,
		SDK_INT4 *	pParam2,
		SDK_INT4 *	pParam3,
		SDK_INT4 *	pParam4
	)

This interface may be used for certain user-specific features, mostly for debugging purposes

    \param[in,out] param Undocumented
    \param[in,out] pParam1 Undocumented
    \param[in,out] pParam2 Undocumented
    \param[in,out] pParam3 Undocumented
    \param[in,out] pParam4 Undocumented
    \return Undocumented  

SDK_USER_PARAM SDK_API SDK_SetUserParam	(	SDK_INT4	param,
		SDK_USER_PARAM	param1,
		SDK_USER_PARAM	param2,
		SDK_USER_PARAM	param3,
		SDK_USER_PARAM	param4
	)

This interface may be used to enable certain user-specific features, mostly for debugging purposes.

    \param[in] param Undocumented
    see \ref ConstantsSetUserParam for further documentation
    \param[in] param1 Undocumented
    \param[in] param2 Undocumented
    \param[in] param3 Undocumented
    \param[in] param4 Undocumented
    \return Undocumented