GetActualGpsPosition() [1/2]

static int GetActualGpsPosition ( out SError  Error, out SGpsPosition  GpsPosition, bool  SatellitesInfo, Int32  MaxTime  )

inlinestatic

The function returns informations about actual GPS position.

Parameters

Error	Additional error information returned from Drive.
GpsPosition	Reference to instance of SGpsPosition class which contains informations about GPS position.
SatellitesInfo	Flag determining whether function should return satellites information.
MaxTime	Maximum time (in milliseconds) function can take. If MaxTime=0 function execution is not time limited.

Returns

1 if successful, other value otherwise.

The function GetActualGpsPosition needs Drive to have valid GPS position. If valid GPS position is not present GetActualGpsPosition returns 0 and GpsPosition (see SGpsPosition class) members are set to 0.

Possible error codes returned from Drive are:

• 0 - Function not succeeded.
• 1 - Function succeeded.
• 2 - Drive not succeeded.

• 3 - Function reached timeout.

• -1 - No fix.
• -2 - GPS position not available.

References SGpsPosition.SizeOf(), and SError.SizeOf().