1 // Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies). |
1 // Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies). |
2 // All rights reserved. |
2 // All rights reserved. |
3 // This component and the accompanying materials are made available |
3 // This component and the accompanying materials are made available |
4 // under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members |
4 // under the terms of "Eclipse Public License v1.0" |
5 // which accompanies this distribution, and is available |
5 // which accompanies this distribution, and is available |
6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html". |
6 // at the URL "http://www.eclipse.org/legal/epl-v10.html". |
7 // |
7 // |
8 // Initial Contributors: |
8 // Initial Contributors: |
9 // Nokia Corporation - initial contribution. |
9 // Nokia Corporation - initial contribution. |
10 // |
10 // |
11 // Contributors: |
11 // Contributors: |
17 #define __LBSPOSITIONINFO_H__ |
17 #define __LBSPOSITIONINFO_H__ |
18 |
18 |
19 #include <lbsposition.h> |
19 #include <lbsposition.h> |
20 #include <lbscommon.h> |
20 #include <lbscommon.h> |
21 #include <lbsfields.h> |
21 #include <lbsfields.h> |
|
22 |
|
23 #ifdef SYMBIAN_ENABLE_SPLIT_HEADERS |
|
24 class TPositionFieldIndex; |
|
25 #endif // SYMBIAN_ENABLE_SPLIT_HEADERS |
|
26 |
22 |
27 |
23 /** |
28 /** |
24 The default size for a HPositionGenericInfo position information buffer |
29 The default size for a HPositionGenericInfo position information buffer |
25 |
30 |
26 @publishedAll |
31 @publishedAll |
220 IMPORT_C TInt MaxFields() const; |
225 IMPORT_C TInt MaxFields() const; |
221 |
226 |
222 /** |
227 /** |
223 * Used to store position information. |
228 * Used to store position information. |
224 * @param aFieldId Standard position field identifier. See _TPositionFieldId |
229 * @param aFieldId Standard position field identifier. See _TPositionFieldId |
225 * @param[in] aValue The parameter aValue can be of the type |
230 * @param [in] aValue The parameter aValue can be of the type |
226 * TInt8, TInt16, TInt32, TInt64, TUint8, TUint16, TUint32, |
231 * TInt8, TInt16, TInt32, TInt64, TUint8, TUint16, TUint32, |
227 * TReal32, TReal64, TTime, TTimeIntervalMicroSeconds, Des8, or Des16. |
232 * TReal32, TReal64, TTime, TTimeIntervalMicroSeconds, Des8, or Des16. |
228 * @return a symbian OS error code. |
233 * @return a symbian OS error code. |
229 * @return KErrNone on successful operation. |
234 * @return KErrNone on successful operation. |
230 * @return KErrPositionBufferOverflow if the data contained in the |
235 * @return KErrPositionBufferOverflow if the data contained in the |
235 {return PositionFieldManager::SetValue(aFieldId, aValue, *this);} |
240 {return PositionFieldManager::SetValue(aFieldId, aValue, *this);} |
236 |
241 |
237 /** |
242 /** |
238 * Used to retrieve position information. |
243 * Used to retrieve position information. |
239 * @param aFieldId Standard position field identifier. See _TPositionFieldId |
244 * @param aFieldId Standard position field identifier. See _TPositionFieldId |
240 * @param[out] aValue The parameter aValue can be of the type |
245 * @param [out] aValue The parameter aValue can be of the type |
241 * TInt8, TInt16, TInt32, TInt64, TUint8, TUint16, TUint32, |
246 * TInt8, TInt16, TInt32, TInt64, TUint8, TUint16, TUint32, |
242 * TReal32, TReal64, TTime, TTimeIntervalMicroSeconds, Des8, or Des16. |
247 * TReal32, TReal64, TTime, TTimeIntervalMicroSeconds, Des8, or Des16. |
243 * Panics with EPositionGenericInfoMismatchDataType if there is a |
248 * Panics with EPositionGenericInfoMismatchDataType if there is a |
244 * mismatch in the data type of a field. |
249 * mismatch in the data type of a field. |
245 * @return a symbian OS error code. |
250 * @return a symbian OS error code. |