RMimerParameterData Class Reference

Use objects of this class to obtain parameter output data. More...

List of all members.

Public Member Functions
IMPORT_C TBool	GetBooleanL (TInt aParNo)
	Returns boolean data to the application.
IMPORT_C void	GetDes16L (TInt aParNo, TDes16 &aDes)
	Returns a 16-bit string to the application.
IMPORT_C void	GetDes8L (TInt aParNo, TDes8 &aDes)
	Returns an 8-bit string to the application.
void	GetDesL (TInt aParNo, TDes &aDes)
	Returns string data to the application.
IMPORT_C TInt64	GetInt64L (TInt aParNo)
	Returns 64-bit integer data to the application.
IMPORT_C TTimeIntervalDays	GetIntervalDaysL (TInt aParNo)
	Returns a day interval value to the application.
IMPORT_C TTimeIntervalHours	GetIntervalHoursL (TInt aParNo)
	Returns an hour interval value to the application.
IMPORT_C TTimeIntervalMicroSeconds	GetIntervalMicroSecondsL (TInt aParNo)
	Returns a microseconds interval value to the application.
IMPORT_C TTimeIntervalMinutes	GetIntervalMinutesL (TInt aParNo)
	Returns a minute interval value to the application.
IMPORT_C TTimeIntervalMonths	GetIntervalMonthsL (TInt aParNo)
	Returns a month interval value to the application.
IMPORT_C TTimeIntervalSeconds	GetIntervalSecondsL (TInt aParNo)
	Returns a second interval value to the application.
IMPORT_C TTimeIntervalYears	GetIntervalYearsL (TInt aParNo)
	Returns a year interval value to the application.
IMPORT_C TInt	GetIntL (TInt aParNo)
	Returns integer data to the application.
IMPORT_C TInt	GetLastError (TDes *aErrorText)
	Obtain error information about the last database operation.
IMPORT_C RMimerMetaData	GetMetaDataL ()
	Obtains a meta data object describing these parameters.
IMPORT_C TReal32	GetReal32L (TInt aParNo)
	Returns floating point data to the application.
IMPORT_C TReal	GetRealL (TInt aParNo)
	Returns floating point data to the application.
IMPORT_C TTime	GetTimeL (TInt aParNo)
	Returns date time data to the application.
IMPORT_C TUint	GetUintL (TInt aParNo)
	Returns unsigned integer data to the application.
	RMimerParameterData (RMimerCommand *)

---

Detailed Description

Use objects of this class to obtain parameter output data.

These objects are returned from RMimerCommand::ExecuteProcedureLC. All methods that return data from this object take a parameter number as its first argument. If the parameter identified by this number is not an OUT or INOUT parameter, a Leave is thrown.

---

Member Function Documentation

IMPORT_C TBool RMimerParameterData::GetBooleanL (  TInt  aParNo  )

Returns boolean data to the application. If the underlying parameter type is a numeric type, this method will return EFalse only when the parameter value is 0, and ETrue otherwise. If the underlying parameter type is a string type, EFalse is returned if and only if the string is empty. Parameters: aParNo  The parameter number. First parameter is parameter number 1. Returns: ETrue if the parameter value was NULL, otherwise EFalse. If the current row is invalid, EFalse is returned.

IMPORT_C void RMimerParameterData::GetDes16L (  TInt  aParNo, TDes16 &  aDes )

Returns a 16-bit string to the application. Parameters: aParNo  The parameter number. First parameter is parameter number 1. aDes  A 16-bit descriptor where the output string will be placed.

IMPORT_C void RMimerParameterData::GetDes8L (  TInt  aParNo, TDes8 &  aDes )

Returns an 8-bit string to the application. Parameters: aParNo  The parameter number. First parameter is parameter number 1. aDes  A 8-bit descriptor where the output string will be placed.

void RMimerParameterData::GetDesL (  TInt  aParNo, TDes &  aDes )  [inline]

Returns string data to the application. Parameters: aParNo  The parameter number. First parameter is parameter number 1. aDes  A descriptor where the output string will be placed. The SQL NULL value is represented by an empty string. Use the #IsNull method to detect SQL NULL values.

IMPORT_C TInt64 RMimerParameterData::GetInt64L (  TInt  aParNo  )

Returns 64-bit integer data to the application. Parameters: aParNo  The parameter number. First parameter is parameter number 1. Returns: The 64-bit integer value.

IMPORT_C TTimeIntervalDays RMimerParameterData::GetIntervalDaysL (  TInt  aParNo  )

Returns a day interval value to the application. The underlying SQL data type must be one of the following: INTERVAL DAY, INTERVAL DAY TO HOUR, INTERVAL DAY TO MINUTE, INTERVAL DAY TO SECOND, INTERVAL HOUR, INTERVAL HOUR TO MINUTE, INTERVAL HOUR TO SECOND, INTERVAL MINUTE, INTERVAL MINUTE TO SECOND, or INTERVAL SECOND. Other SQL data types cannot be returned using this method, attempts to do so will throw an error. Parameters: aParNo  The parameter number. First parameter is parameter number 1. Returns: The day interval value.

IMPORT_C TTimeIntervalHours RMimerParameterData::GetIntervalHoursL (  TInt  aParNo  )

Returns an hour interval value to the application. The underlying SQL data type must be one of the following: INTERVAL DAY, INTERVAL DAY TO HOUR, INTERVAL DAY TO MINUTE, INTERVAL DAY TO SECOND, INTERVAL HOUR, INTERVAL HOUR TO MINUTE, INTERVAL HOUR TO SECOND, INTERVAL MINUTE, INTERVAL MINUTE TO SECOND, or INTERVAL SECOND. Other SQL data types cannot be returned using this method, attempts to do so will throw an error. Parameters: aParNo  The parameter number. First parameter is parameter number 1. Returns: The hour interval value.

