-
-
Notifications
You must be signed in to change notification settings - Fork 8
Expand file tree
/
Copy pathODBCWrappers.h
More file actions
2262 lines (1899 loc) · 87.6 KB
/
Copy pathODBCWrappers.h
File metadata and controls
2262 lines (1899 loc) · 87.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
Module : ODBCWrappers.h
Purpose: Defines the interface for a set of C++ class which encapsulate ODBC 3.x. The classes are loosely
based on the design of the ATL OLEDB Consumer Template classes which are provided with
Microsoft Visual C++.
History: PJN / 24-09-2011 1. Initial creation
PJN / 13-11-2011 1. Initial Public release.
PJN / 16-11-2011 1. Updated code to use std::vector instead of std::auto_ptr for allocating SQLTCHAR
temp heap arrays. Thanks to Andrey Karpov for reporting this issue.
2. BrowseConnect method which returns a string& parameter now uses a TCHAR* parameter
instead of a SQLTCHAR* parameter for the first parameter
PJN / 20-11-2011 1. Removed final occurrence of std::auto_ptr usage in CStatement::GetCursorName.
PJN / 19-02-2013 1. Updated copyright details.
2. Updated code to provide default sensible values for the StrLen_or_IndPtr parameter
if it is not explicitly provided by client code.
3. Updated the sample app to shown examples of inserting into a table, iterating across
the rows in a table, updating a row in a table and deleting a row from a table.
4. Removed some accidental usage of MFC TRACE and ASSERT functions and replaced with
ATL equivalents.
5. Pulling in MS SQL Server extensions header file sqlext.h and associated functionality
is now optional via a new CODBCWRAPPERS_MSSQL_EXTENSIONS preprocessor value
6. Sample app now does not link against MFC for demonstration purpose
PJN / 21-02-2013 1. Addition of a new CODBCWRAPPERS_MFC_EXTENSIONS preprocessor value which changes the
wrapper classes to more tightly integrate with MFC. Internally the classes will then use
the MFC collection classes and expose a CString interface
2. Following a customer request the code should now be compilable in VC 6 for those
diehards still stuck on this compiler.
PJN / 27-02-2015 1. Updated copyright details.
2. Addition of a new CCommand class based on the ATL class of the same name. This class
should make it easier to port ATL OLEDB code which is currently using ATL::CCommand.
Thanks to Serhiy Pavlov for requested this update.
PJN / 14-03-2015 1. Added SAL annotations to all the code.
2. Renamed the parameters to the methods of the classes to be consistent with the
parameter names in the latest Visual Studio 2013 header files.
PJN / 05-11-2015 1. Updated code to compile cleanly on VC 2015.
2. Fixed compiler warnings in CHandle::SetAttr, CHandle::SetAttrU, CConnection::SetAttr,
CConnection::SetAttrU, CStatement::SetAttr & CStatement::SetAttrU related to incorrect
reinterpret_cast's.
3. Implemented support for SQLCancelHandle via CHandle::Cancel.
4. Implemented support for SQLCompleteAsync via CHandle:CompleteAsync
5. Implemented support for setting attributes in CCommandBase::SetAttributes,
CCommandBase::Create & CCommand::Open. Thanks to Serhiy Pavlov for providing this new feature.
PJN / 29-04-2017 1. Updated copyright details.
2. Updated the code to compile cleanly using /permissive-.
PJN / 03-12-2017 1. Replaced NULL throughout the codebase with nullptr. This means that the minimum requirement
for the framework is now VC 2010.
2. Replaced BOOL throughout the codebase with bool.
3. Replaced CString::operator LPC*STR() calls throughout the codebase with CString::GetString calls
4. Renamed CHandle::Cancel method to CHandle::CancelHandle
5. Fixed problems in CAccessor::BindColumns and CAccessor::BindParameters with the
use of __if_exists and /permissive-.
6. Fixed problems in the MFC code path of CDynamicColumnAccessor::BindColumns with
the use of "m_ColumnIndicators" and /permissive-
PJN / 28-11-2018 1. Updated copyright details
2. Fixed a number of C++ core guidelines compiler warnings. These changes mean
that the code will now only compile on VC 2017 or later.
3. Removed code which supported CODBCWRAPPERS_MFC_EXTENSIONS define
PJN / 14-04-2019 1. Updated copyright details
2. Updated the code to clean compile on VC 2019
PJN / 01-10-2019 1. Fixed a number of compiler warnings when the code is compiled with VS 2019 Preview
PJN / 19-12-2019 1. Fixed various Clang-Tidy static code analysis warnings in the code.
PJN / 02-03-2020 1. Updated copyright details.
2. Fixed more Clang-Tidy static code analysis warnings in the code.
PJN / 12-04-2020 1. Fixed more Clang-Tidy static code analysis warnings in the code.
PJN / 20-09-2020 1. Fixed more Clang-Tidy static code analysis warnings in the code.
2. Added a new SET_ODBC_PARAM_FOCUS macro to the code. This allows the code framework to be used
with Table Value Parameters (TVP). A TVP is where a table is passed as a parameter to a stored
procedure. To support this new functionality the CAccessor::BindParameters method now takes a
non const CStatement parameter. Thanks to Serhiy Pavlov for providing this nice addition.
3. Reworked a number of the macros to embed suppressing various VC++ compiler warnings at source.
This change means that client code does not need to suppress these compiler warnings at their
call sites if they are aiming for clean compilation when using code analysis.
PJN / 09-10-2020 1. Fixed a copy and paste error around the ODBC_COLUMN_ENTRY_LENGTH_STATUS macro. Thanks to
Serhiy Pavlov for reporting this issue.
PJN / 13-10-2020 1. Fixed an issue in CHandle::GetDiagRecords and CHandle::ValidateReturnValue where the code
would not terminate a loop if SQLGetDiagRec returns a value other than SQL_NO_DATA. Thanks to
Serhiy Pavlov for reporting this issue.
PJN / 03-07-2021 1. Added support for date and time datatypes: TIME_STRUCT / SQL_TYPE_TIME &
DATE_STRUCT / SQL_TYPE_DATE. Thanks to Serhiy Pavlov for providing this nice addition.
2. Updated copyright details.
PJN / 04-03-2022 1. Updated copyright details.
2. Updated the code to use C++ uniform initialization for all variable declarations.
3. Updated the code to use std::[w]string::data method throughout. This means that
the code must now be compiled using /std:c++17.
PJN / 12-05-2023 1. Updated copyright details
2. Updated modules to indicate that it needs to be compiled using /std:c++17. Thanks to Martin Richter
for reporting this issue.
PJN / 15-12-2023 1. Updated module to remove usage of _if_exists by now using ODBCVER and _ATL_MODULES
preprocessor macro checks along with SFINAE.
PJN / 21-03-2026 1. Fixed a bug in the ODBC_PARAM_ENTRY_TYPE and ODBC_PARAM_ENTRY_PS_TYPE macros where a parameter
was declared as SQLType but then passed as sqlType. Thanks to Martin Kay for reporting this issue.
2. Updated copyright details.
Copyright (c) 2011 - 2026 by PJ Naughter (Web: www.naughter.com, Email: pjna@naughter.com)
All rights reserved.
Copyright / Usage Details:
You are allowed to include the source code in any product (commercial, shareware, freeware or otherwise)
when your product is released in binary form. You are allowed to modify the source code in any way you want
except you cannot modify the copyright details at the top of each module. If you want to distribute source
code with your application, then you are only allowed to distribute versions released by the author. This is
to maintain a single distribution point for the source code.
*/
//////////////////////////// Macros / Includes ////////////////////////////////
#pragma once
#if _MSVC_LANG < 201703
#error ODBCWrappers requires a minimum C++ language standard of /std:c++17
#endif //#if _MSVC_LANG < 201703
#ifndef __ODBCWRAPPERS_H__
#define __ODBCWRAPPERS_H__
#ifndef CODBCWRAPPERS_EXT_CLASS
#define CODBCWRAPPERS_EXT_CLASS
#endif //#ifndef CODBCWRAPPERS_EXT_CLASS
#ifndef CODBCWRAPPERS_EXT_API
#define CODBCWRAPPERS_EXT_API
#endif //#ifndef CODBCWRAPPERS_EXT_API
#ifndef __SQL
#pragma message("To avoid this message, please put sql.h in your pre compiled header (normally stdafx.h)")
#include <sql.h>
#endif //#ifndef __SQL
#ifdef CODBCWRAPPERS_MSSQL_EXTENSIONS
#ifndef __SQLEXT
#pragma message("To avoid this message, please put sqlext.h in your pre compiled header (normally stdafx.h)")
#include <sqlext.h>
#endif //#ifndef __SQLEXT
#endif //#ifdef CODBCWRAPPERS_MSSQL_EXTENSIONS
#ifndef __ATLSTR_H__
#pragma message("To avoid this message, please put atlstr.h in your pre compiled header (normally stdafx.h)")
#include <atlstr.h>
#endif //#ifndef __ATLSTR_H__
#ifndef _ALGORITHM_
#pragma message("To avoid this message, please put algorithm in your pre compiled header (normally stdafx.h)")
#include <algorithm>
#endif //#ifndef _ALGORITHM_
#pragma comment(lib, "odbc32.lib")
#define DEFINE_ODBC_SQL_TYPE_FUNCTION(ctype, odbctype) \
inline SQLSMALLINT _GetODBCSQLType(ctype&) noexcept \
{ \
return odbctype; \
}
#pragma warning(suppress: 26485)
inline SQLSMALLINT _GetODBCSQLType(BYTE[]) noexcept //NOLINT(modernize-avoid-c-arrays)
{
return SQL_VARBINARY;
}
#pragma warning(suppress: 26485)
inline SQLSMALLINT _GetODBCSQLType(char[]) noexcept //NOLINT(modernize-avoid-c-arrays)
{
return SQL_VARCHAR;
}
#pragma warning(suppress: 26485)
inline SQLSMALLINT _GetODBCSQLType(wchar_t[]) noexcept //NOLINT(modernize-avoid-c-arrays)
{
return SQL_WVARCHAR;
}
DEFINE_ODBC_SQL_TYPE_FUNCTION(char, SQL_CHAR)
DEFINE_ODBC_SQL_TYPE_FUNCTION(wchar_t, SQL_CHAR)
DEFINE_ODBC_SQL_TYPE_FUNCTION(bool, SQL_BIT)
DEFINE_ODBC_SQL_TYPE_FUNCTION(BYTE, SQL_TINYINT)
DEFINE_ODBC_SQL_TYPE_FUNCTION(short, SQL_SMALLINT)
DEFINE_ODBC_SQL_TYPE_FUNCTION(long, SQL_INTEGER)
DEFINE_ODBC_SQL_TYPE_FUNCTION(float, SQL_REAL)
DEFINE_ODBC_SQL_TYPE_FUNCTION(double, SQL_DOUBLE)
DEFINE_ODBC_SQL_TYPE_FUNCTION(__int64, SQL_BIGINT)
DEFINE_ODBC_SQL_TYPE_FUNCTION(TIMESTAMP_STRUCT, SQL_TYPE_TIMESTAMP)
DEFINE_ODBC_SQL_TYPE_FUNCTION(TIME_STRUCT, SQL_TYPE_TIME)
DEFINE_ODBC_SQL_TYPE_FUNCTION(DATE_STRUCT, SQL_TYPE_DATE)
DEFINE_ODBC_SQL_TYPE_FUNCTION(SQL_NUMERIC_STRUCT, SQL_NUMERIC)
DEFINE_ODBC_SQL_TYPE_FUNCTION(GUID, SQL_GUID)
#define DEFINE_ODBC_DEFAULT_INDICATOR_VALUE_FUNCTION(ctype, defaultIndicatorValue) \
inline void _GetODBCDefaultIndicatorValue(_In_ ctype&, _Out_opt_ SQLLEN* pDefaultIndicatorValue) noexcept \
{ \
if (pDefaultIndicatorValue != nullptr) \
*pDefaultIndicatorValue = defaultIndicatorValue; \
}
#pragma warning(suppress: 26485)
inline void _GetODBCDefaultIndicatorValue(BYTE[], SQLLEN* /*pDefaultIndicatorValue*/) noexcept //NOLINT(modernize-avoid-c-arrays)
{
#pragma warning(suppress: 26477)
ATLASSERT(false); //If you pass a byte array, then you should explicitly specify the length yourself
}
#pragma warning(suppress: 26429 26485)
inline void _GetODBCDefaultIndicatorValue(char[], SQLLEN* pDefaultIndicatorValue) noexcept //NOLINT(modernize-avoid-c-arrays)
{
*pDefaultIndicatorValue = SQL_NTS; //Lets assume null terminated data for ASCII data
}
#pragma warning(suppress: 26429 26485)
inline void _GetODBCDefaultIndicatorValue(wchar_t[], SQLLEN* pDefaultIndicatorValue) noexcept //NOLINT(modernize-avoid-c-arrays)
{
*pDefaultIndicatorValue = SQL_NTS; //Lets assume null terminated data for Unicode data
}
DEFINE_ODBC_DEFAULT_INDICATOR_VALUE_FUNCTION(char, sizeof(char))
DEFINE_ODBC_DEFAULT_INDICATOR_VALUE_FUNCTION(wchar_t, sizeof(wchar_t))
DEFINE_ODBC_DEFAULT_INDICATOR_VALUE_FUNCTION(bool, 0)
DEFINE_ODBC_DEFAULT_INDICATOR_VALUE_FUNCTION(BYTE, 0)
DEFINE_ODBC_DEFAULT_INDICATOR_VALUE_FUNCTION(short, 0)
DEFINE_ODBC_DEFAULT_INDICATOR_VALUE_FUNCTION(long, 0)
DEFINE_ODBC_DEFAULT_INDICATOR_VALUE_FUNCTION(float, 0)
DEFINE_ODBC_DEFAULT_INDICATOR_VALUE_FUNCTION(double, 0)
DEFINE_ODBC_DEFAULT_INDICATOR_VALUE_FUNCTION(__int64, 0)
DEFINE_ODBC_DEFAULT_INDICATOR_VALUE_FUNCTION(TIMESTAMP_STRUCT, 0)
DEFINE_ODBC_DEFAULT_INDICATOR_VALUE_FUNCTION(TIME_STRUCT, 0)
DEFINE_ODBC_DEFAULT_INDICATOR_VALUE_FUNCTION(DATE_STRUCT, 0)
DEFINE_ODBC_DEFAULT_INDICATOR_VALUE_FUNCTION(SQL_NUMERIC_STRUCT, 0)
DEFINE_ODBC_DEFAULT_INDICATOR_VALUE_FUNCTION(GUID, 0)
//The ODBC_CHECK_RETURN macro checks the return value from ODBC calls
#define ODBC_CHECK_RETURN(nRet, handle) \
handle.ValidateReturnValue(nRet); \
if ((nRet != SQL_SUCCESS) && (nRet != SQL_SUCCESS_WITH_INFO)) \
return nRet;
//The ODBC_CHECK_RETURN_PTR macro checks the return value from ODBC calls
#define ODBC_CHECK_RETURN_PTR(nRet, handle) \
handle->ValidateReturnValue(nRet); \
if ((nRet != SQL_SUCCESS) && (nRet != SQL_SUCCESS_WITH_INFO)) \
return nRet;
#define DEFINE_ODBC_C_TYPE_FUNCTION(ctype, odbctype) \
inline SQLSMALLINT _GetODBCCType(_In_ ctype&) noexcept \
{ \
return odbctype; \
}
#pragma warning(suppress: 26485)
inline SQLSMALLINT _GetODBCCType(BYTE[]) noexcept //NOLINT(modernize-avoid-c-arrays)
{
return SQL_C_BINARY;
}
#pragma warning(suppress: 26485)
inline SQLSMALLINT _GetODBCCType(char[]) noexcept //NOLINT(modernize-avoid-c-arrays)
{
return SQL_C_CHAR;
}
#pragma warning(suppress: 26485)
inline SQLSMALLINT _GetODBCCType(wchar_t[]) noexcept //NOLINT(modernize-avoid-c-arrays)
{
return SQL_C_WCHAR;
}
DEFINE_ODBC_C_TYPE_FUNCTION(char, SQL_C_CHAR)
DEFINE_ODBC_C_TYPE_FUNCTION(wchar_t, SQL_C_WCHAR)
DEFINE_ODBC_C_TYPE_FUNCTION(bool, SQL_C_BIT)
DEFINE_ODBC_C_TYPE_FUNCTION(BYTE, SQL_C_TINYINT)
DEFINE_ODBC_C_TYPE_FUNCTION(short, SQL_C_SSHORT)
DEFINE_ODBC_C_TYPE_FUNCTION(long, SQL_C_SLONG)
DEFINE_ODBC_C_TYPE_FUNCTION(float, SQL_C_FLOAT)
DEFINE_ODBC_C_TYPE_FUNCTION(double, SQL_C_DOUBLE)
DEFINE_ODBC_C_TYPE_FUNCTION(__int64, SQL_C_SBIGINT)
DEFINE_ODBC_C_TYPE_FUNCTION(TIMESTAMP_STRUCT, SQL_C_TYPE_TIMESTAMP)
DEFINE_ODBC_C_TYPE_FUNCTION(TIME_STRUCT, SQL_C_TYPE_TIME)
DEFINE_ODBC_C_TYPE_FUNCTION(DATE_STRUCT, SQL_C_TYPE_DATE)
DEFINE_ODBC_C_TYPE_FUNCTION(SQL_NUMERIC_STRUCT, SQL_C_NUMERIC)
DEFINE_ODBC_C_TYPE_FUNCTION(GUID, SQL_C_GUID)
#define _ODBC_C_TYPE(data) _GetODBCCType((static_cast<_classtype*>(nullptr))->data) //NOLINT(clang-analyzer-core.NonNullParamChecker)
#define _ODBC_SQL_TYPE(data) _GetODBCSQLType((static_cast<_classtype*>(nullptr))->data) //NOLINT(clang-analyzer-core.NonNullParamChecker)
#define _ODBC_SIZE_TYPE(data) sizeof((static_cast<_classtype*>(nullptr))->data) //NOLINT(clang-analyzer-core.NonNullParamChecker)
#define BEGIN_ODBC_PARAM_MAP(x) \
__pragma(warning(push)) \
__pragma(warning(suppress: 26440 26461 26496)) \
public: \
using _classtype = x; \
SQLRETURN _GetBindParametersEntries(_In_opt_ CODBC::CStatement* pStmt, _Out_opt_ int* pnColumns, _In_opt_ std::vector<SQLLEN>* pIndicators) \
{ \
UNREFERENCED_PARAMETER(pStmt); /*NOLINT(clang-diagnostic-unused-value)*/ \
UNREFERENCED_PARAMETER(pIndicators); /*NOLINT(clang-diagnostic-unused-value)*/ \
SQLSMALLINT ioType{SQL_PARAM_INPUT}; \
UNREFERENCED_PARAMETER(ioType); /*NOLINT(clang-diagnostic-unused-value)*/ \
SQLRETURN nRet{SQL_SUCCESS}; \
if (pnColumns != nullptr) \
*pnColumns = 0; \
__pragma(warning(pop))
#define END_ODBC_PARAM_MAP() \
return nRet; \
}
#define _ODBC_PARAM_ENTRY_CODE(ParameterNumber, ValueType, ParameterType, ColumnSize, DecimalDigits, ParameterValuePtr, BufferLength, StrLen_or_IndPtr, data) \
if (pnColumns != nullptr) \
*pnColumns = ParameterNumber; \
if (pStmt != nullptr) \
{ \
SQLLEN* pIndicator{StrLen_or_IndPtr}; \
if (pIndicator == nullptr) \
{ \
SQLLEN& nParameterIndicator{(*pIndicators)[ParameterNumber - 1]}; \
_GetODBCDefaultIndicatorValue(data, &nParameterIndicator); \
pIndicator = &nParameterIndicator; \
} \
nRet = pStmt->BindParameter(ParameterNumber, ioType, ValueType, ParameterType, ColumnSize, DecimalDigits, ParameterValuePtr, BufferLength, pIndicator); \
ODBC_CHECK_RETURN_PTR(nRet, pStmt); \
}
#define ODBC_PARAM_ENTRY(ParameterNumber, data) \
__pragma(warning(push)) \
__pragma(warning(suppress: 26446 26477 26485 26486 26489)) \
_ODBC_PARAM_ENTRY_CODE(ParameterNumber, _ODBC_C_TYPE(data), _ODBC_SQL_TYPE(data), _ODBC_SIZE_TYPE(data), 0, &data, _ODBC_SIZE_TYPE(data), nullptr, data); \
__pragma(warning(pop))
#define ODBC_PARAM_LENGTH(ParameterNumber, data, length) \
_ODBC_PARAM_ENTRY_CODE(ParameterNumber, _ODBC_C_TYPE(data), _ODBC_SQL_TYPE(data), length, 0, &data, length, nullptr, data);
#define ODBC_PARAM_ENTRY_TYPE(ParameterNumber, data, cType, sqlType) \
_ODBC_PARAM_ENTRY_CODE(ParameterNumber, cType, sqlType, _ODBC_SIZE_TYPE(data), 0, &data, _ODBC_SIZE_TYPE(data), nullptr, data);
#define ODBC_PARAM_ENTRY_STATUS(ParameterNumber, data, status) \
__pragma(warning(push)) \
__pragma(warning(suppress: 26446 26485 26486 26489)) \
_ODBC_PARAM_ENTRY_CODE(ParameterNumber, _ODBC_C_TYPE(data), _ODBC_SQL_TYPE(data), _ODBC_SIZE_TYPE(data), 0, &data, _ODBC_SIZE_TYPE(data), &status, data); \
__pragma(warning(pop))
#define ODBC_PARAM_LENGTH_STATUS(ParameterNumber, data, length, status) \
__pragma(warning(push)) \
__pragma(warning(suppress: 26446 26485 26486 26489)) \
_ODBC_PARAM_ENTRY_CODE(ParameterNumber, _ODBC_C_TYPE(data), _ODBC_SQL_TYPE(data), length, 0, &data, length, &status, data); \
__pragma(warning(pop))
#define ODBC_PARAM_ENTRY_PS(ParameterNumber, nPrecision, data) \
__pragma(warning(push)) \
__pragma(warning(suppress: 26446 26485 26486 26489)) \
_ODBC_PARAM_ENTRY_CODE(ParameterNumber, _ODBC_C_TYPE(data), _ODBC_SQL_TYPE(data), _ODBC_SIZE_TYPE(data), nPrecision, &data, _ODBC_SIZE_TYPE(data), nullptr, data); \
__pragma(warning(pop))
#define ODBC_PARAM_PS_LENGTH(ParameterNumber, data, nPrecision, length) \
__pragma(warning(push)) \
__pragma(warning(suppress: 26446 26485 26486 26489)) \
_ODBC_PARAM_ENTRY_CODE(ParameterNumber, _ODBC_C_TYPE(data), _ODBC_SQL_TYPE(data), length, nPrecision, &data, length, nullptr, data); \
__pragma(warning(pop))
#define ODBC_PARAM_ENTRY_PS_TYPE(ParameterNumber, data, nPrecision, cType, sqlType) \
__pragma(warning(push)) \
__pragma(warning(suppress: 26446 26485 26486 26489)) \
_ODBC_PARAM_ENTRY_CODE(ParameterNumber, cType, sqlType, _ODBC_SIZE_TYPE(data), nPrecision, &data, _ODBC_SIZE_TYPE(data), nullptr, data); \
__pragma(warning(pop))
#define ODBC_PARAM_ENTRY_PS_STATUS(ParameterNumber, data, nPrecision, status) \
__pragma(warning(push)) \
__pragma(warning(suppress: 26446 26485 26486 26489)) \
_ODBC_PARAM_ENTRY_CODE(ParameterNumber, _ODBC_C_TYPE(data), _ODBC_SQL_TYPE(data), _ODBC_SIZE_TYPE(data), nPrecision, &data, _ODBC_SIZE_TYPE(data), &status, data); \
__pragma(warning(pop))
#define ODBC_PARAM_PS_LENGTH_STATUS(ParameterNumber, data, nPrecision, length, status) \
__pragma(warning(push)) \
__pragma(warning(suppress: 26446 26485 26486 26489)) \
_ODBC_PARAM_ENTRY_CODE(ParameterNumber, _ODBC_C_TYPE(data), _ODBC_SQL_TYPE(data), length, nPrecision, &data, length, &status, data); \
__pragma(warning(pop))
#define SET_ODBC_PARAM_FOCUS(ColumnNumber) \
if (pStmt != nullptr) \
{ \
nRet = pStmt->SetAttr(SQL_SOPT_SS_PARAM_FOCUS, static_cast<SQLINTEGER>(ColumnNumber)); \
ODBC_CHECK_RETURN_PTR(nRet, pStmt); \
}
#define SET_ODBC_PARAM_TYPE(type) \
ioType = type;
#define DEFINE_ODBC_COMMAND(x, szCommand) \
static SQLTCHAR* GetDefaultCommand() noexcept \
{ \
return const_cast<SQLTCHAR*>(reinterpret_cast<const SQLTCHAR*>(szCommand)); \
}
#pragma warning(push)
#pragma warning(disable: 26429)
#define BEGIN_ODBC_COLUMN_MAP(x) \
public: \
using _classtype = x; \
SQLRETURN _GetBindColumnEntries(_In_opt_ const CODBC::CStatement* pStmt, _Out_opt_ int* pnColumns, _In_opt_ std::vector<SQLLEN>* pIndicators) \
{ \
UNREFERENCED_PARAMETER(pStmt); /*NOLINT(clang-diagnostic-unused-value)*/ \
UNREFERENCED_PARAMETER(pIndicators); /*NOLINT(clang-diagnostic-unused-value)*/ \
SQLRETURN nRet{SQL_SUCCESS}; \
if (pnColumns != nullptr) \
*pnColumns = 0;
#pragma warning(push)
#define END_ODBC_COLUMN_MAP() \
return nRet; \
}
#define _ODBC_COLUMN_ENTRY_CODE(ColumnNumber, TargetType, TargetValuePtr, BufferLength, StrLen_or_Ind) \
if (pnColumns != nullptr) \
*pnColumns = ColumnNumber; \
if (pStmt != nullptr) \
{ \
SQLLEN* pIndicator{StrLen_or_Ind}; \
if (pIndicator == nullptr) \
{ \
SQLLEN& nParameterIndicator{(*pIndicators)[ColumnNumber - 1]}; \
pIndicator = &nParameterIndicator; \
} \
nRet = pStmt->BindCol(ColumnNumber, TargetType, TargetValuePtr, BufferLength, pIndicator); \
ODBC_CHECK_RETURN_PTR(nRet, pStmt); \
}
#define ODBC_COLUMN_ENTRY(ColumnNumber, data) \
__pragma(warning(push)) \
__pragma(warning(suppress: 26446 26477 26485 26486 26489)) \
_ODBC_COLUMN_ENTRY_CODE(ColumnNumber, _ODBC_C_TYPE(data), &data, _ODBC_SIZE_TYPE(data), nullptr); \
__pragma(warning(pop))
#define ODBC_COLUMN_ENTRY_LENGTH(ColumnNumber, data, length) \
__pragma(warning(push)) \
__pragma(warning(suppress: 26446 26485 26486 26489)) \
_ODBC_COLUMN_ENTRY_CODE(ColumnNumber, _ODBC_C_TYPE(data), &data, length, nullptr); \
__pragma(warning(pop))
#define ODBC_COLUMN_ENTRY_TYPE(ColumnNumber, data, type) \
__pragma(warning(push)) \
__pragma(warning(suppress: 26446 26485 26486 26489)) \
_ODBC_COLUMN_ENTRY_CODE(ColumnNumber, type, &data, _ODBC_SIZE_TYPE(data), nullptr); \
__pragma(warning(pop))
#define ODBC_COLUMN_ENTRY_STATUS(ColumnNumber, data, status) \
__pragma(warning(push)) \
__pragma(warning(suppress: 26446 26485 26486 26489)) \
_ODBC_COLUMN_ENTRY_CODE(ColumnNumber, _ODBC_C_TYPE(data), &data, _ODBC_SIZE_TYPE(data), &status); \
__pragma(warning(pop))
#define ODBC_COLUMN_ENTRY_LENGTH_STATUS(ColumnNumber, data, length, status) \
__pragma(warning(push)) \
__pragma(warning(suppress: 26446 26485 26486 26489)) \
_ODBC_COLUMN_ENTRY_CODE(ColumnNumber, _ODBC_C_TYPE(data), &data, length, &status); \
__pragma(warning(pop))
/////////////////////////// Classes ///////////////////////////////////////////
namespace CODBC
{
#ifdef _UNICODE
using String = std::wstring;
#else
using String = std::string;
#endif //#ifdef _UNICODE
inline void CODBCWRAPPERS_EXT_API MultiSZToStringVector(_In_z_ const SQLTCHAR* pszString, _Out_ std::vector<String>& elements)
{
//Clear the vector
elements.clear();
//Add each element we find
#pragma warning(suppress: 26429 26473 26490)
auto pszValue{ reinterpret_cast<const TCHAR*>(pszString) };
#pragma warning(suppress: 26489)
while (*pszValue != _T('\0'))
{
#pragma warning(suppress: 26486 26489)
elements.emplace_back(pszValue);
#pragma warning(suppress: 26481 26486)
pszValue += (_tcslen(pszValue) + 1);
}
}
//Class which encapsulates a generic ODBC handle
class CODBCWRAPPERS_EXT_CLASS CHandle
{
public:
//Constructors / Destructors
#pragma warning(suppress: 26477)
CHandle() noexcept : m_h{ SQL_NULL_HANDLE },
m_Type{ 0 }
{}
CHandle(_In_ CHandle& h) = delete;
#pragma warning(suppress: 26477)
CHandle(_In_ CHandle&& h) noexcept : m_h{ SQL_NULL_HANDLE },
m_Type{ 0 }
{
Attach(h.m_Type, h.Detach());
}
explicit CHandle(_In_ SQLSMALLINT Type, _In_opt_ SQLHANDLE h) noexcept : m_h{ h },
m_Type{ Type }
{}
~CHandle() noexcept
{
#pragma warning(suppress: 26477)
if (m_h != SQL_NULL_HANDLE)
Close();
}
CHandle& operator=(const CHandle&) = delete;
CHandle& operator=(_In_ CHandle&& h) noexcept
{
#pragma warning(suppress: 26477)
if (m_h != SQL_NULL_HANDLE)
Close();
Attach(h.m_Type, h.Detach());
return *this;
}
//Methods
SQLRETURN Create(_In_ SQLSMALLINT Type, _In_opt_ SQLHANDLE InputHandle) noexcept
{
//Validate our parameters
#pragma warning(suppress: 26477)
ATLASSERT(m_h == SQL_NULL_HANDLE);
m_Type = Type;
return SQLAllocHandle(Type, InputHandle, &m_h);
}
void Close() noexcept
{
#pragma warning(suppress: 26477)
if (m_h != SQL_NULL_HANDLE)
{
SQLFreeHandle(m_Type, m_h);
#pragma warning(suppress: 26477)
m_h = SQL_NULL_HANDLE;
m_Type = 0;
}
}
[[nodiscard]] operator SQLHANDLE() const noexcept
{
return m_h;
}
void Attach(_In_ SQLSMALLINT Type, _In_ SQLHANDLE h) noexcept
{
//Validate our parameters
#pragma warning(suppress: 26477)
ATLASSERT(m_h == SQL_NULL_HANDLE);
m_Type = Type;
m_h = h;
}
SQLHANDLE Detach() noexcept
{
SQLHANDLE h{ m_h };
#pragma warning(suppress: 26477)
m_h = SQL_NULL_HANDLE;
m_Type = 0;
return h;
}
SQLRETURN GetDiagField(_In_ SQLSMALLINT iRecord, _In_ SQLSMALLINT fDiagField, _Out_writes_opt_(_Inexpressible_(cbBufferLength)) SQLPOINTER rgbDiagInfo, _In_ SQLSMALLINT cbBufferLength, _Out_opt_ SQLSMALLINT* pcbStringLength) const noexcept
{
//Validate our parameters
#pragma warning(suppress: 26477)
ATLASSERT(m_h != SQL_NULL_HANDLE);
return SQLGetDiagField(m_Type, m_h, iRecord, fDiagField, rgbDiagInfo, cbBufferLength, pcbStringLength);
}
SQLRETURN GetDiagRec(_In_ SQLSMALLINT iRecord, _Out_writes_opt_(6) SQLTCHAR* szSqlState, SQLINTEGER* pfNativeError, _Out_writes_opt_(cchErrorMsgMax) SQLTCHAR* szErrorMsg, _In_ SQLSMALLINT cchErrorMsgMax, _Out_opt_ SQLSMALLINT* pcchErrorMsg) const noexcept
{
//Validate our parameters
#pragma warning(suppress: 26477)
ATLASSERT(m_h != SQL_NULL_HANDLE);
return SQLGetDiagRec(m_Type, m_h, iRecord, szSqlState, pfNativeError, szErrorMsg, cchErrorMsgMax, pcchErrorMsg);
}
void GetDiagRecords(_Out_ std::vector<String>& records) const
{
//clear the vector
records.clear();
bool bContinue{ true };
for (SQLSMALLINT i = 1; bContinue; i++)
{
ATL::CAtlString sState;
SQLINTEGER nNativeError{ 0 };
ATL::CAtlString sMessageText;
SQLSMALLINT nTextLength{ 0 };
#pragma warning(suppress: 26473 26490)
const SQLRETURN nGetDiagRet{ GetDiagRec(i, reinterpret_cast<SQLTCHAR*>(sState.GetBuffer(6)), &nNativeError, reinterpret_cast<SQLTCHAR*>(sMessageText.GetBuffer(SQL_MAX_MESSAGE_LENGTH)), SQL_MAX_MESSAGE_LENGTH, &nTextLength) };
sMessageText.ReleaseBuffer();
sState.ReleaseBuffer();
if (nGetDiagRet == SQL_SUCCESS)
{
ATL::CAtlString sLine;
sLine.Format(_T("State:%s, Native Error Code:%d, Message Text:%s\n"), sState.GetString(), nNativeError, sMessageText.GetString());
#pragma warning(suppress: 26489)
records.emplace_back(sLine);
}
else
bContinue = false;
}
}
#if (ODBCVER >= 0x0380)
SQLRETURN CancelHandle() noexcept
{
//Validate our parameters
#pragma warning(suppress: 26477)
ATLASSERT(m_h != SQL_NULL_HANDLE);
return SQLCancelHandle(m_Type, m_h);
}
#endif //#if (ODBCVER >= 0x0380)
#if (ODBCVER >= 0x0380)
SQLRETURN CompleteAsync(_Out_ RETCODE* AsyncRetCodePtr) noexcept
{
//Validate our parameters
#pragma warning(suppress: 26477)
ATLASSERT(m_h != SQL_NULL_HANDLE);
return SQLCompleteAsync(m_Type, m_h, AsyncRetCodePtr);
}
#endif //#if (ODBCVER >= 0x0380)
#pragma warning(suppress: 26440)
void ValidateReturnValue(_In_ SQLRETURN nRet) const
{
#ifdef _DEBUG
if ((nRet != SQL_SUCCESS) && (nRet != SQL_SUCCESS_WITH_INFO))
{
//Report the bad return value
ATLTRACE(_T("ODBC API Failure, Return Value:%d\n"), nRet);
//Report all the diag records
bool bContinue{ true };
for (SQLSMALLINT i = 1; bContinue; i++)
{
ATL::CAtlString sState;
SQLINTEGER nNativeError{ 0 };
ATL::CAtlString sMessageText;
SQLSMALLINT nTextLength{ 0 };
#pragma warning(suppress: 26473 26490)
const SQLRETURN nGetDiagRet{ GetDiagRec(i, reinterpret_cast<SQLTCHAR*>(sState.GetBuffer(6)), &nNativeError, reinterpret_cast<SQLTCHAR*>(sMessageText.GetBuffer(SQL_MAX_MESSAGE_LENGTH)), SQL_MAX_MESSAGE_LENGTH, &nTextLength) };
sMessageText.ReleaseBuffer();
sState.ReleaseBuffer();
if (nGetDiagRet == SQL_SUCCESS)
{
#ifdef CODBCWRAPPERS_MSSQL_EXTENSIONS
//Report on the MS SQL Extension values if necessary
SQLLEN nRowNumber{ 0 };
GetDiagField(i, SQL_DIAG_ROW_NUMBER, &nRowNumber, SQL_IS_INTEGER, nullptr);
USHORT nLineNumber{ 0 };
GetDiagField(i, SQL_DIAG_SS_LINE, &nLineNumber, SQL_IS_INTEGER, nullptr);
SDWORD nMsgState{ 0 };
GetDiagField(i, SQL_DIAG_SS_MSGSTATE, &nMsgState, SQL_IS_INTEGER, nullptr);
SDWORD nSeverity{ 0 };
GetDiagField(i, SQL_DIAG_SS_SEVERITY, &nSeverity, SQL_IS_INTEGER, nullptr);
ATL::CAtlString sProcName;
SQLSMALLINT nProcName{ 0 };
GetDiagField(i, SQL_DIAG_SS_PROCNAME, sProcName.GetBuffer(4096), 4096, &nProcName);
sProcName.ReleaseBuffer();
ATL::CAtlString sServName;
#ifdef SQL_MAX_SQLSEVERNAME
constexpr const SQLSMALLINT nServNameLength{ SQL_MAX_SQLSERVERNAME };
#else
constexpr const SQLSMALLINT nServNameLength{ 128 };
#endif
SQLSMALLINT nServName{ 0 };
GetDiagField(i, SQL_DIAG_SS_SRVNAME, sServName.GetBuffer(nServNameLength), nServNameLength * sizeof(TCHAR), &nServName);
sServName.ReleaseBuffer();
if (sProcName.GetLength())
ATLTRACE(_T(" Diag Record: State:%s, Native Error Code:%d, Message Text:%s, Row Number:%d, Message State:%d, Severity:%d, Proc Name:%s, Line Number:%d, Server Name:%s\n"),
sState.GetString(), nNativeError, sMessageText.GetString(), nRowNumber, nMsgState, nSeverity, sProcName.GetString(), nLineNumber, sServName.GetString());
else
ATLTRACE(_T(" Diag Record details: State:%s, Native Error Code:%d, Message Text:%s, Row Number:%d, Message State:%d, Severity:%d, Server Name:%s\n"),
sState.GetString(), nNativeError, sMessageText.GetString(), nRowNumber, nMsgState, nSeverity, sServName.GetString());
#else
ATLTRACE(_T(" Diag Record: State:%s, Native Error Code:%d, Message Text:%s\n"), sState.GetString(), nNativeError, sMessageText.GetString());
#endif //CODBCWRAPPERS_MSSQL_EXTENSIONS
}
else
bContinue = false;
}
}
#else
UNREFERENCED_PARAMETER(nRet);
#endif //#ifdef _DEBUG
}
//Member variables
SQLHANDLE m_h;
SQLSMALLINT m_Type;
};
//Class which encapsulates an ODBC environment handle
class CEnvironment : public CHandle
{
public:
//Methods
#pragma warning(suppress: 26434)
SQLRETURN Create() noexcept
{
//Delegate to the base class
#pragma warning(suppress: 26477)
return __super::Create(SQL_HANDLE_ENV, SQL_NULL_HANDLE);
}
SQLRETURN DataSources(_In_ SQLUSMALLINT fDirection, _Out_writes_opt_(cchDSNMax) SQLTCHAR* szDSN, _In_ SQLSMALLINT cchDSNMax, _Out_opt_ SQLSMALLINT* pcchDSN,
_Out_writes_opt_(cchDescriptionMax) SQLTCHAR* szDescription, _In_ SQLSMALLINT cchDescriptionMax, _Out_opt_ SQLSMALLINT* pcchDescription) noexcept
{
//Validate our parameters
#pragma warning(suppress: 26477)
ATLASSERT(m_h != SQL_NULL_HANDLE);
return SQLDataSources(m_h, fDirection, szDSN, cchDSNMax, pcchDSN, szDescription, cchDescriptionMax, pcchDescription);
}
__success(SQL_SUCCEEDED(return)) SQLRETURN DataSources(_In_ SQLUSMALLINT Direction, _Out_ String& sDSN, _Out_ String& sDescription)
{
SQLSMALLINT nDSNLength{ 0 };
SQLSMALLINT nDescLength{ 0 };
SQLRETURN nRet{ DataSources(Direction, nullptr, 0, &nDSNLength, nullptr, 0, &nDescLength) };
if (SQL_SUCCEEDED(nRet))
{
sDSN.resize(static_cast<size_t>(nDSNLength) + 1);
sDescription.resize(static_cast<size_t>(nDescLength) + 1);
#pragma warning(suppress: 26446 26473 26490)
nRet = DataSources(Direction, reinterpret_cast<SQLTCHAR*>(sDSN.data()), nDSNLength + 1, &nDSNLength, reinterpret_cast<SQLTCHAR*>(sDescription.data()), nDescLength + 1, &nDescLength);
if (SQL_SUCCEEDED(nRet))
{
#pragma warning(suppress: 26489)
sDSN.resize(nDSNLength);
#pragma warning(suppress: 26489)
sDescription.resize(nDescLength);
}
else
{
#pragma warning(suppress: 26489)
sDSN.clear();
#pragma warning(suppress: 26489)
sDescription.clear();
}
}
return nRet;
}
SQLRETURN Drivers(_In_ SQLUSMALLINT fDirection, _Out_writes_opt_(cchDriverDescMax) SQLTCHAR* szDriverDesc, _In_ SQLSMALLINT cchDriverDescMax, _Out_opt_ SQLSMALLINT* pcchDriverDesc,
_Out_writes_opt_(cchDrvrAttrMax) SQLTCHAR* szDriverAttributes, _In_ SQLSMALLINT cchDrvrAttrMax, _Out_opt_ SQLSMALLINT* pcchDrvrAttr) noexcept
{
//Validate our parameters
#pragma warning(suppress: 26477)
ATLASSERT(m_h != SQL_NULL_HANDLE);
return SQLDrivers(m_h, fDirection, szDriverDesc, cchDriverDescMax, pcchDriverDesc, szDriverAttributes, cchDrvrAttrMax, pcchDrvrAttr);
}
__success(SQL_SUCCEEDED(return)) SQLRETURN Drivers(_In_ SQLUSMALLINT fDirection, _Out_ String& sDriverDesc, _Out_ std::vector<String>& attributes)
{
SQLSMALLINT nDriverDescLength{ 0 };
SQLSMALLINT nAttributesLength{ 0 };
SQLRETURN nRet{ Drivers(fDirection, nullptr, 0, &nDriverDescLength, nullptr, 0, &nAttributesLength) };
if (SQL_SUCCEEDED(nRet))
{
sDriverDesc.resize(static_cast<size_t>(nDriverDescLength) + 1);
std::vector<SQLTCHAR> sTempAttributes{ static_cast<size_t>(nAttributesLength) + 1, std::allocator<SQLTCHAR>{} };
#pragma warning(suppress: 26473 26490)
nRet = Drivers(fDirection, reinterpret_cast<SQLTCHAR*>(sDriverDesc.data()), nDriverDescLength + 1, &nDriverDescLength, sTempAttributes.data(), nAttributesLength + 1, &nAttributesLength);
if (SQL_SUCCEEDED(nRet))
{
#pragma warning(suppress: 26489)
sDriverDesc.resize(nDriverDescLength);
MultiSZToStringVector(sTempAttributes.data(), attributes);
}
else
{
#pragma warning(suppress: 26489)
sDriverDesc.clear();
}
}
return nRet;
}
SQLRETURN EndTran(_In_ SQLSMALLINT CompletionType) noexcept
{
//Validate our parameters
#pragma warning(suppress: 26477)
ATLASSERT(m_h != SQL_NULL_HANDLE);
return SQLEndTran(SQL_HANDLE_ENV, m_h, CompletionType);
}
SQLRETURN CommitTran() noexcept
{
return EndTran(SQL_COMMIT);
}
SQLRETURN RollbackTran() noexcept
{
return EndTran(SQL_ROLLBACK);
}
SQLRETURN GetAttr(_In_ SQLINTEGER Attribute, _Out_writes_(_Inexpressible_(BufferLength)) SQLPOINTER Value, _In_ SQLINTEGER BufferLength, _Out_opt_ SQLINTEGER* StringLength) noexcept
{
//Validate our parameters
#pragma warning(suppress: 26477)
ATLASSERT(m_h != SQL_NULL_HANDLE);
return SQLGetEnvAttr(m_h, Attribute, Value, BufferLength, StringLength);
}
SQLRETURN GetAttr(_In_ SQLINTEGER Attribute, _Out_ SQLINTEGER& nValue) noexcept
{
return GetAttr(Attribute, &nValue, SQL_IS_INTEGER, nullptr);
}
SQLRETURN GetAttrU(_In_ SQLINTEGER Attribute, _Out_ SQLUINTEGER& nValue) noexcept
{
return GetAttr(Attribute, &nValue, SQL_IS_UINTEGER, nullptr);
}
SQLRETURN SetAttr(_In_ SQLINTEGER Attribute, _In_reads_bytes_opt_(StringLength) SQLPOINTER Value, _In_ SQLINTEGER StringLength) noexcept
{
//Validate our parameters
#pragma warning(suppress: 26477)
ATLASSERT(m_h != SQL_NULL_HANDLE);
return SQLSetEnvAttr(m_h, Attribute, Value, StringLength);
}
SQLRETURN SetAttr(_In_ SQLINTEGER Attribute, _In_ SQLINTEGER nValue) noexcept
{
#pragma warning(suppress : 4312 26490)
return SetAttr(Attribute, reinterpret_cast<SQLPOINTER>(nValue), SQL_IS_INTEGER);
}
SQLRETURN SetAttrU(_In_ SQLINTEGER Attribute, _In_ SQLUINTEGER nValue) noexcept
{
#pragma warning(suppress : 4312 26490)
return SetAttr(Attribute, reinterpret_cast<SQLPOINTER>(nValue), SQL_IS_UINTEGER);
}
};
//Class which encapsulates an ODBC connection handle
class CConnection : public CHandle
{
public:
//Methods
#pragma warning(suppress: 26434)
SQLRETURN Create(_In_ const CEnvironment& environment) noexcept
{
//Delegate to the base class
return __super::Create(SQL_HANDLE_DBC, environment);
}
#pragma warning(suppress: 26434)
void Attach(_In_ SQLHANDLE h) noexcept
{
__super::Attach(SQL_HANDLE_DBC, h);
}
SQLRETURN BrowseConnect(_In_reads_(cchConnStrIn) SQLTCHAR* szConnStrIn, _In_ SQLSMALLINT cchConnStrIn, _Out_writes_opt_(cchConnStrOutMax) SQLTCHAR* szConnStrOut, _In_ SQLSMALLINT cchConnStrOutMax, _Out_opt_ SQLSMALLINT* pcchConnStrOut) noexcept
{
//Validate our parameters
#pragma warning(suppress: 26477)
ATLASSUME(m_h != SQL_NULL_HANDLE);
return SQLBrowseConnect(m_h, szConnStrIn, cchConnStrIn, szConnStrOut, cchConnStrOutMax, pcchConnStrOut);
}
__success(SQL_SUCCEEDED(return)) SQLRETURN BrowseConnect(_In_opt_z_ TCHAR* szConnStrIn, _Out_ String& sConnStrOut)
{
SQLSMALLINT nStringLength{ 0 };
#pragma warning(suppress: 26473 26490)
SQLRETURN nRet{ BrowseConnect(reinterpret_cast<SQLTCHAR*>(szConnStrIn), SQL_NTS, nullptr, 0, &nStringLength) };
if (SQL_SUCCEEDED(nRet))
{
sConnStrOut.resize(static_cast<size_t>(nStringLength) + 1);
#pragma warning(suppress: 26446 26473 26490)
nRet = BrowseConnect(reinterpret_cast<SQLTCHAR*>(szConnStrIn), SQL_NTS, reinterpret_cast<SQLTCHAR*>(sConnStrOut.data()), nStringLength + 1, &nStringLength);
if (SQL_SUCCEEDED(nRet))
{
#pragma warning(suppress: 26489)
sConnStrOut.resize(nStringLength);
}
else
{
#pragma warning(suppress: 26489)
sConnStrOut.clear();
}
}
return nRet;
}
SQLRETURN Connect(_In_reads_(cchDSN) SQLTCHAR* szDSN, _In_ SQLSMALLINT cchDSN, _In_reads_(cchUID) SQLTCHAR* szUID, _In_ SQLSMALLINT cchUID, _In_reads_(cchAuthStr) SQLTCHAR* szAuthStr, _In_ SQLSMALLINT cchAuthStr) noexcept
{
//Validate our parameters
#pragma warning(suppress: 26477)
ATLASSUME(m_h != SQL_NULL_HANDLE);
return SQLConnect(m_h, szDSN, cchDSN, szUID, cchUID, szAuthStr, cchAuthStr);
}
SQLRETURN Connect(_In_opt_z_ TCHAR* ServerName, _In_opt_z_ TCHAR* UserName, _In_opt_z_ TCHAR* Authentication) noexcept
{
//Validate our parameters
#pragma warning(suppress: 26477)
ATLASSUME(m_h != SQL_NULL_HANDLE);
#pragma warning(suppress: 26473 26490)
return Connect(reinterpret_cast<SQLTCHAR*>(ServerName), SQL_NTS, reinterpret_cast<SQLTCHAR*>(UserName), SQL_NTS, reinterpret_cast<SQLTCHAR*>(Authentication), SQL_NTS);
}
SQLRETURN DriverConnect(_In_opt_ SQLHWND hWnd, _In_reads_(cchConnStrIn) SQLTCHAR* szConnStrIn, _In_ SQLSMALLINT cchConnStrIn, _Out_writes_opt_(cchConnStrOutMax) SQLTCHAR* szConnStrOut, _In_ SQLSMALLINT cchConnStrOutMax,
_Out_opt_ SQLSMALLINT* pcchConnStrOut, _In_ SQLUSMALLINT fDriverCompletion) noexcept
{
//Validate our parameters
#pragma warning(suppress: 26477)
ATLASSUME(m_h != SQL_NULL_HANDLE);
return SQLDriverConnect(m_h, hWnd, szConnStrIn, cchConnStrIn, szConnStrOut, cchConnStrOutMax, pcchConnStrOut, fDriverCompletion);
}
__success(SQL_SUCCEEDED(return)) SQLRETURN DriverConnect(_In_z_ SQLTCHAR* szConnStrIn, _Inout_ String& sConnStrOut, _In_opt_ SQLHWND hWnd = nullptr, _In_ SQLUSMALLINT fDriverCompletion = SQL_DRIVER_NOPROMPT)
{
ATL::CAtlString sTempConnStrOut;
SQLSMALLINT nOutConnectionLength{ 0 };
#pragma warning(suppress: 26472 26473 26490)
const SQLRETURN nRet{ DriverConnect(hWnd, szConnStrIn, static_cast<SQLSMALLINT>(_tcslen(reinterpret_cast<TCHAR*>(szConnStrIn))), reinterpret_cast<SQLTCHAR*>(sTempConnStrOut.GetBuffer(4096)), 4096, &nOutConnectionLength, fDriverCompletion) };
sTempConnStrOut.ReleaseBuffer();
if (SQL_SUCCEEDED(nRet))
sConnStrOut = sTempConnStrOut;
return nRet;
}
SQLRETURN Disconnect() noexcept
{
//Validate our parameters
#pragma warning(suppress: 26477)
ATLASSUME(m_h != SQL_NULL_HANDLE);
return SQLDisconnect(m_h);
}
SQLRETURN EndTran(_In_ SQLSMALLINT CompletionType) noexcept
{
//Validate our parameters
#pragma warning(suppress: 26477)
ATLASSERT(m_h != SQL_NULL_HANDLE);
return SQLEndTran(SQL_HANDLE_DBC, m_h, CompletionType);
}
SQLRETURN CommitTran() noexcept
{
return EndTran(SQL_COMMIT);
}
SQLRETURN RollbackTran() noexcept
{
return EndTran(SQL_ROLLBACK);
}
SQLRETURN GetAttr(_In_ SQLINTEGER fAttribute, _Out_writes_opt_(_Inexpressible_(cbValueMax)) SQLPOINTER rgbValue, _In_ SQLINTEGER cbValueMax, _Out_opt_ SQLINTEGER* pcbValue) noexcept
{
//Validate our parameters
#pragma warning(suppress: 26477)
ATLASSERT(m_h != SQL_NULL_HANDLE);
return SQLGetConnectAttr(m_h, fAttribute, rgbValue, cbValueMax, pcbValue);
}
SQLRETURN GetAttr(_In_ SQLINTEGER fAttribute, _Out_ SQLINTEGER& nValue) noexcept
{
return GetAttr(fAttribute, &nValue, SQL_IS_INTEGER, nullptr);
}
SQLRETURN GetAttrU(_In_ SQLINTEGER fAttribute, _Out_ SQLUINTEGER& nValue) noexcept
{
return GetAttr(fAttribute, &nValue, SQL_IS_UINTEGER, nullptr);
}