-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathSystem.Data.SQLite.xml
4254 lines (4249 loc) · 208 KB
/
System.Data.SQLite.xml
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
<?xml version="1.0"?>
<doc>
<assembly>
<name>System.Data.SQLite</name>
</assembly>
<members>
<member name="T:System.Data.SQLite.SQLite3">
<summary>
This class implements SQLiteBase completely, and is the guts of the code that interop's SQLite with .NET
</summary>
</member>
<member name="T:System.Data.SQLite.SQLiteBase">
<summary>
This internal class provides the foundation of SQLite support. It defines all the abstract members needed to implement
a SQLite data provider, and inherits from SQLiteConvert which allows for simple translations of string to and from SQLite.
</summary>
</member>
<member name="T:System.Data.SQLite.SQLiteConvert">
<summary>
This base class provides datatype conversion services for the SQLite provider.
</summary>
</member>
<member name="F:System.Data.SQLite.SQLiteConvert.FullFormat">
<summary>
The format string for DateTime values when using the InvariantCulture or CurrentCulture formats.
</summary>
</member>
<member name="F:System.Data.SQLite.SQLiteConvert.UnixEpoch">
<summary>
The value for the Unix epoch (e.g. January 1, 1970 at midnight, in UTC).
</summary>
</member>
<member name="F:System.Data.SQLite.SQLiteConvert.OleAutomationEpochAsJulianDay">
<summary>
The value of the OLE Automation epoch represented as a Julian day.
</summary>
</member>
<member name="F:System.Data.SQLite.SQLiteConvert._datetimeFormats">
<summary>
An array of ISO8601 datetime formats we support conversion from
</summary>
</member>
<member name="F:System.Data.SQLite.SQLiteConvert._utf8">
<summary>
An UTF-8 Encoding instance, so we can convert strings to and from UTF-8
</summary>
</member>
<member name="F:System.Data.SQLite.SQLiteConvert._datetimeFormat">
<summary>
The default DateTime format for this instance
</summary>
</member>
<member name="F:System.Data.SQLite.SQLiteConvert._datetimeKind">
<summary>
The default DateTimeKind for this instance.
</summary>
</member>
<member name="M:System.Data.SQLite.SQLiteConvert.#ctor(System.Data.SQLite.SQLiteDateFormats,System.DateTimeKind)">
<summary>
Initializes the conversion class
</summary>
<param name="fmt">The default date/time format to use for this instance</param>
<param name="kind">The DateTimeKind to use.</param>
</member>
<member name="M:System.Data.SQLite.SQLiteConvert.ToUTF8(System.String)">
<summary>
Converts a string to a UTF-8 encoded byte array sized to include a null-terminating character.
</summary>
<param name="sourceText">The string to convert to UTF-8</param>
<returns>A byte array containing the converted string plus an extra 0 terminating byte at the end of the array.</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConvert.ToUTF8(System.DateTime)">
<summary>
Convert a DateTime to a UTF-8 encoded, zero-terminated byte array.
</summary>
<remarks>
This function is a convenience function, which first calls ToString() on the DateTime, and then calls ToUTF8() with the
string result.
</remarks>
<param name="dateTimeValue">The DateTime to convert.</param>
<returns>The UTF-8 encoded string, including a 0 terminating byte at the end of the array.</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConvert.ToString(System.IntPtr,System.Int32)">
<summary>
Converts a UTF-8 encoded IntPtr of the specified length into a .NET string
</summary>
<param name="nativestring">The pointer to the memory where the UTF-8 string is encoded</param>
<param name="nativestringlen">The number of bytes to decode</param>
<returns>A string containing the translated character(s)</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConvert.UTF8ToString(System.IntPtr,System.Int32)">
<summary>
Converts a UTF-8 encoded IntPtr of the specified length into a .NET string
</summary>
<param name="nativestring">The pointer to the memory where the UTF-8 string is encoded</param>
<param name="nativestringlen">The number of bytes to decode</param>
<returns>A string containing the translated character(s)</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConvert.ToDateTime(System.String)">
<summary>
Converts a string into a DateTime, using the current DateTimeFormat specified for the connection when it was opened.
</summary>
<remarks>
Acceptable ISO8601 DateTime formats are:
<list type="bullet">
<item><description>THHmmssK</description></item>
<item><description>THHmmK</description></item>
<item><description>HH:mm:ss.FFFFFFFK</description></item>
<item><description>HH:mm:ssK</description></item>
<item><description>HH:mmK</description></item>
<item><description>yyyy-MM-dd HH:mm:ss.FFFFFFFK</description></item>
<item><description>yyyy-MM-dd HH:mm:ssK</description></item>
<item><description>yyyy-MM-dd HH:mmK</description></item>
<item><description>yyyy-MM-ddTHH:mm:ss.FFFFFFFK</description></item>
<item><description>yyyy-MM-ddTHH:mmK</description></item>
<item><description>yyyy-MM-ddTHH:mm:ssK</description></item>
<item><description>yyyyMMddHHmmssK</description></item>
<item><description>yyyyMMddHHmmK</description></item>
<item><description>yyyyMMddTHHmmssFFFFFFFK</description></item>
<item><description>THHmmss</description></item>
<item><description>THHmm</description></item>
<item><description>HH:mm:ss.FFFFFFF</description></item>
<item><description>HH:mm:ss</description></item>
<item><description>HH:mm</description></item>
<item><description>yyyy-MM-dd HH:mm:ss.FFFFFFF</description></item>
<item><description>yyyy-MM-dd HH:mm:ss</description></item>
<item><description>yyyy-MM-dd HH:mm</description></item>
<item><description>yyyy-MM-ddTHH:mm:ss.FFFFFFF</description></item>
<item><description>yyyy-MM-ddTHH:mm</description></item>
<item><description>yyyy-MM-ddTHH:mm:ss</description></item>
<item><description>yyyyMMddHHmmss</description></item>
<item><description>yyyyMMddHHmm</description></item>
<item><description>yyyyMMddTHHmmssFFFFFFF</description></item>
<item><description>yyyy-MM-dd</description></item>
<item><description>yyyyMMdd</description></item>
<item><description>yy-MM-dd</description></item>
</list>
If the string cannot be matched to one of the above formats, an exception will be thrown.
</remarks>
<param name="dateText">The string containing either a long integer number of 100-nanosecond units since
System.DateTime.MinValue, a Julian day double, an integer number of seconds since the Unix epoch, a
culture-independent formatted date and time string, a formatted date and time string in the current
culture, or an ISO8601-format string.</param>
<returns>A DateTime value</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConvert.ToDateTime(System.String,System.Data.SQLite.SQLiteDateFormats,System.DateTimeKind)">
<summary>
Converts a string into a DateTime, using the specified DateTimeFormat and DateTimeKind.
</summary>
<remarks>
Acceptable ISO8601 DateTime formats are:
<list type="bullet">
<item><description>THHmmssK</description></item>
<item><description>THHmmK</description></item>
<item><description>HH:mm:ss.FFFFFFFK</description></item>
<item><description>HH:mm:ssK</description></item>
<item><description>HH:mmK</description></item>
<item><description>yyyy-MM-dd HH:mm:ss.FFFFFFFK</description></item>
<item><description>yyyy-MM-dd HH:mm:ssK</description></item>
<item><description>yyyy-MM-dd HH:mmK</description></item>
<item><description>yyyy-MM-ddTHH:mm:ss.FFFFFFFK</description></item>
<item><description>yyyy-MM-ddTHH:mmK</description></item>
<item><description>yyyy-MM-ddTHH:mm:ssK</description></item>
<item><description>yyyyMMddHHmmssK</description></item>
<item><description>yyyyMMddHHmmK</description></item>
<item><description>yyyyMMddTHHmmssFFFFFFFK</description></item>
<item><description>THHmmss</description></item>
<item><description>THHmm</description></item>
<item><description>HH:mm:ss.FFFFFFF</description></item>
<item><description>HH:mm:ss</description></item>
<item><description>HH:mm</description></item>
<item><description>yyyy-MM-dd HH:mm:ss.FFFFFFF</description></item>
<item><description>yyyy-MM-dd HH:mm:ss</description></item>
<item><description>yyyy-MM-dd HH:mm</description></item>
<item><description>yyyy-MM-ddTHH:mm:ss.FFFFFFF</description></item>
<item><description>yyyy-MM-ddTHH:mm</description></item>
<item><description>yyyy-MM-ddTHH:mm:ss</description></item>
<item><description>yyyyMMddHHmmss</description></item>
<item><description>yyyyMMddHHmm</description></item>
<item><description>yyyyMMddTHHmmssFFFFFFF</description></item>
<item><description>yyyy-MM-dd</description></item>
<item><description>yyyyMMdd</description></item>
<item><description>yy-MM-dd</description></item>
</list>
If the string cannot be matched to one of the above formats, an exception will be thrown.
</remarks>
<param name="dateText">The string containing either a long integer number of 100-nanosecond units since
System.DateTime.MinValue, a Julian day double, an integer number of seconds since the Unix epoch, a
culture-independent formatted date and time string, a formatted date and time string in the current
culture, or an ISO8601-format string.</param>
<param name="format">The SQLiteDateFormats to use.</param>
<param name="kind">The DateTimeKind to use.</param>
<returns>A DateTime value</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConvert.ToDateTime(System.Double)">
<summary>
Converts a julianday value into a DateTime
</summary>
<param name="julianDay">The value to convert</param>
<returns>A .NET DateTime</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConvert.ToDateTime(System.Double,System.DateTimeKind)">
<summary>
Converts a julianday value into a DateTime
</summary>
<param name="julianDay">The value to convert</param>
<param name="kind">The DateTimeKind to use.</param>
<returns>A .NET DateTime</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConvert.ToJulianDay(System.DateTime)">
<summary>
Converts a DateTime struct to a JulianDay double
</summary>
<param name="value">The DateTime to convert</param>
<returns>The JulianDay value the Datetime represents</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConvert.ToString(System.DateTime)">
<summary>
Converts a DateTime to a string value, using the current DateTimeFormat specified for the connection when it was opened.
</summary>
<param name="dateValue">The DateTime value to convert</param>
<returns>Either a string containing the long integer number of 100-nanosecond units since System.DateTime.MinValue, a
Julian day double, an integer number of seconds since the Unix epoch, a culture-independent formatted date and time
string, a formatted date and time string in the current culture, or an ISO8601-format date/time string.</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConvert.ToDateTime(System.IntPtr,System.Int32)">
<summary>
Internal function to convert a UTF-8 encoded IntPtr of the specified length to a DateTime.
</summary>
<remarks>
This is a convenience function, which first calls ToString() on the IntPtr to convert it to a string, then calls
ToDateTime() on the string to return a DateTime.
</remarks>
<param name="ptr">A pointer to the UTF-8 encoded string</param>
<param name="len">The length in bytes of the string</param>
<returns>The parsed DateTime value</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConvert.Split(System.String,System.Char)">
<summary>
Smart method of splitting a string. Skips quoted elements, removes the quotes.
</summary>
<remarks>
This split function works somewhat like the String.Split() function in that it breaks apart a string into
pieces and returns the pieces as an array. The primary differences are:
<list type="bullet">
<item><description>Only one character can be provided as a separator character</description></item>
<item><description>Quoted text inside the string is skipped over when searching for the separator, and the quotes are removed.</description></item>
</list>
Thus, if splitting the following string looking for a comma:<br/>
One,Two, "Three, Four", Five<br/>
<br/>
The resulting array would contain<br/>
[0] One<br/>
[1] Two<br/>
[2] Three, Four<br/>
[3] Five<br/>
<br/>
Note that the leading and trailing spaces were removed from each item during the split.
</remarks>
<param name="source">Source string to split apart</param>
<param name="separator">Separator character</param>
<returns>A string array of the split up elements</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConvert.ToBoolean(System.Object)">
<summary>
Convert a value to true or false.
</summary>
<param name="source">A string or number representing true or false</param>
<returns></returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConvert.ToBoolean(System.String)">
<summary>
Convert a string to true or false.
</summary>
<param name="source">A string representing true or false</param>
<returns></returns>
<remarks>
"yes", "no", "y", "n", "0", "1", "on", "off" as well as Boolean.FalseString and Boolean.TrueString will all be
converted to a proper boolean value.
</remarks>
</member>
<member name="M:System.Data.SQLite.SQLiteConvert.ColumnToType(System.Data.SQLite.SQLiteStatement,System.Int32,System.Data.SQLite.SQLiteType)">
<summary>
Determines the data type of a column in a statement
</summary>
<param name="stmt">The statement to retrieve information for</param>
<param name="i">The column to retrieve type information on</param>
<param name="typ">The SQLiteType to receive the affinity for the given column</param>
</member>
<member name="M:System.Data.SQLite.SQLiteConvert.SQLiteTypeToType(System.Data.SQLite.SQLiteType)">
<summary>
Converts a SQLiteType to a .NET Type object
</summary>
<param name="t">The SQLiteType to convert</param>
<returns>Returns a .NET Type object</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConvert.TypeToDbType(System.Type)">
<summary>
For a given intrinsic type, return a DbType
</summary>
<param name="typ">The native type to convert</param>
<returns>The corresponding (closest match) DbType</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConvert.DbTypeToColumnSize(System.Data.DbType)">
<summary>
Returns the ColumnSize for the given DbType
</summary>
<param name="typ">The DbType to get the size of</param>
<returns></returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConvert.DbTypeToType(System.Data.DbType)">
<summary>
Convert a DbType to a Type
</summary>
<param name="typ">The DbType to convert from</param>
<returns>The closest-match .NET type</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConvert.TypeToAffinity(System.Type)">
<summary>
For a given type, return the closest-match SQLite TypeAffinity, which only understands a very limited subset of types.
</summary>
<param name="typ">The type to evaluate</param>
<returns>The SQLite type affinity for that type.</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConvert.TypeNameToDbType(System.String)">
<summary>
For a given type name, return a closest-match .NET type
</summary>
<param name="Name">The name of the type to match</param>
<returns>The .NET DBType the text evaluates to.</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteBase.Shutdown">
<summary>
Shutdown the SQLite engine so that it can be restarted with different config options.
We depend on auto initialization to recover.
</summary>
</member>
<member name="M:System.Data.SQLite.SQLiteBase.IsOpen">
<summary>
Returns non-zero if a database connection is open.
</summary>
<returns></returns>
</member>
<member name="M:System.Data.SQLite.SQLiteBase.Open(System.String,System.Data.SQLite.SQLiteOpenFlagsEnum,System.Int32,System.Boolean)">
<summary>
Opens a database.
</summary>
<remarks>
Implementers should call SQLiteFunction.BindFunctions() and save the array after opening a connection
to bind all attributed user-defined functions and collating sequences to the new connection.
</remarks>
<param name="strFilename">The filename of the database to open. SQLite automatically creates it if it doesn't exist.</param>
<param name="flags">The open flags to use when creating the connection</param>
<param name="maxPoolSize">The maximum size of the pool for the given filename</param>
<param name="usePool">If true, the connection can be pulled from the connection pool</param>
</member>
<member name="M:System.Data.SQLite.SQLiteBase.Close">
<summary>
Closes the currently-open database.
</summary>
<remarks>
After the database has been closed implemeters should call SQLiteFunction.UnbindFunctions() to deallocate all interop allocated
memory associated with the user-defined functions and collating sequences tied to the closed connection.
</remarks>
</member>
<member name="M:System.Data.SQLite.SQLiteBase.SetTimeout(System.Int32)">
<summary>
Sets the busy timeout on the connection. SQLiteCommand will call this before executing any command.
</summary>
<param name="nTimeoutMS">The number of milliseconds to wait before returning SQLITE_BUSY</param>
</member>
<member name="M:System.Data.SQLite.SQLiteBase.SQLiteLastError">
<summary>
Returns the text of the last error issued by SQLite
</summary>
<returns></returns>
</member>
<member name="M:System.Data.SQLite.SQLiteBase.ClearPool">
<summary>
When pooling is enabled, force this connection to be disposed rather than returned to the pool
</summary>
</member>
<member name="M:System.Data.SQLite.SQLiteBase.Prepare(System.Data.SQLite.SQLiteConnection,System.String,System.Data.SQLite.SQLiteStatement,System.UInt32,System.String@)">
<summary>
Prepares a SQL statement for execution.
</summary>
<param name="cnn">The source connection preparing the command. Can be null for any caller except LINQ</param>
<param name="strSql">The SQL command text to prepare</param>
<param name="previous">The previous statement in a multi-statement command, or null if no previous statement exists</param>
<param name="timeoutMS">The timeout to wait before aborting the prepare</param>
<param name="strRemain">The remainder of the statement that was not processed. Each call to prepare parses the
SQL up to to either the end of the text or to the first semi-colon delimiter. The remaining text is returned
here for a subsequent call to Prepare() until all the text has been processed.</param>
<returns>Returns an initialized SQLiteStatement.</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteBase.Step(System.Data.SQLite.SQLiteStatement)">
<summary>
Steps through a prepared statement.
</summary>
<param name="stmt">The SQLiteStatement to step through</param>
<returns>True if a row was returned, False if not.</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteBase.Reset(System.Data.SQLite.SQLiteStatement)">
<summary>
Resets a prepared statement so it can be executed again. If the error returned is SQLITE_SCHEMA,
transparently attempt to rebuild the SQL statement and throw an error if that was not possible.
</summary>
<param name="stmt">The statement to reset</param>
<returns>Returns -1 if the schema changed while resetting, 0 if the reset was sucessful or 6 (SQLITE_LOCKED) if the reset failed due to a lock</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteBase.SetExtendedResultCodes(System.Boolean)">
<summary>
Enables or disabled extened result codes returned by SQLite
</summary>
<param name="bOnOff">true to enable extended result codes, false to disable.</param>
<returns></returns>
</member>
<member name="M:System.Data.SQLite.SQLiteBase.ResultCode">
<summary>
Returns the numeric result code for the most recent failed SQLite API call
associated with the database connection.
</summary>
<returns>Result code</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteBase.ExtendedResultCode">
<summary>
Returns the extended numeric result code for the most recent failed SQLite API call
associated with the database connection.
</summary>
<returns>Extended result code</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteBase.LogMessage(System.Int32,System.String)">
<summary>
Add a log message via the SQLite sqlite3_log interface.
</summary>
<param name="iErrCode">Error code to be logged with the message.</param>
<param name="zMessage">String to be logged. Unlike the SQLite sqlite3_log()
interface, this should be pre-formatted. Consider using the
String.Format() function.</param>
<returns></returns>
</member>
<member name="P:System.Data.SQLite.SQLiteBase.Version">
<summary>
Returns a string representing the active version of SQLite
</summary>
</member>
<member name="P:System.Data.SQLite.SQLiteBase.LastInsertRowId">
<summary>
Returns the rowid of the most recent successful INSERT into the database from this connection.
</summary>
</member>
<member name="P:System.Data.SQLite.SQLiteBase.Changes">
<summary>
Returns the number of changes the last executing insert/update caused.
</summary>
</member>
<member name="P:System.Data.SQLite.SQLiteBase.MemoryUsed">
<summary>
Returns the amount of memory (in bytes) currently in use by the SQLite core library.
</summary>
</member>
<member name="P:System.Data.SQLite.SQLiteBase.MemoryHighwater">
<summary>
Returns the maximum amount of memory (in bytes) used by the SQLite core library since the high-water mark was last reset.
</summary>
</member>
<member name="F:System.Data.SQLite.SQLite3._sql">
<summary>
The opaque pointer returned to us by the sqlite provider
</summary>
</member>
<member name="F:System.Data.SQLite.SQLite3._functionsArray">
<summary>
The user-defined functions registered on this connection
</summary>
</member>
<member name="M:System.Data.SQLite.SQLite3.Shutdown">
<summary>
Shutdown the SQLite engine so that it can be restarted with different config options.
We depend on auto initialization to recover.
</summary>
<returns>Returns a result code</returns>
</member>
<member name="M:System.Data.SQLite.SQLite3.SetExtendedResultCodes(System.Boolean)">
Enables or disabled extended result codes returned by SQLite
</member>
<member name="M:System.Data.SQLite.SQLite3.ResultCode">
Gets the last SQLite error code
</member>
<member name="M:System.Data.SQLite.SQLite3.ExtendedResultCode">
Gets the last SQLite extended error code
</member>
<member name="M:System.Data.SQLite.SQLite3.LogMessage(System.Int32,System.String)">
Add a log message via the SQLite sqlite3_log interface.
</member>
<member name="M:System.Data.SQLite.SQLite3.SetLogCallback(System.Data.SQLite.SQLiteLogCallback)">
<summary>
Allows the setting of a logging callback invoked by SQLite when a
log event occurs. Only one callback may be set. If NULL is passed,
the logging callback is unregistered.
</summary>
<param name="func">The callback function to invoke.</param>
<returns>Returns a result code</returns>
</member>
<member name="M:System.Data.SQLite.SQLite3.IsInitialized">
<summary>
Determines if the SQLite core library has been initialized for the
current process.
</summary>
<returns>
A boolean indicating whether or not the SQLite core library has been
initialized for the current process.
</returns>
</member>
<member name="M:System.Data.SQLite.SQLite3.StaticIsInitialized">
<summary>
Determines if the SQLite core library has been initialized for the
current process.
</summary>
<returns>
A boolean indicating whether or not the SQLite core library has been
initialized for the current process.
</returns>
</member>
<member name="M:System.Data.SQLite.SQLite3.GetValue(System.Data.SQLite.SQLiteStatement,System.Int32,System.Data.SQLite.SQLiteType)">
<summary>
Helper function to retrieve a column of data from an active statement.
</summary>
<param name="stmt">The statement being step()'d through</param>
<param name="index">The column index to retrieve</param>
<param name="typ">The type of data contained in the column. If Uninitialized, this function will retrieve the datatype information.</param>
<returns>Returns the data in the column</returns>
</member>
<member name="T:System.Data.SQLite.SQLite3_UTF16">
<summary>
Alternate SQLite3 object, overriding many text behaviors to support UTF-16 (Unicode)
</summary>
</member>
<member name="M:System.Data.SQLite.SQLite3_UTF16.ToString(System.IntPtr,System.Int32)">
<summary>
Overrides SQLiteConvert.ToString() to marshal UTF-16 strings instead of UTF-8
</summary>
<param name="b">A pointer to a UTF-16 string</param>
<param name="nbytelen">The length (IN BYTES) of the string</param>
<returns>A .NET string</returns>
</member>
<member name="T:System.Data.SQLite.SQLiteConnectionFlags">
<summary>
The extra behavioral flags that can be applied to a connection.
</summary>
</member>
<member name="F:System.Data.SQLite.SQLiteConnectionFlags.None">
<summary>
No extra flags.
</summary>
</member>
<member name="F:System.Data.SQLite.SQLiteConnectionFlags.LogPrepare">
<summary>
Enable logging of all SQL statements to be prepared.
</summary>
</member>
<member name="F:System.Data.SQLite.SQLiteConnectionFlags.Default">
<summary>
The default extra flags for new connections.
</summary>
</member>
<member name="T:System.Data.SQLite.SQLiteCommand">
<summary>
SQLite implementation of DbCommand.
</summary>
</member>
<member name="F:System.Data.SQLite.SQLiteCommand._commandText">
<summary>
The command text this command is based on
</summary>
</member>
<member name="F:System.Data.SQLite.SQLiteCommand._cnn">
<summary>
The connection the command is associated with
</summary>
</member>
<member name="F:System.Data.SQLite.SQLiteCommand._version">
<summary>
The version of the connection the command is associated with
</summary>
</member>
<member name="F:System.Data.SQLite.SQLiteCommand._activeReader">
<summary>
Indicates whether or not a DataReader is active on the command.
</summary>
</member>
<member name="F:System.Data.SQLite.SQLiteCommand._commandTimeout">
<summary>
The timeout for the command, kludged because SQLite doesn't support per-command timeout values
</summary>
</member>
<member name="F:System.Data.SQLite.SQLiteCommand._designTimeVisible">
<summary>
Designer support
</summary>
</member>
<member name="F:System.Data.SQLite.SQLiteCommand._updateRowSource">
<summary>
Used by DbDataAdapter to determine updating behavior
</summary>
</member>
<member name="F:System.Data.SQLite.SQLiteCommand._parameterCollection">
<summary>
The collection of parameters for the command
</summary>
</member>
<member name="F:System.Data.SQLite.SQLiteCommand._statementList">
<summary>
The SQL command text, broken into individual SQL statements as they are executed
</summary>
</member>
<member name="F:System.Data.SQLite.SQLiteCommand._remainingText">
<summary>
Unprocessed SQL text that has not been executed
</summary>
</member>
<member name="F:System.Data.SQLite.SQLiteCommand._transaction">
<summary>
Transaction associated with this command
</summary>
</member>
<member name="M:System.Data.SQLite.SQLiteCommand.#ctor">
<overloads>
Constructs a new SQLiteCommand
</overloads>
<summary>
Default constructor
</summary>
</member>
<member name="M:System.Data.SQLite.SQLiteCommand.#ctor(System.String)">
<summary>
Initializes the command with the given command text
</summary>
<param name="commandText">The SQL command text</param>
</member>
<member name="M:System.Data.SQLite.SQLiteCommand.#ctor(System.String,System.Data.SQLite.SQLiteConnection)">
<summary>
Initializes the command with the given SQL command text and attach the command to the specified
connection.
</summary>
<param name="commandText">The SQL command text</param>
<param name="connection">The connection to associate with the command</param>
</member>
<member name="M:System.Data.SQLite.SQLiteCommand.#ctor(System.Data.SQLite.SQLiteConnection)">
<summary>
Initializes the command and associates it with the specified connection.
</summary>
<param name="connection">The connection to associate with the command</param>
</member>
<member name="M:System.Data.SQLite.SQLiteCommand.#ctor(System.String,System.Data.SQLite.SQLiteConnection,System.Data.SQLite.SQLiteTransaction)">
<summary>
Initializes a command with the given SQL, connection and transaction
</summary>
<param name="commandText">The SQL command text</param>
<param name="connection">The connection to associate with the command</param>
<param name="transaction">The transaction the command should be associated with</param>
</member>
<member name="M:System.Data.SQLite.SQLiteCommand.Dispose(System.Boolean)">
<summary>
Disposes of the command and clears all member variables
</summary>
<param name="disposing">Whether or not the class is being explicitly or implicitly disposed</param>
</member>
<member name="M:System.Data.SQLite.SQLiteCommand.ClearCommands">
<summary>
Clears and destroys all statements currently prepared
</summary>
</member>
<member name="M:System.Data.SQLite.SQLiteCommand.BuildNextCommand">
<summary>
Builds an array of prepared statements for each complete SQL statement in the command text
</summary>
</member>
<member name="M:System.Data.SQLite.SQLiteCommand.Cancel">
<summary>
Not implemented
</summary>
</member>
<member name="M:System.Data.SQLite.SQLiteCommand.CreateDbParameter">
<summary>
Forwards to the local CreateParameter() function
</summary>
<returns></returns>
</member>
<member name="M:System.Data.SQLite.SQLiteCommand.CreateParameter">
<summary>
Create a new parameter
</summary>
<returns></returns>
</member>
<member name="M:System.Data.SQLite.SQLiteCommand.InitializeForReader">
<summary>
This function ensures there are no active readers, that we have a valid connection,
that the connection is open, that all statements are prepared and all parameters are assigned
in preparation for allocating a data reader.
</summary>
</member>
<member name="M:System.Data.SQLite.SQLiteCommand.ExecuteDbDataReader(System.Data.CommandBehavior)">
<summary>
Creates a new SQLiteDataReader to execute/iterate the array of SQLite prepared statements
</summary>
<param name="behavior">The behavior the data reader should adopt</param>
<returns>Returns a SQLiteDataReader object</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteCommand.ExecuteReader(System.Data.CommandBehavior)">
<summary>
Overrides the default behavior to return a SQLiteDataReader specialization class
</summary>
<param name="behavior">The flags to be associated with the reader</param>
<returns>A SQLiteDataReader</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteCommand.ExecuteReader">
<summary>
Overrides the default behavior of DbDataReader to return a specialized SQLiteDataReader class
</summary>
<returns>A SQLiteDataReader</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteCommand.ClearDataReader">
<summary>
Called by the SQLiteDataReader when the data reader is closed.
</summary>
</member>
<member name="M:System.Data.SQLite.SQLiteCommand.ExecuteNonQuery">
<summary>
Execute the command and return the number of rows inserted/updated affected by it.
</summary>
<returns></returns>
</member>
<member name="M:System.Data.SQLite.SQLiteCommand.ExecuteScalar">
<summary>
Execute the command and return the first column of the first row of the resultset
(if present), or null if no resultset was returned.
</summary>
<returns>The first column of the first row of the first resultset from the query</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteCommand.Prepare">
<summary>
Does nothing. Commands are prepared as they are executed the first time, and kept in prepared state afterwards.
</summary>
</member>
<member name="M:System.Data.SQLite.SQLiteCommand.Clone">
<summary>
Clones a command, including all its parameters
</summary>
<returns>A new SQLiteCommand with the same commandtext, connection and parameters</returns>
</member>
<member name="P:System.Data.SQLite.SQLiteCommand.CommandText">
<summary>
The SQL command text associated with the command
</summary>
</member>
<member name="P:System.Data.SQLite.SQLiteCommand.CommandTimeout">
<summary>
The amount of time to wait for the connection to become available before erroring out
</summary>
</member>
<member name="P:System.Data.SQLite.SQLiteCommand.CommandType">
<summary>
The type of the command. SQLite only supports CommandType.Text
</summary>
</member>
<member name="P:System.Data.SQLite.SQLiteCommand.Connection">
<summary>
The connection associated with this command
</summary>
</member>
<member name="P:System.Data.SQLite.SQLiteCommand.DbConnection">
<summary>
Forwards to the local Connection property
</summary>
</member>
<member name="P:System.Data.SQLite.SQLiteCommand.Parameters">
<summary>
Returns the SQLiteParameterCollection for the given command
</summary>
</member>
<member name="P:System.Data.SQLite.SQLiteCommand.DbParameterCollection">
<summary>
Forwards to the local Parameters property
</summary>
</member>
<member name="P:System.Data.SQLite.SQLiteCommand.Transaction">
<summary>
The transaction associated with this command. SQLite only supports one transaction per connection, so this property forwards to the
command's underlying connection.
</summary>
</member>
<member name="P:System.Data.SQLite.SQLiteCommand.DbTransaction">
<summary>
Forwards to the local Transaction property
</summary>
</member>
<member name="P:System.Data.SQLite.SQLiteCommand.UpdatedRowSource">
<summary>
Sets the method the SQLiteCommandBuilder uses to determine how to update inserted or updated rows in a DataTable.
</summary>
</member>
<member name="P:System.Data.SQLite.SQLiteCommand.DesignTimeVisible">
<summary>
Determines if the command is visible at design time. Defaults to True.
</summary>
</member>
<member name="T:System.Data.SQLite.SQLiteCommandBuilder">
<summary>
SQLite implementation of DbCommandBuilder.
</summary>
</member>
<member name="M:System.Data.SQLite.SQLiteCommandBuilder.#ctor">
<summary>
Default constructor
</summary>
</member>
<member name="M:System.Data.SQLite.SQLiteCommandBuilder.#ctor(System.Data.SQLite.SQLiteDataAdapter)">
<summary>
Initializes the command builder and associates it with the specified data adapter.
</summary>
<param name="adp"></param>
</member>
<member name="M:System.Data.SQLite.SQLiteCommandBuilder.ApplyParameterInfo(System.Data.Common.DbParameter,System.Data.DataRow,System.Data.StatementType,System.Boolean)">
<summary>
Minimal amount of parameter processing. Primarily sets the DbType for the parameter equal to the provider type in the schema
</summary>
<param name="parameter">The parameter to use in applying custom behaviors to a row</param>
<param name="row">The row to apply the parameter to</param>
<param name="statementType">The type of statement</param>
<param name="whereClause">Whether the application of the parameter is part of a WHERE clause</param>
</member>
<member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetParameterName(System.String)">
<summary>
Returns a valid named parameter
</summary>
<param name="parameterName">The name of the parameter</param>
<returns>Error</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetParameterName(System.Int32)">
<summary>
Returns a named parameter for the given ordinal
</summary>
<param name="parameterOrdinal">The i of the parameter</param>
<returns>Error</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetParameterPlaceholder(System.Int32)">
<summary>
Returns a placeholder character for the specified parameter i.
</summary>
<param name="parameterOrdinal">The index of the parameter to provide a placeholder for</param>
<returns>Returns a named parameter</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteCommandBuilder.SetRowUpdatingHandler(System.Data.Common.DbDataAdapter)">
<summary>
Sets the handler for receiving row updating events. Used by the DbCommandBuilder to autogenerate SQL
statements that may not have previously been generated.
</summary>
<param name="adapter">A data adapter to receive events on.</param>
</member>
<member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetDeleteCommand">
<summary>
Returns the automatically-generated SQLite command to delete rows from the database
</summary>
<returns></returns>
</member>
<member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetDeleteCommand(System.Boolean)">
<summary>
Returns the automatically-generated SQLite command to delete rows from the database
</summary>
<param name="useColumnsForParameterNames"></param>
<returns></returns>
</member>
<member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetUpdateCommand">
<summary>
Returns the automatically-generated SQLite command to update rows in the database
</summary>
<returns></returns>
</member>
<member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetUpdateCommand(System.Boolean)">
<summary>
Returns the automatically-generated SQLite command to update rows in the database
</summary>
<param name="useColumnsForParameterNames"></param>
<returns></returns>
</member>
<member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetInsertCommand">
<summary>
Returns the automatically-generated SQLite command to insert rows into the database
</summary>
<returns></returns>
</member>
<member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetInsertCommand(System.Boolean)">
<summary>
Returns the automatically-generated SQLite command to insert rows into the database
</summary>
<param name="useColumnsForParameterNames"></param>
<returns></returns>
</member>
<member name="M:System.Data.SQLite.SQLiteCommandBuilder.QuoteIdentifier(System.String)">
<summary>
Places brackets around an identifier
</summary>
<param name="unquotedIdentifier">The identifier to quote</param>
<returns>The bracketed identifier</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteCommandBuilder.UnquoteIdentifier(System.String)">
<summary>
Removes brackets around an identifier
</summary>
<param name="quotedIdentifier">The quoted (bracketed) identifier</param>
<returns>The undecorated identifier</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetSchemaTable(System.Data.Common.DbCommand)">
<summary>
Override helper, which can help the base command builder choose the right keys for the given query
</summary>
<param name="sourceCommand"></param>
<returns></returns>
</member>
<member name="P:System.Data.SQLite.SQLiteCommandBuilder.DataAdapter">
<summary>
Gets/sets the DataAdapter for this CommandBuilder
</summary>
</member>
<member name="P:System.Data.SQLite.SQLiteCommandBuilder.CatalogLocation">
<summary>
Overridden to hide its property from the designer
</summary>
</member>
<member name="P:System.Data.SQLite.SQLiteCommandBuilder.CatalogSeparator">
<summary>
Overridden to hide its property from the designer
</summary>
</member>
<member name="P:System.Data.SQLite.SQLiteCommandBuilder.QuotePrefix">
<summary>
Overridden to hide its property from the designer
</summary>
</member>
<member name="P:System.Data.SQLite.SQLiteCommandBuilder.QuoteSuffix">
<summary>
Overridden to hide its property from the designer
</summary>
</member>
<member name="P:System.Data.SQLite.SQLiteCommandBuilder.SchemaSeparator">
<summary>
Overridden to hide its property from the designer
</summary>
</member>
<member name="T:System.Data.SQLite.SQLiteConnection">
<summary>
SQLite implentation of DbConnection.
</summary>
<remarks>
The <see cref="P:System.Data.SQLite.SQLiteConnection.ConnectionString">ConnectionString</see> property of the SQLiteConnection class can contain the following parameter(s), delimited with a semi-colon:
<list type="table">
<listheader>
<term>Parameter</term>
<term>Values</term>
<term>Required</term>
<term>Default</term>
</listheader>
<item>
<description>Data Source</description>
<description>{filename}</description>
<description>Y</description>
<description></description>
</item>
<item>
<description>Version</description>
<description>3</description>
<description>N</description>
<description>3</description>
</item>
<item>
<description>UseUTF16Encoding</description>
<description><b>True</b><br/><b>False</b></description>
<description>N</description>
<description>False</description>
</item>
<item>
<description>DateTimeFormat</description>
<description><b>Ticks</b> - Use DateTime.Ticks<br/><b>ISO8601</b> - Use ISO8601 DateTime format</description>
<description>N</description>
<description>ISO8601</description>
</item>
<item>
<description>DateTimeKind</description>
<description><b>Unspecified</b> - Not specified as either UTC or local time.<br/><b>Utc</b> - The time represented is UTC.<br/><b>Local</b> - The time represented is local time.</description>
<description>N</description>
<description>Unspecified</description>
</item>
<item>
<description>BaseSchemaName</description>
<description>Some base data classes in the framework (e.g. those that build SQL queries dynamically)
assume that an ADO.NET provider cannot support an alternate catalog (i.e. database) without supporting
alternate schemas as well; however, SQLite does not fit into this model. Therefore, this value is used
as a placeholder and removed prior to preparing any SQL statements that may contain it.</description>
<description>N</description>