IMPORT_C TTimeIntervalMicroSeconds RMimerParameterData::GetIntervalMicroSecondsL (  TInt  aParNo  )

Returns a microseconds interval value to the application. The underlying SQL data type must be one of the following: INTERVAL DAY, INTERVAL DAY TO HOUR, INTERVAL DAY TO MINUTE, INTERVAL DAY TO SECOND, INTERVAL HOUR, INTERVAL HOUR TO MINUTE, INTERVAL HOUR TO SECOND, INTERVAL MINUTE, INTERVAL MINUTE TO SECOND, or INTERVAL SECOND. Other SQL data types cannot be returned using this method, attempts to do so will throw an error. Parameters: aParNo  The parameter number. First parameter is parameter number 1. Returns: The microseconds interval value.

IMPORT_C TTimeIntervalMinutes RMimerParameterData::GetIntervalMinutesL (  TInt  aParNo  )

Returns a minute interval value to the application. The underlying SQL data type must be one of the following: INTERVAL DAY, INTERVAL DAY TO HOUR, INTERVAL DAY TO MINUTE, INTERVAL DAY TO SECOND, INTERVAL HOUR, INTERVAL HOUR TO MINUTE, INTERVAL HOUR TO SECOND, INTERVAL MINUTE, INTERVAL MINUTE TO SECOND, or INTERVAL SECOND. Other SQL data types cannot be returned using this method, attempts to do so will throw an error. Parameters: aParNo  The parameter number. First parameter is parameter number 1. Returns: The minute interval value.

IMPORT_C TTimeIntervalMonths RMimerParameterData::GetIntervalMonthsL (  TInt  aParNo  )

Returns a month interval value to the application. The underlying SQL data type must be one of the following: INTERVAL YEAR, INTERVAL YEAR TO MONTH, or INTERVAL MONTH. Other SQL data types cannot be returned using this method, attempts to do so will throw an error. Parameters: aParNo  The parameter number. First parameter is parameter number 1. Returns: The hour interval value.

IMPORT_C TTimeIntervalSeconds RMimerParameterData::GetIntervalSecondsL (  TInt  aParNo  )

Returns a second interval value to the application. The underlying SQL data type must be one of the following: INTERVAL DAY, INTERVAL DAY TO HOUR, INTERVAL DAY TO MINUTE, INTERVAL DAY TO SECOND, INTERVAL HOUR, INTERVAL HOUR TO MINUTE, INTERVAL HOUR TO SECOND, INTERVAL MINUTE, INTERVAL MINUTE TO SECOND, or INTERVAL SECOND. Other SQL data types cannot be returned using this method, attempts to do so will throw an error. Parameters: aParNo  The parameter number. First parameter is parameter number 1. Returns: The second interval value.

IMPORT_C TTimeIntervalYears RMimerParameterData::GetIntervalYearsL (  TInt  aParNo  )

Returns a year interval value to the application. The underlying SQL data type must be one of the following: INTERVAL YEAR, INTERVAL YEAR TO MONTH, or INTERVAL MONTH. Other SQL data types cannot be returned using this method, attempts to do so will throw an error. Parameters: aParNo  The parameter number. First parameter is parameter number 1. Returns: The year interval value.

IMPORT_C TInt RMimerParameterData::GetIntL (  TInt  aParNo  )

Returns integer data to the application. Parameters: aParNo  The parameter number. First parameter is parameter number 1. Returns: The integer value.

IMPORT_C TInt RMimerParameterData::GetLastError (  TDes *  aErrorText  )

Obtain error information about the last database operation. The error information is lost once another operation is performed on the database. Parameters: aErrorText  A reference to a descriptor to hold a descriptive error message about the error. If this reference is a NULL pointer, no error text is obtained. Returns: The Mimer SQL error code. This error code is a negative number.

IMPORT_C RMimerMetaData RMimerParameterData::GetMetaDataL (   )

Obtains a meta data object describing these parameters. Returns: A meta data object describing the parameters.

IMPORT_C TReal32 RMimerParameterData::GetReal32L (  TInt  aParNo  )

Returns floating point data to the application. If the parameter contained the SQL NULL value, the returned floating point is the NaN value. Parameters: aParNo  The parameter number. First parameter is parameter number 1. Returns: The floating point value.

IMPORT_C TReal RMimerParameterData::GetRealL (  TInt  aParNo  )

Returns floating point data to the application. If the parameter contained the SQL NULL value, the returned floating point is the NaN value. Parameters: aParNo  The parameter number. First parameter is parameter number 1. Returns: The floating point value.

IMPORT_C TTime RMimerParameterData::GetTimeL (  TInt  aParNo  )

Returns date time data to the application. This table clarifies what is being returned depending on the server data types. SQL type Client value TIMESTAMP That value TIME That time on the current date DATE That date at 00:00:00 CHARACTER CHARACTER VARYING NATIONAL CHARACTER NATIONAL CHARACTER VARYING If the character string represents a valid SQL standard datetime literal, the value represented by the string is used. Otherwise an error is thrown. Other SQL data types cannot be casted to a datetime value, and an error will be thrown. Parameters: aParNo  The parameter number. First parameter is parameter number 1. Returns: The timestamp value.

IMPORT_C TUint RMimerParameterData::GetUintL (  TInt  aParNo  )

Returns unsigned integer data to the application. Parameters: aParNo  The parameter number. First parameter is parameter number 1. Returns: The integer value.

---

Submit a comment or suggestion Version 9.2.5b of Mimer C++ API for Symbian OS
Copyright Mimer Information Technology AB, Box 1713, SE-751 47 UPPSALA, Sweden. All Rights Reserved.