1 // Copyright (c) 2006-2010 Nokia Corporation and/or its subsidiary(-ies).
2 // All rights reserved.
3 // This component and the accompanying materials are made available
4 // under the terms of "Eclipse Public License v1.0"
5 // which accompanies this distribution, and is available
6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
8 // Initial Contributors:
9 // Nokia Corporation - initial contribution.
16 #include <sqldb.h> //RSqlColumnReadStream, RSqlParamWriteStream
17 #include "SqlStatementImpl.h" //CSqlStatementImpl
18 #include "OstTraceDefinitions.h"
19 #ifdef OST_TRACE_COMPILER_IN_USE
20 #include "SqlStreamTraces.h"
22 #include "SqlTraceDef.h"
24 ////////////////////////////////////////////////////////////////////////////////////////////////////
25 ///////////////////// RSqlColumnReadStream ////////////////////////////////////
26 ////////////////////////////////////////////////////////////////////////////////////////////////////
29 Gives access to column data as a read-only stream of characters,
31 The function can only be used for text and binary column types.
33 @param aStmt The RSqlStatement object to which the referred column belongs.
34 @param aColumnIndex The index value identifying the column; this is 0 for the first column.
36 @return KErrNone, the text column data stream has been opened successfully;
37 KErrNoMemory, an out of memory condition occurred;
38 KErrArgument, the column type is neither text nor binary.
39 Note that database specific errors categorised as ESqlDbError, and
40 other system-wide error codes may also be returned.
44 EXPORT_C TInt RSqlColumnReadStream::ColumnText(RSqlStatement& aStmt, TInt aColumnIndex)
46 SQL_TRACE_BORDER(OstTraceExt3(TRACE_BORDER, RSQLCOLUMNREADSTREAM_COLUMNTEXT_ENTRY, "Entry;0x%X;RSqlColumnReadStream::ColumnText;aStmt=0x%X;aColumnIndex=%d", (TUint)this, (TUint)&aStmt, aColumnIndex));
47 TRAPD(err, Attach(aStmt.Impl().ColumnSourceL(aColumnIndex)));
48 SQL_TRACE_BORDER(OstTraceExt2(TRACE_BORDER, RSQLCOLUMNREADSTREAM_COLUMNTEXT_EXIT, "Exit;0x%X;RSqlColumnReadStream::ColumnText;err=%d", (TUint)this, err));
53 Gives access to column data as a read-only stream of bytes.
55 The function can only be used for text and binary column types.
57 @param aStmt The RSqlStatement object to which the referred column belongs.
58 @param aColumnIndex The index value identifying the column; this is 0 for the first column.
60 @return KErrNone, the text column data stream has been opened successfully;
61 KErrNoMemory, an out of memory condition occurred;
62 KErrArgument, the column type is neither text nor binary.
63 Note that database specific errors categorised as ESqlDbError, and
64 other system-wide error codes may also be returned.
68 EXPORT_C TInt RSqlColumnReadStream::ColumnBinary(RSqlStatement& aStmt, TInt aColumnIndex)
70 SQL_TRACE_BORDER(OstTraceExt3(TRACE_BORDER, RSQLCOLUMNREADSTREAM_COLUMNBINARY_ENTRY, "Entry;0x%X;RSqlColumnReadStream::ColumnBinary;aStmt=0x%X;aColumnIndex=%d", (TUint)this, (TUint)&aStmt, aColumnIndex));
71 TRAPD(err, Attach(aStmt.Impl().ColumnSourceL(aColumnIndex)));
72 SQL_TRACE_BORDER(OstTraceExt2(TRACE_BORDER, RSQLCOLUMNREADSTREAM_COLUMNBINARY_EXIT, "Exit;0x%X;RSqlColumnReadStream::ColumnBinary;err=%d", (TUint)this, err));
77 Gives access to column data as a read-only stream of characters,
79 The function can only be used for text and binary column types.
81 @param aStmt The RSqlStatement object to which the referred column belongs.
82 @param aColumnIndex The index value identifying the column; this is 0 for the first column.
84 @leave KErrNoMemory, an out of memory condition occurred;
85 KErrArgument, the column type is neither text nor binary.
86 Note that database specific errors categorised as ESqlDbError, and
87 other system-wide error codes may also be returned.
91 EXPORT_C void RSqlColumnReadStream::ColumnTextL(RSqlStatement& aStmt, TInt aColumnIndex)
93 SQL_TRACE_BORDER(OstTraceExt3(TRACE_BORDER, RSQLCOLUMNREADSTREAM_COLUMNTEXTL_ENTRY, "Entry;0x%X;RSqlColumnReadStream::ColumnTextL;aStmt=0x%X;aColumnIndex=%d", (TUint)this, (TUint)&aStmt, aColumnIndex));
94 Attach(aStmt.Impl().ColumnSourceL(aColumnIndex));
95 SQL_TRACE_BORDER(OstTrace1(TRACE_BORDER, RSQLCOLUMNREADSTREAM_COLUMNTEXTL_EXIT, "Exit;0x%X;RSqlColumnReadStream::ColumnTextL", (TUint)this));
99 Gives access to column data as a read-only stream of bytes.
101 The function can only be used for text and binary column types.
103 @param aStmt The RSqlStatement object to which the referred column belongs.
104 @param aColumnIndex The index value identifying the column; this is 0 for the first column.
106 @leave KErrNoMemory, an out of memory condition occurred;
107 KErrArgument, the column type is neither text nor binary.
108 Note that database specific errors categorised as ESqlDbError, and
109 other system-wide error codes may also be returned.
113 EXPORT_C void RSqlColumnReadStream::ColumnBinaryL(RSqlStatement& aStmt, TInt aColumnIndex)
115 SQL_TRACE_BORDER(OstTraceExt3(TRACE_BORDER, RSQLCOLUMNREADSTREAM_COLUMNBINARYL_ENTRY, "Entry;0x%X;RSqlColumnReadStream::ColumnBinaryL;aStmt=0x%X;aColumnIndex=%d", (TUint)this, (TUint)&aStmt, aColumnIndex));
116 Attach(aStmt.Impl().ColumnSourceL(aColumnIndex));
117 SQL_TRACE_BORDER(OstTrace1(TRACE_BORDER, RSQLCOLUMNREADSTREAM_COLUMNBINARYL_EXIT, "Exit;0x%X;RSqlColumnReadStream::ColumnBinaryL", (TUint)this));
120 ////////////////////////////////////////////////////////////////////////////////////////////////////
121 ///////////////////// RSqlParamWriteStream ////////////////////////////////////
122 ////////////////////////////////////////////////////////////////////////////////////////////////////
125 Gives access to parameter data as a stream of characters.
127 NB You need to close the stream after the execution of the statement operation for
128 which the parameter is set (RSqlStatement::Next() or RSqlStatement::Exec()).
130 @param aStmt The RSqlStatement object to which the referred parameter belongs.
131 @param aParameterIndex The index value identifying the parameter; this is 0 for the first parameter.
133 @return KErrNone, the binary parameter data stream has been opened successfully;
134 KErrNoMemory, an out of memory condition occurred.
135 Note that database specific errors categorised as ESqlDbError, and
136 other system-wide error codes may also be returned.
138 @see RSqlStatement::Next()
139 @see RSqlStatement::Exec()
143 EXPORT_C TInt RSqlParamWriteStream::BindText(RSqlStatement& aStmt, TInt aParameterIndex)
145 SQL_TRACE_BORDER(OstTraceExt3(TRACE_BORDER, RSQLPARAMWRITESTREAM_BINDTEXT_ENTRY, "Entry;0x%X;RSqlParamWriteStream::BindText;aStmt=0x%X;aParameterIndex=%d", (TUint)this, (TUint)&aStmt, aParameterIndex));
146 TRAPD(err, Attach(aStmt.Impl().ParamSinkL(ESqlSrvStmtTxtParamSink16, aParameterIndex)));
147 SQL_TRACE_BORDER(OstTraceExt2(TRACE_BORDER, RSQLPARAMWRITESTREAM_BINDTEXT_EXIT, "Exit;0x%X;RSqlParamWriteStream::BindText;err=%d", (TUint)this, err));
152 Gives access to parameter data as a stream of bytes.
154 NB You need to close the stream after the execution of the statement operation for
155 which the parameter is set (RSqlStatement::Next() or RSqlStatement::Exec()).
157 @param aStmt The RSqlStatement object to which the referred parameter belongs.
158 @param aParameterIndex The index value identifying the parameter; this is 0 for the first parameter.
160 @return KErrNone, the binary parameter data stream has been opened successfully;
161 KErrNoMemory, an out of memory condition occurred.
162 Note that database specific errors categorised as ESqlDbError, and
163 other system-wide error codes may also be returned.
165 @see RSqlStatement::Next()
166 @see RSqlStatement::Exec()
170 EXPORT_C TInt RSqlParamWriteStream::BindBinary(RSqlStatement& aStmt, TInt aParameterIndex)
172 SQL_TRACE_BORDER(OstTraceExt3(TRACE_BORDER, RSQLPARAMWRITESTREAM_BINDBINARY_ENTRY, "Entry;0x%X;RSqlParamWriteStream::BindBinary;aStmt=0x%X;aParameterIndex=%d", (TUint)this, (TUint)&aStmt, aParameterIndex));
173 TRAPD(err, Attach(aStmt.Impl().ParamSinkL(ESqlSrvStmtBinParamSink, aParameterIndex)));
174 SQL_TRACE_BORDER(OstTraceExt2(TRACE_BORDER, RSQLPARAMWRITESTREAM_BINDBINARY_EXIT, "Exit;0x%X;RSqlParamWriteStream::BindBinary;err=%d", (TUint)this, err));
179 Gives access to parameter data as a stream of characters.
181 NB You need to close the stream after the execution of the statement operation for
182 which the parameter is set (RSqlStatement::Next() or RSqlStatement::Exec()).
184 @param aStmt The RSqlStatement object to which the referred parameter belongs.
185 @param aParameterIndex The index value identifying the parameter; this is 0 for the first parameter.
187 @leave KErrNoMemory, an out of memory condition occurred.
188 Note that database specific errors categorised as ESqlDbError, and
189 other system-wide error codes may also be returned.
191 @see RSqlStatement::Next()
192 @see RSqlStatement::Exec()
196 EXPORT_C void RSqlParamWriteStream::BindTextL(RSqlStatement& aStmt, TInt aParameterIndex)
198 SQL_TRACE_BORDER(OstTraceExt3(TRACE_BORDER, RSQLPARAMWRITESTREAM_BINDTEXTL_ENTRY, "Entry;0x%X;RSqlParamWriteStream::BindTextL;aStmt=0x%X;aParameterIndex=%d", (TUint)this, (TUint)&aStmt, aParameterIndex));
199 Attach(aStmt.Impl().ParamSinkL(ESqlSrvStmtTxtParamSink16, aParameterIndex));
200 SQL_TRACE_BORDER(OstTrace1(TRACE_BORDER, RSQLPARAMWRITESTREAM_BINDTEXTL_EXIT, "Exit;0x%X;RSqlParamWriteStream::BindTextL", (TUint)this));
204 Gives access to parameter data as a stream of bytes.
206 NB You need to close the stream after the execution of the statement operation for
207 which the parameter is set (RSqlStatement::Next() or RSqlStatement::Exec()).
209 @param aStmt The RSqlStatement object to which the referred parameter belongs.
210 @param aParameterIndex The index value identifying the parameter; this is 0 for the first parameter.
212 @leave KErrNoMemory, an out of memory condition occurred.
213 Note that database specific errors categorised as ESqlDbError, and
214 other system-wide error codes may also be returned.
216 @see RSqlStatement::Next()
217 @see RSqlStatement::Exec()
221 EXPORT_C void RSqlParamWriteStream::BindBinaryL(RSqlStatement& aStmt, TInt aParameterIndex)
223 SQL_TRACE_BORDER(OstTraceExt3(TRACE_BORDER, RSQLPARAMWRITESTREAM_BINDBINARYL_ENTRY, "Entry;0x%X;RSqlParamWriteStream::BindBinaryL;aStmt=0x%X;aParameterIndex=%d", (TUint)this, (TUint)&aStmt, aParameterIndex));
224 Attach(aStmt.Impl().ParamSinkL(ESqlSrvStmtBinParamSink, aParameterIndex));
225 SQL_TRACE_BORDER(OstTrace1(TRACE_BORDER, RSQLPARAMWRITESTREAM_BINDBINARYL_EXIT, "Exit;0x%X;RSqlParamWriteStream::BindBinaryL", (TUint)this));