CNAS取数仪器端升级
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

21650 lines
1.0MB

  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>System.Data.SQLite</name>
  5. </assembly>
  6. <members>
  7. <member name="T:System.Data.SQLite.AssemblySourceIdAttribute">
  8. <summary>
  9. Defines a source code identifier custom attribute for an assembly
  10. manifest.
  11. </summary>
  12. </member>
  13. <member name="M:System.Data.SQLite.AssemblySourceIdAttribute.#ctor(System.String)">
  14. <summary>
  15. Constructs an instance of this attribute class using the specified
  16. source code identifier value.
  17. </summary>
  18. <param name="value">
  19. The source code identifier value to use.
  20. </param>
  21. </member>
  22. <member name="P:System.Data.SQLite.AssemblySourceIdAttribute.SourceId">
  23. <summary>
  24. Gets the source code identifier value.
  25. </summary>
  26. </member>
  27. <member name="T:System.Data.SQLite.AssemblySourceTimeStampAttribute">
  28. <summary>
  29. Defines a source code time-stamp custom attribute for an assembly
  30. manifest.
  31. </summary>
  32. </member>
  33. <member name="M:System.Data.SQLite.AssemblySourceTimeStampAttribute.#ctor(System.String)">
  34. <summary>
  35. Constructs an instance of this attribute class using the specified
  36. source code time-stamp value.
  37. </summary>
  38. <param name="value">
  39. The source code time-stamp value to use.
  40. </param>
  41. </member>
  42. <member name="P:System.Data.SQLite.AssemblySourceTimeStampAttribute.SourceTimeStamp">
  43. <summary>
  44. Gets the source code time-stamp value.
  45. </summary>
  46. </member>
  47. <member name="T:System.Data.SQLite.SQLiteLogCallback">
  48. <summary>
  49. This is the method signature for the SQLite core library logging callback
  50. function for use with sqlite3_log() and the SQLITE_CONFIG_LOG.
  51. WARNING: This delegate is used more-or-less directly by native code, do
  52. not modify its type signature.
  53. </summary>
  54. <param name="pUserData">
  55. The extra data associated with this message, if any.
  56. </param>
  57. <param name="errorCode">
  58. The error code associated with this message.
  59. </param>
  60. <param name="pMessage">
  61. The message string to be logged.
  62. </param>
  63. </member>
  64. <member name="T:System.Data.SQLite.SQLite3">
  65. <summary>
  66. This class implements SQLiteBase completely, and is the guts of the code that interop's SQLite with .NET
  67. </summary>
  68. </member>
  69. <member name="T:System.Data.SQLite.SQLiteBase">
  70. <summary>
  71. This internal class provides the foundation of SQLite support. It defines all the abstract members needed to implement
  72. a SQLite data provider, and inherits from SQLiteConvert which allows for simple translations of string to and from SQLite.
  73. </summary>
  74. </member>
  75. <member name="T:System.Data.SQLite.SQLiteConvert">
  76. <summary>
  77. This base class provides datatype conversion services for the SQLite provider.
  78. </summary>
  79. </member>
  80. <member name="F:System.Data.SQLite.SQLiteConvert.EscapeChar">
  81. <summary>
  82. This character is used to escape other characters, including itself, in
  83. connection string property names and values.
  84. </summary>
  85. </member>
  86. <member name="F:System.Data.SQLite.SQLiteConvert.QuoteChar">
  87. <summary>
  88. This character can be used to wrap connection string property names and
  89. values. Normally, it is optional; however, when used, it must be the
  90. first -AND- last character of that connection string property name -OR-
  91. value.
  92. </summary>
  93. </member>
  94. <member name="F:System.Data.SQLite.SQLiteConvert.AltQuoteChar">
  95. <summary>
  96. This character can be used to wrap connection string property names and
  97. values. Normally, it is optional; however, when used, it must be the
  98. first -AND- last character of that connection string property name -OR-
  99. value.
  100. </summary>
  101. </member>
  102. <member name="F:System.Data.SQLite.SQLiteConvert.ValueChar">
  103. <summary>
  104. The character is used to separate the name and value for a connection
  105. string property. This character cannot be present in any connection
  106. string property name. This character can be present in a connection
  107. string property value; however, this should be avoided unless deemed
  108. absolutely necessary.
  109. </summary>
  110. </member>
  111. <member name="F:System.Data.SQLite.SQLiteConvert.PairChar">
  112. <summary>
  113. This character is used to separate connection string properties. When
  114. the "No_SQLiteConnectionNewParser" setting is enabled, this character
  115. may not appear in connection string property names -OR- values.
  116. </summary>
  117. </member>
  118. <member name="F:System.Data.SQLite.SQLiteConvert.FallbackDefaultDbType">
  119. <summary>
  120. The fallback default database type when one cannot be obtained from an
  121. existing connection instance.
  122. </summary>
  123. </member>
  124. <member name="F:System.Data.SQLite.SQLiteConvert.FullFormat">
  125. <summary>
  126. The format string for DateTime values when using the InvariantCulture or CurrentCulture formats.
  127. </summary>
  128. </member>
  129. <member name="F:System.Data.SQLite.SQLiteConvert.SpecialChars">
  130. <summary>
  131. These are the characters that are special to the connection string
  132. parser.
  133. </summary>
  134. </member>
  135. <member name="F:System.Data.SQLite.SQLiteConvert.FallbackDefaultTypeName">
  136. <summary>
  137. The fallback default database type name when one cannot be obtained from
  138. an existing connection instance.
  139. </summary>
  140. </member>
  141. <member name="F:System.Data.SQLite.SQLiteConvert.UnixEpoch">
  142. <summary>
  143. The value for the Unix epoch (e.g. January 1, 1970 at midnight, in UTC).
  144. </summary>
  145. </member>
  146. <member name="F:System.Data.SQLite.SQLiteConvert.OleAutomationEpochAsJulianDay">
  147. <summary>
  148. The value of the OLE Automation epoch represented as a Julian day. This
  149. field cannot be removed as the test suite relies upon it.
  150. </summary>
  151. </member>
  152. <member name="F:System.Data.SQLite.SQLiteConvert.MinimumJd">
  153. <summary>
  154. This is the minimum Julian Day value supported by this library
  155. (148731163200000).
  156. </summary>
  157. </member>
  158. <member name="F:System.Data.SQLite.SQLiteConvert.MaximumJd">
  159. <summary>
  160. This is the maximum Julian Day value supported by this library
  161. (464269060799000).
  162. </summary>
  163. </member>
  164. <member name="F:System.Data.SQLite.SQLiteConvert._datetimeFormats">
  165. <summary>
  166. An array of ISO-8601 DateTime formats that we support parsing.
  167. </summary>
  168. </member>
  169. <member name="F:System.Data.SQLite.SQLiteConvert._datetimeFormatUtc">
  170. <summary>
  171. The internal default format for UTC DateTime values when converting
  172. to a string.
  173. </summary>
  174. </member>
  175. <member name="F:System.Data.SQLite.SQLiteConvert._datetimeFormatLocal">
  176. <summary>
  177. The internal default format for local DateTime values when converting
  178. to a string.
  179. </summary>
  180. </member>
  181. <member name="F:System.Data.SQLite.SQLiteConvert._utf8">
  182. <summary>
  183. An UTF-8 Encoding instance, so we can convert strings to and from UTF-8
  184. </summary>
  185. </member>
  186. <member name="F:System.Data.SQLite.SQLiteConvert._datetimeFormat">
  187. <summary>
  188. The default DateTime format for this instance.
  189. </summary>
  190. </member>
  191. <member name="F:System.Data.SQLite.SQLiteConvert._datetimeKind">
  192. <summary>
  193. The default DateTimeKind for this instance.
  194. </summary>
  195. </member>
  196. <member name="F:System.Data.SQLite.SQLiteConvert._datetimeFormatString">
  197. <summary>
  198. The default DateTime format string for this instance.
  199. </summary>
  200. </member>
  201. <member name="M:System.Data.SQLite.SQLiteConvert.#ctor(System.Data.SQLite.SQLiteDateFormats,System.DateTimeKind,System.String)">
  202. <summary>
  203. Initializes the conversion class
  204. </summary>
  205. <param name="fmt">The default date/time format to use for this instance</param>
  206. <param name="kind">The DateTimeKind to use.</param>
  207. <param name="fmtString">The DateTime format string to use.</param>
  208. </member>
  209. <member name="M:System.Data.SQLite.SQLiteConvert.ToUTF8(System.String)">
  210. <summary>
  211. Converts a string to a UTF-8 encoded byte array sized to include a null-terminating character.
  212. </summary>
  213. <param name="sourceText">The string to convert to UTF-8</param>
  214. <returns>A byte array containing the converted string plus an extra 0 terminating byte at the end of the array.</returns>
  215. </member>
  216. <member name="M:System.Data.SQLite.SQLiteConvert.ToUTF8(System.DateTime)">
  217. <summary>
  218. Convert a DateTime to a UTF-8 encoded, zero-terminated byte array.
  219. </summary>
  220. <remarks>
  221. This function is a convenience function, which first calls ToString() on the DateTime, and then calls ToUTF8() with the
  222. string result.
  223. </remarks>
  224. <param name="dateTimeValue">The DateTime to convert.</param>
  225. <returns>The UTF-8 encoded string, including a 0 terminating byte at the end of the array.</returns>
  226. </member>
  227. <member name="M:System.Data.SQLite.SQLiteConvert.ToString(System.IntPtr,System.Int32)">
  228. <summary>
  229. Converts a UTF-8 encoded IntPtr of the specified length into a .NET string
  230. </summary>
  231. <param name="nativestring">The pointer to the memory where the UTF-8 string is encoded</param>
  232. <param name="nativestringlen">The number of bytes to decode</param>
  233. <returns>A string containing the translated character(s)</returns>
  234. </member>
  235. <member name="M:System.Data.SQLite.SQLiteConvert.UTF8ToString(System.IntPtr,System.Int32)">
  236. <summary>
  237. Converts a UTF-8 encoded IntPtr of the specified length into a .NET string
  238. </summary>
  239. <param name="nativestring">The pointer to the memory where the UTF-8 string is encoded</param>
  240. <param name="nativestringlen">The number of bytes to decode</param>
  241. <returns>A string containing the translated character(s)</returns>
  242. </member>
  243. <member name="M:System.Data.SQLite.SQLiteConvert.isValidJd(System.Int64)">
  244. <summary>
  245. Checks if the specified <see cref="T:System.Int64"/> is within the
  246. supported range for a Julian Day value.
  247. </summary>
  248. <param name="jd">
  249. The Julian Day value to check.
  250. </param>
  251. <returns>
  252. Non-zero if the specified Julian Day value is in the supported
  253. range; otherwise, zero.
  254. </returns>
  255. </member>
  256. <member name="M:System.Data.SQLite.SQLiteConvert.DoubleToJd(System.Double)">
  257. <summary>
  258. Converts a Julian Day value from a <see cref="T:System.Double"/> to an
  259. <see cref="T:System.Int64"/>.
  260. </summary>
  261. <param name="julianDay">
  262. The Julian Day <see cref="T:System.Double"/> value to convert.
  263. </param>
  264. <returns>
  265. The resulting Julian Day <see cref="T:System.Int64"/> value.
  266. </returns>
  267. </member>
  268. <member name="M:System.Data.SQLite.SQLiteConvert.JdToDouble(System.Int64)">
  269. <summary>
  270. Converts a Julian Day value from an <see cref="T:System.Int64"/> to a
  271. <see cref="T:System.Double"/>.
  272. </summary>
  273. <param name="jd">
  274. The Julian Day <see cref="T:System.Int64"/> value to convert.
  275. </param>
  276. <returns>
  277. The resulting Julian Day <see cref="T:System.Double"/> value.
  278. </returns>
  279. </member>
  280. <member name="M:System.Data.SQLite.SQLiteConvert.computeYMD(System.Int64,System.Nullable{System.DateTime})">
  281. <summary>
  282. Converts a Julian Day value to a <see cref="T:System.DateTime"/>.
  283. This method was translated from the "computeYMD" function in the
  284. "date.c" file belonging to the SQLite core library.
  285. </summary>
  286. <param name="jd">
  287. The Julian Day value to convert.
  288. </param>
  289. <param name="badValue">
  290. The <see cref="T:System.DateTime"/> value to return in the event that the
  291. Julian Day is out of the supported range. If this value is null,
  292. an exception will be thrown instead.
  293. </param>
  294. <returns>
  295. A <see cref="T:System.DateTime"/> value that contains the year, month, and
  296. day values that are closest to the specified Julian Day value.
  297. </returns>
  298. </member>
  299. <member name="M:System.Data.SQLite.SQLiteConvert.computeHMS(System.Int64,System.Nullable{System.DateTime})">
  300. <summary>
  301. Converts a Julian Day value to a <see cref="T:System.DateTime"/>.
  302. This method was translated from the "computeHMS" function in the
  303. "date.c" file belonging to the SQLite core library.
  304. </summary>
  305. <param name="jd">
  306. The Julian Day value to convert.
  307. </param>
  308. <param name="badValue">
  309. The <see cref="T:System.DateTime"/> value to return in the event that the
  310. Julian Day value is out of the supported range. If this value is
  311. null, an exception will be thrown instead.
  312. </param>
  313. <returns>
  314. A <see cref="T:System.DateTime"/> value that contains the hour, minute, and
  315. second, and millisecond values that are closest to the specified
  316. Julian Day value.
  317. </returns>
  318. </member>
  319. <member name="M:System.Data.SQLite.SQLiteConvert.computeJD(System.DateTime)">
  320. <summary>
  321. Converts a <see cref="T:System.DateTime"/> to a Julian Day value.
  322. This method was translated from the "computeJD" function in
  323. the "date.c" file belonging to the SQLite core library.
  324. Since the range of Julian Day values supported by this method
  325. includes all possible (valid) values of a <see cref="T:System.DateTime"/>
  326. value, it should be extremely difficult for this method to
  327. raise an exception or return an undefined result.
  328. </summary>
  329. <param name="dateTime">
  330. The <see cref="T:System.DateTime"/> value to convert. This value
  331. will be within the range of <see cref="F:System.DateTime.MinValue"/>
  332. (00:00:00.0000000, January 1, 0001) to
  333. <see cref="F:System.DateTime.MaxValue"/> (23:59:59.9999999, December
  334. 31, 9999).
  335. </param>
  336. <returns>
  337. The nearest Julian Day value corresponding to the specified
  338. <see cref="T:System.DateTime"/> value.
  339. </returns>
  340. </member>
  341. <member name="M:System.Data.SQLite.SQLiteConvert.ToDateTime(System.String)">
  342. <summary>
  343. Converts a string into a DateTime, using the DateTimeFormat, DateTimeKind,
  344. and DateTimeFormatString specified for the connection when it was opened.
  345. </summary>
  346. <remarks>
  347. Acceptable ISO8601 DateTime formats are:
  348. <list type="bullet">
  349. <item><description>THHmmssK</description></item>
  350. <item><description>THHmmK</description></item>
  351. <item><description>HH:mm:ss.FFFFFFFK</description></item>
  352. <item><description>HH:mm:ssK</description></item>
  353. <item><description>HH:mmK</description></item>
  354. <item><description>yyyy-MM-dd HH:mm:ss.FFFFFFFK</description></item>
  355. <item><description>yyyy-MM-dd HH:mm:ssK</description></item>
  356. <item><description>yyyy-MM-dd HH:mmK</description></item>
  357. <item><description>yyyy-MM-ddTHH:mm:ss.FFFFFFFK</description></item>
  358. <item><description>yyyy-MM-ddTHH:mmK</description></item>
  359. <item><description>yyyy-MM-ddTHH:mm:ssK</description></item>
  360. <item><description>yyyyMMddHHmmssK</description></item>
  361. <item><description>yyyyMMddHHmmK</description></item>
  362. <item><description>yyyyMMddTHHmmssFFFFFFFK</description></item>
  363. <item><description>THHmmss</description></item>
  364. <item><description>THHmm</description></item>
  365. <item><description>HH:mm:ss.FFFFFFF</description></item>
  366. <item><description>HH:mm:ss</description></item>
  367. <item><description>HH:mm</description></item>
  368. <item><description>yyyy-MM-dd HH:mm:ss.FFFFFFF</description></item>
  369. <item><description>yyyy-MM-dd HH:mm:ss</description></item>
  370. <item><description>yyyy-MM-dd HH:mm</description></item>
  371. <item><description>yyyy-MM-ddTHH:mm:ss.FFFFFFF</description></item>
  372. <item><description>yyyy-MM-ddTHH:mm</description></item>
  373. <item><description>yyyy-MM-ddTHH:mm:ss</description></item>
  374. <item><description>yyyyMMddHHmmss</description></item>
  375. <item><description>yyyyMMddHHmm</description></item>
  376. <item><description>yyyyMMddTHHmmssFFFFFFF</description></item>
  377. <item><description>yyyy-MM-dd</description></item>
  378. <item><description>yyyyMMdd</description></item>
  379. <item><description>yy-MM-dd</description></item>
  380. </list>
  381. If the string cannot be matched to one of the above formats -OR-
  382. the DateTimeFormatString if one was provided, an exception will
  383. be thrown.
  384. </remarks>
  385. <param name="dateText">The string containing either a long integer number of 100-nanosecond units since
  386. System.DateTime.MinValue, a Julian day double, an integer number of seconds since the Unix epoch, a
  387. culture-independent formatted date and time string, a formatted date and time string in the current
  388. culture, or an ISO8601-format string.</param>
  389. <returns>A DateTime value</returns>
  390. </member>
  391. <member name="M:System.Data.SQLite.SQLiteConvert.ToDateTime(System.String,System.Data.SQLite.SQLiteDateFormats,System.DateTimeKind,System.String)">
  392. <summary>
  393. Converts a string into a DateTime, using the specified DateTimeFormat,
  394. DateTimeKind and DateTimeFormatString.
  395. </summary>
  396. <remarks>
  397. Acceptable ISO8601 DateTime formats are:
  398. <list type="bullet">
  399. <item><description>THHmmssK</description></item>
  400. <item><description>THHmmK</description></item>
  401. <item><description>HH:mm:ss.FFFFFFFK</description></item>
  402. <item><description>HH:mm:ssK</description></item>
  403. <item><description>HH:mmK</description></item>
  404. <item><description>yyyy-MM-dd HH:mm:ss.FFFFFFFK</description></item>
  405. <item><description>yyyy-MM-dd HH:mm:ssK</description></item>
  406. <item><description>yyyy-MM-dd HH:mmK</description></item>
  407. <item><description>yyyy-MM-ddTHH:mm:ss.FFFFFFFK</description></item>
  408. <item><description>yyyy-MM-ddTHH:mmK</description></item>
  409. <item><description>yyyy-MM-ddTHH:mm:ssK</description></item>
  410. <item><description>yyyyMMddHHmmssK</description></item>
  411. <item><description>yyyyMMddHHmmK</description></item>
  412. <item><description>yyyyMMddTHHmmssFFFFFFFK</description></item>
  413. <item><description>THHmmss</description></item>
  414. <item><description>THHmm</description></item>
  415. <item><description>HH:mm:ss.FFFFFFF</description></item>
  416. <item><description>HH:mm:ss</description></item>
  417. <item><description>HH:mm</description></item>
  418. <item><description>yyyy-MM-dd HH:mm:ss.FFFFFFF</description></item>
  419. <item><description>yyyy-MM-dd HH:mm:ss</description></item>
  420. <item><description>yyyy-MM-dd HH:mm</description></item>
  421. <item><description>yyyy-MM-ddTHH:mm:ss.FFFFFFF</description></item>
  422. <item><description>yyyy-MM-ddTHH:mm</description></item>
  423. <item><description>yyyy-MM-ddTHH:mm:ss</description></item>
  424. <item><description>yyyyMMddHHmmss</description></item>
  425. <item><description>yyyyMMddHHmm</description></item>
  426. <item><description>yyyyMMddTHHmmssFFFFFFF</description></item>
  427. <item><description>yyyy-MM-dd</description></item>
  428. <item><description>yyyyMMdd</description></item>
  429. <item><description>yy-MM-dd</description></item>
  430. </list>
  431. If the string cannot be matched to one of the above formats -OR-
  432. the DateTimeFormatString if one was provided, an exception will
  433. be thrown.
  434. </remarks>
  435. <param name="dateText">The string containing either a long integer number of 100-nanosecond units since
  436. System.DateTime.MinValue, a Julian day double, an integer number of seconds since the Unix epoch, a
  437. culture-independent formatted date and time string, a formatted date and time string in the current
  438. culture, or an ISO8601-format string.</param>
  439. <param name="format">The SQLiteDateFormats to use.</param>
  440. <param name="kind">The DateTimeKind to use.</param>
  441. <param name="formatString">The DateTime format string to use.</param>
  442. <returns>A DateTime value</returns>
  443. </member>
  444. <member name="M:System.Data.SQLite.SQLiteConvert.ToDateTime(System.Double)">
  445. <summary>
  446. Converts a julianday value into a DateTime
  447. </summary>
  448. <param name="julianDay">The value to convert</param>
  449. <returns>A .NET DateTime</returns>
  450. </member>
  451. <member name="M:System.Data.SQLite.SQLiteConvert.ToDateTime(System.Double,System.DateTimeKind)">
  452. <summary>
  453. Converts a julianday value into a DateTime
  454. </summary>
  455. <param name="julianDay">The value to convert</param>
  456. <param name="kind">The DateTimeKind to use.</param>
  457. <returns>A .NET DateTime</returns>
  458. </member>
  459. <member name="M:System.Data.SQLite.SQLiteConvert.UnixEpochToDateTime(System.Int64,System.DateTimeKind)">
  460. <summary>
  461. Converts the specified number of seconds from the Unix epoch into a
  462. <see cref="T:System.DateTime"/> value.
  463. </summary>
  464. <param name="seconds">
  465. The number of whole seconds since the Unix epoch.
  466. </param>
  467. <param name="kind">
  468. Either Utc or Local time.
  469. </param>
  470. <returns>
  471. The new <see cref="T:System.DateTime"/> value.
  472. </returns>
  473. </member>
  474. <member name="M:System.Data.SQLite.SQLiteConvert.TicksToDateTime(System.Int64,System.DateTimeKind)">
  475. <summary>
  476. Converts the specified number of ticks since the epoch into a
  477. <see cref="T:System.DateTime"/> value.
  478. </summary>
  479. <param name="ticks">
  480. The number of whole ticks since the epoch.
  481. </param>
  482. <param name="kind">
  483. Either Utc or Local time.
  484. </param>
  485. <returns>
  486. The new <see cref="T:System.DateTime"/> value.
  487. </returns>
  488. </member>
  489. <member name="M:System.Data.SQLite.SQLiteConvert.ToJulianDay(System.DateTime)">
  490. <summary>
  491. Converts a DateTime struct to a JulianDay double
  492. </summary>
  493. <param name="value">The DateTime to convert</param>
  494. <returns>The JulianDay value the Datetime represents</returns>
  495. </member>
  496. <member name="M:System.Data.SQLite.SQLiteConvert.ToUnixEpoch(System.DateTime)">
  497. <summary>
  498. Converts a DateTime struct to the whole number of seconds since the
  499. Unix epoch.
  500. </summary>
  501. <param name="value">The DateTime to convert</param>
  502. <returns>The whole number of seconds since the Unix epoch</returns>
  503. </member>
  504. <member name="M:System.Data.SQLite.SQLiteConvert.GetDateTimeKindFormat(System.DateTimeKind,System.String)">
  505. <summary>
  506. Returns the DateTime format string to use for the specified DateTimeKind.
  507. If <paramref name="formatString" /> is not null, it will be returned verbatim.
  508. </summary>
  509. <param name="kind">The DateTimeKind to use.</param>
  510. <param name="formatString">The DateTime format string to use.</param>
  511. <returns>
  512. The DateTime format string to use for the specified DateTimeKind.
  513. </returns>
  514. </member>
  515. <member name="M:System.Data.SQLite.SQLiteConvert.ToString(System.DateTime)">
  516. <summary>
  517. Converts a string into a DateTime, using the DateTimeFormat, DateTimeKind,
  518. and DateTimeFormatString specified for the connection when it was opened.
  519. </summary>
  520. <param name="dateValue">The DateTime value to convert</param>
  521. <returns>Either a string containing the long integer number of 100-nanosecond units since System.DateTime.MinValue, a
  522. Julian day double, an integer number of seconds since the Unix epoch, a culture-independent formatted date and time
  523. string, a formatted date and time string in the current culture, or an ISO8601-format date/time string.</returns>
  524. </member>
  525. <member name="M:System.Data.SQLite.SQLiteConvert.ToString(System.DateTime,System.Data.SQLite.SQLiteDateFormats,System.DateTimeKind,System.String)">
  526. <summary>
  527. Converts a string into a DateTime, using the DateTimeFormat, DateTimeKind,
  528. and DateTimeFormatString specified for the connection when it was opened.
  529. </summary>
  530. <param name="dateValue">The DateTime value to convert</param>
  531. <param name="format">The SQLiteDateFormats to use.</param>
  532. <param name="kind">The DateTimeKind to use.</param>
  533. <param name="formatString">The DateTime format string to use.</param>
  534. <returns>Either a string containing the long integer number of 100-nanosecond units since System.DateTime.MinValue, a
  535. Julian day double, an integer number of seconds since the Unix epoch, a culture-independent formatted date and time
  536. string, a formatted date and time string in the current culture, or an ISO8601-format date/time string.</returns>
  537. </member>
  538. <member name="M:System.Data.SQLite.SQLiteConvert.ToDateTime(System.IntPtr,System.Int32)">
  539. <summary>
  540. Internal function to convert a UTF-8 encoded IntPtr of the specified length to a DateTime.
  541. </summary>
  542. <remarks>
  543. This is a convenience function, which first calls ToString() on the IntPtr to convert it to a string, then calls
  544. ToDateTime() on the string to return a DateTime.
  545. </remarks>
  546. <param name="ptr">A pointer to the UTF-8 encoded string</param>
  547. <param name="len">The length in bytes of the string</param>
  548. <returns>The parsed DateTime value</returns>
  549. </member>
  550. <member name="M:System.Data.SQLite.SQLiteConvert.Split(System.String,System.Char)">
  551. <summary>
  552. Smart method of splitting a string. Skips quoted elements, removes the quotes.
  553. </summary>
  554. <remarks>
  555. This split function works somewhat like the String.Split() function in that it breaks apart a string into
  556. pieces and returns the pieces as an array. The primary differences are:
  557. <list type="bullet">
  558. <item><description>Only one character can be provided as a separator character</description></item>
  559. <item><description>Quoted text inside the string is skipped over when searching for the separator, and the quotes are removed.</description></item>
  560. </list>
  561. Thus, if splitting the following string looking for a comma:<br/>
  562. One,Two, "Three, Four", Five<br/>
  563. <br/>
  564. The resulting array would contain<br/>
  565. [0] One<br/>
  566. [1] Two<br/>
  567. [2] Three, Four<br/>
  568. [3] Five<br/>
  569. <br/>
  570. Note that the leading and trailing spaces were removed from each item during the split.
  571. </remarks>
  572. <param name="source">Source string to split apart</param>
  573. <param name="separator">Separator character</param>
  574. <returns>A string array of the split up elements</returns>
  575. </member>
  576. <member name="M:System.Data.SQLite.SQLiteConvert.NewSplit(System.String,System.Char,System.Boolean,System.String@)">
  577. <summary>
  578. Splits the specified string into multiple strings based on a separator
  579. and returns the result as an array of strings.
  580. </summary>
  581. <param name="value">
  582. The string to split into pieces based on the separator character. If
  583. this string is null, null will always be returned. If this string is
  584. empty, an array of zero strings will always be returned.
  585. </param>
  586. <param name="separator">
  587. The character used to divide the original string into sub-strings.
  588. This character cannot be a backslash or a double-quote; otherwise, no
  589. work will be performed and null will be returned.
  590. </param>
  591. <param name="keepQuote">
  592. If this parameter is non-zero, all double-quote characters will be
  593. retained in the returned list of strings; otherwise, they will be
  594. dropped.
  595. </param>
  596. <param name="error">
  597. Upon failure, this parameter will be modified to contain an appropriate
  598. error message.
  599. </param>
  600. <returns>
  601. The new array of strings or null if the input string is null -OR- the
  602. separator character is a backslash or a double-quote -OR- the string
  603. contains an unbalanced backslash or double-quote character.
  604. </returns>
  605. </member>
  606. <member name="M:System.Data.SQLite.SQLiteConvert.ToStringWithProvider(System.Object,System.IFormatProvider)">
  607. <summary>
  608. Queries and returns the string representation for an object, using the
  609. specified (or current) format provider.
  610. </summary>
  611. <param name="obj">
  612. The object instance to return the string representation for.
  613. </param>
  614. <param name="provider">
  615. The format provider to use -OR- null if the current format provider for
  616. the thread should be used instead.
  617. </param>
  618. <returns>
  619. The string representation for the object instance -OR- null if the
  620. object instance is also null.
  621. </returns>
  622. </member>
  623. <member name="M:System.Data.SQLite.SQLiteConvert.ToBoolean(System.Object,System.IFormatProvider,System.Boolean)">
  624. <summary>
  625. Attempts to convert an arbitrary object to the Boolean data type.
  626. Null object values are converted to false. Throws an exception
  627. upon failure.
  628. </summary>
  629. <param name="obj">
  630. The object value to convert.
  631. </param>
  632. <param name="provider">
  633. The format provider to use.
  634. </param>
  635. <param name="viaFramework">
  636. If non-zero, a string value will be converted using the
  637. <see cref="M:System.Convert.ToBoolean(System.Object,System.IFormatProvider)"/>
  638. method; otherwise, the <see cref="M:System.Data.SQLite.SQLiteConvert.ToBoolean(System.String)"/>
  639. method will be used.
  640. </param>
  641. <returns>
  642. The converted boolean value.
  643. </returns>
  644. </member>
  645. <member name="M:System.Data.SQLite.SQLiteConvert.ToBoolean(System.Object)">
  646. <summary>
  647. Convert a value to true or false.
  648. </summary>
  649. <param name="source">A string or number representing true or false</param>
  650. <returns></returns>
  651. </member>
  652. <member name="M:System.Data.SQLite.SQLiteConvert.ToString(System.Int32)">
  653. <summary>
  654. Converts an integer to a string that can be round-tripped using the
  655. invariant culture.
  656. </summary>
  657. <param name="value">
  658. The integer value to return the string representation for.
  659. </param>
  660. <returns>
  661. The string representation of the specified integer value, using the
  662. invariant culture.
  663. </returns>
  664. </member>
  665. <member name="M:System.Data.SQLite.SQLiteConvert.ToBoolean(System.String)">
  666. <summary>
  667. Attempts to convert a <see cref="T:System.String"/> into a <see cref="T:System.Boolean"/>.
  668. </summary>
  669. <param name="source">
  670. The <see cref="T:System.String"/> to convert, cannot be null.
  671. </param>
  672. <returns>
  673. The converted <see cref="T:System.Boolean"/> value.
  674. </returns>
  675. <remarks>
  676. The supported strings are "yes", "no", "y", "n", "on", "off", "0", "1",
  677. as well as any prefix of the strings <see cref="F:System.Boolean.FalseString"/>
  678. and <see cref="F:System.Boolean.TrueString"/>. All strings are treated in a
  679. case-insensitive manner.
  680. </remarks>
  681. </member>
  682. <member name="M:System.Data.SQLite.SQLiteConvert.SQLiteTypeToType(System.Data.SQLite.SQLiteType)">
  683. <summary>
  684. Converts a SQLiteType to a .NET Type object
  685. </summary>
  686. <param name="t">The SQLiteType to convert</param>
  687. <returns>Returns a .NET Type object</returns>
  688. </member>
  689. <member name="M:System.Data.SQLite.SQLiteConvert.TypeToDbType(System.Type)">
  690. <summary>
  691. For a given intrinsic type, return a DbType
  692. </summary>
  693. <param name="typ">The native type to convert</param>
  694. <returns>The corresponding (closest match) DbType</returns>
  695. </member>
  696. <member name="M:System.Data.SQLite.SQLiteConvert.DbTypeToColumnSize(System.Data.DbType)">
  697. <summary>
  698. Returns the ColumnSize for the given DbType
  699. </summary>
  700. <param name="typ">The DbType to get the size of</param>
  701. <returns></returns>
  702. </member>
  703. <member name="M:System.Data.SQLite.SQLiteConvert.GetDefaultTypeName(System.Data.SQLite.SQLiteConnection)">
  704. <summary>
  705. Determines the default database type name to be used when a
  706. per-connection value is not available.
  707. </summary>
  708. <param name="connection">
  709. The connection context for type mappings, if any.
  710. </param>
  711. <returns>
  712. The default database type name to use.
  713. </returns>
  714. </member>
  715. <member name="M:System.Data.SQLite.SQLiteConvert.DefaultTypeNameWarning(System.Data.DbType,System.Data.SQLite.SQLiteConnectionFlags,System.String)">
  716. <summary>
  717. If applicable, issues a trace log message warning about falling back to
  718. the default database type name.
  719. </summary>
  720. <param name="dbType">
  721. The database value type.
  722. </param>
  723. <param name="flags">
  724. The flags associated with the parent connection object.
  725. </param>
  726. <param name="typeName">
  727. The textual name of the database type.
  728. </param>
  729. </member>
  730. <member name="M:System.Data.SQLite.SQLiteConvert.DefaultDbTypeWarning(System.String,System.Data.SQLite.SQLiteConnectionFlags,System.Nullable{System.Data.DbType})">
  731. <summary>
  732. If applicable, issues a trace log message warning about falling back to
  733. the default database value type.
  734. </summary>
  735. <param name="typeName">
  736. The textual name of the database type.
  737. </param>
  738. <param name="flags">
  739. The flags associated with the parent connection object.
  740. </param>
  741. <param name="dbType">
  742. The database value type.
  743. </param>
  744. </member>
  745. <member name="M:System.Data.SQLite.SQLiteConvert.DbTypeToTypeName(System.Data.SQLite.SQLiteConnection,System.Data.DbType,System.Data.SQLite.SQLiteConnectionFlags)">
  746. <summary>
  747. For a given database value type, return the "closest-match" textual database type name.
  748. </summary>
  749. <param name="connection">The connection context for custom type mappings, if any.</param>
  750. <param name="dbType">The database value type.</param>
  751. <param name="flags">The flags associated with the parent connection object.</param>
  752. <returns>The type name or an empty string if it cannot be determined.</returns>
  753. </member>
  754. <member name="M:System.Data.SQLite.SQLiteConvert.DbTypeToType(System.Data.DbType)">
  755. <summary>
  756. Convert a DbType to a Type
  757. </summary>
  758. <param name="typ">The DbType to convert from</param>
  759. <returns>The closest-match .NET type</returns>
  760. </member>
  761. <member name="M:System.Data.SQLite.SQLiteConvert.TypeToAffinity(System.Type,System.Data.SQLite.SQLiteConnectionFlags)">
  762. <summary>
  763. For a given type, return the closest-match SQLite TypeAffinity, which only understands a very limited subset of types.
  764. </summary>
  765. <param name="typ">The type to evaluate</param>
  766. <param name="flags">The flags associated with the connection.</param>
  767. <returns>The SQLite type affinity for that type.</returns>
  768. </member>
  769. <member name="M:System.Data.SQLite.SQLiteConvert.GetSQLiteDbTypeMap">
  770. <summary>
  771. Builds and returns a map containing the database column types
  772. recognized by this provider.
  773. </summary>
  774. <returns>
  775. A map containing the database column types recognized by this
  776. provider.
  777. </returns>
  778. </member>
  779. <member name="M:System.Data.SQLite.SQLiteConvert.IsStringDbType(System.Data.DbType)">
  780. <summary>
  781. Determines if a database type is considered to be a string.
  782. </summary>
  783. <param name="type">
  784. The database type to check.
  785. </param>
  786. <returns>
  787. Non-zero if the database type is considered to be a string, zero
  788. otherwise.
  789. </returns>
  790. </member>
  791. <member name="M:System.Data.SQLite.SQLiteConvert.SettingValueToString(System.Object)">
  792. <summary>
  793. Determines and returns the runtime configuration setting string that
  794. should be used in place of the specified object value.
  795. </summary>
  796. <param name="value">
  797. The object value to convert to a string.
  798. </param>
  799. <returns>
  800. Either the string to use in place of the object value -OR- null if it
  801. cannot be determined.
  802. </returns>
  803. </member>
  804. <member name="M:System.Data.SQLite.SQLiteConvert.GetDefaultDbType(System.Data.SQLite.SQLiteConnection)">
  805. <summary>
  806. Determines the default <see cref="T:System.Data.DbType"/> value to be used when a
  807. per-connection value is not available.
  808. </summary>
  809. <param name="connection">
  810. The connection context for type mappings, if any.
  811. </param>
  812. <returns>
  813. The default <see cref="T:System.Data.DbType"/> value to use.
  814. </returns>
  815. </member>
  816. <member name="M:System.Data.SQLite.SQLiteConvert.GetStringOrNull(System.Object)">
  817. <summary>
  818. Converts the object value, which is assumed to have originated
  819. from a <see cref="T:System.Data.DataRow"/>, to a string value.
  820. </summary>
  821. <param name="value">
  822. The value to be converted to a string.
  823. </param>
  824. <returns>
  825. A null value will be returned if the original value is null -OR-
  826. the original value is <see cref="F:System.DBNull.Value"/>. Otherwise,
  827. the original value will be converted to a string, using its
  828. (possibly overridden) <see cref="M:System.Object.ToString"/> method and
  829. then returned.
  830. </returns>
  831. </member>
  832. <member name="M:System.Data.SQLite.SQLiteConvert.LooksLikeNull(System.String)">
  833. <summary>
  834. Determines if the specified textual value appears to be a
  835. <see cref="T:System.DBNull"/> value.
  836. </summary>
  837. <param name="text">
  838. The textual value to inspect.
  839. </param>
  840. <returns>
  841. Non-zero if the text looks like a <see cref="T:System.DBNull"/> value,
  842. zero otherwise.
  843. </returns>
  844. </member>
  845. <member name="M:System.Data.SQLite.SQLiteConvert.LooksLikeInt64(System.String)">
  846. <summary>
  847. Determines if the specified textual value appears to be an
  848. <see cref="T:System.Int64"/> value.
  849. </summary>
  850. <param name="text">
  851. The textual value to inspect.
  852. </param>
  853. <returns>
  854. Non-zero if the text looks like an <see cref="T:System.Int64"/> value,
  855. zero otherwise.
  856. </returns>
  857. </member>
  858. <member name="M:System.Data.SQLite.SQLiteConvert.LooksLikeDouble(System.String)">
  859. <summary>
  860. Determines if the specified textual value appears to be a
  861. <see cref="T:System.Double"/> value.
  862. </summary>
  863. <param name="text">
  864. The textual value to inspect.
  865. </param>
  866. <returns>
  867. Non-zero if the text looks like a <see cref="T:System.Double"/> value,
  868. zero otherwise.
  869. </returns>
  870. </member>
  871. <member name="M:System.Data.SQLite.SQLiteConvert.LooksLikeDateTime(System.Data.SQLite.SQLiteConvert,System.String)">
  872. <summary>
  873. Determines if the specified textual value appears to be a
  874. <see cref="T:System.DateTime"/> value.
  875. </summary>
  876. <param name="convert">
  877. The <see cref="T:System.Data.SQLite.SQLiteConvert"/> object instance configured with
  878. the chosen <see cref="T:System.DateTime"/> format.
  879. </param>
  880. <param name="text">
  881. The textual value to inspect.
  882. </param>
  883. <returns>
  884. Non-zero if the text looks like a <see cref="T:System.DateTime"/> in the
  885. configured format, zero otherwise.
  886. </returns>
  887. </member>
  888. <member name="M:System.Data.SQLite.SQLiteConvert.TypeNameToDbType(System.Data.SQLite.SQLiteConnection,System.String,System.Data.SQLite.SQLiteConnectionFlags)">
  889. <summary>
  890. For a given textual database type name, return the "closest-match" database type.
  891. This method is called during query result processing; therefore, its performance
  892. is critical.
  893. </summary>
  894. <param name="connection">The connection context for custom type mappings, if any.</param>
  895. <param name="typeName">The textual name of the database type to match.</param>
  896. <param name="flags">The flags associated with the parent connection object.</param>
  897. <returns>The .NET DBType the text evaluates to.</returns>
  898. </member>
  899. <member name="F:System.Data.SQLite.SQLiteBase.COR_E_EXCEPTION">
  900. <summary>
  901. The error code used for logging exceptions caught in user-provided
  902. code.
  903. </summary>
  904. </member>
  905. <member name="M:System.Data.SQLite.SQLiteBase.IsReadOnly(System.String)">
  906. <summary>
  907. Returns non-zero if this connection to the database is read-only.
  908. </summary>
  909. </member>
  910. <member name="M:System.Data.SQLite.SQLiteBase.SetMemoryStatus(System.Boolean)">
  911. <summary>
  912. Sets the status of the memory usage tracking subsystem in the SQLite core library. By default, this is enabled.
  913. If this is disabled, memory usage tracking will not be performed. This is not really a per-connection value, it is
  914. global to the process.
  915. </summary>
  916. <param name="value">Non-zero to enable memory usage tracking, zero otherwise.</param>
  917. <returns>A standard SQLite return code (i.e. zero for success and non-zero for failure).</returns>
  918. </member>
  919. <member name="M:System.Data.SQLite.SQLiteBase.ReleaseMemory">
  920. <summary>
  921. Attempts to free as much heap memory as possible for the database connection.
  922. </summary>
  923. <returns>A standard SQLite return code (i.e. zero for success and non-zero for failure).</returns>
  924. </member>
  925. <member name="M:System.Data.SQLite.SQLiteBase.Shutdown">
  926. <summary>
  927. Shutdown the SQLite engine so that it can be restarted with different config options.
  928. We depend on auto initialization to recover.
  929. </summary>
  930. </member>
  931. <member name="M:System.Data.SQLite.SQLiteBase.IsOpen">
  932. <summary>
  933. Determines if the associated native connection handle is open.
  934. </summary>
  935. <returns>
  936. Non-zero if a database connection is open.
  937. </returns>
  938. </member>
  939. <member name="M:System.Data.SQLite.SQLiteBase.GetFileName(System.String)">
  940. <summary>
  941. Returns the fully qualified path and file name for the currently open
  942. database, if any.
  943. </summary>
  944. <param name="dbName">
  945. The name of the attached database to query.
  946. </param>
  947. <returns>
  948. The fully qualified path and file name for the currently open database,
  949. if any.
  950. </returns>
  951. </member>
  952. <member name="M:System.Data.SQLite.SQLiteBase.Open(System.String,System.String,System.Data.SQLite.SQLiteConnectionFlags,System.Data.SQLite.SQLiteOpenFlagsEnum,System.Int32,System.Boolean)">
  953. <summary>
  954. Opens a database.
  955. </summary>
  956. <remarks>
  957. Implementers should call SQLiteFunction.BindFunctions() and save the array after opening a connection
  958. to bind all attributed user-defined functions and collating sequences to the new connection.
  959. </remarks>
  960. <param name="strFilename">The filename of the database to open. SQLite automatically creates it if it doesn't exist.</param>
  961. <param name="vfsName">The name of the VFS to use -OR- null to use the default VFS.</param>
  962. <param name="connectionFlags">The flags associated with the parent connection object</param>
  963. <param name="openFlags">The open flags to use when creating the connection</param>
  964. <param name="maxPoolSize">The maximum size of the pool for the given filename</param>
  965. <param name="usePool">If true, the connection can be pulled from the connection pool</param>
  966. </member>
  967. <member name="M:System.Data.SQLite.SQLiteBase.Close(System.Boolean)">
  968. <summary>
  969. Closes the currently-open database.
  970. </summary>
  971. <remarks>
  972. After the database has been closed implemeters should call SQLiteFunction.UnbindFunctions() to deallocate all interop allocated
  973. memory associated with the user-defined functions and collating sequences tied to the closed connection.
  974. </remarks>
  975. <param name="disposing">Non-zero if connection is being disposed, zero otherwise.</param>
  976. </member>
  977. <member name="M:System.Data.SQLite.SQLiteBase.SetTimeout(System.Int32)">
  978. <summary>
  979. Sets the busy timeout on the connection. SQLiteCommand will call this before executing any command.
  980. </summary>
  981. <param name="nTimeoutMS">The number of milliseconds to wait before returning SQLITE_BUSY</param>
  982. </member>
  983. <member name="M:System.Data.SQLite.SQLiteBase.GetLastError">
  984. <summary>
  985. Returns the text of the last error issued by SQLite
  986. </summary>
  987. <returns></returns>
  988. </member>
  989. <member name="M:System.Data.SQLite.SQLiteBase.GetLastError(System.String)">
  990. <summary>
  991. Returns the text of the last error issued by SQLite -OR- the specified default error text if
  992. none is available from the SQLite core library.
  993. </summary>
  994. <param name="defValue">
  995. The error text to return in the event that one is not available from the SQLite core library.
  996. </param>
  997. <returns>
  998. The error text.
  999. </returns>
  1000. </member>
  1001. <member name="M:System.Data.SQLite.SQLiteBase.ClearPool">
  1002. <summary>
  1003. When pooling is enabled, force this connection to be disposed rather than returned to the pool
  1004. </summary>
  1005. </member>
  1006. <member name="M:System.Data.SQLite.SQLiteBase.CountPool">
  1007. <summary>
  1008. When pooling is enabled, returns the number of pool entries matching the current file name.
  1009. </summary>
  1010. <returns>The number of pool entries matching the current file name.</returns>
  1011. </member>
  1012. <member name="M:System.Data.SQLite.SQLiteBase.Prepare(System.Data.SQLite.SQLiteConnection,System.String,System.Data.SQLite.SQLiteStatement,System.UInt32,System.String@)">
  1013. <summary>
  1014. Prepares a SQL statement for execution.
  1015. </summary>
  1016. <param name="cnn">The source connection preparing the command. Can be null for any caller except LINQ</param>
  1017. <param name="strSql">The SQL command text to prepare</param>
  1018. <param name="previous">The previous statement in a multi-statement command, or null if no previous statement exists</param>
  1019. <param name="timeoutMS">The timeout to wait before aborting the prepare</param>
  1020. <param name="strRemain">The remainder of the statement that was not processed. Each call to prepare parses the
  1021. SQL up to to either the end of the text or to the first semi-colon delimiter. The remaining text is returned
  1022. here for a subsequent call to Prepare() until all the text has been processed.</param>
  1023. <returns>Returns an initialized SQLiteStatement.</returns>
  1024. </member>
  1025. <member name="M:System.Data.SQLite.SQLiteBase.Step(System.Data.SQLite.SQLiteStatement)">
  1026. <summary>
  1027. Steps through a prepared statement.
  1028. </summary>
  1029. <param name="stmt">The SQLiteStatement to step through</param>
  1030. <returns>True if a row was returned, False if not.</returns>
  1031. </member>
  1032. <member name="M:System.Data.SQLite.SQLiteBase.IsReadOnly(System.Data.SQLite.SQLiteStatement)">
  1033. <summary>
  1034. Returns non-zero if the specified statement is read-only in nature.
  1035. </summary>
  1036. <param name="stmt">The statement to check.</param>
  1037. <returns>True if the outer query is read-only.</returns>
  1038. </member>
  1039. <member name="M:System.Data.SQLite.SQLiteBase.Reset(System.Data.SQLite.SQLiteStatement)">
  1040. <summary>
  1041. Resets a prepared statement so it can be executed again. If the error returned is SQLITE_SCHEMA,
  1042. transparently attempt to rebuild the SQL statement and throw an error if that was not possible.
  1043. </summary>
  1044. <param name="stmt">The statement to reset</param>
  1045. <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>
  1046. </member>
  1047. <member name="M:System.Data.SQLite.SQLiteBase.Cancel">
  1048. <summary>
  1049. Attempts to interrupt the query currently executing on the associated
  1050. native database connection.
  1051. </summary>
  1052. </member>
  1053. <member name="M:System.Data.SQLite.SQLiteBase.BindFunction(System.Data.SQLite.SQLiteFunctionAttribute,System.Data.SQLite.SQLiteFunction,System.Data.SQLite.SQLiteConnectionFlags)">
  1054. <summary>
  1055. This function binds a user-defined function to the connection.
  1056. </summary>
  1057. <param name="functionAttribute">
  1058. The <see cref="T:System.Data.SQLite.SQLiteFunctionAttribute"/> object instance containing
  1059. the metadata for the function to be bound.
  1060. </param>
  1061. <param name="function">
  1062. The <see cref="T:System.Data.SQLite.SQLiteFunction"/> object instance that implements the
  1063. function to be bound.
  1064. </param>
  1065. <param name="flags">
  1066. The flags associated with the parent connection object.
  1067. </param>
  1068. </member>
  1069. <member name="M:System.Data.SQLite.SQLiteBase.UnbindFunction(System.Data.SQLite.SQLiteFunctionAttribute,System.Data.SQLite.SQLiteConnectionFlags)">
  1070. <summary>
  1071. This function unbinds a user-defined function from the connection.
  1072. </summary>
  1073. <param name="functionAttribute">
  1074. The <see cref="T:System.Data.SQLite.SQLiteFunctionAttribute"/> object instance containing
  1075. the metadata for the function to be unbound.
  1076. </param>
  1077. <param name="flags">
  1078. The flags associated with the parent connection object.
  1079. </param>
  1080. <returns>Non-zero if the function was unbound.</returns>
  1081. </member>
  1082. <member name="M:System.Data.SQLite.SQLiteBase.CreateModule(System.Data.SQLite.SQLiteModule,System.Data.SQLite.SQLiteConnectionFlags)">
  1083. <summary>
  1084. Calls the native SQLite core library in order to create a disposable
  1085. module containing the implementation of a virtual table.
  1086. </summary>
  1087. <param name="module">
  1088. The module object to be used when creating the native disposable module.
  1089. </param>
  1090. <param name="flags">
  1091. The flags for the associated <see cref="T:System.Data.SQLite.SQLiteConnection"/> object instance.
  1092. </param>
  1093. </member>
  1094. <member name="M:System.Data.SQLite.SQLiteBase.DisposeModule(System.Data.SQLite.SQLiteModule,System.Data.SQLite.SQLiteConnectionFlags)">
  1095. <summary>
  1096. Calls the native SQLite core library in order to cleanup the resources
  1097. associated with a module containing the implementation of a virtual table.
  1098. </summary>
  1099. <param name="module">
  1100. The module object previously passed to the <see cref="M:System.Data.SQLite.SQLiteBase.CreateModule(System.Data.SQLite.SQLiteModule,System.Data.SQLite.SQLiteConnectionFlags)"/>
  1101. method.
  1102. </param>
  1103. <param name="flags">
  1104. The flags for the associated <see cref="T:System.Data.SQLite.SQLiteConnection"/> object instance.
  1105. </param>
  1106. </member>
  1107. <member name="M:System.Data.SQLite.SQLiteBase.DeclareVirtualTable(System.Data.SQLite.SQLiteModule,System.String,System.String@)">
  1108. <summary>
  1109. Calls the native SQLite core library in order to declare a virtual table
  1110. in response to a call into the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/>
  1111. or <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> virtual table methods.
  1112. </summary>
  1113. <param name="module">
  1114. The virtual table module that is to be responsible for the virtual table
  1115. being declared.
  1116. </param>
  1117. <param name="strSql">
  1118. The string containing the SQL statement describing the virtual table to
  1119. be declared.
  1120. </param>
  1121. <param name="error">
  1122. Upon success, the contents of this parameter are undefined. Upon failure,
  1123. it should contain an appropriate error message.
  1124. </param>
  1125. <returns>
  1126. A standard SQLite return code.
  1127. </returns>
  1128. </member>
  1129. <member name="M:System.Data.SQLite.SQLiteBase.DeclareVirtualFunction(System.Data.SQLite.SQLiteModule,System.Int32,System.String,System.String@)">
  1130. <summary>
  1131. Calls the native SQLite core library in order to declare a virtual table
  1132. function in response to a call into the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/>
  1133. or <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> virtual table methods.
  1134. </summary>
  1135. <param name="module">
  1136. The virtual table module that is to be responsible for the virtual table
  1137. function being declared.
  1138. </param>
  1139. <param name="argumentCount">
  1140. The number of arguments to the function being declared.
  1141. </param>
  1142. <param name="name">
  1143. The name of the function being declared.
  1144. </param>
  1145. <param name="error">
  1146. Upon success, the contents of this parameter are undefined. Upon failure,
  1147. it should contain an appropriate error message.
  1148. </param>
  1149. <returns>
  1150. A standard SQLite return code.
  1151. </returns>
  1152. </member>
  1153. <member name="M:System.Data.SQLite.SQLiteBase.GetStatusParameter(System.Data.SQLite.SQLiteStatusOpsEnum,System.Boolean,System.Int32@,System.Int32@)">
  1154. <summary>
  1155. Returns the current and/or highwater values for the specified database status parameter.
  1156. </summary>
  1157. <param name="option">
  1158. The database status parameter to query.
  1159. </param>
  1160. <param name="reset">
  1161. Non-zero to reset the highwater value to the current value.
  1162. </param>
  1163. <param name="current">
  1164. If applicable, receives the current value.
  1165. </param>
  1166. <param name="highwater">
  1167. If applicable, receives the highwater value.
  1168. </param>
  1169. <returns>
  1170. A standard SQLite return code.
  1171. </returns>
  1172. </member>
  1173. <member name="M:System.Data.SQLite.SQLiteBase.SetLimitOption(System.Data.SQLite.SQLiteLimitOpsEnum,System.Int32)">
  1174. <summary>
  1175. Change a limit value for the database.
  1176. </summary>
  1177. <param name="option">
  1178. The database limit to change.
  1179. </param>
  1180. <param name="value">
  1181. The new value for the specified limit.
  1182. </param>
  1183. <returns>
  1184. The old value for the specified limit -OR- negative one if an error
  1185. occurs.
  1186. </returns>
  1187. </member>
  1188. <member name="M:System.Data.SQLite.SQLiteBase.SetConfigurationOption(System.Data.SQLite.SQLiteConfigDbOpsEnum,System.Object)">
  1189. <summary>
  1190. Change a configuration option value for the database.
  1191. </summary>
  1192. <param name="option">
  1193. The database configuration option to change.
  1194. </param>
  1195. <param name="value">
  1196. The new value for the specified configuration option.
  1197. </param>
  1198. <returns>
  1199. A standard SQLite return code.
  1200. </returns>
  1201. </member>
  1202. <member name="M:System.Data.SQLite.SQLiteBase.SetLoadExtension(System.Boolean)">
  1203. <summary>
  1204. Enables or disables extension loading by SQLite.
  1205. </summary>
  1206. <param name="bOnOff">
  1207. True to enable loading of extensions, false to disable.
  1208. </param>
  1209. </member>
  1210. <member name="M:System.Data.SQLite.SQLiteBase.LoadExtension(System.String,System.String)">
  1211. <summary>
  1212. Loads a SQLite extension library from the named file.
  1213. </summary>
  1214. <param name="fileName">
  1215. The name of the dynamic link library file containing the extension.
  1216. </param>
  1217. <param name="procName">
  1218. The name of the exported function used to initialize the extension.
  1219. If null, the default "sqlite3_extension_init" will be used.
  1220. </param>
  1221. </member>
  1222. <member name="M:System.Data.SQLite.SQLiteBase.SetExtendedResultCodes(System.Boolean)">
  1223. <summary>
  1224. Enables or disables extened result codes returned by SQLite
  1225. </summary>
  1226. <param name="bOnOff">true to enable extended result codes, false to disable.</param>
  1227. <returns></returns>
  1228. </member>
  1229. <member name="M:System.Data.SQLite.SQLiteBase.ResultCode">
  1230. <summary>
  1231. Returns the numeric result code for the most recent failed SQLite API call
  1232. associated with the database connection.
  1233. </summary>
  1234. <returns>Result code</returns>
  1235. </member>
  1236. <member name="M:System.Data.SQLite.SQLiteBase.ExtendedResultCode">
  1237. <summary>
  1238. Returns the extended numeric result code for the most recent failed SQLite API call
  1239. associated with the database connection.
  1240. </summary>
  1241. <returns>Extended result code</returns>
  1242. </member>
  1243. <member name="M:System.Data.SQLite.SQLiteBase.LogMessage(System.Data.SQLite.SQLiteErrorCode,System.String)">
  1244. <summary>
  1245. Add a log message via the SQLite sqlite3_log interface.
  1246. </summary>
  1247. <param name="iErrCode">Error code to be logged with the message.</param>
  1248. <param name="zMessage">String to be logged. Unlike the SQLite sqlite3_log()
  1249. interface, this should be pre-formatted. Consider using the
  1250. String.Format() function.</param>
  1251. <returns></returns>
  1252. </member>
  1253. <member name="M:System.Data.SQLite.SQLiteBase.IsInitialized">
  1254. <summary>
  1255. Checks if the SQLite core library has been initialized in the current process.
  1256. </summary>
  1257. <returns>
  1258. Non-zero if the SQLite core library has been initialized in the current process,
  1259. zero otherwise.
  1260. </returns>
  1261. </member>
  1262. <member name="M:System.Data.SQLite.SQLiteBase.InitializeBackup(System.Data.SQLite.SQLiteConnection,System.String,System.String)">
  1263. <summary>
  1264. Creates a new SQLite backup object based on the provided destination
  1265. database connection. The source database connection is the one
  1266. associated with this object. The source and destination database
  1267. connections cannot be the same.
  1268. </summary>
  1269. <param name="destCnn">The destination database connection.</param>
  1270. <param name="destName">The destination database name.</param>
  1271. <param name="sourceName">The source database name.</param>
  1272. <returns>The newly created backup object.</returns>
  1273. </member>
  1274. <member name="M:System.Data.SQLite.SQLiteBase.StepBackup(System.Data.SQLite.SQLiteBackup,System.Int32,System.Boolean@)">
  1275. <summary>
  1276. Copies up to N pages from the source database to the destination
  1277. database associated with the specified backup object.
  1278. </summary>
  1279. <param name="backup">The backup object to use.</param>
  1280. <param name="nPage">
  1281. The number of pages to copy or negative to copy all remaining pages.
  1282. </param>
  1283. <param name="retry">
  1284. Set to true if the operation needs to be retried due to database
  1285. locking issues.
  1286. </param>
  1287. <returns>
  1288. True if there are more pages to be copied, false otherwise.
  1289. </returns>
  1290. </member>
  1291. <member name="M:System.Data.SQLite.SQLiteBase.RemainingBackup(System.Data.SQLite.SQLiteBackup)">
  1292. <summary>
  1293. Returns the number of pages remaining to be copied from the source
  1294. database to the destination database associated with the specified
  1295. backup object.
  1296. </summary>
  1297. <param name="backup">The backup object to check.</param>
  1298. <returns>The number of pages remaining to be copied.</returns>
  1299. </member>
  1300. <member name="M:System.Data.SQLite.SQLiteBase.PageCountBackup(System.Data.SQLite.SQLiteBackup)">
  1301. <summary>
  1302. Returns the total number of pages in the source database associated
  1303. with the specified backup object.
  1304. </summary>
  1305. <param name="backup">The backup object to check.</param>
  1306. <returns>The total number of pages in the source database.</returns>
  1307. </member>
  1308. <member name="M:System.Data.SQLite.SQLiteBase.FinishBackup(System.Data.SQLite.SQLiteBackup)">
  1309. <summary>
  1310. Destroys the backup object, rolling back any backup that may be in
  1311. progess.
  1312. </summary>
  1313. <param name="backup">The backup object to destroy.</param>
  1314. </member>
  1315. <member name="M:System.Data.SQLite.SQLiteBase.FallbackGetErrorString(System.Data.SQLite.SQLiteErrorCode)">
  1316. <summary>
  1317. Returns the error message for the specified SQLite return code using
  1318. the internal static lookup table.
  1319. </summary>
  1320. <param name="rc">The SQLite return code.</param>
  1321. <returns>The error message or null if it cannot be found.</returns>
  1322. </member>
  1323. <member name="P:System.Data.SQLite.SQLiteBase.Version">
  1324. <summary>
  1325. Returns a string representing the active version of SQLite
  1326. </summary>
  1327. </member>
  1328. <member name="P:System.Data.SQLite.SQLiteBase.VersionNumber">
  1329. <summary>
  1330. Returns an integer representing the active version of SQLite
  1331. </summary>
  1332. </member>
  1333. <member name="P:System.Data.SQLite.SQLiteBase.LastInsertRowId">
  1334. <summary>
  1335. Returns the rowid of the most recent successful INSERT into the database from this connection.
  1336. </summary>
  1337. </member>
  1338. <member name="P:System.Data.SQLite.SQLiteBase.Changes">
  1339. <summary>
  1340. Returns the number of changes the last executing insert/update caused.
  1341. </summary>
  1342. </member>
  1343. <member name="P:System.Data.SQLite.SQLiteBase.MemoryUsed">
  1344. <summary>
  1345. Returns the amount of memory (in bytes) currently in use by the SQLite core library. This is not really a per-connection
  1346. value, it is global to the process.
  1347. </summary>
  1348. </member>
  1349. <member name="P:System.Data.SQLite.SQLiteBase.MemoryHighwater">
  1350. <summary>
  1351. Returns the maximum amount of memory (in bytes) used by the SQLite core library since the high-water mark was last reset.
  1352. This is not really a per-connection value, it is global to the process.
  1353. </summary>
  1354. </member>
  1355. <member name="P:System.Data.SQLite.SQLiteBase.OwnHandle">
  1356. <summary>
  1357. Returns non-zero if the underlying native connection handle is owned by this instance.
  1358. </summary>
  1359. </member>
  1360. <member name="P:System.Data.SQLite.SQLiteBase.Functions">
  1361. <summary>
  1362. Returns the logical list of functions associated with this connection.
  1363. </summary>
  1364. </member>
  1365. <member name="P:System.Data.SQLite.SQLiteBase.AutoCommit">
  1366. <summary>
  1367. Returns non-zero if the given database connection is in autocommit mode.
  1368. Autocommit mode is on by default. Autocommit mode is disabled by a BEGIN
  1369. statement. Autocommit mode is re-enabled by a COMMIT or ROLLBACK.
  1370. </summary>
  1371. </member>
  1372. <member name="F:System.Data.SQLite.SQLite3.dbName">
  1373. <summary>
  1374. This field is used to refer to memory allocated for the
  1375. SQLITE_DBCONFIG_MAINDBNAME value used with the native
  1376. "sqlite3_db_config" API. If allocated, the associated
  1377. memeory will be freed when the underlying connection is
  1378. closed.
  1379. </summary>
  1380. </member>
  1381. <member name="F:System.Data.SQLite.SQLite3._sql">
  1382. <summary>
  1383. The opaque pointer returned to us by the sqlite provider
  1384. </summary>
  1385. </member>
  1386. <member name="F:System.Data.SQLite.SQLite3._functions">
  1387. <summary>
  1388. The user-defined functions registered on this connection
  1389. </summary>
  1390. </member>
  1391. <member name="F:System.Data.SQLite.SQLite3._shimExtensionFileName">
  1392. <summary>
  1393. This is the name of the native library file that contains the
  1394. "vtshim" extension [wrapper].
  1395. </summary>
  1396. </member>
  1397. <member name="F:System.Data.SQLite.SQLite3._shimIsLoadNeeded">
  1398. <summary>
  1399. This is the flag indicate whether the native library file that
  1400. contains the "vtshim" extension must be dynamically loaded by
  1401. this class prior to use.
  1402. </summary>
  1403. </member>
  1404. <member name="F:System.Data.SQLite.SQLite3._shimExtensionProcName">
  1405. <summary>
  1406. This is the name of the native entry point for the "vtshim"
  1407. extension [wrapper].
  1408. </summary>
  1409. </member>
  1410. <member name="F:System.Data.SQLite.SQLite3._modules">
  1411. <summary>
  1412. The modules created using this connection.
  1413. </summary>
  1414. </member>
  1415. <member name="M:System.Data.SQLite.SQLite3.#ctor(System.Data.SQLite.SQLiteDateFormats,System.DateTimeKind,System.String,System.IntPtr,System.String,System.Boolean)">
  1416. <summary>
  1417. Constructs the object used to interact with the SQLite core library
  1418. using the UTF-8 text encoding.
  1419. </summary>
  1420. <param name="fmt">
  1421. The DateTime format to be used when converting string values to a
  1422. DateTime and binding DateTime parameters.
  1423. </param>
  1424. <param name="kind">
  1425. The <see cref="T:System.DateTimeKind"/> to be used when creating DateTime
  1426. values.
  1427. </param>
  1428. <param name="fmtString">
  1429. The format string to be used when parsing and formatting DateTime
  1430. values.
  1431. </param>
  1432. <param name="db">
  1433. The native handle to be associated with the database connection.
  1434. </param>
  1435. <param name="fileName">
  1436. The fully qualified file name associated with <paramref name="db "/>.
  1437. </param>
  1438. <param name="ownHandle">
  1439. Non-zero if the newly created object instance will need to dispose
  1440. of <paramref name="db"/> when it is no longer needed.
  1441. </param>
  1442. </member>
  1443. <member name="M:System.Data.SQLite.SQLite3.DisposeModules">
  1444. <summary>
  1445. This method attempts to dispose of all the <see cref="T:System.Data.SQLite.SQLiteModule"/> derived
  1446. object instances currently associated with the native database connection.
  1447. </summary>
  1448. </member>
  1449. <member name="M:System.Data.SQLite.SQLite3.GetCancelCount">
  1450. <summary>
  1451. Returns the number of times the <see cref="M:System.Data.SQLite.SQLite3.Cancel"/> method has been
  1452. called.
  1453. </summary>
  1454. </member>
  1455. <member name="M:System.Data.SQLite.SQLite3.ShouldThrowForCancel">
  1456. <summary>
  1457. This method determines whether or not a <see cref="T:System.Data.SQLite.SQLiteException"/>
  1458. with a return code of <see cref="F:System.Data.SQLite.SQLiteErrorCode.Interrupt"/> should
  1459. be thrown after making a call into the SQLite core library.
  1460. </summary>
  1461. <returns>
  1462. Non-zero if a <see cref="T:System.Data.SQLite.SQLiteException"/> to be thrown. This method
  1463. will only return non-zero if the <see cref="M:System.Data.SQLite.SQLite3.Cancel"/> method was called
  1464. one or more times during a call into the SQLite core library (e.g. when
  1465. the sqlite3_prepare*() or sqlite3_step() APIs are used).
  1466. </returns>
  1467. </member>
  1468. <member name="M:System.Data.SQLite.SQLite3.ResetCancelCount">
  1469. <summary>
  1470. Resets the value of the <see cref="F:System.Data.SQLite.SQLite3._cancelCount"/> field.
  1471. </summary>
  1472. </member>
  1473. <member name="M:System.Data.SQLite.SQLite3.Cancel">
  1474. <summary>
  1475. Attempts to interrupt the query currently executing on the associated
  1476. native database connection.
  1477. </summary>
  1478. </member>
  1479. <member name="M:System.Data.SQLite.SQLite3.BindFunction(System.Data.SQLite.SQLiteFunctionAttribute,System.Data.SQLite.SQLiteFunction,System.Data.SQLite.SQLiteConnectionFlags)">
  1480. <summary>
  1481. This function binds a user-defined function to the connection.
  1482. </summary>
  1483. <param name="functionAttribute">
  1484. The <see cref="T:System.Data.SQLite.SQLiteFunctionAttribute"/> object instance containing
  1485. the metadata for the function to be bound.
  1486. </param>
  1487. <param name="function">
  1488. The <see cref="T:System.Data.SQLite.SQLiteFunction"/> object instance that implements the
  1489. function to be bound.
  1490. </param>
  1491. <param name="flags">
  1492. The flags associated with the parent connection object.
  1493. </param>
  1494. </member>
  1495. <member name="M:System.Data.SQLite.SQLite3.UnbindFunction(System.Data.SQLite.SQLiteFunctionAttribute,System.Data.SQLite.SQLiteConnectionFlags)">
  1496. <summary>
  1497. This function binds a user-defined function to the connection.
  1498. </summary>
  1499. <param name="functionAttribute">
  1500. The <see cref="T:System.Data.SQLite.SQLiteFunctionAttribute"/> object instance containing
  1501. the metadata for the function to be unbound.
  1502. </param>
  1503. <param name="flags">
  1504. The flags associated with the parent connection object.
  1505. </param>
  1506. <returns>Non-zero if the function was unbound and removed.</returns>
  1507. </member>
  1508. <member name="M:System.Data.SQLite.SQLite3.ReleaseMemory">
  1509. <summary>
  1510. Attempts to free as much heap memory as possible for the database connection.
  1511. </summary>
  1512. <returns>A standard SQLite return code (i.e. zero for success and non-zero for failure).</returns>
  1513. </member>
  1514. <member name="M:System.Data.SQLite.SQLite3.StaticReleaseMemory(System.Int32,System.Boolean,System.Boolean,System.Int32@,System.Boolean@,System.UInt32@)">
  1515. <summary>
  1516. Attempts to free N bytes of heap memory by deallocating non-essential memory
  1517. allocations held by the database library. Memory used to cache database pages
  1518. to improve performance is an example of non-essential memory. This is a no-op
  1519. returning zero if the SQLite core library was not compiled with the compile-time
  1520. option SQLITE_ENABLE_MEMORY_MANAGEMENT. Optionally, attempts to reset and/or
  1521. compact the Win32 native heap, if applicable.
  1522. </summary>
  1523. <param name="nBytes">
  1524. The requested number of bytes to free.
  1525. </param>
  1526. <param name="reset">
  1527. Non-zero to attempt a heap reset.
  1528. </param>
  1529. <param name="compact">
  1530. Non-zero to attempt heap compaction.
  1531. </param>
  1532. <param name="nFree">
  1533. The number of bytes actually freed. This value may be zero.
  1534. </param>
  1535. <param name="resetOk">
  1536. This value will be non-zero if the heap reset was successful.
  1537. </param>
  1538. <param name="nLargest">
  1539. The size of the largest committed free block in the heap, in bytes.
  1540. This value will be zero unless heap compaction is enabled.
  1541. </param>
  1542. <returns>
  1543. A standard SQLite return code (i.e. zero for success and non-zero
  1544. for failure).
  1545. </returns>
  1546. </member>
  1547. <member name="M:System.Data.SQLite.SQLite3.Shutdown">
  1548. <summary>
  1549. Shutdown the SQLite engine so that it can be restarted with different
  1550. configuration options. We depend on auto initialization to recover.
  1551. </summary>
  1552. <returns>Returns a standard SQLite result code.</returns>
  1553. </member>
  1554. <member name="M:System.Data.SQLite.SQLite3.StaticShutdown(System.Boolean)">
  1555. <summary>
  1556. Shutdown the SQLite engine so that it can be restarted with different
  1557. configuration options. We depend on auto initialization to recover.
  1558. </summary>
  1559. <param name="directories">
  1560. Non-zero to reset the database and temporary directories to their
  1561. default values, which should be null for both. This parameter has no
  1562. effect on non-Windows operating systems.
  1563. </param>
  1564. <returns>Returns a standard SQLite result code.</returns>
  1565. </member>
  1566. <member name="M:System.Data.SQLite.SQLite3.IsOpen">
  1567. <summary>
  1568. Determines if the associated native connection handle is open.
  1569. </summary>
  1570. <returns>
  1571. Non-zero if the associated native connection handle is open.
  1572. </returns>
  1573. </member>
  1574. <member name="M:System.Data.SQLite.SQLite3.GetFileName(System.String)">
  1575. <summary>
  1576. Returns the fully qualified path and file name for the currently open
  1577. database, if any.
  1578. </summary>
  1579. <param name="dbName">
  1580. The name of the attached database to query.
  1581. </param>
  1582. <returns>
  1583. The fully qualified path and file name for the currently open database,
  1584. if any.
  1585. </returns>
  1586. </member>
  1587. <member name="M:System.Data.SQLite.SQLite3.IsAllowedToUsePool(System.Data.SQLite.SQLiteOpenFlagsEnum)">
  1588. <summary>
  1589. This method attempts to determine if a database connection opened
  1590. with the specified <see cref="T:System.Data.SQLite.SQLiteOpenFlagsEnum"/> should be
  1591. allowed into the connection pool.
  1592. </summary>
  1593. <param name="openFlags">
  1594. The <see cref="T:System.Data.SQLite.SQLiteOpenFlagsEnum"/> that were specified when the
  1595. connection was opened.
  1596. </param>
  1597. <returns>
  1598. Non-zero if the connection should (eventually) be allowed into the
  1599. connection pool; otherwise, zero.
  1600. </returns>
  1601. </member>
  1602. <member name="F:System.Data.SQLite.SQLite3.have_errstr">
  1603. <summary>
  1604. Has the sqlite3_errstr() core library API been checked for yet?
  1605. If so, is it present?
  1606. </summary>
  1607. </member>
  1608. <member name="M:System.Data.SQLite.SQLite3.GetErrorString(System.Data.SQLite.SQLiteErrorCode)">
  1609. <summary>
  1610. Returns the error message for the specified SQLite return code using
  1611. the sqlite3_errstr() function, falling back to the internal lookup
  1612. table if necessary.
  1613. WARNING: Do not remove this method, it is used via reflection.
  1614. </summary>
  1615. <param name="rc">The SQLite return code.</param>
  1616. <returns>The error message or null if it cannot be found.</returns>
  1617. </member>
  1618. <member name="F:System.Data.SQLite.SQLite3.have_stmt_readonly">
  1619. <summary>
  1620. Has the sqlite3_stmt_readonly() core library API been checked for yet?
  1621. If so, is it present?
  1622. </summary>
  1623. </member>
  1624. <member name="M:System.Data.SQLite.SQLite3.IsReadOnly(System.Data.SQLite.SQLiteStatement)">
  1625. <summary>
  1626. Returns non-zero if the specified statement is read-only in nature.
  1627. </summary>
  1628. <param name="stmt">The statement to check.</param>
  1629. <returns>True if the outer query is read-only.</returns>
  1630. </member>
  1631. <member name="F:System.Data.SQLite.SQLite3.forceLogPrepare">
  1632. <summary>
  1633. This field is used to keep track of whether or not the
  1634. "SQLite_ForceLogPrepare" environment variable has been queried. If so,
  1635. it will only be non-zero if the environment variable was present.
  1636. </summary>
  1637. </member>
  1638. <member name="F:System.Data.SQLite.SQLite3.forceLogLifecycle">
  1639. <summary>
  1640. This field is used to keep track of whether or not the
  1641. "SQLite_ForceLogLifecycle" environment variable has been queried. If
  1642. so, it will only be non-zero if the environment variable was present.
  1643. </summary>
  1644. </member>
  1645. <member name="M:System.Data.SQLite.SQLite3.ForceLogPrepare">
  1646. <summary>
  1647. Determines if all calls to prepare a SQL query will be logged,
  1648. regardless of the flags for the associated connection.
  1649. </summary>
  1650. <returns>
  1651. Non-zero to log all calls to prepare a SQL query.
  1652. </returns>
  1653. </member>
  1654. <member name="M:System.Data.SQLite.SQLite3.ForceLogLifecycle">
  1655. <summary>
  1656. Determines if calls into key members pertaining to the lifecycle of
  1657. connections and their associated classes will be logged, regardless
  1658. of the flags for the associated connection.
  1659. </summary>
  1660. <returns>
  1661. Non-zero to log calls into key members pertaining to the lifecycle of
  1662. connections and their associated classes (e.g. LINQ, EF6, etc).
  1663. </returns>
  1664. </member>
  1665. <member name="M:System.Data.SQLite.SQLite3.GetShimExtensionFileName(System.Boolean@)">
  1666. <summary>
  1667. Determines the file name of the native library containing the native
  1668. "vtshim" extension -AND- whether it should be dynamically loaded by
  1669. this class.
  1670. </summary>
  1671. <param name="isLoadNeeded">
  1672. This output parameter will be set to non-zero if the returned native
  1673. library file name should be dynamically loaded prior to attempting
  1674. the creation of native disposable extension modules.
  1675. </param>
  1676. <returns>
  1677. The file name of the native library containing the native "vtshim"
  1678. extension -OR- null if it cannot be determined.
  1679. </returns>
  1680. </member>
  1681. <member name="M:System.Data.SQLite.SQLite3.CreateModule(System.Data.SQLite.SQLiteModule,System.Data.SQLite.SQLiteConnectionFlags)">
  1682. <summary>
  1683. Calls the native SQLite core library in order to create a disposable
  1684. module containing the implementation of a virtual table.
  1685. </summary>
  1686. <param name="module">
  1687. The module object to be used when creating the native disposable module.
  1688. </param>
  1689. <param name="flags">
  1690. The flags for the associated <see cref="T:System.Data.SQLite.SQLiteConnection"/> object instance.
  1691. </param>
  1692. </member>
  1693. <member name="M:System.Data.SQLite.SQLite3.DisposeModule(System.Data.SQLite.SQLiteModule,System.Data.SQLite.SQLiteConnectionFlags)">
  1694. <summary>
  1695. Calls the native SQLite core library in order to cleanup the resources
  1696. associated with a module containing the implementation of a virtual table.
  1697. </summary>
  1698. <param name="module">
  1699. The module object previously passed to the <see cref="M:System.Data.SQLite.SQLite3.CreateModule(System.Data.SQLite.SQLiteModule,System.Data.SQLite.SQLiteConnectionFlags)"/>
  1700. method.
  1701. </param>
  1702. <param name="flags">
  1703. The flags for the associated <see cref="T:System.Data.SQLite.SQLiteConnection"/> object instance.
  1704. </param>
  1705. </member>
  1706. <member name="M:System.Data.SQLite.SQLite3.DeclareVirtualTable(System.Data.SQLite.SQLiteModule,System.String,System.String@)">
  1707. <summary>
  1708. Calls the native SQLite core library in order to declare a virtual table
  1709. in response to a call into the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/>
  1710. or <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> virtual table methods.
  1711. </summary>
  1712. <param name="module">
  1713. The virtual table module that is to be responsible for the virtual table
  1714. being declared.
  1715. </param>
  1716. <param name="strSql">
  1717. The string containing the SQL statement describing the virtual table to
  1718. be declared.
  1719. </param>
  1720. <param name="error">
  1721. Upon success, the contents of this parameter are undefined. Upon failure,
  1722. it should contain an appropriate error message.
  1723. </param>
  1724. <returns>
  1725. A standard SQLite return code.
  1726. </returns>
  1727. </member>
  1728. <member name="M:System.Data.SQLite.SQLite3.DeclareVirtualFunction(System.Data.SQLite.SQLiteModule,System.Int32,System.String,System.String@)">
  1729. <summary>
  1730. Calls the native SQLite core library in order to declare a virtual table
  1731. function in response to a call into the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/>
  1732. or <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> virtual table methods.
  1733. </summary>
  1734. <param name="module">
  1735. The virtual table module that is to be responsible for the virtual table
  1736. function being declared.
  1737. </param>
  1738. <param name="argumentCount">
  1739. The number of arguments to the function being declared.
  1740. </param>
  1741. <param name="name">
  1742. The name of the function being declared.
  1743. </param>
  1744. <param name="error">
  1745. Upon success, the contents of this parameter are undefined. Upon failure,
  1746. it should contain an appropriate error message.
  1747. </param>
  1748. <returns>
  1749. A standard SQLite return code.
  1750. </returns>
  1751. </member>
  1752. <member name="M:System.Data.SQLite.SQLite3.GetStatusDbOpsNames">
  1753. <summary>
  1754. Builds an error message string fragment containing the
  1755. defined values of the <see cref="T:System.Data.SQLite.SQLiteStatusOpsEnum"/>
  1756. enumeration.
  1757. </summary>
  1758. <returns>
  1759. The built string fragment.
  1760. </returns>
  1761. </member>
  1762. <member name="M:System.Data.SQLite.SQLite3.GetLimitOpsNames">
  1763. <summary>
  1764. Builds an error message string fragment containing the
  1765. defined values of the <see cref="T:System.Data.SQLite.SQLiteLimitOpsEnum"/>
  1766. enumeration.
  1767. </summary>
  1768. <returns>
  1769. The built string fragment.
  1770. </returns>
  1771. </member>
  1772. <member name="M:System.Data.SQLite.SQLite3.GetConfigDbOpsNames">
  1773. <summary>
  1774. Builds an error message string fragment containing the
  1775. defined values of the <see cref="T:System.Data.SQLite.SQLiteConfigDbOpsEnum"/>
  1776. enumeration.
  1777. </summary>
  1778. <returns>
  1779. The built string fragment.
  1780. </returns>
  1781. </member>
  1782. <member name="M:System.Data.SQLite.SQLite3.GetStatusParameter(System.Data.SQLite.SQLiteStatusOpsEnum,System.Boolean,System.Int32@,System.Int32@)">
  1783. <summary>
  1784. Returns the current and/or highwater values for the specified
  1785. database status parameter.
  1786. </summary>
  1787. <param name="option">
  1788. The database status parameter to query.
  1789. </param>
  1790. <param name="reset">
  1791. Non-zero to reset the highwater value to the current value.
  1792. </param>
  1793. <param name="current">
  1794. If applicable, receives the current value.
  1795. </param>
  1796. <param name="highwater">
  1797. If applicable, receives the highwater value.
  1798. </param>
  1799. <returns>
  1800. A standard SQLite return code.
  1801. </returns>
  1802. </member>
  1803. <member name="M:System.Data.SQLite.SQLite3.SetLimitOption(System.Data.SQLite.SQLiteLimitOpsEnum,System.Int32)">
  1804. <summary>
  1805. Change a limit value for the database.
  1806. </summary>
  1807. <param name="option">
  1808. The database limit to change.
  1809. </param>
  1810. <param name="value">
  1811. The new value for the specified limit.
  1812. </param>
  1813. <returns>
  1814. The old value for the specified limit -OR- negative one if an error
  1815. occurs.
  1816. </returns>
  1817. </member>
  1818. <member name="M:System.Data.SQLite.SQLite3.SetConfigurationOption(System.Data.SQLite.SQLiteConfigDbOpsEnum,System.Object)">
  1819. <summary>
  1820. Change a configuration option value for the database.
  1821. </summary>
  1822. <param name="option">
  1823. The database configuration option to change.
  1824. </param>
  1825. <param name="value">
  1826. The new value for the specified configuration option.
  1827. </param>
  1828. <returns>
  1829. A standard SQLite return code.
  1830. </returns>
  1831. </member>
  1832. <member name="M:System.Data.SQLite.SQLite3.SetLoadExtension(System.Boolean)">
  1833. <summary>
  1834. Enables or disables extension loading by SQLite.
  1835. </summary>
  1836. <param name="bOnOff">
  1837. True to enable loading of extensions, false to disable.
  1838. </param>
  1839. </member>
  1840. <member name="M:System.Data.SQLite.SQLite3.LoadExtension(System.String,System.String)">
  1841. <summary>
  1842. Loads a SQLite extension library from the named file.
  1843. </summary>
  1844. <param name="fileName">
  1845. The name of the dynamic link library file containing the extension.
  1846. </param>
  1847. <param name="procName">
  1848. The name of the exported function used to initialize the extension.
  1849. If null, the default "sqlite3_extension_init" will be used.
  1850. </param>
  1851. </member>
  1852. <member name="M:System.Data.SQLite.SQLite3.SetExtendedResultCodes(System.Boolean)">
  1853. Enables or disables extended result codes returned by SQLite
  1854. </member>
  1855. <member name="M:System.Data.SQLite.SQLite3.ResultCode">
  1856. Gets the last SQLite error code
  1857. </member>
  1858. <member name="M:System.Data.SQLite.SQLite3.ExtendedResultCode">
  1859. Gets the last SQLite extended error code
  1860. </member>
  1861. <member name="M:System.Data.SQLite.SQLite3.LogMessage(System.Data.SQLite.SQLiteErrorCode,System.String)">
  1862. Add a log message via the SQLite sqlite3_log interface.
  1863. </member>
  1864. <member name="M:System.Data.SQLite.SQLite3.StaticLogMessage(System.Data.SQLite.SQLiteErrorCode,System.String)">
  1865. Add a log message via the SQLite sqlite3_log interface.
  1866. </member>
  1867. <member name="M:System.Data.SQLite.SQLite3.SetLogCallback(System.Data.SQLite.SQLiteLogCallback)">
  1868. <summary>
  1869. Allows the setting of a logging callback invoked by SQLite when a
  1870. log event occurs. Only one callback may be set. If NULL is passed,
  1871. the logging callback is unregistered.
  1872. </summary>
  1873. <param name="func">The callback function to invoke.</param>
  1874. <returns>Returns a result code</returns>
  1875. </member>
  1876. <member name="M:System.Data.SQLite.SQLite3.AppendError(System.Text.StringBuilder,System.String)">
  1877. <summary>
  1878. Appends an error message and an appropriate line-ending to a <see cref="T:System.Text.StringBuilder"/>
  1879. instance. This is useful because the .NET Compact Framework has a slightly different set
  1880. of supported methods for the <see cref="T:System.Text.StringBuilder"/> class.
  1881. </summary>
  1882. <param name="builder">
  1883. The <see cref="T:System.Text.StringBuilder"/> instance to append to.
  1884. </param>
  1885. <param name="message">
  1886. The message to append. It will be followed by an appropriate line-ending.
  1887. </param>
  1888. </member>
  1889. <member name="M:System.Data.SQLite.SQLite3.UnhookNativeCallbacks(System.Boolean,System.Boolean)">
  1890. <summary>
  1891. This method attempts to cause the SQLite native library to invalidate
  1892. its function pointers that refer to this instance. This is necessary
  1893. to prevent calls from native code into delegates that may have been
  1894. garbage collected. Normally, these types of issues can only arise for
  1895. connections that are added to the pool; howver, it is good practice to
  1896. unconditionally invalidate function pointers that may refer to objects
  1897. being disposed.
  1898. </summary>
  1899. <param name="includeGlobal">
  1900. Non-zero to also invalidate global function pointers (i.e. those that
  1901. are not directly associated with this connection on the native side).
  1902. </param>
  1903. <param name="canThrow">
  1904. Non-zero if this method is being executed within a context where it can
  1905. throw an exception in the event of failure; otherwise, zero.
  1906. </param>
  1907. <returns>
  1908. Non-zero if this method was successful; otherwise, zero.
  1909. </returns>
  1910. </member>
  1911. <member name="M:System.Data.SQLite.SQLite3.FreeDbName(System.Boolean)">
  1912. <summary>
  1913. This method attempts to free the cached database name used with the
  1914. <see cref="M:System.Data.SQLite.SQLite3.SetConfigurationOption(System.Data.SQLite.SQLiteConfigDbOpsEnum,System.Object)"/> method.
  1915. </summary>
  1916. <param name="canThrow">
  1917. Non-zero if this method is being executed within a context where it can
  1918. throw an exception in the event of failure; otherwise, zero.
  1919. </param>
  1920. <returns>
  1921. Non-zero if this method was successful; otherwise, zero.
  1922. </returns>
  1923. </member>
  1924. <member name="M:System.Data.SQLite.SQLite3.InitializeBackup(System.Data.SQLite.SQLiteConnection,System.String,System.String)">
  1925. <summary>
  1926. Creates a new SQLite backup object based on the provided destination
  1927. database connection. The source database connection is the one
  1928. associated with this object. The source and destination database
  1929. connections cannot be the same.
  1930. </summary>
  1931. <param name="destCnn">The destination database connection.</param>
  1932. <param name="destName">The destination database name.</param>
  1933. <param name="sourceName">The source database name.</param>
  1934. <returns>The newly created backup object.</returns>
  1935. </member>
  1936. <member name="M:System.Data.SQLite.SQLite3.StepBackup(System.Data.SQLite.SQLiteBackup,System.Int32,System.Boolean@)">
  1937. <summary>
  1938. Copies up to N pages from the source database to the destination
  1939. database associated with the specified backup object.
  1940. </summary>
  1941. <param name="backup">The backup object to use.</param>
  1942. <param name="nPage">
  1943. The number of pages to copy, negative to copy all remaining pages.
  1944. </param>
  1945. <param name="retry">
  1946. Set to true if the operation needs to be retried due to database
  1947. locking issues; otherwise, set to false.
  1948. </param>
  1949. <returns>
  1950. True if there are more pages to be copied, false otherwise.
  1951. </returns>
  1952. </member>
  1953. <member name="M:System.Data.SQLite.SQLite3.RemainingBackup(System.Data.SQLite.SQLiteBackup)">
  1954. <summary>
  1955. Returns the number of pages remaining to be copied from the source
  1956. database to the destination database associated with the specified
  1957. backup object.
  1958. </summary>
  1959. <param name="backup">The backup object to check.</param>
  1960. <returns>The number of pages remaining to be copied.</returns>
  1961. </member>
  1962. <member name="M:System.Data.SQLite.SQLite3.PageCountBackup(System.Data.SQLite.SQLiteBackup)">
  1963. <summary>
  1964. Returns the total number of pages in the source database associated
  1965. with the specified backup object.
  1966. </summary>
  1967. <param name="backup">The backup object to check.</param>
  1968. <returns>The total number of pages in the source database.</returns>
  1969. </member>
  1970. <member name="M:System.Data.SQLite.SQLite3.FinishBackup(System.Data.SQLite.SQLiteBackup)">
  1971. <summary>
  1972. Destroys the backup object, rolling back any backup that may be in
  1973. progess.
  1974. </summary>
  1975. <param name="backup">The backup object to destroy.</param>
  1976. </member>
  1977. <member name="M:System.Data.SQLite.SQLite3.IsInitialized">
  1978. <summary>
  1979. Determines if the SQLite core library has been initialized for the
  1980. current process.
  1981. </summary>
  1982. <returns>
  1983. A boolean indicating whether or not the SQLite core library has been
  1984. initialized for the current process.
  1985. </returns>
  1986. </member>
  1987. <member name="M:System.Data.SQLite.SQLite3.StaticIsInitialized">
  1988. <summary>
  1989. Determines if the SQLite core library has been initialized for the
  1990. current process.
  1991. </summary>
  1992. <returns>
  1993. A boolean indicating whether or not the SQLite core library has been
  1994. initialized for the current process.
  1995. </returns>
  1996. </member>
  1997. <member name="M:System.Data.SQLite.SQLite3.GetValue(System.Data.SQLite.SQLiteStatement,System.Data.SQLite.SQLiteConnectionFlags,System.Int32,System.Data.SQLite.SQLiteType)">
  1998. <summary>
  1999. Helper function to retrieve a column of data from an active statement.
  2000. </summary>
  2001. <param name="stmt">The statement being step()'d through</param>
  2002. <param name="flags">The flags associated with the connection.</param>
  2003. <param name="index">The column index to retrieve</param>
  2004. <param name="typ">The type of data contained in the column. If Uninitialized, this function will retrieve the datatype information.</param>
  2005. <returns>Returns the data in the column</returns>
  2006. </member>
  2007. <member name="P:System.Data.SQLite.SQLite3.OwnHandle">
  2008. <summary>
  2009. Returns non-zero if the underlying native connection handle is owned
  2010. by this instance.
  2011. </summary>
  2012. </member>
  2013. <member name="P:System.Data.SQLite.SQLite3.Functions">
  2014. <summary>
  2015. Returns the logical list of functions associated with this connection.
  2016. </summary>
  2017. </member>
  2018. <member name="T:System.Data.SQLite.SQLite3_UTF16">
  2019. <summary>
  2020. Alternate SQLite3 object, overriding many text behaviors to support UTF-16 (Unicode)
  2021. </summary>
  2022. </member>
  2023. <member name="M:System.Data.SQLite.SQLite3_UTF16.#ctor(System.Data.SQLite.SQLiteDateFormats,System.DateTimeKind,System.String,System.IntPtr,System.String,System.Boolean)">
  2024. <summary>
  2025. Constructs the object used to interact with the SQLite core library
  2026. using the UTF-8 text encoding.
  2027. </summary>
  2028. <param name="fmt">
  2029. The DateTime format to be used when converting string values to a
  2030. DateTime and binding DateTime parameters.
  2031. </param>
  2032. <param name="kind">
  2033. The <see cref="T:System.DateTimeKind"/> to be used when creating DateTime
  2034. values.
  2035. </param>
  2036. <param name="fmtString">
  2037. The format string to be used when parsing and formatting DateTime
  2038. values.
  2039. </param>
  2040. <param name="db">
  2041. The native handle to be associated with the database connection.
  2042. </param>
  2043. <param name="fileName">
  2044. The fully qualified file name associated with <paramref name="db"/>.
  2045. </param>
  2046. <param name="ownHandle">
  2047. Non-zero if the newly created object instance will need to dispose
  2048. of <paramref name="db"/> when it is no longer needed.
  2049. </param>
  2050. </member>
  2051. <member name="M:System.Data.SQLite.SQLite3_UTF16.ToString(System.IntPtr,System.Int32)">
  2052. <summary>
  2053. Overrides SQLiteConvert.ToString() to marshal UTF-16 strings instead of UTF-8
  2054. </summary>
  2055. <param name="b">A pointer to a UTF-16 string</param>
  2056. <param name="nbytelen">The length (IN BYTES) of the string</param>
  2057. <returns>A .NET string</returns>
  2058. </member>
  2059. <member name="T:System.Data.SQLite.SQLiteBackup">
  2060. <summary>
  2061. Represents a single SQL backup in SQLite.
  2062. </summary>
  2063. </member>
  2064. <member name="F:System.Data.SQLite.SQLiteBackup._sql">
  2065. <summary>
  2066. The underlying SQLite object this backup is bound to.
  2067. </summary>
  2068. </member>
  2069. <member name="F:System.Data.SQLite.SQLiteBackup._sqlite_backup">
  2070. <summary>
  2071. The actual backup handle.
  2072. </summary>
  2073. </member>
  2074. <member name="F:System.Data.SQLite.SQLiteBackup._destDb">
  2075. <summary>
  2076. The destination database for the backup.
  2077. </summary>
  2078. </member>
  2079. <member name="F:System.Data.SQLite.SQLiteBackup._zDestName">
  2080. <summary>
  2081. The destination database name for the backup.
  2082. </summary>
  2083. </member>
  2084. <member name="F:System.Data.SQLite.SQLiteBackup._sourceDb">
  2085. <summary>
  2086. The source database for the backup.
  2087. </summary>
  2088. </member>
  2089. <member name="F:System.Data.SQLite.SQLiteBackup._zSourceName">
  2090. <summary>
  2091. The source database name for the backup.
  2092. </summary>
  2093. </member>
  2094. <member name="F:System.Data.SQLite.SQLiteBackup._stepResult">
  2095. <summary>
  2096. The last result from the StepBackup method of the SQLite3 class.
  2097. This is used to determine if the call to the FinishBackup method of
  2098. the SQLite3 class should throw an exception when it receives a non-Ok
  2099. return code from the core SQLite library.
  2100. </summary>
  2101. </member>
  2102. <member name="M:System.Data.SQLite.SQLiteBackup.#ctor(System.Data.SQLite.SQLiteBase,System.Data.SQLite.SQLiteBackupHandle,System.IntPtr,System.Byte[],System.IntPtr,System.Byte[])">
  2103. <summary>
  2104. Initializes the backup.
  2105. </summary>
  2106. <param name="sqlbase">The base SQLite object.</param>
  2107. <param name="backup">The backup handle.</param>
  2108. <param name="destDb">The destination database for the backup.</param>
  2109. <param name="zDestName">The destination database name for the backup.</param>
  2110. <param name="sourceDb">The source database for the backup.</param>
  2111. <param name="zSourceName">The source database name for the backup.</param>
  2112. </member>
  2113. <member name="M:System.Data.SQLite.SQLiteBackup.Dispose">
  2114. <summary>
  2115. Disposes and finalizes the backup.
  2116. </summary>
  2117. </member>
  2118. <member name="T:System.Data.SQLite.ISQLiteSchemaExtensions">
  2119. <summary>
  2120. </summary>
  2121. </member>
  2122. <member name="M:System.Data.SQLite.ISQLiteSchemaExtensions.BuildTempSchema(System.Data.SQLite.SQLiteConnection)">
  2123. <summary>
  2124. Creates temporary tables on the connection so schema information can be queried.
  2125. </summary>
  2126. <param name="connection">
  2127. The connection upon which to build the schema tables.
  2128. </param>
  2129. </member>
  2130. <member name="T:System.Data.SQLite.SQLiteConnectionFlags">
  2131. <summary>
  2132. The extra behavioral flags that can be applied to a connection.
  2133. </summary>
  2134. </member>
  2135. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.None">
  2136. <summary>
  2137. No extra flags.
  2138. </summary>
  2139. </member>
  2140. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.LogPrepare">
  2141. <summary>
  2142. Enable logging of all SQL statements to be prepared.
  2143. </summary>
  2144. </member>
  2145. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.LogPreBind">
  2146. <summary>
  2147. Enable logging of all bound parameter types and raw values.
  2148. </summary>
  2149. </member>
  2150. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.LogBind">
  2151. <summary>
  2152. Enable logging of all bound parameter strongly typed values.
  2153. </summary>
  2154. </member>
  2155. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.LogCallbackException">
  2156. <summary>
  2157. Enable logging of all exceptions caught from user-provided
  2158. managed code called from native code via delegates.
  2159. </summary>
  2160. </member>
  2161. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.LogBackup">
  2162. <summary>
  2163. Enable logging of backup API errors.
  2164. </summary>
  2165. </member>
  2166. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.NoExtensionFunctions">
  2167. <summary>
  2168. Skip adding the extension functions provided by the native
  2169. interop assembly.
  2170. </summary>
  2171. </member>
  2172. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.BindUInt32AsInt64">
  2173. <summary>
  2174. When binding parameter values with the <see cref="T:System.UInt32"/>
  2175. type, use the interop method that accepts an <see cref="T:System.Int64"/>
  2176. value.
  2177. </summary>
  2178. </member>
  2179. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.BindAllAsText">
  2180. <summary>
  2181. When binding parameter values, always bind them as though they were
  2182. plain text (i.e. no numeric, date/time, or other conversions should
  2183. be attempted).
  2184. </summary>
  2185. </member>
  2186. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.GetAllAsText">
  2187. <summary>
  2188. When returning column values, always return them as though they were
  2189. plain text (i.e. no numeric, date/time, or other conversions should
  2190. be attempted).
  2191. </summary>
  2192. </member>
  2193. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.NoLoadExtension">
  2194. <summary>
  2195. Prevent this <see cref="T:System.Data.SQLite.SQLiteConnection"/> object instance from
  2196. loading extensions.
  2197. </summary>
  2198. </member>
  2199. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.NoCreateModule">
  2200. <summary>
  2201. Prevent this <see cref="T:System.Data.SQLite.SQLiteConnection"/> object instance from
  2202. creating virtual table modules.
  2203. </summary>
  2204. </member>
  2205. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.NoBindFunctions">
  2206. <summary>
  2207. Skip binding any functions provided by other managed assemblies when
  2208. opening the connection.
  2209. </summary>
  2210. </member>
  2211. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.NoLogModule">
  2212. <summary>
  2213. Skip setting the logging related properties of the
  2214. <see cref="T:System.Data.SQLite.SQLiteModule"/> object instance that was passed to
  2215. the <see cref="M:System.Data.SQLite.SQLiteConnection.CreateModule(System.Data.SQLite.SQLiteModule)"/> method.
  2216. </summary>
  2217. </member>
  2218. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.LogModuleError">
  2219. <summary>
  2220. Enable logging of all virtual table module errors seen by the
  2221. <see cref="M:System.Data.SQLite.SQLiteModule.SetTableError(System.IntPtr,System.String)"/> method.
  2222. </summary>
  2223. </member>
  2224. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.LogModuleException">
  2225. <summary>
  2226. Enable logging of certain virtual table module exceptions that cannot
  2227. be easily discovered via other means.
  2228. </summary>
  2229. </member>
  2230. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.TraceWarning">
  2231. <summary>
  2232. Enable tracing of potentially important [non-fatal] error conditions
  2233. that cannot be easily reported through other means.
  2234. </summary>
  2235. </member>
  2236. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.ConvertInvariantText">
  2237. <summary>
  2238. When binding parameter values, always use the invariant culture when
  2239. converting their values from strings.
  2240. </summary>
  2241. </member>
  2242. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.BindInvariantText">
  2243. <summary>
  2244. When binding parameter values, always use the invariant culture when
  2245. converting their values to strings.
  2246. </summary>
  2247. </member>
  2248. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.NoConnectionPool">
  2249. <summary>
  2250. Disable using the connection pool by default. If the "Pooling"
  2251. connection string property is specified, its value will override
  2252. this flag. The precise outcome of combining this flag with the
  2253. <see cref="F:System.Data.SQLite.SQLiteConnectionFlags.UseConnectionPool"/> flag is unspecified; however,
  2254. one of the flags will be in effect.
  2255. </summary>
  2256. </member>
  2257. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.UseConnectionPool">
  2258. <summary>
  2259. Enable using the connection pool by default. If the "Pooling"
  2260. connection string property is specified, its value will override
  2261. this flag. The precise outcome of combining this flag with the
  2262. <see cref="F:System.Data.SQLite.SQLiteConnectionFlags.NoConnectionPool"/> flag is unspecified; however,
  2263. one of the flags will be in effect.
  2264. </summary>
  2265. </member>
  2266. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.UseConnectionTypes">
  2267. <summary>
  2268. Enable using per-connection mappings between type names and
  2269. <see cref="T:System.Data.DbType"/> values. Also see the
  2270. <see cref="M:System.Data.SQLite.SQLiteConnection.ClearTypeMappings"/>,
  2271. <see cref="M:System.Data.SQLite.SQLiteConnection.GetTypeMappings"/>, and
  2272. <see cref="M:System.Data.SQLite.SQLiteConnection.AddTypeMapping(System.String,System.Data.DbType,System.Boolean)"/> methods. These
  2273. per-connection mappings, when present, override the corresponding
  2274. global mappings.
  2275. </summary>
  2276. </member>
  2277. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.NoGlobalTypes">
  2278. <summary>
  2279. Disable using global mappings between type names and
  2280. <see cref="T:System.Data.DbType"/> values. This may be useful in some very narrow
  2281. cases; however, if there are no per-connection type mappings, the
  2282. fallback defaults will be used for both type names and their
  2283. associated <see cref="T:System.Data.DbType"/> values. Therefore, use of this flag
  2284. is not recommended.
  2285. </summary>
  2286. </member>
  2287. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.StickyHasRows">
  2288. <summary>
  2289. When the <see cref="P:System.Data.SQLite.SQLiteDataReader.HasRows"/> property is used, it
  2290. should return non-zero if there were ever any rows in the associated
  2291. result sets.
  2292. </summary>
  2293. </member>
  2294. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.StrictEnlistment">
  2295. <summary>
  2296. Enable "strict" transaction enlistment semantics. Setting this flag
  2297. will cause an exception to be thrown if an attempt is made to enlist
  2298. in a transaction with an unavailable or unsupported isolation level.
  2299. In the future, more extensive checks may be enabled by this flag as
  2300. well.
  2301. </summary>
  2302. </member>
  2303. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.MapIsolationLevels">
  2304. <summary>
  2305. Enable mapping of unsupported transaction isolation levels to the
  2306. closest supported transaction isolation level.
  2307. </summary>
  2308. </member>
  2309. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.DetectTextAffinity">
  2310. <summary>
  2311. When returning column values, attempt to detect the affinity of
  2312. textual values by checking if they fully conform to those of the
  2313. <see cref="F:System.Data.SQLite.TypeAffinity.Null"/>,
  2314. <see cref="F:System.Data.SQLite.TypeAffinity.Int64"/>,
  2315. <see cref="F:System.Data.SQLite.TypeAffinity.Double"/>,
  2316. or <see cref="F:System.Data.SQLite.TypeAffinity.DateTime"/> types.
  2317. </summary>
  2318. </member>
  2319. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.DetectStringType">
  2320. <summary>
  2321. When returning column values, attempt to detect the type of
  2322. string values by checking if they fully conform to those of
  2323. the <see cref="F:System.Data.SQLite.TypeAffinity.Null"/>,
  2324. <see cref="F:System.Data.SQLite.TypeAffinity.Int64"/>,
  2325. <see cref="F:System.Data.SQLite.TypeAffinity.Double"/>,
  2326. or <see cref="F:System.Data.SQLite.TypeAffinity.DateTime"/> types.
  2327. </summary>
  2328. </member>
  2329. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.NoConvertSettings">
  2330. <summary>
  2331. Skip querying runtime configuration settings for use by the
  2332. <see cref="T:System.Data.SQLite.SQLiteConvert"/> class, including the default
  2333. <see cref="T:System.Data.DbType"/> value and default database type name.
  2334. <b>NOTE: If the <see cref="P:System.Data.SQLite.SQLiteConnection.DefaultDbType"/>
  2335. and/or <see cref="P:System.Data.SQLite.SQLiteConnection.DefaultTypeName"/>
  2336. properties are not set explicitly nor set via their connection
  2337. string properties and repeated calls to determine these runtime
  2338. configuration settings are seen to be a problem, this flag
  2339. should be set.</b>
  2340. </summary>
  2341. </member>
  2342. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.BindDateTimeWithKind">
  2343. <summary>
  2344. When binding parameter values with the <see cref="T:System.DateTime"/>
  2345. type, take their <see cref="T:System.DateTimeKind"/> into account as
  2346. well as that of the associated <see cref="T:System.Data.SQLite.SQLiteConnection"/>.
  2347. </summary>
  2348. </member>
  2349. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.RollbackOnException">
  2350. <summary>
  2351. If an exception is caught when raising the
  2352. <see cref="E:System.Data.SQLite.SQLiteConnection.Commit"/> event, the transaction
  2353. should be rolled back. If this is not specified, the transaction
  2354. will continue the commit process instead.
  2355. </summary>
  2356. </member>
  2357. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.DenyOnException">
  2358. <summary>
  2359. If an exception is caught when raising the
  2360. <see cref="E:System.Data.SQLite.SQLiteConnection.Authorize"/> event, the action should
  2361. should be denied. If this is not specified, the action will be
  2362. allowed instead.
  2363. </summary>
  2364. </member>
  2365. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.InterruptOnException">
  2366. <summary>
  2367. If an exception is caught when raising the
  2368. <see cref="E:System.Data.SQLite.SQLiteConnection.Progress"/> event, the operation
  2369. should be interrupted. If this is not specified, the operation
  2370. will simply continue.
  2371. </summary>
  2372. </member>
  2373. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.UnbindFunctionsOnClose">
  2374. <summary>
  2375. Attempt to unbind all functions provided by other managed assemblies
  2376. when closing the connection.
  2377. </summary>
  2378. </member>
  2379. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.NoVerifyTextAffinity">
  2380. <summary>
  2381. When returning column values as a <see cref="T:System.String"/>, skip
  2382. verifying their affinity.
  2383. </summary>
  2384. </member>
  2385. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.UseConnectionBindValueCallbacks">
  2386. <summary>
  2387. Enable using per-connection mappings between type names and
  2388. <see cref="T:System.Data.SQLite.SQLiteBindValueCallback"/> values. Also see the
  2389. <see cref="M:System.Data.SQLite.SQLiteConnection.ClearTypeCallbacks"/>,
  2390. <see cref="M:System.Data.SQLite.SQLiteConnection.TryGetTypeCallbacks(System.String,System.Data.SQLite.SQLiteTypeCallbacks@)"/>, and
  2391. <see cref="M:System.Data.SQLite.SQLiteConnection.SetTypeCallbacks(System.String,System.Data.SQLite.SQLiteTypeCallbacks)"/> methods.
  2392. </summary>
  2393. </member>
  2394. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.UseConnectionReadValueCallbacks">
  2395. <summary>
  2396. Enable using per-connection mappings between type names and
  2397. <see cref="T:System.Data.SQLite.SQLiteReadValueCallback"/> values. Also see the
  2398. <see cref="M:System.Data.SQLite.SQLiteConnection.ClearTypeCallbacks"/>,
  2399. <see cref="M:System.Data.SQLite.SQLiteConnection.TryGetTypeCallbacks(System.String,System.Data.SQLite.SQLiteTypeCallbacks@)"/>, and
  2400. <see cref="M:System.Data.SQLite.SQLiteConnection.SetTypeCallbacks(System.String,System.Data.SQLite.SQLiteTypeCallbacks)"/> methods.
  2401. </summary>
  2402. </member>
  2403. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.UseParameterNameForTypeName">
  2404. <summary>
  2405. If the database type name has not been explicitly set for the
  2406. parameter specified, fallback to using the parameter name.
  2407. </summary>
  2408. </member>
  2409. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.UseParameterDbTypeForTypeName">
  2410. <summary>
  2411. If the database type name has not been explicitly set for the
  2412. parameter specified, fallback to using the database type name
  2413. associated with the <see cref="T:System.Data.DbType"/> value.
  2414. </summary>
  2415. </member>
  2416. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.NoVerifyTypeAffinity">
  2417. <summary>
  2418. When returning column values, skip verifying their affinity.
  2419. </summary>
  2420. </member>
  2421. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.AllowNestedTransactions">
  2422. <summary>
  2423. Allow transactions to be nested. The outermost transaction still
  2424. controls whether or not any changes are ultimately committed or
  2425. rolled back. All non-outermost transactions are implemented using
  2426. the SAVEPOINT construct.
  2427. </summary>
  2428. </member>
  2429. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.BindDecimalAsText">
  2430. <summary>
  2431. When binding parameter values, always bind <see cref="T:System.Decimal"/>
  2432. values as though they were plain text (i.e. not <see cref="T:System.Decimal"/>,
  2433. which is the legacy behavior).
  2434. </summary>
  2435. </member>
  2436. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.GetDecimalAsText">
  2437. <summary>
  2438. When returning column values, always return <see cref="T:System.Decimal"/>
  2439. values as though they were plain text (i.e. not <see cref="T:System.Double"/>,
  2440. which is the legacy behavior).
  2441. </summary>
  2442. </member>
  2443. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.BindInvariantDecimal">
  2444. <summary>
  2445. When binding <see cref="T:System.Decimal"/> parameter values, always use
  2446. the invariant culture when converting their values to strings.
  2447. </summary>
  2448. </member>
  2449. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.GetInvariantDecimal">
  2450. <summary>
  2451. When returning <see cref="T:System.Decimal"/> column values, always use
  2452. the invariant culture when converting their values from strings.
  2453. </summary>
  2454. </member>
  2455. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.WaitForEnlistmentReset">
  2456. <summary>
  2457. <b>EXPERIMENTAL</b> --
  2458. Enable waiting for the enlistment to be reset prior to attempting
  2459. to create a new enlistment. This may be necessary due to the
  2460. semantics used by distributed transactions, which complete
  2461. asynchronously.
  2462. </summary>
  2463. </member>
  2464. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.GetInvariantInt64">
  2465. <summary>
  2466. When returning <see cref="T:System.Int64"/> column values, always use
  2467. the invariant culture when converting their values from strings.
  2468. </summary>
  2469. </member>
  2470. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.GetInvariantDouble">
  2471. <summary>
  2472. When returning <see cref="T:System.Double"/> column values, always use
  2473. the invariant culture when converting their values from strings.
  2474. </summary>
  2475. </member>
  2476. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.StrictConformance">
  2477. <summary>
  2478. <b>EXPERIMENTAL</b> --
  2479. Enable strict conformance to the ADO.NET standard, e.g. use of
  2480. thrown exceptions to indicate common error conditions.
  2481. </summary>
  2482. </member>
  2483. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.HidePassword">
  2484. <summary>
  2485. <b>EXPERIMENTAL</b> --
  2486. When opening a connection, attempt to hide the password from the
  2487. connection string, etc. Given the memory architecture of the CLR,
  2488. (and P/Invoke) this is not 100% reliable and should not be relied
  2489. upon for security critical uses or applications.
  2490. </summary>
  2491. </member>
  2492. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.NoCoreFunctions">
  2493. <summary>
  2494. Skip adding the extension functions provided by the native interop
  2495. assembly if they would conflict with a function provided by the
  2496. SQLite core library.
  2497. </summary>
  2498. </member>
  2499. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.BindAndGetAllAsText">
  2500. <summary>
  2501. When binding parameter values or returning column values, always
  2502. treat them as though they were plain text (i.e. no numeric,
  2503. date/time, or other conversions should be attempted).
  2504. </summary>
  2505. </member>
  2506. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.ConvertAndBindInvariantText">
  2507. <summary>
  2508. When binding parameter values, always use the invariant culture when
  2509. converting their values to strings or from strings.
  2510. </summary>
  2511. </member>
  2512. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.BindAndGetAllAsInvariantText">
  2513. <summary>
  2514. When binding parameter values or returning column values, always
  2515. treat them as though they were plain text (i.e. no numeric,
  2516. date/time, or other conversions should be attempted) and always
  2517. use the invariant culture when converting their values to strings.
  2518. </summary>
  2519. </member>
  2520. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.ConvertAndBindAndGetAllAsInvariantText">
  2521. <summary>
  2522. When binding parameter values or returning column values, always
  2523. treat them as though they were plain text (i.e. no numeric,
  2524. date/time, or other conversions should be attempted) and always
  2525. use the invariant culture when converting their values to strings
  2526. or from strings.
  2527. </summary>
  2528. </member>
  2529. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.UseConnectionAllValueCallbacks">
  2530. <summary>
  2531. Enables use of all per-connection value handling callbacks.
  2532. </summary>
  2533. </member>
  2534. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.UseParameterAnythingForTypeName">
  2535. <summary>
  2536. Enables use of all applicable <see cref="T:System.Data.SQLite.SQLiteParameter"/>
  2537. properties as fallbacks for the database type name.
  2538. </summary>
  2539. </member>
  2540. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.LogAll">
  2541. <summary>
  2542. Enable all logging.
  2543. </summary>
  2544. </member>
  2545. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.LogDefault">
  2546. <summary>
  2547. The default logging related flags for new connections.
  2548. </summary>
  2549. </member>
  2550. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.Default">
  2551. <summary>
  2552. The default extra flags for new connections.
  2553. </summary>
  2554. </member>
  2555. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.DefaultAndLogAll">
  2556. <summary>
  2557. The default extra flags for new connections with all logging enabled.
  2558. </summary>
  2559. </member>
  2560. <member name="T:System.Data.SQLite.SQLiteStatusOpsEnum">
  2561. <summary>
  2562. These are the supported status parameters for use with the native
  2563. SQLite library.
  2564. </summary>
  2565. </member>
  2566. <member name="F:System.Data.SQLite.SQLiteStatusOpsEnum.SQLITE_DBSTATUS_LOOKASIDE_USED">
  2567. <summary>
  2568. This parameter returns the number of lookaside memory slots
  2569. currently checked out.
  2570. </summary>
  2571. </member>
  2572. <member name="F:System.Data.SQLite.SQLiteStatusOpsEnum.SQLITE_DBSTATUS_CACHE_USED">
  2573. <summary>
  2574. This parameter returns the approximate number of bytes of
  2575. heap memory used by all pager caches associated with the
  2576. database connection. The highwater mark associated with
  2577. SQLITE_DBSTATUS_CACHE_USED is always 0.
  2578. </summary>
  2579. </member>
  2580. <member name="F:System.Data.SQLite.SQLiteStatusOpsEnum.SQLITE_DBSTATUS_SCHEMA_USED">
  2581. <summary>
  2582. This parameter returns the approximate number of bytes of
  2583. heap memory used to store the schema for all databases
  2584. associated with the connection - main, temp, and any ATTACH-ed
  2585. databases. The full amount of memory used by the schemas is
  2586. reported, even if the schema memory is shared with other
  2587. database connections due to shared cache mode being enabled.
  2588. The highwater mark associated with SQLITE_DBSTATUS_SCHEMA_USED
  2589. is always 0.
  2590. </summary>
  2591. </member>
  2592. <member name="F:System.Data.SQLite.SQLiteStatusOpsEnum.SQLITE_DBSTATUS_STMT_USED">
  2593. <summary>
  2594. This parameter returns the number malloc attempts that might
  2595. have been satisfied using lookaside memory but failed due to
  2596. all lookaside memory already being in use. Only the high-water
  2597. value is meaningful; the current value is always zero.
  2598. </summary>
  2599. </member>
  2600. <member name="F:System.Data.SQLite.SQLiteStatusOpsEnum.SQLITE_DBSTATUS_LOOKASIDE_HIT">
  2601. <summary>
  2602. This parameter returns the number malloc attempts that were
  2603. satisfied using lookaside memory. Only the high-water value
  2604. is meaningful; the current value is always zero.
  2605. </summary>
  2606. </member>
  2607. <member name="F:System.Data.SQLite.SQLiteStatusOpsEnum.SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE">
  2608. <summary>
  2609. This parameter returns the number malloc attempts that might
  2610. have been satisfied using lookaside memory but failed due to
  2611. the amount of memory requested being larger than the lookaside
  2612. slot size. Only the high-water value is meaningful; the current
  2613. value is always zero.
  2614. </summary>
  2615. </member>
  2616. <member name="F:System.Data.SQLite.SQLiteStatusOpsEnum.SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL">
  2617. <summary>
  2618. This parameter returns the number malloc attempts that might
  2619. have been satisfied using lookaside memory but failed due to
  2620. the amount of memory requested being larger than the lookaside
  2621. slot size. Only the high-water value is meaningful; the current
  2622. value is always zero.
  2623. </summary>
  2624. </member>
  2625. <member name="F:System.Data.SQLite.SQLiteStatusOpsEnum.SQLITE_DBSTATUS_CACHE_HIT">
  2626. <summary>
  2627. This parameter returns the number of pager cache hits that
  2628. have occurred. The highwater mark associated with
  2629. SQLITE_DBSTATUS_CACHE_HIT is always 0.
  2630. </summary>
  2631. </member>
  2632. <member name="F:System.Data.SQLite.SQLiteStatusOpsEnum.SQLITE_DBSTATUS_CACHE_MISS">
  2633. <summary>
  2634. This parameter returns the number of pager cache misses that
  2635. have occurred. The highwater mark associated with
  2636. SQLITE_DBSTATUS_CACHE_MISS is always 0.
  2637. </summary>
  2638. </member>
  2639. <member name="F:System.Data.SQLite.SQLiteStatusOpsEnum.SQLITE_DBSTATUS_CACHE_WRITE">
  2640. <summary>
  2641. This parameter returns the number of dirty cache entries that
  2642. have been written to disk. Specifically, the number of pages
  2643. written to the wal file in wal mode databases, or the number
  2644. of pages written to the database file in rollback mode
  2645. databases. Any pages written as part of transaction rollback
  2646. or database recovery operations are not included. If an IO or
  2647. other error occurs while writing a page to disk, the effect
  2648. on subsequent SQLITE_DBSTATUS_CACHE_WRITE requests is
  2649. undefined. The highwater mark associated with
  2650. SQLITE_DBSTATUS_CACHE_WRITE is always 0.
  2651. </summary>
  2652. </member>
  2653. <member name="F:System.Data.SQLite.SQLiteStatusOpsEnum.SQLITE_DBSTATUS_DEFERRED_FKS">
  2654. <summary>
  2655. This parameter returns zero for the current value if and only
  2656. if all foreign key constraints (deferred or immediate) have
  2657. been resolved. The highwater mark is always 0.
  2658. </summary>
  2659. </member>
  2660. <member name="F:System.Data.SQLite.SQLiteStatusOpsEnum.SQLITE_DBSTATUS_CACHE_USED_SHARED">
  2661. <summary>
  2662. This parameter is similar to DBSTATUS_CACHE_USED, except that
  2663. if a pager cache is shared between two or more connections the
  2664. bytes of heap memory used by that pager cache is divided evenly
  2665. between the attached connections. In other words, if none of
  2666. the pager caches associated with the database connection are
  2667. shared, this request returns the same value as DBSTATUS_CACHE_USED.
  2668. Or, if one or more or the pager caches are shared, the value
  2669. returned by this call will be smaller than that returned by
  2670. DBSTATUS_CACHE_USED. The highwater mark associated with
  2671. SQLITE_DBSTATUS_CACHE_USED_SHARED is always 0.
  2672. </summary>
  2673. </member>
  2674. <member name="F:System.Data.SQLite.SQLiteStatusOpsEnum.SQLITE_DBSTATUS_CACHE_SPILL">
  2675. <summary>
  2676. This parameter returns the number of dirty cache entries that have
  2677. been written to disk in the middle of a transaction due to the page
  2678. cache overflowing. Transactions are more efficient if they are
  2679. written to disk all at once. When pages spill mid-transaction, that
  2680. introduces additional overhead. This parameter can be used help
  2681. identify inefficiencies that can be resolved by increasing the cache
  2682. size.
  2683. </summary>
  2684. </member>
  2685. <member name="T:System.Data.SQLite.SQLiteConfigDbOpsEnum">
  2686. <summary>
  2687. These are the supported configuration verbs for use with the native
  2688. SQLite library. They are used with the
  2689. <see cref="M:System.Data.SQLite.SQLiteConnection.SetConfigurationOption(System.Data.SQLite.SQLiteConfigDbOpsEnum,System.Object)"/> method.
  2690. </summary>
  2691. </member>
  2692. <member name="F:System.Data.SQLite.SQLiteConfigDbOpsEnum.SQLITE_DBCONFIG_NONE">
  2693. <summary>
  2694. This value represents an unknown (or invalid) option, do not use it.
  2695. </summary>
  2696. </member>
  2697. <member name="F:System.Data.SQLite.SQLiteConfigDbOpsEnum.SQLITE_DBCONFIG_MAINDBNAME">
  2698. <summary>
  2699. This option is used to change the name of the "main" database
  2700. schema. The sole argument is a pointer to a constant UTF8 string
  2701. which will become the new schema name in place of "main".
  2702. </summary>
  2703. </member>
  2704. <member name="F:System.Data.SQLite.SQLiteConfigDbOpsEnum.SQLITE_DBCONFIG_LOOKASIDE">
  2705. <summary>
  2706. This option is used to configure the lookaside memory allocator.
  2707. The value must be an array with three elements. The second element
  2708. must be an <see cref="T:System.Int32"/> containing the size of each buffer
  2709. slot. The third element must be an <see cref="T:System.Int32"/> containing
  2710. the number of slots. The first element must be an <see cref="T:System.IntPtr"/>
  2711. that points to a native memory buffer of bytes equal to or greater
  2712. than the product of the second and third element values.
  2713. </summary>
  2714. </member>
  2715. <member name="F:System.Data.SQLite.SQLiteConfigDbOpsEnum.SQLITE_DBCONFIG_ENABLE_FKEY">
  2716. <summary>
  2717. This option is used to enable or disable the enforcement of
  2718. foreign key constraints.
  2719. </summary>
  2720. </member>
  2721. <member name="F:System.Data.SQLite.SQLiteConfigDbOpsEnum.SQLITE_DBCONFIG_ENABLE_TRIGGER">
  2722. <summary>
  2723. This option is used to enable or disable triggers.
  2724. </summary>
  2725. </member>
  2726. <member name="F:System.Data.SQLite.SQLiteConfigDbOpsEnum.SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER">
  2727. <summary>
  2728. This option is used to enable or disable the two-argument version
  2729. of the fts3_tokenizer() function which is part of the FTS3 full-text
  2730. search engine extension.
  2731. </summary>
  2732. </member>
  2733. <member name="F:System.Data.SQLite.SQLiteConfigDbOpsEnum.SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION">
  2734. <summary>
  2735. This option is used to enable or disable the loading of extensions.
  2736. </summary>
  2737. </member>
  2738. <member name="F:System.Data.SQLite.SQLiteConfigDbOpsEnum.SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE">
  2739. <summary>
  2740. This option is used to enable or disable the automatic checkpointing
  2741. when a WAL database is closed.
  2742. </summary>
  2743. </member>
  2744. <member name="F:System.Data.SQLite.SQLiteConfigDbOpsEnum.SQLITE_DBCONFIG_ENABLE_QPSG">
  2745. <summary>
  2746. This option is used to enable or disable the query planner stability
  2747. guarantee (QPSG).
  2748. </summary>
  2749. </member>
  2750. <member name="F:System.Data.SQLite.SQLiteConfigDbOpsEnum.SQLITE_DBCONFIG_TRIGGER_EQP">
  2751. <summary>
  2752. This option is used to enable or disable the extra EXPLAIN QUERY PLAN
  2753. output for trigger programs.
  2754. </summary>
  2755. </member>
  2756. <member name="F:System.Data.SQLite.SQLiteConfigDbOpsEnum.SQLITE_DBCONFIG_RESET_DATABASE">
  2757. <summary>
  2758. This option is used as part of the process to reset a database back
  2759. to an empty state. Because resetting a database is destructive and
  2760. irreversible, the process requires the use of this obscure flag and
  2761. multiple steps to help ensure that it does not happen by accident.
  2762. </summary>
  2763. </member>
  2764. <member name="F:System.Data.SQLite.SQLiteConfigDbOpsEnum.SQLITE_DBCONFIG_DEFENSIVE">
  2765. <summary>
  2766. This option activates or deactivates the "defensive" flag for a
  2767. database connection. When the defensive flag is enabled, language
  2768. features that allow ordinary SQL to deliberately corrupt the database
  2769. file are disabled. The disabled features include but are not limited
  2770. to the following:
  2771. <![CDATA[<ul>]]>
  2772. <![CDATA[<li>]]>
  2773. The PRAGMA writable_schema=ON statement.
  2774. <![CDATA[</li>]]>
  2775. <![CDATA[<li>]]>
  2776. The PRAGMA journal_mode=OFF statement.
  2777. <![CDATA[</li>]]>
  2778. <![CDATA[<li>]]>
  2779. Writes to the sqlite_dbpage virtual table.
  2780. <![CDATA[</li>]]>
  2781. <![CDATA[<li>]]>
  2782. Direct writes to shadow tables.
  2783. <![CDATA[</li>]]>
  2784. <![CDATA[</ul>]]>
  2785. </summary>
  2786. </member>
  2787. <member name="F:System.Data.SQLite.SQLiteConfigDbOpsEnum.SQLITE_DBCONFIG_WRITABLE_SCHEMA">
  2788. <summary>
  2789. This option activates or deactivates the "writable_schema" flag.
  2790. </summary>
  2791. </member>
  2792. <member name="F:System.Data.SQLite.SQLiteConfigDbOpsEnum.SQLITE_DBCONFIG_LEGACY_ALTER_TABLE">
  2793. <summary>
  2794. This option activates or deactivates the legacy behavior of the ALTER
  2795. TABLE RENAME command such it behaves as it did prior to version 3.24.0
  2796. (2018-06-04).
  2797. </summary>
  2798. </member>
  2799. <member name="F:System.Data.SQLite.SQLiteConfigDbOpsEnum.SQLITE_DBCONFIG_DQS_DML">
  2800. <summary>
  2801. This option activates or deactivates the legacy double-quoted string
  2802. literal misfeature for DML statement only, that is DELETE, INSERT,
  2803. SELECT, and UPDATE statements.
  2804. </summary>
  2805. </member>
  2806. <member name="F:System.Data.SQLite.SQLiteConfigDbOpsEnum.SQLITE_DBCONFIG_DQS_DDL">
  2807. <summary>
  2808. This option activates or deactivates the legacy double-quoted string
  2809. literal misfeature for DDL statements, such as CREATE TABLE and CREATE
  2810. INDEX.
  2811. </summary>
  2812. </member>
  2813. <member name="F:System.Data.SQLite.SQLiteConfigDbOpsEnum.SQLITE_DBCONFIG_ENABLE_VIEW">
  2814. <summary>
  2815. This option is used to enable or disable CREATE VIEW.
  2816. </summary>
  2817. </member>
  2818. <member name="F:System.Data.SQLite.SQLiteConfigDbOpsEnum.SQLITE_DBCONFIG_LEGACY_FILE_FORMAT">
  2819. <summary>
  2820. This option activates or deactivates the legacy file format flag.
  2821. </summary>
  2822. </member>
  2823. <member name="F:System.Data.SQLite.SQLiteConfigDbOpsEnum.SQLITE_DBCONFIG_TRUSTED_SCHEMA">
  2824. <summary>
  2825. This option tells SQLite to assume that database schemas (i.e. the
  2826. contents of the sqlite_master tables) are untainted by malicious
  2827. content. When the trusted schema option is disabled, SQLite takes
  2828. additional defensive steps to protect the application from harm
  2829. including:
  2830. <![CDATA[<ul>]]>
  2831. <![CDATA[<li>]]>
  2832. Prohibit the use of SQL functions inside triggers, views, CHECK
  2833. constraints, DEFAULT clauses, expression indexes, partial indexes,
  2834. or generated columns unless those functions are tagged with
  2835. SQLITE_INNOCUOUS.
  2836. <![CDATA[</li>]]>
  2837. <![CDATA[<li>]]>
  2838. Prohibit the use of virtual tables inside of triggers or views
  2839. unless those virtual tables are tagged with SQLITE_VTAB_INNOCUOUS.
  2840. <![CDATA[</ul>]]>
  2841. This setting defaults to "on" for legacy compatibility, however
  2842. all applications are advised to turn it off if possible. This
  2843. setting can also be controlled using the PRAGMA trusted_schema
  2844. statement.
  2845. </summary>
  2846. </member>
  2847. <member name="T:System.Data.SQLite.SQLiteTraceFlags">
  2848. <summary>
  2849. These constants are used with the sqlite3_trace_v2() API and the
  2850. callbacks registered by it.
  2851. </summary>
  2852. </member>
  2853. <member name="T:System.Data.SQLite.SQLiteLimitOpsEnum">
  2854. <summary>
  2855. These constants are used with the sqlite3_limit() API.
  2856. </summary>
  2857. </member>
  2858. <member name="F:System.Data.SQLite.SQLiteLimitOpsEnum.SQLITE_LIMIT_NONE">
  2859. <summary>
  2860. This value represents an unknown (or invalid) limit, do not use it.
  2861. </summary>
  2862. </member>
  2863. <member name="F:System.Data.SQLite.SQLiteLimitOpsEnum.SQLITE_LIMIT_LENGTH">
  2864. <summary>
  2865. The maximum size of any string or BLOB or table row, in bytes.
  2866. </summary>
  2867. </member>
  2868. <member name="F:System.Data.SQLite.SQLiteLimitOpsEnum.SQLITE_LIMIT_SQL_LENGTH">
  2869. <summary>
  2870. The maximum length of an SQL statement, in bytes.
  2871. </summary>
  2872. </member>
  2873. <member name="F:System.Data.SQLite.SQLiteLimitOpsEnum.SQLITE_LIMIT_COLUMN">
  2874. <summary>
  2875. The maximum number of columns in a table definition or in the
  2876. result set of a SELECT or the maximum number of columns in an
  2877. index or in an ORDER BY or GROUP BY clause.
  2878. </summary>
  2879. </member>
  2880. <member name="F:System.Data.SQLite.SQLiteLimitOpsEnum.SQLITE_LIMIT_EXPR_DEPTH">
  2881. <summary>
  2882. The maximum depth of the parse tree on any expression.
  2883. </summary>
  2884. </member>
  2885. <member name="F:System.Data.SQLite.SQLiteLimitOpsEnum.SQLITE_LIMIT_COMPOUND_SELECT">
  2886. <summary>
  2887. The maximum number of terms in a compound SELECT statement.
  2888. </summary>
  2889. </member>
  2890. <member name="F:System.Data.SQLite.SQLiteLimitOpsEnum.SQLITE_LIMIT_VDBE_OP">
  2891. <summary>
  2892. The maximum number of instructions in a virtual machine program
  2893. used to implement an SQL statement. If sqlite3_prepare_v2() or
  2894. the equivalent tries to allocate space for more than this many
  2895. opcodes in a single prepared statement, an SQLITE_NOMEM error
  2896. is returned.
  2897. </summary>
  2898. </member>
  2899. <member name="F:System.Data.SQLite.SQLiteLimitOpsEnum.SQLITE_LIMIT_FUNCTION_ARG">
  2900. <summary>
  2901. The maximum number of arguments on a function.
  2902. </summary>
  2903. </member>
  2904. <member name="F:System.Data.SQLite.SQLiteLimitOpsEnum.SQLITE_LIMIT_ATTACHED">
  2905. <summary>
  2906. The maximum number of attached databases.
  2907. </summary>
  2908. </member>
  2909. <member name="F:System.Data.SQLite.SQLiteLimitOpsEnum.SQLITE_LIMIT_LIKE_PATTERN_LENGTH">
  2910. <summary>
  2911. The maximum length of the pattern argument to the LIKE or GLOB
  2912. operators.
  2913. </summary>
  2914. </member>
  2915. <member name="F:System.Data.SQLite.SQLiteLimitOpsEnum.SQLITE_LIMIT_VARIABLE_NUMBER">
  2916. <summary>
  2917. The maximum index number of any parameter in an SQL statement.
  2918. </summary>
  2919. </member>
  2920. <member name="F:System.Data.SQLite.SQLiteLimitOpsEnum.SQLITE_LIMIT_TRIGGER_DEPTH">
  2921. <summary>
  2922. The maximum depth of recursion for triggers.
  2923. </summary>
  2924. </member>
  2925. <member name="F:System.Data.SQLite.SQLiteLimitOpsEnum.SQLITE_LIMIT_WORKER_THREADS">
  2926. <summary>
  2927. The maximum number of auxiliary worker threads that a single
  2928. prepared statement may start.
  2929. </summary>
  2930. </member>
  2931. <member name="T:System.Data.SQLite.SQLiteBlob">
  2932. <summary>
  2933. Represents a single SQL blob in SQLite.
  2934. </summary>
  2935. </member>
  2936. <member name="F:System.Data.SQLite.SQLiteBlob._sql">
  2937. <summary>
  2938. The underlying SQLite object this blob is bound to.
  2939. </summary>
  2940. </member>
  2941. <member name="F:System.Data.SQLite.SQLiteBlob._sqlite_blob">
  2942. <summary>
  2943. The actual blob handle.
  2944. </summary>
  2945. </member>
  2946. <member name="M:System.Data.SQLite.SQLiteBlob.#ctor(System.Data.SQLite.SQLiteBase,System.Data.SQLite.SQLiteBlobHandle)">
  2947. <summary>
  2948. Initializes the blob.
  2949. </summary>
  2950. <param name="sqlbase">The base SQLite object.</param>
  2951. <param name="blob">The blob handle.</param>
  2952. </member>
  2953. <member name="M:System.Data.SQLite.SQLiteBlob.Create(System.Data.SQLite.SQLiteDataReader,System.Int32,System.Boolean)">
  2954. <summary>
  2955. Creates a <see cref="T:System.Data.SQLite.SQLiteBlob"/> object. This will not work
  2956. for tables that were created WITHOUT ROWID -OR- if the query
  2957. does not include the "rowid" column or one of its aliases -OR-
  2958. if the <see cref="T:System.Data.SQLite.SQLiteDataReader"/> was not created with the
  2959. <see cref="F:System.Data.CommandBehavior.KeyInfo"/> flag.
  2960. </summary>
  2961. <param name="dataReader">
  2962. The <see cref="T:System.Data.SQLite.SQLiteDataReader"/> instance with a result set
  2963. containing the desired blob column.
  2964. </param>
  2965. <param name="i">
  2966. The index of the blob column.
  2967. </param>
  2968. <param name="readOnly">
  2969. Non-zero to open the blob object for read-only access.
  2970. </param>
  2971. <returns>
  2972. The newly created <see cref="T:System.Data.SQLite.SQLiteBlob"/> instance -OR- null
  2973. if an error occurs.
  2974. </returns>
  2975. </member>
  2976. <member name="M:System.Data.SQLite.SQLiteBlob.Create(System.Data.SQLite.SQLiteConnection,System.String,System.String,System.String,System.Int64,System.Boolean)">
  2977. <summary>
  2978. Creates a <see cref="T:System.Data.SQLite.SQLiteBlob"/> object. This will not work
  2979. for tables that were created WITHOUT ROWID.
  2980. </summary>
  2981. <param name="connection">
  2982. The connection to use when opening the blob object.
  2983. </param>
  2984. <param name="databaseName">
  2985. The name of the database containing the blob object.
  2986. </param>
  2987. <param name="tableName">
  2988. The name of the table containing the blob object.
  2989. </param>
  2990. <param name="columnName">
  2991. The name of the column containing the blob object.
  2992. </param>
  2993. <param name="rowId">
  2994. The integer identifier for the row associated with the desired
  2995. blob object.
  2996. </param>
  2997. <param name="readOnly">
  2998. Non-zero to open the blob object for read-only access.
  2999. </param>
  3000. <returns>
  3001. The newly created <see cref="T:System.Data.SQLite.SQLiteBlob"/> instance -OR- null
  3002. if an error occurs.
  3003. </returns>
  3004. </member>
  3005. <member name="M:System.Data.SQLite.SQLiteBlob.CheckOpen">
  3006. <summary>
  3007. Throws an exception if the blob object does not appear to be open.
  3008. </summary>
  3009. </member>
  3010. <member name="M:System.Data.SQLite.SQLiteBlob.VerifyParameters(System.Byte[],System.Int32,System.Int32)">
  3011. <summary>
  3012. Throws an exception if an invalid read/write parameter is detected.
  3013. </summary>
  3014. <param name="buffer">
  3015. When reading, this array will be populated with the bytes read from
  3016. the underlying database blob. When writing, this array contains new
  3017. values for the specified portion of the underlying database blob.
  3018. </param>
  3019. <param name="count">
  3020. The number of bytes to read or write.
  3021. </param>
  3022. <param name="offset">
  3023. The byte offset, relative to the start of the underlying database
  3024. blob, where the read or write operation will begin.
  3025. </param>
  3026. </member>
  3027. <member name="M:System.Data.SQLite.SQLiteBlob.Reopen(System.Int64)">
  3028. <summary>
  3029. Retargets this object to an underlying database blob for a
  3030. different row; the database, table, and column remain exactly
  3031. the same. If this operation fails for any reason, this blob
  3032. object is automatically disposed.
  3033. </summary>
  3034. <param name="rowId">
  3035. The integer identifier for the new row.
  3036. </param>
  3037. </member>
  3038. <member name="M:System.Data.SQLite.SQLiteBlob.GetCount">
  3039. <summary>
  3040. Queries the total number of bytes for the underlying database blob.
  3041. </summary>
  3042. <returns>
  3043. The total number of bytes for the underlying database blob.
  3044. </returns>
  3045. </member>
  3046. <member name="M:System.Data.SQLite.SQLiteBlob.Read(System.Byte[],System.Int32,System.Int32)">
  3047. <summary>
  3048. Reads data from the underlying database blob.
  3049. </summary>
  3050. <param name="buffer">
  3051. This array will be populated with the bytes read from the
  3052. underlying database blob.
  3053. </param>
  3054. <param name="count">
  3055. The number of bytes to read.
  3056. </param>
  3057. <param name="offset">
  3058. The byte offset, relative to the start of the underlying
  3059. database blob, where the read operation will begin.
  3060. </param>
  3061. </member>
  3062. <member name="M:System.Data.SQLite.SQLiteBlob.Write(System.Byte[],System.Int32,System.Int32)">
  3063. <summary>
  3064. Writes data into the underlying database blob.
  3065. </summary>
  3066. <param name="buffer">
  3067. This array contains the new values for the specified portion of
  3068. the underlying database blob.
  3069. </param>
  3070. <param name="count">
  3071. The number of bytes to write.
  3072. </param>
  3073. <param name="offset">
  3074. The byte offset, relative to the start of the underlying
  3075. database blob, where the write operation will begin.
  3076. </param>
  3077. </member>
  3078. <member name="M:System.Data.SQLite.SQLiteBlob.Close">
  3079. <summary>
  3080. Closes the blob, freeing the associated resources.
  3081. </summary>
  3082. </member>
  3083. <member name="M:System.Data.SQLite.SQLiteBlob.Dispose">
  3084. <summary>
  3085. Disposes and finalizes the blob.
  3086. </summary>
  3087. </member>
  3088. <member name="M:System.Data.SQLite.SQLiteBlob.Finalize">
  3089. <summary>
  3090. The destructor.
  3091. </summary>
  3092. </member>
  3093. <member name="T:System.Data.SQLite.SQLiteCommand">
  3094. <summary>
  3095. SQLite implementation of DbCommand.
  3096. </summary>
  3097. </member>
  3098. <member name="F:System.Data.SQLite.SQLiteCommand.DefaultConnectionString">
  3099. <summary>
  3100. The default connection string to be used when creating a temporary
  3101. connection to execute a command via the static
  3102. <see cref="M:System.Data.SQLite.SQLiteCommand.Execute(System.String,System.Data.SQLite.SQLiteExecuteType,System.String,System.Object[])"/> or
  3103. <see cref="M:System.Data.SQLite.SQLiteCommand.Execute(System.String,System.Data.SQLite.SQLiteExecuteType,System.Data.CommandBehavior,System.String,System.Object[])"/>
  3104. methods.
  3105. </summary>
  3106. </member>
  3107. <member name="F:System.Data.SQLite.SQLiteCommand._commandText">
  3108. <summary>
  3109. The command text this command is based on
  3110. </summary>
  3111. </member>
  3112. <member name="F:System.Data.SQLite.SQLiteCommand._cnn">
  3113. <summary>
  3114. The connection the command is associated with
  3115. </summary>
  3116. </member>
  3117. <member name="F:System.Data.SQLite.SQLiteCommand._version">
  3118. <summary>
  3119. The version of the connection the command is associated with
  3120. </summary>
  3121. </member>
  3122. <member name="F:System.Data.SQLite.SQLiteCommand._activeReader">
  3123. <summary>
  3124. Indicates whether or not a DataReader is active on the command.
  3125. </summary>
  3126. </member>
  3127. <member name="F:System.Data.SQLite.SQLiteCommand._commandTimeout">
  3128. <summary>
  3129. The timeout for the command, kludged because SQLite doesn't support per-command timeout values
  3130. </summary>
  3131. </member>
  3132. <member name="F:System.Data.SQLite.SQLiteCommand._designTimeVisible">
  3133. <summary>
  3134. Designer support
  3135. </summary>
  3136. </member>
  3137. <member name="F:System.Data.SQLite.SQLiteCommand._updateRowSource">
  3138. <summary>
  3139. Used by DbDataAdapter to determine updating behavior
  3140. </summary>
  3141. </member>
  3142. <member name="F:System.Data.SQLite.SQLiteCommand._parameterCollection">
  3143. <summary>
  3144. The collection of parameters for the command
  3145. </summary>
  3146. </member>
  3147. <member name="F:System.Data.SQLite.SQLiteCommand._statementList">
  3148. <summary>
  3149. The SQL command text, broken into individual SQL statements as they are executed
  3150. </summary>
  3151. </member>
  3152. <member name="F:System.Data.SQLite.SQLiteCommand._remainingText">
  3153. <summary>
  3154. Unprocessed SQL text that has not been executed
  3155. </summary>
  3156. </member>
  3157. <member name="F:System.Data.SQLite.SQLiteCommand._transaction">
  3158. <summary>
  3159. Transaction associated with this command
  3160. </summary>
  3161. </member>
  3162. <member name="M:System.Data.SQLite.SQLiteCommand.#ctor">
  3163. <overloads>
  3164. Constructs a new SQLiteCommand
  3165. </overloads>
  3166. <summary>
  3167. Default constructor
  3168. </summary>
  3169. </member>
  3170. <member name="M:System.Data.SQLite.SQLiteCommand.#ctor(System.String)">
  3171. <summary>
  3172. Initializes the command with the given command text
  3173. </summary>
  3174. <param name="commandText">The SQL command text</param>
  3175. </member>
  3176. <member name="M:System.Data.SQLite.SQLiteCommand.#ctor(System.String,System.Data.SQLite.SQLiteConnection)">
  3177. <summary>
  3178. Initializes the command with the given SQL command text and attach the command to the specified
  3179. connection.
  3180. </summary>
  3181. <param name="commandText">The SQL command text</param>
  3182. <param name="connection">The connection to associate with the command</param>
  3183. </member>
  3184. <member name="M:System.Data.SQLite.SQLiteCommand.#ctor(System.Data.SQLite.SQLiteConnection)">
  3185. <summary>
  3186. Initializes the command and associates it with the specified connection.
  3187. </summary>
  3188. <param name="connection">The connection to associate with the command</param>
  3189. </member>
  3190. <member name="M:System.Data.SQLite.SQLiteCommand.#ctor(System.String,System.Data.SQLite.SQLiteConnection,System.Data.SQLite.SQLiteTransaction)">
  3191. <summary>
  3192. Initializes a command with the given SQL, connection and transaction
  3193. </summary>
  3194. <param name="commandText">The SQL command text</param>
  3195. <param name="connection">The connection to associate with the command</param>
  3196. <param name="transaction">The transaction the command should be associated with</param>
  3197. </member>
  3198. <member name="M:System.Data.SQLite.SQLiteCommand.Dispose(System.Boolean)">
  3199. <summary>
  3200. Disposes of the command and clears all member variables
  3201. </summary>
  3202. <param name="disposing">Whether or not the class is being explicitly or implicitly disposed</param>
  3203. </member>
  3204. <member name="M:System.Data.SQLite.SQLiteCommand.GetFlags(System.Data.SQLite.SQLiteCommand)">
  3205. <summary>
  3206. This method attempts to query the flags associated with the database
  3207. connection in use. If the database connection is disposed, the default
  3208. flags will be returned.
  3209. </summary>
  3210. <param name="command">
  3211. The command containing the databse connection to query the flags from.
  3212. </param>
  3213. <returns>
  3214. The connection flags value.
  3215. </returns>
  3216. </member>
  3217. <member name="M:System.Data.SQLite.SQLiteCommand.ClearCommands">
  3218. <summary>
  3219. Clears and destroys all statements currently prepared
  3220. </summary>
  3221. </member>
  3222. <member name="M:System.Data.SQLite.SQLiteCommand.BuildNextCommand">
  3223. <summary>
  3224. Builds an array of prepared statements for each complete SQL statement in the command text
  3225. </summary>
  3226. </member>
  3227. <member name="M:System.Data.SQLite.SQLiteCommand.Cancel">
  3228. <summary>
  3229. Not implemented
  3230. </summary>
  3231. </member>
  3232. <member name="M:System.Data.SQLite.SQLiteCommand.CreateDbParameter">
  3233. <summary>
  3234. Forwards to the local CreateParameter() function
  3235. </summary>
  3236. <returns></returns>
  3237. </member>
  3238. <member name="M:System.Data.SQLite.SQLiteCommand.CreateParameter">
  3239. <summary>
  3240. Create a new parameter
  3241. </summary>
  3242. <returns></returns>
  3243. </member>
  3244. <member name="M:System.Data.SQLite.SQLiteCommand.VerifyOnly">
  3245. <summary>
  3246. Verifies that all SQL queries associated with the current command text
  3247. can be successfully compiled. A <see cref="T:System.Data.SQLite.SQLiteException"/> will be
  3248. raised if any errors occur.
  3249. </summary>
  3250. </member>
  3251. <member name="M:System.Data.SQLite.SQLiteCommand.InitializeForReader">
  3252. <summary>
  3253. This function ensures there are no active readers, that we have a valid connection,
  3254. that the connection is open, that all statements are prepared and all parameters are assigned
  3255. in preparation for allocating a data reader.
  3256. </summary>
  3257. </member>
  3258. <member name="M:System.Data.SQLite.SQLiteCommand.ExecuteDbDataReader(System.Data.CommandBehavior)">
  3259. <summary>
  3260. Creates a new SQLiteDataReader to execute/iterate the array of SQLite prepared statements
  3261. </summary>
  3262. <param name="behavior">The behavior the data reader should adopt</param>
  3263. <returns>Returns a SQLiteDataReader object</returns>
  3264. </member>
  3265. <member name="M:System.Data.SQLite.SQLiteCommand.Execute(System.String,System.Data.SQLite.SQLiteExecuteType,System.String,System.Object[])">
  3266. <summary>
  3267. This method creates a new connection, executes the query using the given
  3268. execution type, closes the connection, and returns the results. If the
  3269. connection string is null, a temporary in-memory database connection will
  3270. be used.
  3271. </summary>
  3272. <param name="commandText">
  3273. The text of the command to be executed.
  3274. </param>
  3275. <param name="executeType">
  3276. The execution type for the command. This is used to determine which method
  3277. of the command object to call, which then determines the type of results
  3278. returned, if any.
  3279. </param>
  3280. <param name="connectionString">
  3281. The connection string to the database to be opened, used, and closed. If
  3282. this parameter is null, a temporary in-memory databse will be used.
  3283. </param>
  3284. <param name="args">
  3285. The SQL parameter values to be used when building the command object to be
  3286. executed, if any.
  3287. </param>
  3288. <returns>
  3289. The results of the query -OR- null if no results were produced from the
  3290. given execution type.
  3291. </returns>
  3292. </member>
  3293. <member name="M:System.Data.SQLite.SQLiteCommand.Execute(System.String,System.Data.SQLite.SQLiteExecuteType,System.Data.CommandBehavior,System.String,System.Object[])">
  3294. <summary>
  3295. This method creates a new connection, executes the query using the given
  3296. execution type and command behavior, closes the connection unless a data
  3297. reader is created, and returns the results. If the connection string is
  3298. null, a temporary in-memory database connection will be used.
  3299. </summary>
  3300. <param name="commandText">
  3301. The text of the command to be executed.
  3302. </param>
  3303. <param name="executeType">
  3304. The execution type for the command. This is used to determine which method
  3305. of the command object to call, which then determines the type of results
  3306. returned, if any.
  3307. </param>
  3308. <param name="commandBehavior">
  3309. The command behavior flags for the command.
  3310. </param>
  3311. <param name="connectionString">
  3312. The connection string to the database to be opened, used, and closed. If
  3313. this parameter is null, a temporary in-memory databse will be used.
  3314. </param>
  3315. <param name="args">
  3316. The SQL parameter values to be used when building the command object to be
  3317. executed, if any.
  3318. </param>
  3319. <returns>
  3320. The results of the query -OR- null if no results were produced from the
  3321. given execution type.
  3322. </returns>
  3323. </member>
  3324. <member name="M:System.Data.SQLite.SQLiteCommand.Execute(System.String,System.Data.SQLite.SQLiteExecuteType,System.Data.CommandBehavior,System.Data.SQLite.SQLiteConnection,System.Object[])">
  3325. <summary>
  3326. This method executes a query using the given execution type and command
  3327. behavior and returns the results.
  3328. </summary>
  3329. <param name="commandText">
  3330. The text of the command to be executed.
  3331. </param>
  3332. <param name="executeType">
  3333. The execution type for the command. This is used to determine which method
  3334. of the command object to call, which then determines the type of results
  3335. returned, if any.
  3336. </param>
  3337. <param name="commandBehavior">
  3338. The command behavior flags for the command.
  3339. </param>
  3340. <param name="connection">
  3341. The connection used to create and execute the command.
  3342. </param>
  3343. <param name="args">
  3344. The SQL parameter values to be used when building the command object to be
  3345. executed, if any.
  3346. </param>
  3347. <returns>
  3348. The results of the query -OR- null if no results were produced from the
  3349. given execution type.
  3350. </returns>
  3351. </member>
  3352. <member name="M:System.Data.SQLite.SQLiteCommand.ExecuteReader(System.Data.CommandBehavior)">
  3353. <summary>
  3354. Overrides the default behavior to return a SQLiteDataReader specialization class
  3355. </summary>
  3356. <param name="behavior">The flags to be associated with the reader.</param>
  3357. <returns>A SQLiteDataReader</returns>
  3358. </member>
  3359. <member name="M:System.Data.SQLite.SQLiteCommand.ExecuteReader">
  3360. <summary>
  3361. Overrides the default behavior of DbDataReader to return a specialized SQLiteDataReader class
  3362. </summary>
  3363. <returns>A SQLiteDataReader</returns>
  3364. </member>
  3365. <member name="M:System.Data.SQLite.SQLiteCommand.ResetDataReader">
  3366. <summary>
  3367. Called by the SQLiteDataReader when the data reader is closed.
  3368. </summary>
  3369. </member>
  3370. <member name="M:System.Data.SQLite.SQLiteCommand.ExecuteNonQuery">
  3371. <summary>
  3372. Execute the command and return the number of rows inserted/updated affected by it.
  3373. </summary>
  3374. <returns>The number of rows inserted/updated affected by it.</returns>
  3375. </member>
  3376. <member name="M:System.Data.SQLite.SQLiteCommand.ExecuteNonQuery(System.Data.CommandBehavior)">
  3377. <summary>
  3378. Execute the command and return the number of rows inserted/updated affected by it.
  3379. </summary>
  3380. <param name="behavior">The flags to be associated with the reader.</param>
  3381. <returns>The number of rows inserted/updated affected by it.</returns>
  3382. </member>
  3383. <member name="M:System.Data.SQLite.SQLiteCommand.ExecuteScalar">
  3384. <summary>
  3385. Execute the command and return the first column of the first row of the resultset
  3386. (if present), or null if no resultset was returned.
  3387. </summary>
  3388. <returns>The first column of the first row of the first resultset from the query.</returns>
  3389. </member>
  3390. <member name="M:System.Data.SQLite.SQLiteCommand.ExecuteScalar(System.Data.CommandBehavior)">
  3391. <summary>
  3392. Execute the command and return the first column of the first row of the resultset
  3393. (if present), or null if no resultset was returned.
  3394. </summary>
  3395. <param name="behavior">The flags to be associated with the reader.</param>
  3396. <returns>The first column of the first row of the first resultset from the query.</returns>
  3397. </member>
  3398. <member name="M:System.Data.SQLite.SQLiteCommand.Reset">
  3399. <summary>
  3400. This method resets all the prepared statements held by this instance
  3401. back to their initial states, ready to be re-executed.
  3402. </summary>
  3403. </member>
  3404. <member name="M:System.Data.SQLite.SQLiteCommand.Reset(System.Boolean,System.Boolean)">
  3405. <summary>
  3406. This method resets all the prepared statements held by this instance
  3407. back to their initial states, ready to be re-executed.
  3408. </summary>
  3409. <param name="clearBindings">
  3410. Non-zero if the parameter bindings should be cleared as well.
  3411. </param>
  3412. <param name="ignoreErrors">
  3413. If this is zero, a <see cref="T:System.Data.SQLite.SQLiteException"/> may be thrown for
  3414. any unsuccessful return codes from the native library; otherwise, a
  3415. <see cref="T:System.Data.SQLite.SQLiteException"/> will only be thrown if the connection
  3416. or its state is invalid.
  3417. </param>
  3418. </member>
  3419. <member name="M:System.Data.SQLite.SQLiteCommand.Prepare">
  3420. <summary>
  3421. Does nothing. Commands are prepared as they are executed the first time, and kept in prepared state afterwards.
  3422. </summary>
  3423. </member>
  3424. <member name="M:System.Data.SQLite.SQLiteCommand.Clone">
  3425. <summary>
  3426. Clones a command, including all its parameters
  3427. </summary>
  3428. <returns>A new SQLiteCommand with the same commandtext, connection and parameters</returns>
  3429. </member>
  3430. <member name="P:System.Data.SQLite.SQLiteCommand.CommandText">
  3431. <summary>
  3432. The SQL command text associated with the command
  3433. </summary>
  3434. </member>
  3435. <member name="P:System.Data.SQLite.SQLiteCommand.CommandTimeout">
  3436. <summary>
  3437. The amount of time to wait for the connection to become available before erroring out
  3438. </summary>
  3439. </member>
  3440. <member name="P:System.Data.SQLite.SQLiteCommand.CommandType">
  3441. <summary>
  3442. The type of the command. SQLite only supports CommandType.Text
  3443. </summary>
  3444. </member>
  3445. <member name="P:System.Data.SQLite.SQLiteCommand.Connection">
  3446. <summary>
  3447. The connection associated with this command
  3448. </summary>
  3449. </member>
  3450. <member name="P:System.Data.SQLite.SQLiteCommand.DbConnection">
  3451. <summary>
  3452. Forwards to the local Connection property
  3453. </summary>
  3454. </member>
  3455. <member name="P:System.Data.SQLite.SQLiteCommand.Parameters">
  3456. <summary>
  3457. Returns the SQLiteParameterCollection for the given command
  3458. </summary>
  3459. </member>
  3460. <member name="P:System.Data.SQLite.SQLiteCommand.DbParameterCollection">
  3461. <summary>
  3462. Forwards to the local Parameters property
  3463. </summary>
  3464. </member>
  3465. <member name="P:System.Data.SQLite.SQLiteCommand.Transaction">
  3466. <summary>
  3467. The transaction associated with this command. SQLite only supports one transaction per connection, so this property forwards to the
  3468. command's underlying connection.
  3469. </summary>
  3470. </member>
  3471. <member name="P:System.Data.SQLite.SQLiteCommand.DbTransaction">
  3472. <summary>
  3473. Forwards to the local Transaction property
  3474. </summary>
  3475. </member>
  3476. <member name="P:System.Data.SQLite.SQLiteCommand.UpdatedRowSource">
  3477. <summary>
  3478. Sets the method the SQLiteCommandBuilder uses to determine how to update inserted or updated rows in a DataTable.
  3479. </summary>
  3480. </member>
  3481. <member name="P:System.Data.SQLite.SQLiteCommand.DesignTimeVisible">
  3482. <summary>
  3483. Determines if the command is visible at design time. Defaults to True.
  3484. </summary>
  3485. </member>
  3486. <member name="T:System.Data.SQLite.SQLiteCommandBuilder">
  3487. <summary>
  3488. SQLite implementation of DbCommandBuilder.
  3489. </summary>
  3490. </member>
  3491. <member name="M:System.Data.SQLite.SQLiteCommandBuilder.#ctor">
  3492. <summary>
  3493. Default constructor
  3494. </summary>
  3495. </member>
  3496. <member name="M:System.Data.SQLite.SQLiteCommandBuilder.#ctor(System.Data.SQLite.SQLiteDataAdapter)">
  3497. <summary>
  3498. Initializes the command builder and associates it with the specified data adapter.
  3499. </summary>
  3500. <param name="adp"></param>
  3501. </member>
  3502. <member name="M:System.Data.SQLite.SQLiteCommandBuilder.Dispose(System.Boolean)">
  3503. <summary>
  3504. Cleans up resources (native and managed) associated with the current instance.
  3505. </summary>
  3506. <param name="disposing">
  3507. Zero when being disposed via garbage collection; otherwise, non-zero.
  3508. </param>
  3509. </member>
  3510. <member name="M:System.Data.SQLite.SQLiteCommandBuilder.ApplyParameterInfo(System.Data.Common.DbParameter,System.Data.DataRow,System.Data.StatementType,System.Boolean)">
  3511. <summary>
  3512. Minimal amount of parameter processing. Primarily sets the DbType for the parameter equal to the provider type in the schema
  3513. </summary>
  3514. <param name="parameter">The parameter to use in applying custom behaviors to a row</param>
  3515. <param name="row">The row to apply the parameter to</param>
  3516. <param name="statementType">The type of statement</param>
  3517. <param name="whereClause">Whether the application of the parameter is part of a WHERE clause</param>
  3518. </member>
  3519. <member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetParameterName(System.String)">
  3520. <summary>
  3521. Returns a valid named parameter
  3522. </summary>
  3523. <param name="parameterName">The name of the parameter</param>
  3524. <returns>Error</returns>
  3525. </member>
  3526. <member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetParameterName(System.Int32)">
  3527. <summary>
  3528. Returns a named parameter for the given ordinal
  3529. </summary>
  3530. <param name="parameterOrdinal">The i of the parameter</param>
  3531. <returns>Error</returns>
  3532. </member>
  3533. <member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetParameterPlaceholder(System.Int32)">
  3534. <summary>
  3535. Returns a placeholder character for the specified parameter i.
  3536. </summary>
  3537. <param name="parameterOrdinal">The index of the parameter to provide a placeholder for</param>
  3538. <returns>Returns a named parameter</returns>
  3539. </member>
  3540. <member name="M:System.Data.SQLite.SQLiteCommandBuilder.SetRowUpdatingHandler(System.Data.Common.DbDataAdapter)">
  3541. <summary>
  3542. Sets the handler for receiving row updating events. Used by the DbCommandBuilder to autogenerate SQL
  3543. statements that may not have previously been generated.
  3544. </summary>
  3545. <param name="adapter">A data adapter to receive events on.</param>
  3546. </member>
  3547. <member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetDeleteCommand">
  3548. <summary>
  3549. Returns the automatically-generated SQLite command to delete rows from the database
  3550. </summary>
  3551. <returns></returns>
  3552. </member>
  3553. <member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetDeleteCommand(System.Boolean)">
  3554. <summary>
  3555. Returns the automatically-generated SQLite command to delete rows from the database
  3556. </summary>
  3557. <param name="useColumnsForParameterNames"></param>
  3558. <returns></returns>
  3559. </member>
  3560. <member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetUpdateCommand">
  3561. <summary>
  3562. Returns the automatically-generated SQLite command to update rows in the database
  3563. </summary>
  3564. <returns></returns>
  3565. </member>
  3566. <member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetUpdateCommand(System.Boolean)">
  3567. <summary>
  3568. Returns the automatically-generated SQLite command to update rows in the database
  3569. </summary>
  3570. <param name="useColumnsForParameterNames"></param>
  3571. <returns></returns>
  3572. </member>
  3573. <member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetInsertCommand">
  3574. <summary>
  3575. Returns the automatically-generated SQLite command to insert rows into the database
  3576. </summary>
  3577. <returns></returns>
  3578. </member>
  3579. <member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetInsertCommand(System.Boolean)">
  3580. <summary>
  3581. Returns the automatically-generated SQLite command to insert rows into the database
  3582. </summary>
  3583. <param name="useColumnsForParameterNames"></param>
  3584. <returns></returns>
  3585. </member>
  3586. <member name="M:System.Data.SQLite.SQLiteCommandBuilder.QuoteIdentifier(System.String)">
  3587. <summary>
  3588. Places brackets around an identifier
  3589. </summary>
  3590. <param name="unquotedIdentifier">The identifier to quote</param>
  3591. <returns>The bracketed identifier</returns>
  3592. </member>
  3593. <member name="M:System.Data.SQLite.SQLiteCommandBuilder.UnquoteIdentifier(System.String)">
  3594. <summary>
  3595. Removes brackets around an identifier
  3596. </summary>
  3597. <param name="quotedIdentifier">The quoted (bracketed) identifier</param>
  3598. <returns>The undecorated identifier</returns>
  3599. </member>
  3600. <member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetSchemaTable(System.Data.Common.DbCommand)">
  3601. <summary>
  3602. Override helper, which can help the base command builder choose the right keys for the given query
  3603. </summary>
  3604. <param name="sourceCommand"></param>
  3605. <returns></returns>
  3606. </member>
  3607. <member name="P:System.Data.SQLite.SQLiteCommandBuilder.DataAdapter">
  3608. <summary>
  3609. Gets/sets the DataAdapter for this CommandBuilder
  3610. </summary>
  3611. </member>
  3612. <member name="P:System.Data.SQLite.SQLiteCommandBuilder.CatalogLocation">
  3613. <summary>
  3614. Overridden to hide its property from the designer
  3615. </summary>
  3616. </member>
  3617. <member name="P:System.Data.SQLite.SQLiteCommandBuilder.CatalogSeparator">
  3618. <summary>
  3619. Overridden to hide its property from the designer
  3620. </summary>
  3621. </member>
  3622. <member name="P:System.Data.SQLite.SQLiteCommandBuilder.QuotePrefix">
  3623. <summary>
  3624. Overridden to hide its property from the designer
  3625. </summary>
  3626. </member>
  3627. <member name="P:System.Data.SQLite.SQLiteCommandBuilder.QuoteSuffix">
  3628. <summary>
  3629. Overridden to hide its property from the designer
  3630. </summary>
  3631. </member>
  3632. <member name="P:System.Data.SQLite.SQLiteCommandBuilder.SchemaSeparator">
  3633. <summary>
  3634. Overridden to hide its property from the designer
  3635. </summary>
  3636. </member>
  3637. <member name="T:System.Data.SQLite.SQLiteDataReaderValue">
  3638. <summary>
  3639. This class represents a single value to be returned
  3640. from the <see cref="T:System.Data.SQLite.SQLiteDataReader"/> class via
  3641. its <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBlob(System.Int32,System.Boolean)"/>,
  3642. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBoolean(System.Int32)"/>,
  3643. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetByte(System.Int32)"/>,
  3644. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)"/>,
  3645. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChar(System.Int32)"/>,
  3646. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)"/>,
  3647. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetDateTime(System.Int32)"/>,
  3648. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetDecimal(System.Int32)"/>,
  3649. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetDouble(System.Int32)"/>,
  3650. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetFloat(System.Int32)"/>,
  3651. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetGuid(System.Int32)"/>,
  3652. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetInt16(System.Int32)"/>,
  3653. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetInt32(System.Int32)"/>,
  3654. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetInt64(System.Int32)"/>,
  3655. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetString(System.Int32)"/>, or
  3656. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetValue(System.Int32)"/> method. If the value of the
  3657. associated public field of this class is null upon returning from the
  3658. callback, the null value will only be used if the return type for the
  3659. <see cref="T:System.Data.SQLite.SQLiteDataReader"/> method called is not a value type.
  3660. If the value to be returned from the <see cref="T:System.Data.SQLite.SQLiteDataReader"/>
  3661. method is unsuitable (e.g. null with a value type), an exception will
  3662. be thrown.
  3663. </summary>
  3664. </member>
  3665. <member name="F:System.Data.SQLite.SQLiteDataReaderValue.BlobValue">
  3666. <summary>
  3667. The value to be returned from the
  3668. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBlob(System.Int32,System.Boolean)"/> method -OR- null to
  3669. indicate an error.
  3670. </summary>
  3671. </member>
  3672. <member name="F:System.Data.SQLite.SQLiteDataReaderValue.BooleanValue">
  3673. <summary>
  3674. The value to be returned from the
  3675. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBoolean(System.Int32)"/> method -OR- null to
  3676. indicate an error.
  3677. </summary>
  3678. </member>
  3679. <member name="F:System.Data.SQLite.SQLiteDataReaderValue.ByteValue">
  3680. <summary>
  3681. The value to be returned from the
  3682. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetByte(System.Int32)"/> method -OR- null to
  3683. indicate an error.
  3684. </summary>
  3685. </member>
  3686. <member name="F:System.Data.SQLite.SQLiteDataReaderValue.BytesValue">
  3687. <summary>
  3688. The value to be returned from the
  3689. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)"/> method.
  3690. </summary>
  3691. </member>
  3692. <member name="F:System.Data.SQLite.SQLiteDataReaderValue.CharValue">
  3693. <summary>
  3694. The value to be returned from the
  3695. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChar(System.Int32)"/> method -OR- null to
  3696. indicate an error.
  3697. </summary>
  3698. </member>
  3699. <member name="F:System.Data.SQLite.SQLiteDataReaderValue.CharsValue">
  3700. <summary>
  3701. The value to be returned from the
  3702. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)"/> method.
  3703. </summary>
  3704. </member>
  3705. <member name="F:System.Data.SQLite.SQLiteDataReaderValue.DateTimeValue">
  3706. <summary>
  3707. The value to be returned from the
  3708. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetDateTime(System.Int32)"/> method -OR- null to
  3709. indicate an error.
  3710. </summary>
  3711. </member>
  3712. <member name="F:System.Data.SQLite.SQLiteDataReaderValue.DecimalValue">
  3713. <summary>
  3714. The value to be returned from the
  3715. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetDecimal(System.Int32)"/> method -OR- null to
  3716. indicate an error.
  3717. </summary>
  3718. </member>
  3719. <member name="F:System.Data.SQLite.SQLiteDataReaderValue.DoubleValue">
  3720. <summary>
  3721. The value to be returned from the
  3722. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetDouble(System.Int32)"/> method -OR- null to
  3723. indicate an error.
  3724. </summary>
  3725. </member>
  3726. <member name="F:System.Data.SQLite.SQLiteDataReaderValue.FloatValue">
  3727. <summary>
  3728. The value to be returned from the
  3729. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetFloat(System.Int32)"/> method -OR- null to
  3730. indicate an error.
  3731. </summary>
  3732. </member>
  3733. <member name="F:System.Data.SQLite.SQLiteDataReaderValue.GuidValue">
  3734. <summary>
  3735. The value to be returned from the
  3736. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetGuid(System.Int32)"/> method -OR- null to
  3737. indicate an error.
  3738. </summary>
  3739. </member>
  3740. <member name="F:System.Data.SQLite.SQLiteDataReaderValue.Int16Value">
  3741. <summary>
  3742. The value to be returned from the
  3743. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetInt16(System.Int32)"/> method -OR- null to
  3744. indicate an error.
  3745. </summary>
  3746. </member>
  3747. <member name="F:System.Data.SQLite.SQLiteDataReaderValue.Int32Value">
  3748. <summary>
  3749. The value to be returned from the
  3750. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetInt32(System.Int32)"/> method -OR- null to
  3751. indicate an error.
  3752. </summary>
  3753. </member>
  3754. <member name="F:System.Data.SQLite.SQLiteDataReaderValue.Int64Value">
  3755. <summary>
  3756. The value to be returned from the
  3757. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetInt64(System.Int32)"/> method -OR- null to
  3758. indicate an error.
  3759. </summary>
  3760. </member>
  3761. <member name="F:System.Data.SQLite.SQLiteDataReaderValue.StringValue">
  3762. <summary>
  3763. The value to be returned from the
  3764. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetString(System.Int32)"/> method.
  3765. </summary>
  3766. </member>
  3767. <member name="F:System.Data.SQLite.SQLiteDataReaderValue.Value">
  3768. <summary>
  3769. The value to be returned from the
  3770. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetValue(System.Int32)"/> method.
  3771. </summary>
  3772. </member>
  3773. <member name="T:System.Data.SQLite.SQLiteReadEventArgs">
  3774. <summary>
  3775. This class represents the parameters that are provided
  3776. to the <see cref="T:System.Data.SQLite.SQLiteDataReader"/> methods, with
  3777. the exception of the column index (provided separately).
  3778. </summary>
  3779. </member>
  3780. <member name="T:System.Data.SQLite.SQLiteReadBlobEventArgs">
  3781. <summary>
  3782. This class represents the parameters that are provided to
  3783. the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBlob(System.Int32,System.Boolean)"/> method, with
  3784. the exception of the column index (provided separately).
  3785. </summary>
  3786. </member>
  3787. <member name="F:System.Data.SQLite.SQLiteReadBlobEventArgs.readOnly">
  3788. <summary>
  3789. Provides the underlying storage for the
  3790. <see cref="P:System.Data.SQLite.SQLiteReadBlobEventArgs.ReadOnly"/> property.
  3791. </summary>
  3792. </member>
  3793. <member name="M:System.Data.SQLite.SQLiteReadBlobEventArgs.#ctor(System.Boolean)">
  3794. <summary>
  3795. Constructs an instance of this class to pass into a user-defined
  3796. callback associated with the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBlob(System.Int32,System.Boolean)"/>
  3797. method.
  3798. </summary>
  3799. <param name="readOnly">
  3800. The value that was originally specified for the "readOnly"
  3801. parameter to the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBlob(System.Int32,System.Boolean)"/> method.
  3802. </param>
  3803. </member>
  3804. <member name="P:System.Data.SQLite.SQLiteReadBlobEventArgs.ReadOnly">
  3805. <summary>
  3806. The value that was originally specified for the "readOnly"
  3807. parameter to the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBlob(System.Int32,System.Boolean)"/> method.
  3808. </summary>
  3809. </member>
  3810. <member name="T:System.Data.SQLite.SQLiteReadArrayEventArgs">
  3811. <summary>
  3812. This class represents the parameters that are provided
  3813. to the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)"/> and
  3814. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)"/> methods, with
  3815. the exception of the column index (provided separately).
  3816. </summary>
  3817. </member>
  3818. <member name="F:System.Data.SQLite.SQLiteReadArrayEventArgs.dataOffset">
  3819. <summary>
  3820. Provides the underlying storage for the
  3821. <see cref="P:System.Data.SQLite.SQLiteReadArrayEventArgs.DataOffset"/> property.
  3822. </summary>
  3823. </member>
  3824. <member name="F:System.Data.SQLite.SQLiteReadArrayEventArgs.byteBuffer">
  3825. <summary>
  3826. Provides the underlying storage for the
  3827. <see cref="P:System.Data.SQLite.SQLiteReadArrayEventArgs.ByteBuffer"/> property.
  3828. </summary>
  3829. </member>
  3830. <member name="F:System.Data.SQLite.SQLiteReadArrayEventArgs.charBuffer">
  3831. <summary>
  3832. Provides the underlying storage for the
  3833. <see cref="P:System.Data.SQLite.SQLiteReadArrayEventArgs.CharBuffer"/> property.
  3834. </summary>
  3835. </member>
  3836. <member name="F:System.Data.SQLite.SQLiteReadArrayEventArgs.bufferOffset">
  3837. <summary>
  3838. Provides the underlying storage for the
  3839. <see cref="P:System.Data.SQLite.SQLiteReadArrayEventArgs.BufferOffset"/> property.
  3840. </summary>
  3841. </member>
  3842. <member name="F:System.Data.SQLite.SQLiteReadArrayEventArgs.length">
  3843. <summary>
  3844. Provides the underlying storage for the
  3845. <see cref="P:System.Data.SQLite.SQLiteReadArrayEventArgs.Length"/> property.
  3846. </summary>
  3847. </member>
  3848. <member name="M:System.Data.SQLite.SQLiteReadArrayEventArgs.#ctor(System.Int64,System.Byte[],System.Int32,System.Int32)">
  3849. <summary>
  3850. Constructs an instance of this class to pass into a user-defined
  3851. callback associated with the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)"/>
  3852. method.
  3853. </summary>
  3854. <param name="dataOffset">
  3855. The value that was originally specified for the "dataOffset"
  3856. parameter to the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)"/> or
  3857. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)"/> methods.
  3858. </param>
  3859. <param name="byteBuffer">
  3860. The value that was originally specified for the "buffer"
  3861. parameter to the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)"/>
  3862. method.
  3863. </param>
  3864. <param name="bufferOffset">
  3865. The value that was originally specified for the "bufferOffset"
  3866. parameter to the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)"/> or
  3867. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)"/> methods.
  3868. </param>
  3869. <param name="length">
  3870. The value that was originally specified for the "length"
  3871. parameter to the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)"/> or
  3872. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)"/> methods.
  3873. </param>
  3874. </member>
  3875. <member name="M:System.Data.SQLite.SQLiteReadArrayEventArgs.#ctor(System.Int64,System.Char[],System.Int32,System.Int32)">
  3876. <summary>
  3877. Constructs an instance of this class to pass into a user-defined
  3878. callback associated with the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)"/>
  3879. method.
  3880. </summary>
  3881. <param name="dataOffset">
  3882. The value that was originally specified for the "dataOffset"
  3883. parameter to the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)"/> or
  3884. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)"/> methods.
  3885. </param>
  3886. <param name="charBuffer">
  3887. The value that was originally specified for the "buffer"
  3888. parameter to the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)"/>
  3889. method.
  3890. </param>
  3891. <param name="bufferOffset">
  3892. The value that was originally specified for the "bufferOffset"
  3893. parameter to the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)"/> or
  3894. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)"/> methods.
  3895. </param>
  3896. <param name="length">
  3897. The value that was originally specified for the "length"
  3898. parameter to the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)"/> or
  3899. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)"/> methods.
  3900. </param>
  3901. </member>
  3902. <member name="P:System.Data.SQLite.SQLiteReadArrayEventArgs.DataOffset">
  3903. <summary>
  3904. The value that was originally specified for the "dataOffset"
  3905. parameter to the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)"/> or
  3906. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)"/> methods.
  3907. </summary>
  3908. </member>
  3909. <member name="P:System.Data.SQLite.SQLiteReadArrayEventArgs.ByteBuffer">
  3910. <summary>
  3911. The value that was originally specified for the "buffer"
  3912. parameter to the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)"/>
  3913. method.
  3914. </summary>
  3915. </member>
  3916. <member name="P:System.Data.SQLite.SQLiteReadArrayEventArgs.CharBuffer">
  3917. <summary>
  3918. The value that was originally specified for the "buffer"
  3919. parameter to the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)"/>
  3920. method.
  3921. </summary>
  3922. </member>
  3923. <member name="P:System.Data.SQLite.SQLiteReadArrayEventArgs.BufferOffset">
  3924. <summary>
  3925. The value that was originally specified for the "bufferOffset"
  3926. parameter to the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)"/> or
  3927. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)"/> methods.
  3928. </summary>
  3929. </member>
  3930. <member name="P:System.Data.SQLite.SQLiteReadArrayEventArgs.Length">
  3931. <summary>
  3932. The value that was originally specified for the "length"
  3933. parameter to the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)"/> or
  3934. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)"/> methods.
  3935. </summary>
  3936. </member>
  3937. <member name="T:System.Data.SQLite.SQLiteReadValueEventArgs">
  3938. <summary>
  3939. This class represents the parameters and return values for the
  3940. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBlob(System.Int32,System.Boolean)"/>,
  3941. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBoolean(System.Int32)"/>,
  3942. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetByte(System.Int32)"/>,
  3943. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)"/>,
  3944. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChar(System.Int32)"/>,
  3945. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)"/>,
  3946. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetDateTime(System.Int32)"/>,
  3947. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetDecimal(System.Int32)"/>,
  3948. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetDouble(System.Int32)"/>,
  3949. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetFloat(System.Int32)"/>,
  3950. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetGuid(System.Int32)"/>,
  3951. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetInt16(System.Int32)"/>,
  3952. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetInt32(System.Int32)"/>,
  3953. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetInt64(System.Int32)"/>,
  3954. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetString(System.Int32)"/>, and
  3955. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetValue(System.Int32)"/> methods.
  3956. </summary>
  3957. </member>
  3958. <member name="F:System.Data.SQLite.SQLiteReadValueEventArgs.methodName">
  3959. <summary>
  3960. Provides the underlying storage for the
  3961. <see cref="P:System.Data.SQLite.SQLiteReadValueEventArgs.MethodName"/> property.
  3962. </summary>
  3963. </member>
  3964. <member name="F:System.Data.SQLite.SQLiteReadValueEventArgs.extraEventArgs">
  3965. <summary>
  3966. Provides the underlying storage for the
  3967. <see cref="P:System.Data.SQLite.SQLiteReadValueEventArgs.ExtraEventArgs"/> property.
  3968. </summary>
  3969. </member>
  3970. <member name="F:System.Data.SQLite.SQLiteReadValueEventArgs.value">
  3971. <summary>
  3972. Provides the underlying storage for the
  3973. <see cref="P:System.Data.SQLite.SQLiteReadValueEventArgs.Value"/> property.
  3974. </summary>
  3975. </member>
  3976. <member name="M:System.Data.SQLite.SQLiteReadValueEventArgs.#ctor(System.String,System.Data.SQLite.SQLiteReadEventArgs,System.Data.SQLite.SQLiteDataReaderValue)">
  3977. <summary>
  3978. Constructs a new instance of this class. Depending on the method
  3979. being called, the <paramref name="extraEventArgs"/> and/or
  3980. <paramref name="value"/> parameters may be null.
  3981. </summary>
  3982. <param name="methodName">
  3983. The name of the <see cref="T:System.Data.SQLite.SQLiteDataReader"/> method that was
  3984. responsible for invoking this callback.
  3985. </param>
  3986. <param name="extraEventArgs">
  3987. If the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)"/> or
  3988. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)"/> method is being called,
  3989. this object will contain the array related parameters for that
  3990. method. If the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBlob(System.Int32,System.Boolean)"/> method is
  3991. being called, this object will contain the blob related parameters
  3992. for that method.
  3993. </param>
  3994. <param name="value">
  3995. This may be used by the callback to set the return value for the
  3996. called <see cref="T:System.Data.SQLite.SQLiteDataReader"/> method.
  3997. </param>
  3998. </member>
  3999. <member name="P:System.Data.SQLite.SQLiteReadValueEventArgs.MethodName">
  4000. <summary>
  4001. The name of the <see cref="T:System.Data.SQLite.SQLiteDataReader"/> method that was
  4002. responsible for invoking this callback.
  4003. </summary>
  4004. </member>
  4005. <member name="P:System.Data.SQLite.SQLiteReadValueEventArgs.ExtraEventArgs">
  4006. <summary>
  4007. If the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)"/> or
  4008. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)"/> method is being called,
  4009. this object will contain the array related parameters for that
  4010. method. If the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBlob(System.Int32,System.Boolean)"/> method is
  4011. being called, this object will contain the blob related parameters
  4012. for that method.
  4013. </summary>
  4014. </member>
  4015. <member name="P:System.Data.SQLite.SQLiteReadValueEventArgs.Value">
  4016. <summary>
  4017. This may be used by the callback to set the return value for the
  4018. called <see cref="T:System.Data.SQLite.SQLiteDataReader"/> method.
  4019. </summary>
  4020. </member>
  4021. <member name="T:System.Data.SQLite.SQLiteBindValueCallback">
  4022. <summary>
  4023. This represents a method that will be called in response to a request to
  4024. bind a parameter to a command. If an exception is thrown, it will cause
  4025. the parameter binding operation to fail -AND- it will continue to unwind
  4026. the call stack.
  4027. </summary>
  4028. <param name="convert">
  4029. The <see cref="T:System.Data.SQLite.SQLiteConvert"/> instance in use.
  4030. </param>
  4031. <param name="command">
  4032. The <see cref="T:System.Data.SQLite.SQLiteCommand"/> instance in use.
  4033. </param>
  4034. <param name="flags">
  4035. The flags associated with the <see cref="T:System.Data.SQLite.SQLiteConnection"/> instance
  4036. in use.
  4037. </param>
  4038. <param name="parameter">
  4039. The <see cref="T:System.Data.SQLite.SQLiteParameter"/> instance being bound to the command.
  4040. </param>
  4041. <param name="typeName">
  4042. The database type name associated with this callback.
  4043. </param>
  4044. <param name="index">
  4045. The ordinal of the parameter being bound to the command.
  4046. </param>
  4047. <param name="userData">
  4048. The data originally used when registering this callback.
  4049. </param>
  4050. <param name="complete">
  4051. Non-zero if the default handling for the parameter binding call should
  4052. be skipped (i.e. the parameter should not be bound at all). Great care
  4053. should be used when setting this to non-zero.
  4054. </param>
  4055. </member>
  4056. <member name="T:System.Data.SQLite.SQLiteReadValueCallback">
  4057. <summary>
  4058. This represents a method that will be called in response to a request
  4059. to read a value from a data reader. If an exception is thrown, it will
  4060. cause the data reader operation to fail -AND- it will continue to unwind
  4061. the call stack.
  4062. </summary>
  4063. <param name="convert">
  4064. The <see cref="T:System.Data.SQLite.SQLiteConvert"/> instance in use.
  4065. </param>
  4066. <param name="dataReader">
  4067. The <see cref="T:System.Data.SQLite.SQLiteDataReader"/> instance in use.
  4068. </param>
  4069. <param name="flags">
  4070. The flags associated with the <see cref="T:System.Data.SQLite.SQLiteConnection"/> instance
  4071. in use.
  4072. </param>
  4073. <param name="eventArgs">
  4074. The parameter and return type data for the column being read from the
  4075. data reader.
  4076. </param>
  4077. <param name="typeName">
  4078. The database type name associated with this callback.
  4079. </param>
  4080. <param name="index">
  4081. The zero based index of the column being read from the data reader.
  4082. </param>
  4083. <param name="userData">
  4084. The data originally used when registering this callback.
  4085. </param>
  4086. <param name="complete">
  4087. Non-zero if the default handling for the data reader call should be
  4088. skipped. If this is set to non-zero and the necessary return value
  4089. is unavailable or unsuitable, an exception will be thrown.
  4090. </param>
  4091. </member>
  4092. <member name="T:System.Data.SQLite.SQLiteTypeCallbacks">
  4093. <summary>
  4094. This class represents the custom data type handling callbacks
  4095. for a single type name.
  4096. </summary>
  4097. </member>
  4098. <member name="F:System.Data.SQLite.SQLiteTypeCallbacks.typeName">
  4099. <summary>
  4100. Provides the underlying storage for the
  4101. <see cref="P:System.Data.SQLite.SQLiteTypeCallbacks.TypeName"/> property.
  4102. </summary>
  4103. </member>
  4104. <member name="F:System.Data.SQLite.SQLiteTypeCallbacks.bindValueCallback">
  4105. <summary>
  4106. Provides the underlying storage for the
  4107. <see cref="P:System.Data.SQLite.SQLiteTypeCallbacks.BindValueCallback"/> property.
  4108. </summary>
  4109. </member>
  4110. <member name="F:System.Data.SQLite.SQLiteTypeCallbacks.readValueCallback">
  4111. <summary>
  4112. Provides the underlying storage for the
  4113. <see cref="P:System.Data.SQLite.SQLiteTypeCallbacks.ReadValueCallback"/> property.
  4114. </summary>
  4115. </member>
  4116. <member name="F:System.Data.SQLite.SQLiteTypeCallbacks.bindValueUserData">
  4117. <summary>
  4118. Provides the underlying storage for the
  4119. <see cref="P:System.Data.SQLite.SQLiteTypeCallbacks.BindValueUserData"/> property.
  4120. </summary>
  4121. </member>
  4122. <member name="F:System.Data.SQLite.SQLiteTypeCallbacks.readValueUserData">
  4123. <summary>
  4124. Provides the underlying storage for the
  4125. <see cref="P:System.Data.SQLite.SQLiteTypeCallbacks.ReadValueUserData"/> property.
  4126. </summary>
  4127. </member>
  4128. <member name="M:System.Data.SQLite.SQLiteTypeCallbacks.#ctor(System.Data.SQLite.SQLiteBindValueCallback,System.Data.SQLite.SQLiteReadValueCallback,System.Object,System.Object)">
  4129. <summary>
  4130. Constructs an instance of this class.
  4131. </summary>
  4132. <param name="bindValueCallback">
  4133. The custom paramater binding callback. This parameter may be null.
  4134. </param>
  4135. <param name="readValueCallback">
  4136. The custom data reader value callback. This parameter may be null.
  4137. </param>
  4138. <param name="bindValueUserData">
  4139. The extra data to pass into the parameter binding callback. This
  4140. parameter may be null.
  4141. </param>
  4142. <param name="readValueUserData">
  4143. The extra data to pass into the data reader value callback. This
  4144. parameter may be null.
  4145. </param>
  4146. </member>
  4147. <member name="M:System.Data.SQLite.SQLiteTypeCallbacks.Create(System.Data.SQLite.SQLiteBindValueCallback,System.Data.SQLite.SQLiteReadValueCallback,System.Object,System.Object)">
  4148. <summary>
  4149. Creates an instance of the <see cref="T:System.Data.SQLite.SQLiteTypeCallbacks"/> class.
  4150. </summary>
  4151. <param name="bindValueCallback">
  4152. The custom paramater binding callback. This parameter may be null.
  4153. </param>
  4154. <param name="readValueCallback">
  4155. The custom data reader value callback. This parameter may be null.
  4156. </param>
  4157. <param name="bindValueUserData">
  4158. The extra data to pass into the parameter binding callback. This
  4159. parameter may be null.
  4160. </param>
  4161. <param name="readValueUserData">
  4162. The extra data to pass into the data reader value callback. This
  4163. parameter may be null.
  4164. </param>
  4165. </member>
  4166. <member name="P:System.Data.SQLite.SQLiteTypeCallbacks.TypeName">
  4167. <summary>
  4168. The database type name that the callbacks contained in this class
  4169. will apply to. This value may not be null.
  4170. </summary>
  4171. </member>
  4172. <member name="P:System.Data.SQLite.SQLiteTypeCallbacks.BindValueCallback">
  4173. <summary>
  4174. The custom paramater binding callback. This value may be null.
  4175. </summary>
  4176. </member>
  4177. <member name="P:System.Data.SQLite.SQLiteTypeCallbacks.ReadValueCallback">
  4178. <summary>
  4179. The custom data reader value callback. This value may be null.
  4180. </summary>
  4181. </member>
  4182. <member name="P:System.Data.SQLite.SQLiteTypeCallbacks.BindValueUserData">
  4183. <summary>
  4184. The extra data to pass into the parameter binding callback. This
  4185. value may be null.
  4186. </summary>
  4187. </member>
  4188. <member name="P:System.Data.SQLite.SQLiteTypeCallbacks.ReadValueUserData">
  4189. <summary>
  4190. The extra data to pass into the data reader value callback. This
  4191. value may be null.
  4192. </summary>
  4193. </member>
  4194. <member name="T:System.Data.SQLite.SQLiteTypeCallbacksMap">
  4195. <summary>
  4196. This class represents the mappings between database type names
  4197. and their associated custom data type handling callbacks.
  4198. </summary>
  4199. </member>
  4200. <member name="M:System.Data.SQLite.SQLiteTypeCallbacksMap.#ctor">
  4201. <summary>
  4202. Constructs an (empty) instance of this class.
  4203. </summary>
  4204. </member>
  4205. <member name="T:System.Data.SQLite.ConnectionEventArgs">
  4206. <summary>
  4207. Event data for connection event handlers.
  4208. </summary>
  4209. </member>
  4210. <member name="F:System.Data.SQLite.ConnectionEventArgs.EventType">
  4211. <summary>
  4212. The type of event being raised.
  4213. </summary>
  4214. </member>
  4215. <member name="F:System.Data.SQLite.ConnectionEventArgs.EventArgs">
  4216. <summary>
  4217. The <see cref="T:System.Data.StateChangeEventArgs"/> associated with this event, if any.
  4218. </summary>
  4219. </member>
  4220. <member name="F:System.Data.SQLite.ConnectionEventArgs.Transaction">
  4221. <summary>
  4222. The transaction associated with this event, if any.
  4223. </summary>
  4224. </member>
  4225. <member name="F:System.Data.SQLite.ConnectionEventArgs.Command">
  4226. <summary>
  4227. The command associated with this event, if any.
  4228. </summary>
  4229. </member>
  4230. <member name="F:System.Data.SQLite.ConnectionEventArgs.DataReader">
  4231. <summary>
  4232. The data reader associated with this event, if any.
  4233. </summary>
  4234. </member>
  4235. <member name="F:System.Data.SQLite.ConnectionEventArgs.CriticalHandle">
  4236. <summary>
  4237. The critical handle associated with this event, if any.
  4238. </summary>
  4239. </member>
  4240. <member name="F:System.Data.SQLite.ConnectionEventArgs.Text">
  4241. <summary>
  4242. Command or message text associated with this event, if any.
  4243. </summary>
  4244. </member>
  4245. <member name="F:System.Data.SQLite.ConnectionEventArgs.Data">
  4246. <summary>
  4247. Extra data associated with this event, if any.
  4248. </summary>
  4249. </member>
  4250. <member name="M:System.Data.SQLite.ConnectionEventArgs.#ctor(System.Data.SQLite.SQLiteConnectionEventType,System.Data.StateChangeEventArgs,System.Data.IDbTransaction,System.Data.IDbCommand,System.Data.IDataReader,System.Runtime.InteropServices.CriticalHandle,System.String,System.Object)">
  4251. <summary>
  4252. Constructs the object.
  4253. </summary>
  4254. <param name="eventType">The type of event being raised.</param>
  4255. <param name="eventArgs">The base <see cref="F:System.Data.SQLite.ConnectionEventArgs.EventArgs"/> associated
  4256. with this event, if any.</param>
  4257. <param name="transaction">The transaction associated with this event, if any.</param>
  4258. <param name="command">The command associated with this event, if any.</param>
  4259. <param name="dataReader">The data reader associated with this event, if any.</param>
  4260. <param name="criticalHandle">The critical handle associated with this event, if any.</param>
  4261. <param name="text">The command or message text, if any.</param>
  4262. <param name="data">The extra data, if any.</param>
  4263. </member>
  4264. <member name="T:System.Data.SQLite.SQLiteConnectionEventHandler">
  4265. <summary>
  4266. Raised when an event pertaining to a connection occurs.
  4267. </summary>
  4268. <param name="sender">The connection involved.</param>
  4269. <param name="e">Extra information about the event.</param>
  4270. </member>
  4271. <member name="T:System.Data.SQLite.SQLiteConnection">
  4272. <summary>
  4273. SQLite implentation of DbConnection.
  4274. </summary>
  4275. <remarks>
  4276. The <see cref="P:System.Data.SQLite.SQLiteConnection.ConnectionString"/> property can contain the following parameter(s), delimited with a semi-colon:
  4277. <list type="table">
  4278. <listheader>
  4279. <term>Parameter</term>
  4280. <term>Values</term>
  4281. <term>Required</term>
  4282. <term>Default</term>
  4283. </listheader>
  4284. <item>
  4285. <description>Data Source</description>
  4286. <description>
  4287. This may be a file name, the string ":memory:", or any supported URI (starting with SQLite 3.7.7).
  4288. Starting with release 1.0.86.0, in order to use more than one consecutive backslash (e.g. for a
  4289. UNC path), each of the adjoining backslash characters must be doubled (e.g. "\\Network\Share\test.db"
  4290. would become "\\\\Network\Share\test.db").
  4291. </description>
  4292. <description>Y</description>
  4293. <description></description>
  4294. </item>
  4295. <item>
  4296. <description>Uri</description>
  4297. <description>
  4298. If specified, this must be a file name that starts with "file://", "file:", or "/". Any leading
  4299. "file://" or "file:" prefix will be stripped off and the resulting file name will be used to open
  4300. the database.
  4301. </description>
  4302. <description>N</description>
  4303. <description>null</description>
  4304. </item>
  4305. <item>
  4306. <description>FullUri</description>
  4307. <description>
  4308. If specified, this must be a URI in a format recognized by the SQLite core library (starting with
  4309. SQLite 3.7.7). It will be passed verbatim to the SQLite core library.
  4310. </description>
  4311. <description>N</description>
  4312. <description>null</description>
  4313. </item>
  4314. <item>
  4315. <description>Version</description>
  4316. <description>3</description>
  4317. <description>N</description>
  4318. <description>3</description>
  4319. </item>
  4320. <item>
  4321. <description>UseUTF16Encoding</description>
  4322. <description>
  4323. <b>True</b> - The UTF-16 encoding should be used.
  4324. <br/>
  4325. <b>False</b> - The UTF-8 encoding should be used.
  4326. </description>
  4327. <description>N</description>
  4328. <description>False</description>
  4329. </item>
  4330. <item>
  4331. <description>DefaultDbType</description>
  4332. <description>
  4333. This is the default <see cref="T:System.Data.DbType"/> to use when one cannot be determined based on the
  4334. column metadata and the configured type mappings.
  4335. </description>
  4336. <description>N</description>
  4337. <description>null</description>
  4338. </item>
  4339. <item>
  4340. <description>DefaultTypeName</description>
  4341. <description>
  4342. This is the default type name to use when one cannot be determined based on the column metadata
  4343. and the configured type mappings.
  4344. </description>
  4345. <description>N</description>
  4346. <description>null</description>
  4347. </item>
  4348. <item>
  4349. <description>NoDefaultFlags</description>
  4350. <description>
  4351. <b>True</b> - Do not combine the specified (or existing) connection flags with the value of the
  4352. <see cref="P:System.Data.SQLite.SQLiteConnection.DefaultFlags"/> property.
  4353. <br/>
  4354. <b>False</b> - Combine the specified (or existing) connection flags with the value of the
  4355. <see cref="P:System.Data.SQLite.SQLiteConnection.DefaultFlags"/> property.
  4356. </description>
  4357. <description>N</description>
  4358. <description>False</description>
  4359. </item>
  4360. <item>
  4361. <description>NoSharedFlags</description>
  4362. <description>
  4363. <b>True</b> - Do not combine the specified (or existing) connection flags with the value of the
  4364. <see cref="P:System.Data.SQLite.SQLiteConnection.SharedFlags"/> property.
  4365. <br/>
  4366. <b>False</b> - Combine the specified (or existing) connection flags with the value of the
  4367. <see cref="P:System.Data.SQLite.SQLiteConnection.SharedFlags"/> property.
  4368. </description>
  4369. <description>N</description>
  4370. <description>False</description>
  4371. </item>
  4372. <item>
  4373. <description>VfsName</description>
  4374. <description>
  4375. The name of the VFS to use when opening the database connection.
  4376. If this is not specified, the default VFS will be used.
  4377. </description>
  4378. <description>N</description>
  4379. <description>null</description>
  4380. </item>
  4381. <item>
  4382. <description>ZipVfsVersion</description>
  4383. <description>
  4384. If non-null, this is the "version" of ZipVFS to use. This requires
  4385. the System.Data.SQLite interop assembly -AND- primary managed assembly
  4386. to be compiled with the INTEROP_INCLUDE_ZIPVFS option; otherwise, this
  4387. property does nothing. The valid values are "v2" and "v3". Using
  4388. anyother value will cause an exception to be thrown. Please see the
  4389. ZipVFS documentation for more information on how to use this parameter.
  4390. </description>
  4391. <description>N</description>
  4392. <description>null</description>
  4393. </item>
  4394. <item>
  4395. <description>DateTimeFormat</description>
  4396. <description>
  4397. <b>Ticks</b> - Use the value of DateTime.Ticks.<br/>
  4398. <b>ISO8601</b> - Use the ISO-8601 format. Uses the "yyyy-MM-dd HH:mm:ss.FFFFFFFK" format for UTC
  4399. DateTime values and "yyyy-MM-dd HH:mm:ss.FFFFFFF" format for local DateTime values).<br/>
  4400. <b>JulianDay</b> - The interval of time in days and fractions of a day since January 1, 4713 BC.<br/>
  4401. <b>UnixEpoch</b> - The whole number of seconds since the Unix epoch (January 1, 1970).<br/>
  4402. <b>InvariantCulture</b> - Any culture-independent string value that the .NET Framework can interpret as a valid DateTime.<br/>
  4403. <b>CurrentCulture</b> - Any string value that the .NET Framework can interpret as a valid DateTime using the current culture.</description>
  4404. <description>N</description>
  4405. <description>ISO8601</description>
  4406. </item>
  4407. <item>
  4408. <description>DateTimeKind</description>
  4409. <description>
  4410. <b>Unspecified</b> - Not specified as either UTC or local time.
  4411. <br/>
  4412. <b>Utc</b> - The time represented is UTC.
  4413. <br/>
  4414. <b>Local</b> - The time represented is local time.
  4415. </description>
  4416. <description>N</description>
  4417. <description>Unspecified</description>
  4418. </item>
  4419. <item>
  4420. <description>DateTimeFormatString</description>
  4421. <description>
  4422. The exact DateTime format string to use for all formatting and parsing of all DateTime
  4423. values for this connection.
  4424. </description>
  4425. <description>N</description>
  4426. <description>null</description>
  4427. </item>
  4428. <item>
  4429. <description>BaseSchemaName</description>
  4430. <description>
  4431. Some base data classes in the framework (e.g. those that build SQL queries dynamically)
  4432. assume that an ADO.NET provider cannot support an alternate catalog (i.e. database) without supporting
  4433. alternate schemas as well; however, SQLite does not fit into this model. Therefore, this value is used
  4434. as a placeholder and removed prior to preparing any SQL statements that may contain it.
  4435. </description>
  4436. <description>N</description>
  4437. <description>sqlite_default_schema</description>
  4438. </item>
  4439. <item>
  4440. <description>BinaryGUID</description>
  4441. <description>
  4442. <b>True</b> - Store GUID columns in binary form
  4443. <br/>
  4444. <b>False</b> - Store GUID columns as text
  4445. </description>
  4446. <description>N</description>
  4447. <description>True</description>
  4448. </item>
  4449. <item>
  4450. <description>Cache Size</description>
  4451. <description>
  4452. If the argument N is positive then the suggested cache size is set to N.
  4453. If the argument N is negative, then the number of cache pages is adjusted
  4454. to use approximately abs(N*4096) bytes of memory. Backwards compatibility
  4455. note: The behavior of cache_size with a negative N was different in SQLite
  4456. versions prior to 3.7.10. In version 3.7.9 and earlier, the number of
  4457. pages in the cache was set to the absolute value of N.
  4458. </description>
  4459. <description>N</description>
  4460. <description>-2000</description>
  4461. </item>
  4462. <item>
  4463. <description>Synchronous</description>
  4464. <description>
  4465. <b>Normal</b> - Normal file flushing behavior
  4466. <br/>
  4467. <b>Full</b> - Full flushing after all writes
  4468. <br/>
  4469. <b>Off</b> - Underlying OS flushes I/O's
  4470. </description>
  4471. <description>N</description>
  4472. <description>Full</description>
  4473. </item>
  4474. <item>
  4475. <description>Page Size</description>
  4476. <description>{size in bytes}</description>
  4477. <description>N</description>
  4478. <description>4096</description>
  4479. </item>
  4480. <item>
  4481. <description>Password</description>
  4482. <description>
  4483. {password} - Using this parameter requires that the legacy CryptoAPI based
  4484. codec (or the SQLite Encryption Extension) be enabled at compile-time for
  4485. both the native interop assembly and the core managed assemblies; otherwise,
  4486. using this parameter may result in an exception being thrown when attempting
  4487. to open the connection.
  4488. </description>
  4489. <description>N</description>
  4490. <description></description>
  4491. </item>
  4492. <item>
  4493. <description>HexPassword</description>
  4494. <description>
  4495. {hexPassword} - Must contain a sequence of zero or more hexadecimal encoded
  4496. byte values without a leading "0x" prefix. Using this parameter requires
  4497. that the legacy CryptoAPI based codec (or the SQLite Encryption Extension)
  4498. be enabled at compile-time for both the native interop assembly and the
  4499. core managed assemblies; otherwise, using this parameter may result in an
  4500. exception being thrown when attempting to open the connection.
  4501. </description>
  4502. <description>N</description>
  4503. <description></description>
  4504. </item>
  4505. <item>
  4506. <description>TextPassword</description>
  4507. <description>
  4508. {password} - Using this parameter requires that the legacy CryptoAPI based
  4509. codec (or the SQLite Encryption Extension) be enabled at compile-time for
  4510. both the native interop assembly and the core managed assemblies; otherwise,
  4511. using this parameter may result in an exception being thrown when attempting
  4512. to open the connection.
  4513. </description>
  4514. <description>N</description>
  4515. <description></description>
  4516. </item>
  4517. <item>
  4518. <description>Enlist</description>
  4519. <description>
  4520. <b>Y</b> - Automatically enlist in distributed transactions
  4521. <br/>
  4522. <b>N</b> - No automatic enlistment
  4523. </description>
  4524. <description>N</description>
  4525. <description>Y</description>
  4526. </item>
  4527. <item>
  4528. <description>Pooling</description>
  4529. <description>
  4530. <b>True</b> - Use connection pooling.<br/>
  4531. <b>False</b> - Do not use connection pooling.<br/><br/>
  4532. <b>WARNING:</b> When using the default connection pool implementation,
  4533. setting this property to True should be avoided by applications that make
  4534. use of COM (either directly or indirectly) due to possible deadlocks that
  4535. can occur during the finalization of some COM objects.
  4536. </description>
  4537. <description>N</description>
  4538. <description>False</description>
  4539. </item>
  4540. <item>
  4541. <description>FailIfMissing</description>
  4542. <description>
  4543. <b>True</b> - Don't create the database if it does not exist, throw an error instead
  4544. <br/>
  4545. <b>False</b> - Automatically create the database if it does not exist
  4546. </description>
  4547. <description>N</description>
  4548. <description>False</description>
  4549. </item>
  4550. <item>
  4551. <description>Max Page Count</description>
  4552. <description>{size in pages} - Limits the maximum number of pages (limits the size) of the database</description>
  4553. <description>N</description>
  4554. <description>0</description>
  4555. </item>
  4556. <item>
  4557. <description>Legacy Format</description>
  4558. <description>
  4559. <b>True</b> - Use the more compatible legacy 3.x database format
  4560. <br/>
  4561. <b>False</b> - Use the newer 3.3x database format which compresses numbers more effectively
  4562. </description>
  4563. <description>N</description>
  4564. <description>False</description>
  4565. </item>
  4566. <item>
  4567. <description>Default Timeout</description>
  4568. <description>{time in seconds}<br/>The default command timeout</description>
  4569. <description>N</description>
  4570. <description>30</description>
  4571. </item>
  4572. <item>
  4573. <description>BusyTimeout</description>
  4574. <description>{time in milliseconds}<br/>Sets the busy timeout for the core library.</description>
  4575. <description>N</description>
  4576. <description>0</description>
  4577. </item>
  4578. <item>
  4579. <description>WaitTimeout</description>
  4580. <description>{time in milliseconds}<br/>
  4581. <b>EXPERIMENTAL</b> -- The wait timeout to use with
  4582. <see cref="M:System.Data.SQLite.SQLiteConnection.WaitForEnlistmentReset(System.Int32,System.Nullable{System.Boolean})"/> method. This is only used when
  4583. waiting for the enlistment to be reset prior to enlisting in a transaction,
  4584. and then only when the appropriate connection flag is set.</description>
  4585. <description>N</description>
  4586. <description>30000</description>
  4587. </item>
  4588. <item>
  4589. <description>Journal Mode</description>
  4590. <description>
  4591. <b>Delete</b> - Delete the journal file after a commit.
  4592. <br/>
  4593. <b>Persist</b> - Zero out and leave the journal file on disk after a
  4594. commit.
  4595. <br/>
  4596. <b>Off</b> - Disable the rollback journal entirely. This saves disk I/O
  4597. but at the expense of database safety and integrity. If the application
  4598. using SQLite crashes in the middle of a transaction when this journaling
  4599. mode is set, then the database file will very likely go corrupt.
  4600. <br/>
  4601. <b>Truncate</b> - Truncate the journal file to zero-length instead of
  4602. deleting it.
  4603. <br/>
  4604. <b>Memory</b> - Store the journal in volatile RAM. This saves disk I/O
  4605. but at the expense of database safety and integrity. If the application
  4606. using SQLite crashes in the middle of a transaction when this journaling
  4607. mode is set, then the database file will very likely go corrupt.
  4608. <br/>
  4609. <b>Wal</b> - Use a write-ahead log instead of a rollback journal.
  4610. </description>
  4611. <description>N</description>
  4612. <description>Delete</description>
  4613. </item>
  4614. <item>
  4615. <description>Read Only</description>
  4616. <description>
  4617. <b>True</b> - Open the database for read only access
  4618. <br/>
  4619. <b>False</b> - Open the database for normal read/write access
  4620. </description>
  4621. <description>N</description>
  4622. <description>False</description>
  4623. </item>
  4624. <item>
  4625. <description>Max Pool Size</description>
  4626. <description>The maximum number of connections for the given connection string that can be in the connection pool</description>
  4627. <description>N</description>
  4628. <description>100</description>
  4629. </item>
  4630. <item>
  4631. <description>Default IsolationLevel</description>
  4632. <description>The default transaciton isolation level</description>
  4633. <description>N</description>
  4634. <description>Serializable</description>
  4635. </item>
  4636. <item>
  4637. <description>Foreign Keys</description>
  4638. <description>Enable foreign key constraints</description>
  4639. <description>N</description>
  4640. <description>False</description>
  4641. </item>
  4642. <item>
  4643. <description>Flags</description>
  4644. <description>Extra behavioral flags for the connection. See the <see cref="T:System.Data.SQLite.SQLiteConnectionFlags"/> enumeration for possible values.</description>
  4645. <description>N</description>
  4646. <description>Default</description>
  4647. </item>
  4648. <item>
  4649. <description>SetDefaults</description>
  4650. <description>
  4651. <b>True</b> - Apply the default connection settings to the opened database.<br/>
  4652. <b>False</b> - Skip applying the default connection settings to the opened database.
  4653. </description>
  4654. <description>N</description>
  4655. <description>True</description>
  4656. </item>
  4657. <item>
  4658. <description>ToFullPath</description>
  4659. <description>
  4660. <b>True</b> - Attempt to expand the data source file name to a fully qualified path before opening.
  4661. <br/>
  4662. <b>False</b> - Skip attempting to expand the data source file name to a fully qualified path before opening.
  4663. </description>
  4664. <description>N</description>
  4665. <description>True</description>
  4666. </item>
  4667. <item>
  4668. <description>PrepareRetries</description>
  4669. <description>
  4670. The maximum number of retries when preparing SQL to be executed. This
  4671. normally only applies to preparation errors resulting from the database
  4672. schema being changed.
  4673. </description>
  4674. <description>N</description>
  4675. <description>3</description>
  4676. </item>
  4677. <item>
  4678. <description>ProgressOps</description>
  4679. <description>
  4680. The approximate number of virtual machine instructions between progress
  4681. events. In order for progress events to actually fire, the event handler
  4682. must be added to the <see cref="E:System.Data.SQLite.SQLiteConnection.Progress"/> event as well.
  4683. </description>
  4684. <description>N</description>
  4685. <description>0</description>
  4686. </item>
  4687. <item>
  4688. <description>Recursive Triggers</description>
  4689. <description>
  4690. <b>True</b> - Enable the recursive trigger capability.
  4691. <b>False</b> - Disable the recursive trigger capability.
  4692. </description>
  4693. <description>N</description>
  4694. <description>False</description>
  4695. </item>
  4696. </list>
  4697. </remarks>
  4698. </member>
  4699. <member name="F:System.Data.SQLite.SQLiteConnection.BadDbType">
  4700. <summary>
  4701. The "invalid value" for the <see cref="T:System.Data.DbType"/> enumeration used
  4702. by the <see cref="P:System.Data.SQLite.SQLiteConnection.DefaultDbType"/> property. This constant is shared
  4703. by this class and the SQLiteConnectionStringBuilder class.
  4704. </summary>
  4705. </member>
  4706. <member name="F:System.Data.SQLite.SQLiteConnection.DefaultBaseSchemaName">
  4707. <summary>
  4708. The default "stub" (i.e. placeholder) base schema name to use when
  4709. returning column schema information. Used as the initial value of
  4710. the BaseSchemaName property. This should start with "sqlite_*"
  4711. because those names are reserved for use by SQLite (i.e. they cannot
  4712. be confused with the names of user objects).
  4713. </summary>
  4714. </member>
  4715. <member name="F:System.Data.SQLite.SQLiteConnection._assembly">
  4716. <summary>
  4717. The managed assembly containing this type.
  4718. </summary>
  4719. </member>
  4720. <member name="F:System.Data.SQLite.SQLiteConnection._syncRoot">
  4721. <summary>
  4722. Object used to synchronize access to the static instance data
  4723. for this class.
  4724. </summary>
  4725. </member>
  4726. <member name="F:System.Data.SQLite.SQLiteConnection._sharedFlags">
  4727. <summary>
  4728. The extra connection flags to be used for all opened connections.
  4729. </summary>
  4730. </member>
  4731. <member name="F:System.Data.SQLite.SQLiteConnection._lastConnectionInOpen">
  4732. <summary>
  4733. The <see cref="T:System.Data.SQLite.SQLiteConnection"/> instance (for this thread) that
  4734. had the most recent call to <see cref="M:System.Data.SQLite.SQLiteConnection.Open"/>.
  4735. </summary>
  4736. </member>
  4737. <member name="F:System.Data.SQLite.SQLiteConnection._connectionState">
  4738. <summary>
  4739. State of the current connection
  4740. </summary>
  4741. </member>
  4742. <member name="F:System.Data.SQLite.SQLiteConnection._connectionString">
  4743. <summary>
  4744. The connection string
  4745. </summary>
  4746. </member>
  4747. <member name="F:System.Data.SQLite.SQLiteConnection._transactionLevel">
  4748. <summary>
  4749. Nesting level of the transactions open on the connection
  4750. </summary>
  4751. </member>
  4752. <member name="F:System.Data.SQLite.SQLiteConnection._transactionSequence">
  4753. <summary>
  4754. Transaction counter for the connection. Currently, this is only used
  4755. to build SAVEPOINT names.
  4756. </summary>
  4757. </member>
  4758. <member name="F:System.Data.SQLite.SQLiteConnection._noDispose">
  4759. <summary>
  4760. If this flag is non-zero, the <see cref="M:System.Data.SQLite.SQLiteConnection.Dispose"/> method will have
  4761. no effect; however, the <see cref="M:System.Data.SQLite.SQLiteConnection.Close"/> method will continue to
  4762. behave as normal.
  4763. </summary>
  4764. </member>
  4765. <member name="F:System.Data.SQLite.SQLiteConnection._disposing">
  4766. <summary>
  4767. If set, then the connection is currently being disposed.
  4768. </summary>
  4769. </member>
  4770. <member name="F:System.Data.SQLite.SQLiteConnection._defaultIsolation">
  4771. <summary>
  4772. The default isolation level for new transactions
  4773. </summary>
  4774. </member>
  4775. <member name="F:System.Data.SQLite.SQLiteConnection._enlistmentSyncRoot">
  4776. <summary>
  4777. This object is used with lock statements to synchronize access to the
  4778. <see cref="F:System.Data.SQLite.SQLiteConnection._enlistment"/> field, below.
  4779. </summary>
  4780. </member>
  4781. <member name="F:System.Data.SQLite.SQLiteConnection._enlistment">
  4782. <summary>
  4783. Whether or not the connection is enlisted in a distrubuted transaction
  4784. </summary>
  4785. </member>
  4786. <member name="F:System.Data.SQLite.SQLiteConnection._typeNames">
  4787. <summary>
  4788. The per-connection mappings between type names and <see cref="T:System.Data.DbType"/>
  4789. values. These mappings override the corresponding global mappings.
  4790. </summary>
  4791. </member>
  4792. <member name="F:System.Data.SQLite.SQLiteConnection._typeCallbacks">
  4793. <summary>
  4794. The per-connection mappings between type names and optional callbacks
  4795. for parameter binding and value reading.
  4796. </summary>
  4797. </member>
  4798. <member name="F:System.Data.SQLite.SQLiteConnection._sql">
  4799. <summary>
  4800. The base SQLite object to interop with
  4801. </summary>
  4802. </member>
  4803. <member name="F:System.Data.SQLite.SQLiteConnection._dataSource">
  4804. <summary>
  4805. The database filename minus path and extension
  4806. </summary>
  4807. </member>
  4808. <member name="F:System.Data.SQLite.SQLiteConnection._password">
  4809. <summary>
  4810. Temporary password storage, emptied after the database has been opened
  4811. </summary>
  4812. </member>
  4813. <member name="F:System.Data.SQLite.SQLiteConnection._passwordWasText">
  4814. <summary>
  4815. This will be non-zero if the "TextPassword" connection string property
  4816. was used. When this value is non-zero, <see cref="M:System.Data.SQLite.SQLiteConnection.ChangePassword(System.Byte[])"/>
  4817. will retain treatment of the password as a NUL-terminated text string.
  4818. </summary>
  4819. </member>
  4820. <member name="F:System.Data.SQLite.SQLiteConnection._baseSchemaName">
  4821. <summary>
  4822. The "stub" (i.e. placeholder) base schema name to use when returning
  4823. column schema information.
  4824. </summary>
  4825. </member>
  4826. <member name="F:System.Data.SQLite.SQLiteConnection._flags">
  4827. <summary>
  4828. The extra behavioral flags for this connection, if any. See the
  4829. <see cref="T:System.Data.SQLite.SQLiteConnectionFlags"/> enumeration for a list of
  4830. possible values.
  4831. </summary>
  4832. </member>
  4833. <member name="F:System.Data.SQLite.SQLiteConnection._cachedSettings">
  4834. <summary>
  4835. The cached values for all settings that have been fetched on behalf
  4836. of this connection. This cache may be cleared by calling the
  4837. <see cref="M:System.Data.SQLite.SQLiteConnection.ClearCachedSettings"/> method.
  4838. </summary>
  4839. </member>
  4840. <member name="F:System.Data.SQLite.SQLiteConnection._defaultDbType">
  4841. <summary>
  4842. The default databse type for this connection. This value will only
  4843. be used if the <see cref="F:System.Data.SQLite.SQLiteConnectionFlags.UseConnectionTypes"/>
  4844. flag is set.
  4845. </summary>
  4846. </member>
  4847. <member name="F:System.Data.SQLite.SQLiteConnection._defaultTypeName">
  4848. <summary>
  4849. The default databse type name for this connection. This value will only
  4850. be used if the <see cref="F:System.Data.SQLite.SQLiteConnectionFlags.UseConnectionTypes"/>
  4851. flag is set.
  4852. </summary>
  4853. </member>
  4854. <member name="F:System.Data.SQLite.SQLiteConnection._vfsName">
  4855. <summary>
  4856. The name of the VFS to be used when opening the database connection.
  4857. </summary>
  4858. </member>
  4859. <member name="F:System.Data.SQLite.SQLiteConnection._defaultTimeout">
  4860. <summary>
  4861. Default command timeout
  4862. </summary>
  4863. </member>
  4864. <member name="F:System.Data.SQLite.SQLiteConnection._busyTimeout">
  4865. <summary>
  4866. The default busy timeout to use with the SQLite core library. This is
  4867. only used when opening a connection.
  4868. </summary>
  4869. </member>
  4870. <member name="F:System.Data.SQLite.SQLiteConnection._waitTimeout">
  4871. <summary>
  4872. The default wait timeout to use with <see cref="M:System.Data.SQLite.SQLiteConnection.WaitForEnlistmentReset(System.Int32,System.Nullable{System.Boolean})"/>
  4873. method. This is only used when waiting for the enlistment to be reset
  4874. prior to enlisting in a transaction, and then only when the appropriate
  4875. connection flag is set.
  4876. </summary>
  4877. </member>
  4878. <member name="F:System.Data.SQLite.SQLiteConnection._prepareRetries">
  4879. <summary>
  4880. The maximum number of retries when preparing SQL to be executed. This
  4881. normally only applies to preparation errors resulting from the database
  4882. schema being changed.
  4883. </summary>
  4884. </member>
  4885. <member name="F:System.Data.SQLite.SQLiteConnection._progressOps">
  4886. <summary>
  4887. The approximate number of virtual machine instructions between progress
  4888. events. In order for progress events to actually fire, the event handler
  4889. must be added to the <see cref="E:System.Data.SQLite.SQLiteConnection.Progress"/> event as
  4890. well. This value will only be used when opening the database.
  4891. </summary>
  4892. </member>
  4893. <member name="F:System.Data.SQLite.SQLiteConnection._parseViaFramework">
  4894. <summary>
  4895. Non-zero if the built-in (i.e. framework provided) connection string
  4896. parser should be used when opening the connection.
  4897. </summary>
  4898. </member>
  4899. <member name="M:System.Data.SQLite.SQLiteConnection.#ctor">
  4900. <overloads>
  4901. Constructs a new SQLiteConnection object
  4902. </overloads>
  4903. <summary>
  4904. Default constructor
  4905. </summary>
  4906. </member>
  4907. <member name="M:System.Data.SQLite.SQLiteConnection.#ctor(System.String)">
  4908. <summary>
  4909. Initializes the connection with the specified connection string.
  4910. </summary>
  4911. <param name="connectionString">The connection string to use.</param>
  4912. </member>
  4913. <member name="M:System.Data.SQLite.SQLiteConnection.#ctor(System.IntPtr,System.String,System.Boolean)">
  4914. <summary>
  4915. Initializes the connection with a pre-existing native connection handle.
  4916. This constructor overload is intended to be used only by the private
  4917. <see cref="M:System.Data.SQLite.SQLiteModule.CreateOrConnect(System.Boolean,System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> method.
  4918. </summary>
  4919. <param name="db">
  4920. The native connection handle to use.
  4921. </param>
  4922. <param name="fileName">
  4923. The file name corresponding to the native connection handle.
  4924. </param>
  4925. <param name="ownHandle">
  4926. Non-zero if this instance owns the native connection handle and
  4927. should dispose of it when it is no longer needed.
  4928. </param>
  4929. </member>
  4930. <member name="M:System.Data.SQLite.SQLiteConnection.InitializeDefaults">
  4931. <summary>
  4932. Initializes user-settable properties with their default values.
  4933. This method is only intended to be used from the constructor.
  4934. </summary>
  4935. </member>
  4936. <member name="M:System.Data.SQLite.SQLiteConnection.#ctor(System.String,System.Boolean)">
  4937. <summary>
  4938. Initializes the connection with the specified connection string.
  4939. </summary>
  4940. <param name="connectionString">
  4941. The connection string to use.
  4942. </param>
  4943. <param name="parseViaFramework">
  4944. Non-zero to parse the connection string using the built-in (i.e.
  4945. framework provided) parser when opening the connection.
  4946. </param>
  4947. </member>
  4948. <member name="M:System.Data.SQLite.SQLiteConnection.#ctor(System.Data.SQLite.SQLiteConnection)">
  4949. <summary>
  4950. Clones the settings and connection string from an existing connection. If the existing connection is already open, this
  4951. function will open its own connection, enumerate any attached databases of the original connection, and automatically
  4952. attach to them.
  4953. </summary>
  4954. <param name="connection">The connection to copy the settings from.</param>
  4955. </member>
  4956. <member name="M:System.Data.SQLite.SQLiteConnection.GetNativeHandle(System.Data.SQLite.SQLiteConnection)">
  4957. <summary>
  4958. Attempts to lookup the native handle associated with the connection. An exception will
  4959. be thrown if this cannot be accomplished.
  4960. </summary>
  4961. <param name="connection">
  4962. The connection associated with the desired native handle.
  4963. </param>
  4964. <returns>
  4965. The native handle associated with the connection or <see cref="F:System.IntPtr.Zero"/> if it
  4966. cannot be determined.
  4967. </returns>
  4968. </member>
  4969. <member name="M:System.Data.SQLite.SQLiteConnection.OnChanged(System.Data.SQLite.SQLiteConnection,System.Data.SQLite.ConnectionEventArgs)">
  4970. <summary>
  4971. Raises the <see cref="E:System.Data.SQLite.SQLiteConnection.Changed"/> event.
  4972. </summary>
  4973. <param name="connection">
  4974. The connection associated with this event. If this parameter is not
  4975. null and the specified connection cannot raise events, then the
  4976. registered event handlers will not be invoked.
  4977. </param>
  4978. <param name="e">
  4979. A <see cref="T:System.Data.SQLite.ConnectionEventArgs"/> that contains the event data.
  4980. </param>
  4981. </member>
  4982. <member name="M:System.Data.SQLite.SQLiteConnection.CreateHandle(System.IntPtr)">
  4983. <summary>
  4984. Creates and returns a new managed database connection handle. This
  4985. method is intended to be used by implementations of the
  4986. <see cref="T:System.Data.SQLite.ISQLiteConnectionPool"/> interface only. In theory, it
  4987. could be used by other classes; however, that usage is not supported.
  4988. </summary>
  4989. <param name="nativeHandle">
  4990. This must be a native database connection handle returned by the
  4991. SQLite core library and it must remain valid and open during the
  4992. entire duration of the calling method.
  4993. </param>
  4994. <returns>
  4995. The new managed database connection handle or null if it cannot be
  4996. created.
  4997. </returns>
  4998. </member>
  4999. <member name="M:System.Data.SQLite.SQLiteConnection.BackupDatabase(System.Data.SQLite.SQLiteConnection,System.String,System.String,System.Int32,System.Data.SQLite.SQLiteBackupCallback,System.Int32)">
  5000. <summary>
  5001. Backs up the database, using the specified database connection as the
  5002. destination.
  5003. </summary>
  5004. <param name="destination">The destination database connection.</param>
  5005. <param name="destinationName">The destination database name.</param>
  5006. <param name="sourceName">The source database name.</param>
  5007. <param name="pages">
  5008. The number of pages to copy at a time -OR- a negative value to copy all
  5009. pages. When a negative value is used, the <paramref name="callback" />
  5010. may never be invoked.
  5011. </param>
  5012. <param name="callback">
  5013. The method to invoke between each step of the backup process. This
  5014. parameter may be null (i.e. no callbacks will be performed). If the
  5015. callback returns false -OR- throws an exception, the backup is canceled.
  5016. </param>
  5017. <param name="retryMilliseconds">
  5018. The number of milliseconds to sleep after encountering a locking error
  5019. during the backup process. A value less than zero means that no sleep
  5020. should be performed.
  5021. </param>
  5022. </member>
  5023. <member name="M:System.Data.SQLite.SQLiteConnection.ClearCachedSettings">
  5024. <summary>
  5025. Clears the per-connection cached settings.
  5026. </summary>
  5027. <returns>
  5028. The total number of per-connection settings cleared.
  5029. </returns>
  5030. </member>
  5031. <member name="M:System.Data.SQLite.SQLiteConnection.TryGetCachedSetting(System.String,System.Object,System.Object@)">
  5032. <summary>
  5033. Queries and returns the value of the specified setting, using the
  5034. cached setting names and values for this connection, when available.
  5035. </summary>
  5036. <param name="name">
  5037. The name of the setting.
  5038. </param>
  5039. <param name="default">
  5040. The value to be returned if the setting has not been set explicitly
  5041. or cannot be determined.
  5042. </param>
  5043. <param name="value">
  5044. The value of the cached setting is stored here if found; otherwise,
  5045. the value of <paramref name="default" /> is stored here.
  5046. </param>
  5047. <returns>
  5048. Non-zero if the cached setting was found; otherwise, zero.
  5049. </returns>
  5050. </member>
  5051. <member name="M:System.Data.SQLite.SQLiteConnection.SetCachedSetting(System.String,System.Object)">
  5052. <summary>
  5053. Adds or sets the cached setting specified by <paramref name="name" />
  5054. to the value specified by <paramref name="value" />.
  5055. </summary>
  5056. <param name="name">
  5057. The name of the cached setting to add or replace.
  5058. </param>
  5059. <param name="value">
  5060. The new value of the cached setting.
  5061. </param>
  5062. </member>
  5063. <member name="M:System.Data.SQLite.SQLiteConnection.ClearTypeMappings">
  5064. <summary>
  5065. Clears the per-connection type mappings.
  5066. </summary>
  5067. <returns>
  5068. The total number of per-connection type mappings cleared.
  5069. </returns>
  5070. </member>
  5071. <member name="M:System.Data.SQLite.SQLiteConnection.GetTypeMappings">
  5072. <summary>
  5073. Returns the per-connection type mappings.
  5074. </summary>
  5075. <returns>
  5076. The per-connection type mappings -OR- null if they are unavailable.
  5077. </returns>
  5078. </member>
  5079. <member name="M:System.Data.SQLite.SQLiteConnection.AddTypeMapping(System.String,System.Data.DbType,System.Boolean)">
  5080. <summary>
  5081. Adds a per-connection type mapping, possibly replacing one or more
  5082. that already exist.
  5083. </summary>
  5084. <param name="typeName">
  5085. The case-insensitive database type name (e.g. "MYDATE"). The value
  5086. of this parameter cannot be null. Using an empty string value (or
  5087. a string value consisting entirely of whitespace) for this parameter
  5088. is not recommended.
  5089. </param>
  5090. <param name="dataType">
  5091. The <see cref="T:System.Data.DbType"/> value that should be associated with the
  5092. specified type name.
  5093. </param>
  5094. <param name="primary">
  5095. Non-zero if this mapping should be considered to be the primary one
  5096. for the specified <see cref="T:System.Data.DbType"/>.
  5097. </param>
  5098. <returns>
  5099. A negative value if nothing was done. Zero if no per-connection type
  5100. mappings were replaced (i.e. it was a pure add operation). More than
  5101. zero if some per-connection type mappings were replaced.
  5102. </returns>
  5103. </member>
  5104. <member name="M:System.Data.SQLite.SQLiteConnection.ClearTypeCallbacks">
  5105. <summary>
  5106. Clears the per-connection type callbacks.
  5107. </summary>
  5108. <returns>
  5109. The total number of per-connection type callbacks cleared.
  5110. </returns>
  5111. </member>
  5112. <member name="M:System.Data.SQLite.SQLiteConnection.TryGetTypeCallbacks(System.String,System.Data.SQLite.SQLiteTypeCallbacks@)">
  5113. <summary>
  5114. Attempts to get the per-connection type callbacks for the specified
  5115. database type name.
  5116. </summary>
  5117. <param name="typeName">
  5118. The database type name.
  5119. </param>
  5120. <param name="callbacks">
  5121. Upon success, this parameter will contain the object holding the
  5122. callbacks for the database type name. Upon failure, this parameter
  5123. will be null.
  5124. </param>
  5125. <returns>
  5126. Non-zero upon success; otherwise, zero.
  5127. </returns>
  5128. </member>
  5129. <member name="M:System.Data.SQLite.SQLiteConnection.SetTypeCallbacks(System.String,System.Data.SQLite.SQLiteTypeCallbacks)">
  5130. <summary>
  5131. Sets, resets, or clears the per-connection type callbacks for the
  5132. specified database type name.
  5133. </summary>
  5134. <param name="typeName">
  5135. The database type name.
  5136. </param>
  5137. <param name="callbacks">
  5138. The object holding the callbacks for the database type name. If
  5139. this parameter is null, any callbacks for the database type name
  5140. will be removed if they are present.
  5141. </param>
  5142. <returns>
  5143. Non-zero if callbacks were set or removed; otherwise, zero.
  5144. </returns>
  5145. </member>
  5146. <member name="M:System.Data.SQLite.SQLiteConnection.BindFunction(System.Data.SQLite.SQLiteFunctionAttribute,System.Data.SQLite.SQLiteFunction)">
  5147. <summary>
  5148. Attempts to bind the specified <see cref="T:System.Data.SQLite.SQLiteFunction"/> object
  5149. instance to this connection.
  5150. </summary>
  5151. <param name="functionAttribute">
  5152. The <see cref="T:System.Data.SQLite.SQLiteFunctionAttribute"/> object instance containing
  5153. the metadata for the function to be bound.
  5154. </param>
  5155. <param name="function">
  5156. The <see cref="T:System.Data.SQLite.SQLiteFunction"/> object instance that implements the
  5157. function to be bound.
  5158. </param>
  5159. </member>
  5160. <member name="M:System.Data.SQLite.SQLiteConnection.BindFunction(System.Data.SQLite.SQLiteFunctionAttribute,System.Delegate,System.Delegate)">
  5161. <summary>
  5162. Attempts to bind the specified <see cref="T:System.Data.SQLite.SQLiteFunction"/> object
  5163. instance to this connection.
  5164. </summary>
  5165. <param name="functionAttribute">
  5166. The <see cref="T:System.Data.SQLite.SQLiteFunctionAttribute"/> object instance containing
  5167. the metadata for the function to be bound.
  5168. </param>
  5169. <param name="callback1">
  5170. A <see cref="T:System.Delegate"/> object instance that helps implement the
  5171. function to be bound. For scalar functions, this corresponds to the
  5172. <see cref="T:System.Data.SQLite.SQLiteInvokeDelegate"/> type. For aggregate functions,
  5173. this corresponds to the <see cref="T:System.Data.SQLite.SQLiteStepDelegate"/> type. For
  5174. collation functions, this corresponds to the
  5175. <see cref="T:System.Data.SQLite.SQLiteCompareDelegate"/> type.
  5176. </param>
  5177. <param name="callback2">
  5178. A <see cref="T:System.Delegate"/> object instance that helps implement the
  5179. function to be bound. For aggregate functions, this corresponds to the
  5180. <see cref="T:System.Data.SQLite.SQLiteFinalDelegate"/> type. For other callback types, it
  5181. is not used and must be null.
  5182. </param>
  5183. </member>
  5184. <member name="M:System.Data.SQLite.SQLiteConnection.UnbindFunction(System.Data.SQLite.SQLiteFunctionAttribute)">
  5185. <summary>
  5186. Attempts to unbind the specified <see cref="T:System.Data.SQLite.SQLiteFunction"/> object
  5187. instance to this connection.
  5188. </summary>
  5189. <param name="functionAttribute">
  5190. The <see cref="T:System.Data.SQLite.SQLiteFunctionAttribute"/> object instance containing
  5191. the metadata for the function to be unbound.
  5192. </param>
  5193. <returns>Non-zero if the function was unbound.</returns>
  5194. </member>
  5195. <member name="M:System.Data.SQLite.SQLiteConnection.UnbindAllFunctions(System.Boolean)">
  5196. <summary>
  5197. This method unbinds all registered (known) functions -OR- all previously
  5198. bound user-defined functions from this connection.
  5199. </summary>
  5200. <param name="registered">
  5201. Non-zero to unbind all registered (known) functions -OR- zero to unbind
  5202. all functions currently bound to the connection.
  5203. </param>
  5204. <returns>
  5205. Non-zero if all the specified user-defined functions were unbound.
  5206. </returns>
  5207. </member>
  5208. <member name="M:System.Data.SQLite.SQLiteConnection.ParseConnectionString(System.String,System.Boolean,System.Boolean)">
  5209. <summary>
  5210. Parses a connection string into component parts using the custom
  5211. connection string parser. An exception may be thrown if the syntax
  5212. of the connection string is incorrect.
  5213. </summary>
  5214. <param name="connectionString">
  5215. The connection string to parse.
  5216. </param>
  5217. <param name="parseViaFramework">
  5218. Non-zero to parse the connection string using the algorithm provided
  5219. by the framework itself. This is not applicable when running on the
  5220. .NET Compact Framework.
  5221. </param>
  5222. <param name="allowNameOnly">
  5223. Non-zero if names are allowed without values.
  5224. </param>
  5225. <returns>
  5226. The list of key/value pairs corresponding to the parameters specified
  5227. within the connection string.
  5228. </returns>
  5229. </member>
  5230. <member name="M:System.Data.SQLite.SQLiteConnection.ParseConnectionString(System.Data.SQLite.SQLiteConnection,System.String,System.Boolean,System.Boolean)">
  5231. <summary>
  5232. Parses a connection string into component parts using the custom
  5233. connection string parser. An exception may be thrown if the syntax
  5234. of the connection string is incorrect.
  5235. </summary>
  5236. <param name="connection">
  5237. The connection that will be using the parsed connection string.
  5238. </param>
  5239. <param name="connectionString">
  5240. The connection string to parse.
  5241. </param>
  5242. <param name="parseViaFramework">
  5243. Non-zero to parse the connection string using the algorithm provided
  5244. by the framework itself. This is not applicable when running on the
  5245. .NET Compact Framework.
  5246. </param>
  5247. <param name="allowNameOnly">
  5248. Non-zero if names are allowed without values.
  5249. </param>
  5250. <returns>
  5251. The list of key/value pairs corresponding to the parameters specified
  5252. within the connection string.
  5253. </returns>
  5254. </member>
  5255. <member name="M:System.Data.SQLite.SQLiteConnection.EscapeForConnectionString(System.String,System.Boolean)">
  5256. <summary>
  5257. Attempts to escape the specified connection string property name or
  5258. value in a way that is compatible with the connection string parser.
  5259. </summary>
  5260. <param name="value">
  5261. The connection string property name or value to escape.
  5262. </param>
  5263. <param name="allowEquals">
  5264. Non-zero if the equals sign is permitted in the string. If this is
  5265. zero and the string contains an equals sign, an exception will be
  5266. thrown.
  5267. </param>
  5268. <returns>
  5269. The original string, with all special characters escaped. If the
  5270. original string contains equals signs, they will not be escaped.
  5271. Instead, they will be preserved verbatim.
  5272. </returns>
  5273. </member>
  5274. <member name="M:System.Data.SQLite.SQLiteConnection.BuildConnectionString(System.Collections.Generic.SortedList{System.String,System.String})">
  5275. <summary>
  5276. Builds a connection string from a list of key/value pairs.
  5277. </summary>
  5278. <param name="opts">
  5279. The list of key/value pairs corresponding to the parameters to be
  5280. specified within the connection string.
  5281. </param>
  5282. <returns>
  5283. The connection string. Depending on how the connection string was
  5284. originally parsed, the returned connection string value may not be
  5285. usable in a subsequent call to the <see cref="M:System.Data.SQLite.SQLiteConnection.Open"/> method.
  5286. </returns>
  5287. </member>
  5288. <member name="M:System.Data.SQLite.SQLiteConnection.Dispose">
  5289. <summary>
  5290. Disposes and finalizes the connection, if applicable.
  5291. </summary>
  5292. </member>
  5293. <member name="M:System.Data.SQLite.SQLiteConnection.Dispose(System.Boolean)">
  5294. <summary>
  5295. Cleans up resources (native and managed) associated with the current instance.
  5296. </summary>
  5297. <param name="disposing">
  5298. Zero when being disposed via garbage collection; otherwise, non-zero.
  5299. </param>
  5300. </member>
  5301. <member name="M:System.Data.SQLite.SQLiteConnection.Clone">
  5302. <summary>
  5303. Creates a clone of the connection. All attached databases and user-defined functions are cloned. If the existing connection is open, the cloned connection
  5304. will also be opened.
  5305. </summary>
  5306. <returns></returns>
  5307. </member>
  5308. <member name="M:System.Data.SQLite.SQLiteConnection.CreateFile(System.String)">
  5309. <summary>
  5310. Creates a database file. This just creates a zero-byte file which SQLite
  5311. will turn into a database when the file is opened properly.
  5312. </summary>
  5313. <param name="databaseFileName">The file to create</param>
  5314. </member>
  5315. <member name="M:System.Data.SQLite.SQLiteConnection.OnStateChange(System.Data.ConnectionState,System.Data.StateChangeEventArgs@)">
  5316. <summary>
  5317. Raises the state change event when the state of the connection changes
  5318. </summary>
  5319. <param name="newState">The new connection state. If this is different
  5320. from the previous state, the <see cref="E:System.Data.SQLite.SQLiteConnection.StateChange"/> event is
  5321. raised.</param>
  5322. <param name="eventArgs">The event data created for the raised event, if
  5323. it was actually raised.</param>
  5324. </member>
  5325. <member name="M:System.Data.SQLite.SQLiteConnection.GetFallbackDefaultIsolationLevel">
  5326. <summary>
  5327. Determines and returns the fallback default isolation level when one cannot be
  5328. obtained from an existing connection instance.
  5329. </summary>
  5330. <returns>
  5331. The fallback default isolation level for this connection instance -OR-
  5332. <see cref="F:System.Data.IsolationLevel.Unspecified"/> if it cannot be determined.
  5333. </returns>
  5334. </member>
  5335. <member name="M:System.Data.SQLite.SQLiteConnection.GetDefaultIsolationLevel">
  5336. <summary>
  5337. Determines and returns the default isolation level for this connection instance.
  5338. </summary>
  5339. <returns>
  5340. The default isolation level for this connection instance -OR-
  5341. <see cref="F:System.Data.IsolationLevel.Unspecified"/> if it cannot be determined.
  5342. </returns>
  5343. </member>
  5344. <member name="M:System.Data.SQLite.SQLiteConnection.BeginTransaction(System.Data.IsolationLevel,System.Boolean)">
  5345. <summary>
  5346. OBSOLETE. Creates a new SQLiteTransaction if one isn't already active on the connection.
  5347. </summary>
  5348. <param name="isolationLevel">This parameter is ignored.</param>
  5349. <param name="deferredLock">When TRUE, SQLite defers obtaining a write lock until a write operation is requested.
  5350. When FALSE, a writelock is obtained immediately. The default is TRUE, but in a multi-threaded multi-writer
  5351. environment, one may instead choose to lock the database immediately to avoid any possible writer deadlock.</param>
  5352. <returns>Returns a SQLiteTransaction object.</returns>
  5353. </member>
  5354. <member name="M:System.Data.SQLite.SQLiteConnection.BeginTransaction(System.Boolean)">
  5355. <summary>
  5356. OBSOLETE. Creates a new SQLiteTransaction if one isn't already active on the connection.
  5357. </summary>
  5358. <param name="deferredLock">When TRUE, SQLite defers obtaining a write lock until a write operation is requested.
  5359. When FALSE, a writelock is obtained immediately. The default is false, but in a multi-threaded multi-writer
  5360. environment, one may instead choose to lock the database immediately to avoid any possible writer deadlock.</param>
  5361. <returns>Returns a SQLiteTransaction object.</returns>
  5362. </member>
  5363. <member name="M:System.Data.SQLite.SQLiteConnection.BeginTransaction(System.Data.IsolationLevel)">
  5364. <summary>
  5365. Creates a new <see cref="T:System.Data.SQLite.SQLiteTransaction"/> if one isn't already active on the connection.
  5366. </summary>
  5367. <param name="isolationLevel">Supported isolation levels are Serializable, ReadCommitted and Unspecified.</param>
  5368. <remarks>
  5369. Unspecified will use the default isolation level specified in the connection string. If no isolation level is specified in the
  5370. connection string, Serializable is used.
  5371. Serializable transactions are the default. In this mode, the engine gets an immediate lock on the database, and no other threads
  5372. may begin a transaction. Other threads may read from the database, but not write.
  5373. With a ReadCommitted isolation level, locks are deferred and elevated as needed. It is possible for multiple threads to start
  5374. a transaction in ReadCommitted mode, but if a thread attempts to commit a transaction while another thread
  5375. has a ReadCommitted lock, it may timeout or cause a deadlock on both threads until both threads' CommandTimeout's are reached.
  5376. </remarks>
  5377. <returns>Returns a SQLiteTransaction object.</returns>
  5378. </member>
  5379. <member name="M:System.Data.SQLite.SQLiteConnection.BeginTransaction">
  5380. <summary>
  5381. Creates a new <see cref="T:System.Data.SQLite.SQLiteTransaction"/> if one isn't already
  5382. active on the connection.
  5383. </summary>
  5384. <returns>Returns the new transaction object.</returns>
  5385. </member>
  5386. <member name="M:System.Data.SQLite.SQLiteConnection.BeginDbTransaction(System.Data.IsolationLevel)">
  5387. <summary>
  5388. Forwards to the local <see cref="M:System.Data.SQLite.SQLiteConnection.BeginTransaction(System.Data.IsolationLevel)"/> function
  5389. </summary>
  5390. <param name="isolationLevel">Supported isolation levels are Unspecified, Serializable, and ReadCommitted</param>
  5391. <returns></returns>
  5392. </member>
  5393. <member name="M:System.Data.SQLite.SQLiteConnection.ChangeDatabase(System.String)">
  5394. <summary>
  5395. This method is not implemented; however, the <see cref="E:System.Data.SQLite.SQLiteConnection.Changed"/>
  5396. event will still be raised.
  5397. </summary>
  5398. <param name="databaseName"></param>
  5399. </member>
  5400. <member name="M:System.Data.SQLite.SQLiteConnection.Close">
  5401. <summary>
  5402. When the database connection is closed, all commands linked to this connection are automatically reset.
  5403. </summary>
  5404. </member>
  5405. <member name="M:System.Data.SQLite.SQLiteConnection.ClearPool(System.Data.SQLite.SQLiteConnection)">
  5406. <summary>
  5407. Clears the connection pool associated with the connection. Any other active connections using the same database file
  5408. will be discarded instead of returned to the pool when they are closed.
  5409. </summary>
  5410. <param name="connection"></param>
  5411. </member>
  5412. <member name="M:System.Data.SQLite.SQLiteConnection.ClearAllPools">
  5413. <summary>
  5414. Clears all connection pools. Any active connections will be discarded instead of sent to the pool when they are closed.
  5415. </summary>
  5416. </member>
  5417. <member name="M:System.Data.SQLite.SQLiteConnection.CreateCommand">
  5418. <summary>
  5419. Create a new <see cref="T:System.Data.SQLite.SQLiteCommand"/> and associate it with this connection.
  5420. </summary>
  5421. <returns>Returns a new command object already assigned to this connection.</returns>
  5422. </member>
  5423. <member name="M:System.Data.SQLite.SQLiteConnection.CreateDbCommand">
  5424. <summary>
  5425. Forwards to the local <see cref="M:System.Data.SQLite.SQLiteConnection.CreateCommand"/> function.
  5426. </summary>
  5427. <returns></returns>
  5428. </member>
  5429. <member name="M:System.Data.SQLite.SQLiteConnection.CreateSession(System.String)">
  5430. <summary>
  5431. Attempts to create a new <see cref="T:System.Data.SQLite.ISQLiteSession"/> object instance
  5432. using this connection and the specified database name.
  5433. </summary>
  5434. <param name="databaseName">
  5435. The name of the database for the newly created session.
  5436. </param>
  5437. <returns>
  5438. The newly created session -OR- null if it cannot be created.
  5439. </returns>
  5440. </member>
  5441. <member name="M:System.Data.SQLite.SQLiteConnection.CreateChangeSet(System.Byte[])">
  5442. <summary>
  5443. Attempts to create a new <see cref="T:System.Data.SQLite.ISQLiteChangeSet"/> object instance
  5444. using this connection and the specified raw data.
  5445. </summary>
  5446. <param name="rawData">
  5447. The raw data that contains a change set (or patch set).
  5448. </param>
  5449. <returns>
  5450. The newly created change set -OR- null if it cannot be created.
  5451. </returns>
  5452. </member>
  5453. <member name="M:System.Data.SQLite.SQLiteConnection.CreateChangeSet(System.Byte[],System.Data.SQLite.SQLiteChangeSetStartFlags)">
  5454. <summary>
  5455. Attempts to create a new <see cref="T:System.Data.SQLite.ISQLiteChangeSet"/> object instance
  5456. using this connection and the specified raw data.
  5457. </summary>
  5458. <param name="rawData">
  5459. The raw data that contains a change set (or patch set).
  5460. </param>
  5461. <param name="flags">
  5462. The flags used to create the change set iterator.
  5463. </param>
  5464. <returns>
  5465. The newly created change set -OR- null if it cannot be created.
  5466. </returns>
  5467. </member>
  5468. <member name="M:System.Data.SQLite.SQLiteConnection.CreateChangeSet(System.IO.Stream,System.IO.Stream)">
  5469. <summary>
  5470. Attempts to create a new <see cref="T:System.Data.SQLite.ISQLiteChangeSet"/> object instance
  5471. using this connection and the specified stream.
  5472. </summary>
  5473. <param name="inputStream">
  5474. The stream where the raw data that contains a change set (or patch set)
  5475. may be read.
  5476. </param>
  5477. <param name="outputStream">
  5478. The stream where the raw data that contains a change set (or patch set)
  5479. may be written.
  5480. </param>
  5481. <returns>
  5482. The newly created change set -OR- null if it cannot be created.
  5483. </returns>
  5484. </member>
  5485. <member name="M:System.Data.SQLite.SQLiteConnection.CreateChangeSet(System.IO.Stream,System.IO.Stream,System.Data.SQLite.SQLiteChangeSetStartFlags)">
  5486. <summary>
  5487. Attempts to create a new <see cref="T:System.Data.SQLite.ISQLiteChangeSet"/> object instance
  5488. using this connection and the specified stream.
  5489. </summary>
  5490. <param name="inputStream">
  5491. The stream where the raw data that contains a change set (or patch set)
  5492. may be read.
  5493. </param>
  5494. <param name="outputStream">
  5495. The stream where the raw data that contains a change set (or patch set)
  5496. may be written.
  5497. </param>
  5498. <param name="flags">
  5499. The flags used to create the change set iterator.
  5500. </param>
  5501. <returns>
  5502. The newly created change set -OR- null if it cannot be created.
  5503. </returns>
  5504. </member>
  5505. <member name="M:System.Data.SQLite.SQLiteConnection.CreateChangeGroup">
  5506. <summary>
  5507. Attempts to create a new <see cref="T:System.Data.SQLite.ISQLiteChangeGroup"/> object
  5508. instance using this connection.
  5509. </summary>
  5510. <returns>
  5511. The newly created change group -OR- null if it cannot be created.
  5512. </returns>
  5513. </member>
  5514. <member name="M:System.Data.SQLite.SQLiteConnection.ShouldUseLegacyConnectionStringParser(System.Data.SQLite.SQLiteConnection)">
  5515. <summary>
  5516. Determines if the legacy connection string parser should be used.
  5517. </summary>
  5518. <param name="connection">
  5519. The connection that will be using the parsed connection string.
  5520. </param>
  5521. <returns>
  5522. Non-zero if the legacy connection string parser should be used.
  5523. </returns>
  5524. </member>
  5525. <member name="M:System.Data.SQLite.SQLiteConnection.ParseConnectionString(System.String,System.Boolean)">
  5526. <summary>
  5527. Parses a connection string into component parts using the custom
  5528. connection string parser. An exception may be thrown if the syntax
  5529. of the connection string is incorrect.
  5530. </summary>
  5531. <param name="connectionString">
  5532. The connection string to parse.
  5533. </param>
  5534. <param name="allowNameOnly">
  5535. Non-zero if names are allowed without values.
  5536. </param>
  5537. <returns>
  5538. The list of key/value pairs corresponding to the parameters specified
  5539. within the connection string.
  5540. </returns>
  5541. </member>
  5542. <member name="M:System.Data.SQLite.SQLiteConnection.ParseConnectionString(System.Data.SQLite.SQLiteConnection,System.String,System.Boolean)">
  5543. <summary>
  5544. Parses a connection string into component parts using the custom
  5545. connection string parser. An exception may be thrown if the syntax
  5546. of the connection string is incorrect.
  5547. </summary>
  5548. <param name="connection">
  5549. The connection that will be using the parsed connection string.
  5550. </param>
  5551. <param name="connectionString">
  5552. The connection string to parse.
  5553. </param>
  5554. <param name="allowNameOnly">
  5555. Non-zero if names are allowed without values.
  5556. </param>
  5557. <returns>
  5558. The list of key/value pairs corresponding to the parameters specified
  5559. within the connection string.
  5560. </returns>
  5561. </member>
  5562. <member name="M:System.Data.SQLite.SQLiteConnection.ParseConnectionStringViaFramework(System.Data.SQLite.SQLiteConnection,System.String,System.Boolean)">
  5563. <summary>
  5564. Parses a connection string using the built-in (i.e. framework provided)
  5565. connection string parser class and returns the key/value pairs. An
  5566. exception may be thrown if the connection string is invalid or cannot be
  5567. parsed. When compiled for the .NET Compact Framework, the custom
  5568. connection string parser is always used instead because the framework
  5569. provided one is unavailable there.
  5570. </summary>
  5571. <param name="connection">
  5572. The connection that will be using the parsed connection string.
  5573. </param>
  5574. <param name="connectionString">
  5575. The connection string to parse.
  5576. </param>
  5577. <param name="strict">
  5578. Non-zero to throw an exception if any connection string values are not of
  5579. the <see cref="T:System.String"/> type. This is not applicable when running on
  5580. the .NET Compact Framework.
  5581. </param>
  5582. <returns>The list of key/value pairs.</returns>
  5583. </member>
  5584. <member name="M:System.Data.SQLite.SQLiteConnection.EnlistTransaction(System.Transactions.Transaction)">
  5585. <summary>
  5586. Manual distributed transaction enlistment support
  5587. </summary>
  5588. <param name="transaction">The distributed transaction to enlist in</param>
  5589. </member>
  5590. <member name="M:System.Data.SQLite.SQLiteConnection.WaitForEnlistmentReset(System.Int32,System.Nullable{System.Boolean})">
  5591. <summary>
  5592. <b>EXPERIMENTAL</b> --
  5593. Waits for the enlistment associated with this connection to be reset.
  5594. This method always throws <see cref="T:System.NotImplementedException"/> when
  5595. running on the .NET Compact Framework.
  5596. </summary>
  5597. <param name="timeoutMilliseconds">
  5598. The approximate maximum number of milliseconds to wait before timing
  5599. out the wait operation.
  5600. </param>
  5601. <param name="returnOnDisposed">
  5602. The return value to use if the connection has been disposed; if this
  5603. value is null, <see cref="T:System.ObjectDisposedException"/> will be raised
  5604. if the connection has been disposed.
  5605. </param>
  5606. <returns>
  5607. Non-zero if the enlistment assciated with this connection was reset;
  5608. otherwise, zero. It should be noted that this method returning a
  5609. non-zero value does not necessarily guarantee that the connection
  5610. can enlist in a new transaction (i.e. due to potentical race with
  5611. other threads); therefore, callers should generally use try/catch
  5612. when calling the <see cref="M:System.Data.SQLite.SQLiteConnection.EnlistTransaction(System.Transactions.Transaction)"/> method.
  5613. </returns>
  5614. </member>
  5615. <member name="M:System.Data.SQLite.SQLiteConnection.FindKey(System.Collections.Generic.SortedList{System.String,System.String},System.String,System.String)">
  5616. <summary>
  5617. Looks for a key in the array of key/values of the parameter string. If not found, return the specified default value
  5618. </summary>
  5619. <param name="items">The list to look in</param>
  5620. <param name="key">The key to find</param>
  5621. <param name="defValue">The default value to return if the key is not found</param>
  5622. <returns>The value corresponding to the specified key, or the default value if not found.</returns>
  5623. </member>
  5624. <member name="M:System.Data.SQLite.SQLiteConnection.TryParseEnum(System.Type,System.String,System.Boolean)">
  5625. <summary>
  5626. Attempts to convert the string value to an enumerated value of the specified type.
  5627. </summary>
  5628. <param name="type">The enumerated type to convert the string value to.</param>
  5629. <param name="value">The string value to be converted.</param>
  5630. <param name="ignoreCase">Non-zero to make the conversion case-insensitive.</param>
  5631. <returns>The enumerated value upon success or null upon error.</returns>
  5632. </member>
  5633. <member name="M:System.Data.SQLite.SQLiteConnection.TryParseByte(System.String,System.Globalization.NumberStyles,System.Byte@)">
  5634. <summary>
  5635. Attempts to convert an input string into a byte value.
  5636. </summary>
  5637. <param name="value">
  5638. The string value to be converted.
  5639. </param>
  5640. <param name="style">
  5641. The number styles to use for the conversion.
  5642. </param>
  5643. <param name="result">
  5644. Upon sucess, this will contain the parsed byte value.
  5645. Upon failure, the value of this parameter is undefined.
  5646. </param>
  5647. <returns>
  5648. Non-zero upon success; zero on failure.
  5649. </returns>
  5650. </member>
  5651. <member name="M:System.Data.SQLite.SQLiteConnection.SetLimitOption(System.Data.SQLite.SQLiteLimitOpsEnum,System.Int32)">
  5652. <summary>
  5653. Change a limit value for the database.
  5654. </summary>
  5655. <param name="option">
  5656. The database limit to change.
  5657. </param>
  5658. <param name="value">
  5659. The new value for the specified limit.
  5660. </param>
  5661. <returns>
  5662. The old value for the specified limit -OR- negative one if an error
  5663. occurs.
  5664. </returns>
  5665. </member>
  5666. <member name="M:System.Data.SQLite.SQLiteConnection.SetConfigurationOption(System.Data.SQLite.SQLiteConfigDbOpsEnum,System.Object)">
  5667. <summary>
  5668. Change a configuration option value for the database.
  5669. </summary>
  5670. <param name="option">
  5671. The database configuration option to change.
  5672. </param>
  5673. <param name="value">
  5674. The new value for the specified configuration option.
  5675. </param>
  5676. </member>
  5677. <member name="M:System.Data.SQLite.SQLiteConnection.EnableExtensions(System.Boolean)">
  5678. <summary>
  5679. Enables or disables extension loading.
  5680. </summary>
  5681. <param name="enable">
  5682. True to enable loading of extensions, false to disable.
  5683. </param>
  5684. </member>
  5685. <member name="M:System.Data.SQLite.SQLiteConnection.LoadExtension(System.String)">
  5686. <summary>
  5687. Loads a SQLite extension library from the named dynamic link library file.
  5688. </summary>
  5689. <param name="fileName">
  5690. The name of the dynamic link library file containing the extension.
  5691. </param>
  5692. </member>
  5693. <member name="M:System.Data.SQLite.SQLiteConnection.LoadExtension(System.String,System.String)">
  5694. <summary>
  5695. Loads a SQLite extension library from the named dynamic link library file.
  5696. </summary>
  5697. <param name="fileName">
  5698. The name of the dynamic link library file containing the extension.
  5699. </param>
  5700. <param name="procName">
  5701. The name of the exported function used to initialize the extension.
  5702. If null, the default "sqlite3_extension_init" will be used.
  5703. </param>
  5704. </member>
  5705. <member name="M:System.Data.SQLite.SQLiteConnection.CreateModule(System.Data.SQLite.SQLiteModule)">
  5706. <summary>
  5707. Creates a disposable module containing the implementation of a virtual
  5708. table.
  5709. </summary>
  5710. <param name="module">
  5711. The module object to be used when creating the disposable module.
  5712. </param>
  5713. </member>
  5714. <member name="M:System.Data.SQLite.SQLiteConnection.FromHexString(System.String)">
  5715. <summary>
  5716. Parses a string containing a sequence of zero or more hexadecimal
  5717. encoded byte values and returns the resulting byte array. The
  5718. "0x" prefix is not allowed on the input string.
  5719. </summary>
  5720. <param name="text">
  5721. The input string containing zero or more hexadecimal encoded byte
  5722. values.
  5723. </param>
  5724. <returns>
  5725. A byte array containing the parsed byte values or null if an error
  5726. was encountered.
  5727. </returns>
  5728. </member>
  5729. <member name="M:System.Data.SQLite.SQLiteConnection.ToHexString(System.Byte[])">
  5730. <summary>
  5731. Creates and returns a string containing the hexadecimal encoded byte
  5732. values from the input array.
  5733. </summary>
  5734. <param name="array">
  5735. The input array of bytes.
  5736. </param>
  5737. <returns>
  5738. The resulting string or null upon failure.
  5739. </returns>
  5740. </member>
  5741. <member name="M:System.Data.SQLite.SQLiteConnection.FromHexString(System.String,System.String@)">
  5742. <summary>
  5743. Parses a string containing a sequence of zero or more hexadecimal
  5744. encoded byte values and returns the resulting byte array. The
  5745. "0x" prefix is not allowed on the input string.
  5746. </summary>
  5747. <param name="text">
  5748. The input string containing zero or more hexadecimal encoded byte
  5749. values.
  5750. </param>
  5751. <param name="error">
  5752. Upon failure, this will contain an appropriate error message.
  5753. </param>
  5754. <returns>
  5755. A byte array containing the parsed byte values or null if an error
  5756. was encountered.
  5757. </returns>
  5758. </member>
  5759. <member name="M:System.Data.SQLite.SQLiteConnection.GetDefaultPooling">
  5760. <summary>
  5761. This method figures out what the default connection pool setting should
  5762. be based on the connection flags. When present, the "Pooling" connection
  5763. string property value always overrides the value returned by this method.
  5764. </summary>
  5765. <returns>
  5766. Non-zero if the connection pool should be enabled by default; otherwise,
  5767. zero.
  5768. </returns>
  5769. </member>
  5770. <member name="M:System.Data.SQLite.SQLiteConnection.GetEffectiveIsolationLevel(System.Data.IsolationLevel)">
  5771. <summary>
  5772. Determines the transaction isolation level that should be used by
  5773. the caller, primarily based upon the one specified by the caller.
  5774. If mapping of transaction isolation levels is enabled, the returned
  5775. transaction isolation level may be significantly different than the
  5776. originally specified one.
  5777. </summary>
  5778. <param name="isolationLevel">
  5779. The originally specified transaction isolation level.
  5780. </param>
  5781. <returns>
  5782. The transaction isolation level that should be used.
  5783. </returns>
  5784. </member>
  5785. <member name="M:System.Data.SQLite.SQLiteConnection.Open">
  5786. <summary>
  5787. Opens the connection using the parameters found in the <see cref="P:System.Data.SQLite.SQLiteConnection.ConnectionString"/>.
  5788. </summary>
  5789. </member>
  5790. <member name="M:System.Data.SQLite.SQLiteConnection.OpenAndReturn">
  5791. <summary>
  5792. Opens the connection using the parameters found in the <see cref="P:System.Data.SQLite.SQLiteConnection.ConnectionString"/> and then returns it.
  5793. </summary>
  5794. <returns>The current connection object.</returns>
  5795. </member>
  5796. <member name="M:System.Data.SQLite.SQLiteConnection.Cancel">
  5797. <summary>
  5798. This method causes any pending database operation to abort and return at
  5799. its earliest opportunity. This routine is typically called in response
  5800. to a user action such as pressing "Cancel" or Ctrl-C where the user wants
  5801. a long query operation to halt immediately. It is safe to call this
  5802. routine from any thread. However, it is not safe to call this routine
  5803. with a database connection that is closed or might close before this method
  5804. returns.
  5805. </summary>
  5806. </member>
  5807. <member name="M:System.Data.SQLite.SQLiteConnection.IsReadOnly(System.String)">
  5808. <summary>
  5809. Checks if this connection to the specified database should be considered
  5810. read-only. An exception will be thrown if the database name specified
  5811. via <paramref name="name" /> cannot be found.
  5812. </summary>
  5813. <param name="name">
  5814. The name of a database associated with this connection -OR- null for the
  5815. main database.
  5816. </param>
  5817. <returns>
  5818. Non-zero if this connection to the specified database should be considered
  5819. read-only.
  5820. </returns>
  5821. </member>
  5822. <member name="M:System.Data.SQLite.SQLiteConnection.GetMemoryStatistics(System.Collections.Generic.IDictionary{System.String,System.Int64}@)">
  5823. <summary>
  5824. Returns various global memory statistics for the SQLite core library via
  5825. a dictionary of key/value pairs. Currently, only the "MemoryUsed" and
  5826. "MemoryHighwater" keys are returned and they have values that correspond
  5827. to the values that could be obtained via the <see cref="P:System.Data.SQLite.SQLiteConnection.MemoryUsed"/>
  5828. and <see cref="P:System.Data.SQLite.SQLiteConnection.MemoryHighwater"/> connection properties.
  5829. </summary>
  5830. <param name="statistics">
  5831. This dictionary will be populated with the global memory statistics. It
  5832. will be created if necessary.
  5833. </param>
  5834. </member>
  5835. <member name="M:System.Data.SQLite.SQLiteConnection.ReleaseMemory">
  5836. <summary>
  5837. Attempts to free as much heap memory as possible for this database connection.
  5838. </summary>
  5839. </member>
  5840. <member name="M:System.Data.SQLite.SQLiteConnection.ReleaseMemory(System.Int32,System.Boolean,System.Boolean,System.Int32@,System.Boolean@,System.UInt32@)">
  5841. <summary>
  5842. Attempts to free N bytes of heap memory by deallocating non-essential memory
  5843. allocations held by the database library. Memory used to cache database pages
  5844. to improve performance is an example of non-essential memory. This is a no-op
  5845. returning zero if the SQLite core library was not compiled with the compile-time
  5846. option SQLITE_ENABLE_MEMORY_MANAGEMENT. Optionally, attempts to reset and/or
  5847. compact the Win32 native heap, if applicable.
  5848. </summary>
  5849. <param name="nBytes">
  5850. The requested number of bytes to free.
  5851. </param>
  5852. <param name="reset">
  5853. Non-zero to attempt a heap reset.
  5854. </param>
  5855. <param name="compact">
  5856. Non-zero to attempt heap compaction.
  5857. </param>
  5858. <param name="nFree">
  5859. The number of bytes actually freed. This value may be zero.
  5860. </param>
  5861. <param name="resetOk">
  5862. This value will be non-zero if the heap reset was successful.
  5863. </param>
  5864. <param name="nLargest">
  5865. The size of the largest committed free block in the heap, in bytes.
  5866. This value will be zero unless heap compaction is enabled.
  5867. </param>
  5868. <returns>
  5869. A standard SQLite return code (i.e. zero for success and non-zero
  5870. for failure).
  5871. </returns>
  5872. </member>
  5873. <member name="M:System.Data.SQLite.SQLiteConnection.SetMemoryStatus(System.Boolean)">
  5874. <summary>
  5875. Sets the status of the memory usage tracking subsystem in the SQLite core library. By default, this is enabled.
  5876. If this is disabled, memory usage tracking will not be performed. This is not really a per-connection value, it is
  5877. global to the process.
  5878. </summary>
  5879. <param name="value">Non-zero to enable memory usage tracking, zero otherwise.</param>
  5880. <returns>A standard SQLite return code (i.e. zero for success and non-zero for failure).</returns>
  5881. </member>
  5882. <member name="M:System.Data.SQLite.SQLiteConnection.TryGetLastCachedSetting(System.String,System.Object,System.Object@)">
  5883. <summary>
  5884. Queries and returns the value of the specified setting, using the
  5885. cached setting names and values for the last connection that used
  5886. the <see cref="M:System.Data.SQLite.SQLiteConnection.Open"/> method, when available.
  5887. </summary>
  5888. <param name="name">
  5889. The name of the setting.
  5890. </param>
  5891. <param name="default">
  5892. The value to be returned if the setting has not been set explicitly
  5893. or cannot be determined.
  5894. </param>
  5895. <param name="value">
  5896. The value of the cached setting is stored here if found; otherwise,
  5897. the value of <paramref name="default"/> is stored here.
  5898. </param>
  5899. <returns>
  5900. Non-zero if the cached setting was found; otherwise, zero.
  5901. </returns>
  5902. </member>
  5903. <member name="M:System.Data.SQLite.SQLiteConnection.SetLastCachedSetting(System.String,System.Object)">
  5904. <summary>
  5905. Adds or sets the cached setting specified by <paramref name="name"/>
  5906. to the value specified by <paramref name="value"/> using the cached
  5907. setting names and values for the last connection that used the
  5908. <see cref="M:System.Data.SQLite.SQLiteConnection.Open"/> method, when available.
  5909. </summary>
  5910. <param name="name">
  5911. The name of the cached setting to add or replace.
  5912. </param>
  5913. <param name="value">
  5914. The new value of the cached setting.
  5915. </param>
  5916. </member>
  5917. <member name="M:System.Data.SQLite.SQLiteConnection.Shutdown">
  5918. <summary>
  5919. Passes a shutdown request to the SQLite core library. Does not throw
  5920. an exception if the shutdown request fails.
  5921. </summary>
  5922. <returns>
  5923. A standard SQLite return code (i.e. zero for success and non-zero for
  5924. failure).
  5925. </returns>
  5926. </member>
  5927. <member name="M:System.Data.SQLite.SQLiteConnection.Shutdown(System.Boolean,System.Boolean)">
  5928. <summary>
  5929. Passes a shutdown request to the SQLite core library. Throws an
  5930. exception if the shutdown request fails and the no-throw parameter
  5931. is non-zero.
  5932. </summary>
  5933. <param name="directories">
  5934. Non-zero to reset the database and temporary directories to their
  5935. default values, which should be null for both.
  5936. </param>
  5937. <param name="noThrow">
  5938. When non-zero, throw an exception if the shutdown request fails.
  5939. </param>
  5940. </member>
  5941. <member name="M:System.Data.SQLite.SQLiteConnection.SetExtendedResultCodes(System.Boolean)">
  5942. Enables or disables extended result codes returned by SQLite
  5943. </member>
  5944. <member name="M:System.Data.SQLite.SQLiteConnection.ResultCode">
  5945. Enables or disables extended result codes returned by SQLite
  5946. </member>
  5947. <member name="M:System.Data.SQLite.SQLiteConnection.ExtendedResultCode">
  5948. Enables or disables extended result codes returned by SQLite
  5949. </member>
  5950. <member name="M:System.Data.SQLite.SQLiteConnection.LogMessage(System.Data.SQLite.SQLiteErrorCode,System.String)">
  5951. Add a log message via the SQLite sqlite3_log interface.
  5952. </member>
  5953. <member name="M:System.Data.SQLite.SQLiteConnection.LogMessage(System.Int32,System.String)">
  5954. Add a log message via the SQLite sqlite3_log interface.
  5955. </member>
  5956. <member name="M:System.Data.SQLite.SQLiteConnection.ChangePassword(System.String)">
  5957. <summary>
  5958. Change the password (or assign a password) to an open database.
  5959. </summary>
  5960. <remarks>
  5961. No readers or writers may be active for this process. The database must already be open
  5962. and if it already was password protected, the existing password must already have been supplied.
  5963. </remarks>
  5964. <param name="newPassword">The new password to assign to the database</param>
  5965. </member>
  5966. <member name="M:System.Data.SQLite.SQLiteConnection.ChangePassword(System.Byte[])">
  5967. <summary>
  5968. Change the password (or assign a password) to an open database.
  5969. </summary>
  5970. <remarks>
  5971. No readers or writers may be active for this process. The database must already be open
  5972. and if it already was password protected, the existing password must already have been supplied.
  5973. </remarks>
  5974. <param name="newPassword">The new password to assign to the database</param>
  5975. </member>
  5976. <member name="M:System.Data.SQLite.SQLiteConnection.SetPassword(System.String)">
  5977. <summary>
  5978. Sets the password for a password-protected database. A password-protected database is
  5979. unusable for any operation until the password has been set.
  5980. </summary>
  5981. <param name="databasePassword">The password for the database</param>
  5982. </member>
  5983. <member name="M:System.Data.SQLite.SQLiteConnection.SetPassword(System.Byte[])">
  5984. <summary>
  5985. Sets the password for a password-protected database. A password-protected database is
  5986. unusable for any operation until the password has been set.
  5987. </summary>
  5988. <param name="databasePassword">The password for the database</param>
  5989. </member>
  5990. <member name="M:System.Data.SQLite.SQLiteConnection.SetAvRetry(System.Int32@,System.Int32@)">
  5991. <summary>
  5992. Queries or modifies the number of retries or the retry interval (in milliseconds) for
  5993. certain I/O operations that may fail due to anti-virus software.
  5994. </summary>
  5995. <param name="count">The number of times to retry the I/O operation. A negative value
  5996. will cause the current count to be queried and replace that negative value.</param>
  5997. <param name="interval">The number of milliseconds to wait before retrying the I/O
  5998. operation. This number is multiplied by the number of retry attempts so far to come
  5999. up with the final number of milliseconds to wait. A negative value will cause the
  6000. current interval to be queried and replace that negative value.</param>
  6001. <returns>Zero for success, non-zero for error.</returns>
  6002. </member>
  6003. <member name="M:System.Data.SQLite.SQLiteConnection.SetChunkSize(System.Int32)">
  6004. <summary>
  6005. Sets the chunk size for the primary file associated with this database
  6006. connection.
  6007. </summary>
  6008. <param name="size">
  6009. The new chunk size for the main database, in bytes.
  6010. </param>
  6011. <returns>
  6012. Zero for success, non-zero for error.
  6013. </returns>
  6014. </member>
  6015. <member name="M:System.Data.SQLite.SQLiteConnection.UnwrapString(System.String)">
  6016. <summary>
  6017. Removes one set of surrounding single -OR- double quotes from the string
  6018. value and returns the resulting string value. If the string is null, empty,
  6019. or contains quotes that are not balanced, nothing is done and the original
  6020. string value will be returned.
  6021. </summary>
  6022. <param name="value">The string value to process.</param>
  6023. <returns>
  6024. The string value, modified to remove one set of surrounding single -OR-
  6025. double quotes, if applicable.
  6026. </returns>
  6027. </member>
  6028. <member name="M:System.Data.SQLite.SQLiteConnection.GetDataDirectory">
  6029. <summary>
  6030. Determines the directory to be used when dealing with the "|DataDirectory|"
  6031. macro in a database file name.
  6032. </summary>
  6033. <returns>
  6034. The directory to use in place of the "|DataDirectory|" macro -OR- null if it
  6035. cannot be determined.
  6036. </returns>
  6037. </member>
  6038. <member name="M:System.Data.SQLite.SQLiteConnection.ExpandFileName(System.String,System.Boolean)">
  6039. <summary>
  6040. Expand the filename of the data source, resolving the |DataDirectory|
  6041. macro as appropriate.
  6042. </summary>
  6043. <param name="sourceFile">The database filename to expand</param>
  6044. <param name="toFullPath">
  6045. Non-zero if the returned file name should be converted to a full path
  6046. (except when using the .NET Compact Framework).
  6047. </param>
  6048. <returns>The expanded path and filename of the filename</returns>
  6049. </member>
  6050. <member name="M:System.Data.SQLite.SQLiteConnection.GetSchema">
  6051. <overloads>
  6052. The following commands are used to extract schema information out of the database. Valid schema types are:
  6053. <list type="bullet">
  6054. <item>
  6055. <description>MetaDataCollections</description>
  6056. </item>
  6057. <item>
  6058. <description>DataSourceInformation</description>
  6059. </item>
  6060. <item>
  6061. <description>Catalogs</description>
  6062. </item>
  6063. <item>
  6064. <description>Columns</description>
  6065. </item>
  6066. <item>
  6067. <description>ForeignKeys</description>
  6068. </item>
  6069. <item>
  6070. <description>Indexes</description>
  6071. </item>
  6072. <item>
  6073. <description>IndexColumns</description>
  6074. </item>
  6075. <item>
  6076. <description>Tables</description>
  6077. </item>
  6078. <item>
  6079. <description>Views</description>
  6080. </item>
  6081. <item>
  6082. <description>ViewColumns</description>
  6083. </item>
  6084. </list>
  6085. </overloads>
  6086. <summary>
  6087. Returns the MetaDataCollections schema
  6088. </summary>
  6089. <returns>A DataTable of the MetaDataCollections schema</returns>
  6090. </member>
  6091. <member name="M:System.Data.SQLite.SQLiteConnection.GetSchema(System.String)">
  6092. <summary>
  6093. Returns schema information of the specified collection
  6094. </summary>
  6095. <param name="collectionName">The schema collection to retrieve</param>
  6096. <returns>A DataTable of the specified collection</returns>
  6097. </member>
  6098. <member name="M:System.Data.SQLite.SQLiteConnection.GetSchema(System.String,System.String[])">
  6099. <summary>
  6100. Retrieves schema information using the specified constraint(s) for the specified collection
  6101. </summary>
  6102. <param name="collectionName">The collection to retrieve.</param>
  6103. <param name="restrictionValues">
  6104. The restrictions to impose. Typically, this may include:
  6105. <list type="table">
  6106. <listheader>
  6107. <term>restrictionValues element index</term>
  6108. <term>usage</term>
  6109. </listheader>
  6110. <item>
  6111. <description>0</description>
  6112. <description>The database (or catalog) name, if applicable.</description>
  6113. </item>
  6114. <item>
  6115. <description>1</description>
  6116. <description>The schema name. This is not used by this provider.</description>
  6117. </item>
  6118. <item>
  6119. <description>2</description>
  6120. <description>The table name, if applicable.</description>
  6121. </item>
  6122. <item>
  6123. <description>3</description>
  6124. <description>
  6125. Depends on <paramref name="collectionName" />.
  6126. When "IndexColumns", it is the index name; otherwise, it is the column name.
  6127. </description>
  6128. </item>
  6129. <item>
  6130. <description>4</description>
  6131. <description>
  6132. Depends on <paramref name="collectionName" />.
  6133. When "IndexColumns", it is the column name; otherwise, it is not used.
  6134. </description>
  6135. </item>
  6136. </list>
  6137. </param>
  6138. <returns>A DataTable of the specified collection</returns>
  6139. </member>
  6140. <member name="M:System.Data.SQLite.SQLiteConnection.Schema_MetaDataCollections">
  6141. <summary>
  6142. Builds a MetaDataCollections schema datatable
  6143. </summary>
  6144. <returns>DataTable</returns>
  6145. </member>
  6146. <member name="M:System.Data.SQLite.SQLiteConnection.Schema_DataSourceInformation">
  6147. <summary>
  6148. Builds a DataSourceInformation datatable
  6149. </summary>
  6150. <returns>DataTable</returns>
  6151. </member>
  6152. <member name="M:System.Data.SQLite.SQLiteConnection.Schema_Columns(System.String,System.String,System.String)">
  6153. <summary>
  6154. Build a Columns schema
  6155. </summary>
  6156. <param name="strCatalog">The catalog (attached database) to query, can be null</param>
  6157. <param name="strTable">The table to retrieve schema information for, can be null</param>
  6158. <param name="strColumn">The column to retrieve schema information for, can be null</param>
  6159. <returns>DataTable</returns>
  6160. </member>
  6161. <member name="M:System.Data.SQLite.SQLiteConnection.Schema_Indexes(System.String,System.String,System.String)">
  6162. <summary>
  6163. Returns index information for the given database and catalog
  6164. </summary>
  6165. <param name="strCatalog">The catalog (attached database) to query, can be null</param>
  6166. <param name="strIndex">The name of the index to retrieve information for, can be null</param>
  6167. <param name="strTable">The table to retrieve index information for, can be null</param>
  6168. <returns>DataTable</returns>
  6169. </member>
  6170. <member name="M:System.Data.SQLite.SQLiteConnection.Schema_Tables(System.String,System.String,System.String)">
  6171. <summary>
  6172. Retrieves table schema information for the database and catalog
  6173. </summary>
  6174. <param name="strCatalog">The catalog (attached database) to retrieve tables on</param>
  6175. <param name="strTable">The table to retrieve, can be null</param>
  6176. <param name="strType">The table type, can be null</param>
  6177. <returns>DataTable</returns>
  6178. </member>
  6179. <member name="M:System.Data.SQLite.SQLiteConnection.Schema_Views(System.String,System.String)">
  6180. <summary>
  6181. Retrieves view schema information for the database
  6182. </summary>
  6183. <param name="strCatalog">The catalog (attached database) to retrieve views on</param>
  6184. <param name="strView">The view name, can be null</param>
  6185. <returns>DataTable</returns>
  6186. </member>
  6187. <member name="M:System.Data.SQLite.SQLiteConnection.Schema_Catalogs(System.String)">
  6188. <summary>
  6189. Retrieves catalog (attached databases) schema information for the database
  6190. </summary>
  6191. <param name="strCatalog">The catalog to retrieve, can be null</param>
  6192. <returns>DataTable</returns>
  6193. </member>
  6194. <member name="M:System.Data.SQLite.SQLiteConnection.Schema_IndexColumns(System.String,System.String,System.String,System.String)">
  6195. <summary>
  6196. Returns the base column information for indexes in a database
  6197. </summary>
  6198. <param name="strCatalog">The catalog to retrieve indexes for (can be null)</param>
  6199. <param name="strTable">The table to restrict index information by (can be null)</param>
  6200. <param name="strIndex">The index to restrict index information by (can be null)</param>
  6201. <param name="strColumn">The source column to restrict index information by (can be null)</param>
  6202. <returns>A DataTable containing the results</returns>
  6203. </member>
  6204. <member name="M:System.Data.SQLite.SQLiteConnection.Schema_ViewColumns(System.String,System.String,System.String)">
  6205. <summary>
  6206. Returns detailed column information for a specified view
  6207. </summary>
  6208. <param name="strCatalog">The catalog to retrieve columns for (can be null)</param>
  6209. <param name="strView">The view to restrict column information by (can be null)</param>
  6210. <param name="strColumn">The source column to restrict column information by (can be null)</param>
  6211. <returns>A DataTable containing the results</returns>
  6212. </member>
  6213. <member name="M:System.Data.SQLite.SQLiteConnection.Schema_ForeignKeys(System.String,System.String,System.String)">
  6214. <summary>
  6215. Retrieves foreign key information from the specified set of filters
  6216. </summary>
  6217. <param name="strCatalog">An optional catalog to restrict results on</param>
  6218. <param name="strTable">An optional table to restrict results on</param>
  6219. <param name="strKeyName">An optional foreign key name to restrict results on</param>
  6220. <returns>A DataTable with the results of the query</returns>
  6221. </member>
  6222. <member name="E:System.Data.SQLite.SQLiteConnection._handlers">
  6223. <summary>
  6224. Static variable to store the connection event handlers to call.
  6225. </summary>
  6226. </member>
  6227. <member name="E:System.Data.SQLite.SQLiteConnection.StateChange">
  6228. <summary>
  6229. This event is raised whenever the database is opened or closed.
  6230. </summary>
  6231. </member>
  6232. <member name="E:System.Data.SQLite.SQLiteConnection.Changed">
  6233. <summary>
  6234. This event is raised when events related to the lifecycle of a
  6235. SQLiteConnection object occur.
  6236. </summary>
  6237. </member>
  6238. <member name="P:System.Data.SQLite.SQLiteConnection.ConnectionPool">
  6239. <summary>
  6240. This property is used to obtain or set the custom connection pool
  6241. implementation to use, if any. Setting this property to null will
  6242. cause the default connection pool implementation to be used.
  6243. </summary>
  6244. </member>
  6245. <member name="P:System.Data.SQLite.SQLiteConnection.PoolCount">
  6246. <summary>
  6247. Returns the number of pool entries for the file name associated with this connection.
  6248. </summary>
  6249. </member>
  6250. <member name="P:System.Data.SQLite.SQLiteConnection.ConnectionString">
  6251. <summary>
  6252. The connection string containing the parameters for the connection
  6253. </summary>
  6254. <remarks>
  6255. For the complete list of supported connection string properties,
  6256. please see <see cref="T:System.Data.SQLite.SQLiteConnection"/>.
  6257. </remarks>
  6258. </member>
  6259. <member name="P:System.Data.SQLite.SQLiteConnection.DataSource">
  6260. <summary>
  6261. Returns the data source file name without extension or path.
  6262. </summary>
  6263. </member>
  6264. <member name="P:System.Data.SQLite.SQLiteConnection.FileName">
  6265. <summary>
  6266. Returns the fully qualified path and file name for the currently open
  6267. database, if any.
  6268. </summary>
  6269. </member>
  6270. <member name="P:System.Data.SQLite.SQLiteConnection.Database">
  6271. <summary>
  6272. Returns the string "main".
  6273. </summary>
  6274. </member>
  6275. <member name="P:System.Data.SQLite.SQLiteConnection.DefaultTimeout">
  6276. <summary>
  6277. Gets/sets the default command timeout for newly-created commands. This is especially useful for
  6278. commands used internally such as inside a SQLiteTransaction, where setting the timeout is not possible.
  6279. This can also be set in the ConnectionString with "Default Timeout"
  6280. </summary>
  6281. </member>
  6282. <member name="P:System.Data.SQLite.SQLiteConnection.BusyTimeout">
  6283. <summary>
  6284. Gets/sets the default busy timeout to use with the SQLite core library. This is only used when
  6285. opening a connection.
  6286. </summary>
  6287. </member>
  6288. <member name="P:System.Data.SQLite.SQLiteConnection.WaitTimeout">
  6289. <summary>
  6290. <b>EXPERIMENTAL</b> --
  6291. The wait timeout to use with <see cref="M:System.Data.SQLite.SQLiteConnection.WaitForEnlistmentReset(System.Int32,System.Nullable{System.Boolean})"/> method.
  6292. This is only used when waiting for the enlistment to be reset prior to
  6293. enlisting in a transaction, and then only when the appropriate connection
  6294. flag is set.
  6295. </summary>
  6296. </member>
  6297. <member name="P:System.Data.SQLite.SQLiteConnection.PrepareRetries">
  6298. <summary>
  6299. The maximum number of retries when preparing SQL to be executed. This
  6300. normally only applies to preparation errors resulting from the database
  6301. schema being changed.
  6302. </summary>
  6303. </member>
  6304. <member name="P:System.Data.SQLite.SQLiteConnection.ProgressOps">
  6305. <summary>
  6306. The approximate number of virtual machine instructions between progress
  6307. events. In order for progress events to actually fire, the event handler
  6308. must be added to the <see cref="E:System.Data.SQLite.SQLiteConnection.Progress"/> event as
  6309. well. This value will only be used when the underlying native progress
  6310. callback needs to be changed.
  6311. </summary>
  6312. </member>
  6313. <member name="P:System.Data.SQLite.SQLiteConnection.ParseViaFramework">
  6314. <summary>
  6315. Non-zero if the built-in (i.e. framework provided) connection string
  6316. parser should be used when opening the connection.
  6317. </summary>
  6318. </member>
  6319. <member name="P:System.Data.SQLite.SQLiteConnection.Flags">
  6320. <summary>
  6321. Gets/sets the extra behavioral flags for this connection. See the
  6322. <see cref="T:System.Data.SQLite.SQLiteConnectionFlags"/> enumeration for a list of
  6323. possible values.
  6324. </summary>
  6325. </member>
  6326. <member name="P:System.Data.SQLite.SQLiteConnection.DefaultDbType">
  6327. <summary>
  6328. Gets/sets the default database type for this connection. This value
  6329. will only be used when not null.
  6330. </summary>
  6331. </member>
  6332. <member name="P:System.Data.SQLite.SQLiteConnection.DefaultTypeName">
  6333. <summary>
  6334. Gets/sets the default database type name for this connection. This
  6335. value will only be used when not null.
  6336. </summary>
  6337. </member>
  6338. <member name="P:System.Data.SQLite.SQLiteConnection.VfsName">
  6339. <summary>
  6340. Gets/sets the VFS name for this connection. This value will only be
  6341. used when opening the database.
  6342. </summary>
  6343. </member>
  6344. <member name="P:System.Data.SQLite.SQLiteConnection.OwnHandle">
  6345. <summary>
  6346. Returns non-zero if the underlying native connection handle is
  6347. owned by this instance.
  6348. </summary>
  6349. </member>
  6350. <member name="P:System.Data.SQLite.SQLiteConnection.ServerVersion">
  6351. <summary>
  6352. Returns the version of the underlying SQLite database engine
  6353. </summary>
  6354. </member>
  6355. <member name="P:System.Data.SQLite.SQLiteConnection.LastInsertRowId">
  6356. <summary>
  6357. Returns the rowid of the most recent successful INSERT into the database from this connection.
  6358. </summary>
  6359. </member>
  6360. <member name="P:System.Data.SQLite.SQLiteConnection.Changes">
  6361. <summary>
  6362. Returns the number of rows changed by the last INSERT, UPDATE, or DELETE statement executed on
  6363. this connection.
  6364. </summary>
  6365. </member>
  6366. <member name="P:System.Data.SQLite.SQLiteConnection.AutoCommit">
  6367. <summary>
  6368. Returns non-zero if the given database connection is in autocommit mode.
  6369. Autocommit mode is on by default. Autocommit mode is disabled by a BEGIN
  6370. statement. Autocommit mode is re-enabled by a COMMIT or ROLLBACK.
  6371. </summary>
  6372. </member>
  6373. <member name="P:System.Data.SQLite.SQLiteConnection.MemoryUsed">
  6374. <summary>
  6375. Returns the amount of memory (in bytes) currently in use by the SQLite core library.
  6376. </summary>
  6377. </member>
  6378. <member name="P:System.Data.SQLite.SQLiteConnection.MemoryHighwater">
  6379. <summary>
  6380. Returns the maximum amount of memory (in bytes) used by the SQLite core library since the high-water mark was last reset.
  6381. </summary>
  6382. </member>
  6383. <member name="P:System.Data.SQLite.SQLiteConnection.DefineConstants">
  6384. <summary>
  6385. Returns a string containing the define constants (i.e. compile-time
  6386. options) used to compile the core managed assembly, delimited with
  6387. spaces.
  6388. </summary>
  6389. </member>
  6390. <member name="P:System.Data.SQLite.SQLiteConnection.SQLiteVersion">
  6391. <summary>
  6392. Returns the version of the underlying SQLite core library.
  6393. </summary>
  6394. </member>
  6395. <member name="P:System.Data.SQLite.SQLiteConnection.SQLiteSourceId">
  6396. <summary>
  6397. This method returns the string whose value is the same as the
  6398. SQLITE_SOURCE_ID C preprocessor macro used when compiling the
  6399. SQLite core library.
  6400. </summary>
  6401. </member>
  6402. <member name="P:System.Data.SQLite.SQLiteConnection.SQLiteCompileOptions">
  6403. <summary>
  6404. Returns a string containing the compile-time options used to
  6405. compile the SQLite core native library, delimited with spaces.
  6406. </summary>
  6407. </member>
  6408. <member name="P:System.Data.SQLite.SQLiteConnection.InteropVersion">
  6409. <summary>
  6410. This method returns the version of the interop SQLite assembly
  6411. used. If the SQLite interop assembly is not in use or the
  6412. necessary information cannot be obtained for any reason, a null
  6413. value may be returned.
  6414. </summary>
  6415. </member>
  6416. <member name="P:System.Data.SQLite.SQLiteConnection.InteropSourceId">
  6417. <summary>
  6418. This method returns the string whose value contains the unique
  6419. identifier for the source checkout used to build the interop
  6420. assembly. If the SQLite interop assembly is not in use or the
  6421. necessary information cannot be obtained for any reason, a null
  6422. value may be returned.
  6423. </summary>
  6424. </member>
  6425. <member name="P:System.Data.SQLite.SQLiteConnection.InteropCompileOptions">
  6426. <summary>
  6427. Returns a string containing the compile-time options used to
  6428. compile the SQLite interop assembly, delimited with spaces.
  6429. </summary>
  6430. </member>
  6431. <member name="P:System.Data.SQLite.SQLiteConnection.ProviderVersion">
  6432. <summary>
  6433. This method returns the version of the managed components used
  6434. to interact with the SQLite core library. If the necessary
  6435. information cannot be obtained for any reason, a null value may
  6436. be returned.
  6437. </summary>
  6438. </member>
  6439. <member name="P:System.Data.SQLite.SQLiteConnection.ProviderSourceId">
  6440. <summary>
  6441. This method returns the string whose value contains the unique
  6442. identifier for the source checkout used to build the managed
  6443. components currently executing. If the necessary information
  6444. cannot be obtained for any reason, a null value may be returned.
  6445. </summary>
  6446. </member>
  6447. <member name="P:System.Data.SQLite.SQLiteConnection.DefaultFlags">
  6448. <summary>
  6449. The default connection flags to be used for all opened connections
  6450. when they are not present in the connection string.
  6451. </summary>
  6452. </member>
  6453. <member name="P:System.Data.SQLite.SQLiteConnection.SharedFlags">
  6454. <summary>
  6455. The extra connection flags to be used for all opened connections.
  6456. </summary>
  6457. </member>
  6458. <member name="P:System.Data.SQLite.SQLiteConnection.State">
  6459. <summary>
  6460. Returns the state of the connection.
  6461. </summary>
  6462. </member>
  6463. <member name="E:System.Data.SQLite.SQLiteConnection.Progress">
  6464. <summary>
  6465. This event is raised periodically during long running queries. Changing
  6466. the value of the <see cref="F:System.Data.SQLite.ProgressEventArgs.ReturnCode"/> property will
  6467. determine if the operation in progress will continue or be interrupted.
  6468. For the entire duration of the event, the associated connection and
  6469. statement objects must not be modified, either directly or indirectly, by
  6470. the called code.
  6471. </summary>
  6472. </member>
  6473. <member name="E:System.Data.SQLite.SQLiteConnection.Authorize">
  6474. <summary>
  6475. This event is raised whenever SQLite encounters an action covered by the
  6476. authorizer during query preparation. Changing the value of the
  6477. <see cref="F:System.Data.SQLite.AuthorizerEventArgs.ReturnCode"/> property will determine if
  6478. the specific action will be allowed, ignored, or denied. For the entire
  6479. duration of the event, the associated connection and statement objects
  6480. must not be modified, either directly or indirectly, by the called code.
  6481. </summary>
  6482. </member>
  6483. <member name="E:System.Data.SQLite.SQLiteConnection.Update">
  6484. <summary>
  6485. This event is raised whenever SQLite makes an update/delete/insert into the database on
  6486. this connection. It only applies to the given connection.
  6487. </summary>
  6488. </member>
  6489. <member name="E:System.Data.SQLite.SQLiteConnection.Commit">
  6490. <summary>
  6491. This event is raised whenever SQLite is committing a transaction.
  6492. Return non-zero to trigger a rollback.
  6493. </summary>
  6494. </member>
  6495. <member name="E:System.Data.SQLite.SQLiteConnection.Trace">
  6496. <summary>
  6497. This event is raised whenever SQLite statement first begins executing on
  6498. this connection. It only applies to the given connection.
  6499. </summary>
  6500. </member>
  6501. <member name="E:System.Data.SQLite.SQLiteConnection.RollBack">
  6502. <summary>
  6503. This event is raised whenever SQLite is rolling back a transaction.
  6504. </summary>
  6505. </member>
  6506. <member name="P:System.Data.SQLite.SQLiteConnection.DbProviderFactory">
  6507. <summary>
  6508. Returns the <see cref="T:System.Data.SQLite.SQLiteFactory"/> instance.
  6509. </summary>
  6510. </member>
  6511. <member name="T:System.Data.SQLite.SynchronizationModes">
  6512. <summary>
  6513. The I/O file cache flushing behavior for the connection
  6514. </summary>
  6515. </member>
  6516. <member name="F:System.Data.SQLite.SynchronizationModes.Normal">
  6517. <summary>
  6518. Normal file flushing at critical sections of the code
  6519. </summary>
  6520. </member>
  6521. <member name="F:System.Data.SQLite.SynchronizationModes.Full">
  6522. <summary>
  6523. Full file flushing after every write operation
  6524. </summary>
  6525. </member>
  6526. <member name="F:System.Data.SQLite.SynchronizationModes.Off">
  6527. <summary>
  6528. Use the default operating system's file flushing, SQLite does not explicitly flush the file buffers after writing
  6529. </summary>
  6530. </member>
  6531. <member name="T:System.Data.SQLite.SQLiteProgressEventHandler">
  6532. <summary>
  6533. Raised each time the number of virtual machine instructions is
  6534. approximately equal to the value of the
  6535. <see cref="P:System.Data.SQLite.SQLiteConnection.ProgressOps"/> property.
  6536. </summary>
  6537. <param name="sender">The connection performing the operation.</param>
  6538. <param name="e">A <see cref="T:System.Data.SQLite.ProgressEventArgs"/> that contains the
  6539. event data.</param>
  6540. </member>
  6541. <member name="T:System.Data.SQLite.SQLiteAuthorizerEventHandler">
  6542. <summary>
  6543. Raised when authorization is required to perform an action contained
  6544. within a SQL query.
  6545. </summary>
  6546. <param name="sender">The connection performing the action.</param>
  6547. <param name="e">A <see cref="T:System.Data.SQLite.AuthorizerEventArgs"/> that contains the
  6548. event data.</param>
  6549. </member>
  6550. <member name="T:System.Data.SQLite.SQLiteCommitHandler">
  6551. <summary>
  6552. Raised when a transaction is about to be committed. To roll back a transaction, set the
  6553. rollbackTrans boolean value to true.
  6554. </summary>
  6555. <param name="sender">The connection committing the transaction</param>
  6556. <param name="e">Event arguments on the transaction</param>
  6557. </member>
  6558. <member name="T:System.Data.SQLite.SQLiteUpdateEventHandler">
  6559. <summary>
  6560. Raised when data is inserted, updated and deleted on a given connection
  6561. </summary>
  6562. <param name="sender">The connection committing the transaction</param>
  6563. <param name="e">The event parameters which triggered the event</param>
  6564. </member>
  6565. <member name="T:System.Data.SQLite.SQLiteTraceEventHandler">
  6566. <summary>
  6567. Raised when a statement first begins executing on a given connection
  6568. </summary>
  6569. <param name="sender">The connection executing the statement</param>
  6570. <param name="e">Event arguments of the trace</param>
  6571. </member>
  6572. <member name="T:System.Data.SQLite.SQLiteBackupCallback">
  6573. <summary>
  6574. Raised between each backup step.
  6575. </summary>
  6576. <param name="source">
  6577. The source database connection.
  6578. </param>
  6579. <param name="sourceName">
  6580. The source database name.
  6581. </param>
  6582. <param name="destination">
  6583. The destination database connection.
  6584. </param>
  6585. <param name="destinationName">
  6586. The destination database name.
  6587. </param>
  6588. <param name="pages">
  6589. The number of pages copied with each step.
  6590. </param>
  6591. <param name="remainingPages">
  6592. The number of pages remaining to be copied.
  6593. </param>
  6594. <param name="totalPages">
  6595. The total number of pages in the source database.
  6596. </param>
  6597. <param name="retry">
  6598. Set to true if the operation needs to be retried due to database
  6599. locking issues; otherwise, set to false.
  6600. </param>
  6601. <returns>
  6602. True to continue with the backup process or false to halt the backup
  6603. process, rolling back any changes that have been made so far.
  6604. </returns>
  6605. </member>
  6606. <member name="T:System.Data.SQLite.ProgressEventArgs">
  6607. <summary>
  6608. The event data associated with progress reporting events.
  6609. </summary>
  6610. </member>
  6611. <member name="F:System.Data.SQLite.ProgressEventArgs.UserData">
  6612. <summary>
  6613. The user-defined native data associated with this event. Currently,
  6614. this will always contain the value of <see cref="F:System.IntPtr.Zero"/>.
  6615. </summary>
  6616. </member>
  6617. <member name="F:System.Data.SQLite.ProgressEventArgs.ReturnCode">
  6618. <summary>
  6619. The return code for the current call into the progress callback.
  6620. </summary>
  6621. </member>
  6622. <member name="M:System.Data.SQLite.ProgressEventArgs.#ctor">
  6623. <summary>
  6624. Constructs an instance of this class with default property values.
  6625. </summary>
  6626. </member>
  6627. <member name="M:System.Data.SQLite.ProgressEventArgs.#ctor(System.IntPtr,System.Data.SQLite.SQLiteProgressReturnCode)">
  6628. <summary>
  6629. Constructs an instance of this class with specific property values.
  6630. </summary>
  6631. <param name="pUserData">
  6632. The user-defined native data associated with this event.
  6633. </param>
  6634. <param name="returnCode">
  6635. The progress return code.
  6636. </param>
  6637. </member>
  6638. <member name="T:System.Data.SQLite.AuthorizerEventArgs">
  6639. <summary>
  6640. The data associated with a call into the authorizer.
  6641. </summary>
  6642. </member>
  6643. <member name="F:System.Data.SQLite.AuthorizerEventArgs.UserData">
  6644. <summary>
  6645. The user-defined native data associated with this event. Currently,
  6646. this will always contain the value of <see cref="F:System.IntPtr.Zero"/>.
  6647. </summary>
  6648. </member>
  6649. <member name="F:System.Data.SQLite.AuthorizerEventArgs.ActionCode">
  6650. <summary>
  6651. The action code responsible for the current call into the authorizer.
  6652. </summary>
  6653. </member>
  6654. <member name="F:System.Data.SQLite.AuthorizerEventArgs.Argument1">
  6655. <summary>
  6656. The first string argument for the current call into the authorizer.
  6657. The exact value will vary based on the action code, see the
  6658. <see cref="T:System.Data.SQLite.SQLiteAuthorizerActionCode"/> enumeration for possible
  6659. values.
  6660. </summary>
  6661. </member>
  6662. <member name="F:System.Data.SQLite.AuthorizerEventArgs.Argument2">
  6663. <summary>
  6664. The second string argument for the current call into the authorizer.
  6665. The exact value will vary based on the action code, see the
  6666. <see cref="T:System.Data.SQLite.SQLiteAuthorizerActionCode"/> enumeration for possible
  6667. values.
  6668. </summary>
  6669. </member>
  6670. <member name="F:System.Data.SQLite.AuthorizerEventArgs.Database">
  6671. <summary>
  6672. The database name for the current call into the authorizer, if
  6673. applicable.
  6674. </summary>
  6675. </member>
  6676. <member name="F:System.Data.SQLite.AuthorizerEventArgs.Context">
  6677. <summary>
  6678. The name of the inner-most trigger or view that is responsible for
  6679. the access attempt or a null value if this access attempt is directly
  6680. from top-level SQL code.
  6681. </summary>
  6682. </member>
  6683. <member name="F:System.Data.SQLite.AuthorizerEventArgs.ReturnCode">
  6684. <summary>
  6685. The return code for the current call into the authorizer.
  6686. </summary>
  6687. </member>
  6688. <member name="M:System.Data.SQLite.AuthorizerEventArgs.#ctor">
  6689. <summary>
  6690. Constructs an instance of this class with default property values.
  6691. </summary>
  6692. </member>
  6693. <member name="M:System.Data.SQLite.AuthorizerEventArgs.#ctor(System.IntPtr,System.Data.SQLite.SQLiteAuthorizerActionCode,System.String,System.String,System.String,System.String,System.Data.SQLite.SQLiteAuthorizerReturnCode)">
  6694. <summary>
  6695. Constructs an instance of this class with specific property values.
  6696. </summary>
  6697. <param name="pUserData">
  6698. The user-defined native data associated with this event.
  6699. </param>
  6700. <param name="actionCode">
  6701. The authorizer action code.
  6702. </param>
  6703. <param name="argument1">
  6704. The first authorizer argument.
  6705. </param>
  6706. <param name="argument2">
  6707. The second authorizer argument.
  6708. </param>
  6709. <param name="database">
  6710. The database name, if applicable.
  6711. </param>
  6712. <param name="context">
  6713. The name of the inner-most trigger or view that is responsible for
  6714. the access attempt or a null value if this access attempt is directly
  6715. from top-level SQL code.
  6716. </param>
  6717. <param name="returnCode">
  6718. The authorizer return code.
  6719. </param>
  6720. </member>
  6721. <member name="T:System.Data.SQLite.UpdateEventType">
  6722. <summary>
  6723. Whenever an update event is triggered on a connection, this enum will indicate
  6724. exactly what type of operation is being performed.
  6725. </summary>
  6726. </member>
  6727. <member name="F:System.Data.SQLite.UpdateEventType.Delete">
  6728. <summary>
  6729. A row is being deleted from the given database and table
  6730. </summary>
  6731. </member>
  6732. <member name="F:System.Data.SQLite.UpdateEventType.Insert">
  6733. <summary>
  6734. A row is being inserted into the table.
  6735. </summary>
  6736. </member>
  6737. <member name="F:System.Data.SQLite.UpdateEventType.Update">
  6738. <summary>
  6739. A row is being updated in the table.
  6740. </summary>
  6741. </member>
  6742. <member name="T:System.Data.SQLite.UpdateEventArgs">
  6743. <summary>
  6744. Passed during an Update callback, these event arguments detail the type of update operation being performed
  6745. on the given connection.
  6746. </summary>
  6747. </member>
  6748. <member name="F:System.Data.SQLite.UpdateEventArgs.Database">
  6749. <summary>
  6750. The name of the database being updated (usually "main" but can be any attached or temporary database)
  6751. </summary>
  6752. </member>
  6753. <member name="F:System.Data.SQLite.UpdateEventArgs.Table">
  6754. <summary>
  6755. The name of the table being updated
  6756. </summary>
  6757. </member>
  6758. <member name="F:System.Data.SQLite.UpdateEventArgs.Event">
  6759. <summary>
  6760. The type of update being performed (insert/update/delete)
  6761. </summary>
  6762. </member>
  6763. <member name="F:System.Data.SQLite.UpdateEventArgs.RowId">
  6764. <summary>
  6765. The RowId affected by this update.
  6766. </summary>
  6767. </member>
  6768. <member name="T:System.Data.SQLite.CommitEventArgs">
  6769. <summary>
  6770. Event arguments raised when a transaction is being committed
  6771. </summary>
  6772. </member>
  6773. <member name="F:System.Data.SQLite.CommitEventArgs.AbortTransaction">
  6774. <summary>
  6775. Set to true to abort the transaction and trigger a rollback
  6776. </summary>
  6777. </member>
  6778. <member name="T:System.Data.SQLite.TraceEventArgs">
  6779. <summary>
  6780. Passed during an Trace callback, these event arguments contain the UTF-8 rendering of the SQL statement text
  6781. </summary>
  6782. </member>
  6783. <member name="F:System.Data.SQLite.TraceEventArgs.Statement">
  6784. <summary>
  6785. SQL statement text as the statement first begins executing
  6786. </summary>
  6787. </member>
  6788. <member name="T:System.Data.SQLite.ISQLiteConnectionPool">
  6789. <summary>
  6790. This interface represents a custom connection pool implementation
  6791. usable by System.Data.SQLite.
  6792. </summary>
  6793. </member>
  6794. <member name="M:System.Data.SQLite.ISQLiteConnectionPool.GetCounts(System.String,System.Collections.Generic.Dictionary{System.String,System.Int32}@,System.Int32@,System.Int32@,System.Int32@)">
  6795. <summary>
  6796. Counts the number of pool entries matching the specified file name.
  6797. </summary>
  6798. <param name="fileName">
  6799. The file name to match or null to match all files.
  6800. </param>
  6801. <param name="counts">
  6802. The pool entry counts for each matching file.
  6803. </param>
  6804. <param name="openCount">
  6805. The total number of connections successfully opened from any pool.
  6806. </param>
  6807. <param name="closeCount">
  6808. The total number of connections successfully closed from any pool.
  6809. </param>
  6810. <param name="totalCount">
  6811. The total number of pool entries for all matching files.
  6812. </param>
  6813. </member>
  6814. <member name="M:System.Data.SQLite.ISQLiteConnectionPool.ClearPool(System.String)">
  6815. <summary>
  6816. Disposes of all pooled connections associated with the specified
  6817. database file name.
  6818. </summary>
  6819. <param name="fileName">
  6820. The database file name.
  6821. </param>
  6822. </member>
  6823. <member name="M:System.Data.SQLite.ISQLiteConnectionPool.ClearAllPools">
  6824. <summary>
  6825. Disposes of all pooled connections.
  6826. </summary>
  6827. </member>
  6828. <member name="M:System.Data.SQLite.ISQLiteConnectionPool.Add(System.String,System.Object,System.Int32)">
  6829. <summary>
  6830. Adds a connection to the pool of those associated with the
  6831. specified database file name.
  6832. </summary>
  6833. <param name="fileName">
  6834. The database file name.
  6835. </param>
  6836. <param name="handle">
  6837. The database connection handle.
  6838. </param>
  6839. <param name="version">
  6840. The connection pool version at the point the database connection
  6841. handle was received from the connection pool. This is also the
  6842. connection pool version that the database connection handle was
  6843. created under.
  6844. </param>
  6845. </member>
  6846. <member name="M:System.Data.SQLite.ISQLiteConnectionPool.Remove(System.String,System.Int32,System.Int32@)">
  6847. <summary>
  6848. Removes a connection from the pool of those associated with the
  6849. specified database file name with the intent of using it to
  6850. interact with the database.
  6851. </summary>
  6852. <param name="fileName">
  6853. The database file name.
  6854. </param>
  6855. <param name="maxPoolSize">
  6856. The new maximum size of the connection pool for the specified
  6857. database file name.
  6858. </param>
  6859. <param name="version">
  6860. The connection pool version associated with the returned database
  6861. connection handle, if any.
  6862. </param>
  6863. <returns>
  6864. The database connection handle associated with the specified
  6865. database file name or null if it cannot be obtained.
  6866. </returns>
  6867. </member>
  6868. <member name="T:System.Data.SQLite.SQLiteConnectionPool">
  6869. <summary>
  6870. This default method implementations in this class should not be used by
  6871. applications that make use of COM (either directly or indirectly) due
  6872. to possible deadlocks that can occur during finalization of some COM
  6873. objects.
  6874. </summary>
  6875. </member>
  6876. <member name="F:System.Data.SQLite.SQLiteConnectionPool._syncRoot">
  6877. <summary>
  6878. This field is used to synchronize access to the private static data
  6879. in this class.
  6880. </summary>
  6881. </member>
  6882. <member name="F:System.Data.SQLite.SQLiteConnectionPool._connectionPool">
  6883. <summary>
  6884. When this field is non-null, it will be used to provide the
  6885. implementation of all the connection pool methods; otherwise,
  6886. the default method implementations will be used.
  6887. </summary>
  6888. </member>
  6889. <member name="F:System.Data.SQLite.SQLiteConnectionPool._queueList">
  6890. <summary>
  6891. The dictionary of connection pools, based on the normalized file
  6892. name of the SQLite database.
  6893. </summary>
  6894. </member>
  6895. <member name="F:System.Data.SQLite.SQLiteConnectionPool._poolVersion">
  6896. <summary>
  6897. The default version number new pools will get.
  6898. </summary>
  6899. </member>
  6900. <member name="F:System.Data.SQLite.SQLiteConnectionPool._poolOpened">
  6901. <summary>
  6902. The number of connections successfully opened from any pool.
  6903. This value is incremented by the Remove method.
  6904. </summary>
  6905. </member>
  6906. <member name="F:System.Data.SQLite.SQLiteConnectionPool._poolClosed">
  6907. <summary>
  6908. The number of connections successfully closed from any pool.
  6909. This value is incremented by the Add method.
  6910. </summary>
  6911. </member>
  6912. <member name="M:System.Data.SQLite.SQLiteConnectionPool.GetCounts(System.String,System.Collections.Generic.Dictionary{System.String,System.Int32}@,System.Int32@,System.Int32@,System.Int32@)">
  6913. <summary>
  6914. Counts the number of pool entries matching the specified file name.
  6915. </summary>
  6916. <param name="fileName">
  6917. The file name to match or null to match all files.
  6918. </param>
  6919. <param name="counts">
  6920. The pool entry counts for each matching file.
  6921. </param>
  6922. <param name="openCount">
  6923. The total number of connections successfully opened from any pool.
  6924. </param>
  6925. <param name="closeCount">
  6926. The total number of connections successfully closed from any pool.
  6927. </param>
  6928. <param name="totalCount">
  6929. The total number of pool entries for all matching files.
  6930. </param>
  6931. </member>
  6932. <member name="M:System.Data.SQLite.SQLiteConnectionPool.ClearPool(System.String)">
  6933. <summary>
  6934. Disposes of all pooled connections associated with the specified
  6935. database file name.
  6936. </summary>
  6937. <param name="fileName">
  6938. The database file name.
  6939. </param>
  6940. </member>
  6941. <member name="M:System.Data.SQLite.SQLiteConnectionPool.ClearAllPools">
  6942. <summary>
  6943. Disposes of all pooled connections.
  6944. </summary>
  6945. </member>
  6946. <member name="M:System.Data.SQLite.SQLiteConnectionPool.Add(System.String,System.Data.SQLite.SQLiteConnectionHandle,System.Int32)">
  6947. <summary>
  6948. Adds a connection to the pool of those associated with the
  6949. specified database file name.
  6950. </summary>
  6951. <param name="fileName">
  6952. The database file name.
  6953. </param>
  6954. <param name="handle">
  6955. The database connection handle.
  6956. </param>
  6957. <param name="version">
  6958. The connection pool version at the point the database connection
  6959. handle was received from the connection pool. This is also the
  6960. connection pool version that the database connection handle was
  6961. created under.
  6962. </param>
  6963. </member>
  6964. <member name="M:System.Data.SQLite.SQLiteConnectionPool.Remove(System.String,System.Int32,System.Int32@)">
  6965. <summary>
  6966. Removes a connection from the pool of those associated with the
  6967. specified database file name with the intent of using it to
  6968. interact with the database.
  6969. </summary>
  6970. <param name="fileName">
  6971. The database file name.
  6972. </param>
  6973. <param name="maxPoolSize">
  6974. The new maximum size of the connection pool for the specified
  6975. database file name.
  6976. </param>
  6977. <param name="version">
  6978. The connection pool version associated with the returned database
  6979. connection handle, if any.
  6980. </param>
  6981. <returns>
  6982. The database connection handle associated with the specified
  6983. database file name or null if it cannot be obtained.
  6984. </returns>
  6985. </member>
  6986. <member name="M:System.Data.SQLite.SQLiteConnectionPool.GetConnectionPool">
  6987. <summary>
  6988. This method is used to obtain a reference to the custom connection
  6989. pool implementation currently in use, if any.
  6990. </summary>
  6991. <returns>
  6992. The custom connection pool implementation or null if the default
  6993. connection pool implementation should be used.
  6994. </returns>
  6995. </member>
  6996. <member name="M:System.Data.SQLite.SQLiteConnectionPool.SetConnectionPool(System.Data.SQLite.ISQLiteConnectionPool)">
  6997. <summary>
  6998. This method is used to set the reference to the custom connection
  6999. pool implementation to use, if any.
  7000. </summary>
  7001. <param name="connectionPool">
  7002. The custom connection pool implementation to use or null if the
  7003. default connection pool implementation should be used.
  7004. </param>
  7005. </member>
  7006. <member name="M:System.Data.SQLite.SQLiteConnectionPool.ResizePool(System.Data.SQLite.SQLiteConnectionPool.PoolQueue,System.Boolean)">
  7007. <summary>
  7008. We do not have to thread-lock anything in this function, because it
  7009. is only called by other functions above which already take the lock.
  7010. </summary>
  7011. <param name="queue">
  7012. The pool queue to resize.
  7013. </param>
  7014. <param name="add">
  7015. If a function intends to add to the pool, this is true, which
  7016. forces the resize to take one more than it needs from the pool.
  7017. </param>
  7018. </member>
  7019. <member name="T:System.Data.SQLite.SQLiteConnectionPool.PoolQueue">
  7020. <summary>
  7021. Keeps track of connections made on a specified file. The PoolVersion
  7022. dictates whether old objects get returned to the pool or discarded
  7023. when no longer in use.
  7024. </summary>
  7025. </member>
  7026. <member name="F:System.Data.SQLite.SQLiteConnectionPool.PoolQueue.Queue">
  7027. <summary>
  7028. The queue of weak references to the actual database connection
  7029. handles.
  7030. </summary>
  7031. </member>
  7032. <member name="F:System.Data.SQLite.SQLiteConnectionPool.PoolQueue.PoolVersion">
  7033. <summary>
  7034. This pool version associated with the database connection
  7035. handles in this pool queue.
  7036. </summary>
  7037. </member>
  7038. <member name="F:System.Data.SQLite.SQLiteConnectionPool.PoolQueue.MaxPoolSize">
  7039. <summary>
  7040. The maximum size of this pool queue.
  7041. </summary>
  7042. </member>
  7043. <member name="M:System.Data.SQLite.SQLiteConnectionPool.PoolQueue.#ctor(System.Int32,System.Int32)">
  7044. <summary>
  7045. Constructs a connection pool queue using the specified version
  7046. and maximum size. Normally, all the database connection
  7047. handles in this pool are associated with a single database file
  7048. name.
  7049. </summary>
  7050. <param name="version">
  7051. The initial pool version for this connection pool queue.
  7052. </param>
  7053. <param name="maxSize">
  7054. The initial maximum size for this connection pool queue.
  7055. </param>
  7056. </member>
  7057. <member name="T:System.Data.SQLite.SQLiteConnectionStringBuilder">
  7058. <summary>
  7059. SQLite implementation of DbConnectionStringBuilder.
  7060. </summary>
  7061. </member>
  7062. <member name="F:System.Data.SQLite.SQLiteConnectionStringBuilder._properties">
  7063. <summary>
  7064. Properties of this class
  7065. </summary>
  7066. </member>
  7067. <member name="M:System.Data.SQLite.SQLiteConnectionStringBuilder.#ctor">
  7068. <overloads>
  7069. Constructs a new instance of the class
  7070. </overloads>
  7071. <summary>
  7072. Default constructor
  7073. </summary>
  7074. </member>
  7075. <member name="M:System.Data.SQLite.SQLiteConnectionStringBuilder.#ctor(System.String)">
  7076. <summary>
  7077. Constructs a new instance of the class using the specified connection string.
  7078. </summary>
  7079. <param name="connectionString">The connection string to parse</param>
  7080. </member>
  7081. <member name="M:System.Data.SQLite.SQLiteConnectionStringBuilder.Initialize(System.String)">
  7082. <summary>
  7083. Private initializer, which assigns the connection string and resets the builder
  7084. </summary>
  7085. <param name="cnnString">The connection string to assign</param>
  7086. </member>
  7087. <member name="M:System.Data.SQLite.SQLiteConnectionStringBuilder.TryGetValue(System.String,System.Object@)">
  7088. <summary>
  7089. Helper function for retrieving values from the connectionstring
  7090. </summary>
  7091. <param name="keyword">The keyword to retrieve settings for</param>
  7092. <param name="value">The resulting parameter value</param>
  7093. <returns>Returns true if the value was found and returned</returns>
  7094. </member>
  7095. <member name="M:System.Data.SQLite.SQLiteConnectionStringBuilder.FallbackGetProperties(System.Collections.Hashtable)">
  7096. <summary>
  7097. Fallback method for MONO, which doesn't implement DbConnectionStringBuilder.GetProperties()
  7098. </summary>
  7099. <param name="propertyList">The hashtable to fill with property descriptors</param>
  7100. </member>
  7101. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.Version">
  7102. <summary>
  7103. Gets/Sets the default version of the SQLite engine to instantiate. Currently the only valid value is 3, indicating version 3 of the sqlite library.
  7104. </summary>
  7105. </member>
  7106. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.SyncMode">
  7107. <summary>
  7108. Gets/Sets the synchronization mode (file flushing) of the connection string. Default is "Normal".
  7109. </summary>
  7110. </member>
  7111. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.UseUTF16Encoding">
  7112. <summary>
  7113. Gets/Sets the encoding for the connection string. The default is "False" which indicates UTF-8 encoding.
  7114. </summary>
  7115. </member>
  7116. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.Pooling">
  7117. <summary>
  7118. Gets/Sets whether or not to use connection pooling. The default is "False"
  7119. </summary>
  7120. </member>
  7121. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.BinaryGUID">
  7122. <summary>
  7123. Gets/Sets whethor not to store GUID's in binary format. The default is True
  7124. which saves space in the database.
  7125. </summary>
  7126. </member>
  7127. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.DataSource">
  7128. <summary>
  7129. Gets/Sets the filename to open on the connection string.
  7130. </summary>
  7131. </member>
  7132. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.Uri">
  7133. <summary>
  7134. An alternate to the data source property
  7135. </summary>
  7136. </member>
  7137. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.FullUri">
  7138. <summary>
  7139. An alternate to the data source property that uses the SQLite URI syntax.
  7140. </summary>
  7141. </member>
  7142. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.DefaultTimeout">
  7143. <summary>
  7144. Gets/sets the default command timeout for newly-created commands. This is especially useful for
  7145. commands used internally such as inside a SQLiteTransaction, where setting the timeout is not possible.
  7146. </summary>
  7147. </member>
  7148. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.BusyTimeout">
  7149. <summary>
  7150. Gets/sets the busy timeout to use with the SQLite core library.
  7151. </summary>
  7152. </member>
  7153. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.WaitTimeout">
  7154. <summary>
  7155. <b>EXPERIMENTAL</b> --
  7156. The wait timeout to use with
  7157. <see cref="M:System.Data.SQLite.SQLiteConnection.WaitForEnlistmentReset(System.Int32,System.Nullable{System.Boolean})"/> method.
  7158. This is only used when waiting for the enlistment to be reset
  7159. prior to enlisting in a transaction, and then only when the
  7160. appropriate connection flag is set.
  7161. </summary>
  7162. </member>
  7163. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.PrepareRetries">
  7164. <summary>
  7165. Gets/sets the maximum number of retries when preparing SQL to be executed.
  7166. This normally only applies to preparation errors resulting from the database
  7167. schema being changed.
  7168. </summary>
  7169. </member>
  7170. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.ProgressOps">
  7171. <summary>
  7172. Gets/sets the approximate number of virtual machine instructions between
  7173. progress events. In order for progress events to actually fire, the event
  7174. handler must be added to the <see cref="E:System.Data.SQLite.SQLiteConnection.Progress"/> event
  7175. as well.
  7176. </summary>
  7177. </member>
  7178. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.Enlist">
  7179. <summary>
  7180. Determines whether or not the connection will automatically participate
  7181. in the current distributed transaction (if one exists)
  7182. </summary>
  7183. </member>
  7184. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.FailIfMissing">
  7185. <summary>
  7186. If set to true, will throw an exception if the database specified in the connection
  7187. string does not exist. If false, the database will be created automatically.
  7188. </summary>
  7189. </member>
  7190. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.LegacyFormat">
  7191. <summary>
  7192. If enabled, uses the legacy 3.xx format for maximum compatibility, but results in larger
  7193. database sizes.
  7194. </summary>
  7195. </member>
  7196. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.ReadOnly">
  7197. <summary>
  7198. When enabled, the database will be opened for read-only access and writing will be disabled.
  7199. </summary>
  7200. </member>
  7201. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.Password">
  7202. <summary>
  7203. Gets/sets the database encryption password
  7204. </summary>
  7205. </member>
  7206. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.HexPassword">
  7207. <summary>
  7208. Gets/sets the database encryption hexadecimal password
  7209. </summary>
  7210. </member>
  7211. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.TextPassword">
  7212. <summary>
  7213. Gets/sets the database encryption textual password
  7214. </summary>
  7215. </member>
  7216. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.PageSize">
  7217. <summary>
  7218. Gets/Sets the page size for the connection.
  7219. </summary>
  7220. </member>
  7221. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.MaxPageCount">
  7222. <summary>
  7223. Gets/Sets the maximum number of pages the database may hold
  7224. </summary>
  7225. </member>
  7226. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.CacheSize">
  7227. <summary>
  7228. Gets/Sets the cache size for the connection.
  7229. </summary>
  7230. </member>
  7231. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.DateTimeFormat">
  7232. <summary>
  7233. Gets/Sets the DateTime format for the connection.
  7234. </summary>
  7235. </member>
  7236. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.DateTimeKind">
  7237. <summary>
  7238. Gets/Sets the DateTime kind for the connection.
  7239. </summary>
  7240. </member>
  7241. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.DateTimeFormatString">
  7242. <summary>
  7243. Gets/sets the DateTime format string used for formatting
  7244. and parsing purposes.
  7245. </summary>
  7246. </member>
  7247. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.BaseSchemaName">
  7248. <summary>
  7249. Gets/Sets the placeholder base schema name used for
  7250. .NET Framework compatibility purposes.
  7251. </summary>
  7252. </member>
  7253. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.JournalMode">
  7254. <summary>
  7255. Determines how SQLite handles the transaction journal file.
  7256. </summary>
  7257. </member>
  7258. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.DefaultIsolationLevel">
  7259. <summary>
  7260. Sets the default isolation level for transactions on the connection.
  7261. </summary>
  7262. </member>
  7263. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.DefaultDbType">
  7264. <summary>
  7265. Gets/sets the default database type for the connection.
  7266. </summary>
  7267. </member>
  7268. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.DefaultTypeName">
  7269. <summary>
  7270. Gets/sets the default type name for the connection.
  7271. </summary>
  7272. </member>
  7273. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.VfsName">
  7274. <summary>
  7275. Gets/sets the VFS name for the connection.
  7276. </summary>
  7277. </member>
  7278. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.ForeignKeys">
  7279. <summary>
  7280. If enabled, use foreign key constraints
  7281. </summary>
  7282. </member>
  7283. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.RecursiveTriggers">
  7284. <summary>
  7285. Enable or disable the recursive trigger capability.
  7286. </summary>
  7287. </member>
  7288. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.ZipVfsVersion">
  7289. <summary>
  7290. If non-null, this is the version of ZipVFS to use. This requires the
  7291. System.Data.SQLite interop assembly -AND- primary managed assembly to
  7292. be compiled with the INTEROP_INCLUDE_ZIPVFS option; otherwise, this
  7293. property does nothing.
  7294. </summary>
  7295. </member>
  7296. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.Flags">
  7297. <summary>
  7298. Gets/Sets the extra behavioral flags.
  7299. </summary>
  7300. </member>
  7301. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.SetDefaults">
  7302. <summary>
  7303. If enabled, apply the default connection settings to opened databases.
  7304. </summary>
  7305. </member>
  7306. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.ToFullPath">
  7307. <summary>
  7308. If enabled, attempt to resolve the provided data source file name to a
  7309. full path before opening.
  7310. </summary>
  7311. </member>
  7312. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.NoDefaultFlags">
  7313. <summary>
  7314. If enabled, skip using the configured default connection flags.
  7315. </summary>
  7316. </member>
  7317. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.NoSharedFlags">
  7318. <summary>
  7319. If enabled, skip using the configured shared connection flags.
  7320. </summary>
  7321. </member>
  7322. <member name="T:System.Data.SQLite.TypeAffinity">
  7323. <summary>
  7324. SQLite has very limited types, and is inherently text-based. The first 5 types below represent the sum of all types SQLite
  7325. understands. The DateTime extension to the spec is for internal use only.
  7326. </summary>
  7327. </member>
  7328. <member name="F:System.Data.SQLite.TypeAffinity.Uninitialized">
  7329. <summary>
  7330. Not used
  7331. </summary>
  7332. </member>
  7333. <member name="F:System.Data.SQLite.TypeAffinity.Int64">
  7334. <summary>
  7335. All integers in SQLite default to Int64
  7336. </summary>
  7337. </member>
  7338. <member name="F:System.Data.SQLite.TypeAffinity.Double">
  7339. <summary>
  7340. All floating point numbers in SQLite default to double
  7341. </summary>
  7342. </member>
  7343. <member name="F:System.Data.SQLite.TypeAffinity.Text">
  7344. <summary>
  7345. The default data type of SQLite is text
  7346. </summary>
  7347. </member>
  7348. <member name="F:System.Data.SQLite.TypeAffinity.Blob">
  7349. <summary>
  7350. Typically blob types are only seen when returned from a function
  7351. </summary>
  7352. </member>
  7353. <member name="F:System.Data.SQLite.TypeAffinity.Null">
  7354. <summary>
  7355. Null types can be returned from functions
  7356. </summary>
  7357. </member>
  7358. <member name="F:System.Data.SQLite.TypeAffinity.DateTime">
  7359. <summary>
  7360. Used internally by this provider
  7361. </summary>
  7362. </member>
  7363. <member name="F:System.Data.SQLite.TypeAffinity.None">
  7364. <summary>
  7365. Used internally by this provider
  7366. </summary>
  7367. </member>
  7368. <member name="T:System.Data.SQLite.SQLiteConnectionEventType">
  7369. <summary>
  7370. These are the event types associated with the
  7371. <see cref="T:System.Data.SQLite.SQLiteConnectionEventHandler"/>
  7372. delegate (and its corresponding event) and the
  7373. <see cref="T:System.Data.SQLite.ConnectionEventArgs"/> class.
  7374. </summary>
  7375. </member>
  7376. <member name="F:System.Data.SQLite.SQLiteConnectionEventType.Invalid">
  7377. <summary>
  7378. Not used.
  7379. </summary>
  7380. </member>
  7381. <member name="F:System.Data.SQLite.SQLiteConnectionEventType.Unknown">
  7382. <summary>
  7383. Not used.
  7384. </summary>
  7385. </member>
  7386. <member name="F:System.Data.SQLite.SQLiteConnectionEventType.Opening">
  7387. <summary>
  7388. The connection is being opened.
  7389. </summary>
  7390. </member>
  7391. <member name="F:System.Data.SQLite.SQLiteConnectionEventType.ConnectionString">
  7392. <summary>
  7393. The connection string has been parsed.
  7394. </summary>
  7395. </member>
  7396. <member name="F:System.Data.SQLite.SQLiteConnectionEventType.Opened">
  7397. <summary>
  7398. The connection was opened.
  7399. </summary>
  7400. </member>
  7401. <member name="F:System.Data.SQLite.SQLiteConnectionEventType.ChangeDatabase">
  7402. <summary>
  7403. The <see cref="F:System.Data.SQLite.SQLiteConnectionEventType.ChangeDatabase"/> method was called on the
  7404. connection.
  7405. </summary>
  7406. </member>
  7407. <member name="F:System.Data.SQLite.SQLiteConnectionEventType.NewTransaction">
  7408. <summary>
  7409. A transaction was created using the connection.
  7410. </summary>
  7411. </member>
  7412. <member name="F:System.Data.SQLite.SQLiteConnectionEventType.EnlistTransaction">
  7413. <summary>
  7414. The connection was enlisted into a transaction.
  7415. </summary>
  7416. </member>
  7417. <member name="F:System.Data.SQLite.SQLiteConnectionEventType.NewCommand">
  7418. <summary>
  7419. A command was created using the connection.
  7420. </summary>
  7421. </member>
  7422. <member name="F:System.Data.SQLite.SQLiteConnectionEventType.NewDataReader">
  7423. <summary>
  7424. A data reader was created using the connection.
  7425. </summary>
  7426. </member>
  7427. <member name="F:System.Data.SQLite.SQLiteConnectionEventType.NewCriticalHandle">
  7428. <summary>
  7429. An instance of a <see cref="T:System.Runtime.InteropServices.CriticalHandle"/> derived class has
  7430. been created to wrap a native resource.
  7431. </summary>
  7432. </member>
  7433. <member name="F:System.Data.SQLite.SQLiteConnectionEventType.Closing">
  7434. <summary>
  7435. The connection is being closed.
  7436. </summary>
  7437. </member>
  7438. <member name="F:System.Data.SQLite.SQLiteConnectionEventType.Closed">
  7439. <summary>
  7440. The connection was closed.
  7441. </summary>
  7442. </member>
  7443. <member name="F:System.Data.SQLite.SQLiteConnectionEventType.DisposingCommand">
  7444. <summary>
  7445. A command is being disposed.
  7446. </summary>
  7447. </member>
  7448. <member name="F:System.Data.SQLite.SQLiteConnectionEventType.DisposingDataReader">
  7449. <summary>
  7450. A data reader is being disposed.
  7451. </summary>
  7452. </member>
  7453. <member name="F:System.Data.SQLite.SQLiteConnectionEventType.ClosingDataReader">
  7454. <summary>
  7455. A data reader is being closed.
  7456. </summary>
  7457. </member>
  7458. <member name="F:System.Data.SQLite.SQLiteConnectionEventType.OpenedFromPool">
  7459. <summary>
  7460. A native resource was opened (i.e. obtained) from the pool.
  7461. </summary>
  7462. </member>
  7463. <member name="F:System.Data.SQLite.SQLiteConnectionEventType.ClosedToPool">
  7464. <summary>
  7465. A native resource was closed (i.e. released) to the pool.
  7466. </summary>
  7467. </member>
  7468. <member name="T:System.Data.SQLite.SQLiteDateFormats">
  7469. <summary>
  7470. This implementation of SQLite for ADO.NET can process date/time fields in
  7471. databases in one of six formats.
  7472. </summary>
  7473. <remarks>
  7474. ISO8601 format is more compatible, readable, fully-processable, but less
  7475. accurate as it does not provide time down to fractions of a second.
  7476. JulianDay is the numeric format the SQLite uses internally and is arguably
  7477. the most compatible with 3rd party tools. It is not readable as text
  7478. without post-processing. Ticks less compatible with 3rd party tools that
  7479. query the database, and renders the DateTime field unreadable as text
  7480. without post-processing. UnixEpoch is more compatible with Unix systems.
  7481. InvariantCulture allows the configured format for the invariant culture
  7482. format to be used and is human readable. CurrentCulture allows the
  7483. configured format for the current culture to be used and is also human
  7484. readable.
  7485. The preferred order of choosing a DateTime format is JulianDay, ISO8601,
  7486. and then Ticks. Ticks is mainly present for legacy code support.
  7487. </remarks>
  7488. </member>
  7489. <member name="F:System.Data.SQLite.SQLiteDateFormats.Ticks">
  7490. <summary>
  7491. Use the value of DateTime.Ticks. This value is not recommended and is not well supported with LINQ.
  7492. </summary>
  7493. </member>
  7494. <member name="F:System.Data.SQLite.SQLiteDateFormats.ISO8601">
  7495. <summary>
  7496. Use the ISO-8601 format. Uses the "yyyy-MM-dd HH:mm:ss.FFFFFFFK" format for UTC DateTime values and
  7497. "yyyy-MM-dd HH:mm:ss.FFFFFFF" format for local DateTime values).
  7498. </summary>
  7499. </member>
  7500. <member name="F:System.Data.SQLite.SQLiteDateFormats.JulianDay">
  7501. <summary>
  7502. The interval of time in days and fractions of a day since January 1, 4713 BC.
  7503. </summary>
  7504. </member>
  7505. <member name="F:System.Data.SQLite.SQLiteDateFormats.UnixEpoch">
  7506. <summary>
  7507. The whole number of seconds since the Unix epoch (January 1, 1970).
  7508. </summary>
  7509. </member>
  7510. <member name="F:System.Data.SQLite.SQLiteDateFormats.InvariantCulture">
  7511. <summary>
  7512. Any culture-independent string value that the .NET Framework can interpret as a valid DateTime.
  7513. </summary>
  7514. </member>
  7515. <member name="F:System.Data.SQLite.SQLiteDateFormats.CurrentCulture">
  7516. <summary>
  7517. Any string value that the .NET Framework can interpret as a valid DateTime using the current culture.
  7518. </summary>
  7519. </member>
  7520. <member name="F:System.Data.SQLite.SQLiteDateFormats.Default">
  7521. <summary>
  7522. The default format for this provider.
  7523. </summary>
  7524. </member>
  7525. <member name="T:System.Data.SQLite.SQLiteJournalModeEnum">
  7526. <summary>
  7527. This enum determines how SQLite treats its journal file.
  7528. </summary>
  7529. <remarks>
  7530. By default SQLite will create and delete the journal file when needed during a transaction.
  7531. However, for some computers running certain filesystem monitoring tools, the rapid
  7532. creation and deletion of the journal file can cause those programs to fail, or to interfere with SQLite.
  7533. If a program or virus scanner is interfering with SQLite's journal file, you may receive errors like "unable to open database file"
  7534. when starting a transaction. If this is happening, you may want to change the default journal mode to Persist.
  7535. </remarks>
  7536. </member>
  7537. <member name="F:System.Data.SQLite.SQLiteJournalModeEnum.Default">
  7538. <summary>
  7539. The default mode, this causes SQLite to use the existing journaling mode for the database.
  7540. </summary>
  7541. </member>
  7542. <member name="F:System.Data.SQLite.SQLiteJournalModeEnum.Delete">
  7543. <summary>
  7544. SQLite will create and destroy the journal file as-needed.
  7545. </summary>
  7546. </member>
  7547. <member name="F:System.Data.SQLite.SQLiteJournalModeEnum.Persist">
  7548. <summary>
  7549. When this is set, SQLite will keep the journal file even after a transaction has completed. It's contents will be erased,
  7550. and the journal re-used as often as needed. If it is deleted, it will be recreated the next time it is needed.
  7551. </summary>
  7552. </member>
  7553. <member name="F:System.Data.SQLite.SQLiteJournalModeEnum.Off">
  7554. <summary>
  7555. This option disables the rollback journal entirely. Interrupted transactions or a program crash can cause database
  7556. corruption in this mode!
  7557. </summary>
  7558. </member>
  7559. <member name="F:System.Data.SQLite.SQLiteJournalModeEnum.Truncate">
  7560. <summary>
  7561. SQLite will truncate the journal file to zero-length instead of deleting it.
  7562. </summary>
  7563. </member>
  7564. <member name="F:System.Data.SQLite.SQLiteJournalModeEnum.Memory">
  7565. <summary>
  7566. SQLite will store the journal in volatile RAM. This saves disk I/O but at the expense of database safety and integrity.
  7567. If the application using SQLite crashes in the middle of a transaction when the MEMORY journaling mode is set, then the
  7568. database file will very likely go corrupt.
  7569. </summary>
  7570. </member>
  7571. <member name="F:System.Data.SQLite.SQLiteJournalModeEnum.Wal">
  7572. <summary>
  7573. SQLite uses a write-ahead log instead of a rollback journal to implement transactions. The WAL journaling mode is persistent;
  7574. after being set it stays in effect across multiple database connections and after closing and reopening the database. A database
  7575. in WAL journaling mode can only be accessed by SQLite version 3.7.0 or later.
  7576. </summary>
  7577. </member>
  7578. <member name="T:System.Data.SQLite.SQLiteSynchronousEnum">
  7579. <summary>
  7580. Possible values for the "synchronous" database setting. This setting determines
  7581. how often the database engine calls the xSync method of the VFS.
  7582. </summary>
  7583. </member>
  7584. <member name="F:System.Data.SQLite.SQLiteSynchronousEnum.Default">
  7585. <summary>
  7586. Use the default "synchronous" database setting. Currently, this should be
  7587. the same as using the FULL mode.
  7588. </summary>
  7589. </member>
  7590. <member name="F:System.Data.SQLite.SQLiteSynchronousEnum.Off">
  7591. <summary>
  7592. The database engine continues without syncing as soon as it has handed
  7593. data off to the operating system. If the application running SQLite
  7594. crashes, the data will be safe, but the database might become corrupted
  7595. if the operating system crashes or the computer loses power before that
  7596. data has been written to the disk surface.
  7597. </summary>
  7598. </member>
  7599. <member name="F:System.Data.SQLite.SQLiteSynchronousEnum.Normal">
  7600. <summary>
  7601. The database engine will still sync at the most critical moments, but
  7602. less often than in FULL mode. There is a very small (though non-zero)
  7603. chance that a power failure at just the wrong time could corrupt the
  7604. database in NORMAL mode.
  7605. </summary>
  7606. </member>
  7607. <member name="F:System.Data.SQLite.SQLiteSynchronousEnum.Full">
  7608. <summary>
  7609. The database engine will use the xSync method of the VFS to ensure that
  7610. all content is safely written to the disk surface prior to continuing.
  7611. This ensures that an operating system crash or power failure will not
  7612. corrupt the database. FULL synchronous is very safe, but it is also
  7613. slower.
  7614. </summary>
  7615. </member>
  7616. <member name="T:System.Data.SQLite.SQLiteExecuteType">
  7617. <summary>
  7618. The requested command execution type. This controls which method of the
  7619. <see cref="T:System.Data.SQLite.SQLiteCommand"/> object will be called.
  7620. </summary>
  7621. </member>
  7622. <member name="F:System.Data.SQLite.SQLiteExecuteType.None">
  7623. <summary>
  7624. Do nothing. No method will be called.
  7625. </summary>
  7626. </member>
  7627. <member name="F:System.Data.SQLite.SQLiteExecuteType.NonQuery">
  7628. <summary>
  7629. The command is not expected to return a result -OR- the result is not
  7630. needed. The <see cref="M:System.Data.SQLite.SQLiteCommand.ExecuteNonQuery"/> or
  7631. <see cref="M:System.Data.SQLite.SQLiteCommand.ExecuteNonQuery(System.Data.CommandBehavior)"/> method
  7632. will be called.
  7633. </summary>
  7634. </member>
  7635. <member name="F:System.Data.SQLite.SQLiteExecuteType.Scalar">
  7636. <summary>
  7637. The command is expected to return a scalar result -OR- the result should
  7638. be limited to a scalar result. The <see cref="M:System.Data.SQLite.SQLiteCommand.ExecuteScalar"/>
  7639. or <see cref="M:System.Data.SQLite.SQLiteCommand.ExecuteScalar(System.Data.CommandBehavior)"/> method will
  7640. be called.
  7641. </summary>
  7642. </member>
  7643. <member name="F:System.Data.SQLite.SQLiteExecuteType.Reader">
  7644. <summary>
  7645. The command is expected to return <see cref="T:System.Data.SQLite.SQLiteDataReader"/> result.
  7646. The <see cref="M:System.Data.SQLite.SQLiteCommand.ExecuteReader"/> or
  7647. <see cref="M:System.Data.SQLite.SQLiteCommand.ExecuteReader(System.Data.CommandBehavior)"/> method will
  7648. be called.
  7649. </summary>
  7650. </member>
  7651. <member name="F:System.Data.SQLite.SQLiteExecuteType.Default">
  7652. <summary>
  7653. Use the default command execution type. Using this value is the same
  7654. as using the <see cref="F:System.Data.SQLite.SQLiteExecuteType.NonQuery"/> value.
  7655. </summary>
  7656. </member>
  7657. <member name="T:System.Data.SQLite.SQLiteAuthorizerActionCode">
  7658. <summary>
  7659. The action code responsible for the current call into the authorizer.
  7660. </summary>
  7661. </member>
  7662. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.None">
  7663. <summary>
  7664. No action is being performed. This value should not be used from
  7665. external code.
  7666. </summary>
  7667. </member>
  7668. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Copy">
  7669. <summary>
  7670. No longer used.
  7671. </summary>
  7672. </member>
  7673. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.CreateIndex">
  7674. <summary>
  7675. An index will be created. The action-specific arguments are the
  7676. index name and the table name.
  7677. </summary>
  7678. </member>
  7679. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.CreateTable">
  7680. <summary>
  7681. A table will be created. The action-specific arguments are the
  7682. table name and a null value.
  7683. </summary>
  7684. </member>
  7685. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.CreateTempIndex">
  7686. <summary>
  7687. A temporary index will be created. The action-specific arguments
  7688. are the index name and the table name.
  7689. </summary>
  7690. </member>
  7691. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.CreateTempTable">
  7692. <summary>
  7693. A temporary table will be created. The action-specific arguments
  7694. are the table name and a null value.
  7695. </summary>
  7696. </member>
  7697. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.CreateTempTrigger">
  7698. <summary>
  7699. A temporary trigger will be created. The action-specific arguments
  7700. are the trigger name and the table name.
  7701. </summary>
  7702. </member>
  7703. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.CreateTempView">
  7704. <summary>
  7705. A temporary view will be created. The action-specific arguments are
  7706. the view name and a null value.
  7707. </summary>
  7708. </member>
  7709. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.CreateTrigger">
  7710. <summary>
  7711. A trigger will be created. The action-specific arguments are the
  7712. trigger name and the table name.
  7713. </summary>
  7714. </member>
  7715. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.CreateView">
  7716. <summary>
  7717. A view will be created. The action-specific arguments are the view
  7718. name and a null value.
  7719. </summary>
  7720. </member>
  7721. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Delete">
  7722. <summary>
  7723. A DELETE statement will be executed. The action-specific arguments
  7724. are the table name and a null value.
  7725. </summary>
  7726. </member>
  7727. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.DropIndex">
  7728. <summary>
  7729. An index will be dropped. The action-specific arguments are the
  7730. index name and the table name.
  7731. </summary>
  7732. </member>
  7733. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.DropTable">
  7734. <summary>
  7735. A table will be dropped. The action-specific arguments are the tables
  7736. name and a null value.
  7737. </summary>
  7738. </member>
  7739. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.DropTempIndex">
  7740. <summary>
  7741. A temporary index will be dropped. The action-specific arguments are
  7742. the index name and the table name.
  7743. </summary>
  7744. </member>
  7745. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.DropTempTable">
  7746. <summary>
  7747. A temporary table will be dropped. The action-specific arguments are
  7748. the table name and a null value.
  7749. </summary>
  7750. </member>
  7751. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.DropTempTrigger">
  7752. <summary>
  7753. A temporary trigger will be dropped. The action-specific arguments
  7754. are the trigger name and the table name.
  7755. </summary>
  7756. </member>
  7757. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.DropTempView">
  7758. <summary>
  7759. A temporary view will be dropped. The action-specific arguments are
  7760. the view name and a null value.
  7761. </summary>
  7762. </member>
  7763. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.DropTrigger">
  7764. <summary>
  7765. A trigger will be dropped. The action-specific arguments are the
  7766. trigger name and the table name.
  7767. </summary>
  7768. </member>
  7769. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.DropView">
  7770. <summary>
  7771. A view will be dropped. The action-specific arguments are the view
  7772. name and a null value.
  7773. </summary>
  7774. </member>
  7775. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Insert">
  7776. <summary>
  7777. An INSERT statement will be executed. The action-specific arguments
  7778. are the table name and a null value.
  7779. </summary>
  7780. </member>
  7781. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Pragma">
  7782. <summary>
  7783. A PRAGMA statement will be executed. The action-specific arguments
  7784. are the name of the PRAGMA and the new value or a null value.
  7785. </summary>
  7786. </member>
  7787. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Read">
  7788. <summary>
  7789. A table column will be read. The action-specific arguments are the
  7790. table name and the column name.
  7791. </summary>
  7792. </member>
  7793. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Select">
  7794. <summary>
  7795. A SELECT statement will be executed. The action-specific arguments
  7796. are both null values.
  7797. </summary>
  7798. </member>
  7799. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Transaction">
  7800. <summary>
  7801. A transaction will be started, committed, or rolled back. The
  7802. action-specific arguments are the name of the operation (BEGIN,
  7803. COMMIT, or ROLLBACK) and a null value.
  7804. </summary>
  7805. </member>
  7806. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Update">
  7807. <summary>
  7808. An UPDATE statement will be executed. The action-specific arguments
  7809. are the table name and the column name.
  7810. </summary>
  7811. </member>
  7812. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Attach">
  7813. <summary>
  7814. A database will be attached to the connection. The action-specific
  7815. arguments are the database file name and a null value.
  7816. </summary>
  7817. </member>
  7818. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Detach">
  7819. <summary>
  7820. A database will be detached from the connection. The action-specific
  7821. arguments are the database name and a null value.
  7822. </summary>
  7823. </member>
  7824. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.AlterTable">
  7825. <summary>
  7826. The schema of a table will be altered. The action-specific arguments
  7827. are the database name and the table name.
  7828. </summary>
  7829. </member>
  7830. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Reindex">
  7831. <summary>
  7832. An index will be deleted and then recreated. The action-specific
  7833. arguments are the index name and a null value.
  7834. </summary>
  7835. </member>
  7836. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Analyze">
  7837. <summary>
  7838. A table will be analyzed to gathers statistics about it. The
  7839. action-specific arguments are the table name and a null value.
  7840. </summary>
  7841. </member>
  7842. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.CreateVtable">
  7843. <summary>
  7844. A virtual table will be created. The action-specific arguments are
  7845. the table name and the module name.
  7846. </summary>
  7847. </member>
  7848. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.DropVtable">
  7849. <summary>
  7850. A virtual table will be dropped. The action-specific arguments are
  7851. the table name and the module name.
  7852. </summary>
  7853. </member>
  7854. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Function">
  7855. <summary>
  7856. A SQL function will be called. The action-specific arguments are a
  7857. null value and the function name.
  7858. </summary>
  7859. </member>
  7860. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Savepoint">
  7861. <summary>
  7862. A savepoint will be created, released, or rolled back. The
  7863. action-specific arguments are the name of the operation (BEGIN,
  7864. RELEASE, or ROLLBACK) and the savepoint name.
  7865. </summary>
  7866. </member>
  7867. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Recursive">
  7868. <summary>
  7869. A recursive query will be executed. The action-specific arguments
  7870. are two null values.
  7871. </summary>
  7872. </member>
  7873. <member name="T:System.Data.SQLite.SQLiteProgressReturnCode">
  7874. <summary>
  7875. The possible return codes for the progress callback.
  7876. </summary>
  7877. </member>
  7878. <member name="F:System.Data.SQLite.SQLiteProgressReturnCode.Continue">
  7879. <summary>
  7880. The operation should continue.
  7881. </summary>
  7882. </member>
  7883. <member name="F:System.Data.SQLite.SQLiteProgressReturnCode.Interrupt">
  7884. <summary>
  7885. The operation should be interrupted.
  7886. </summary>
  7887. </member>
  7888. <member name="T:System.Data.SQLite.SQLiteAuthorizerReturnCode">
  7889. <summary>
  7890. The return code for the current call into the authorizer.
  7891. </summary>
  7892. </member>
  7893. <member name="F:System.Data.SQLite.SQLiteAuthorizerReturnCode.Ok">
  7894. <summary>
  7895. The action will be allowed.
  7896. </summary>
  7897. </member>
  7898. <member name="F:System.Data.SQLite.SQLiteAuthorizerReturnCode.Deny">
  7899. <summary>
  7900. The overall action will be disallowed and an error message will be
  7901. returned from the query preparation method.
  7902. </summary>
  7903. </member>
  7904. <member name="F:System.Data.SQLite.SQLiteAuthorizerReturnCode.Ignore">
  7905. <summary>
  7906. The specific action will be disallowed; however, the overall action
  7907. will continue. The exact effects of this return code vary depending
  7908. on the specific action, please refer to the SQLite core library
  7909. documentation for futher details.
  7910. </summary>
  7911. </member>
  7912. <member name="T:System.Data.SQLite.SQLiteType">
  7913. <summary>
  7914. Class used internally to determine the datatype of a column in a resultset
  7915. </summary>
  7916. </member>
  7917. <member name="F:System.Data.SQLite.SQLiteType.Type">
  7918. <summary>
  7919. The DbType of the column, or DbType.Object if it cannot be determined
  7920. </summary>
  7921. </member>
  7922. <member name="F:System.Data.SQLite.SQLiteType.Affinity">
  7923. <summary>
  7924. The affinity of a column, used for expressions or when Type is DbType.Object
  7925. </summary>
  7926. </member>
  7927. <member name="M:System.Data.SQLite.SQLiteType.#ctor">
  7928. <summary>
  7929. Constructs a default instance of this type.
  7930. </summary>
  7931. </member>
  7932. <member name="M:System.Data.SQLite.SQLiteType.#ctor(System.Data.SQLite.TypeAffinity,System.Data.DbType)">
  7933. <summary>
  7934. Constructs an instance of this type with the specified field values.
  7935. </summary>
  7936. <param name="affinity">
  7937. The type affinity to use for the new instance.
  7938. </param>
  7939. <param name="type">
  7940. The database type to use for the new instance.
  7941. </param>
  7942. </member>
  7943. <member name="T:System.Data.SQLite.SQLiteDataAdapter">
  7944. <summary>
  7945. SQLite implementation of DbDataAdapter.
  7946. </summary>
  7947. </member>
  7948. <member name="M:System.Data.SQLite.SQLiteDataAdapter.#ctor">
  7949. <overloads>
  7950. This class is just a shell around the DbDataAdapter. Nothing from
  7951. DbDataAdapter is overridden here, just a few constructors are defined.
  7952. </overloads>
  7953. <summary>
  7954. Default constructor.
  7955. </summary>
  7956. </member>
  7957. <member name="M:System.Data.SQLite.SQLiteDataAdapter.#ctor(System.Data.SQLite.SQLiteCommand)">
  7958. <summary>
  7959. Constructs a data adapter using the specified select command.
  7960. </summary>
  7961. <param name="cmd">
  7962. The select command to associate with the adapter.
  7963. </param>
  7964. </member>
  7965. <member name="M:System.Data.SQLite.SQLiteDataAdapter.#ctor(System.String,System.Data.SQLite.SQLiteConnection)">
  7966. <summary>
  7967. Constructs a data adapter with the supplied select command text and
  7968. associated with the specified connection.
  7969. </summary>
  7970. <param name="commandText">
  7971. The select command text to associate with the data adapter.
  7972. </param>
  7973. <param name="connection">
  7974. The connection to associate with the select command.
  7975. </param>
  7976. </member>
  7977. <member name="M:System.Data.SQLite.SQLiteDataAdapter.#ctor(System.String,System.String)">
  7978. <summary>
  7979. Constructs a data adapter with the specified select command text,
  7980. and using the specified database connection string.
  7981. </summary>
  7982. <param name="commandText">
  7983. The select command text to use to construct a select command.
  7984. </param>
  7985. <param name="connectionString">
  7986. A connection string suitable for passing to a new SQLiteConnection,
  7987. which is associated with the select command.
  7988. </param>
  7989. </member>
  7990. <member name="M:System.Data.SQLite.SQLiteDataAdapter.#ctor(System.String,System.String,System.Boolean)">
  7991. <summary>
  7992. Constructs a data adapter with the specified select command text,
  7993. and using the specified database connection string.
  7994. </summary>
  7995. <param name="commandText">
  7996. The select command text to use to construct a select command.
  7997. </param>
  7998. <param name="connectionString">
  7999. A connection string suitable for passing to a new SQLiteConnection,
  8000. which is associated with the select command.
  8001. </param>
  8002. <param name="parseViaFramework">
  8003. Non-zero to parse the connection string using the built-in (i.e.
  8004. framework provided) parser when opening the connection.
  8005. </param>
  8006. </member>
  8007. <member name="M:System.Data.SQLite.SQLiteDataAdapter.Dispose(System.Boolean)">
  8008. <summary>
  8009. Cleans up resources (native and managed) associated with the current instance.
  8010. </summary>
  8011. <param name="disposing">
  8012. Zero when being disposed via garbage collection; otherwise, non-zero.
  8013. </param>
  8014. </member>
  8015. <member name="M:System.Data.SQLite.SQLiteDataAdapter.OnRowUpdating(System.Data.Common.RowUpdatingEventArgs)">
  8016. <summary>
  8017. Raised by the underlying DbDataAdapter when a row is being updated
  8018. </summary>
  8019. <param name="value">The event's specifics</param>
  8020. </member>
  8021. <member name="M:System.Data.SQLite.SQLiteDataAdapter.OnRowUpdated(System.Data.Common.RowUpdatedEventArgs)">
  8022. <summary>
  8023. Raised by DbDataAdapter after a row is updated
  8024. </summary>
  8025. <param name="value">The event's specifics</param>
  8026. </member>
  8027. <member name="E:System.Data.SQLite.SQLiteDataAdapter.RowUpdating">
  8028. <summary>
  8029. Row updating event handler
  8030. </summary>
  8031. </member>
  8032. <member name="E:System.Data.SQLite.SQLiteDataAdapter.RowUpdated">
  8033. <summary>
  8034. Row updated event handler
  8035. </summary>
  8036. </member>
  8037. <member name="P:System.Data.SQLite.SQLiteDataAdapter.SelectCommand">
  8038. <summary>
  8039. Gets/sets the select command for this DataAdapter
  8040. </summary>
  8041. </member>
  8042. <member name="P:System.Data.SQLite.SQLiteDataAdapter.InsertCommand">
  8043. <summary>
  8044. Gets/sets the insert command for this DataAdapter
  8045. </summary>
  8046. </member>
  8047. <member name="P:System.Data.SQLite.SQLiteDataAdapter.UpdateCommand">
  8048. <summary>
  8049. Gets/sets the update command for this DataAdapter
  8050. </summary>
  8051. </member>
  8052. <member name="P:System.Data.SQLite.SQLiteDataAdapter.DeleteCommand">
  8053. <summary>
  8054. Gets/sets the delete command for this DataAdapter
  8055. </summary>
  8056. </member>
  8057. <member name="T:System.Data.SQLite.SQLiteDataReader">
  8058. <summary>
  8059. SQLite implementation of DbDataReader.
  8060. </summary>
  8061. </member>
  8062. <member name="F:System.Data.SQLite.SQLiteDataReader._command">
  8063. <summary>
  8064. Underlying command this reader is attached to
  8065. </summary>
  8066. </member>
  8067. <member name="F:System.Data.SQLite.SQLiteDataReader._flags">
  8068. <summary>
  8069. The flags pertaining to the associated connection (via the command).
  8070. </summary>
  8071. </member>
  8072. <member name="F:System.Data.SQLite.SQLiteDataReader._activeStatementIndex">
  8073. <summary>
  8074. Index of the current statement in the command being processed
  8075. </summary>
  8076. </member>
  8077. <member name="F:System.Data.SQLite.SQLiteDataReader._activeStatement">
  8078. <summary>
  8079. Current statement being Read()
  8080. </summary>
  8081. </member>
  8082. <member name="F:System.Data.SQLite.SQLiteDataReader._readingState">
  8083. <summary>
  8084. State of the current statement being processed.
  8085. -1 = First Step() executed, so the first Read() will be ignored
  8086. 0 = Actively reading
  8087. 1 = Finished reading
  8088. 2 = Non-row-returning statement, no records
  8089. </summary>
  8090. </member>
  8091. <member name="F:System.Data.SQLite.SQLiteDataReader._rowsAffected">
  8092. <summary>
  8093. Number of records affected by the insert/update statements executed on the command
  8094. </summary>
  8095. </member>
  8096. <member name="F:System.Data.SQLite.SQLiteDataReader._fieldCount">
  8097. <summary>
  8098. Count of fields (columns) in the row-returning statement currently being processed
  8099. </summary>
  8100. </member>
  8101. <member name="F:System.Data.SQLite.SQLiteDataReader._stepCount">
  8102. <summary>
  8103. The number of calls to Step() that have returned true (i.e. the number of rows that
  8104. have been read in the current result set).
  8105. </summary>
  8106. </member>
  8107. <member name="F:System.Data.SQLite.SQLiteDataReader._fieldIndexes">
  8108. <summary>
  8109. Maps the field (column) names to their corresponding indexes within the results.
  8110. </summary>
  8111. </member>
  8112. <member name="F:System.Data.SQLite.SQLiteDataReader._fieldTypeArray">
  8113. <summary>
  8114. Datatypes of active fields (columns) in the current statement, used for type-restricting data
  8115. </summary>
  8116. </member>
  8117. <member name="F:System.Data.SQLite.SQLiteDataReader._commandBehavior">
  8118. <summary>
  8119. The behavior of the datareader
  8120. </summary>
  8121. </member>
  8122. <member name="F:System.Data.SQLite.SQLiteDataReader._disposeCommand">
  8123. <summary>
  8124. If set, then dispose of the command object when the reader is finished
  8125. </summary>
  8126. </member>
  8127. <member name="F:System.Data.SQLite.SQLiteDataReader._throwOnDisposed">
  8128. <summary>
  8129. If set, then raise an exception when the object is accessed after being disposed.
  8130. </summary>
  8131. </member>
  8132. <member name="F:System.Data.SQLite.SQLiteDataReader._keyInfo">
  8133. <summary>
  8134. An array of rowid's for the active statement if CommandBehavior.KeyInfo is specified
  8135. </summary>
  8136. </member>
  8137. <member name="F:System.Data.SQLite.SQLiteDataReader._version">
  8138. <summary>
  8139. Matches the version of the connection.
  8140. </summary>
  8141. </member>
  8142. <member name="F:System.Data.SQLite.SQLiteDataReader._baseSchemaName">
  8143. <summary>
  8144. The "stub" (i.e. placeholder) base schema name to use when returning
  8145. column schema information. Matches the base schema name used by the
  8146. associated connection.
  8147. </summary>
  8148. </member>
  8149. <member name="M:System.Data.SQLite.SQLiteDataReader.#ctor(System.Data.SQLite.SQLiteCommand,System.Data.CommandBehavior)">
  8150. <summary>
  8151. Internal constructor, initializes the datareader and sets up to begin executing statements
  8152. </summary>
  8153. <param name="cmd">The SQLiteCommand this data reader is for</param>
  8154. <param name="behave">The expected behavior of the data reader</param>
  8155. </member>
  8156. <member name="M:System.Data.SQLite.SQLiteDataReader.Dispose(System.Boolean)">
  8157. <summary>
  8158. Dispose of all resources used by this datareader.
  8159. </summary>
  8160. <param name="disposing"></param>
  8161. </member>
  8162. <member name="M:System.Data.SQLite.SQLiteDataReader.Close">
  8163. <summary>
  8164. Closes the datareader, potentially closing the connection as well if CommandBehavior.CloseConnection was specified.
  8165. </summary>
  8166. </member>
  8167. <member name="M:System.Data.SQLite.SQLiteDataReader.CheckClosed">
  8168. <summary>
  8169. Throw an error if the datareader is closed
  8170. </summary>
  8171. </member>
  8172. <member name="M:System.Data.SQLite.SQLiteDataReader.CheckValidRow">
  8173. <summary>
  8174. Throw an error if a row is not loaded
  8175. </summary>
  8176. </member>
  8177. <member name="M:System.Data.SQLite.SQLiteDataReader.GetEnumerator">
  8178. <summary>
  8179. Enumerator support
  8180. </summary>
  8181. <returns>Returns a DbEnumerator object.</returns>
  8182. </member>
  8183. <member name="M:System.Data.SQLite.SQLiteDataReader.RefreshFlags">
  8184. <summary>
  8185. Forces the connection flags cached by this data reader to be refreshed
  8186. from the underlying connection.
  8187. </summary>
  8188. </member>
  8189. <member name="M:System.Data.SQLite.SQLiteDataReader.VerifyForGet">
  8190. <summary>
  8191. This method is used to make sure the result set is open and a row is currently available.
  8192. </summary>
  8193. </member>
  8194. <member name="M:System.Data.SQLite.SQLiteDataReader.VerifyType(System.Int32,System.Data.DbType)">
  8195. <summary>
  8196. SQLite is inherently un-typed. All datatypes in SQLite are natively strings. The definition of the columns of a table
  8197. and the affinity of returned types are all we have to go on to type-restrict data in the reader.
  8198. This function attempts to verify that the type of data being requested of a column matches the datatype of the column. In
  8199. the case of columns that are not backed into a table definition, we attempt to match up the affinity of a column (int, double, string or blob)
  8200. to a set of known types that closely match that affinity. It's not an exact science, but its the best we can do.
  8201. </summary>
  8202. <returns>
  8203. This function throws an InvalidTypeCast() exception if the requested type doesn't match the column's definition or affinity.
  8204. </returns>
  8205. <param name="i">The index of the column to type-check</param>
  8206. <param name="typ">The type we want to get out of the column</param>
  8207. </member>
  8208. <member name="M:System.Data.SQLite.SQLiteDataReader.InvokeReadValueCallback(System.Int32,System.Data.SQLite.SQLiteReadEventArgs,System.Boolean@)">
  8209. <summary>
  8210. Invokes the data reader value callback configured for the database
  8211. type name associated with the specified column. If no data reader
  8212. value callback is available for the database type name, do nothing.
  8213. </summary>
  8214. <param name="index">
  8215. The index of the column being read.
  8216. </param>
  8217. <param name="eventArgs">
  8218. The extra event data to pass into the callback.
  8219. </param>
  8220. <param name="complete">
  8221. Non-zero if the default handling for the data reader call should be
  8222. skipped. If this is set to non-zero and the necessary return value
  8223. is unavailable or unsuitable, an exception will be thrown.
  8224. </param>
  8225. </member>
  8226. <member name="M:System.Data.SQLite.SQLiteDataReader.GetRowId(System.Int32)">
  8227. <summary>
  8228. Attempts to query the integer identifier for the current row. This
  8229. will not work for tables that were created WITHOUT ROWID -OR- if the
  8230. query does not include the "rowid" column or one of its aliases -OR-
  8231. if the <see cref="T:System.Data.SQLite.SQLiteDataReader"/> was not created with the
  8232. <see cref="F:System.Data.CommandBehavior.KeyInfo"/> flag.
  8233. </summary>
  8234. <param name="i">
  8235. The index of the BLOB column.
  8236. </param>
  8237. <returns>
  8238. The integer identifier for the current row -OR- null if it could not
  8239. be determined.
  8240. </returns>
  8241. </member>
  8242. <member name="M:System.Data.SQLite.SQLiteDataReader.GetBlob(System.Int32,System.Boolean)">
  8243. <summary>
  8244. Retrieves the column as a <see cref="T:System.Data.SQLite.SQLiteBlob"/> object.
  8245. This will not work for tables that were created WITHOUT ROWID
  8246. -OR- if the query does not include the "rowid" column or one
  8247. of its aliases -OR- if the <see cref="T:System.Data.SQLite.SQLiteDataReader"/> was
  8248. not created with the <see cref="F:System.Data.CommandBehavior.KeyInfo"/>
  8249. flag.
  8250. </summary>
  8251. <param name="i">The index of the column.</param>
  8252. <param name="readOnly">
  8253. Non-zero to open the blob object for read-only access.
  8254. </param>
  8255. <returns>A new <see cref="T:System.Data.SQLite.SQLiteBlob"/> object.</returns>
  8256. </member>
  8257. <member name="M:System.Data.SQLite.SQLiteDataReader.GetBoolean(System.Int32)">
  8258. <summary>
  8259. Retrieves the column as a boolean value
  8260. </summary>
  8261. <param name="i">The index of the column.</param>
  8262. <returns>bool</returns>
  8263. </member>
  8264. <member name="M:System.Data.SQLite.SQLiteDataReader.GetByte(System.Int32)">
  8265. <summary>
  8266. Retrieves the column as a single byte value
  8267. </summary>
  8268. <param name="i">The index of the column.</param>
  8269. <returns>byte</returns>
  8270. </member>
  8271. <member name="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)">
  8272. <summary>
  8273. Retrieves a column as an array of bytes (blob)
  8274. </summary>
  8275. <param name="i">The index of the column.</param>
  8276. <param name="fieldOffset">The zero-based index of where to begin reading the data</param>
  8277. <param name="buffer">The buffer to write the bytes into</param>
  8278. <param name="bufferoffset">The zero-based index of where to begin writing into the array</param>
  8279. <param name="length">The number of bytes to retrieve</param>
  8280. <returns>The actual number of bytes written into the array</returns>
  8281. <remarks>
  8282. To determine the number of bytes in the column, pass a null value for the buffer. The total length will be returned.
  8283. </remarks>
  8284. </member>
  8285. <member name="M:System.Data.SQLite.SQLiteDataReader.GetChar(System.Int32)">
  8286. <summary>
  8287. Returns the column as a single character
  8288. </summary>
  8289. <param name="i">The index of the column.</param>
  8290. <returns>char</returns>
  8291. </member>
  8292. <member name="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)">
  8293. <summary>
  8294. Retrieves a column as an array of chars (blob)
  8295. </summary>
  8296. <param name="i">The index of the column.</param>
  8297. <param name="fieldoffset">The zero-based index of where to begin reading the data</param>
  8298. <param name="buffer">The buffer to write the characters into</param>
  8299. <param name="bufferoffset">The zero-based index of where to begin writing into the array</param>
  8300. <param name="length">The number of bytes to retrieve</param>
  8301. <returns>The actual number of characters written into the array</returns>
  8302. <remarks>
  8303. To determine the number of characters in the column, pass a null value for the buffer. The total length will be returned.
  8304. </remarks>
  8305. </member>
  8306. <member name="M:System.Data.SQLite.SQLiteDataReader.GetDataTypeName(System.Int32)">
  8307. <summary>
  8308. Retrieves the name of the back-end datatype of the column
  8309. </summary>
  8310. <param name="i">The index of the column.</param>
  8311. <returns>string</returns>
  8312. </member>
  8313. <member name="M:System.Data.SQLite.SQLiteDataReader.GetDateTime(System.Int32)">
  8314. <summary>
  8315. Retrieve the column as a date/time value
  8316. </summary>
  8317. <param name="i">The index of the column.</param>
  8318. <returns>DateTime</returns>
  8319. </member>
  8320. <member name="M:System.Data.SQLite.SQLiteDataReader.GetDecimal(System.Int32)">
  8321. <summary>
  8322. Retrieve the column as a decimal value
  8323. </summary>
  8324. <param name="i">The index of the column.</param>
  8325. <returns>decimal</returns>
  8326. </member>
  8327. <member name="M:System.Data.SQLite.SQLiteDataReader.GetDouble(System.Int32)">
  8328. <summary>
  8329. Returns the column as a double
  8330. </summary>
  8331. <param name="i">The index of the column.</param>
  8332. <returns>double</returns>
  8333. </member>
  8334. <member name="M:System.Data.SQLite.SQLiteDataReader.GetFieldAffinity(System.Int32)">
  8335. <summary>
  8336. Determines and returns the <see cref="T:System.Data.SQLite.TypeAffinity"/> of the
  8337. specified column.
  8338. </summary>
  8339. <param name="i">
  8340. The index of the column.
  8341. </param>
  8342. <returns>
  8343. The <see cref="T:System.Data.SQLite.TypeAffinity"/> associated with the specified
  8344. column, if any.
  8345. </returns>
  8346. </member>
  8347. <member name="M:System.Data.SQLite.SQLiteDataReader.GetFieldType(System.Int32)">
  8348. <summary>
  8349. Returns the .NET type of a given column
  8350. </summary>
  8351. <param name="i">The index of the column.</param>
  8352. <returns>Type</returns>
  8353. </member>
  8354. <member name="M:System.Data.SQLite.SQLiteDataReader.GetFloat(System.Int32)">
  8355. <summary>
  8356. Returns a column as a float value
  8357. </summary>
  8358. <param name="i">The index of the column.</param>
  8359. <returns>float</returns>
  8360. </member>
  8361. <member name="M:System.Data.SQLite.SQLiteDataReader.GetGuid(System.Int32)">
  8362. <summary>
  8363. Returns the column as a Guid
  8364. </summary>
  8365. <param name="i">The index of the column.</param>
  8366. <returns>Guid</returns>
  8367. </member>
  8368. <member name="M:System.Data.SQLite.SQLiteDataReader.GetInt16(System.Int32)">
  8369. <summary>
  8370. Returns the column as a short
  8371. </summary>
  8372. <param name="i">The index of the column.</param>
  8373. <returns>Int16</returns>
  8374. </member>
  8375. <member name="M:System.Data.SQLite.SQLiteDataReader.GetInt32(System.Int32)">
  8376. <summary>
  8377. Retrieves the column as an int
  8378. </summary>
  8379. <param name="i">The index of the column.</param>
  8380. <returns>Int32</returns>
  8381. </member>
  8382. <member name="M:System.Data.SQLite.SQLiteDataReader.GetInt64(System.Int32)">
  8383. <summary>
  8384. Retrieves the column as a long
  8385. </summary>
  8386. <param name="i">The index of the column.</param>
  8387. <returns>Int64</returns>
  8388. </member>
  8389. <member name="M:System.Data.SQLite.SQLiteDataReader.GetName(System.Int32)">
  8390. <summary>
  8391. Retrieves the name of the column
  8392. </summary>
  8393. <param name="i">The index of the column.</param>
  8394. <returns>string</returns>
  8395. </member>
  8396. <member name="M:System.Data.SQLite.SQLiteDataReader.GetDatabaseName(System.Int32)">
  8397. <summary>
  8398. Returns the name of the database associated with the specified column.
  8399. </summary>
  8400. <param name="i">The index of the column.</param>
  8401. <returns>string</returns>
  8402. </member>
  8403. <member name="M:System.Data.SQLite.SQLiteDataReader.GetTableName(System.Int32)">
  8404. <summary>
  8405. Returns the name of the table associated with the specified column.
  8406. </summary>
  8407. <param name="i">The index of the column.</param>
  8408. <returns>string</returns>
  8409. </member>
  8410. <member name="M:System.Data.SQLite.SQLiteDataReader.GetOriginalName(System.Int32)">
  8411. <summary>
  8412. Returns the original name of the specified column.
  8413. </summary>
  8414. <param name="i">The index of the column.</param>
  8415. <returns>string</returns>
  8416. </member>
  8417. <member name="M:System.Data.SQLite.SQLiteDataReader.GetOrdinal(System.String)">
  8418. <summary>
  8419. Retrieves the i of a column, given its name
  8420. </summary>
  8421. <param name="name">The name of the column to retrieve</param>
  8422. <returns>The int i of the column</returns>
  8423. </member>
  8424. <member name="M:System.Data.SQLite.SQLiteDataReader.GetSchemaTable">
  8425. <summary>
  8426. Schema information in SQLite is difficult to map into .NET conventions, so a lot of work must be done
  8427. to gather the necessary information so it can be represented in an ADO.NET manner.
  8428. </summary>
  8429. <returns>Returns a DataTable containing the schema information for the active SELECT statement being processed.</returns>
  8430. </member>
  8431. <member name="M:System.Data.SQLite.SQLiteDataReader.GetString(System.Int32)">
  8432. <summary>
  8433. Retrieves the column as a string
  8434. </summary>
  8435. <param name="i">The index of the column.</param>
  8436. <returns>string</returns>
  8437. </member>
  8438. <member name="M:System.Data.SQLite.SQLiteDataReader.GetValue(System.Int32)">
  8439. <summary>
  8440. Retrieves the column as an object corresponding to the underlying datatype of the column
  8441. </summary>
  8442. <param name="i">The index of the column.</param>
  8443. <returns>object</returns>
  8444. </member>
  8445. <member name="M:System.Data.SQLite.SQLiteDataReader.GetValues(System.Object[])">
  8446. <summary>
  8447. Retreives the values of multiple columns, up to the size of the supplied array
  8448. </summary>
  8449. <param name="values">The array to fill with values from the columns in the current resultset</param>
  8450. <returns>The number of columns retrieved</returns>
  8451. </member>
  8452. <member name="M:System.Data.SQLite.SQLiteDataReader.GetValues">
  8453. <summary>
  8454. Returns a collection containing all the column names and values for the
  8455. current row of data in the current resultset, if any. If there is no
  8456. current row or no current resultset, an exception may be thrown.
  8457. </summary>
  8458. <returns>
  8459. The collection containing the column name and value information for the
  8460. current row of data in the current resultset or null if this information
  8461. cannot be obtained.
  8462. </returns>
  8463. </member>
  8464. <member name="M:System.Data.SQLite.SQLiteDataReader.IsDBNull(System.Int32)">
  8465. <summary>
  8466. Returns True if the specified column is null
  8467. </summary>
  8468. <param name="i">The index of the column.</param>
  8469. <returns>True or False</returns>
  8470. </member>
  8471. <member name="M:System.Data.SQLite.SQLiteDataReader.NextResult">
  8472. <summary>
  8473. Moves to the next resultset in multiple row-returning SQL command.
  8474. </summary>
  8475. <returns>True if the command was successful and a new resultset is available, False otherwise.</returns>
  8476. </member>
  8477. <member name="M:System.Data.SQLite.SQLiteDataReader.GetConnection(System.Data.SQLite.SQLiteDataReader)">
  8478. <summary>
  8479. This method attempts to query the database connection associated with
  8480. the data reader in use. If the underlying command or connection is
  8481. unavailable, a null value will be returned.
  8482. </summary>
  8483. <returns>
  8484. The connection object -OR- null if it is unavailable.
  8485. </returns>
  8486. </member>
  8487. <member name="M:System.Data.SQLite.SQLiteDataReader.GetSQLiteType(System.Data.SQLite.SQLiteType,System.String)">
  8488. <summary>
  8489. Retrieves the SQLiteType for a given column and row value.
  8490. </summary>
  8491. <param name="oldType">
  8492. The original SQLiteType structure, based only on the column.
  8493. </param>
  8494. <param name="text">
  8495. The textual value of the column for a given row.
  8496. </param>
  8497. <returns>
  8498. The SQLiteType structure.
  8499. </returns>
  8500. </member>
  8501. <member name="M:System.Data.SQLite.SQLiteDataReader.GetSQLiteType(System.Data.SQLite.SQLiteConnectionFlags,System.Int32)">
  8502. <summary>
  8503. Retrieves the SQLiteType for a given column, and caches it to avoid repetetive interop calls.
  8504. </summary>
  8505. <param name="flags">The flags associated with the parent connection object.</param>
  8506. <param name="i">The index of the column.</param>
  8507. <returns>A SQLiteType structure</returns>
  8508. </member>
  8509. <member name="M:System.Data.SQLite.SQLiteDataReader.Read">
  8510. <summary>
  8511. Reads the next row from the resultset
  8512. </summary>
  8513. <returns>True if a new row was successfully loaded and is ready for processing</returns>
  8514. </member>
  8515. <member name="P:System.Data.SQLite.SQLiteDataReader.Depth">
  8516. <summary>
  8517. Not implemented. Returns 0
  8518. </summary>
  8519. </member>
  8520. <member name="P:System.Data.SQLite.SQLiteDataReader.FieldCount">
  8521. <summary>
  8522. Returns the number of columns in the current resultset
  8523. </summary>
  8524. </member>
  8525. <member name="P:System.Data.SQLite.SQLiteDataReader.StepCount">
  8526. <summary>
  8527. Returns the number of rows seen so far in the current result set.
  8528. </summary>
  8529. </member>
  8530. <member name="P:System.Data.SQLite.SQLiteDataReader.VisibleFieldCount">
  8531. <summary>
  8532. Returns the number of visible fields in the current resultset
  8533. </summary>
  8534. </member>
  8535. <member name="P:System.Data.SQLite.SQLiteDataReader.HasRows">
  8536. <summary>
  8537. Returns True if the resultset has rows that can be fetched
  8538. </summary>
  8539. </member>
  8540. <member name="P:System.Data.SQLite.SQLiteDataReader.IsClosed">
  8541. <summary>
  8542. Returns True if the data reader is closed
  8543. </summary>
  8544. </member>
  8545. <member name="P:System.Data.SQLite.SQLiteDataReader.RecordsAffected">
  8546. <summary>
  8547. Returns the number of rows affected by the statement being executed.
  8548. The value returned may not be accurate for DDL statements. Also, it
  8549. will be -1 for any statement that does not modify the database (e.g.
  8550. SELECT). If an otherwise read-only statement modifies the database
  8551. indirectly (e.g. via a virtual table or user-defined function), the
  8552. value returned is undefined.
  8553. </summary>
  8554. </member>
  8555. <member name="P:System.Data.SQLite.SQLiteDataReader.Item(System.String)">
  8556. <summary>
  8557. Indexer to retrieve data from a column given its name
  8558. </summary>
  8559. <param name="name">The name of the column to retrieve data for</param>
  8560. <returns>The value contained in the column</returns>
  8561. </member>
  8562. <member name="P:System.Data.SQLite.SQLiteDataReader.Item(System.Int32)">
  8563. <summary>
  8564. Indexer to retrieve data from a column given its i
  8565. </summary>
  8566. <param name="i">The index of the column.</param>
  8567. <returns>The value contained in the column</returns>
  8568. </member>
  8569. <member name="T:System.Data.SQLite.SQLiteException">
  8570. <summary>
  8571. SQLite exception class.
  8572. </summary>
  8573. </member>
  8574. <member name="F:System.Data.SQLite.SQLiteException.FACILITY_SQLITE">
  8575. <summary>
  8576. This value was copied from the "WinError.h" file included with the
  8577. Platform SDK for Windows 10.
  8578. </summary>
  8579. </member>
  8580. <member name="M:System.Data.SQLite.SQLiteException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  8581. <summary>
  8582. Private constructor for use with serialization.
  8583. </summary>
  8584. <param name="info">
  8585. Holds the serialized object data about the exception being thrown.
  8586. </param>
  8587. <param name="context">
  8588. Contains contextual information about the source or destination.
  8589. </param>
  8590. </member>
  8591. <member name="M:System.Data.SQLite.SQLiteException.#ctor(System.Data.SQLite.SQLiteErrorCode,System.String)">
  8592. <summary>
  8593. Public constructor for generating a SQLite exception given the error
  8594. code and message.
  8595. </summary>
  8596. <param name="errorCode">
  8597. The SQLite return code to report.
  8598. </param>
  8599. <param name="message">
  8600. Message text to go along with the return code message text.
  8601. </param>
  8602. </member>
  8603. <member name="M:System.Data.SQLite.SQLiteException.#ctor(System.String)">
  8604. <summary>
  8605. Public constructor that uses the base class constructor for the error
  8606. message.
  8607. </summary>
  8608. <param name="message">Error message text.</param>
  8609. </member>
  8610. <member name="M:System.Data.SQLite.SQLiteException.#ctor">
  8611. <summary>
  8612. Public constructor that uses the default base class constructor.
  8613. </summary>
  8614. </member>
  8615. <member name="M:System.Data.SQLite.SQLiteException.#ctor(System.String,System.Exception)">
  8616. <summary>
  8617. Public constructor that uses the base class constructor for the error
  8618. message and inner exception.
  8619. </summary>
  8620. <param name="message">Error message text.</param>
  8621. <param name="innerException">The original (inner) exception.</param>
  8622. </member>
  8623. <member name="M:System.Data.SQLite.SQLiteException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  8624. <summary>
  8625. Adds extra information to the serialized object data specific to this
  8626. class type. This is only used for serialization.
  8627. </summary>
  8628. <param name="info">
  8629. Holds the serialized object data about the exception being thrown.
  8630. </param>
  8631. <param name="context">
  8632. Contains contextual information about the source or destination.
  8633. </param>
  8634. </member>
  8635. <member name="M:System.Data.SQLite.SQLiteException.Initialize">
  8636. <summary>
  8637. This method performs extra initialization tasks. It may be called by
  8638. any of the constructors of this class. It must not throw exceptions.
  8639. </summary>
  8640. </member>
  8641. <member name="M:System.Data.SQLite.SQLiteException.MakeHResult(System.Int32,System.Boolean)">
  8642. <summary>
  8643. Maps a Win32 error code to an HRESULT.
  8644. </summary>
  8645. <param name="errorCode">
  8646. The specified Win32 error code. It must be within the range of zero
  8647. (0) to 0xFFFF (65535).
  8648. </param>
  8649. <param name="success">
  8650. Non-zero if the HRESULT should indicate success; otherwise, zero.
  8651. </param>
  8652. <returns>
  8653. The integer value of the HRESULT.
  8654. </returns>
  8655. </member>
  8656. <member name="M:System.Data.SQLite.SQLiteException.GetHResultForErrorCode(System.Data.SQLite.SQLiteErrorCode)">
  8657. <summary>
  8658. Attempts to map the specified <see cref="T:System.Data.SQLite.SQLiteErrorCode"/> onto an
  8659. existing HRESULT -OR- a Win32 error code wrapped in an HRESULT. The
  8660. mappings may not have perfectly matching semantics; however, they do
  8661. have the benefit of being unique within the context of this exception
  8662. type.
  8663. </summary>
  8664. <param name="errorCode">
  8665. The <see cref="T:System.Data.SQLite.SQLiteErrorCode"/> to map.
  8666. </param>
  8667. <returns>
  8668. The integer HRESULT value -OR- null if there is no known mapping.
  8669. </returns>
  8670. </member>
  8671. <member name="M:System.Data.SQLite.SQLiteException.GetErrorString(System.Data.SQLite.SQLiteErrorCode)">
  8672. <summary>
  8673. Returns the error message for the specified SQLite return code.
  8674. </summary>
  8675. <param name="errorCode">The SQLite return code.</param>
  8676. <returns>The error message or null if it cannot be found.</returns>
  8677. </member>
  8678. <member name="M:System.Data.SQLite.SQLiteException.GetStockErrorMessage(System.Data.SQLite.SQLiteErrorCode,System.String)">
  8679. <summary>
  8680. Returns the composite error message based on the SQLite return code
  8681. and the optional detailed error message.
  8682. </summary>
  8683. <param name="errorCode">The SQLite return code.</param>
  8684. <param name="message">Optional detailed error message.</param>
  8685. <returns>Error message text for the return code.</returns>
  8686. </member>
  8687. <member name="P:System.Data.SQLite.SQLiteException.ResultCode">
  8688. <summary>
  8689. Gets the associated SQLite result code for this exception as a
  8690. <see cref="T:System.Data.SQLite.SQLiteErrorCode"/>. This property returns the same
  8691. underlying value as the <see cref="P:System.Data.SQLite.SQLiteException.ErrorCode"/> property.
  8692. </summary>
  8693. </member>
  8694. <member name="P:System.Data.SQLite.SQLiteException.ErrorCode">
  8695. <summary>
  8696. Gets the associated SQLite return code for this exception as an
  8697. <see cref="T:System.Int32"/>. For desktop versions of the .NET Framework,
  8698. this property overrides the property of the same name within the
  8699. <see cref="T:System.Runtime.InteropServices.ExternalException"/>
  8700. class. This property returns the same underlying value as the
  8701. <see cref="P:System.Data.SQLite.SQLiteException.ResultCode"/> property.
  8702. </summary>
  8703. </member>
  8704. <member name="T:System.Data.SQLite.SQLiteErrorCode">
  8705. <summary>
  8706. SQLite error codes. Actually, this enumeration represents a return code,
  8707. which may also indicate success in one of several ways (e.g. SQLITE_OK,
  8708. SQLITE_ROW, and SQLITE_DONE). Therefore, the name of this enumeration is
  8709. something of a misnomer.
  8710. </summary>
  8711. </member>
  8712. <member name="F:System.Data.SQLite.SQLiteErrorCode.Unknown">
  8713. <summary>
  8714. The error code is unknown. This error code
  8715. is only used by the managed wrapper itself.
  8716. </summary>
  8717. </member>
  8718. <member name="F:System.Data.SQLite.SQLiteErrorCode.Ok">
  8719. <summary>
  8720. Successful result
  8721. </summary>
  8722. </member>
  8723. <member name="F:System.Data.SQLite.SQLiteErrorCode.Error">
  8724. <summary>
  8725. SQL error or missing database
  8726. </summary>
  8727. </member>
  8728. <member name="F:System.Data.SQLite.SQLiteErrorCode.Internal">
  8729. <summary>
  8730. Internal logic error in SQLite
  8731. </summary>
  8732. </member>
  8733. <member name="F:System.Data.SQLite.SQLiteErrorCode.Perm">
  8734. <summary>
  8735. Access permission denied
  8736. </summary>
  8737. </member>
  8738. <member name="F:System.Data.SQLite.SQLiteErrorCode.Abort">
  8739. <summary>
  8740. Callback routine requested an abort
  8741. </summary>
  8742. </member>
  8743. <member name="F:System.Data.SQLite.SQLiteErrorCode.Busy">
  8744. <summary>
  8745. The database file is locked
  8746. </summary>
  8747. </member>
  8748. <member name="F:System.Data.SQLite.SQLiteErrorCode.Locked">
  8749. <summary>
  8750. A table in the database is locked
  8751. </summary>
  8752. </member>
  8753. <member name="F:System.Data.SQLite.SQLiteErrorCode.NoMem">
  8754. <summary>
  8755. A malloc() failed
  8756. </summary>
  8757. </member>
  8758. <member name="F:System.Data.SQLite.SQLiteErrorCode.ReadOnly">
  8759. <summary>
  8760. Attempt to write a readonly database
  8761. </summary>
  8762. </member>
  8763. <member name="F:System.Data.SQLite.SQLiteErrorCode.Interrupt">
  8764. <summary>
  8765. Operation terminated by sqlite3_interrupt()
  8766. </summary>
  8767. </member>
  8768. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr">
  8769. <summary>
  8770. Some kind of disk I/O error occurred
  8771. </summary>
  8772. </member>
  8773. <member name="F:System.Data.SQLite.SQLiteErrorCode.Corrupt">
  8774. <summary>
  8775. The database disk image is malformed
  8776. </summary>
  8777. </member>
  8778. <member name="F:System.Data.SQLite.SQLiteErrorCode.NotFound">
  8779. <summary>
  8780. Unknown opcode in sqlite3_file_control()
  8781. </summary>
  8782. </member>
  8783. <member name="F:System.Data.SQLite.SQLiteErrorCode.Full">
  8784. <summary>
  8785. Insertion failed because database is full
  8786. </summary>
  8787. </member>
  8788. <member name="F:System.Data.SQLite.SQLiteErrorCode.CantOpen">
  8789. <summary>
  8790. Unable to open the database file
  8791. </summary>
  8792. </member>
  8793. <member name="F:System.Data.SQLite.SQLiteErrorCode.Protocol">
  8794. <summary>
  8795. Database lock protocol error
  8796. </summary>
  8797. </member>
  8798. <member name="F:System.Data.SQLite.SQLiteErrorCode.Empty">
  8799. <summary>
  8800. Database is empty
  8801. </summary>
  8802. </member>
  8803. <member name="F:System.Data.SQLite.SQLiteErrorCode.Schema">
  8804. <summary>
  8805. The database schema changed
  8806. </summary>
  8807. </member>
  8808. <member name="F:System.Data.SQLite.SQLiteErrorCode.TooBig">
  8809. <summary>
  8810. String or BLOB exceeds size limit
  8811. </summary>
  8812. </member>
  8813. <member name="F:System.Data.SQLite.SQLiteErrorCode.Constraint">
  8814. <summary>
  8815. Abort due to constraint violation
  8816. </summary>
  8817. </member>
  8818. <member name="F:System.Data.SQLite.SQLiteErrorCode.Mismatch">
  8819. <summary>
  8820. Data type mismatch
  8821. </summary>
  8822. </member>
  8823. <member name="F:System.Data.SQLite.SQLiteErrorCode.Misuse">
  8824. <summary>
  8825. Library used incorrectly
  8826. </summary>
  8827. </member>
  8828. <member name="F:System.Data.SQLite.SQLiteErrorCode.NoLfs">
  8829. <summary>
  8830. Uses OS features not supported on host
  8831. </summary>
  8832. </member>
  8833. <member name="F:System.Data.SQLite.SQLiteErrorCode.Auth">
  8834. <summary>
  8835. Authorization denied
  8836. </summary>
  8837. </member>
  8838. <member name="F:System.Data.SQLite.SQLiteErrorCode.Format">
  8839. <summary>
  8840. Auxiliary database format error
  8841. </summary>
  8842. </member>
  8843. <member name="F:System.Data.SQLite.SQLiteErrorCode.Range">
  8844. <summary>
  8845. 2nd parameter to sqlite3_bind out of range
  8846. </summary>
  8847. </member>
  8848. <member name="F:System.Data.SQLite.SQLiteErrorCode.NotADb">
  8849. <summary>
  8850. File opened that is not a database file
  8851. </summary>
  8852. </member>
  8853. <member name="F:System.Data.SQLite.SQLiteErrorCode.Notice">
  8854. <summary>
  8855. Notifications from sqlite3_log()
  8856. </summary>
  8857. </member>
  8858. <member name="F:System.Data.SQLite.SQLiteErrorCode.Warning">
  8859. <summary>
  8860. Warnings from sqlite3_log()
  8861. </summary>
  8862. </member>
  8863. <member name="F:System.Data.SQLite.SQLiteErrorCode.Row">
  8864. <summary>
  8865. sqlite3_step() has another row ready
  8866. </summary>
  8867. </member>
  8868. <member name="F:System.Data.SQLite.SQLiteErrorCode.Done">
  8869. <summary>
  8870. sqlite3_step() has finished executing
  8871. </summary>
  8872. </member>
  8873. <member name="F:System.Data.SQLite.SQLiteErrorCode.NonExtendedMask">
  8874. <summary>
  8875. Used to mask off extended result codes
  8876. </summary>
  8877. </member>
  8878. <member name="F:System.Data.SQLite.SQLiteErrorCode.Error_Missing_CollSeq">
  8879. <summary>
  8880. A collation sequence was referenced by a schema and it cannot be
  8881. found.
  8882. </summary>
  8883. </member>
  8884. <member name="F:System.Data.SQLite.SQLiteErrorCode.Error_Retry">
  8885. <summary>
  8886. An internal operation failed and it may succeed if retried.
  8887. </summary>
  8888. </member>
  8889. <member name="F:System.Data.SQLite.SQLiteErrorCode.Error_Snapshot">
  8890. <summary>
  8891. The specified snapshot has been overwritten by a checkpoint.
  8892. </summary>
  8893. </member>
  8894. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Read">
  8895. <summary>
  8896. A file read operation failed.
  8897. </summary>
  8898. </member>
  8899. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Short_Read">
  8900. <summary>
  8901. A file read operation returned less data than requested.
  8902. </summary>
  8903. </member>
  8904. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Write">
  8905. <summary>
  8906. A file write operation failed.
  8907. </summary>
  8908. </member>
  8909. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Fsync">
  8910. <summary>
  8911. A file synchronization operation failed.
  8912. </summary>
  8913. </member>
  8914. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Dir_Fsync">
  8915. <summary>
  8916. A directory synchronization operation failed.
  8917. </summary>
  8918. </member>
  8919. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Truncate">
  8920. <summary>
  8921. A file truncate operation failed.
  8922. </summary>
  8923. </member>
  8924. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Fstat">
  8925. <summary>
  8926. A file metadata operation failed.
  8927. </summary>
  8928. </member>
  8929. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Unlock">
  8930. <summary>
  8931. A file unlock operation failed.
  8932. </summary>
  8933. </member>
  8934. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_RdLock">
  8935. <summary>
  8936. A file lock operation failed.
  8937. </summary>
  8938. </member>
  8939. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Delete">
  8940. <summary>
  8941. A file delete operation failed.
  8942. </summary>
  8943. </member>
  8944. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Blocked">
  8945. <summary>
  8946. Not currently used.
  8947. </summary>
  8948. </member>
  8949. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_NoMem">
  8950. <summary>
  8951. Out-of-memory during a file operation.
  8952. </summary>
  8953. </member>
  8954. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Access">
  8955. <summary>
  8956. A file existence/status operation failed.
  8957. </summary>
  8958. </member>
  8959. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_CheckReservedLock">
  8960. <summary>
  8961. A check for a reserved lock failed.
  8962. </summary>
  8963. </member>
  8964. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Lock">
  8965. <summary>
  8966. A file lock operation failed.
  8967. </summary>
  8968. </member>
  8969. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Close">
  8970. <summary>
  8971. A file close operation failed.
  8972. </summary>
  8973. </member>
  8974. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Dir_Close">
  8975. <summary>
  8976. A directory close operation failed.
  8977. </summary>
  8978. </member>
  8979. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_ShmOpen">
  8980. <summary>
  8981. A shared memory open operation failed.
  8982. </summary>
  8983. </member>
  8984. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_ShmSize">
  8985. <summary>
  8986. A shared memory size operation failed.
  8987. </summary>
  8988. </member>
  8989. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_ShmLock">
  8990. <summary>
  8991. A shared memory lock operation failed.
  8992. </summary>
  8993. </member>
  8994. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_ShmMap">
  8995. <summary>
  8996. A shared memory map operation failed.
  8997. </summary>
  8998. </member>
  8999. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Seek">
  9000. <summary>
  9001. A file seek operation failed.
  9002. </summary>
  9003. </member>
  9004. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Delete_NoEnt">
  9005. <summary>
  9006. A file delete operation failed because it does not exist.
  9007. </summary>
  9008. </member>
  9009. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Mmap">
  9010. <summary>
  9011. A file memory mapping operation failed.
  9012. </summary>
  9013. </member>
  9014. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_GetTempPath">
  9015. <summary>
  9016. The temporary directory path could not be obtained.
  9017. </summary>
  9018. </member>
  9019. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_ConvPath">
  9020. <summary>
  9021. A path string conversion operation failed.
  9022. </summary>
  9023. </member>
  9024. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_VNode">
  9025. <summary>
  9026. Reserved.
  9027. </summary>
  9028. </member>
  9029. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Auth">
  9030. <summary>
  9031. An attempt to authenticate failed.
  9032. </summary>
  9033. </member>
  9034. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Begin_Atomic">
  9035. <summary>
  9036. An attempt to begin a file system transaction failed.
  9037. </summary>
  9038. </member>
  9039. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Commit_Atomic">
  9040. <summary>
  9041. An attempt to commit a file system transaction failed.
  9042. </summary>
  9043. </member>
  9044. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Rollback_Atomic">
  9045. <summary>
  9046. An attempt to rollback a file system transaction failed.
  9047. </summary>
  9048. </member>
  9049. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Data">
  9050. <summary>
  9051. Data read from the file system appears to be incorrect.
  9052. </summary>
  9053. </member>
  9054. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_CorruptFs">
  9055. <summary>
  9056. File system corruption was detected during a read or write.
  9057. </summary>
  9058. </member>
  9059. <member name="F:System.Data.SQLite.SQLiteErrorCode.Locked_SharedCache">
  9060. <summary>
  9061. A database table is locked in shared-cache mode.
  9062. </summary>
  9063. </member>
  9064. <member name="F:System.Data.SQLite.SQLiteErrorCode.Locked_Vtab">
  9065. <summary>
  9066. A virtual table in the database is locked.
  9067. </summary>
  9068. </member>
  9069. <member name="F:System.Data.SQLite.SQLiteErrorCode.Busy_Recovery">
  9070. <summary>
  9071. A database file is locked due to a recovery operation.
  9072. </summary>
  9073. </member>
  9074. <member name="F:System.Data.SQLite.SQLiteErrorCode.Busy_Snapshot">
  9075. <summary>
  9076. A database file is locked due to snapshot semantics.
  9077. </summary>
  9078. </member>
  9079. <member name="F:System.Data.SQLite.SQLiteErrorCode.Busy_Timeout">
  9080. <summary>
  9081. An internal timeout was encountered while waiting for a database lock.
  9082. </summary>
  9083. </member>
  9084. <member name="F:System.Data.SQLite.SQLiteErrorCode.CantOpen_NoTempDir">
  9085. <summary>
  9086. A database file cannot be opened because no temporary directory is available.
  9087. </summary>
  9088. </member>
  9089. <member name="F:System.Data.SQLite.SQLiteErrorCode.CantOpen_IsDir">
  9090. <summary>
  9091. A database file cannot be opened because its path represents a directory.
  9092. </summary>
  9093. </member>
  9094. <member name="F:System.Data.SQLite.SQLiteErrorCode.CantOpen_FullPath">
  9095. <summary>
  9096. A database file cannot be opened because its full path could not be obtained.
  9097. </summary>
  9098. </member>
  9099. <member name="F:System.Data.SQLite.SQLiteErrorCode.CantOpen_ConvPath">
  9100. <summary>
  9101. A database file cannot be opened because a path string conversion operation failed.
  9102. </summary>
  9103. </member>
  9104. <member name="F:System.Data.SQLite.SQLiteErrorCode.CantOpen_DirtyWal">
  9105. <summary>
  9106. No longer used.
  9107. </summary>
  9108. </member>
  9109. <member name="F:System.Data.SQLite.SQLiteErrorCode.CantOpen_SymLink">
  9110. <summary>
  9111. A database file is a symbolic link and cannot be opened.
  9112. </summary>
  9113. </member>
  9114. <member name="F:System.Data.SQLite.SQLiteErrorCode.Corrupt_Vtab">
  9115. <summary>
  9116. A virtual table is malformed.
  9117. </summary>
  9118. </member>
  9119. <member name="F:System.Data.SQLite.SQLiteErrorCode.Corrupt_Sequence">
  9120. <summary>
  9121. A required sequence table is missing or corrupt.
  9122. </summary>
  9123. </member>
  9124. <member name="F:System.Data.SQLite.SQLiteErrorCode.Corrupt_Index">
  9125. <summary>
  9126. An index entry that should be present is missing.
  9127. </summary>
  9128. </member>
  9129. <member name="F:System.Data.SQLite.SQLiteErrorCode.ReadOnly_Recovery">
  9130. <summary>
  9131. A database file is read-only due to a recovery operation.
  9132. </summary>
  9133. </member>
  9134. <member name="F:System.Data.SQLite.SQLiteErrorCode.ReadOnly_CantLock">
  9135. <summary>
  9136. A database file is read-only because a lock could not be obtained.
  9137. </summary>
  9138. </member>
  9139. <member name="F:System.Data.SQLite.SQLiteErrorCode.ReadOnly_Rollback">
  9140. <summary>
  9141. A database file is read-only because it needs rollback processing.
  9142. </summary>
  9143. </member>
  9144. <member name="F:System.Data.SQLite.SQLiteErrorCode.ReadOnly_DbMoved">
  9145. <summary>
  9146. A database file is read-only because it was moved while open.
  9147. </summary>
  9148. </member>
  9149. <member name="F:System.Data.SQLite.SQLiteErrorCode.ReadOnly_CantInit">
  9150. <summary>
  9151. The shared-memory file is read-only and it should be read-write.
  9152. </summary>
  9153. </member>
  9154. <member name="F:System.Data.SQLite.SQLiteErrorCode.ReadOnly_Directory">
  9155. <summary>
  9156. Unable to create journal file because the directory is read-only.
  9157. </summary>
  9158. </member>
  9159. <member name="F:System.Data.SQLite.SQLiteErrorCode.Abort_Rollback">
  9160. <summary>
  9161. An operation is being aborted due to rollback processing.
  9162. </summary>
  9163. </member>
  9164. <member name="F:System.Data.SQLite.SQLiteErrorCode.Constraint_Check">
  9165. <summary>
  9166. A CHECK constraint failed.
  9167. </summary>
  9168. </member>
  9169. <member name="F:System.Data.SQLite.SQLiteErrorCode.Constraint_CommitHook">
  9170. <summary>
  9171. A commit hook produced a unsuccessful return code.
  9172. </summary>
  9173. </member>
  9174. <member name="F:System.Data.SQLite.SQLiteErrorCode.Constraint_ForeignKey">
  9175. <summary>
  9176. A FOREIGN KEY constraint failed.
  9177. </summary>
  9178. </member>
  9179. <member name="F:System.Data.SQLite.SQLiteErrorCode.Constraint_Function">
  9180. <summary>
  9181. Not currently used.
  9182. </summary>
  9183. </member>
  9184. <member name="F:System.Data.SQLite.SQLiteErrorCode.Constraint_NotNull">
  9185. <summary>
  9186. A NOT NULL constraint failed.
  9187. </summary>
  9188. </member>
  9189. <member name="F:System.Data.SQLite.SQLiteErrorCode.Constraint_PrimaryKey">
  9190. <summary>
  9191. A PRIMARY KEY constraint failed.
  9192. </summary>
  9193. </member>
  9194. <member name="F:System.Data.SQLite.SQLiteErrorCode.Constraint_Trigger">
  9195. <summary>
  9196. The RAISE function was used by a trigger-program.
  9197. </summary>
  9198. </member>
  9199. <member name="F:System.Data.SQLite.SQLiteErrorCode.Constraint_Unique">
  9200. <summary>
  9201. A UNIQUE constraint failed.
  9202. </summary>
  9203. </member>
  9204. <member name="F:System.Data.SQLite.SQLiteErrorCode.Constraint_Vtab">
  9205. <summary>
  9206. Not currently used.
  9207. </summary>
  9208. </member>
  9209. <member name="F:System.Data.SQLite.SQLiteErrorCode.Constraint_RowId">
  9210. <summary>
  9211. A ROWID constraint failed.
  9212. </summary>
  9213. </member>
  9214. <member name="F:System.Data.SQLite.SQLiteErrorCode.Constraint_Pinned">
  9215. <summary>
  9216. A database cursor is busy and cannot be moved.
  9217. </summary>
  9218. </member>
  9219. <member name="F:System.Data.SQLite.SQLiteErrorCode.Misuse_No_License">
  9220. <summary>
  9221. Method called without an appropriate license.
  9222. </summary>
  9223. </member>
  9224. <member name="F:System.Data.SQLite.SQLiteErrorCode.Notice_Recover_Wal">
  9225. <summary>
  9226. Frames were recovered from the WAL log file.
  9227. </summary>
  9228. </member>
  9229. <member name="F:System.Data.SQLite.SQLiteErrorCode.Notice_Recover_Rollback">
  9230. <summary>
  9231. Pages were recovered from the journal file.
  9232. </summary>
  9233. </member>
  9234. <member name="F:System.Data.SQLite.SQLiteErrorCode.Warning_AutoIndex">
  9235. <summary>
  9236. An automatic index was created to process a query.
  9237. </summary>
  9238. </member>
  9239. <member name="F:System.Data.SQLite.SQLiteErrorCode.Auth_User">
  9240. <summary>
  9241. User authentication failed.
  9242. </summary>
  9243. </member>
  9244. <member name="F:System.Data.SQLite.SQLiteErrorCode.Ok_Load_Permanently">
  9245. <summary>
  9246. Success. Prevents the extension from unloading until the process
  9247. terminates.
  9248. </summary>
  9249. </member>
  9250. <member name="F:System.Data.SQLite.SQLiteErrorCode.Ok_SymLink">
  9251. <summary>
  9252. Success. The specified file name refers to a symbolic link.
  9253. </summary>
  9254. </member>
  9255. <member name="T:System.Data.SQLite.SQLiteFactory">
  9256. <summary>
  9257. SQLite implementation of <see cref="T:System.Data.Common.DbProviderFactory"/>.
  9258. </summary>
  9259. <summary>
  9260. SQLite implementation of <see cref="T:System.IServiceProvider"/>.
  9261. </summary>
  9262. </member>
  9263. <member name="M:System.Data.SQLite.SQLiteFactory.#ctor">
  9264. <summary>
  9265. Constructs a new instance.
  9266. </summary>
  9267. </member>
  9268. <member name="M:System.Data.SQLite.SQLiteFactory.Dispose">
  9269. <summary>
  9270. Cleans up resources (native and managed) associated with the current instance.
  9271. </summary>
  9272. </member>
  9273. <member name="M:System.Data.SQLite.SQLiteFactory.Finalize">
  9274. <summary>
  9275. Cleans up resources associated with the current instance.
  9276. </summary>
  9277. </member>
  9278. <member name="F:System.Data.SQLite.SQLiteFactory.Instance">
  9279. <summary>
  9280. Static instance member which returns an instanced <see cref="T:System.Data.SQLite.SQLiteFactory"/> class.
  9281. </summary>
  9282. </member>
  9283. <member name="M:System.Data.SQLite.SQLiteFactory.CreateCommand">
  9284. <summary>
  9285. Creates and returns a new <see cref="T:System.Data.SQLite.SQLiteCommand"/> object.
  9286. </summary>
  9287. <returns>The new object.</returns>
  9288. </member>
  9289. <member name="M:System.Data.SQLite.SQLiteFactory.CreateCommandBuilder">
  9290. <summary>
  9291. Creates and returns a new <see cref="T:System.Data.SQLite.SQLiteCommandBuilder"/> object.
  9292. </summary>
  9293. <returns>The new object.</returns>
  9294. </member>
  9295. <member name="M:System.Data.SQLite.SQLiteFactory.CreateConnection">
  9296. <summary>
  9297. Creates and returns a new <see cref="T:System.Data.SQLite.SQLiteConnection"/> object.
  9298. </summary>
  9299. <returns>The new object.</returns>
  9300. </member>
  9301. <member name="M:System.Data.SQLite.SQLiteFactory.CreateConnectionStringBuilder">
  9302. <summary>
  9303. Creates and returns a new <see cref="T:System.Data.SQLite.SQLiteConnectionStringBuilder"/> object.
  9304. </summary>
  9305. <returns>The new object.</returns>
  9306. </member>
  9307. <member name="M:System.Data.SQLite.SQLiteFactory.CreateDataAdapter">
  9308. <summary>
  9309. Creates and returns a new <see cref="T:System.Data.SQLite.SQLiteDataAdapter"/> object.
  9310. </summary>
  9311. <returns>The new object.</returns>
  9312. </member>
  9313. <member name="M:System.Data.SQLite.SQLiteFactory.CreateParameter">
  9314. <summary>
  9315. Creates and returns a new <see cref="T:System.Data.SQLite.SQLiteParameter"/> object.
  9316. </summary>
  9317. <returns>The new object.</returns>
  9318. </member>
  9319. <member name="M:System.Data.SQLite.SQLiteFactory.PreInitialize">
  9320. <summary>
  9321. This method is called to perform preliminary static initialization
  9322. necessary for this class.
  9323. </summary>
  9324. </member>
  9325. <member name="M:System.Data.SQLite.SQLiteFactory.InitializeDbProviderServices">
  9326. <summary>
  9327. This method is called to perform some of the static initialization
  9328. necessary for this class.
  9329. </summary>
  9330. </member>
  9331. <member name="M:System.Data.SQLite.SQLiteFactory.System#IServiceProvider#GetService(System.Type)">
  9332. <summary>
  9333. Will provide a <see cref="T:System.IServiceProvider"/> object in .NET 3.5.
  9334. </summary>
  9335. <param name="serviceType">The class or interface type to query for.</param>
  9336. <returns></returns>
  9337. </member>
  9338. <member name="E:System.Data.SQLite.SQLiteFactory.Log">
  9339. <summary>
  9340. This event is raised whenever SQLite raises a logging event.
  9341. Note that this should be set as one of the first things in the
  9342. application. This event is provided for backward compatibility only.
  9343. New code should use the <see cref="T:System.Data.SQLite.SQLiteLog"/> class instead.
  9344. </summary>
  9345. </member>
  9346. <member name="T:System.Data.SQLite.SQLiteFunction">
  9347. <summary>
  9348. This abstract class is designed to handle user-defined functions easily. An instance of the derived class is made for each
  9349. connection to the database.
  9350. </summary>
  9351. <remarks>
  9352. Although there is one instance of a class derived from SQLiteFunction per database connection, the derived class has no access
  9353. to the underlying connection. This is necessary to deter implementers from thinking it would be a good idea to make database
  9354. calls during processing.
  9355. It is important to distinguish between a per-connection instance, and a per-SQL statement context. One instance of this class
  9356. services all SQL statements being stepped through on that connection, and there can be many. One should never store per-statement
  9357. information in member variables of user-defined function classes.
  9358. For aggregate functions, always create and store your per-statement data in the contextData object on the 1st step. This data will
  9359. be automatically freed for you (and Dispose() called if the item supports IDisposable) when the statement completes.
  9360. </remarks>
  9361. </member>
  9362. <member name="F:System.Data.SQLite.SQLiteFunction._base">
  9363. <summary>
  9364. The base connection this function is attached to
  9365. </summary>
  9366. </member>
  9367. <member name="F:System.Data.SQLite.SQLiteFunction._contextDataList">
  9368. <summary>
  9369. Internal array used to keep track of aggregate function context data
  9370. </summary>
  9371. </member>
  9372. <member name="F:System.Data.SQLite.SQLiteFunction._flags">
  9373. <summary>
  9374. The connection flags associated with this object (this should be the
  9375. same value as the flags associated with the parent connection object).
  9376. </summary>
  9377. </member>
  9378. <member name="F:System.Data.SQLite.SQLiteFunction._InvokeFunc">
  9379. <summary>
  9380. Holds a reference to the callback function for user functions
  9381. </summary>
  9382. </member>
  9383. <member name="F:System.Data.SQLite.SQLiteFunction._StepFunc">
  9384. <summary>
  9385. Holds a reference to the callbakc function for stepping in an aggregate function
  9386. </summary>
  9387. </member>
  9388. <member name="F:System.Data.SQLite.SQLiteFunction._FinalFunc">
  9389. <summary>
  9390. Holds a reference to the callback function for finalizing an aggregate function
  9391. </summary>
  9392. </member>
  9393. <member name="F:System.Data.SQLite.SQLiteFunction._CompareFunc">
  9394. <summary>
  9395. Holds a reference to the callback function for collating sequences
  9396. </summary>
  9397. </member>
  9398. <member name="F:System.Data.SQLite.SQLiteFunction._context">
  9399. <summary>
  9400. Current context of the current callback. Only valid during a callback
  9401. </summary>
  9402. </member>
  9403. <member name="F:System.Data.SQLite.SQLiteFunction._registeredFunctions">
  9404. <summary>
  9405. This static dictionary contains all the registered (known) user-defined
  9406. functions declared using the proper attributes. The contained dictionary
  9407. values are always null and are not currently used.
  9408. </summary>
  9409. </member>
  9410. <member name="M:System.Data.SQLite.SQLiteFunction.#ctor">
  9411. <summary>
  9412. Internal constructor, initializes the function's internal variables.
  9413. </summary>
  9414. </member>
  9415. <member name="M:System.Data.SQLite.SQLiteFunction.#ctor(System.Data.SQLite.SQLiteDateFormats,System.DateTimeKind,System.String,System.Boolean)">
  9416. <summary>
  9417. Constructs an instance of this class using the specified data-type
  9418. conversion parameters.
  9419. </summary>
  9420. <param name="format">
  9421. The DateTime format to be used when converting string values to a
  9422. DateTime and binding DateTime parameters.
  9423. </param>
  9424. <param name="kind">
  9425. The <see cref="T:System.DateTimeKind"/> to be used when creating DateTime
  9426. values.
  9427. </param>
  9428. <param name="formatString">
  9429. The format string to be used when parsing and formatting DateTime
  9430. values.
  9431. </param>
  9432. <param name="utf16">
  9433. Non-zero to create a UTF-16 data-type conversion context; otherwise,
  9434. a UTF-8 data-type conversion context will be created.
  9435. </param>
  9436. </member>
  9437. <member name="M:System.Data.SQLite.SQLiteFunction.Dispose">
  9438. <summary>
  9439. Disposes of any active contextData variables that were not automatically cleaned up. Sometimes this can happen if
  9440. someone closes the connection while a DataReader is open.
  9441. </summary>
  9442. </member>
  9443. <member name="M:System.Data.SQLite.SQLiteFunction.Dispose(System.Boolean)">
  9444. <summary>
  9445. Placeholder for a user-defined disposal routine
  9446. </summary>
  9447. <param name="disposing">True if the object is being disposed explicitly</param>
  9448. </member>
  9449. <member name="M:System.Data.SQLite.SQLiteFunction.Finalize">
  9450. <summary>
  9451. Cleans up resources associated with the current instance.
  9452. </summary>
  9453. </member>
  9454. <member name="M:System.Data.SQLite.SQLiteFunction.Invoke(System.Object[])">
  9455. <summary>
  9456. Scalar functions override this method to do their magic.
  9457. </summary>
  9458. <remarks>
  9459. Parameters passed to functions have only an affinity for a certain data type, there is no underlying schema available
  9460. to force them into a certain type. Therefore the only types you will ever see as parameters are
  9461. DBNull.Value, Int64, Double, String or byte[] array.
  9462. </remarks>
  9463. <param name="args">The arguments for the command to process</param>
  9464. <returns>You may return most simple types as a return value, null or DBNull.Value to return null, DateTime, or
  9465. you may return an Exception-derived class if you wish to return an error to SQLite. Do not actually throw the error,
  9466. just return it!</returns>
  9467. </member>
  9468. <member name="M:System.Data.SQLite.SQLiteFunction.Step(System.Object[],System.Int32,System.Object@)">
  9469. <summary>
  9470. Aggregate functions override this method to do their magic.
  9471. </summary>
  9472. <remarks>
  9473. Typically you'll be updating whatever you've placed in the contextData field and returning as quickly as possible.
  9474. </remarks>
  9475. <param name="args">The arguments for the command to process</param>
  9476. <param name="stepNumber">The 1-based step number. This is incrememted each time the step method is called.</param>
  9477. <param name="contextData">A placeholder for implementers to store contextual data pertaining to the current context.</param>
  9478. </member>
  9479. <member name="M:System.Data.SQLite.SQLiteFunction.Final(System.Object)">
  9480. <summary>
  9481. Aggregate functions override this method to finish their aggregate processing.
  9482. </summary>
  9483. <remarks>
  9484. If you implemented your aggregate function properly,
  9485. you've been recording and keeping track of your data in the contextData object provided, and now at this stage you should have
  9486. all the information you need in there to figure out what to return.
  9487. NOTE: It is possible to arrive here without receiving a previous call to Step(), in which case the contextData will
  9488. be null. This can happen when no rows were returned. You can either return null, or 0 or some other custom return value
  9489. if that is the case.
  9490. </remarks>
  9491. <param name="contextData">Your own assigned contextData, provided for you so you can return your final results.</param>
  9492. <returns>You may return most simple types as a return value, null or DBNull.Value to return null, DateTime, or
  9493. you may return an Exception-derived class if you wish to return an error to SQLite. Do not actually throw the error,
  9494. just return it!
  9495. </returns>
  9496. </member>
  9497. <member name="M:System.Data.SQLite.SQLiteFunction.Compare(System.String,System.String)">
  9498. <summary>
  9499. User-defined collating sequences override this method to provide a custom string sorting algorithm.
  9500. </summary>
  9501. <param name="param1">The first string to compare.</param>
  9502. <param name="param2">The second strnig to compare.</param>
  9503. <returns>1 if param1 is greater than param2, 0 if they are equal, or -1 if param1 is less than param2.</returns>
  9504. </member>
  9505. <member name="M:System.Data.SQLite.SQLiteFunction.ConvertParams(System.Int32,System.IntPtr)">
  9506. <summary>
  9507. Converts an IntPtr array of context arguments to an object array containing the resolved parameters the pointers point to.
  9508. </summary>
  9509. <remarks>
  9510. Parameters passed to functions have only an affinity for a certain data type, there is no underlying schema available
  9511. to force them into a certain type. Therefore the only types you will ever see as parameters are
  9512. DBNull.Value, Int64, Double, String or byte[] array.
  9513. </remarks>
  9514. <param name="nArgs">The number of arguments</param>
  9515. <param name="argsptr">A pointer to the array of arguments</param>
  9516. <returns>An object array of the arguments once they've been converted to .NET values</returns>
  9517. </member>
  9518. <member name="M:System.Data.SQLite.SQLiteFunction.SetReturnValue(System.IntPtr,System.Object)">
  9519. <summary>
  9520. Takes the return value from Invoke() and Final() and figures out how to return it to SQLite's context.
  9521. </summary>
  9522. <param name="context">The context the return value applies to</param>
  9523. <param name="returnValue">The parameter to return to SQLite</param>
  9524. </member>
  9525. <member name="M:System.Data.SQLite.SQLiteFunction.ScalarCallback(System.IntPtr,System.Int32,System.IntPtr)">
  9526. <summary>
  9527. Internal scalar callback function, which wraps the raw context pointer and calls the virtual Invoke() method.
  9528. WARNING: Must not throw exceptions.
  9529. </summary>
  9530. <param name="context">A raw context pointer</param>
  9531. <param name="nArgs">Number of arguments passed in</param>
  9532. <param name="argsptr">A pointer to the array of arguments</param>
  9533. </member>
  9534. <member name="M:System.Data.SQLite.SQLiteFunction.CompareCallback(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)">
  9535. <summary>
  9536. Internal collating sequence function, which wraps up the raw string pointers and executes the Compare() virtual function.
  9537. WARNING: Must not throw exceptions.
  9538. </summary>
  9539. <param name="ptr">Not used</param>
  9540. <param name="len1">Length of the string pv1</param>
  9541. <param name="ptr1">Pointer to the first string to compare</param>
  9542. <param name="len2">Length of the string pv2</param>
  9543. <param name="ptr2">Pointer to the second string to compare</param>
  9544. <returns>Returns -1 if the first string is less than the second. 0 if they are equal, or 1 if the first string is greater
  9545. than the second. Returns 0 if an exception is caught.</returns>
  9546. </member>
  9547. <member name="M:System.Data.SQLite.SQLiteFunction.CompareCallback16(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)">
  9548. <summary>
  9549. Internal collating sequence function, which wraps up the raw string pointers and executes the Compare() virtual function.
  9550. WARNING: Must not throw exceptions.
  9551. </summary>
  9552. <param name="ptr">Not used</param>
  9553. <param name="len1">Length of the string pv1</param>
  9554. <param name="ptr1">Pointer to the first string to compare</param>
  9555. <param name="len2">Length of the string pv2</param>
  9556. <param name="ptr2">Pointer to the second string to compare</param>
  9557. <returns>Returns -1 if the first string is less than the second. 0 if they are equal, or 1 if the first string is greater
  9558. than the second. Returns 0 if an exception is caught.</returns>
  9559. </member>
  9560. <member name="M:System.Data.SQLite.SQLiteFunction.StepCallback(System.IntPtr,System.Int32,System.IntPtr)">
  9561. <summary>
  9562. The internal aggregate Step function callback, which wraps the raw context pointer and calls the virtual Step() method.
  9563. WARNING: Must not throw exceptions.
  9564. </summary>
  9565. <remarks>
  9566. This function takes care of doing the lookups and getting the important information put together to call the Step() function.
  9567. That includes pulling out the user's contextData and updating it after the call is made. We use a sorted list for this so
  9568. binary searches can be done to find the data.
  9569. </remarks>
  9570. <param name="context">A raw context pointer</param>
  9571. <param name="nArgs">Number of arguments passed in</param>
  9572. <param name="argsptr">A pointer to the array of arguments</param>
  9573. </member>
  9574. <member name="M:System.Data.SQLite.SQLiteFunction.FinalCallback(System.IntPtr)">
  9575. <summary>
  9576. An internal aggregate Final function callback, which wraps the context pointer and calls the virtual Final() method.
  9577. WARNING: Must not throw exceptions.
  9578. </summary>
  9579. <param name="context">A raw context pointer</param>
  9580. </member>
  9581. <member name="M:System.Data.SQLite.SQLiteFunction.#cctor">
  9582. <summary>
  9583. Using reflection, enumerate all assemblies in the current appdomain looking for classes that
  9584. have a SQLiteFunctionAttribute attribute, and registering them accordingly.
  9585. </summary>
  9586. </member>
  9587. <member name="M:System.Data.SQLite.SQLiteFunction.RegisterFunction(System.Type)">
  9588. <summary>
  9589. Manual method of registering a function. The type must still have the SQLiteFunctionAttributes in order to work
  9590. properly, but this is a workaround for the Compact Framework where enumerating assemblies is not currently supported.
  9591. </summary>
  9592. <param name="typ">The type of the function to register</param>
  9593. </member>
  9594. <member name="M:System.Data.SQLite.SQLiteFunction.RegisterFunction(System.String,System.Int32,System.Data.SQLite.FunctionType,System.Type,System.Delegate,System.Delegate)">
  9595. <summary>
  9596. Alternative method of registering a function. This method
  9597. does not require the specified type to be annotated with
  9598. <see cref="T:System.Data.SQLite.SQLiteFunctionAttribute"/>.
  9599. </summary>
  9600. <param name="name">
  9601. The name of the function to register.
  9602. </param>
  9603. <param name="argumentCount">
  9604. The number of arguments accepted by the function.
  9605. </param>
  9606. <param name="functionType">
  9607. The type of SQLite function being resitered (e.g. scalar,
  9608. aggregate, or collating sequence).
  9609. </param>
  9610. <param name="instanceType">
  9611. The <see cref="T:System.Type"/> that actually implements the function.
  9612. This will only be used if the <paramref name="callback1"/>
  9613. and <paramref name="callback2"/> parameters are null.
  9614. </param>
  9615. <param name="callback1">
  9616. The <see cref="T:System.Delegate"/> to be used for all calls into the
  9617. <see cref="M:System.Data.SQLite.SQLiteFunction.Invoke(System.Object[])"/>,
  9618. <see cref="M:System.Data.SQLite.SQLiteFunction.Step(System.Object[],System.Int32,System.Object@)"/>,
  9619. and <see cref="M:System.Data.SQLite.SQLiteFunction.Compare(System.String,System.String)"/> virtual methods.
  9620. </param>
  9621. <param name="callback2">
  9622. The <see cref="T:System.Delegate"/> to be used for all calls into the
  9623. <see cref="M:System.Data.SQLite.SQLiteFunction.Final(System.Object)"/> virtual method. This
  9624. parameter is only necessary for aggregate functions.
  9625. </param>
  9626. </member>
  9627. <member name="M:System.Data.SQLite.SQLiteFunction.ReplaceFunction(System.Data.SQLite.SQLiteFunctionAttribute,System.Object)">
  9628. <summary>
  9629. Replaces a registered function, disposing of the associated (old)
  9630. value if necessary.
  9631. </summary>
  9632. <param name="at">
  9633. The attribute that describes the function to replace.
  9634. </param>
  9635. <param name="newValue">
  9636. The new value to use.
  9637. </param>
  9638. <returns>
  9639. Non-zero if an existing registered function was replaced; otherwise,
  9640. zero.
  9641. </returns>
  9642. </member>
  9643. <member name="M:System.Data.SQLite.SQLiteFunction.CreateFunction(System.Data.SQLite.SQLiteFunctionAttribute,System.Data.SQLite.SQLiteFunction@)">
  9644. <summary>
  9645. Creates a <see cref="T:System.Data.SQLite.SQLiteFunction"/> instance based on the specified
  9646. <see cref="T:System.Data.SQLite.SQLiteFunctionAttribute"/>.
  9647. </summary>
  9648. <param name="functionAttribute">
  9649. The <see cref="T:System.Data.SQLite.SQLiteFunctionAttribute"/> containing the metadata about
  9650. the function to create.
  9651. </param>
  9652. <param name="function">
  9653. The created function -OR- null if the function could not be created.
  9654. </param>
  9655. <returns>
  9656. Non-zero if the function was created; otherwise, zero.
  9657. </returns>
  9658. </member>
  9659. <member name="M:System.Data.SQLite.SQLiteFunction.BindFunctions(System.Data.SQLite.SQLiteBase,System.Data.SQLite.SQLiteConnectionFlags)">
  9660. <summary>
  9661. Called by the SQLiteBase derived classes, this method binds all registered (known) user-defined functions to a connection.
  9662. It is done this way so that all user-defined functions will access the database using the same encoding scheme
  9663. as the connection (UTF-8 or UTF-16).
  9664. </summary>
  9665. <remarks>
  9666. The wrapper functions that interop with SQLite will create a unique cookie value, which internally is a pointer to
  9667. all the wrapped callback functions. The interop function uses it to map CDecl callbacks to StdCall callbacks.
  9668. </remarks>
  9669. <param name="sqlbase">The base object on which the functions are to bind.</param>
  9670. <param name="flags">The flags associated with the parent connection object.</param>
  9671. <returns>Returns a logical list of functions which the connection should retain until it is closed.</returns>
  9672. </member>
  9673. <member name="M:System.Data.SQLite.SQLiteFunction.UnbindAllFunctions(System.Data.SQLite.SQLiteBase,System.Data.SQLite.SQLiteConnectionFlags,System.Boolean)">
  9674. <summary>
  9675. Called by the SQLiteBase derived classes, this method unbinds all registered (known)
  9676. functions -OR- all previously bound user-defined functions from a connection.
  9677. </summary>
  9678. <param name="sqlbase">The base object from which the functions are to be unbound.</param>
  9679. <param name="flags">The flags associated with the parent connection object.</param>
  9680. <param name="registered">
  9681. Non-zero to unbind all registered (known) functions -OR- zero to unbind all functions
  9682. currently bound to the connection.
  9683. </param>
  9684. <returns>Non-zero if all the specified user-defined functions were unbound.</returns>
  9685. </member>
  9686. <member name="M:System.Data.SQLite.SQLiteFunction.BindFunction(System.Data.SQLite.SQLiteBase,System.Data.SQLite.SQLiteFunctionAttribute,System.Data.SQLite.SQLiteFunction,System.Data.SQLite.SQLiteConnectionFlags)">
  9687. <summary>
  9688. This function binds a user-defined function to a connection.
  9689. </summary>
  9690. <param name="sqliteBase">
  9691. The <see cref="T:System.Data.SQLite.SQLiteBase"/> object instance associated with the
  9692. <see cref="T:System.Data.SQLite.SQLiteConnection"/> that the function should be bound to.
  9693. </param>
  9694. <param name="functionAttribute">
  9695. The <see cref="T:System.Data.SQLite.SQLiteFunctionAttribute"/> object instance containing
  9696. the metadata for the function to be bound.
  9697. </param>
  9698. <param name="function">
  9699. The <see cref="T:System.Data.SQLite.SQLiteFunction"/> object instance that implements the
  9700. function to be bound.
  9701. </param>
  9702. <param name="flags">
  9703. The flags associated with the parent connection object.
  9704. </param>
  9705. </member>
  9706. <member name="M:System.Data.SQLite.SQLiteFunction.UnbindFunction(System.Data.SQLite.SQLiteBase,System.Data.SQLite.SQLiteFunctionAttribute,System.Data.SQLite.SQLiteFunction,System.Data.SQLite.SQLiteConnectionFlags)">
  9707. <summary>
  9708. This function unbinds a user-defined functions from a connection.
  9709. </summary>
  9710. <param name="sqliteBase">
  9711. The <see cref="T:System.Data.SQLite.SQLiteBase"/> object instance associated with the
  9712. <see cref="T:System.Data.SQLite.SQLiteConnection"/> that the function should be bound to.
  9713. </param>
  9714. <param name="functionAttribute">
  9715. The <see cref="T:System.Data.SQLite.SQLiteFunctionAttribute"/> object instance containing
  9716. the metadata for the function to be bound.
  9717. </param>
  9718. <param name="function">
  9719. The <see cref="T:System.Data.SQLite.SQLiteFunction"/> object instance that implements the
  9720. function to be bound.
  9721. </param>
  9722. <param name="flags">
  9723. The flags associated with the parent connection object.
  9724. </param>
  9725. <returns>Non-zero if the function was unbound.</returns>
  9726. </member>
  9727. <member name="P:System.Data.SQLite.SQLiteFunction.SQLiteConvert">
  9728. <summary>
  9729. Returns a reference to the underlying connection's SQLiteConvert class, which can be used to convert
  9730. strings and DateTime's into the current connection's encoding schema.
  9731. </summary>
  9732. </member>
  9733. <member name="T:System.Data.SQLite.SQLiteInvokeDelegate">
  9734. <summary>
  9735. This <see cref="T:System.Delegate"/> type is used with the
  9736. <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Invoke(System.Object[])"/> method.
  9737. </summary>
  9738. <param name="param0">
  9739. This is always the string literal "Invoke".
  9740. </param>
  9741. <param name="args">
  9742. The arguments for the scalar function.
  9743. </param>
  9744. <returns>
  9745. The result of the scalar function.
  9746. </returns>
  9747. </member>
  9748. <member name="T:System.Data.SQLite.SQLiteStepDelegate">
  9749. <summary>
  9750. This <see cref="T:System.Delegate"/> type is used with the
  9751. <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Step(System.Object[],System.Int32,System.Object@)"/> method.
  9752. </summary>
  9753. <param name="param0">
  9754. This is always the string literal "Step".
  9755. </param>
  9756. <param name="args">
  9757. The arguments for the aggregate function.
  9758. </param>
  9759. <param name="stepNumber">
  9760. The step number (one based). This is incrememted each time the
  9761. <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Step(System.Object[],System.Int32,System.Object@)"/> method is called.
  9762. </param>
  9763. <param name="contextData">
  9764. A placeholder for implementers to store contextual data pertaining
  9765. to the current context.
  9766. </param>
  9767. </member>
  9768. <member name="T:System.Data.SQLite.SQLiteFinalDelegate">
  9769. <summary>
  9770. This <see cref="T:System.Delegate"/> type is used with the
  9771. <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Final(System.Object)"/> method.
  9772. </summary>
  9773. <param name="param0">
  9774. This is always the string literal "Final".
  9775. </param>
  9776. <param name="contextData">
  9777. A placeholder for implementers to store contextual data pertaining
  9778. to the current context.
  9779. </param>
  9780. <returns>
  9781. The result of the aggregate function.
  9782. </returns>
  9783. </member>
  9784. <member name="T:System.Data.SQLite.SQLiteCompareDelegate">
  9785. <summary>
  9786. This <see cref="T:System.Delegate"/> type is used with the
  9787. <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Compare(System.String,System.String)"/> method.
  9788. </summary>
  9789. <param name="param0">
  9790. This is always the string literal "Compare".
  9791. </param>
  9792. <param name="param1">
  9793. The first string to compare.
  9794. </param>
  9795. <param name="param2">
  9796. The second strnig to compare.
  9797. </param>
  9798. <returns>
  9799. A positive integer if the <paramref name="param1"/> parameter is
  9800. greater than the <paramref name="param2"/> parameter, a negative
  9801. integer if the <paramref name="param1"/> parameter is less than
  9802. the <paramref name="param2"/> parameter, or zero if they are
  9803. equal.
  9804. </returns>
  9805. </member>
  9806. <member name="T:System.Data.SQLite.SQLiteDelegateFunction">
  9807. <summary>
  9808. This class implements a SQLite function using a <see cref="T:System.Delegate"/>.
  9809. All the virtual methods of the <see cref="T:System.Data.SQLite.SQLiteFunction"/> class are
  9810. implemented using calls to the <see cref="T:System.Data.SQLite.SQLiteInvokeDelegate"/>,
  9811. <see cref="T:System.Data.SQLite.SQLiteStepDelegate"/>, <see cref="T:System.Data.SQLite.SQLiteFinalDelegate"/>,
  9812. and <see cref="T:System.Data.SQLite.SQLiteCompareDelegate"/> strongly typed delegate types
  9813. or via the <see cref="M:System.Delegate.DynamicInvoke(System.Object[])"/> method.
  9814. The arguments are presented in the same order they appear in
  9815. the associated <see cref="T:System.Data.SQLite.SQLiteFunction"/> methods with one exception:
  9816. the first argument is the name of the virtual method being implemented.
  9817. </summary>
  9818. </member>
  9819. <member name="F:System.Data.SQLite.SQLiteDelegateFunction.NoCallbackError">
  9820. <summary>
  9821. This error message is used by the overridden virtual methods when
  9822. a required <see cref="T:System.Delegate"/> property (e.g.
  9823. <see cref="P:System.Data.SQLite.SQLiteDelegateFunction.Callback1"/> or <see cref="P:System.Data.SQLite.SQLiteDelegateFunction.Callback2"/>) has not been
  9824. set.
  9825. </summary>
  9826. </member>
  9827. <member name="F:System.Data.SQLite.SQLiteDelegateFunction.ResultInt32Error">
  9828. <summary>
  9829. This error message is used by the overridden <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Compare(System.String,System.String)"/>
  9830. method when the result does not have a type of <see cref="T:System.Int32"/>.
  9831. </summary>
  9832. </member>
  9833. <member name="M:System.Data.SQLite.SQLiteDelegateFunction.#ctor">
  9834. <summary>
  9835. Constructs an empty instance of this class.
  9836. </summary>
  9837. </member>
  9838. <member name="M:System.Data.SQLite.SQLiteDelegateFunction.#ctor(System.Delegate,System.Delegate)">
  9839. <summary>
  9840. Constructs an instance of this class using the specified
  9841. <see cref="T:System.Delegate"/> as the <see cref="T:System.Data.SQLite.SQLiteFunction"/>
  9842. implementation.
  9843. </summary>
  9844. <param name="callback1">
  9845. The <see cref="T:System.Delegate"/> to be used for all calls into the
  9846. <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Invoke(System.Object[])"/>, <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Step(System.Object[],System.Int32,System.Object@)"/>, and
  9847. <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Compare(System.String,System.String)"/> virtual methods needed by the
  9848. <see cref="T:System.Data.SQLite.SQLiteFunction"/> base class.
  9849. </param>
  9850. <param name="callback2">
  9851. The <see cref="T:System.Delegate"/> to be used for all calls into the
  9852. <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Final(System.Object)"/> virtual methods needed by the
  9853. <see cref="T:System.Data.SQLite.SQLiteFunction"/> base class.
  9854. </param>
  9855. </member>
  9856. <member name="M:System.Data.SQLite.SQLiteDelegateFunction.GetInvokeArgs(System.Object[],System.Boolean)">
  9857. <summary>
  9858. Returns the list of arguments for the <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Invoke(System.Object[])"/> method,
  9859. as an <see cref="T:System.Array"/> of <see cref="T:System.Object"/>. The first
  9860. argument is always the literal string "Invoke".
  9861. </summary>
  9862. <param name="args">
  9863. The original arguments received by the <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Invoke(System.Object[])"/> method.
  9864. </param>
  9865. <param name="earlyBound">
  9866. Non-zero if the returned arguments are going to be used with the
  9867. <see cref="T:System.Data.SQLite.SQLiteInvokeDelegate"/> type; otherwise, zero.
  9868. </param>
  9869. <returns>
  9870. The arguments to pass to the configured <see cref="T:System.Delegate"/>.
  9871. </returns>
  9872. </member>
  9873. <member name="M:System.Data.SQLite.SQLiteDelegateFunction.GetStepArgs(System.Object[],System.Int32,System.Object,System.Boolean)">
  9874. <summary>
  9875. Returns the list of arguments for the <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Step(System.Object[],System.Int32,System.Object@)"/> method,
  9876. as an <see cref="T:System.Array"/> of <see cref="T:System.Object"/>. The first
  9877. argument is always the literal string "Step".
  9878. </summary>
  9879. <param name="args">
  9880. The original arguments received by the <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Step(System.Object[],System.Int32,System.Object@)"/> method.
  9881. </param>
  9882. <param name="stepNumber">
  9883. The step number (one based). This is incrememted each time the
  9884. <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Step(System.Object[],System.Int32,System.Object@)"/> method is called.
  9885. </param>
  9886. <param name="contextData">
  9887. A placeholder for implementers to store contextual data pertaining
  9888. to the current context.
  9889. </param>
  9890. <param name="earlyBound">
  9891. Non-zero if the returned arguments are going to be used with the
  9892. <see cref="T:System.Data.SQLite.SQLiteStepDelegate"/> type; otherwise, zero.
  9893. </param>
  9894. <returns>
  9895. The arguments to pass to the configured <see cref="T:System.Delegate"/>.
  9896. </returns>
  9897. </member>
  9898. <member name="M:System.Data.SQLite.SQLiteDelegateFunction.UpdateStepArgs(System.Object[],System.Object@,System.Boolean)">
  9899. <summary>
  9900. Updates the output arguments for the <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Step(System.Object[],System.Int32,System.Object@)"/> method,
  9901. using an <see cref="T:System.Array"/> of <see cref="T:System.Object"/>. The first
  9902. argument is always the literal string "Step". Currently, only the
  9903. <paramref name="contextData"/> parameter is updated.
  9904. </summary>
  9905. <param name="args">
  9906. The original arguments received by the <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Step(System.Object[],System.Int32,System.Object@)"/> method.
  9907. </param>
  9908. <param name="contextData">
  9909. A placeholder for implementers to store contextual data pertaining
  9910. to the current context.
  9911. </param>
  9912. <param name="earlyBound">
  9913. Non-zero if the returned arguments are going to be used with the
  9914. <see cref="T:System.Data.SQLite.SQLiteStepDelegate"/> type; otherwise, zero.
  9915. </param>
  9916. <returns>
  9917. The arguments to pass to the configured <see cref="T:System.Delegate"/>.
  9918. </returns>
  9919. </member>
  9920. <member name="M:System.Data.SQLite.SQLiteDelegateFunction.GetFinalArgs(System.Object,System.Boolean)">
  9921. <summary>
  9922. Returns the list of arguments for the <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Final(System.Object)"/> method,
  9923. as an <see cref="T:System.Array"/> of <see cref="T:System.Object"/>. The first
  9924. argument is always the literal string "Final".
  9925. </summary>
  9926. <param name="contextData">
  9927. A placeholder for implementers to store contextual data pertaining
  9928. to the current context.
  9929. </param>
  9930. <param name="earlyBound">
  9931. Non-zero if the returned arguments are going to be used with the
  9932. <see cref="T:System.Data.SQLite.SQLiteFinalDelegate"/> type; otherwise, zero.
  9933. </param>
  9934. <returns>
  9935. The arguments to pass to the configured <see cref="T:System.Delegate"/>.
  9936. </returns>
  9937. </member>
  9938. <member name="M:System.Data.SQLite.SQLiteDelegateFunction.GetCompareArgs(System.String,System.String,System.Boolean)">
  9939. <summary>
  9940. Returns the list of arguments for the <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Compare(System.String,System.String)"/> method,
  9941. as an <see cref="T:System.Array"/> of <see cref="T:System.Object"/>. The first
  9942. argument is always the literal string "Compare".
  9943. </summary>
  9944. <param name="param1">
  9945. The first string to compare.
  9946. </param>
  9947. <param name="param2">
  9948. The second strnig to compare.
  9949. </param>
  9950. <param name="earlyBound">
  9951. Non-zero if the returned arguments are going to be used with the
  9952. <see cref="T:System.Data.SQLite.SQLiteCompareDelegate"/> type; otherwise, zero.
  9953. </param>
  9954. <returns>
  9955. The arguments to pass to the configured <see cref="T:System.Delegate"/>.
  9956. </returns>
  9957. </member>
  9958. <member name="M:System.Data.SQLite.SQLiteDelegateFunction.Invoke(System.Object[])">
  9959. <summary>
  9960. This virtual method is the implementation for scalar functions.
  9961. See the <see cref="M:System.Data.SQLite.SQLiteFunction.Invoke(System.Object[])"/> method for more
  9962. details.
  9963. </summary>
  9964. <param name="args">
  9965. The arguments for the scalar function.
  9966. </param>
  9967. <returns>
  9968. The result of the scalar function.
  9969. </returns>
  9970. </member>
  9971. <member name="M:System.Data.SQLite.SQLiteDelegateFunction.Step(System.Object[],System.Int32,System.Object@)">
  9972. <summary>
  9973. This virtual method is part of the implementation for aggregate
  9974. functions. See the <see cref="M:System.Data.SQLite.SQLiteFunction.Step(System.Object[],System.Int32,System.Object@)"/> method
  9975. for more details.
  9976. </summary>
  9977. <param name="args">
  9978. The arguments for the aggregate function.
  9979. </param>
  9980. <param name="stepNumber">
  9981. The step number (one based). This is incrememted each time the
  9982. <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Step(System.Object[],System.Int32,System.Object@)"/> method is called.
  9983. </param>
  9984. <param name="contextData">
  9985. A placeholder for implementers to store contextual data pertaining
  9986. to the current context.
  9987. </param>
  9988. </member>
  9989. <member name="M:System.Data.SQLite.SQLiteDelegateFunction.Final(System.Object)">
  9990. <summary>
  9991. This virtual method is part of the implementation for aggregate
  9992. functions. See the <see cref="M:System.Data.SQLite.SQLiteFunction.Final(System.Object)"/> method
  9993. for more details.
  9994. </summary>
  9995. <param name="contextData">
  9996. A placeholder for implementers to store contextual data pertaining
  9997. to the current context.
  9998. </param>
  9999. <returns>
  10000. The result of the aggregate function.
  10001. </returns>
  10002. </member>
  10003. <member name="M:System.Data.SQLite.SQLiteDelegateFunction.Compare(System.String,System.String)">
  10004. <summary>
  10005. This virtual method is part of the implementation for collating
  10006. sequences. See the <see cref="M:System.Data.SQLite.SQLiteFunction.Compare(System.String,System.String)"/> method
  10007. for more details.
  10008. </summary>
  10009. <param name="param1">
  10010. The first string to compare.
  10011. </param>
  10012. <param name="param2">
  10013. The second strnig to compare.
  10014. </param>
  10015. <returns>
  10016. A positive integer if the <paramref name="param1"/> parameter is
  10017. greater than the <paramref name="param2"/> parameter, a negative
  10018. integer if the <paramref name="param1"/> parameter is less than
  10019. the <paramref name="param2"/> parameter, or zero if they are
  10020. equal.
  10021. </returns>
  10022. </member>
  10023. <member name="P:System.Data.SQLite.SQLiteDelegateFunction.Callback1">
  10024. <summary>
  10025. The <see cref="T:System.Delegate"/> to be used for all calls into the
  10026. <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Invoke(System.Object[])"/>, <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Step(System.Object[],System.Int32,System.Object@)"/>, and
  10027. <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Compare(System.String,System.String)"/> virtual methods needed by the
  10028. <see cref="T:System.Data.SQLite.SQLiteFunction"/> base class.
  10029. </summary>
  10030. </member>
  10031. <member name="P:System.Data.SQLite.SQLiteDelegateFunction.Callback2">
  10032. <summary>
  10033. The <see cref="T:System.Delegate"/> to be used for all calls into the
  10034. <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Final(System.Object)"/> virtual methods needed by the
  10035. <see cref="T:System.Data.SQLite.SQLiteFunction"/> base class.
  10036. </summary>
  10037. </member>
  10038. <member name="T:System.Data.SQLite.SQLiteFunctionEx">
  10039. <summary>
  10040. Extends SQLiteFunction and allows an inherited class to obtain the collating sequence associated with a function call.
  10041. </summary>
  10042. <remarks>
  10043. User-defined functions can call the GetCollationSequence() method in this class and use it to compare strings and char arrays.
  10044. </remarks>
  10045. </member>
  10046. <member name="M:System.Data.SQLite.SQLiteFunctionEx.GetCollationSequence">
  10047. <summary>
  10048. Obtains the collating sequence in effect for the given function.
  10049. </summary>
  10050. <returns></returns>
  10051. </member>
  10052. <member name="M:System.Data.SQLite.SQLiteFunctionEx.Dispose(System.Boolean)">
  10053. <summary>
  10054. Cleans up resources (native and managed) associated with the current instance.
  10055. </summary>
  10056. <param name="disposing">
  10057. Zero when being disposed via garbage collection; otherwise, non-zero.
  10058. </param>
  10059. </member>
  10060. <member name="T:System.Data.SQLite.FunctionType">
  10061. <summary>
  10062. The type of user-defined function to declare
  10063. </summary>
  10064. </member>
  10065. <member name="F:System.Data.SQLite.FunctionType.Scalar">
  10066. <summary>
  10067. Scalar functions are designed to be called and return a result immediately. Examples include ABS(), Upper(), Lower(), etc.
  10068. </summary>
  10069. </member>
  10070. <member name="F:System.Data.SQLite.FunctionType.Aggregate">
  10071. <summary>
  10072. Aggregate functions are designed to accumulate data until the end of a call and then return a result gleaned from the accumulated data.
  10073. Examples include SUM(), COUNT(), AVG(), etc.
  10074. </summary>
  10075. </member>
  10076. <member name="F:System.Data.SQLite.FunctionType.Collation">
  10077. <summary>
  10078. Collating sequences are used to sort textual data in a custom manner, and appear in an ORDER BY clause. Typically text in an ORDER BY is
  10079. sorted using a straight case-insensitive comparison function. Custom collating sequences can be used to alter the behavior of text sorting
  10080. in a user-defined manner.
  10081. </summary>
  10082. </member>
  10083. <member name="T:System.Data.SQLite.SQLiteCallback">
  10084. <summary>
  10085. An internal callback delegate declaration.
  10086. </summary>
  10087. <param name="context">Raw native context pointer for the user function.</param>
  10088. <param name="argc">Total number of arguments to the user function.</param>
  10089. <param name="argv">Raw native pointer to the array of raw native argument pointers.</param>
  10090. </member>
  10091. <member name="T:System.Data.SQLite.SQLiteFinalCallback">
  10092. <summary>
  10093. An internal final callback delegate declaration.
  10094. </summary>
  10095. <param name="context">Raw context pointer for the user function</param>
  10096. </member>
  10097. <member name="T:System.Data.SQLite.SQLiteCollation">
  10098. <summary>
  10099. Internal callback delegate for implementing collating sequences
  10100. </summary>
  10101. <param name="puser">Not used</param>
  10102. <param name="len1">Length of the string pv1</param>
  10103. <param name="pv1">Pointer to the first string to compare</param>
  10104. <param name="len2">Length of the string pv2</param>
  10105. <param name="pv2">Pointer to the second string to compare</param>
  10106. <returns>Returns -1 if the first string is less than the second. 0 if they are equal, or 1 if the first string is greater
  10107. than the second.</returns>
  10108. </member>
  10109. <member name="T:System.Data.SQLite.CollationTypeEnum">
  10110. <summary>
  10111. The type of collating sequence
  10112. </summary>
  10113. </member>
  10114. <member name="F:System.Data.SQLite.CollationTypeEnum.Binary">
  10115. <summary>
  10116. The built-in BINARY collating sequence
  10117. </summary>
  10118. </member>
  10119. <member name="F:System.Data.SQLite.CollationTypeEnum.NoCase">
  10120. <summary>
  10121. The built-in NOCASE collating sequence
  10122. </summary>
  10123. </member>
  10124. <member name="F:System.Data.SQLite.CollationTypeEnum.Reverse">
  10125. <summary>
  10126. The built-in REVERSE collating sequence
  10127. </summary>
  10128. </member>
  10129. <member name="F:System.Data.SQLite.CollationTypeEnum.Custom">
  10130. <summary>
  10131. A custom user-defined collating sequence
  10132. </summary>
  10133. </member>
  10134. <member name="T:System.Data.SQLite.CollationEncodingEnum">
  10135. <summary>
  10136. The encoding type the collation sequence uses
  10137. </summary>
  10138. </member>
  10139. <member name="F:System.Data.SQLite.CollationEncodingEnum.UTF8">
  10140. <summary>
  10141. The collation sequence is UTF8
  10142. </summary>
  10143. </member>
  10144. <member name="F:System.Data.SQLite.CollationEncodingEnum.UTF16LE">
  10145. <summary>
  10146. The collation sequence is UTF16 little-endian
  10147. </summary>
  10148. </member>
  10149. <member name="F:System.Data.SQLite.CollationEncodingEnum.UTF16BE">
  10150. <summary>
  10151. The collation sequence is UTF16 big-endian
  10152. </summary>
  10153. </member>
  10154. <member name="T:System.Data.SQLite.CollationSequence">
  10155. <summary>
  10156. A struct describing the collating sequence a function is executing in
  10157. </summary>
  10158. </member>
  10159. <member name="F:System.Data.SQLite.CollationSequence.Name">
  10160. <summary>
  10161. The name of the collating sequence
  10162. </summary>
  10163. </member>
  10164. <member name="F:System.Data.SQLite.CollationSequence.Type">
  10165. <summary>
  10166. The type of collating sequence
  10167. </summary>
  10168. </member>
  10169. <member name="F:System.Data.SQLite.CollationSequence.Encoding">
  10170. <summary>
  10171. The text encoding of the collation sequence
  10172. </summary>
  10173. </member>
  10174. <member name="F:System.Data.SQLite.CollationSequence._func">
  10175. <summary>
  10176. Context of the function that requested the collating sequence
  10177. </summary>
  10178. </member>
  10179. <member name="M:System.Data.SQLite.CollationSequence.Compare(System.String,System.String)">
  10180. <summary>
  10181. Calls the base collating sequence to compare two strings
  10182. </summary>
  10183. <param name="s1">The first string to compare</param>
  10184. <param name="s2">The second string to compare</param>
  10185. <returns>-1 if s1 is less than s2, 0 if s1 is equal to s2, and 1 if s1 is greater than s2</returns>
  10186. </member>
  10187. <member name="M:System.Data.SQLite.CollationSequence.Compare(System.Char[],System.Char[])">
  10188. <summary>
  10189. Calls the base collating sequence to compare two character arrays
  10190. </summary>
  10191. <param name="c1">The first array to compare</param>
  10192. <param name="c2">The second array to compare</param>
  10193. <returns>-1 if c1 is less than c2, 0 if c1 is equal to c2, and 1 if c1 is greater than c2</returns>
  10194. </member>
  10195. <member name="T:System.Data.SQLite.SQLiteFunctionAttribute">
  10196. <summary>
  10197. A simple custom attribute to enable us to easily find user-defined functions in
  10198. the loaded assemblies and initialize them in SQLite as connections are made.
  10199. </summary>
  10200. </member>
  10201. <member name="M:System.Data.SQLite.SQLiteFunctionAttribute.#ctor">
  10202. <summary>
  10203. Default constructor, initializes the internal variables for the function.
  10204. </summary>
  10205. </member>
  10206. <member name="M:System.Data.SQLite.SQLiteFunctionAttribute.#ctor(System.String,System.Int32,System.Data.SQLite.FunctionType)">
  10207. <summary>
  10208. Constructs an instance of this class. This sets the initial
  10209. <see cref="P:System.Data.SQLite.SQLiteFunctionAttribute.InstanceType"/>, <see cref="P:System.Data.SQLite.SQLiteFunctionAttribute.Callback1"/>, and
  10210. <see cref="P:System.Data.SQLite.SQLiteFunctionAttribute.Callback2"/> properties to null.
  10211. </summary>
  10212. <param name="name">
  10213. The name of the function, as seen by the SQLite core library.
  10214. </param>
  10215. <param name="argumentCount">
  10216. The number of arguments that the function will accept.
  10217. </param>
  10218. <param name="functionType">
  10219. The type of function being declared. This will either be Scalar,
  10220. Aggregate, or Collation.
  10221. </param>
  10222. </member>
  10223. <member name="P:System.Data.SQLite.SQLiteFunctionAttribute.Name">
  10224. <summary>
  10225. The function's name as it will be used in SQLite command text.
  10226. </summary>
  10227. </member>
  10228. <member name="P:System.Data.SQLite.SQLiteFunctionAttribute.Arguments">
  10229. <summary>
  10230. The number of arguments this function expects. -1 if the number of arguments is variable.
  10231. </summary>
  10232. </member>
  10233. <member name="P:System.Data.SQLite.SQLiteFunctionAttribute.FuncType">
  10234. <summary>
  10235. The type of function this implementation will be.
  10236. </summary>
  10237. </member>
  10238. <member name="P:System.Data.SQLite.SQLiteFunctionAttribute.InstanceType">
  10239. <summary>
  10240. The <see cref="T:System.Type"/> object instance that describes the class
  10241. containing the implementation for the associated function. The value of
  10242. this property will not be used if either the <see cref="P:System.Data.SQLite.SQLiteFunctionAttribute.Callback1"/> or
  10243. <see cref="P:System.Data.SQLite.SQLiteFunctionAttribute.Callback2"/> property values are set to non-null.
  10244. </summary>
  10245. </member>
  10246. <member name="P:System.Data.SQLite.SQLiteFunctionAttribute.Callback1">
  10247. <summary>
  10248. The <see cref="T:System.Delegate"/> that refers to the implementation for the
  10249. associated function. If this property value is set to non-null, it will
  10250. be used instead of the <see cref="P:System.Data.SQLite.SQLiteFunctionAttribute.InstanceType"/> property value.
  10251. </summary>
  10252. </member>
  10253. <member name="P:System.Data.SQLite.SQLiteFunctionAttribute.Callback2">
  10254. <summary>
  10255. The <see cref="T:System.Delegate"/> that refers to the implementation for the
  10256. associated function. If this property value is set to non-null, it will
  10257. be used instead of the <see cref="P:System.Data.SQLite.SQLiteFunctionAttribute.InstanceType"/> property value.
  10258. </summary>
  10259. </member>
  10260. <member name="T:System.Data.SQLite.SQLiteKeyReader">
  10261. <summary>
  10262. This class provides key info for a given SQLite statement.
  10263. <remarks>
  10264. Providing key information for a given statement is non-trivial :(
  10265. </remarks>
  10266. </summary>
  10267. </member>
  10268. <member name="M:System.Data.SQLite.SQLiteKeyReader.#ctor(System.Data.SQLite.SQLiteConnection,System.Data.SQLite.SQLiteDataReader,System.Data.SQLite.SQLiteStatement)">
  10269. <summary>
  10270. This function does all the nasty work at determining what keys need to be returned for
  10271. a given statement.
  10272. </summary>
  10273. <param name="cnn"></param>
  10274. <param name="reader"></param>
  10275. <param name="stmt"></param>
  10276. </member>
  10277. <member name="M:System.Data.SQLite.SQLiteKeyReader.Sync">
  10278. <summary>
  10279. Make sure all the subqueries are open and ready and sync'd with the current rowid
  10280. of the table they're supporting
  10281. </summary>
  10282. </member>
  10283. <member name="M:System.Data.SQLite.SQLiteKeyReader.Reset">
  10284. <summary>
  10285. Release any readers on any subqueries
  10286. </summary>
  10287. </member>
  10288. <member name="M:System.Data.SQLite.SQLiteKeyReader.AppendSchemaTable(System.Data.DataTable)">
  10289. <summary>
  10290. Append all the columns we've added to the original query to the schema
  10291. </summary>
  10292. <param name="tbl"></param>
  10293. </member>
  10294. <member name="P:System.Data.SQLite.SQLiteKeyReader.Count">
  10295. <summary>
  10296. How many additional columns of keyinfo we're holding
  10297. </summary>
  10298. </member>
  10299. <member name="T:System.Data.SQLite.SQLiteKeyReader.KeyInfo">
  10300. <summary>
  10301. Used to support CommandBehavior.KeyInfo
  10302. </summary>
  10303. </member>
  10304. <member name="T:System.Data.SQLite.SQLiteKeyReader.RowIdInfo">
  10305. <summary>
  10306. Used to keep track of the per-table RowId column metadata.
  10307. </summary>
  10308. </member>
  10309. <member name="T:System.Data.SQLite.SQLiteKeyReader.KeyQuery">
  10310. <summary>
  10311. A single sub-query for a given table/database.
  10312. </summary>
  10313. </member>
  10314. <member name="T:System.Data.SQLite.LogEventArgs">
  10315. <summary>
  10316. Event data for logging event handlers.
  10317. </summary>
  10318. </member>
  10319. <member name="F:System.Data.SQLite.LogEventArgs.ErrorCode">
  10320. <summary>
  10321. The error code. The type of this object value should be
  10322. <see cref="T:System.Int32"/> or <see cref="T:System.Data.SQLite.SQLiteErrorCode"/>.
  10323. </summary>
  10324. </member>
  10325. <member name="F:System.Data.SQLite.LogEventArgs.Message">
  10326. <summary>
  10327. SQL statement text as the statement first begins executing
  10328. </summary>
  10329. </member>
  10330. <member name="F:System.Data.SQLite.LogEventArgs.Data">
  10331. <summary>
  10332. Extra data associated with this event, if any.
  10333. </summary>
  10334. </member>
  10335. <member name="M:System.Data.SQLite.LogEventArgs.#ctor(System.IntPtr,System.Object,System.String,System.Object)">
  10336. <summary>
  10337. Constructs the object.
  10338. </summary>
  10339. <param name="pUserData">Should be null.</param>
  10340. <param name="errorCode">
  10341. The error code. The type of this object value should be
  10342. <see cref="T:System.Int32"/> or <see cref="T:System.Data.SQLite.SQLiteErrorCode"/>.
  10343. </param>
  10344. <param name="message">The error message, if any.</param>
  10345. <param name="data">The extra data, if any.</param>
  10346. </member>
  10347. <member name="T:System.Data.SQLite.SQLiteLogEventHandler">
  10348. <summary>
  10349. Raised when a log event occurs.
  10350. </summary>
  10351. <param name="sender">The current connection</param>
  10352. <param name="e">Event arguments of the trace</param>
  10353. </member>
  10354. <member name="T:System.Data.SQLite.SQLiteLog">
  10355. <summary>
  10356. Manages the SQLite custom logging functionality and the associated
  10357. callback for the whole process.
  10358. </summary>
  10359. </member>
  10360. <member name="F:System.Data.SQLite.SQLiteLog._initializeTimeout">
  10361. <summary>
  10362. Maximum number of milliseconds a non-primary thread should wait
  10363. for the <see cref="M:System.Data.SQLite.SQLiteLog.PrivateInitialize(System.String)"/> method to be completed.
  10364. </summary>
  10365. </member>
  10366. <member name="F:System.Data.SQLite.SQLiteLog.syncRoot">
  10367. <summary>
  10368. Object used to synchronize access to the static instance data
  10369. for this class.
  10370. </summary>
  10371. </member>
  10372. <member name="F:System.Data.SQLite.SQLiteLog._initializeEvent">
  10373. <summary>
  10374. This will be signaled when the <see cref="M:System.Data.SQLite.SQLiteLog.PrivateInitialize(System.String)"/>
  10375. method has been completed.
  10376. </summary>
  10377. </member>
  10378. <member name="F:System.Data.SQLite.SQLiteLog._domainUnload">
  10379. <summary>
  10380. Member variable to store the AppDomain.DomainUnload event handler.
  10381. </summary>
  10382. </member>
  10383. <member name="F:System.Data.SQLite.SQLiteLog._defaultHandler">
  10384. <summary>
  10385. The default log event handler.
  10386. </summary>
  10387. </member>
  10388. <member name="F:System.Data.SQLite.SQLiteLog._callback">
  10389. <summary>
  10390. The log callback passed to native SQLite engine. This must live
  10391. as long as the SQLite library has a pointer to it.
  10392. </summary>
  10393. </member>
  10394. <member name="F:System.Data.SQLite.SQLiteLog._sql">
  10395. <summary>
  10396. The base SQLite object to interop with.
  10397. </summary>
  10398. </member>
  10399. <member name="F:System.Data.SQLite.SQLiteLog._initializeCallCount">
  10400. <summary>
  10401. The number of times that the <see cref="M:System.Data.SQLite.SQLiteLog.Initialize(System.String)"/>
  10402. method has been called when the logging subystem was actually
  10403. eligible to be initialized (i.e. without the "No_SQLiteLog"
  10404. environment variable being set).
  10405. </summary>
  10406. </member>
  10407. <member name="F:System.Data.SQLite.SQLiteLog._uninitializeCallCount">
  10408. <summary>
  10409. The number of times that the <see cref="M:System.Data.SQLite.SQLiteLog.Uninitialize"/> method
  10410. has been called.
  10411. </summary>
  10412. </member>
  10413. <member name="F:System.Data.SQLite.SQLiteLog._initializeDoneCount">
  10414. <summary>
  10415. The number of times that the <see cref="M:System.Data.SQLite.SQLiteLog.Initialize(System.String)"/>
  10416. method has been completed (i.e. without the "No_SQLiteLog"
  10417. environment variable being set).
  10418. </summary>
  10419. </member>
  10420. <member name="F:System.Data.SQLite.SQLiteLog._attemptedInitialize">
  10421. <summary>
  10422. This will be non-zero if an attempt was already made to initialize
  10423. the (managed) logging subsystem.
  10424. </summary>
  10425. </member>
  10426. <member name="F:System.Data.SQLite.SQLiteLog._enabled">
  10427. <summary>
  10428. This will be non-zero if logging is currently enabled.
  10429. </summary>
  10430. </member>
  10431. <member name="M:System.Data.SQLite.SQLiteLog.CreateAndOrGetTheEvent">
  10432. <summary>
  10433. Creates the <see cref="T:System.Threading.EventWaitHandle"/> that will be used to
  10434. signal completion of the <see cref="M:System.Data.SQLite.SQLiteLog.PrivateInitialize(System.String)"/> method,
  10435. if necessary, and then returns it.
  10436. </summary>
  10437. <returns>
  10438. The <see cref="T:System.Threading.EventWaitHandle"/> that will be used to signal
  10439. completion of the <see cref="M:System.Data.SQLite.SQLiteLog.PrivateInitialize(System.String)"/> method.
  10440. </returns>
  10441. </member>
  10442. <member name="M:System.Data.SQLite.SQLiteLog.Initialize">
  10443. <summary>
  10444. Initializes the SQLite logging facilities.
  10445. </summary>
  10446. </member>
  10447. <member name="M:System.Data.SQLite.SQLiteLog.Initialize(System.String)">
  10448. <summary>
  10449. Initializes the SQLite logging facilities -OR- waits for the
  10450. SQLite logging facilities to be initialized by another thread.
  10451. </summary>
  10452. <param name="className">
  10453. The name of the managed class that called this method. This
  10454. parameter may be null.
  10455. </param>
  10456. </member>
  10457. <member name="M:System.Data.SQLite.SQLiteLog.PrivateInitialize(System.String)">
  10458. <summary>
  10459. Initializes the SQLite logging facilities.
  10460. </summary>
  10461. <param name="className">
  10462. The name of the managed class that called this method. This
  10463. parameter may be null.
  10464. </param>
  10465. <returns>
  10466. Non-zero if everything was fully initialized successfully.
  10467. </returns>
  10468. </member>
  10469. <member name="M:System.Data.SQLite.SQLiteLog.Uninitialize">
  10470. <summary>
  10471. Uninitializes the SQLite logging facilities.
  10472. </summary>
  10473. </member>
  10474. <member name="M:System.Data.SQLite.SQLiteLog.Uninitialize(System.String,System.Boolean)">
  10475. <summary>
  10476. Uninitializes the SQLite logging facilities.
  10477. </summary>
  10478. <param name="className">
  10479. The name of the managed class that called this method. This
  10480. parameter may be null.
  10481. </param>
  10482. <param name="shutdown">
  10483. Non-zero if the native SQLite library should be shutdown prior
  10484. to attempting to unset its logging callback.
  10485. </param>
  10486. </member>
  10487. <member name="M:System.Data.SQLite.SQLiteLog.DomainUnload(System.Object,System.EventArgs)">
  10488. <summary>
  10489. Handles the AppDomain being unloaded.
  10490. </summary>
  10491. <param name="sender">Should be null.</param>
  10492. <param name="e">The data associated with this event.</param>
  10493. </member>
  10494. <member name="M:System.Data.SQLite.SQLiteLog.LogMessage(System.String)">
  10495. <summary>
  10496. Log a message to all the registered log event handlers without going
  10497. through the SQLite library.
  10498. </summary>
  10499. <param name="message">The message to be logged.</param>
  10500. </member>
  10501. <member name="M:System.Data.SQLite.SQLiteLog.LogMessage(System.Data.SQLite.SQLiteErrorCode,System.String)">
  10502. <summary>
  10503. Log a message to all the registered log event handlers without going
  10504. through the SQLite library.
  10505. </summary>
  10506. <param name="errorCode">The SQLite error code.</param>
  10507. <param name="message">The message to be logged.</param>
  10508. </member>
  10509. <member name="M:System.Data.SQLite.SQLiteLog.LogMessage(System.Int32,System.String)">
  10510. <summary>
  10511. Log a message to all the registered log event handlers without going
  10512. through the SQLite library.
  10513. </summary>
  10514. <param name="errorCode">The integer error code.</param>
  10515. <param name="message">The message to be logged.</param>
  10516. </member>
  10517. <member name="M:System.Data.SQLite.SQLiteLog.LogMessage(System.Object,System.String)">
  10518. <summary>
  10519. Log a message to all the registered log event handlers without going
  10520. through the SQLite library.
  10521. </summary>
  10522. <param name="errorCode">
  10523. The error code. The type of this object value should be
  10524. System.Int32 or SQLiteErrorCode.
  10525. </param>
  10526. <param name="message">The message to be logged.</param>
  10527. </member>
  10528. <member name="M:System.Data.SQLite.SQLiteLog.InitializeDefaultHandler">
  10529. <summary>
  10530. Creates and initializes the default log event handler.
  10531. </summary>
  10532. </member>
  10533. <member name="M:System.Data.SQLite.SQLiteLog.AddDefaultHandler">
  10534. <summary>
  10535. Adds the default log event handler to the list of handlers.
  10536. </summary>
  10537. </member>
  10538. <member name="M:System.Data.SQLite.SQLiteLog.RemoveDefaultHandler">
  10539. <summary>
  10540. Removes the default log event handler from the list of handlers.
  10541. </summary>
  10542. </member>
  10543. <member name="M:System.Data.SQLite.SQLiteLog.LogCallback(System.IntPtr,System.Int32,System.IntPtr)">
  10544. <summary>
  10545. Internal proxy function that calls any registered application log
  10546. event handlers.
  10547. WARNING: This method is used more-or-less directly by native code,
  10548. do not modify its type signature.
  10549. </summary>
  10550. <param name="pUserData">
  10551. The extra data associated with this message, if any.
  10552. </param>
  10553. <param name="errorCode">
  10554. The error code associated with this message.
  10555. </param>
  10556. <param name="pMessage">
  10557. The message string to be logged.
  10558. </param>
  10559. </member>
  10560. <member name="M:System.Data.SQLite.SQLiteLog.LogEventHandler(System.Object,System.Data.SQLite.LogEventArgs)">
  10561. <summary>
  10562. Default logger. Currently, uses the Trace class (i.e. sends events
  10563. to the current trace listeners, if any).
  10564. </summary>
  10565. <param name="sender">Should be null.</param>
  10566. <param name="e">The data associated with this event.</param>
  10567. </member>
  10568. <member name="E:System.Data.SQLite.SQLiteLog._handlers">
  10569. <summary>
  10570. Member variable to store the application log handler to call.
  10571. </summary>
  10572. </member>
  10573. <member name="E:System.Data.SQLite.SQLiteLog.Log">
  10574. <summary>
  10575. This event is raised whenever SQLite raises a logging event.
  10576. Note that this should be set as one of the first things in the
  10577. application.
  10578. </summary>
  10579. </member>
  10580. <member name="P:System.Data.SQLite.SQLiteLog.Enabled">
  10581. <summary>
  10582. If this property is true, logging is enabled; otherwise, logging is
  10583. disabled. When logging is disabled, no logging events will fire.
  10584. </summary>
  10585. </member>
  10586. <member name="P:System.Data.SQLite.SQLiteLog.InternalEnabled">
  10587. <summary>
  10588. If this property is true, logging is enabled; otherwise, logging is
  10589. disabled. When logging is disabled, no logging events will fire.
  10590. For internal use only.
  10591. </summary>
  10592. </member>
  10593. <member name="T:System.Data.SQLite.SQLiteMetaDataCollectionNames">
  10594. <summary>
  10595. MetaDataCollections specific to SQLite
  10596. </summary>
  10597. </member>
  10598. <member name="F:System.Data.SQLite.SQLiteMetaDataCollectionNames.Catalogs">
  10599. <summary>
  10600. Returns a list of databases attached to the connection
  10601. </summary>
  10602. </member>
  10603. <member name="F:System.Data.SQLite.SQLiteMetaDataCollectionNames.Columns">
  10604. <summary>
  10605. Returns column information for the specified table
  10606. </summary>
  10607. </member>
  10608. <member name="F:System.Data.SQLite.SQLiteMetaDataCollectionNames.Indexes">
  10609. <summary>
  10610. Returns index information for the optionally-specified table
  10611. </summary>
  10612. </member>
  10613. <member name="F:System.Data.SQLite.SQLiteMetaDataCollectionNames.IndexColumns">
  10614. <summary>
  10615. Returns base columns for the given index
  10616. </summary>
  10617. </member>
  10618. <member name="F:System.Data.SQLite.SQLiteMetaDataCollectionNames.Tables">
  10619. <summary>
  10620. Returns the tables in the given catalog
  10621. </summary>
  10622. </member>
  10623. <member name="F:System.Data.SQLite.SQLiteMetaDataCollectionNames.Views">
  10624. <summary>
  10625. Returns user-defined views in the given catalog
  10626. </summary>
  10627. </member>
  10628. <member name="F:System.Data.SQLite.SQLiteMetaDataCollectionNames.ViewColumns">
  10629. <summary>
  10630. Returns underlying column information on the given view
  10631. </summary>
  10632. </member>
  10633. <member name="F:System.Data.SQLite.SQLiteMetaDataCollectionNames.ForeignKeys">
  10634. <summary>
  10635. Returns foreign key information for the given catalog
  10636. </summary>
  10637. </member>
  10638. <member name="F:System.Data.SQLite.SQLiteMetaDataCollectionNames.Triggers">
  10639. <summary>
  10640. Returns the triggers on the database
  10641. </summary>
  10642. </member>
  10643. <member name="T:System.Data.SQLite.SQLiteParameter">
  10644. <summary>
  10645. SQLite implementation of DbParameter.
  10646. </summary>
  10647. </member>
  10648. <member name="F:System.Data.SQLite.SQLiteParameter.UnknownDbType">
  10649. <summary>
  10650. This value represents an "unknown" <see cref="P:System.Data.SQLite.SQLiteParameter.DbType"/>.
  10651. </summary>
  10652. </member>
  10653. <member name="F:System.Data.SQLite.SQLiteParameter._command">
  10654. <summary>
  10655. The command associated with this parameter.
  10656. </summary>
  10657. </member>
  10658. <member name="F:System.Data.SQLite.SQLiteParameter._dbType">
  10659. <summary>
  10660. The data type of the parameter
  10661. </summary>
  10662. </member>
  10663. <member name="F:System.Data.SQLite.SQLiteParameter._rowVersion">
  10664. <summary>
  10665. The version information for mapping the parameter
  10666. </summary>
  10667. </member>
  10668. <member name="F:System.Data.SQLite.SQLiteParameter._objValue">
  10669. <summary>
  10670. The value of the data in the parameter
  10671. </summary>
  10672. </member>
  10673. <member name="F:System.Data.SQLite.SQLiteParameter._sourceColumn">
  10674. <summary>
  10675. The source column for the parameter
  10676. </summary>
  10677. </member>
  10678. <member name="F:System.Data.SQLite.SQLiteParameter._parameterName">
  10679. <summary>
  10680. The column name
  10681. </summary>
  10682. </member>
  10683. <member name="F:System.Data.SQLite.SQLiteParameter._dataSize">
  10684. <summary>
  10685. The data size, unused by SQLite
  10686. </summary>
  10687. </member>
  10688. <member name="F:System.Data.SQLite.SQLiteParameter._typeName">
  10689. <summary>
  10690. The database type name associated with this parameter, if any.
  10691. </summary>
  10692. </member>
  10693. <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.Data.IDbCommand)">
  10694. <summary>
  10695. Constructor used when creating for use with a specific command.
  10696. </summary>
  10697. <param name="command">
  10698. The command associated with this parameter.
  10699. </param>
  10700. </member>
  10701. <member name="M:System.Data.SQLite.SQLiteParameter.#ctor">
  10702. <summary>
  10703. Default constructor
  10704. </summary>
  10705. </member>
  10706. <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.String)">
  10707. <summary>
  10708. Constructs a named parameter given the specified parameter name
  10709. </summary>
  10710. <param name="parameterName">The parameter name</param>
  10711. </member>
  10712. <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.String,System.Object)">
  10713. <summary>
  10714. Constructs a named parameter given the specified parameter name and initial value
  10715. </summary>
  10716. <param name="parameterName">The parameter name</param>
  10717. <param name="value">The initial value of the parameter</param>
  10718. </member>
  10719. <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.String,System.Data.DbType)">
  10720. <summary>
  10721. Constructs a named parameter of the specified type
  10722. </summary>
  10723. <param name="parameterName">The parameter name</param>
  10724. <param name="dbType">The datatype of the parameter</param>
  10725. </member>
  10726. <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.String,System.Data.DbType,System.String)">
  10727. <summary>
  10728. Constructs a named parameter of the specified type and source column reference
  10729. </summary>
  10730. <param name="parameterName">The parameter name</param>
  10731. <param name="dbType">The data type</param>
  10732. <param name="sourceColumn">The source column</param>
  10733. </member>
  10734. <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.String,System.Data.DbType,System.String,System.Data.DataRowVersion)">
  10735. <summary>
  10736. Constructs a named parameter of the specified type, source column and row version
  10737. </summary>
  10738. <param name="parameterName">The parameter name</param>
  10739. <param name="dbType">The data type</param>
  10740. <param name="sourceColumn">The source column</param>
  10741. <param name="rowVersion">The row version information</param>
  10742. </member>
  10743. <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.Data.DbType)">
  10744. <summary>
  10745. Constructs an unnamed parameter of the specified data type
  10746. </summary>
  10747. <param name="dbType">The datatype of the parameter</param>
  10748. </member>
  10749. <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.Data.DbType,System.Object)">
  10750. <summary>
  10751. Constructs an unnamed parameter of the specified data type and sets the initial value
  10752. </summary>
  10753. <param name="dbType">The datatype of the parameter</param>
  10754. <param name="value">The initial value of the parameter</param>
  10755. </member>
  10756. <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.Data.DbType,System.String)">
  10757. <summary>
  10758. Constructs an unnamed parameter of the specified data type and source column
  10759. </summary>
  10760. <param name="dbType">The datatype of the parameter</param>
  10761. <param name="sourceColumn">The source column</param>
  10762. </member>
  10763. <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.Data.DbType,System.String,System.Data.DataRowVersion)">
  10764. <summary>
  10765. Constructs an unnamed parameter of the specified data type, source column and row version
  10766. </summary>
  10767. <param name="dbType">The data type</param>
  10768. <param name="sourceColumn">The source column</param>
  10769. <param name="rowVersion">The row version information</param>
  10770. </member>
  10771. <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.String,System.Data.DbType,System.Int32)">
  10772. <summary>
  10773. Constructs a named parameter of the specified type and size
  10774. </summary>
  10775. <param name="parameterName">The parameter name</param>
  10776. <param name="parameterType">The data type</param>
  10777. <param name="parameterSize">The size of the parameter</param>
  10778. </member>
  10779. <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.String,System.Data.DbType,System.Int32,System.String)">
  10780. <summary>
  10781. Constructs a named parameter of the specified type, size and source column
  10782. </summary>
  10783. <param name="parameterName">The name of the parameter</param>
  10784. <param name="parameterType">The data type</param>
  10785. <param name="parameterSize">The size of the parameter</param>
  10786. <param name="sourceColumn">The source column</param>
  10787. </member>
  10788. <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.String,System.Data.DbType,System.Int32,System.String,System.Data.DataRowVersion)">
  10789. <summary>
  10790. Constructs a named parameter of the specified type, size, source column and row version
  10791. </summary>
  10792. <param name="parameterName">The name of the parameter</param>
  10793. <param name="parameterType">The data type</param>
  10794. <param name="parameterSize">The size of the parameter</param>
  10795. <param name="sourceColumn">The source column</param>
  10796. <param name="rowVersion">The row version information</param>
  10797. </member>
  10798. <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.String,System.Data.DbType,System.Int32,System.Data.ParameterDirection,System.Boolean,System.Byte,System.Byte,System.String,System.Data.DataRowVersion,System.Object)">
  10799. <summary>
  10800. Constructs a named parameter of the specified type, size, source column and row version
  10801. </summary>
  10802. <param name="parameterName">The name of the parameter</param>
  10803. <param name="parameterType">The data type</param>
  10804. <param name="parameterSize">The size of the parameter</param>
  10805. <param name="direction">Only input parameters are supported in SQLite</param>
  10806. <param name="isNullable">Ignored</param>
  10807. <param name="precision">Ignored</param>
  10808. <param name="scale">Ignored</param>
  10809. <param name="sourceColumn">The source column</param>
  10810. <param name="rowVersion">The row version information</param>
  10811. <param name="value">The initial value to assign the parameter</param>
  10812. </member>
  10813. <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.String,System.Data.DbType,System.Int32,System.Data.ParameterDirection,System.Byte,System.Byte,System.String,System.Data.DataRowVersion,System.Boolean,System.Object)">
  10814. <summary>
  10815. Constructs a named parameter, yet another flavor
  10816. </summary>
  10817. <param name="parameterName">The name of the parameter</param>
  10818. <param name="parameterType">The data type</param>
  10819. <param name="parameterSize">The size of the parameter</param>
  10820. <param name="direction">Only input parameters are supported in SQLite</param>
  10821. <param name="precision">Ignored</param>
  10822. <param name="scale">Ignored</param>
  10823. <param name="sourceColumn">The source column</param>
  10824. <param name="rowVersion">The row version information</param>
  10825. <param name="sourceColumnNullMapping">Whether or not this parameter is for comparing NULL's</param>
  10826. <param name="value">The intial value to assign the parameter</param>
  10827. </member>
  10828. <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.Data.DbType,System.Int32)">
  10829. <summary>
  10830. Constructs an unnamed parameter of the specified type and size
  10831. </summary>
  10832. <param name="parameterType">The data type</param>
  10833. <param name="parameterSize">The size of the parameter</param>
  10834. </member>
  10835. <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.Data.DbType,System.Int32,System.String)">
  10836. <summary>
  10837. Constructs an unnamed parameter of the specified type, size, and source column
  10838. </summary>
  10839. <param name="parameterType">The data type</param>
  10840. <param name="parameterSize">The size of the parameter</param>
  10841. <param name="sourceColumn">The source column</param>
  10842. </member>
  10843. <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.Data.DbType,System.Int32,System.String,System.Data.DataRowVersion)">
  10844. <summary>
  10845. Constructs an unnamed parameter of the specified type, size, source column and row version
  10846. </summary>
  10847. <param name="parameterType">The data type</param>
  10848. <param name="parameterSize">The size of the parameter</param>
  10849. <param name="sourceColumn">The source column</param>
  10850. <param name="rowVersion">The row version information</param>
  10851. </member>
  10852. <member name="M:System.Data.SQLite.SQLiteParameter.ResetDbType">
  10853. <summary>
  10854. Resets the DbType of the parameter so it can be inferred from the value
  10855. </summary>
  10856. </member>
  10857. <member name="M:System.Data.SQLite.SQLiteParameter.Clone">
  10858. <summary>
  10859. Clones a parameter
  10860. </summary>
  10861. <returns>A new, unassociated SQLiteParameter</returns>
  10862. </member>
  10863. <member name="P:System.Data.SQLite.SQLiteParameter.Command">
  10864. <summary>
  10865. The command associated with this parameter.
  10866. </summary>
  10867. </member>
  10868. <member name="P:System.Data.SQLite.SQLiteParameter.IsNullable">
  10869. <summary>
  10870. Whether or not the parameter can contain a null value
  10871. </summary>
  10872. </member>
  10873. <member name="P:System.Data.SQLite.SQLiteParameter.DbType">
  10874. <summary>
  10875. Returns the datatype of the parameter
  10876. </summary>
  10877. </member>
  10878. <member name="P:System.Data.SQLite.SQLiteParameter.Direction">
  10879. <summary>
  10880. Supports only input parameters
  10881. </summary>
  10882. </member>
  10883. <member name="P:System.Data.SQLite.SQLiteParameter.ParameterName">
  10884. <summary>
  10885. Returns the parameter name
  10886. </summary>
  10887. </member>
  10888. <member name="P:System.Data.SQLite.SQLiteParameter.Size">
  10889. <summary>
  10890. Returns the size of the parameter
  10891. </summary>
  10892. </member>
  10893. <member name="P:System.Data.SQLite.SQLiteParameter.SourceColumn">
  10894. <summary>
  10895. Gets/sets the source column
  10896. </summary>
  10897. </member>
  10898. <member name="P:System.Data.SQLite.SQLiteParameter.SourceColumnNullMapping">
  10899. <summary>
  10900. Used by DbCommandBuilder to determine the mapping for nullable fields
  10901. </summary>
  10902. </member>
  10903. <member name="P:System.Data.SQLite.SQLiteParameter.SourceVersion">
  10904. <summary>
  10905. Gets and sets the row version
  10906. </summary>
  10907. </member>
  10908. <member name="P:System.Data.SQLite.SQLiteParameter.Value">
  10909. <summary>
  10910. Gets and sets the parameter value. If no datatype was specified, the datatype will assume the type from the value given.
  10911. </summary>
  10912. </member>
  10913. <member name="P:System.Data.SQLite.SQLiteParameter.TypeName">
  10914. <summary>
  10915. The database type name associated with this parameter, if any.
  10916. </summary>
  10917. </member>
  10918. <member name="T:System.Data.SQLite.SQLiteParameterCollection">
  10919. <summary>
  10920. SQLite implementation of DbParameterCollection.
  10921. </summary>
  10922. </member>
  10923. <member name="F:System.Data.SQLite.SQLiteParameterCollection._command">
  10924. <summary>
  10925. The underlying command to which this collection belongs
  10926. </summary>
  10927. </member>
  10928. <member name="F:System.Data.SQLite.SQLiteParameterCollection._parameterList">
  10929. <summary>
  10930. The internal array of parameters in this collection
  10931. </summary>
  10932. </member>
  10933. <member name="F:System.Data.SQLite.SQLiteParameterCollection._unboundFlag">
  10934. <summary>
  10935. Determines whether or not all parameters have been bound to their statement(s)
  10936. </summary>
  10937. </member>
  10938. <member name="M:System.Data.SQLite.SQLiteParameterCollection.#ctor(System.Data.SQLite.SQLiteCommand)">
  10939. <summary>
  10940. Initializes the collection
  10941. </summary>
  10942. <param name="cmd">The command to which the collection belongs</param>
  10943. </member>
  10944. <member name="M:System.Data.SQLite.SQLiteParameterCollection.GetEnumerator">
  10945. <summary>
  10946. Retrieves an enumerator for the collection
  10947. </summary>
  10948. <returns>An enumerator for the underlying array</returns>
  10949. </member>
  10950. <member name="M:System.Data.SQLite.SQLiteParameterCollection.Add(System.String,System.Data.DbType,System.Int32,System.String)">
  10951. <summary>
  10952. Adds a parameter to the collection
  10953. </summary>
  10954. <param name="parameterName">The parameter name</param>
  10955. <param name="parameterType">The data type</param>
  10956. <param name="parameterSize">The size of the value</param>
  10957. <param name="sourceColumn">The source column</param>
  10958. <returns>A SQLiteParameter object</returns>
  10959. </member>
  10960. <member name="M:System.Data.SQLite.SQLiteParameterCollection.Add(System.String,System.Data.DbType,System.Int32)">
  10961. <summary>
  10962. Adds a parameter to the collection
  10963. </summary>
  10964. <param name="parameterName">The parameter name</param>
  10965. <param name="parameterType">The data type</param>
  10966. <param name="parameterSize">The size of the value</param>
  10967. <returns>A SQLiteParameter object</returns>
  10968. </member>
  10969. <member name="M:System.Data.SQLite.SQLiteParameterCollection.Add(System.String,System.Data.DbType)">
  10970. <summary>
  10971. Adds a parameter to the collection
  10972. </summary>
  10973. <param name="parameterName">The parameter name</param>
  10974. <param name="parameterType">The data type</param>
  10975. <returns>A SQLiteParameter object</returns>
  10976. </member>
  10977. <member name="M:System.Data.SQLite.SQLiteParameterCollection.Add(System.Data.SQLite.SQLiteParameter)">
  10978. <summary>
  10979. Adds a parameter to the collection
  10980. </summary>
  10981. <param name="parameter">The parameter to add</param>
  10982. <returns>A zero-based index of where the parameter is located in the array</returns>
  10983. </member>
  10984. <member name="M:System.Data.SQLite.SQLiteParameterCollection.Add(System.Object)">
  10985. <summary>
  10986. Adds a parameter to the collection
  10987. </summary>
  10988. <param name="value">The parameter to add</param>
  10989. <returns>A zero-based index of where the parameter is located in the array</returns>
  10990. </member>
  10991. <member name="M:System.Data.SQLite.SQLiteParameterCollection.AddWithValue(System.String,System.Object)">
  10992. <summary>
  10993. Adds a named/unnamed parameter and its value to the parameter collection.
  10994. </summary>
  10995. <param name="parameterName">Name of the parameter, or null to indicate an unnamed parameter</param>
  10996. <param name="value">The initial value of the parameter</param>
  10997. <returns>Returns the SQLiteParameter object created during the call.</returns>
  10998. </member>
  10999. <member name="M:System.Data.SQLite.SQLiteParameterCollection.AddRange(System.Data.SQLite.SQLiteParameter[])">
  11000. <summary>
  11001. Adds an array of parameters to the collection
  11002. </summary>
  11003. <param name="values">The array of parameters to add</param>
  11004. </member>
  11005. <member name="M:System.Data.SQLite.SQLiteParameterCollection.AddRange(System.Array)">
  11006. <summary>
  11007. Adds an array of parameters to the collection
  11008. </summary>
  11009. <param name="values">The array of parameters to add</param>
  11010. </member>
  11011. <member name="M:System.Data.SQLite.SQLiteParameterCollection.Clear">
  11012. <summary>
  11013. Clears the array and resets the collection
  11014. </summary>
  11015. </member>
  11016. <member name="M:System.Data.SQLite.SQLiteParameterCollection.Contains(System.String)">
  11017. <summary>
  11018. Determines if the named parameter exists in the collection
  11019. </summary>
  11020. <param name="parameterName">The name of the parameter to check</param>
  11021. <returns>True if the parameter is in the collection</returns>
  11022. </member>
  11023. <member name="M:System.Data.SQLite.SQLiteParameterCollection.Contains(System.Object)">
  11024. <summary>
  11025. Determines if the parameter exists in the collection
  11026. </summary>
  11027. <param name="value">The SQLiteParameter to check</param>
  11028. <returns>True if the parameter is in the collection</returns>
  11029. </member>
  11030. <member name="M:System.Data.SQLite.SQLiteParameterCollection.CopyTo(System.Array,System.Int32)">
  11031. <summary>
  11032. Not implemented
  11033. </summary>
  11034. <param name="array"></param>
  11035. <param name="index"></param>
  11036. </member>
  11037. <member name="M:System.Data.SQLite.SQLiteParameterCollection.GetParameter(System.String)">
  11038. <summary>
  11039. Retrieve a parameter by name from the collection
  11040. </summary>
  11041. <param name="parameterName">The name of the parameter to fetch</param>
  11042. <returns>A DbParameter object</returns>
  11043. </member>
  11044. <member name="M:System.Data.SQLite.SQLiteParameterCollection.GetParameter(System.Int32)">
  11045. <summary>
  11046. Retrieves a parameter by its index in the collection
  11047. </summary>
  11048. <param name="index">The index of the parameter to retrieve</param>
  11049. <returns>A DbParameter object</returns>
  11050. </member>
  11051. <member name="M:System.Data.SQLite.SQLiteParameterCollection.IndexOf(System.String)">
  11052. <summary>
  11053. Returns the index of a parameter given its name
  11054. </summary>
  11055. <param name="parameterName">The name of the parameter to find</param>
  11056. <returns>-1 if not found, otherwise a zero-based index of the parameter</returns>
  11057. </member>
  11058. <member name="M:System.Data.SQLite.SQLiteParameterCollection.IndexOf(System.Object)">
  11059. <summary>
  11060. Returns the index of a parameter
  11061. </summary>
  11062. <param name="value">The parameter to find</param>
  11063. <returns>-1 if not found, otherwise a zero-based index of the parameter</returns>
  11064. </member>
  11065. <member name="M:System.Data.SQLite.SQLiteParameterCollection.Insert(System.Int32,System.Object)">
  11066. <summary>
  11067. Inserts a parameter into the array at the specified location
  11068. </summary>
  11069. <param name="index">The zero-based index to insert the parameter at</param>
  11070. <param name="value">The parameter to insert</param>
  11071. </member>
  11072. <member name="M:System.Data.SQLite.SQLiteParameterCollection.Remove(System.Object)">
  11073. <summary>
  11074. Removes a parameter from the collection
  11075. </summary>
  11076. <param name="value">The parameter to remove</param>
  11077. </member>
  11078. <member name="M:System.Data.SQLite.SQLiteParameterCollection.RemoveAt(System.String)">
  11079. <summary>
  11080. Removes a parameter from the collection given its name
  11081. </summary>
  11082. <param name="parameterName">The name of the parameter to remove</param>
  11083. </member>
  11084. <member name="M:System.Data.SQLite.SQLiteParameterCollection.RemoveAt(System.Int32)">
  11085. <summary>
  11086. Removes a parameter from the collection given its index
  11087. </summary>
  11088. <param name="index">The zero-based parameter index to remove</param>
  11089. </member>
  11090. <member name="M:System.Data.SQLite.SQLiteParameterCollection.SetParameter(System.String,System.Data.Common.DbParameter)">
  11091. <summary>
  11092. Re-assign the named parameter to a new parameter object
  11093. </summary>
  11094. <param name="parameterName">The name of the parameter to replace</param>
  11095. <param name="value">The new parameter</param>
  11096. </member>
  11097. <member name="M:System.Data.SQLite.SQLiteParameterCollection.SetParameter(System.Int32,System.Data.Common.DbParameter)">
  11098. <summary>
  11099. Re-assign a parameter at the specified index
  11100. </summary>
  11101. <param name="index">The zero-based index of the parameter to replace</param>
  11102. <param name="value">The new parameter</param>
  11103. </member>
  11104. <member name="M:System.Data.SQLite.SQLiteParameterCollection.Unbind">
  11105. <summary>
  11106. Un-binds all parameters from their statements
  11107. </summary>
  11108. </member>
  11109. <member name="M:System.Data.SQLite.SQLiteParameterCollection.MapParameters(System.Data.SQLite.SQLiteStatement)">
  11110. <summary>
  11111. This function attempts to map all parameters in the collection to all statements in a Command.
  11112. Since named parameters may span multiple statements, this function makes sure all statements are bound
  11113. to the same named parameter. Unnamed parameters are bound in sequence.
  11114. </summary>
  11115. </member>
  11116. <member name="P:System.Data.SQLite.SQLiteParameterCollection.IsSynchronized">
  11117. <summary>
  11118. Returns false
  11119. </summary>
  11120. </member>
  11121. <member name="P:System.Data.SQLite.SQLiteParameterCollection.IsFixedSize">
  11122. <summary>
  11123. Returns false
  11124. </summary>
  11125. </member>
  11126. <member name="P:System.Data.SQLite.SQLiteParameterCollection.IsReadOnly">
  11127. <summary>
  11128. Returns false
  11129. </summary>
  11130. </member>
  11131. <member name="P:System.Data.SQLite.SQLiteParameterCollection.SyncRoot">
  11132. <summary>
  11133. Returns null
  11134. </summary>
  11135. </member>
  11136. <member name="P:System.Data.SQLite.SQLiteParameterCollection.Count">
  11137. <summary>
  11138. Returns a count of parameters in the collection
  11139. </summary>
  11140. </member>
  11141. <member name="P:System.Data.SQLite.SQLiteParameterCollection.Item(System.String)">
  11142. <summary>
  11143. Overloaded to specialize the return value of the default indexer
  11144. </summary>
  11145. <param name="parameterName">Name of the parameter to get/set</param>
  11146. <returns>The specified named SQLite parameter</returns>
  11147. </member>
  11148. <member name="P:System.Data.SQLite.SQLiteParameterCollection.Item(System.Int32)">
  11149. <summary>
  11150. Overloaded to specialize the return value of the default indexer
  11151. </summary>
  11152. <param name="index">The index of the parameter to get/set</param>
  11153. <returns>The specified SQLite parameter</returns>
  11154. </member>
  11155. <member name="T:System.Data.SQLite.SQLiteStatement">
  11156. <summary>
  11157. Represents a single SQL statement in SQLite.
  11158. </summary>
  11159. </member>
  11160. <member name="F:System.Data.SQLite.SQLiteStatement._sql">
  11161. <summary>
  11162. The underlying SQLite object this statement is bound to
  11163. </summary>
  11164. </member>
  11165. <member name="F:System.Data.SQLite.SQLiteStatement._sqlStatement">
  11166. <summary>
  11167. The command text of this SQL statement
  11168. </summary>
  11169. </member>
  11170. <member name="F:System.Data.SQLite.SQLiteStatement._sqlite_stmt">
  11171. <summary>
  11172. The actual statement pointer
  11173. </summary>
  11174. </member>
  11175. <member name="F:System.Data.SQLite.SQLiteStatement._unnamedParameters">
  11176. <summary>
  11177. An index from which unnamed parameters begin
  11178. </summary>
  11179. </member>
  11180. <member name="F:System.Data.SQLite.SQLiteStatement._paramNames">
  11181. <summary>
  11182. Names of the parameters as SQLite understands them to be
  11183. </summary>
  11184. </member>
  11185. <member name="F:System.Data.SQLite.SQLiteStatement._paramValues">
  11186. <summary>
  11187. Parameters for this statement
  11188. </summary>
  11189. </member>
  11190. <member name="F:System.Data.SQLite.SQLiteStatement._command">
  11191. <summary>
  11192. Command this statement belongs to (if any)
  11193. </summary>
  11194. </member>
  11195. <member name="F:System.Data.SQLite.SQLiteStatement._flags">
  11196. <summary>
  11197. The flags associated with the parent connection object.
  11198. </summary>
  11199. </member>
  11200. <member name="M:System.Data.SQLite.SQLiteStatement.#ctor(System.Data.SQLite.SQLiteBase,System.Data.SQLite.SQLiteConnectionFlags,System.Data.SQLite.SQLiteStatementHandle,System.String,System.Data.SQLite.SQLiteStatement)">
  11201. <summary>
  11202. Initializes the statement and attempts to get all information about parameters in the statement
  11203. </summary>
  11204. <param name="sqlbase">The base SQLite object</param>
  11205. <param name="flags">The flags associated with the parent connection object</param>
  11206. <param name="stmt">The statement</param>
  11207. <param name="strCommand">The command text for this statement</param>
  11208. <param name="previous">The previous command in a multi-statement command</param>
  11209. </member>
  11210. <member name="M:System.Data.SQLite.SQLiteStatement.Dispose">
  11211. <summary>
  11212. Disposes and finalizes the statement
  11213. </summary>
  11214. </member>
  11215. <member name="M:System.Data.SQLite.SQLiteStatement.TryGetChanges(System.Int32@,System.Boolean@)">
  11216. <summary>
  11217. If the underlying database connection is open, fetches the number of changed rows
  11218. resulting from the most recent query; otherwise, does nothing.
  11219. </summary>
  11220. <param name="changes">
  11221. The number of changes when true is returned.
  11222. Undefined if false is returned.
  11223. </param>
  11224. <param name="readOnly">
  11225. The read-only flag when true is returned.
  11226. Undefined if false is returned.
  11227. </param>
  11228. <returns>Non-zero if the number of changed rows was fetched.</returns>
  11229. </member>
  11230. <member name="M:System.Data.SQLite.SQLiteStatement.MapParameter(System.String,System.Data.SQLite.SQLiteParameter)">
  11231. <summary>
  11232. Called by SQLiteParameterCollection, this function determines if the specified parameter name belongs to
  11233. this statement, and if so, keeps a reference to the parameter so it can be bound later.
  11234. </summary>
  11235. <param name="s">The parameter name to map</param>
  11236. <param name="p">The parameter to assign it</param>
  11237. </member>
  11238. <member name="M:System.Data.SQLite.SQLiteStatement.BindParameters">
  11239. <summary>
  11240. Bind all parameters, making sure the caller didn't miss any
  11241. </summary>
  11242. </member>
  11243. <member name="M:System.Data.SQLite.SQLiteStatement.GetConnection(System.Data.SQLite.SQLiteStatement)">
  11244. <summary>
  11245. This method attempts to query the database connection associated with
  11246. the statement in use. If the underlying command or connection is
  11247. unavailable, a null value will be returned.
  11248. </summary>
  11249. <returns>
  11250. The connection object -OR- null if it is unavailable.
  11251. </returns>
  11252. </member>
  11253. <member name="M:System.Data.SQLite.SQLiteStatement.InvokeBindValueCallback(System.Int32,System.Data.SQLite.SQLiteParameter,System.Boolean@)">
  11254. <summary>
  11255. Invokes the parameter binding callback configured for the database
  11256. type name associated with the specified column. If no parameter
  11257. binding callback is available for the database type name, do
  11258. nothing.
  11259. </summary>
  11260. <param name="index">
  11261. The index of the column being read.
  11262. </param>
  11263. <param name="parameter">
  11264. The <see cref="T:System.Data.SQLite.SQLiteParameter"/> instance being bound to the
  11265. command.
  11266. </param>
  11267. <param name="complete">
  11268. Non-zero if the default handling for the parameter binding call
  11269. should be skipped (i.e. the parameter should not be bound at all).
  11270. Great care should be used when setting this to non-zero.
  11271. </param>
  11272. </member>
  11273. <member name="M:System.Data.SQLite.SQLiteStatement.BindParameter(System.Int32,System.Data.SQLite.SQLiteParameter)">
  11274. <summary>
  11275. Perform the bind operation for an individual parameter
  11276. </summary>
  11277. <param name="index">The index of the parameter to bind</param>
  11278. <param name="param">The parameter we're binding</param>
  11279. </member>
  11280. <member name="T:System.Data.SQLite.SQLiteTransaction">
  11281. <summary>
  11282. SQLite implementation of DbTransaction that does not support nested transactions.
  11283. </summary>
  11284. </member>
  11285. <member name="T:System.Data.SQLite.SQLiteTransactionBase">
  11286. <summary>
  11287. Base class used by to implement DbTransaction for SQLite.
  11288. </summary>
  11289. </member>
  11290. <member name="F:System.Data.SQLite.SQLiteTransactionBase._cnn">
  11291. <summary>
  11292. The connection to which this transaction is bound.
  11293. </summary>
  11294. </member>
  11295. <member name="F:System.Data.SQLite.SQLiteTransactionBase._version">
  11296. <summary>
  11297. Matches the version of the connection.
  11298. </summary>
  11299. </member>
  11300. <member name="F:System.Data.SQLite.SQLiteTransactionBase._level">
  11301. <summary>
  11302. The isolation level for this transaction.
  11303. </summary>
  11304. </member>
  11305. <member name="M:System.Data.SQLite.SQLiteTransactionBase.#ctor(System.Data.SQLite.SQLiteConnection,System.Boolean)">
  11306. <summary>
  11307. Constructs the transaction object, binding it to the supplied connection
  11308. </summary>
  11309. <param name="connection">The connection to open a transaction on</param>
  11310. <param name="deferredLock">TRUE to defer the writelock, or FALSE to lock immediately</param>
  11311. </member>
  11312. <member name="M:System.Data.SQLite.SQLiteTransactionBase.Dispose(System.Boolean)">
  11313. <summary>
  11314. Disposes the transaction. If it is currently active, any changes are rolled back.
  11315. </summary>
  11316. </member>
  11317. <member name="M:System.Data.SQLite.SQLiteTransactionBase.Rollback">
  11318. <summary>
  11319. Rolls back the active transaction.
  11320. </summary>
  11321. </member>
  11322. <member name="M:System.Data.SQLite.SQLiteTransactionBase.Begin(System.Boolean)">
  11323. <summary>
  11324. Attempts to start a transaction. An exception will be thrown if the transaction cannot
  11325. be started for any reason.
  11326. </summary>
  11327. <param name="deferredLock">TRUE to defer the writelock, or FALSE to lock immediately</param>
  11328. </member>
  11329. <member name="M:System.Data.SQLite.SQLiteTransactionBase.IssueRollback(System.Boolean)">
  11330. <summary>
  11331. Issue a ROLLBACK command against the database connection,
  11332. optionally re-throwing any caught exception.
  11333. </summary>
  11334. <param name="throwError">
  11335. Non-zero to re-throw caught exceptions.
  11336. </param>
  11337. </member>
  11338. <member name="M:System.Data.SQLite.SQLiteTransactionBase.IsValid(System.Boolean)">
  11339. <summary>
  11340. Checks the state of this transaction, optionally throwing an exception if a state
  11341. inconsistency is found.
  11342. </summary>
  11343. <param name="throwError">
  11344. Non-zero to throw an exception if a state inconsistency is found.
  11345. </param>
  11346. <returns>
  11347. Non-zero if this transaction is valid; otherwise, false.
  11348. </returns>
  11349. </member>
  11350. <member name="P:System.Data.SQLite.SQLiteTransactionBase.IsolationLevel">
  11351. <summary>
  11352. Gets the isolation level of the transaction. SQLite only supports Serializable transactions.
  11353. </summary>
  11354. </member>
  11355. <member name="P:System.Data.SQLite.SQLiteTransactionBase.Connection">
  11356. <summary>
  11357. Returns the underlying connection to which this transaction applies.
  11358. </summary>
  11359. </member>
  11360. <member name="P:System.Data.SQLite.SQLiteTransactionBase.DbConnection">
  11361. <summary>
  11362. Forwards to the local Connection property
  11363. </summary>
  11364. </member>
  11365. <member name="M:System.Data.SQLite.SQLiteTransaction.#ctor(System.Data.SQLite.SQLiteConnection,System.Boolean)">
  11366. <summary>
  11367. Constructs the transaction object, binding it to the supplied connection
  11368. </summary>
  11369. <param name="connection">The connection to open a transaction on</param>
  11370. <param name="deferredLock">TRUE to defer the writelock, or FALSE to lock immediately</param>
  11371. </member>
  11372. <member name="M:System.Data.SQLite.SQLiteTransaction.Dispose(System.Boolean)">
  11373. <summary>
  11374. Disposes the transaction. If it is currently active, any changes are rolled back.
  11375. </summary>
  11376. </member>
  11377. <member name="M:System.Data.SQLite.SQLiteTransaction.Commit">
  11378. <summary>
  11379. Commits the current transaction.
  11380. </summary>
  11381. </member>
  11382. <member name="M:System.Data.SQLite.SQLiteTransaction.Begin(System.Boolean)">
  11383. <summary>
  11384. Attempts to start a transaction. An exception will be thrown if the transaction cannot
  11385. be started for any reason.
  11386. </summary>
  11387. <param name="deferredLock">TRUE to defer the writelock, or FALSE to lock immediately</param>
  11388. </member>
  11389. <member name="M:System.Data.SQLite.SQLiteTransaction.IssueRollback(System.Boolean)">
  11390. <summary>
  11391. Issue a ROLLBACK command against the database connection,
  11392. optionally re-throwing any caught exception.
  11393. </summary>
  11394. <param name="throwError">
  11395. Non-zero to re-throw caught exceptions.
  11396. </param>
  11397. </member>
  11398. <member name="T:System.Data.SQLite.SQLiteTransaction2">
  11399. <summary>
  11400. SQLite implementation of DbTransaction that does support nested transactions.
  11401. </summary>
  11402. </member>
  11403. <member name="F:System.Data.SQLite.SQLiteTransaction2._beginLevel">
  11404. <summary>
  11405. The original transaction level for the associated connection
  11406. when this transaction was created (i.e. begun).
  11407. </summary>
  11408. </member>
  11409. <member name="F:System.Data.SQLite.SQLiteTransaction2._savePointName">
  11410. <summary>
  11411. The SAVEPOINT name for this transaction, if any. This will
  11412. only be non-null if this transaction is a nested one.
  11413. </summary>
  11414. </member>
  11415. <member name="M:System.Data.SQLite.SQLiteTransaction2.#ctor(System.Data.SQLite.SQLiteConnection,System.Boolean)">
  11416. <summary>
  11417. Constructs the transaction object, binding it to the supplied connection
  11418. </summary>
  11419. <param name="connection">The connection to open a transaction on</param>
  11420. <param name="deferredLock">TRUE to defer the writelock, or FALSE to lock immediately</param>
  11421. </member>
  11422. <member name="M:System.Data.SQLite.SQLiteTransaction2.Dispose(System.Boolean)">
  11423. <summary>
  11424. Disposes the transaction. If it is currently active, any changes are rolled back.
  11425. </summary>
  11426. </member>
  11427. <member name="M:System.Data.SQLite.SQLiteTransaction2.Commit">
  11428. <summary>
  11429. Commits the current transaction.
  11430. </summary>
  11431. </member>
  11432. <member name="M:System.Data.SQLite.SQLiteTransaction2.Begin(System.Boolean)">
  11433. <summary>
  11434. Attempts to start a transaction. An exception will be thrown if the transaction cannot
  11435. be started for any reason.
  11436. </summary>
  11437. <param name="deferredLock">TRUE to defer the writelock, or FALSE to lock immediately</param>
  11438. </member>
  11439. <member name="M:System.Data.SQLite.SQLiteTransaction2.IssueRollback(System.Boolean)">
  11440. <summary>
  11441. Issue a ROLLBACK command against the database connection,
  11442. optionally re-throwing any caught exception.
  11443. </summary>
  11444. <param name="throwError">
  11445. Non-zero to re-throw caught exceptions.
  11446. </param>
  11447. </member>
  11448. <member name="M:System.Data.SQLite.SQLiteTransaction2.GetSavePointName">
  11449. <summary>
  11450. Constructs the name of a new savepoint for this transaction. It
  11451. should only be called from the constructor of this class.
  11452. </summary>
  11453. <returns>
  11454. The name of the new savepoint -OR- null if it cannot be constructed.
  11455. </returns>
  11456. </member>
  11457. <member name="T:System.Data.SQLite.HelperMethods">
  11458. <summary>
  11459. This static class provides some methods that are shared between the
  11460. native library pre-loader and other classes.
  11461. </summary>
  11462. </member>
  11463. <member name="F:System.Data.SQLite.HelperMethods.staticSyncRoot">
  11464. <summary>
  11465. This lock is used to protect the static <see cref="F:System.Data.SQLite.HelperMethods.isMono"/> and
  11466. <see cref="F:System.Data.SQLite.HelperMethods.isDotNetCore"/> fields.
  11467. </summary>
  11468. </member>
  11469. <member name="F:System.Data.SQLite.HelperMethods.MonoRuntimeType">
  11470. <summary>
  11471. This type is only present when running on Mono.
  11472. </summary>
  11473. </member>
  11474. <member name="F:System.Data.SQLite.HelperMethods.DotNetCoreLibType">
  11475. <summary>
  11476. This type is only present when running on .NET Core.
  11477. </summary>
  11478. </member>
  11479. <member name="F:System.Data.SQLite.HelperMethods.isMono">
  11480. <summary>
  11481. Keeps track of whether we are running on Mono. Initially null, it is
  11482. set by the <see cref="M:System.Data.SQLite.HelperMethods.IsMono"/> method on its first call. Later, it
  11483. is returned verbatim by the <see cref="M:System.Data.SQLite.HelperMethods.IsMono"/> method.
  11484. </summary>
  11485. </member>
  11486. <member name="F:System.Data.SQLite.HelperMethods.isDotNetCore">
  11487. <summary>
  11488. Keeps track of whether we are running on .NET Core. Initially null,
  11489. it is set by the <see cref="M:System.Data.SQLite.HelperMethods.IsDotNetCore"/> method on its first
  11490. call. Later, it is returned verbatim by the
  11491. <see cref="M:System.Data.SQLite.HelperMethods.IsDotNetCore"/> method.
  11492. </summary>
  11493. </member>
  11494. <member name="F:System.Data.SQLite.HelperMethods.debuggerBreak">
  11495. <summary>
  11496. Keeps track of whether we successfully invoked the
  11497. <see cref="M:System.Diagnostics.Debugger.Break"/> method. Initially null, it is set by
  11498. the <see cref="M:System.Data.SQLite.HelperMethods.MaybeBreakIntoDebugger"/> method on its first call.
  11499. </summary>
  11500. </member>
  11501. <member name="M:System.Data.SQLite.HelperMethods.GetProcessId">
  11502. <summary>
  11503. Determines the ID of the current process. Only used for debugging.
  11504. </summary>
  11505. <returns>
  11506. The ID of the current process -OR- zero if it cannot be determined.
  11507. </returns>
  11508. </member>
  11509. <member name="M:System.Data.SQLite.HelperMethods.IsMono">
  11510. <summary>
  11511. Determines whether or not this assembly is running on Mono.
  11512. </summary>
  11513. <returns>
  11514. Non-zero if this assembly is running on Mono.
  11515. </returns>
  11516. </member>
  11517. <member name="M:System.Data.SQLite.HelperMethods.IsDotNetCore">
  11518. <summary>
  11519. Determines whether or not this assembly is running on .NET Core.
  11520. </summary>
  11521. <returns>
  11522. Non-zero if this assembly is running on .NET Core.
  11523. </returns>
  11524. </member>
  11525. <member name="M:System.Data.SQLite.HelperMethods.ResetBreakIntoDebugger">
  11526. <summary>
  11527. Resets the cached value for the "PreLoadSQLite_BreakIntoDebugger"
  11528. configuration setting.
  11529. </summary>
  11530. </member>
  11531. <member name="M:System.Data.SQLite.HelperMethods.MaybeBreakIntoDebugger">
  11532. <summary>
  11533. If the "PreLoadSQLite_BreakIntoDebugger" configuration setting is
  11534. present (e.g. via the environment), give the interactive user an
  11535. opportunity to attach a debugger to the current process; otherwise,
  11536. do nothing.
  11537. </summary>
  11538. </member>
  11539. <member name="M:System.Data.SQLite.HelperMethods.GetThreadId">
  11540. <summary>
  11541. Determines the ID of the current thread. Only used for debugging.
  11542. </summary>
  11543. <returns>
  11544. The ID of the current thread -OR- zero if it cannot be determined.
  11545. </returns>
  11546. </member>
  11547. <member name="M:System.Data.SQLite.HelperMethods.HasFlags(System.Data.SQLite.SQLiteConnectionFlags,System.Data.SQLite.SQLiteConnectionFlags)">
  11548. <summary>
  11549. Determines if the specified flags are present within the flags
  11550. associated with the parent connection object.
  11551. </summary>
  11552. <param name="flags">
  11553. The flags associated with the parent connection object.
  11554. </param>
  11555. <param name="hasFlags">
  11556. The flags to check for.
  11557. </param>
  11558. <returns>
  11559. Non-zero if the specified flag or flags were present; otherwise,
  11560. zero.
  11561. </returns>
  11562. </member>
  11563. <member name="M:System.Data.SQLite.HelperMethods.LogPrepare(System.Data.SQLite.SQLiteConnectionFlags)">
  11564. <summary>
  11565. Determines if preparing a query should be logged.
  11566. </summary>
  11567. <param name="flags">
  11568. The flags associated with the parent connection object.
  11569. </param>
  11570. <returns>
  11571. Non-zero if the query preparation should be logged; otherwise, zero.
  11572. </returns>
  11573. </member>
  11574. <member name="M:System.Data.SQLite.HelperMethods.LogPreBind(System.Data.SQLite.SQLiteConnectionFlags)">
  11575. <summary>
  11576. Determines if pre-parameter binding should be logged.
  11577. </summary>
  11578. <param name="flags">
  11579. The flags associated with the parent connection object.
  11580. </param>
  11581. <returns>
  11582. Non-zero if the pre-parameter binding should be logged; otherwise,
  11583. zero.
  11584. </returns>
  11585. </member>
  11586. <member name="M:System.Data.SQLite.HelperMethods.LogBind(System.Data.SQLite.SQLiteConnectionFlags)">
  11587. <summary>
  11588. Determines if parameter binding should be logged.
  11589. </summary>
  11590. <param name="flags">
  11591. The flags associated with the parent connection object.
  11592. </param>
  11593. <returns>
  11594. Non-zero if the parameter binding should be logged; otherwise, zero.
  11595. </returns>
  11596. </member>
  11597. <member name="M:System.Data.SQLite.HelperMethods.LogCallbackExceptions(System.Data.SQLite.SQLiteConnectionFlags)">
  11598. <summary>
  11599. Determines if an exception in a native callback should be logged.
  11600. </summary>
  11601. <param name="flags">
  11602. The flags associated with the parent connection object.
  11603. </param>
  11604. <returns>
  11605. Non-zero if the exception should be logged; otherwise, zero.
  11606. </returns>
  11607. </member>
  11608. <member name="M:System.Data.SQLite.HelperMethods.LogBackup(System.Data.SQLite.SQLiteConnectionFlags)">
  11609. <summary>
  11610. Determines if backup API errors should be logged.
  11611. </summary>
  11612. <param name="flags">
  11613. The flags associated with the parent connection object.
  11614. </param>
  11615. <returns>
  11616. Non-zero if the backup API error should be logged; otherwise, zero.
  11617. </returns>
  11618. </member>
  11619. <member name="M:System.Data.SQLite.HelperMethods.NoLogModule(System.Data.SQLite.SQLiteConnectionFlags)">
  11620. <summary>
  11621. Determines if logging for the <see cref="T:System.Data.SQLite.SQLiteModule"/> class is
  11622. disabled.
  11623. </summary>
  11624. <param name="flags">
  11625. The flags associated with the parent connection object.
  11626. </param>
  11627. <returns>
  11628. Non-zero if logging for the <see cref="T:System.Data.SQLite.SQLiteModule"/> class is
  11629. disabled; otherwise, zero.
  11630. </returns>
  11631. </member>
  11632. <member name="M:System.Data.SQLite.HelperMethods.LogModuleError(System.Data.SQLite.SQLiteConnectionFlags)">
  11633. <summary>
  11634. Determines if <see cref="T:System.Data.SQLite.SQLiteModule"/> errors should be logged.
  11635. </summary>
  11636. <param name="flags">
  11637. The flags associated with the parent connection object.
  11638. </param>
  11639. <returns>
  11640. Non-zero if the <see cref="T:System.Data.SQLite.SQLiteModule"/> error should be logged;
  11641. otherwise, zero.
  11642. </returns>
  11643. </member>
  11644. <member name="M:System.Data.SQLite.HelperMethods.LogModuleException(System.Data.SQLite.SQLiteConnectionFlags)">
  11645. <summary>
  11646. Determines if <see cref="T:System.Data.SQLite.SQLiteModule"/> exceptions should be
  11647. logged.
  11648. </summary>
  11649. <param name="flags">
  11650. The flags associated with the parent connection object.
  11651. </param>
  11652. <returns>
  11653. Non-zero if the <see cref="T:System.Data.SQLite.SQLiteModule"/> exception should be
  11654. logged; otherwise, zero.
  11655. </returns>
  11656. </member>
  11657. <member name="M:System.Data.SQLite.HelperMethods.IsWindows">
  11658. <summary>
  11659. Determines if the current process is running on one of the Windows
  11660. [sub-]platforms.
  11661. </summary>
  11662. <returns>
  11663. Non-zero when running on Windows; otherwise, zero.
  11664. </returns>
  11665. </member>
  11666. <member name="M:System.Data.SQLite.HelperMethods.StringFormat(System.IFormatProvider,System.String,System.Object[])">
  11667. <summary>
  11668. This is a wrapper around the
  11669. <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/> method.
  11670. On Mono, it has to call the method overload without the
  11671. <see cref="T:System.IFormatProvider"/> parameter, due to a bug in Mono.
  11672. </summary>
  11673. <param name="provider">
  11674. This is used for culture-specific formatting.
  11675. </param>
  11676. <param name="format">
  11677. The format string.
  11678. </param>
  11679. <param name="args">
  11680. An array the objects to format.
  11681. </param>
  11682. <returns>
  11683. The resulting string.
  11684. </returns>
  11685. </member>
  11686. <member name="T:System.Data.SQLite.NativeLibraryHelper">
  11687. <summary>
  11688. This static class provides a thin wrapper around the native library
  11689. loading features of the underlying platform.
  11690. </summary>
  11691. </member>
  11692. <member name="M:System.Data.SQLite.NativeLibraryHelper.LoadLibraryWin32(System.String)">
  11693. <summary>
  11694. Attempts to load the specified native library file using the Win32
  11695. API.
  11696. </summary>
  11697. <param name="fileName">
  11698. The file name of the native library to load.
  11699. </param>
  11700. <returns>
  11701. The native module handle upon success -OR- IntPtr.Zero on failure.
  11702. </returns>
  11703. </member>
  11704. <member name="M:System.Data.SQLite.NativeLibraryHelper.GetMachineWin32">
  11705. <summary>
  11706. Attempts to determine the machine name of the current process using
  11707. the Win32 API.
  11708. </summary>
  11709. <returns>
  11710. The machine name for the current process -OR- null on failure.
  11711. </returns>
  11712. </member>
  11713. <member name="M:System.Data.SQLite.NativeLibraryHelper.LoadLibraryPosix(System.String)">
  11714. <summary>
  11715. Attempts to load the specified native library file using the POSIX
  11716. API.
  11717. </summary>
  11718. <param name="fileName">
  11719. The file name of the native library to load.
  11720. </param>
  11721. <returns>
  11722. The native module handle upon success -OR- IntPtr.Zero on failure.
  11723. </returns>
  11724. </member>
  11725. <member name="M:System.Data.SQLite.NativeLibraryHelper.GetMachinePosix">
  11726. <summary>
  11727. Attempts to determine the machine name of the current process using
  11728. the POSIX API.
  11729. </summary>
  11730. <returns>
  11731. The machine name for the current process -OR- null on failure.
  11732. </returns>
  11733. </member>
  11734. <member name="M:System.Data.SQLite.NativeLibraryHelper.LoadLibrary(System.String)">
  11735. <summary>
  11736. Attempts to load the specified native library file.
  11737. </summary>
  11738. <param name="fileName">
  11739. The file name of the native library to load.
  11740. </param>
  11741. <returns>
  11742. The native module handle upon success -OR- IntPtr.Zero on failure.
  11743. </returns>
  11744. </member>
  11745. <member name="M:System.Data.SQLite.NativeLibraryHelper.GetMachine">
  11746. <summary>
  11747. Attempts to determine the machine name of the current process.
  11748. </summary>
  11749. <returns>
  11750. The machine name for the current process -OR- null on failure.
  11751. </returns>
  11752. </member>
  11753. <member name="T:System.Data.SQLite.NativeLibraryHelper.LoadLibraryCallback">
  11754. <summary>
  11755. This delegate is used to wrap the concept of loading a native
  11756. library, based on a file name, and returning the loaded module
  11757. handle.
  11758. </summary>
  11759. <param name="fileName">
  11760. The file name of the native library to load.
  11761. </param>
  11762. <returns>
  11763. The native module handle upon success -OR- IntPtr.Zero on failure.
  11764. </returns>
  11765. </member>
  11766. <member name="T:System.Data.SQLite.NativeLibraryHelper.GetMachineCallback">
  11767. <summary>
  11768. This delegate is used to wrap the concept of querying the machine
  11769. name of the current process.
  11770. </summary>
  11771. <returns>
  11772. The machine name for the current process -OR- null on failure.
  11773. </returns>
  11774. </member>
  11775. <member name="T:System.Data.SQLite.UnsafeNativeMethodsPosix">
  11776. <summary>
  11777. This class declares P/Invoke methods to call native POSIX APIs.
  11778. </summary>
  11779. </member>
  11780. <member name="F:System.Data.SQLite.UnsafeNativeMethodsPosix.RTLD_LAZY">
  11781. <summary>
  11782. For use with dlopen(), bind function calls lazily.
  11783. </summary>
  11784. </member>
  11785. <member name="F:System.Data.SQLite.UnsafeNativeMethodsPosix.RTLD_NOW">
  11786. <summary>
  11787. For use with dlopen(), bind function calls immediately.
  11788. </summary>
  11789. </member>
  11790. <member name="F:System.Data.SQLite.UnsafeNativeMethodsPosix.RTLD_GLOBAL">
  11791. <summary>
  11792. For use with dlopen(), make symbols globally available.
  11793. </summary>
  11794. </member>
  11795. <member name="F:System.Data.SQLite.UnsafeNativeMethodsPosix.RTLD_LOCAL">
  11796. <summary>
  11797. For use with dlopen(), opposite of RTLD_GLOBAL, and the default.
  11798. </summary>
  11799. </member>
  11800. <member name="F:System.Data.SQLite.UnsafeNativeMethodsPosix.RTLD_DEFAULT">
  11801. <summary>
  11802. For use with dlopen(), the defaults used by this class.
  11803. </summary>
  11804. </member>
  11805. <member name="M:System.Data.SQLite.UnsafeNativeMethodsPosix.uname(System.Data.SQLite.UnsafeNativeMethodsPosix.utsname_interop@)">
  11806. <summary>
  11807. This is the P/Invoke method that wraps the native Unix uname
  11808. function. See the POSIX documentation for full details on what it
  11809. does.
  11810. </summary>
  11811. <param name="name">
  11812. Structure containing a preallocated byte buffer to fill with the
  11813. requested information.
  11814. </param>
  11815. <returns>
  11816. Zero for success and less than zero upon failure.
  11817. </returns>
  11818. </member>
  11819. <member name="M:System.Data.SQLite.UnsafeNativeMethodsPosix.dlopen(System.String,System.Int32)">
  11820. <summary>
  11821. This is the P/Invoke method that wraps the native Unix dlopen
  11822. function. See the POSIX documentation for full details on what it
  11823. does.
  11824. </summary>
  11825. <param name="fileName">
  11826. The name of the executable library.
  11827. </param>
  11828. <param name="mode">
  11829. This must be a combination of the individual bit flags RTLD_LAZY,
  11830. RTLD_NOW, RTLD_GLOBAL, and/or RTLD_LOCAL.
  11831. </param>
  11832. <returns>
  11833. The native module handle upon success -OR- IntPtr.Zero on failure.
  11834. </returns>
  11835. </member>
  11836. <member name="M:System.Data.SQLite.UnsafeNativeMethodsPosix.dlclose(System.IntPtr)">
  11837. <summary>
  11838. This is the P/Invoke method that wraps the native Unix dlclose
  11839. function. See the POSIX documentation for full details on what it
  11840. does.
  11841. </summary>
  11842. <param name="module">
  11843. The handle to the loaded native library.
  11844. </param>
  11845. <returns>
  11846. Zero upon success -OR- non-zero on failure.
  11847. </returns>
  11848. </member>
  11849. <member name="F:System.Data.SQLite.UnsafeNativeMethodsPosix.utsNameSeparators">
  11850. <summary>
  11851. These are the characters used to separate the string fields within
  11852. the raw buffer returned by the <see cref="M:System.Data.SQLite.UnsafeNativeMethodsPosix.uname(System.Data.SQLite.UnsafeNativeMethodsPosix.utsname_interop@)"/> P/Invoke method.
  11853. </summary>
  11854. </member>
  11855. <member name="M:System.Data.SQLite.UnsafeNativeMethodsPosix.GetOsVersionInfo(System.Data.SQLite.UnsafeNativeMethodsPosix.utsname@)">
  11856. <summary>
  11857. This method is a wrapper around the <see cref="M:System.Data.SQLite.UnsafeNativeMethodsPosix.uname(System.Data.SQLite.UnsafeNativeMethodsPosix.utsname_interop@)"/> P/Invoke
  11858. method that extracts and returns the human readable strings from
  11859. the raw buffer.
  11860. </summary>
  11861. <param name="utsName">
  11862. This structure, which contains strings, will be filled based on the
  11863. data placed in the raw buffer returned by the <see cref="M:System.Data.SQLite.UnsafeNativeMethodsPosix.uname(System.Data.SQLite.UnsafeNativeMethodsPosix.utsname_interop@)"/>
  11864. P/Invoke method.
  11865. </param>
  11866. <returns>
  11867. Non-zero upon success; otherwise, zero.
  11868. </returns>
  11869. </member>
  11870. <member name="T:System.Data.SQLite.UnsafeNativeMethodsPosix.utsname">
  11871. <summary>
  11872. This structure is used when running on POSIX operating systems
  11873. to store information about the current machine, including the
  11874. human readable name of the operating system as well as that of
  11875. the underlying hardware.
  11876. </summary>
  11877. </member>
  11878. <member name="T:System.Data.SQLite.UnsafeNativeMethodsPosix.utsname_interop">
  11879. <summary>
  11880. This structure is passed directly to the P/Invoke method to
  11881. obtain the information about the current machine, including
  11882. the human readable name of the operating system as well as
  11883. that of the underlying hardware.
  11884. </summary>
  11885. </member>
  11886. <member name="T:System.Data.SQLite.UnsafeNativeMethodsWin32">
  11887. <summary>
  11888. This class declares P/Invoke methods to call native Win32 APIs.
  11889. </summary>
  11890. </member>
  11891. <member name="M:System.Data.SQLite.UnsafeNativeMethodsWin32.LoadLibrary(System.String)">
  11892. <summary>
  11893. This is the P/Invoke method that wraps the native Win32 LoadLibrary
  11894. function. See the MSDN documentation for full details on what it
  11895. does.
  11896. </summary>
  11897. <param name="fileName">
  11898. The name of the executable library.
  11899. </param>
  11900. <returns>
  11901. The native module handle upon success -OR- IntPtr.Zero on failure.
  11902. </returns>
  11903. </member>
  11904. <member name="M:System.Data.SQLite.UnsafeNativeMethodsWin32.GetSystemInfo(System.Data.SQLite.UnsafeNativeMethodsWin32.SYSTEM_INFO@)">
  11905. <summary>
  11906. This is the P/Invoke method that wraps the native Win32 GetSystemInfo
  11907. function. See the MSDN documentation for full details on what it
  11908. does.
  11909. </summary>
  11910. <param name="systemInfo">
  11911. The system information structure to be filled in by the function.
  11912. </param>
  11913. </member>
  11914. <member name="T:System.Data.SQLite.UnsafeNativeMethodsWin32.ProcessorArchitecture">
  11915. <summary>
  11916. This enumeration contains the possible values for the processor
  11917. architecture field of the system information structure.
  11918. </summary>
  11919. </member>
  11920. <member name="T:System.Data.SQLite.UnsafeNativeMethodsWin32.SYSTEM_INFO">
  11921. <summary>
  11922. This structure contains information about the current computer. This
  11923. includes the processor type, page size, memory addresses, etc.
  11924. </summary>
  11925. </member>
  11926. <member name="T:System.Data.SQLite.UnsafeNativeMethods">
  11927. <summary>
  11928. This class declares P/Invoke methods to call native SQLite APIs.
  11929. </summary>
  11930. </member>
  11931. <member name="F:System.Data.SQLite.UnsafeNativeMethods.DllFileExtension">
  11932. <summary>
  11933. The file extension used for dynamic link libraries.
  11934. </summary>
  11935. </member>
  11936. <member name="F:System.Data.SQLite.UnsafeNativeMethods.ConfigFileExtension">
  11937. <summary>
  11938. The primary file extension used for the XML configuration file.
  11939. </summary>
  11940. </member>
  11941. <member name="F:System.Data.SQLite.UnsafeNativeMethods.AltConfigFileExtension">
  11942. <summary>
  11943. The secondary file extension used for the XML configuration file.
  11944. </summary>
  11945. </member>
  11946. <member name="F:System.Data.SQLite.UnsafeNativeMethods.XmlConfigFileName">
  11947. <summary>
  11948. This is the name of the primary XML configuration file specific
  11949. to the System.Data.SQLite assembly.
  11950. </summary>
  11951. </member>
  11952. <member name="F:System.Data.SQLite.UnsafeNativeMethods.XmlAltConfigFileName">
  11953. <summary>
  11954. This is the name of the secondary XML configuration file specific
  11955. to the System.Data.SQLite assembly.
  11956. </summary>
  11957. </member>
  11958. <member name="F:System.Data.SQLite.UnsafeNativeMethods.XmlConfigDirectoryToken">
  11959. <summary>
  11960. This is the XML configuratrion file token that will be replaced with
  11961. the qualified path to the directory containing the XML configuration
  11962. file.
  11963. </summary>
  11964. </member>
  11965. <member name="F:System.Data.SQLite.UnsafeNativeMethods.AssemblyDirectoryToken">
  11966. <summary>
  11967. This is the environment variable token that will be replaced with
  11968. the qualified path to the directory containing this assembly.
  11969. </summary>
  11970. </member>
  11971. <member name="F:System.Data.SQLite.UnsafeNativeMethods.TargetFrameworkToken">
  11972. <summary>
  11973. This is the environment variable token that will be replaced with an
  11974. abbreviation of the target framework attribute value associated with
  11975. this assembly.
  11976. </summary>
  11977. </member>
  11978. <member name="F:System.Data.SQLite.UnsafeNativeMethods.staticSyncRoot">
  11979. <summary>
  11980. This lock is used to protect the static _SQLiteNativeModuleFileName,
  11981. _SQLiteNativeModuleHandle, and processorArchitecturePlatforms fields.
  11982. </summary>
  11983. </member>
  11984. <member name="F:System.Data.SQLite.UnsafeNativeMethods.targetFrameworkAbbreviations">
  11985. <summary>
  11986. This dictionary stores the mappings between target framework names
  11987. and their associated (NuGet) abbreviations. These mappings are only
  11988. used by the <see cref="M:System.Data.SQLite.UnsafeNativeMethods.AbbreviateTargetFramework(System.String)"/> method.
  11989. </summary>
  11990. </member>
  11991. <member name="F:System.Data.SQLite.UnsafeNativeMethods.processorArchitecturePlatforms">
  11992. <summary>
  11993. This dictionary stores the mappings between processor architecture
  11994. names and platform names. These mappings are now used for two
  11995. purposes. First, they are used to determine if the assembly code
  11996. base should be used instead of the location, based upon whether one
  11997. or more of the named sub-directories exist within the assembly code
  11998. base. Second, they are used to assist in loading the appropriate
  11999. SQLite interop assembly into the current process.
  12000. </summary>
  12001. </member>
  12002. <member name="F:System.Data.SQLite.UnsafeNativeMethods.cachedAssemblyDirectory">
  12003. <summary>
  12004. This is the cached return value from the
  12005. <see cref="M:System.Data.SQLite.UnsafeNativeMethods.GetAssemblyDirectory"/> method -OR- null if that method
  12006. has never returned a valid value.
  12007. </summary>
  12008. </member>
  12009. <member name="F:System.Data.SQLite.UnsafeNativeMethods.noAssemblyDirectory">
  12010. <summary>
  12011. When this field is non-zero, it indicates the
  12012. <see cref="M:System.Data.SQLite.UnsafeNativeMethods.GetAssemblyDirectory"/> method was not able to locate a
  12013. suitable assembly directory. The
  12014. <see cref="M:System.Data.SQLite.UnsafeNativeMethods.GetCachedAssemblyDirectory"/> method will check this
  12015. field and skips calls into the <see cref="M:System.Data.SQLite.UnsafeNativeMethods.GetAssemblyDirectory"/>
  12016. method whenever it is non-zero.
  12017. </summary>
  12018. </member>
  12019. <member name="F:System.Data.SQLite.UnsafeNativeMethods.cachedXmlConfigFileName">
  12020. <summary>
  12021. This is the cached return value from the
  12022. <see cref="M:System.Data.SQLite.UnsafeNativeMethods.GetXmlConfigFileName"/> method -OR- null if that method
  12023. has never returned a valid value.
  12024. </summary>
  12025. </member>
  12026. <member name="F:System.Data.SQLite.UnsafeNativeMethods.noXmlConfigFileName">
  12027. <summary>
  12028. When this field is non-zero, it indicates the
  12029. <see cref="M:System.Data.SQLite.UnsafeNativeMethods.GetXmlConfigFileName"/> method was not able to locate a
  12030. suitable XML configuration file name. The
  12031. <see cref="M:System.Data.SQLite.UnsafeNativeMethods.GetCachedXmlConfigFileName"/> method will check this
  12032. field and skips calls into the <see cref="M:System.Data.SQLite.UnsafeNativeMethods.GetXmlConfigFileName"/>
  12033. method whenever it is non-zero.
  12034. </summary>
  12035. </member>
  12036. <member name="M:System.Data.SQLite.UnsafeNativeMethods.#cctor">
  12037. <summary>
  12038. For now, this method simply calls the Initialize method.
  12039. </summary>
  12040. </member>
  12041. <member name="M:System.Data.SQLite.UnsafeNativeMethods.Initialize">
  12042. <summary>
  12043. Attempts to initialize this class by pre-loading the native SQLite
  12044. library for the processor architecture of the current process.
  12045. </summary>
  12046. </member>
  12047. <member name="M:System.Data.SQLite.UnsafeNativeMethods.MaybeCombinePath(System.String,System.String)">
  12048. <summary>
  12049. Combines two path strings.
  12050. </summary>
  12051. <param name="path1">
  12052. The first path -OR- null.
  12053. </param>
  12054. <param name="path2">
  12055. The second path -OR- null.
  12056. </param>
  12057. <returns>
  12058. The combined path string -OR- null if both of the original path
  12059. strings are null.
  12060. </returns>
  12061. </member>
  12062. <member name="M:System.Data.SQLite.UnsafeNativeMethods.ResetCachedXmlConfigFileName">
  12063. <summary>
  12064. Resets the cached XML configuration file name value, thus forcing the
  12065. next call to <see cref="M:System.Data.SQLite.UnsafeNativeMethods.GetCachedXmlConfigFileName"/> method to rely
  12066. upon the <see cref="M:System.Data.SQLite.UnsafeNativeMethods.GetXmlConfigFileName"/> method to fetch the
  12067. XML configuration file name.
  12068. </summary>
  12069. </member>
  12070. <member name="M:System.Data.SQLite.UnsafeNativeMethods.GetCachedXmlConfigFileName">
  12071. <summary>
  12072. Queries and returns the cached XML configuration file name for the
  12073. assembly containing the managed System.Data.SQLite components, if
  12074. available. If the cached XML configuration file name value is not
  12075. available, the <see cref="M:System.Data.SQLite.UnsafeNativeMethods.GetXmlConfigFileName"/> method will
  12076. be used to obtain the XML configuration file name.
  12077. </summary>
  12078. <returns>
  12079. The XML configuration file name -OR- null if it cannot be determined
  12080. or does not exist.
  12081. </returns>
  12082. </member>
  12083. <member name="M:System.Data.SQLite.UnsafeNativeMethods.GetXmlConfigFileName">
  12084. <summary>
  12085. Queries and returns the XML configuration file name for the assembly
  12086. containing the managed System.Data.SQLite components.
  12087. </summary>
  12088. <returns>
  12089. The XML configuration file name -OR- null if it cannot be determined
  12090. or does not exist.
  12091. </returns>
  12092. </member>
  12093. <member name="M:System.Data.SQLite.UnsafeNativeMethods.ReplaceXmlConfigFileTokens(System.String,System.String)">
  12094. <summary>
  12095. If necessary, replaces all supported XML configuration file tokens
  12096. with their associated values.
  12097. </summary>
  12098. <param name="fileName">
  12099. The name of the XML configuration file being read.
  12100. </param>
  12101. <param name="value">
  12102. A setting value read from the XML configuration file.
  12103. </param>
  12104. <returns>
  12105. The value of the <paramref name="value" /> will all supported XML
  12106. configuration file tokens replaced. No return value is reserved
  12107. to indicate an error. This method cannot fail.
  12108. </returns>
  12109. </member>
  12110. <member name="M:System.Data.SQLite.UnsafeNativeMethods.GetSettingValueViaXmlConfigFile(System.String,System.String,System.String,System.Boolean,System.Boolean)">
  12111. <summary>
  12112. Queries and returns the value of the specified setting, using the
  12113. specified XML configuration file.
  12114. </summary>
  12115. <param name="fileName">
  12116. The name of the XML configuration file to read.
  12117. </param>
  12118. <param name="name">
  12119. The name of the setting.
  12120. </param>
  12121. <param name="default">
  12122. The value to be returned if the setting has not been set explicitly
  12123. or cannot be determined.
  12124. </param>
  12125. <param name="expand">
  12126. Non-zero to expand any environment variable references contained in
  12127. the setting value to be returned. This has no effect on the .NET
  12128. Compact Framework.
  12129. </param>
  12130. <param name="tokens">
  12131. Non-zero to replace any special token references contained in the
  12132. setting value to be returned. This has no effect on the .NET Compact
  12133. Framework.
  12134. </param>
  12135. <returns>
  12136. The value of the setting -OR- the default value specified by
  12137. <paramref name="default" /> if it has not been set explicitly or
  12138. cannot be determined.
  12139. </returns>
  12140. </member>
  12141. <member name="M:System.Data.SQLite.UnsafeNativeMethods.GetAssemblyTargetFramework(System.Reflection.Assembly)">
  12142. <summary>
  12143. Attempts to determine the target framework attribute value that is
  12144. associated with the specified managed assembly, if applicable.
  12145. </summary>
  12146. <param name="assembly">
  12147. The managed assembly to read the target framework attribute value
  12148. from.
  12149. </param>
  12150. <returns>
  12151. The value of the target framework attribute value for the specified
  12152. managed assembly -OR- null if it cannot be determined. If this
  12153. assembly was compiled with a version of the .NET Framework prior to
  12154. version 4.0, the value returned MAY reflect that version of the .NET
  12155. Framework instead of the one associated with the specified managed
  12156. assembly.
  12157. </returns>
  12158. </member>
  12159. <member name="M:System.Data.SQLite.UnsafeNativeMethods.AbbreviateTargetFramework(System.String)">
  12160. <summary>
  12161. Accepts a long target framework attribute value and makes it into a
  12162. much shorter version, suitable for use with NuGet packages.
  12163. </summary>
  12164. <param name="targetFramework">
  12165. The long target framework attribute value to convert.
  12166. </param>
  12167. <returns>
  12168. The short target framework attribute value -OR- null if it cannot
  12169. be determined or converted.
  12170. </returns>
  12171. </member>
  12172. <member name="M:System.Data.SQLite.UnsafeNativeMethods.ReplaceEnvironmentVariableTokens(System.String)">
  12173. <summary>
  12174. If necessary, replaces all supported environment variable tokens
  12175. with their associated values.
  12176. </summary>
  12177. <param name="value">
  12178. A setting value read from an environment variable.
  12179. </param>
  12180. <returns>
  12181. The value of the <paramref name="value" /> will all supported
  12182. environment variable tokens replaced. No return value is reserved
  12183. to indicate an error. This method cannot fail.
  12184. </returns>
  12185. </member>
  12186. <member name="M:System.Data.SQLite.UnsafeNativeMethods.GetSettingValue(System.String,System.String)">
  12187. <summary>
  12188. Queries and returns the value of the specified setting, using the XML
  12189. configuration file and/or the environment variables for the current
  12190. process and/or the current system, when available.
  12191. </summary>
  12192. <param name="name">
  12193. The name of the setting.
  12194. </param>
  12195. <param name="default">
  12196. The value to be returned if the setting has not been set explicitly
  12197. or cannot be determined.
  12198. </param>
  12199. <returns>
  12200. The value of the setting -OR- the default value specified by
  12201. <paramref name="default" /> if it has not been set explicitly or
  12202. cannot be determined. By default, all references to existing
  12203. environment variables will be expanded to their corresponding values
  12204. within the value to be returned unless either the "No_Expand" or
  12205. "No_Expand_<paramref name="name" />" environment variable is set [to
  12206. anything].
  12207. </returns>
  12208. </member>
  12209. <member name="M:System.Data.SQLite.UnsafeNativeMethods.ResetCachedAssemblyDirectory">
  12210. <summary>
  12211. Resets the cached assembly directory value, thus forcing the next
  12212. call to <see cref="M:System.Data.SQLite.UnsafeNativeMethods.GetCachedAssemblyDirectory"/> method to rely
  12213. upon the <see cref="M:System.Data.SQLite.UnsafeNativeMethods.GetAssemblyDirectory"/> method to fetch the
  12214. assembly directory.
  12215. </summary>
  12216. </member>
  12217. <member name="M:System.Data.SQLite.UnsafeNativeMethods.GetCachedAssemblyDirectory">
  12218. <summary>
  12219. Queries and returns the cached directory for the assembly currently
  12220. being executed, if available. If the cached assembly directory value
  12221. is not available, the <see cref="M:System.Data.SQLite.UnsafeNativeMethods.GetAssemblyDirectory"/> method will
  12222. be used to obtain the assembly directory.
  12223. </summary>
  12224. <returns>
  12225. The directory for the assembly currently being executed -OR- null if
  12226. it cannot be determined.
  12227. </returns>
  12228. </member>
  12229. <member name="M:System.Data.SQLite.UnsafeNativeMethods.GetAssemblyDirectory">
  12230. <summary>
  12231. Queries and returns the directory for the assembly currently being
  12232. executed.
  12233. </summary>
  12234. <returns>
  12235. The directory for the assembly currently being executed -OR- null if
  12236. it cannot be determined.
  12237. </returns>
  12238. </member>
  12239. <member name="F:System.Data.SQLite.UnsafeNativeMethods.PROCESSOR_ARCHITECTURE">
  12240. <summary>
  12241. The name of the environment variable containing the processor
  12242. architecture of the current process.
  12243. </summary>
  12244. </member>
  12245. <member name="F:System.Data.SQLite.UnsafeNativeMethods._SQLiteNativeModuleFileName">
  12246. <summary>
  12247. The native module file name for the native SQLite library or null.
  12248. </summary>
  12249. </member>
  12250. <member name="F:System.Data.SQLite.UnsafeNativeMethods._SQLiteNativeModuleHandle">
  12251. <summary>
  12252. The native module handle for the native SQLite library or the value
  12253. IntPtr.Zero.
  12254. </summary>
  12255. </member>
  12256. <member name="M:System.Data.SQLite.UnsafeNativeMethods.GetNativeLibraryFileNameOnly">
  12257. <summary>
  12258. Determines the base file name (without any directory information)
  12259. for the native SQLite library to be pre-loaded by this class.
  12260. </summary>
  12261. <returns>
  12262. The base file name for the native SQLite library to be pre-loaded by
  12263. this class -OR- null if its value cannot be determined.
  12264. </returns>
  12265. </member>
  12266. <member name="M:System.Data.SQLite.UnsafeNativeMethods.SearchForDirectory(System.String@,System.String@,System.Boolean@)">
  12267. <summary>
  12268. Searches for the native SQLite library in the directory containing
  12269. the assembly currently being executed as well as the base directory
  12270. for the current application domain.
  12271. </summary>
  12272. <param name="baseDirectory">
  12273. Upon success, this parameter will be modified to refer to the base
  12274. directory containing the native SQLite library.
  12275. </param>
  12276. <param name="processorArchitecture">
  12277. Upon success, this parameter will be modified to refer to the name
  12278. of the immediate directory (i.e. the offset from the base directory)
  12279. containing the native SQLite library.
  12280. </param>
  12281. <param name="allowBaseDirectoryOnly">
  12282. Upon success, this parameter will be modified to non-zero only if
  12283. the base directory itself should be allowed for loading the native
  12284. library.
  12285. </param>
  12286. <returns>
  12287. Non-zero (success) if the native SQLite library was found; otherwise,
  12288. zero (failure).
  12289. </returns>
  12290. </member>
  12291. <member name="M:System.Data.SQLite.UnsafeNativeMethods.GetBaseDirectory">
  12292. <summary>
  12293. Queries and returns the base directory of the current application
  12294. domain.
  12295. </summary>
  12296. <returns>
  12297. The base directory for the current application domain -OR- null if it
  12298. cannot be determined.
  12299. </returns>
  12300. </member>
  12301. <member name="M:System.Data.SQLite.UnsafeNativeMethods.FixUpDllFileName(System.String)">
  12302. <summary>
  12303. Determines if the dynamic link library file name requires a suffix
  12304. and adds it if necessary.
  12305. </summary>
  12306. <param name="fileName">
  12307. The original dynamic link library file name to inspect.
  12308. </param>
  12309. <returns>
  12310. The dynamic link library file name, possibly modified to include an
  12311. extension.
  12312. </returns>
  12313. </member>
  12314. <member name="M:System.Data.SQLite.UnsafeNativeMethods.GetProcessorArchitecture">
  12315. <summary>
  12316. Queries and returns the processor architecture of the current
  12317. process.
  12318. </summary>
  12319. <returns>
  12320. The processor architecture of the current process -OR- null if it
  12321. cannot be determined.
  12322. </returns>
  12323. </member>
  12324. <member name="M:System.Data.SQLite.UnsafeNativeMethods.GetPlatformName(System.String)">
  12325. <summary>
  12326. Given the processor architecture, returns the name of the platform.
  12327. </summary>
  12328. <param name="processorArchitecture">
  12329. The processor architecture to be translated to a platform name.
  12330. </param>
  12331. <returns>
  12332. The platform name for the specified processor architecture -OR- null
  12333. if it cannot be determined.
  12334. </returns>
  12335. </member>
  12336. <member name="M:System.Data.SQLite.UnsafeNativeMethods.PreLoadSQLiteDll(System.String,System.String,System.Boolean,System.String@,System.IntPtr@)">
  12337. <summary>
  12338. Attempts to load the native SQLite library based on the specified
  12339. directory and processor architecture.
  12340. </summary>
  12341. <param name="baseDirectory">
  12342. The base directory to use, null for default (the base directory of
  12343. the current application domain). This directory should contain the
  12344. processor architecture specific sub-directories.
  12345. </param>
  12346. <param name="processorArchitecture">
  12347. The requested processor architecture, null for default (the
  12348. processor architecture of the current process). This caller should
  12349. almost always specify null for this parameter.
  12350. </param>
  12351. <param name="allowBaseDirectoryOnly">
  12352. Non-zero indicates that the native SQLite library can be loaded
  12353. from the base directory itself.
  12354. </param>
  12355. <param name="nativeModuleFileName">
  12356. The candidate native module file name to load will be stored here,
  12357. if necessary.
  12358. </param>
  12359. <param name="nativeModuleHandle">
  12360. The native module handle as returned by LoadLibrary will be stored
  12361. here, if necessary. This value will be IntPtr.Zero if the call to
  12362. LoadLibrary fails.
  12363. </param>
  12364. <returns>
  12365. Non-zero if the native module was loaded successfully; otherwise,
  12366. zero.
  12367. </returns>
  12368. </member>
  12369. <member name="T:System.Data.SQLite.SR">
  12370. <summary>
  12371. A strongly-typed resource class, for looking up localized strings, etc.
  12372. </summary>
  12373. </member>
  12374. <member name="P:System.Data.SQLite.SR.ResourceManager">
  12375. <summary>
  12376. Returns the cached ResourceManager instance used by this class.
  12377. </summary>
  12378. </member>
  12379. <member name="P:System.Data.SQLite.SR.Culture">
  12380. <summary>
  12381. Overrides the current thread's CurrentUICulture property for all
  12382. resource lookups using this strongly typed resource class.
  12383. </summary>
  12384. </member>
  12385. <member name="P:System.Data.SQLite.SR.DataTypes">
  12386. <summary>
  12387. Looks up a localized string similar to &lt;?xml version=&quot;1.0&quot; standalone=&quot;yes&quot;?&gt;
  12388. &lt;DocumentElement&gt;
  12389. &lt;DataTypes&gt;
  12390. &lt;TypeName&gt;smallint&lt;/TypeName&gt;
  12391. &lt;ProviderDbType&gt;10&lt;/ProviderDbType&gt;
  12392. &lt;ColumnSize&gt;5&lt;/ColumnSize&gt;
  12393. &lt;DataType&gt;System.Int16&lt;/DataType&gt;
  12394. &lt;CreateFormat&gt;smallint&lt;/CreateFormat&gt;
  12395. &lt;IsAutoIncrementable&gt;false&lt;/IsAutoIncrementable&gt;
  12396. &lt;IsCaseSensitive&gt;false&lt;/IsCaseSensitive&gt;
  12397. &lt;IsFixedLength&gt;true&lt;/IsFixedLength&gt;
  12398. &lt;IsFixedPrecisionScale&gt;true&lt;/IsFixedPrecisionScale&gt;
  12399. &lt;IsLong&gt;false&lt;/IsLong&gt;
  12400. &lt;IsNullable&gt;true&lt;/ [rest of string was truncated]&quot;;.
  12401. </summary>
  12402. </member>
  12403. <member name="P:System.Data.SQLite.SR.Keywords">
  12404. <summary>
  12405. Looks up a localized string similar to ALL,ALTER,AND,AS,AUTOINCREMENT,BETWEEN,BY,CASE,CHECK,COLLATE,COMMIT,CONSTRAINT,CREATE,CROSS,DEFAULT,DEFERRABLE,DELETE,DISTINCT,DROP,ELSE,ESCAPE,EXCEPT,FOREIGN,FROM,FULL,GROUP,HAVING,IN,INDEX,INNER,INSERT,INTERSECT,INTO,IS,ISNULL,JOIN,LEFT,LIMIT,NATURAL,NOT,NOTNULL,NULL,ON,OR,ORDER,OUTER,PRIMARY,REFERENCES,RIGHT,ROLLBACK,SELECT,SET,TABLE,THEN,TO,TRANSACTION,UNION,UNIQUE,UPDATE,USING,VALUES,WHEN,WHERE.
  12406. </summary>
  12407. </member>
  12408. <member name="P:System.Data.SQLite.SR.MetaDataCollections">
  12409. <summary>
  12410. Looks up a localized string similar to &lt;?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot; ?&gt;
  12411. &lt;DocumentElement&gt;
  12412. &lt;MetaDataCollections&gt;
  12413. &lt;CollectionName&gt;MetaDataCollections&lt;/CollectionName&gt;
  12414. &lt;NumberOfRestrictions&gt;0&lt;/NumberOfRestrictions&gt;
  12415. &lt;NumberOfIdentifierParts&gt;0&lt;/NumberOfIdentifierParts&gt;
  12416. &lt;/MetaDataCollections&gt;
  12417. &lt;MetaDataCollections&gt;
  12418. &lt;CollectionName&gt;DataSourceInformation&lt;/CollectionName&gt;
  12419. &lt;NumberOfRestrictions&gt;0&lt;/NumberOfRestrictions&gt;
  12420. &lt;NumberOfIdentifierParts&gt;0&lt;/NumberOfIdentifierParts&gt;
  12421. &lt;/MetaDataCollections&gt;
  12422. &lt;MetaDataC [rest of string was truncated]&quot;;.
  12423. </summary>
  12424. </member>
  12425. <member name="T:System.Data.SQLite.ISQLiteNativeModule">
  12426. <summary>
  12427. This interface represents a virtual table implementation written in
  12428. native code.
  12429. </summary>
  12430. </member>
  12431. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)">
  12432. <summary>
  12433. <para><code>
  12434. int (*xCreate)(sqlite3 *db, void *pAux,
  12435. int argc, char *const*argv,
  12436. sqlite3_vtab **ppVTab,
  12437. char **pzErr);
  12438. </code></para>
  12439. <para>
  12440. The xCreate method is called to create a new instance of a virtual table
  12441. in response to a CREATE VIRTUAL TABLE statement.
  12442. If the xCreate method is the same pointer as the xConnect method, then the
  12443. virtual table is an eponymous virtual table.
  12444. If the xCreate method is omitted (if it is a NULL pointer) then the virtual
  12445. table is an eponymous-only virtual table.
  12446. </para>
  12447. <para>
  12448. The db parameter is a pointer to the SQLite database connection that
  12449. is executing the CREATE VIRTUAL TABLE statement.
  12450. The pAux argument is the copy of the client data pointer that was the
  12451. fourth argument to the sqlite3_create_module() or
  12452. sqlite3_create_module_v2() call that registered the
  12453. virtual table module.
  12454. The argv parameter is an array of argc pointers to null terminated strings.
  12455. The first string, argv[0], is the name of the module being invoked. The
  12456. module name is the name provided as the second argument to
  12457. sqlite3_create_module() and as the argument to the USING clause of the
  12458. CREATE VIRTUAL TABLE statement that is running.
  12459. The second, argv[1], is the name of the database in which the new virtual table is being created. The database name is "main" for the primary database, or
  12460. "temp" for TEMP database, or the name given at the end of the ATTACH
  12461. statement for attached databases. The third element of the array, argv[2],
  12462. is the name of the new virtual table, as specified following the TABLE
  12463. keyword in the CREATE VIRTUAL TABLE statement.
  12464. If present, the fourth and subsequent strings in the argv[] array report
  12465. the arguments to the module name in the CREATE VIRTUAL TABLE statement.
  12466. </para>
  12467. <para>
  12468. The job of this method is to construct the new virtual table object
  12469. (an sqlite3_vtab object) and return a pointer to it in *ppVTab.
  12470. </para>
  12471. <para>
  12472. As part of the task of creating a new sqlite3_vtab structure, this
  12473. method <u>must</u> invoke sqlite3_declare_vtab() to tell the SQLite
  12474. core about the columns and datatypes in the virtual table.
  12475. The sqlite3_declare_vtab() API has the following prototype:
  12476. </para>
  12477. <para><code>
  12478. int sqlite3_declare_vtab(sqlite3 *db, const char *zCreateTable)
  12479. </code></para>
  12480. <para>
  12481. The first argument to sqlite3_declare_vtab() must be the same
  12482. database connection pointer as the first parameter to this method.
  12483. The second argument to sqlite3_declare_vtab() must a zero-terminated
  12484. UTF-8 string that contains a well-formed CREATE TABLE statement that
  12485. defines the columns in the virtual table and their data types.
  12486. The name of the table in this CREATE TABLE statement is ignored,
  12487. as are all constraints. Only the column names and datatypes matter.
  12488. The CREATE TABLE statement string need not to be
  12489. held in persistent memory. The string can be
  12490. deallocated and/or reused as soon as the sqlite3_declare_vtab()
  12491. routine returns.
  12492. </para>
  12493. <para>
  12494. The xCreate method need not initialize the pModule, nRef, and zErrMsg
  12495. fields of the sqlite3_vtab object. The SQLite core will take care of
  12496. that chore.
  12497. </para>
  12498. <para>
  12499. The xCreate should return SQLITE_OK if it is successful in
  12500. creating the new virtual table, or SQLITE_ERROR if it is not successful.
  12501. If not successful, the sqlite3_vtab structure must not be allocated.
  12502. An error message may optionally be returned in *pzErr if unsuccessful.
  12503. Space to hold the error message string must be allocated using
  12504. an SQLite memory allocation function like
  12505. sqlite3_malloc() or sqlite3_mprintf() as the SQLite core will
  12506. attempt to free the space using sqlite3_free() after the error has
  12507. been reported up to the application.
  12508. </para>
  12509. <para>
  12510. If the xCreate method is omitted (left as a NULL pointer) then the
  12511. virtual table is an eponymous-only virtual table. New instances of
  12512. the virtual table cannot be created using CREATE VIRTUAL TABLE and the
  12513. virtual table can only be used via its module name.
  12514. Note that SQLite versions prior to 3.9.0 (2015-10-14) do not understand
  12515. eponymous-only virtual tables and will segfault if an attempt is made
  12516. to CREATE VIRTUAL TABLE on an eponymous-only virtual table because
  12517. the xCreate method was not checked for null.
  12518. </para>
  12519. <para>
  12520. If the xCreate method is the exact same pointer as the xConnect method,
  12521. that indicates that the virtual table does not need to initialize backing
  12522. store. Such a virtual table can be used as an eponymous virtual table
  12523. or as a named virtual table using CREATE VIRTUAL TABLE or both.
  12524. </para>
  12525. <para>
  12526. If a column datatype contains the special keyword "HIDDEN"
  12527. (in any combination of upper and lower case letters) then that keyword
  12528. it is omitted from the column datatype name and the column is marked
  12529. as a hidden column internally.
  12530. A hidden column differs from a normal column in three respects:
  12531. </para>
  12532. <para>
  12533. <![CDATA[<ul>]]>
  12534. <![CDATA[<li>]]> Hidden columns are not listed in the dataset returned by
  12535. "PRAGMA table_info",
  12536. <![CDATA[</li>]]><![CDATA[<li>]]> Hidden columns are not included in the expansion of a "*"
  12537. expression in the result set of a SELECT, and
  12538. <![CDATA[</li>]]><![CDATA[<li>]]> Hidden columns are not included in the implicit column-list
  12539. used by an INSERT statement that lacks an explicit column-list.
  12540. <![CDATA[</li>]]><![CDATA[</ul>]]>
  12541. </para>
  12542. <para>
  12543. For example, if the following SQL is passed to sqlite3_declare_vtab():
  12544. </para>
  12545. <para><code>
  12546. CREATE TABLE x(a HIDDEN VARCHAR(12), b INTEGER, c INTEGER Hidden);
  12547. </code></para>
  12548. <para>
  12549. Then the virtual table would be created with two hidden columns,
  12550. and with datatypes of "VARCHAR(12)" and "INTEGER".
  12551. </para>
  12552. <para>
  12553. An example use of hidden columns can be seen in the FTS3 virtual
  12554. table implementation, where every FTS virtual table
  12555. contains an FTS hidden column that is used to pass information from the
  12556. virtual table into FTS auxiliary functions and to the FTS MATCH operator.
  12557. </para>
  12558. <para>
  12559. A virtual table that contains hidden columns can be used like
  12560. a table-valued function in the FROM clause of a SELECT statement.
  12561. The arguments to the table-valued function become constraints on
  12562. the HIDDEN columns of the virtual table.
  12563. </para>
  12564. <para>
  12565. For example, the "generate_series" extension (located in the
  12566. ext/misc/series.c
  12567. file in the source tree)
  12568. implements an eponymous virtual table with the following schema:
  12569. </para>
  12570. <para><code>
  12571. CREATE TABLE generate_series(
  12572. value,
  12573. start HIDDEN,
  12574. stop HIDDEN,
  12575. step HIDDEN
  12576. );
  12577. </code></para>
  12578. <para>
  12579. The sqlite3_module.xBestIndex method in the implementation of this
  12580. table checks for equality constraints against the HIDDEN columns, and uses
  12581. those as input parameters to determine the range of integer "value" outputs
  12582. to generate. Reasonable defaults are used for any unconstrained columns.
  12583. For example, to list all integers between 5 and 50:
  12584. </para>
  12585. <para><code>
  12586. SELECT value FROM generate_series(5,50);
  12587. </code></para>
  12588. <para>
  12589. The previous query is equivalent to the following:
  12590. </para>
  12591. <para><code>
  12592. SELECT value FROM generate_series WHERE start=5 AND stop=50;
  12593. </code></para>
  12594. <para>
  12595. Arguments on the virtual table name are matched to hidden columns
  12596. in order. The number of arguments can be less than the
  12597. number of hidden columns, in which case the latter hidden columns are
  12598. unconstrained. However, an error results if there are more arguments
  12599. than there are hidden columns in the virtual table.
  12600. </para>
  12601. <para>
  12602. Beginning with SQLite version 3.14.0 (2016-08-08),
  12603. the CREATE TABLE statement that
  12604. is passed into sqlite3_declare_vtab() may contain a WITHOUT ROWID clause.
  12605. This is useful for cases where the virtual table rows
  12606. cannot easily be mapped into unique integers. A CREATE TABLE
  12607. statement that includes WITHOUT ROWID must define one or more columns as
  12608. the PRIMARY KEY. Every column of the PRIMARY KEY must individually be
  12609. NOT NULL and all columns for each row must be collectively unique.
  12610. </para>
  12611. <para>
  12612. Note that SQLite does not enforce the PRIMARY KEY for a WITHOUT ROWID
  12613. virtual table. Enforcement is the responsibility of the underlying
  12614. virtual table implementation. But SQLite does assume that the PRIMARY KEY
  12615. constraint is valid - that the identified columns really are UNIQUE and
  12616. NOT NULL - and it uses that assumption to optimize queries against the
  12617. virtual table.
  12618. </para>
  12619. <para>
  12620. The rowid column is not accessible on a
  12621. WITHOUT ROWID virtual table (of course).
  12622. </para>
  12623. <para>
  12624. The xUpdate method was originally designed around having a
  12625. ROWID as a single value. The xUpdate method has been expanded to
  12626. accommodate an arbitrary PRIMARY KEY in place of the ROWID, but the
  12627. PRIMARY KEY must still be only one column. For this reason, SQLite
  12628. will reject any WITHOUT ROWID virtual table that has more than one
  12629. PRIMARY KEY column and a non-NULL xUpdate method.
  12630. </para>
  12631. </summary>
  12632. <param name="pDb">
  12633. The native database connection handle.
  12634. </param>
  12635. <param name="pAux">
  12636. The original native pointer value that was provided to the
  12637. sqlite3_create_module(), sqlite3_create_module_v2() or
  12638. sqlite3_create_disposable_module() functions.
  12639. </param>
  12640. <param name="argc">
  12641. The number of arguments from the CREATE VIRTUAL TABLE statement.
  12642. </param>
  12643. <param name="argv">
  12644. The array of string arguments from the CREATE VIRTUAL TABLE
  12645. statement.
  12646. </param>
  12647. <param name="pVtab">
  12648. Upon success, this parameter must be modified to point to the newly
  12649. created native sqlite3_vtab derived structure.
  12650. </param>
  12651. <param name="pError">
  12652. Upon failure, this parameter must be modified to point to the error
  12653. message, with the underlying memory having been obtained from the
  12654. sqlite3_malloc() function.
  12655. </param>
  12656. <returns>
  12657. A standard SQLite return code.
  12658. </returns>
  12659. </member>
  12660. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)">
  12661. <summary>
  12662. <para><code>
  12663. int (*xConnect)(sqlite3*, void *pAux,
  12664. int argc, char *const*argv,
  12665. sqlite3_vtab **ppVTab,
  12666. char **pzErr);
  12667. </code></para>
  12668. <para>
  12669. The xConnect method is very similar to xCreate.
  12670. It has the same parameters and constructs a new sqlite3_vtab structure
  12671. just like xCreate.
  12672. And it must also call sqlite3_declare_vtab() like xCreate.
  12673. </para>
  12674. <para>
  12675. The difference is that xConnect is called to establish a new
  12676. connection to an existing virtual table whereas xCreate is called
  12677. to create a new virtual table from scratch.
  12678. </para>
  12679. <para>
  12680. The xCreate and xConnect methods are only different when the
  12681. virtual table has some kind of backing store that must be initialized
  12682. the first time the virtual table is created. The xCreate method creates
  12683. and initializes the backing store. The xConnect method just connects
  12684. to an existing backing store. When xCreate and xConnect are the same,
  12685. the table is an eponymous virtual table.
  12686. </para>
  12687. <para>
  12688. As an example, consider a virtual table implementation that
  12689. provides read-only access to existing comma-separated-value (CSV)
  12690. files on disk. There is no backing store that needs to be created
  12691. or initialized for such a virtual table (since the CSV files already
  12692. exist on disk) so the xCreate and xConnect methods will be identical
  12693. for that module.
  12694. </para>
  12695. <para>
  12696. Another example is a virtual table that implements a full-text index.
  12697. The xCreate method must create and initialize data structures to hold
  12698. the dictionary and posting lists for that index. The xConnect method,
  12699. on the other hand, only has to locate and use an existing dictionary
  12700. and posting lists that were created by a prior xCreate call.
  12701. </para>
  12702. <para>
  12703. The xConnect method must return SQLITE_OK if it is successful
  12704. in creating the new virtual table, or SQLITE_ERROR if it is not
  12705. successful. If not successful, the sqlite3_vtab structure must not be
  12706. allocated. An error message may optionally be returned in *pzErr if
  12707. unsuccessful.
  12708. Space to hold the error message string must be allocated using
  12709. an SQLite memory allocation function like
  12710. sqlite3_malloc() or sqlite3_mprintf() as the SQLite core will
  12711. attempt to free the space using sqlite3_free() after the error has
  12712. been reported up to the application.
  12713. </para>
  12714. <para>
  12715. The xConnect method is required for every virtual table implementation,
  12716. though the xCreate and xConnect pointers of the sqlite3_module object
  12717. may point to the same function if the virtual table does not need to
  12718. initialize backing store.
  12719. </para>
  12720. </summary>
  12721. <param name="pDb">
  12722. The native database connection handle.
  12723. </param>
  12724. <param name="pAux">
  12725. The original native pointer value that was provided to the
  12726. sqlite3_create_module(), sqlite3_create_module_v2() or
  12727. sqlite3_create_disposable_module() functions.
  12728. </param>
  12729. <param name="argc">
  12730. The number of arguments from the CREATE VIRTUAL TABLE statement.
  12731. </param>
  12732. <param name="argv">
  12733. The array of string arguments from the CREATE VIRTUAL TABLE
  12734. statement.
  12735. </param>
  12736. <param name="pVtab">
  12737. Upon success, this parameter must be modified to point to the newly
  12738. created native sqlite3_vtab derived structure.
  12739. </param>
  12740. <param name="pError">
  12741. Upon failure, this parameter must be modified to point to the error
  12742. message, with the underlying memory having been obtained from the
  12743. sqlite3_malloc() function.
  12744. </param>
  12745. <returns>
  12746. A standard SQLite return code.
  12747. </returns>
  12748. </member>
  12749. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xBestIndex(System.IntPtr,System.IntPtr)">
  12750. <summary>
  12751. <para>
  12752. SQLite uses the xBestIndex method of a virtual table module to determine
  12753. the best way to access the virtual table.
  12754. The xBestIndex method has a prototype like this:
  12755. </para>
  12756. <para><code>
  12757. int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info*);
  12758. </code></para>
  12759. <para>
  12760. The SQLite core communicates with the xBestIndex method by filling
  12761. in certain fields of the sqlite3_index_info structure and passing a
  12762. pointer to that structure into xBestIndex as the second parameter.
  12763. The xBestIndex method fills out other fields of this structure which
  12764. forms the reply. The sqlite3_index_info structure looks like this:
  12765. </para>
  12766. <para><code>
  12767. struct sqlite3_index_info {
  12768. /* Inputs */
  12769. const int nConstraint; /* Number of entries in aConstraint */
  12770. const struct sqlite3_index_constraint {
  12771. int iColumn; /* Column constrained. -1 for ROWID */
  12772. unsigned char op; /* Constraint operator */
  12773. unsigned char usable; /* True if this constraint is usable */
  12774. int iTermOffset; /* Used internally - xBestIndex should ignore */
  12775. } *const aConstraint; /* Table of WHERE clause constraints */
  12776. const int nOrderBy; /* Number of terms in the ORDER BY clause */
  12777. const struct sqlite3_index_orderby {
  12778. int iColumn; /* Column number */
  12779. unsigned char desc; /* True for DESC. False for ASC. */
  12780. } *const aOrderBy; /* The ORDER BY clause */
  12781. /* Outputs */
  12782. struct sqlite3_index_constraint_usage {
  12783. int argvIndex; /* if >0, constraint is part of argv to xFilter */
  12784. unsigned char omit; /* Do not code a test for this constraint */
  12785. } *const aConstraintUsage;
  12786. int idxNum; /* Number used to identify the index */
  12787. char *idxStr; /* String, possibly obtained from sqlite3_malloc */
  12788. int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */
  12789. int orderByConsumed; /* True if output is already ordered */
  12790. double estimatedCost; /* Estimated cost of using this index */
  12791. <![CDATA[<b>]]>/* Fields below are only available in SQLite 3.8.2 and later */<![CDATA[</b>]]>
  12792. sqlite3_int64 estimatedRows; /* Estimated number of rows returned */
  12793. <![CDATA[<b>]]>/* Fields below are only available in SQLite 3.9.0 and later */<![CDATA[</b>]]>
  12794. int idxFlags; /* Mask of SQLITE_INDEX_SCAN_* flags */
  12795. <![CDATA[<b>]]>/* Fields below are only available in SQLite 3.10.0 and later */<![CDATA[</b>]]>
  12796. sqlite3_uint64 colUsed; /* Input: Mask of columns used by statement */
  12797. };
  12798. </code></para>
  12799. <para>
  12800. Note the warnings on the "estimatedRows", "idxFlags", and colUsed fields.
  12801. These fields were added with SQLite versions 3.8.2, 3.9.0, and 3.10.0, respectively.
  12802. Any extension that reads or writes these fields must first check that the
  12803. version of the SQLite library in use is greater than or equal to appropriate
  12804. version - perhaps comparing the value returned from sqlite3_libversion_number()
  12805. against constants 3008002, 3009000, and/or 3010000. The result of attempting
  12806. to access these fields in an sqlite3_index_info structure created by an
  12807. older version of SQLite are undefined.
  12808. </para>
  12809. <para>
  12810. In addition, there are some defined constants:
  12811. </para>
  12812. <para><code>
  12813. #define SQLITE_INDEX_CONSTRAINT_EQ 2
  12814. #define SQLITE_INDEX_CONSTRAINT_GT 4
  12815. #define SQLITE_INDEX_CONSTRAINT_LE 8
  12816. #define SQLITE_INDEX_CONSTRAINT_LT 16
  12817. #define SQLITE_INDEX_CONSTRAINT_GE 32
  12818. #define SQLITE_INDEX_CONSTRAINT_MATCH 64
  12819. #define SQLITE_INDEX_CONSTRAINT_LIKE 65 /* 3.10.0 and later */
  12820. #define SQLITE_INDEX_CONSTRAINT_GLOB 66 /* 3.10.0 and later */
  12821. #define SQLITE_INDEX_CONSTRAINT_REGEXP 67 /* 3.10.0 and later */
  12822. #define SQLITE_INDEX_CONSTRAINT_NE 68 /* 3.21.0 and later */
  12823. #define SQLITE_INDEX_CONSTRAINT_ISNOT 69 /* 3.21.0 and later */
  12824. #define SQLITE_INDEX_CONSTRAINT_ISNOTNULL 70 /* 3.21.0 and later */
  12825. #define SQLITE_INDEX_CONSTRAINT_ISNULL 71 /* 3.21.0 and later */
  12826. #define SQLITE_INDEX_CONSTRAINT_IS 72 /* 3.21.0 and later */
  12827. #define SQLITE_INDEX_CONSTRAINT_FUNCTION 150 /* 3.25.0 and later */
  12828. #define SQLITE_INDEX_SCAN_UNIQUE 1 /* Scan visits at most 1 row */
  12829. </code></para>
  12830. <para>
  12831. The SQLite core calls the xBestIndex method when it is compiling a query
  12832. that involves a virtual table. In other words, SQLite calls this method
  12833. when it is running sqlite3_prepare() or the equivalent.
  12834. By calling this method, the
  12835. SQLite core is saying to the virtual table that it needs to access
  12836. some subset of the rows in the virtual table and it wants to know the
  12837. most efficient way to do that access. The xBestIndex method replies
  12838. with information that the SQLite core can then use to conduct an
  12839. efficient search of the virtual table.
  12840. </para>
  12841. <para>
  12842. While compiling a single SQL query, the SQLite core might call
  12843. xBestIndex multiple times with different settings in sqlite3_index_info.
  12844. The SQLite core will then select the combination that appears to
  12845. give the best performance.
  12846. </para>
  12847. <para>
  12848. Before calling this method, the SQLite core initializes an instance
  12849. of the sqlite3_index_info structure with information about the
  12850. query that it is currently trying to process. This information
  12851. derives mainly from the WHERE clause and ORDER BY or GROUP BY clauses
  12852. of the query, but also from any ON or USING clauses if the query is a
  12853. join. The information that the SQLite core provides to the xBestIndex
  12854. method is held in the part of the structure that is marked as "Inputs".
  12855. The "Outputs" section is initialized to zero.
  12856. </para>
  12857. <para>
  12858. The information in the sqlite3_index_info structure is ephemeral
  12859. and may be overwritten or deallocated as soon as the xBestIndex method
  12860. returns. If the xBestIndex method needs to remember any part of the
  12861. sqlite3_index_info structure, it should make a copy. Care must be
  12862. take to store the copy in a place where it will be deallocated, such
  12863. as in the idxStr field with needToFreeIdxStr set to 1.
  12864. </para>
  12865. <para>
  12866. Note that xBestIndex will always be called before xFilter, since
  12867. the idxNum and idxStr outputs from xBestIndex are required inputs to
  12868. xFilter. However, there is no guarantee that xFilter will be called
  12869. following a successful xBestIndex.
  12870. </para>
  12871. <para>
  12872. The xBestIndex method is required for every virtual table implementation.
  12873. </para>
  12874. <para>
  12875. The main thing that the SQLite core is trying to communicate to
  12876. the virtual table is the constraints that are available to limit
  12877. the number of rows that need to be searched. The aConstraint[] array
  12878. contains one entry for each constraint. There will be exactly
  12879. nConstraint entries in that array.
  12880. </para>
  12881. <para>
  12882. Each constraint will usually correspond to a term in the WHERE clause
  12883. or in a USING or ON clause that is of the form
  12884. </para>
  12885. <para><code>
  12886. column OP EXPR
  12887. </code></para>
  12888. <para>
  12889. Where "column" is a column in the virtual table, OP is an operator
  12890. like "=" or "&lt;", and EXPR is an arbitrary expression. So, for example,
  12891. if the WHERE clause contained a term like this:
  12892. </para>
  12893. <para><code>
  12894. a = 5
  12895. </code></para>
  12896. <para>
  12897. Then one of the constraints would be on the "a" column with
  12898. operator "=" and an expression of "5". Constraints need not have a
  12899. literal representation of the WHERE clause. The query optimizer might
  12900. make transformations to the
  12901. WHERE clause in order to extract as many constraints
  12902. as it can. So, for example, if the WHERE clause contained something
  12903. like this:
  12904. </para>
  12905. <para><code>
  12906. x BETWEEN 10 AND 100 AND 999&gt;y
  12907. </code></para>
  12908. <para>
  12909. The query optimizer might translate this into three separate constraints:
  12910. </para>
  12911. <para><code>
  12912. x &gt;= 10
  12913. x &lt;= 100
  12914. y &lt; 999
  12915. </code></para>
  12916. <para>
  12917. For each such constraint, the aConstraint[].iColumn field indicates which
  12918. column appears on the left-hand side of the constraint.
  12919. The first column of the virtual table is column 0.
  12920. The rowid of the virtual table is column -1.
  12921. The aConstraint[].op field indicates which operator is used.
  12922. The SQLITE_INDEX_CONSTRAINT_* constants map integer constants
  12923. into operator values.
  12924. Columns occur in the order they were defined by the call to
  12925. sqlite3_declare_vtab() in the xCreate or xConnect method.
  12926. Hidden columns are counted when determining the column index.
  12927. </para>
  12928. <para>
  12929. If the xFindFunction() method for the virtual table is defined, and
  12930. if xFindFunction() sometimes returns SQLITE_INDEX_CONSTRAINT_FUNCTION or
  12931. larger, then the constraints might also be of the form:
  12932. </para>
  12933. <para><code>
  12934. FUNCTION( column, EXPR)
  12935. </code></para>
  12936. <para>
  12937. In this case the aConstraint[].op value is the same as the value
  12938. returned by xFindFunction() for FUNCTION.
  12939. </para>
  12940. <para>
  12941. The aConstraint[] array contains information about all constraints
  12942. that apply to the virtual table. But some of the constraints might
  12943. not be usable because of the way tables are ordered in a join.
  12944. The xBestIndex method must therefore only consider constraints
  12945. that have an aConstraint[].usable flag which is true.
  12946. </para>
  12947. <para>
  12948. In addition to WHERE clause constraints, the SQLite core also
  12949. tells the xBestIndex method about the ORDER BY clause.
  12950. (In an aggregate query, the SQLite core might put in GROUP BY clause
  12951. information in place of the ORDER BY clause information, but this fact
  12952. should not make any difference to the xBestIndex method.)
  12953. If all terms of the ORDER BY clause are columns in the virtual table,
  12954. then nOrderBy will be the number of terms in the ORDER BY clause
  12955. and the aOrderBy[] array will identify the column for each term
  12956. in the order by clause and whether or not that column is ASC or DESC.
  12957. </para>
  12958. <para>
  12959. In SQLite version 3.10.0 (2016-01-06) and later,
  12960. the colUsed field is available
  12961. to indicate which fields of the virtual table are actually used by the
  12962. statement being prepared. If the lowest bit of colUsed is set, that
  12963. means that the first column is used. The second lowest bit corresponds
  12964. to the second column. And so forth. If the most significant bit of
  12965. colUsed is set, that means that one or more columns other than the
  12966. first 63 columns are used. If column usage information is needed by the
  12967. xFilter method, then the required bits must be encoded into either
  12968. the idxNum or idxStr output fields.
  12969. </para>
  12970. <para>
  12971. For the LIKE, GLOB, REGEXP, and MATCH operators, the
  12972. aConstraint[].iColumn value is the virtual table column that
  12973. is the left operand of the operator. However, if these operators
  12974. are expressed as function calls instead of operators, then
  12975. the aConstraint[].iColumn value references the virtual table
  12976. column that is the second argument to that function:
  12977. </para>
  12978. <para><code>
  12979. LIKE(<i>EXPR</i>, <i>column</i>)<![CDATA[<br>]]>
  12980. GLOB(<i>EXPR</i>, <i>column</i>)<![CDATA[<br>]]>
  12981. REGEXP(<i>EXPR</i>, <i>column</i>)<![CDATA[<br>]]>
  12982. MATCH(<i>EXPR</i>, <i>column</i>)<![CDATA[<br>]]>
  12983. </code></para>
  12984. <para>
  12985. Hence, as far as the xBestIndex() method is concerned, the following
  12986. two forms are equivalent:
  12987. </para>
  12988. <para><code>
  12989. <i>column</i> LIKE <i>EXPR</i><![CDATA[<br>]]>
  12990. LIKE(<i>EXPR</i>,<i>column</i>)
  12991. </code></para>
  12992. <para>
  12993. This special behavior of looking at the second argument of a function
  12994. only occurs for the LIKE, GLOB, REGEXP, and MATCH functions. For all
  12995. other functions, the aConstraint[].iColumn value references the first
  12996. argument of the function.
  12997. </para>
  12998. <para>
  12999. This special feature of LIKE, GLOB, REGEXP, and MATCH does not
  13000. apply to the xFindFunction() method, however. The
  13001. xFindFunction() method always keys off of the left operand of an
  13002. LIKE, GLOB, REGEXP, or MATCH operator but off of the first argument
  13003. to function-call equivalents of those operators.
  13004. </para>
  13005. <para>
  13006. Given all of the information above, the job of the xBestIndex
  13007. method it to figure out the best way to search the virtual table.
  13008. </para>
  13009. <para>
  13010. The xBestIndex method fills the idxNum and idxStr fields with
  13011. information that communicates an indexing strategy to the xFilter
  13012. method. The information in idxNum and idxStr is arbitrary as far
  13013. as the SQLite core is concerned. The SQLite core just copies the
  13014. information through to the xFilter method. Any desired meaning can
  13015. be assigned to idxNum and idxStr as long as xBestIndex and xFilter
  13016. agree on what that meaning is.
  13017. </para>
  13018. <para>
  13019. The idxStr value may be a string obtained from an SQLite
  13020. memory allocation function such as sqlite3_mprintf().
  13021. If this is the case, then the needToFreeIdxStr flag must be set to
  13022. true so that the SQLite core will know to call sqlite3_free() on
  13023. that string when it has finished with it, and thus avoid a memory leak.
  13024. The idxStr value may also be a static constant string, in which case
  13025. the needToFreeIdxStr boolean should remain false.
  13026. </para>
  13027. <para>
  13028. If the virtual table will output rows in the order specified by
  13029. the ORDER BY clause, then the orderByConsumed flag may be set to
  13030. true. If the output is not automatically in the correct order
  13031. then orderByConsumed must be left in its default false setting.
  13032. This will indicate to the SQLite core that it will need to do a
  13033. separate sorting pass over the data after it comes out of the virtual table.
  13034. </para>
  13035. <para>
  13036. The estimatedCost field should be set to the estimated number
  13037. of disk access operations required to execute this query against
  13038. the virtual table. The SQLite core will often call xBestIndex
  13039. multiple times with different constraints, obtain multiple cost
  13040. estimates, then choose the query plan that gives the lowest estimate.
  13041. The SQLite core initializes estimatedCost to a very large value
  13042. prior to invoking xBestIndex, so if xBestIndex determines that the
  13043. current combination of parameters is undesirable, it can leave the
  13044. estimatedCost field unchanged to discourage its use.
  13045. </para>
  13046. <para>
  13047. If the current version of SQLite is 3.8.2 or greater, the estimatedRows
  13048. field may be set to an estimate of the number of rows returned by the
  13049. proposed query plan. If this value is not explicitly set, the default
  13050. estimate of 25 rows is used.
  13051. </para>
  13052. <para>
  13053. If the current version of SQLite is 3.9.0 or greater, the idxFlags field
  13054. may be set to SQLITE_INDEX_SCAN_UNIQUE to indicate that the virtual table
  13055. will return only zero or one rows given the input constraints. Additional
  13056. bits of the idxFlags field might be understood in later versions of SQLite.
  13057. </para>
  13058. <para>
  13059. The aConstraintUsage[] array contains one element for each of
  13060. the nConstraint constraints in the inputs section of the
  13061. sqlite3_index_info structure.
  13062. The aConstraintUsage[] array is used by xBestIndex to tell the
  13063. core how it is using the constraints.
  13064. </para>
  13065. <para>
  13066. The xBestIndex method may set aConstraintUsage[].argvIndex
  13067. entries to values greater than zero.
  13068. Exactly one entry should be set to 1, another to 2, another to 3,
  13069. and so forth up to as many or as few as the xBestIndex method wants.
  13070. The EXPR of the corresponding constraints will then be passed
  13071. in as the argv[] parameters to xFilter.
  13072. </para>
  13073. <para>
  13074. For example, if the aConstraint[3].argvIndex is set to 1, then
  13075. when xFilter is called, the argv[0] passed to xFilter will have
  13076. the EXPR value of the aConstraint[3] constraint.
  13077. </para>
  13078. <para>
  13079. By default, the SQLite core double checks all constraints on
  13080. each row of the virtual table that it receives. If such a check
  13081. is redundant, the xBestFilter method can suppress that double-check by
  13082. setting aConstraintUsage[].omit.
  13083. </para>
  13084. <para>
  13085. The xBestIndex method should return SQLITE_OK on success. If any
  13086. kind of fatal error occurs, an appropriate error code (ex: SQLITE_NOMEM)
  13087. should be returned instead.
  13088. </para>
  13089. <para>
  13090. If xBestIndex returns SQLITE_CONSTRAINT, that does not indicate an
  13091. error. Rather, SQLITE_CONSTRAINT indicates that the particular combination
  13092. of input parameters specified should not be used in the query plan.
  13093. The SQLITE_CONSTRAINT return is useful for table-valued functions that
  13094. have required parameters. If the aConstraint[].usable field is false
  13095. for one of the required parameter, then the xBestIndex method should
  13096. return SQLITE_CONSTRAINT.
  13097. </para>
  13098. <para>
  13099. The following example will better illustrate the use of SQLITE_CONSTRAINT
  13100. as a return value from xBestIndex:
  13101. </para>
  13102. <para><code>
  13103. SELECT * FROM realtab, tablevaluedfunc(realtab.x);
  13104. </code></para>
  13105. <para>
  13106. Assuming that the first hidden column of "tablevaluedfunc" is "param1",
  13107. the query above is semantically equivalent to this:
  13108. </para>
  13109. <para><code>
  13110. SELECT * FROM realtab, tablevaluedfunc
  13111. WHERE tablevaluedfunc.param1 = realtab.x;
  13112. </code></para>
  13113. <para>
  13114. The query planner must decide between many possible implementations
  13115. of this query, but two plans in particular are of note:
  13116. </para>
  13117. <![CDATA[<ol>]]>
  13118. <![CDATA[<li>]]>Scan all
  13119. rows of realtab and for each row, find rows in tablevaluedfunc where
  13120. param1 is equal to realtab.x
  13121. <![CDATA[</li>]]><![CDATA[<li>]]>Scan all rows of tablevalued func and for each row find rows
  13122. in realtab where x is equal to tablevaluedfunc.param1.
  13123. <![CDATA[</li>]]><![CDATA[</ol>]]>
  13124. <para>
  13125. The xBestIndex method will be invoked once for each of the potential
  13126. plans above. For plan 1, the aConstraint[].usable flag for for the
  13127. SQLITE_CONSTRAINT_EQ constraint on the param1 column will be true because
  13128. the right-hand side value for the "param1 = ?" constraint will be known,
  13129. since it is determined by the outer realtab loop.
  13130. But for plan 2, the aConstraint[].usable flag for "param1 = ?" will be false
  13131. because the right-hand side value is determined by an inner loop and is thus
  13132. an unknown quantity. Because param1 is a required input to the table-valued
  13133. functions, the xBestIndex method should return SQLITE_CONSTRAINT when presented
  13134. with plan 2, indicating that a required input is missing. This forces the
  13135. query planner to select plan 1.
  13136. </para>
  13137. </summary>
  13138. <param name="pVtab">
  13139. The native pointer to the sqlite3_vtab derived structure.
  13140. </param>
  13141. <param name="pIndex">
  13142. The native pointer to the sqlite3_index_info structure.
  13143. </param>
  13144. <returns>
  13145. A standard SQLite return code.
  13146. </returns>
  13147. </member>
  13148. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xDisconnect(System.IntPtr)">
  13149. <summary>
  13150. <para><code>
  13151. int (*xDisconnect)(sqlite3_vtab *pVTab);
  13152. </code></para>
  13153. <para>
  13154. This method releases a connection to a virtual table.
  13155. Only the sqlite3_vtab object is destroyed.
  13156. The virtual table is not destroyed and any backing store
  13157. associated with the virtual table persists.
  13158. </para>
  13159. This method undoes the work of xConnect.
  13160. <para>
  13161. This method is a destructor for a connection to the virtual table.
  13162. Contrast this method with xDestroy. The xDestroy is a destructor
  13163. for the entire virtual table.
  13164. </para>
  13165. <para>
  13166. The xDisconnect method is required for every virtual table implementation,
  13167. though it is acceptable for the xDisconnect and xDestroy methods to be
  13168. the same function if that makes sense for the particular virtual table.
  13169. </para>
  13170. </summary>
  13171. <param name="pVtab">
  13172. The native pointer to the sqlite3_vtab derived structure.
  13173. </param>
  13174. <returns>
  13175. A standard SQLite return code.
  13176. </returns>
  13177. </member>
  13178. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xDestroy(System.IntPtr)">
  13179. <summary>
  13180. <para><code>
  13181. int (*xDestroy)(sqlite3_vtab *pVTab);
  13182. </code></para>
  13183. <para>
  13184. This method releases a connection to a virtual table, just like
  13185. the xDisconnect method, and it also destroys the underlying
  13186. table implementation. This method undoes the work of xCreate.
  13187. </para>
  13188. <para>
  13189. The xDisconnect method is called whenever a database connection
  13190. that uses a virtual table is closed. The xDestroy method is only
  13191. called when a DROP TABLE statement is executed against the virtual table.
  13192. </para>
  13193. <para>
  13194. The xDestroy method is required for every virtual table implementation,
  13195. though it is acceptable for the xDisconnect and xDestroy methods to be
  13196. the same function if that makes sense for the particular virtual table.
  13197. </para>
  13198. </summary>
  13199. <param name="pVtab">
  13200. The native pointer to the sqlite3_vtab derived structure.
  13201. </param>
  13202. <returns>
  13203. A standard SQLite return code.
  13204. </returns>
  13205. </member>
  13206. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xOpen(System.IntPtr,System.IntPtr@)">
  13207. <summary>
  13208. <para><code>
  13209. int (*xOpen)(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor);
  13210. </code></para>
  13211. <para>
  13212. The xOpen method creates a new cursor used for accessing (read and/or
  13213. writing) a virtual table. A successful invocation of this method
  13214. will allocate the memory for the sqlite3_vtab_cursor (or a subclass),
  13215. initialize the new object, and make *ppCursor point to the new object.
  13216. The successful call then returns SQLITE_OK.
  13217. </para>
  13218. <para>
  13219. For every successful call to this method, the SQLite core will
  13220. later invoke the xClose method to destroy
  13221. the allocated cursor.
  13222. </para>
  13223. <para>
  13224. The xOpen method need not initialize the pVtab field of the
  13225. sqlite3_vtab_cursor structure. The SQLite core will take care
  13226. of that chore automatically.
  13227. </para>
  13228. <para>
  13229. A virtual table implementation must be able to support an arbitrary
  13230. number of simultaneously open cursors.
  13231. </para>
  13232. <para>
  13233. When initially opened, the cursor is in an undefined state.
  13234. The SQLite core will invoke the xFilter method
  13235. on the cursor prior to any attempt to position or read from the cursor.
  13236. </para>
  13237. <para>
  13238. The xOpen method is required for every virtual table implementation.
  13239. </para>
  13240. </summary>
  13241. <param name="pVtab">
  13242. The native pointer to the sqlite3_vtab derived structure.
  13243. </param>
  13244. <param name="pCursor">
  13245. Upon success, this parameter must be modified to point to the newly
  13246. created native sqlite3_vtab_cursor derived structure.
  13247. </param>
  13248. <returns>
  13249. A standard SQLite return code.
  13250. </returns>
  13251. </member>
  13252. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xClose(System.IntPtr)">
  13253. <summary>
  13254. <para><code>
  13255. int (*xClose)(sqlite3_vtab_cursor*);
  13256. </code></para>
  13257. <para>
  13258. The xClose method closes a cursor previously opened by
  13259. xOpen.
  13260. The SQLite core will always call xClose once for each cursor opened
  13261. using xOpen.
  13262. </para>
  13263. <para>
  13264. This method must release all resources allocated by the
  13265. corresponding xOpen call. The routine will not be called again even if it
  13266. returns an error. The SQLite core will not use the
  13267. sqlite3_vtab_cursor again after it has been closed.
  13268. </para>
  13269. <para>
  13270. The xClose method is required for every virtual table implementation.
  13271. </para>
  13272. </summary>
  13273. <param name="pCursor">
  13274. The native pointer to the sqlite3_vtab_cursor derived structure.
  13275. </param>
  13276. <returns>
  13277. A standard SQLite return code.
  13278. </returns>
  13279. </member>
  13280. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xFilter(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)">
  13281. <summary>
  13282. <para><code>
  13283. int (*xFilter)(sqlite3_vtab_cursor*, int idxNum, const char *idxStr,
  13284. int argc, sqlite3_value **argv);
  13285. </code></para>
  13286. <para>
  13287. This method begins a search of a virtual table.
  13288. The first argument is a cursor opened by xOpen.
  13289. The next two arguments define a particular search index previously
  13290. chosen by xBestIndex. The specific meanings of idxNum and idxStr
  13291. are unimportant as long as xFilter and xBestIndex agree on what
  13292. that meaning is.
  13293. </para>
  13294. <para>
  13295. The xBestIndex function may have requested the values of
  13296. certain expressions using the aConstraintUsage[].argvIndex values
  13297. of the sqlite3_index_info structure.
  13298. Those values are passed to xFilter using the argc and argv parameters.
  13299. </para>
  13300. <para>
  13301. If the virtual table contains one or more rows that match the
  13302. search criteria, then the cursor must be left point at the first row.
  13303. Subsequent calls to xEof must return false (zero).
  13304. If there are no rows match, then the cursor must be left in a state
  13305. that will cause the xEof to return true (non-zero).
  13306. The SQLite engine will use
  13307. the xColumn and xRowid methods to access that row content.
  13308. The xNext method will be used to advance to the next row.
  13309. </para>
  13310. <para>
  13311. This method must return SQLITE_OK if successful, or an sqlite
  13312. error code if an error occurs.
  13313. </para>
  13314. <para>
  13315. The xFilter method is required for every virtual table implementation.
  13316. </para>
  13317. </summary>
  13318. <param name="pCursor">
  13319. The native pointer to the sqlite3_vtab_cursor derived structure.
  13320. </param>
  13321. <param name="idxNum">
  13322. Number used to help identify the selected index.
  13323. </param>
  13324. <param name="idxStr">
  13325. The native pointer to the UTF-8 encoded string containing the
  13326. string used to help identify the selected index.
  13327. </param>
  13328. <param name="argc">
  13329. The number of native pointers to sqlite3_value structures specified
  13330. in <paramref name="argv" />.
  13331. </param>
  13332. <param name="argv">
  13333. An array of native pointers to sqlite3_value structures containing
  13334. filtering criteria for the selected index.
  13335. </param>
  13336. <returns>
  13337. A standard SQLite return code.
  13338. </returns>
  13339. </member>
  13340. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xNext(System.IntPtr)">
  13341. <summary>
  13342. <para><code>
  13343. int (*xNext)(sqlite3_vtab_cursor*);
  13344. </code></para>
  13345. <para>
  13346. The xNext method advances a virtual table cursor
  13347. to the next row of a result set initiated by xFilter.
  13348. If the cursor is already pointing at the last row when this
  13349. routine is called, then the cursor no longer points to valid
  13350. data and a subsequent call to the xEof method must return true (non-zero).
  13351. If the cursor is successfully advanced to another row of content, then
  13352. subsequent calls to xEof must return false (zero).
  13353. </para>
  13354. <para>
  13355. This method must return SQLITE_OK if successful, or an sqlite
  13356. error code if an error occurs.
  13357. </para>
  13358. <para>
  13359. The xNext method is required for every virtual table implementation.
  13360. </para>
  13361. </summary>
  13362. <param name="pCursor">
  13363. The native pointer to the sqlite3_vtab_cursor derived structure.
  13364. </param>
  13365. <returns>
  13366. A standard SQLite return code.
  13367. </returns>
  13368. </member>
  13369. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xEof(System.IntPtr)">
  13370. <summary>
  13371. <para><code>
  13372. int (*xEof)(sqlite3_vtab_cursor*);
  13373. </code></para>
  13374. <para>
  13375. The xEof method must return false (zero) if the specified cursor
  13376. currently points to a valid row of data, or true (non-zero) otherwise.
  13377. This method is called by the SQL engine immediately after each
  13378. xFilter and xNext invocation.
  13379. </para>
  13380. <para>
  13381. The xEof method is required for every virtual table implementation.
  13382. </para>
  13383. </summary>
  13384. <param name="pCursor">
  13385. The native pointer to the sqlite3_vtab_cursor derived structure.
  13386. </param>
  13387. <returns>
  13388. Non-zero if no more rows are available; zero otherwise.
  13389. </returns>
  13390. </member>
  13391. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xColumn(System.IntPtr,System.IntPtr,System.Int32)">
  13392. <summary>
  13393. <para><code>
  13394. int (*xColumn)(sqlite3_vtab_cursor*, sqlite3_context*, int N);
  13395. </code></para>
  13396. <para>
  13397. The SQLite core invokes this method in order to find the value for
  13398. the N-th column of the current row. N is zero-based so the first column
  13399. is numbered 0.
  13400. The xColumn method may return its result back to SQLite using one of the
  13401. following interface:
  13402. </para>
  13403. <para>
  13404. <![CDATA[<ul>]]>
  13405. <![CDATA[<li>]]> sqlite3_result_blob()
  13406. <![CDATA[</li>]]><![CDATA[<li>]]> sqlite3_result_double()
  13407. <![CDATA[</li>]]><![CDATA[<li>]]> sqlite3_result_int()
  13408. <![CDATA[</li>]]><![CDATA[<li>]]> sqlite3_result_int64()
  13409. <![CDATA[</li>]]><![CDATA[<li>]]> sqlite3_result_null()
  13410. <![CDATA[</li>]]><![CDATA[<li>]]> sqlite3_result_text()
  13411. <![CDATA[</li>]]><![CDATA[<li>]]> sqlite3_result_text16()
  13412. <![CDATA[</li>]]><![CDATA[<li>]]> sqlite3_result_text16le()
  13413. <![CDATA[</li>]]><![CDATA[<li>]]> sqlite3_result_text16be()
  13414. <![CDATA[</li>]]><![CDATA[<li>]]> sqlite3_result_zeroblob()
  13415. <![CDATA[</li>]]><![CDATA[</ul>]]>
  13416. </para>
  13417. <para>
  13418. If the xColumn method implementation calls none of the functions above,
  13419. then the value of the column defaults to an SQL NULL.
  13420. </para>
  13421. <para>
  13422. To raise an error, the xColumn method should use one of the result_text()
  13423. methods to set the error message text, then return an appropriate
  13424. error code. The xColumn method must return SQLITE_OK on success.
  13425. </para>
  13426. <para>
  13427. The xColumn method is required for every virtual table implementation.
  13428. </para>
  13429. </summary>
  13430. <param name="pCursor">
  13431. The native pointer to the sqlite3_vtab_cursor derived structure.
  13432. </param>
  13433. <param name="pContext">
  13434. The native pointer to the sqlite3_context structure to be used
  13435. for returning the specified column value to the SQLite core
  13436. library.
  13437. </param>
  13438. <param name="index">
  13439. The zero-based index corresponding to the column containing the
  13440. value to be returned.
  13441. </param>
  13442. <returns>
  13443. A standard SQLite return code.
  13444. </returns>
  13445. </member>
  13446. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xRowId(System.IntPtr,System.Int64@)">
  13447. <summary>
  13448. <para><code>
  13449. int (*xRowid)(sqlite3_vtab_cursor *pCur, sqlite_int64 *pRowid);
  13450. </code></para>
  13451. <para>
  13452. A successful invocation of this method will cause *pRowid to be
  13453. filled with the rowid of row that the
  13454. virtual table cursor pCur is currently pointing at.
  13455. This method returns SQLITE_OK on success.
  13456. It returns an appropriate error code on failure.
  13457. </para>
  13458. <para>
  13459. The xRowid method is required for every virtual table implementation.
  13460. </para>
  13461. </summary>
  13462. <param name="pCursor">
  13463. The native pointer to the sqlite3_vtab_cursor derived structure.
  13464. </param>
  13465. <param name="rowId">
  13466. Upon success, this parameter must be modified to contain the unique
  13467. integer row identifier for the current row for the specified cursor.
  13468. </param>
  13469. <returns>
  13470. A standard SQLite return code.
  13471. </returns>
  13472. </member>
  13473. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xUpdate(System.IntPtr,System.Int32,System.IntPtr,System.Int64@)">
  13474. <summary>
  13475. <para><code>
  13476. int (*xUpdate)(
  13477. sqlite3_vtab *pVTab,
  13478. int argc,
  13479. sqlite3_value **argv,
  13480. sqlite_int64 *pRowid
  13481. );
  13482. </code></para>
  13483. <para>
  13484. All changes to a virtual table are made using the xUpdate method.
  13485. This one method can be used to insert, delete, or update.
  13486. </para>
  13487. <para>
  13488. The argc parameter specifies the number of entries in the argv array.
  13489. The value of argc will be 1 for a pure delete operation or N+2 for an insert
  13490. or replace or update where N is the number of columns in the table.
  13491. In the previous sentence, N includes any hidden columns.
  13492. </para>
  13493. <para>
  13494. Every argv entry will have a non-NULL value in C but may contain the
  13495. SQL value NULL. In other words, it is always true that
  13496. <![CDATA[<tt>]]>argv[i]!=0<![CDATA[</tt>]]> for <![CDATA[<b>]]>i<![CDATA[</b>]]> between 0 and <![CDATA[<tt>]]>argc-1<![CDATA[</tt>]]>.
  13497. However, it might be the case that
  13498. <![CDATA[<tt>]]>sqlite3_value_type(argv[i])==SQLITE_NULL<![CDATA[</tt>]]>.
  13499. </para>
  13500. <para>
  13501. The argv[0] parameter is the rowid of a row in the virtual table
  13502. to be deleted. If argv[0] is an SQL NULL, then no deletion occurs.
  13503. </para>
  13504. <para>
  13505. The argv[1] parameter is the rowid of a new row to be inserted
  13506. into the virtual table. If argv[1] is an SQL NULL, then the implementation
  13507. must choose a rowid for the newly inserted row. Subsequent argv[]
  13508. entries contain values of the columns of the virtual table, in the
  13509. order that the columns were declared. The number of columns will
  13510. match the table declaration that the xConnect or xCreate method made
  13511. using the sqlite3_declare_vtab() call. All hidden columns are included.
  13512. </para>
  13513. <para>
  13514. When doing an insert without a rowid (argc>1, argv[1] is an SQL NULL),
  13515. on a virtual table that uses ROWID (but not on a WITHOUT ROWID virtual table),
  13516. the implementation must set *pRowid to the rowid of the newly inserted row;
  13517. this will become the value returned by the sqlite3_last_insert_rowid()
  13518. function. Setting this value in all the other cases is a harmless no-op;
  13519. the SQLite engine ignores the *pRowid return value if argc==1 or
  13520. argv[1] is not an SQL NULL.
  13521. </para>
  13522. <para>
  13523. Each call to xUpdate will fall into one of cases shown below.
  13524. Not that references to <![CDATA[<b>]]>argv[i]<![CDATA[</b>]]> mean the SQL value
  13525. held within the argv[i] object, not the argv[i]
  13526. object itself.
  13527. </para>
  13528. <para><code>
  13529. <![CDATA[<dl>]]>
  13530. <![CDATA[<dt>]]><![CDATA[<b>]]>argc = 1 <![CDATA[<br>]]> argv[0] &#8800; NULL<![CDATA[</b>]]>
  13531. <![CDATA[</dt>]]><![CDATA[<dd>]]>
  13532. DELETE: The single row with rowid or PRIMARY KEY equal to argv[0] is deleted.
  13533. No insert occurs.
  13534. <![CDATA[</dd>]]><![CDATA[<dt>]]><![CDATA[<b>]]>argc &gt; 1 <![CDATA[<br>]]> argv[0] = NULL<![CDATA[</b>]]>
  13535. <![CDATA[</dt>]]><![CDATA[<dd>]]>
  13536. INSERT: A new row is inserted with column values taken from
  13537. argv[2] and following. In a rowid virtual table, if argv[1] is an SQL NULL,
  13538. then a new unique rowid is generated automatically. The argv[1] will be NULL
  13539. for a WITHOUT ROWID virtual table, in which case the implementation should
  13540. take the PRIMARY KEY value from the appropriate column in argv[2] and following.
  13541. <![CDATA[</dd>]]><![CDATA[<dt>]]><![CDATA[<b>]]>argc &gt; 1 <![CDATA[<br>]]> argv[0] &#8800; NULL <![CDATA[<br>]]> argv[0] = argv[1]<![CDATA[</b>]]>
  13542. <![CDATA[</dt>]]><![CDATA[<dd>]]>
  13543. UPDATE:
  13544. The row with rowid or PRIMARY KEY argv[0] is updated with new values
  13545. in argv[2] and following parameters.
  13546. <![CDATA[</dd>]]><![CDATA[<dt>]]><![CDATA[<b>]]>argc &gt; 1 <![CDATA[<br>]]> argv[0] &#8800; NULL <![CDATA[<br>]]> argv[0] &#8800; argv[1]<![CDATA[</b>]]>
  13547. <![CDATA[</dt>]]><![CDATA[<dd>]]>
  13548. UPDATE with rowid or PRIMARY KEY change:
  13549. The row with rowid or PRIMARY KEY argv[0] is updated with
  13550. the rowid or PRIMARY KEY in argv[1]
  13551. and new values in argv[2] and following parameters. This will occur
  13552. when an SQL statement updates a rowid, as in the statement:
  13553. <para><code>
  13554. UPDATE table SET rowid=rowid+1 WHERE ...;
  13555. </code></para>
  13556. <![CDATA[</dd>]]><![CDATA[</dl>]]>
  13557. </code></para>
  13558. <para>
  13559. The xUpdate method must return SQLITE_OK if and only if it is
  13560. successful. If a failure occurs, the xUpdate must return an appropriate
  13561. error code. On a failure, the pVTab->zErrMsg element may optionally
  13562. be replaced with error message text stored in memory allocated from SQLite
  13563. using functions such as sqlite3_mprintf() or sqlite3_malloc().
  13564. </para>
  13565. <para>
  13566. If the xUpdate method violates some constraint of the virtual table
  13567. (including, but not limited to, attempting to store a value of the wrong
  13568. datatype, attempting to store a value that is too
  13569. large or too small, or attempting to change a read-only value) then the
  13570. xUpdate must fail with an appropriate error code.
  13571. </para>
  13572. <para>
  13573. If the xUpdate method is performing an UPDATE, then
  13574. sqlite3_value_nochange(X) can be used to discover which columns
  13575. of the virtual table were actually modified by the UPDATE
  13576. statement. The sqlite3_value_nochange(X) interface returns
  13577. true for columns that do not change.
  13578. On every UPDATE, SQLite will first invoke
  13579. xColumn separately for each unchanging column in the table to
  13580. obtain the value for that column. The xColumn method can
  13581. check to see if the column is unchanged at the SQL level
  13582. by invoking sqlite3_vtab_nochange(). If xColumn sees that
  13583. the column is not being modified, it should return without setting
  13584. a result using one of the sqlite3_result_xxxxx()
  13585. interfaces. Only in that case sqlite3_value_nochange() will be
  13586. true within the xUpdate method. If xColumn does
  13587. invoke one or more sqlite3_result_xxxxx()
  13588. interfaces, then SQLite understands that as a change in the value
  13589. of the column and the sqlite3_value_nochange() call for that
  13590. column within xUpdate will return false.
  13591. </para>
  13592. <para>
  13593. There might be one or more sqlite3_vtab_cursor objects open and in use
  13594. on the virtual table instance and perhaps even on the row of the virtual
  13595. table when the xUpdate method is invoked. The implementation of
  13596. xUpdate must be prepared for attempts to delete or modify rows of the table
  13597. out from other existing cursors. If the virtual table cannot accommodate
  13598. such changes, the xUpdate method must return an error code.
  13599. </para>
  13600. <para>
  13601. The xUpdate method is optional.
  13602. If the xUpdate pointer in the sqlite3_module for a virtual table
  13603. is a NULL pointer, then the virtual table is read-only.
  13604. </para>
  13605. </summary>
  13606. <param name="pVtab">
  13607. The native pointer to the sqlite3_vtab derived structure.
  13608. </param>
  13609. <param name="argc">
  13610. The number of new or modified column values contained in
  13611. <paramref name="argv" />.
  13612. </param>
  13613. <param name="argv">
  13614. The array of native pointers to sqlite3_value structures containing
  13615. the new or modified column values, if any.
  13616. </param>
  13617. <param name="rowId">
  13618. Upon success, this parameter must be modified to contain the unique
  13619. integer row identifier for the row that was inserted, if any.
  13620. </param>
  13621. <returns>
  13622. A standard SQLite return code.
  13623. </returns>
  13624. </member>
  13625. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xBegin(System.IntPtr)">
  13626. <summary>
  13627. <para><code>
  13628. int (*xBegin)(sqlite3_vtab *pVTab);
  13629. </code></para>
  13630. <para>
  13631. This method begins a transaction on a virtual table.
  13632. This is method is optional. The xBegin pointer of sqlite3_module
  13633. may be NULL.
  13634. </para>
  13635. <para>
  13636. This method is always followed by one call to either the
  13637. xCommit or xRollback method. Virtual table transactions do
  13638. not nest, so the xBegin method will not be invoked more than once
  13639. on a single virtual table
  13640. without an intervening call to either xCommit or xRollback.
  13641. Multiple calls to other methods can and likely will occur in between
  13642. the xBegin and the corresponding xCommit or xRollback.
  13643. </para>
  13644. </summary>
  13645. <param name="pVtab">
  13646. The native pointer to the sqlite3_vtab derived structure.
  13647. </param>
  13648. <returns>
  13649. A standard SQLite return code.
  13650. </returns>
  13651. </member>
  13652. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xSync(System.IntPtr)">
  13653. <summary>
  13654. <para><code>
  13655. int (*xSync)(sqlite3_vtab *pVTab);
  13656. </code></para>
  13657. <para>
  13658. This method signals the start of a two-phase commit on a virtual
  13659. table.
  13660. This is method is optional. The xSync pointer of sqlite3_module
  13661. may be NULL.
  13662. </para>
  13663. <para>
  13664. This method is only invoked after call to the xBegin method and
  13665. prior to an xCommit or xRollback. In order to implement two-phase
  13666. commit, the xSync method on all virtual tables is invoked prior to
  13667. invoking the xCommit method on any virtual table. If any of the
  13668. xSync methods fail, the entire transaction is rolled back.
  13669. </para>
  13670. </summary>
  13671. <param name="pVtab">
  13672. The native pointer to the sqlite3_vtab derived structure.
  13673. </param>
  13674. <returns>
  13675. A standard SQLite return code.
  13676. </returns>
  13677. </member>
  13678. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xCommit(System.IntPtr)">
  13679. <summary>
  13680. <para><code>
  13681. int (*xCommit)(sqlite3_vtab *pVTab);
  13682. </code></para>
  13683. <para>
  13684. This method causes a virtual table transaction to commit.
  13685. This is method is optional. The xCommit pointer of sqlite3_module
  13686. may be NULL.
  13687. </para>
  13688. <para>
  13689. A call to this method always follows a prior call to xBegin and
  13690. xSync.
  13691. </para>
  13692. </summary>
  13693. <param name="pVtab">
  13694. The native pointer to the sqlite3_vtab derived structure.
  13695. </param>
  13696. <returns>
  13697. A standard SQLite return code.
  13698. </returns>
  13699. </member>
  13700. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xRollback(System.IntPtr)">
  13701. <summary>
  13702. <para><code>
  13703. int (*xRollback)(sqlite3_vtab *pVTab);
  13704. </code></para>
  13705. <para>
  13706. This method causes a virtual table transaction to rollback.
  13707. This is method is optional. The xRollback pointer of sqlite3_module
  13708. may be NULL.
  13709. </para>
  13710. <para>
  13711. A call to this method always follows a prior call to xBegin.
  13712. </para>
  13713. </summary>
  13714. <param name="pVtab">
  13715. The native pointer to the sqlite3_vtab derived structure.
  13716. </param>
  13717. <returns>
  13718. A standard SQLite return code.
  13719. </returns>
  13720. </member>
  13721. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,System.IntPtr@)">
  13722. <summary>
  13723. <para><code>
  13724. int (*xFindFunction)(
  13725. sqlite3_vtab *pVtab,
  13726. int nArg,
  13727. const char *zName,
  13728. void (**pxFunc)(sqlite3_context*,int,sqlite3_value**),
  13729. void **ppArg
  13730. );
  13731. </code></para>
  13732. <para>
  13733. This method is called during sqlite3_prepare() to give the virtual
  13734. table implementation an opportunity to overload functions.
  13735. This method may be set to NULL in which case no overloading occurs.
  13736. </para>
  13737. <para>
  13738. When a function uses a column from a virtual table as its first
  13739. argument, this method is called to see if the virtual table would
  13740. like to overload the function. The first three parameters are inputs:
  13741. the virtual table, the number of arguments to the function, and the
  13742. name of the function. If no overloading is desired, this method
  13743. returns 0. To overload the function, this method writes the new
  13744. function implementation into *pxFunc and writes user data into *ppArg
  13745. and returns either 1 or a number between
  13746. SQLITE_INDEX_CONSTRAINT_FUNCTION and 255.
  13747. </para>
  13748. <para>
  13749. Historically, the return value from xFindFunction() was either zero
  13750. or one. Zero means that the function is not overloaded and one means that
  13751. it is overload. The ability to return values of
  13752. SQLITE_INDEX_CONSTRAINT_FUNCTION or greater was added in
  13753. version 3.25.0 (2018-09-15). If xFindFunction returns
  13754. SQLITE_INDEX_CONSTRAINT_FUNCTION or greater, than means that the function
  13755. takes two arguments and the function
  13756. can be used as a boolean in the WHERE clause of a query and that
  13757. the virtual table is able to exploit that function to speed up the query
  13758. result. When xFindFunction returns SQLITE_INDEX_CONSTRAINT_FUNCTION or
  13759. larger, the value returned becomes the sqlite3_index_info.aConstraint.op
  13760. value for one of the constraints passed into xBestIndex() and the second
  13761. argument becomes the value corresponding to that constraint that is passed
  13762. to xFilter(). This enables the
  13763. xBestIndex()/xFilter implementations to use the function to speed
  13764. its search.
  13765. </para>
  13766. <para>
  13767. The technique of having xFindFunction() return values of
  13768. SQLITE_INDEX_CONSTRAINT_FUNCTION was initially used in the implementation
  13769. of the Geopoly module. The xFindFunction() method of that module returns
  13770. SQLITE_INDEX_CONSTRAINT_FUNCTION for the geopoly_overlap() SQL function
  13771. and it returns
  13772. SQLITE_INDEX_CONSTRAINT_FUNCTION+1 for the geopoly_within() SQL function.
  13773. This permits search optimizations for queries such as:
  13774. </para>
  13775. <para><code>
  13776. SELECT * FROM geopolytab WHERE geopoly_overlap(_shape, $query_polygon);
  13777. </code></para>
  13778. <para>
  13779. Note that infix functions (LIKE, GLOB, REGEXP, and MATCH) reverse
  13780. the order of their arguments. So "like(A,B)" would normally work the same
  13781. as "B like A".
  13782. However, xFindFunction() always looks a the left-most argument, not
  13783. the first logical argument.
  13784. Hence, for the form "B like A", SQLite looks at the
  13785. left operand "B" and if that operand is a virtual table column
  13786. it invokes the xFindFunction() method on that virtual table.
  13787. But if the form "like(A,B)" is used instead, then SQLite checks
  13788. the A term to see if it is column of a virtual table and if so
  13789. it invokes the xFindFunction() method for the virtual table of
  13790. column A.
  13791. </para>
  13792. <para>
  13793. The function pointer returned by this routine must be valid for
  13794. the lifetime of the sqlite3_vtab object given in the first parameter.
  13795. </para>
  13796. </summary>
  13797. <param name="pVtab">
  13798. The native pointer to the sqlite3_vtab derived structure.
  13799. </param>
  13800. <param name="nArg">
  13801. The number of arguments to the function being sought.
  13802. </param>
  13803. <param name="zName">
  13804. The name of the function being sought.
  13805. </param>
  13806. <param name="callback">
  13807. Upon success, this parameter must be modified to contain the
  13808. delegate responsible for implementing the specified function.
  13809. </param>
  13810. <param name="pClientData">
  13811. Upon success, this parameter must be modified to contain the
  13812. native user-data pointer associated with
  13813. <paramref name="callback" />.
  13814. </param>
  13815. <returns>
  13816. Non-zero if the specified function was found; zero otherwise.
  13817. </returns>
  13818. </member>
  13819. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xRename(System.IntPtr,System.IntPtr)">
  13820. <summary>
  13821. <para><code>
  13822. int (*xRename)(sqlite3_vtab *pVtab, const char *zNew);
  13823. </code></para>
  13824. <para>
  13825. This method provides notification that the virtual table implementation
  13826. that the virtual table will be given a new name.
  13827. If this method returns SQLITE_OK then SQLite renames the table.
  13828. If this method returns an error code then the renaming is prevented.
  13829. </para>
  13830. <para>
  13831. The xRename method is optional. If omitted, then the virtual
  13832. table may not be renamed using the ALTER TABLE RENAME command.
  13833. </para>
  13834. <para>
  13835. The PRAGMA legacy_alter_table setting is enabled prior to invoking this
  13836. method, and the value for legacy_alter_table is restored after this
  13837. method finishes. This is necessary for the correct operation of virtual
  13838. tables that make use of shadow tables where the shadow tables must be
  13839. renamed to match the new virtual table name. If the legacy_alter_format is
  13840. off, then the xConnect method will be invoked for the virtual table every
  13841. time the xRename method tries to change the name of the shadow table.
  13842. </para>
  13843. </summary>
  13844. <param name="pVtab">
  13845. The native pointer to the sqlite3_vtab derived structure.
  13846. </param>
  13847. <param name="zNew">
  13848. The native pointer to the UTF-8 encoded string containing the new
  13849. name for the virtual table.
  13850. </param>
  13851. <returns>
  13852. A standard SQLite return code.
  13853. </returns>
  13854. </member>
  13855. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xSavepoint(System.IntPtr,System.Int32)">
  13856. <summary>
  13857. <para><code>
  13858. int (*xSavepoint)(sqlite3_vtab *pVtab, int);
  13859. int (*xRelease)(sqlite3_vtab *pVtab, int);
  13860. int (*xRollbackTo)(sqlite3_vtab *pVtab, int);
  13861. </code></para>
  13862. <para>
  13863. These methods provide the virtual table implementation an opportunity to
  13864. implement nested transactions. They are always optional and will only be
  13865. called in SQLite version 3.7.7 (2011-06-23) and later.
  13866. </para>
  13867. <para>
  13868. When xSavepoint(X,N) is invoked, that is a signal to the virtual table X
  13869. that it should save its current state as savepoint N.
  13870. A subsequent call
  13871. to xRollbackTo(X,R) means that the state of the virtual table should return
  13872. to what it was when xSavepoint(X,R) was last called.
  13873. The call
  13874. to xRollbackTo(X,R) will invalidate all savepoints with N>R; none of the
  13875. invalided savepoints will be rolled back or released without first
  13876. being reinitialized by a call to xSavepoint().
  13877. A call to xRelease(X,M) invalidates all savepoints where N>=M.
  13878. </para>
  13879. <para>
  13880. None of the xSavepoint(), xRelease(), or xRollbackTo() methods will ever
  13881. be called except in between calls to xBegin() and
  13882. either xCommit() or xRollback().
  13883. </para>
  13884. </summary>
  13885. <param name="pVtab">
  13886. The native pointer to the sqlite3_vtab derived structure.
  13887. </param>
  13888. <param name="iSavepoint">
  13889. This is an integer identifier under which the the current state of
  13890. the virtual table should be saved.
  13891. </param>
  13892. <returns>
  13893. A standard SQLite return code.
  13894. </returns>
  13895. </member>
  13896. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xRelease(System.IntPtr,System.Int32)">
  13897. <summary>
  13898. <para><code>
  13899. int (*xSavepoint)(sqlite3_vtab *pVtab, int);
  13900. int (*xRelease)(sqlite3_vtab *pVtab, int);
  13901. int (*xRollbackTo)(sqlite3_vtab *pVtab, int);
  13902. </code></para>
  13903. <para>
  13904. These methods provide the virtual table implementation an opportunity to
  13905. implement nested transactions. They are always optional and will only be
  13906. called in SQLite version 3.7.7 (2011-06-23) and later.
  13907. </para>
  13908. <para>
  13909. When xSavepoint(X,N) is invoked, that is a signal to the virtual table X
  13910. that it should save its current state as savepoint N.
  13911. A subsequent call
  13912. to xRollbackTo(X,R) means that the state of the virtual table should return
  13913. to what it was when xSavepoint(X,R) was last called.
  13914. The call
  13915. to xRollbackTo(X,R) will invalidate all savepoints with N>R; none of the
  13916. invalided savepoints will be rolled back or released without first
  13917. being reinitialized by a call to xSavepoint().
  13918. A call to xRelease(X,M) invalidates all savepoints where N>=M.
  13919. </para>
  13920. <para>
  13921. None of the xSavepoint(), xRelease(), or xRollbackTo() methods will ever
  13922. be called except in between calls to xBegin() and
  13923. either xCommit() or xRollback().
  13924. </para>
  13925. </summary>
  13926. <param name="pVtab">
  13927. The native pointer to the sqlite3_vtab derived structure.
  13928. </param>
  13929. <param name="iSavepoint">
  13930. This is an integer used to indicate that any saved states with an
  13931. identifier greater than or equal to this should be deleted by the
  13932. virtual table.
  13933. </param>
  13934. <returns>
  13935. A standard SQLite return code.
  13936. </returns>
  13937. </member>
  13938. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xRollbackTo(System.IntPtr,System.Int32)">
  13939. <summary>
  13940. <para><code>
  13941. int (*xSavepoint)(sqlite3_vtab *pVtab, int);
  13942. int (*xRelease)(sqlite3_vtab *pVtab, int);
  13943. int (*xRollbackTo)(sqlite3_vtab *pVtab, int);
  13944. </code></para>
  13945. <para>
  13946. These methods provide the virtual table implementation an opportunity to
  13947. implement nested transactions. They are always optional and will only be
  13948. called in SQLite version 3.7.7 (2011-06-23) and later.
  13949. </para>
  13950. <para>
  13951. When xSavepoint(X,N) is invoked, that is a signal to the virtual table X
  13952. that it should save its current state as savepoint N.
  13953. A subsequent call
  13954. to xRollbackTo(X,R) means that the state of the virtual table should return
  13955. to what it was when xSavepoint(X,R) was last called.
  13956. The call
  13957. to xRollbackTo(X,R) will invalidate all savepoints with N>R; none of the
  13958. invalided savepoints will be rolled back or released without first
  13959. being reinitialized by a call to xSavepoint().
  13960. A call to xRelease(X,M) invalidates all savepoints where N>=M.
  13961. </para>
  13962. <para>
  13963. None of the xSavepoint(), xRelease(), or xRollbackTo() methods will ever
  13964. be called except in between calls to xBegin() and
  13965. either xCommit() or xRollback().
  13966. </para>
  13967. </summary>
  13968. <param name="pVtab">
  13969. The native pointer to the sqlite3_vtab derived structure.
  13970. </param>
  13971. <param name="iSavepoint">
  13972. This is an integer identifier used to specify a specific saved
  13973. state for the virtual table for it to restore itself back to, which
  13974. should also have the effect of deleting all saved states with an
  13975. integer identifier greater than this one.
  13976. </param>
  13977. <returns>
  13978. A standard SQLite return code.
  13979. </returns>
  13980. </member>
  13981. <member name="T:System.Data.SQLite.SQLiteContext">
  13982. <summary>
  13983. This class represents a context from the SQLite core library that can
  13984. be passed to the sqlite3_result_*() and associated functions.
  13985. </summary>
  13986. </member>
  13987. <member name="T:System.Data.SQLite.ISQLiteNativeHandle">
  13988. <summary>
  13989. This interface represents a native handle provided by the SQLite core
  13990. library.
  13991. </summary>
  13992. </member>
  13993. <member name="P:System.Data.SQLite.ISQLiteNativeHandle.NativeHandle">
  13994. <summary>
  13995. The native handle value.
  13996. </summary>
  13997. </member>
  13998. <member name="F:System.Data.SQLite.SQLiteContext.pContext">
  13999. <summary>
  14000. The native context handle.
  14001. </summary>
  14002. </member>
  14003. <member name="M:System.Data.SQLite.SQLiteContext.#ctor(System.IntPtr)">
  14004. <summary>
  14005. Constructs an instance of this class using the specified native
  14006. context handle.
  14007. </summary>
  14008. <param name="pContext">
  14009. The native context handle to use.
  14010. </param>
  14011. </member>
  14012. <member name="M:System.Data.SQLite.SQLiteContext.SetNull">
  14013. <summary>
  14014. Sets the context result to NULL.
  14015. </summary>
  14016. </member>
  14017. <member name="M:System.Data.SQLite.SQLiteContext.SetDouble(System.Double)">
  14018. <summary>
  14019. Sets the context result to the specified <see cref="T:System.Double"/>
  14020. value.
  14021. </summary>
  14022. <param name="value">
  14023. The <see cref="T:System.Double"/> value to use.
  14024. </param>
  14025. </member>
  14026. <member name="M:System.Data.SQLite.SQLiteContext.SetInt(System.Int32)">
  14027. <summary>
  14028. Sets the context result to the specified <see cref="T:System.Int32"/>
  14029. value.
  14030. </summary>
  14031. <param name="value">
  14032. The <see cref="T:System.Int32"/> value to use.
  14033. </param>
  14034. </member>
  14035. <member name="M:System.Data.SQLite.SQLiteContext.SetInt64(System.Int64)">
  14036. <summary>
  14037. Sets the context result to the specified <see cref="T:System.Int64"/>
  14038. value.
  14039. </summary>
  14040. <param name="value">
  14041. The <see cref="T:System.Int64"/> value to use.
  14042. </param>
  14043. </member>
  14044. <member name="M:System.Data.SQLite.SQLiteContext.SetString(System.String)">
  14045. <summary>
  14046. Sets the context result to the specified <see cref="T:System.String"/>
  14047. value.
  14048. </summary>
  14049. <param name="value">
  14050. The <see cref="T:System.String"/> value to use. This value will be
  14051. converted to the UTF-8 encoding prior to being used.
  14052. </param>
  14053. </member>
  14054. <member name="M:System.Data.SQLite.SQLiteContext.SetError(System.String)">
  14055. <summary>
  14056. Sets the context result to the specified <see cref="T:System.String"/>
  14057. value containing an error message.
  14058. </summary>
  14059. <param name="value">
  14060. The <see cref="T:System.String"/> value containing the error message text.
  14061. This value will be converted to the UTF-8 encoding prior to being
  14062. used.
  14063. </param>
  14064. </member>
  14065. <member name="M:System.Data.SQLite.SQLiteContext.SetErrorCode(System.Data.SQLite.SQLiteErrorCode)">
  14066. <summary>
  14067. Sets the context result to the specified <see cref="T:System.Data.SQLite.SQLiteErrorCode"/>
  14068. value.
  14069. </summary>
  14070. <param name="value">
  14071. The <see cref="T:System.Data.SQLite.SQLiteErrorCode"/> value to use.
  14072. </param>
  14073. </member>
  14074. <member name="M:System.Data.SQLite.SQLiteContext.SetErrorTooBig">
  14075. <summary>
  14076. Sets the context result to contain the error code SQLITE_TOOBIG.
  14077. </summary>
  14078. </member>
  14079. <member name="M:System.Data.SQLite.SQLiteContext.SetErrorNoMemory">
  14080. <summary>
  14081. Sets the context result to contain the error code SQLITE_NOMEM.
  14082. </summary>
  14083. </member>
  14084. <member name="M:System.Data.SQLite.SQLiteContext.SetBlob(System.Byte[])">
  14085. <summary>
  14086. Sets the context result to the specified <see cref="T:System.Byte"/> array
  14087. value.
  14088. </summary>
  14089. <param name="value">
  14090. The <see cref="T:System.Byte"/> array value to use.
  14091. </param>
  14092. </member>
  14093. <member name="M:System.Data.SQLite.SQLiteContext.SetZeroBlob(System.Int32)">
  14094. <summary>
  14095. Sets the context result to a BLOB of zeros of the specified size.
  14096. </summary>
  14097. <param name="value">
  14098. The number of zero bytes to use for the BLOB context result.
  14099. </param>
  14100. </member>
  14101. <member name="M:System.Data.SQLite.SQLiteContext.SetValue(System.Data.SQLite.SQLiteValue)">
  14102. <summary>
  14103. Sets the context result to the specified <see cref="T:System.Data.SQLite.SQLiteValue"/>.
  14104. </summary>
  14105. <param name="value">
  14106. The <see cref="T:System.Data.SQLite.SQLiteValue"/> to use.
  14107. </param>
  14108. </member>
  14109. <member name="P:System.Data.SQLite.SQLiteContext.NativeHandle">
  14110. <summary>
  14111. Returns the underlying SQLite native handle associated with this
  14112. object instance.
  14113. </summary>
  14114. </member>
  14115. <member name="T:System.Data.SQLite.SQLiteValue">
  14116. <summary>
  14117. This class represents a value from the SQLite core library that can be
  14118. passed to the sqlite3_value_*() and associated functions.
  14119. </summary>
  14120. </member>
  14121. <member name="F:System.Data.SQLite.SQLiteValue.pValue">
  14122. <summary>
  14123. The native value handle.
  14124. </summary>
  14125. </member>
  14126. <member name="M:System.Data.SQLite.SQLiteValue.#ctor(System.IntPtr)">
  14127. <summary>
  14128. Constructs an instance of this class using the specified native
  14129. value handle.
  14130. </summary>
  14131. <param name="pValue">
  14132. The native value handle to use.
  14133. </param>
  14134. </member>
  14135. <member name="M:System.Data.SQLite.SQLiteValue.PreventNativeAccess">
  14136. <summary>
  14137. Invalidates the native value handle, thereby preventing further
  14138. access to it from this object instance.
  14139. </summary>
  14140. </member>
  14141. <member name="M:System.Data.SQLite.SQLiteValue.FromIntPtr(System.IntPtr)">
  14142. <summary>
  14143. Converts a native pointer to a native sqlite3_value structure into
  14144. a managed <see cref="T:System.Data.SQLite.SQLiteValue"/> object instance.
  14145. </summary>
  14146. <param name="pValue">
  14147. The native pointer to a native sqlite3_value structure to convert.
  14148. </param>
  14149. <returns>
  14150. The managed <see cref="T:System.Data.SQLite.SQLiteValue"/> object instance or null upon
  14151. failure.
  14152. </returns>
  14153. </member>
  14154. <member name="M:System.Data.SQLite.SQLiteValue.ArrayFromSizeAndIntPtr(System.Int32,System.IntPtr)">
  14155. <summary>
  14156. Converts a logical array of native pointers to native sqlite3_value
  14157. structures into a managed array of <see cref="T:System.Data.SQLite.SQLiteValue"/>
  14158. object instances.
  14159. </summary>
  14160. <param name="argc">
  14161. The number of elements in the logical array of native sqlite3_value
  14162. structures.
  14163. </param>
  14164. <param name="argv">
  14165. The native pointer to the logical array of native sqlite3_value
  14166. structures to convert.
  14167. </param>
  14168. <returns>
  14169. The managed array of <see cref="T:System.Data.SQLite.SQLiteValue"/> object instances or
  14170. null upon failure.
  14171. </returns>
  14172. </member>
  14173. <member name="M:System.Data.SQLite.SQLiteValue.GetTypeAffinity">
  14174. <summary>
  14175. Gets and returns the type affinity associated with this value.
  14176. </summary>
  14177. <returns>
  14178. The type affinity associated with this value.
  14179. </returns>
  14180. </member>
  14181. <member name="M:System.Data.SQLite.SQLiteValue.GetBytes">
  14182. <summary>
  14183. Gets and returns the number of bytes associated with this value, if
  14184. it refers to a UTF-8 encoded string.
  14185. </summary>
  14186. <returns>
  14187. The number of bytes associated with this value. The returned value
  14188. may be zero.
  14189. </returns>
  14190. </member>
  14191. <member name="M:System.Data.SQLite.SQLiteValue.GetInt">
  14192. <summary>
  14193. Gets and returns the <see cref="T:System.Int32"/> associated with this
  14194. value.
  14195. </summary>
  14196. <returns>
  14197. The <see cref="T:System.Int32"/> associated with this value.
  14198. </returns>
  14199. </member>
  14200. <member name="M:System.Data.SQLite.SQLiteValue.GetInt64">
  14201. <summary>
  14202. Gets and returns the <see cref="T:System.Int64"/> associated with
  14203. this value.
  14204. </summary>
  14205. <returns>
  14206. The <see cref="T:System.Int64"/> associated with this value.
  14207. </returns>
  14208. </member>
  14209. <member name="M:System.Data.SQLite.SQLiteValue.GetDouble">
  14210. <summary>
  14211. Gets and returns the <see cref="T:System.Double"/> associated with this
  14212. value.
  14213. </summary>
  14214. <returns>
  14215. The <see cref="T:System.Double"/> associated with this value.
  14216. </returns>
  14217. </member>
  14218. <member name="M:System.Data.SQLite.SQLiteValue.GetString">
  14219. <summary>
  14220. Gets and returns the <see cref="T:System.String"/> associated with this
  14221. value.
  14222. </summary>
  14223. <returns>
  14224. The <see cref="T:System.String"/> associated with this value. The value is
  14225. converted from the UTF-8 encoding prior to being returned.
  14226. </returns>
  14227. </member>
  14228. <member name="M:System.Data.SQLite.SQLiteValue.GetBlob">
  14229. <summary>
  14230. Gets and returns the <see cref="T:System.Byte"/> array associated with this
  14231. value.
  14232. </summary>
  14233. <returns>
  14234. The <see cref="T:System.Byte"/> array associated with this value.
  14235. </returns>
  14236. </member>
  14237. <member name="M:System.Data.SQLite.SQLiteValue.GetObject">
  14238. <summary>
  14239. Gets and returns an <see cref="T:System.Object"/> instance associated with
  14240. this value.
  14241. </summary>
  14242. <returns>
  14243. The <see cref="T:System.Object"/> associated with this value. If the type
  14244. affinity of the object is unknown or cannot be determined, a null
  14245. value will be returned.
  14246. </returns>
  14247. </member>
  14248. <member name="M:System.Data.SQLite.SQLiteValue.Persist">
  14249. <summary>
  14250. Uses the native value handle to obtain and store the managed value
  14251. for this object instance, thus saving it for later use. The type
  14252. of the managed value is determined by the type affinity of the
  14253. native value. If the type affinity is not recognized by this
  14254. method, no work is done and false is returned.
  14255. </summary>
  14256. <returns>
  14257. Non-zero if the native value was persisted successfully.
  14258. </returns>
  14259. </member>
  14260. <member name="P:System.Data.SQLite.SQLiteValue.NativeHandle">
  14261. <summary>
  14262. Returns the underlying SQLite native handle associated with this
  14263. object instance.
  14264. </summary>
  14265. </member>
  14266. <member name="P:System.Data.SQLite.SQLiteValue.Persisted">
  14267. <summary>
  14268. Returns non-zero if the native SQLite value has been successfully
  14269. persisted as a managed value within this object instance (i.e. the
  14270. <see cref="P:System.Data.SQLite.SQLiteValue.Value"/> property may then be read successfully).
  14271. </summary>
  14272. </member>
  14273. <member name="P:System.Data.SQLite.SQLiteValue.Value">
  14274. <summary>
  14275. If the managed value for this object instance is available (i.e. it
  14276. has been previously persisted via the <see cref="M:System.Data.SQLite.SQLiteValue.Persist"/>) method,
  14277. that value is returned; otherwise, an exception is thrown. The
  14278. returned value may be null.
  14279. </summary>
  14280. </member>
  14281. <member name="T:System.Data.SQLite.SQLiteIndexConstraintOp">
  14282. <summary>
  14283. These are the allowed values for the operators that are part of a
  14284. constraint term in the WHERE clause of a query that uses a virtual
  14285. table.
  14286. </summary>
  14287. </member>
  14288. <member name="F:System.Data.SQLite.SQLiteIndexConstraintOp.EqualTo">
  14289. <summary>
  14290. This value represents the equality operator.
  14291. </summary>
  14292. </member>
  14293. <member name="F:System.Data.SQLite.SQLiteIndexConstraintOp.GreaterThan">
  14294. <summary>
  14295. This value represents the greater than operator.
  14296. </summary>
  14297. </member>
  14298. <member name="F:System.Data.SQLite.SQLiteIndexConstraintOp.LessThanOrEqualTo">
  14299. <summary>
  14300. This value represents the less than or equal to operator.
  14301. </summary>
  14302. </member>
  14303. <member name="F:System.Data.SQLite.SQLiteIndexConstraintOp.LessThan">
  14304. <summary>
  14305. This value represents the less than operator.
  14306. </summary>
  14307. </member>
  14308. <member name="F:System.Data.SQLite.SQLiteIndexConstraintOp.GreaterThanOrEqualTo">
  14309. <summary>
  14310. This value represents the greater than or equal to operator.
  14311. </summary>
  14312. </member>
  14313. <member name="F:System.Data.SQLite.SQLiteIndexConstraintOp.Match">
  14314. <summary>
  14315. This value represents the MATCH operator.
  14316. </summary>
  14317. </member>
  14318. <member name="F:System.Data.SQLite.SQLiteIndexConstraintOp.Like">
  14319. <summary>
  14320. This value represents the LIKE operator.
  14321. </summary>
  14322. </member>
  14323. <member name="F:System.Data.SQLite.SQLiteIndexConstraintOp.Glob">
  14324. <summary>
  14325. This value represents the GLOB operator.
  14326. </summary>
  14327. </member>
  14328. <member name="F:System.Data.SQLite.SQLiteIndexConstraintOp.Regexp">
  14329. <summary>
  14330. This value represents the REGEXP operator.
  14331. </summary>
  14332. </member>
  14333. <member name="F:System.Data.SQLite.SQLiteIndexConstraintOp.NotEqualTo">
  14334. <summary>
  14335. This value represents the inequality operator.
  14336. </summary>
  14337. </member>
  14338. <member name="F:System.Data.SQLite.SQLiteIndexConstraintOp.IsNot">
  14339. <summary>
  14340. This value represents the IS NOT operator.
  14341. </summary>
  14342. </member>
  14343. <member name="F:System.Data.SQLite.SQLiteIndexConstraintOp.IsNotNull">
  14344. <summary>
  14345. This value represents the IS NOT NULL operator.
  14346. </summary>
  14347. </member>
  14348. <member name="F:System.Data.SQLite.SQLiteIndexConstraintOp.IsNull">
  14349. <summary>
  14350. This value represents the IS NULL operator.
  14351. </summary>
  14352. </member>
  14353. <member name="F:System.Data.SQLite.SQLiteIndexConstraintOp.Is">
  14354. <summary>
  14355. This value represents the IS operator.
  14356. </summary>
  14357. </member>
  14358. <member name="T:System.Data.SQLite.SQLiteIndexFlags">
  14359. <summary>
  14360. These are the allowed values for the index flags from the
  14361. <see cref="M:System.Data.SQLite.ISQLiteManagedModule.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)"/> method.
  14362. </summary>
  14363. </member>
  14364. <member name="F:System.Data.SQLite.SQLiteIndexFlags.None">
  14365. <summary>
  14366. No special handling. This is the default.
  14367. </summary>
  14368. </member>
  14369. <member name="F:System.Data.SQLite.SQLiteIndexFlags.ScanUnique">
  14370. <summary>
  14371. This value indicates that the scan of the index will visit at
  14372. most one row.
  14373. </summary>
  14374. </member>
  14375. <member name="T:System.Data.SQLite.SQLiteIndexConstraint">
  14376. <summary>
  14377. This class represents the native sqlite3_index_constraint structure
  14378. from the SQLite core library.
  14379. </summary>
  14380. </member>
  14381. <member name="M:System.Data.SQLite.SQLiteIndexConstraint.#ctor(System.Data.SQLite.UnsafeNativeMethods.sqlite3_index_constraint)">
  14382. <summary>
  14383. Constructs an instance of this class using the specified native
  14384. sqlite3_index_constraint structure.
  14385. </summary>
  14386. <param name="constraint">
  14387. The native sqlite3_index_constraint structure to use.
  14388. </param>
  14389. </member>
  14390. <member name="M:System.Data.SQLite.SQLiteIndexConstraint.#ctor(System.Int32,System.Data.SQLite.SQLiteIndexConstraintOp,System.Byte,System.Int32)">
  14391. <summary>
  14392. Constructs an instance of this class using the specified field
  14393. values.
  14394. </summary>
  14395. <param name="iColumn">
  14396. Column on left-hand side of constraint.
  14397. </param>
  14398. <param name="op">
  14399. Constraint operator (<see cref="T:System.Data.SQLite.SQLiteIndexConstraintOp"/>).
  14400. </param>
  14401. <param name="usable">
  14402. True if this constraint is usable.
  14403. </param>
  14404. <param name="iTermOffset">
  14405. Used internally - <see cref="M:System.Data.SQLite.ISQLiteManagedModule.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)"/>
  14406. should ignore.
  14407. </param>
  14408. </member>
  14409. <member name="F:System.Data.SQLite.SQLiteIndexConstraint.iColumn">
  14410. <summary>
  14411. Column on left-hand side of constraint.
  14412. </summary>
  14413. </member>
  14414. <member name="F:System.Data.SQLite.SQLiteIndexConstraint.op">
  14415. <summary>
  14416. Constraint operator (<see cref="T:System.Data.SQLite.SQLiteIndexConstraintOp"/>).
  14417. </summary>
  14418. </member>
  14419. <member name="F:System.Data.SQLite.SQLiteIndexConstraint.usable">
  14420. <summary>
  14421. True if this constraint is usable.
  14422. </summary>
  14423. </member>
  14424. <member name="F:System.Data.SQLite.SQLiteIndexConstraint.iTermOffset">
  14425. <summary>
  14426. Used internally - <see cref="M:System.Data.SQLite.ISQLiteManagedModule.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)"/>
  14427. should ignore.
  14428. </summary>
  14429. </member>
  14430. <member name="T:System.Data.SQLite.SQLiteIndexOrderBy">
  14431. <summary>
  14432. This class represents the native sqlite3_index_orderby structure from
  14433. the SQLite core library.
  14434. </summary>
  14435. </member>
  14436. <member name="M:System.Data.SQLite.SQLiteIndexOrderBy.#ctor(System.Data.SQLite.UnsafeNativeMethods.sqlite3_index_orderby)">
  14437. <summary>
  14438. Constructs an instance of this class using the specified native
  14439. sqlite3_index_orderby structure.
  14440. </summary>
  14441. <param name="orderBy">
  14442. The native sqlite3_index_orderby structure to use.
  14443. </param>
  14444. </member>
  14445. <member name="M:System.Data.SQLite.SQLiteIndexOrderBy.#ctor(System.Int32,System.Byte)">
  14446. <summary>
  14447. Constructs an instance of this class using the specified field
  14448. values.
  14449. </summary>
  14450. <param name="iColumn">
  14451. Column number.
  14452. </param>
  14453. <param name="desc">
  14454. True for DESC. False for ASC.
  14455. </param>
  14456. </member>
  14457. <member name="F:System.Data.SQLite.SQLiteIndexOrderBy.iColumn">
  14458. <summary>
  14459. Column number.
  14460. </summary>
  14461. </member>
  14462. <member name="F:System.Data.SQLite.SQLiteIndexOrderBy.desc">
  14463. <summary>
  14464. True for DESC. False for ASC.
  14465. </summary>
  14466. </member>
  14467. <member name="T:System.Data.SQLite.SQLiteIndexConstraintUsage">
  14468. <summary>
  14469. This class represents the native sqlite3_index_constraint_usage
  14470. structure from the SQLite core library.
  14471. </summary>
  14472. </member>
  14473. <member name="M:System.Data.SQLite.SQLiteIndexConstraintUsage.#ctor">
  14474. <summary>
  14475. Constructs a default instance of this class.
  14476. </summary>
  14477. </member>
  14478. <member name="M:System.Data.SQLite.SQLiteIndexConstraintUsage.#ctor(System.Data.SQLite.UnsafeNativeMethods.sqlite3_index_constraint_usage)">
  14479. <summary>
  14480. Constructs an instance of this class using the specified native
  14481. sqlite3_index_constraint_usage structure.
  14482. </summary>
  14483. <param name="constraintUsage">
  14484. The native sqlite3_index_constraint_usage structure to use.
  14485. </param>
  14486. </member>
  14487. <member name="M:System.Data.SQLite.SQLiteIndexConstraintUsage.#ctor(System.Int32,System.Byte)">
  14488. <summary>
  14489. Constructs an instance of this class using the specified field
  14490. values.
  14491. </summary>
  14492. <param name="argvIndex">
  14493. If greater than 0, constraint is part of argv to xFilter.
  14494. </param>
  14495. <param name="omit">
  14496. Do not code a test for this constraint.
  14497. </param>
  14498. </member>
  14499. <member name="F:System.Data.SQLite.SQLiteIndexConstraintUsage.argvIndex">
  14500. <summary>
  14501. If greater than 0, constraint is part of argv to xFilter.
  14502. </summary>
  14503. </member>
  14504. <member name="F:System.Data.SQLite.SQLiteIndexConstraintUsage.omit">
  14505. <summary>
  14506. Do not code a test for this constraint.
  14507. </summary>
  14508. </member>
  14509. <member name="T:System.Data.SQLite.SQLiteIndexInputs">
  14510. <summary>
  14511. This class represents the various inputs provided by the SQLite core
  14512. library to the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)"/> method.
  14513. </summary>
  14514. </member>
  14515. <member name="M:System.Data.SQLite.SQLiteIndexInputs.#ctor(System.Int32,System.Int32)">
  14516. <summary>
  14517. Constructs an instance of this class.
  14518. </summary>
  14519. <param name="nConstraint">
  14520. The number of <see cref="T:System.Data.SQLite.SQLiteIndexConstraint"/> instances to
  14521. pre-allocate space for.
  14522. </param>
  14523. <param name="nOrderBy">
  14524. The number of <see cref="T:System.Data.SQLite.SQLiteIndexOrderBy"/> instances to
  14525. pre-allocate space for.
  14526. </param>
  14527. </member>
  14528. <member name="P:System.Data.SQLite.SQLiteIndexInputs.Constraints">
  14529. <summary>
  14530. An array of <see cref="T:System.Data.SQLite.SQLiteIndexConstraint"/> object instances,
  14531. each containing information supplied by the SQLite core library.
  14532. </summary>
  14533. </member>
  14534. <member name="P:System.Data.SQLite.SQLiteIndexInputs.OrderBys">
  14535. <summary>
  14536. An array of <see cref="T:System.Data.SQLite.SQLiteIndexOrderBy"/> object instances,
  14537. each containing information supplied by the SQLite core library.
  14538. </summary>
  14539. </member>
  14540. <member name="T:System.Data.SQLite.SQLiteIndexOutputs">
  14541. <summary>
  14542. This class represents the various outputs provided to the SQLite core
  14543. library by the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)"/> method.
  14544. </summary>
  14545. </member>
  14546. <member name="M:System.Data.SQLite.SQLiteIndexOutputs.#ctor(System.Int32)">
  14547. <summary>
  14548. Constructs an instance of this class.
  14549. </summary>
  14550. <param name="nConstraint">
  14551. The number of <see cref="T:System.Data.SQLite.SQLiteIndexConstraintUsage"/> instances
  14552. to pre-allocate space for.
  14553. </param>
  14554. </member>
  14555. <member name="M:System.Data.SQLite.SQLiteIndexOutputs.CanUseEstimatedRows">
  14556. <summary>
  14557. Determines if the native estimatedRows field can be used, based on
  14558. the available version of the SQLite core library.
  14559. </summary>
  14560. <returns>
  14561. Non-zero if the <see cref="P:System.Data.SQLite.SQLiteIndexOutputs.EstimatedRows"/> property is supported
  14562. by the SQLite core library.
  14563. </returns>
  14564. </member>
  14565. <member name="M:System.Data.SQLite.SQLiteIndexOutputs.CanUseIndexFlags">
  14566. <summary>
  14567. Determines if the native flags field can be used, based on the
  14568. available version of the SQLite core library.
  14569. </summary>
  14570. <returns>
  14571. Non-zero if the <see cref="P:System.Data.SQLite.SQLiteIndexOutputs.IndexFlags"/> property is supported by
  14572. the SQLite core library.
  14573. </returns>
  14574. </member>
  14575. <member name="M:System.Data.SQLite.SQLiteIndexOutputs.CanUseColumnsUsed">
  14576. <summary>
  14577. Determines if the native flags field can be used, based on the
  14578. available version of the SQLite core library.
  14579. </summary>
  14580. <returns>
  14581. Non-zero if the <see cref="P:System.Data.SQLite.SQLiteIndexOutputs.ColumnsUsed"/> property is supported by
  14582. the SQLite core library.
  14583. </returns>
  14584. </member>
  14585. <member name="P:System.Data.SQLite.SQLiteIndexOutputs.ConstraintUsages">
  14586. <summary>
  14587. An array of <see cref="T:System.Data.SQLite.SQLiteIndexConstraintUsage"/> object
  14588. instances, each containing information to be supplied to the SQLite
  14589. core library.
  14590. </summary>
  14591. </member>
  14592. <member name="P:System.Data.SQLite.SQLiteIndexOutputs.IndexNumber">
  14593. <summary>
  14594. Number used to help identify the selected index. This value will
  14595. later be provided to the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Filter(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int32,System.String,System.Data.SQLite.SQLiteValue[])"/>
  14596. method.
  14597. </summary>
  14598. </member>
  14599. <member name="P:System.Data.SQLite.SQLiteIndexOutputs.IndexString">
  14600. <summary>
  14601. String used to help identify the selected index. This value will
  14602. later be provided to the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Filter(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int32,System.String,System.Data.SQLite.SQLiteValue[])"/>
  14603. method.
  14604. </summary>
  14605. </member>
  14606. <member name="P:System.Data.SQLite.SQLiteIndexOutputs.NeedToFreeIndexString">
  14607. <summary>
  14608. Non-zero if the index string must be freed by the SQLite core
  14609. library.
  14610. </summary>
  14611. </member>
  14612. <member name="P:System.Data.SQLite.SQLiteIndexOutputs.OrderByConsumed">
  14613. <summary>
  14614. True if output is already ordered.
  14615. </summary>
  14616. </member>
  14617. <member name="P:System.Data.SQLite.SQLiteIndexOutputs.EstimatedCost">
  14618. <summary>
  14619. Estimated cost of using this index. Using a null value here
  14620. indicates that a default estimated cost value should be used.
  14621. </summary>
  14622. </member>
  14623. <member name="P:System.Data.SQLite.SQLiteIndexOutputs.EstimatedRows">
  14624. <summary>
  14625. Estimated number of rows returned. Using a null value here
  14626. indicates that a default estimated rows value should be used.
  14627. This property has no effect if the SQLite core library is not at
  14628. least version 3.8.2.
  14629. </summary>
  14630. </member>
  14631. <member name="P:System.Data.SQLite.SQLiteIndexOutputs.IndexFlags">
  14632. <summary>
  14633. The flags that should be used with this index. Using a null value
  14634. here indicates that a default flags value should be used. This
  14635. property has no effect if the SQLite core library is not at least
  14636. version 3.9.0.
  14637. </summary>
  14638. </member>
  14639. <member name="P:System.Data.SQLite.SQLiteIndexOutputs.ColumnsUsed">
  14640. <summary>
  14641. <para>
  14642. Indicates which columns of the virtual table may be required by the
  14643. current scan. Virtual table columns are numbered from zero in the
  14644. order in which they appear within the CREATE TABLE statement passed
  14645. to sqlite3_declare_vtab(). For the first 63 columns (columns 0-62),
  14646. the corresponding bit is set within the bit mask if the column may
  14647. be required by SQLite. If the table has at least 64 columns and
  14648. any column to the right of the first 63 is required, then bit 63 of
  14649. colUsed is also set. In other words, column iCol may be required
  14650. if the expression
  14651. </para>
  14652. <para><code>
  14653. (colUsed &amp; ((sqlite3_uint64)1 &lt;&lt; (iCol&gt;=63 ? 63 : iCol)))
  14654. </code></para>
  14655. <para>
  14656. evaluates to non-zero. Using a null value here indicates that a
  14657. default flags value should be used. This property has no effect if
  14658. the SQLite core library is not at least version 3.10.0.
  14659. </para>
  14660. </summary>
  14661. </member>
  14662. <member name="T:System.Data.SQLite.SQLiteIndex">
  14663. <summary>
  14664. This class represents the various inputs and outputs used with the
  14665. <see cref="M:System.Data.SQLite.ISQLiteManagedModule.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)"/> method.
  14666. </summary>
  14667. </member>
  14668. <member name="M:System.Data.SQLite.SQLiteIndex.#ctor(System.Int32,System.Int32)">
  14669. <summary>
  14670. Constructs an instance of this class.
  14671. </summary>
  14672. <param name="nConstraint">
  14673. The number of <see cref="T:System.Data.SQLite.SQLiteIndexConstraint"/> (and
  14674. <see cref="T:System.Data.SQLite.SQLiteIndexConstraintUsage"/>) instances to
  14675. pre-allocate space for.
  14676. </param>
  14677. <param name="nOrderBy">
  14678. The number of <see cref="T:System.Data.SQLite.SQLiteIndexOrderBy"/> instances to
  14679. pre-allocate space for.
  14680. </param>
  14681. </member>
  14682. <member name="M:System.Data.SQLite.SQLiteIndex.SizeOfNative(System.Int32@,System.Int32@,System.Int32@,System.Int32@)">
  14683. <summary>
  14684. Attempts to determine the structure sizes needed to create and
  14685. populate a native
  14686. <see cref="T:System.Data.SQLite.UnsafeNativeMethods.sqlite3_index_info"/>
  14687. structure.
  14688. </summary>
  14689. <param name="sizeOfInfoType">
  14690. The size of the native
  14691. <see cref="T:System.Data.SQLite.UnsafeNativeMethods.sqlite3_index_info"/>
  14692. structure is stored here.
  14693. </param>
  14694. <param name="sizeOfConstraintType">
  14695. The size of the native
  14696. <see cref="T:System.Data.SQLite.UnsafeNativeMethods.sqlite3_index_constraint"/>
  14697. structure is stored here.
  14698. </param>
  14699. <param name="sizeOfOrderByType">
  14700. The size of the native
  14701. <see cref="T:System.Data.SQLite.UnsafeNativeMethods.sqlite3_index_orderby"/>
  14702. structure is stored here.
  14703. </param>
  14704. <param name="sizeOfConstraintUsageType">
  14705. The size of the native
  14706. <see cref="T:System.Data.SQLite.UnsafeNativeMethods.sqlite3_index_constraint_usage"/>
  14707. structure is stored here.
  14708. </param>
  14709. </member>
  14710. <member name="M:System.Data.SQLite.SQLiteIndex.AllocateAndInitializeNative(System.Int32,System.Int32)">
  14711. <summary>
  14712. Attempts to allocate and initialize a native
  14713. <see cref="T:System.Data.SQLite.UnsafeNativeMethods.sqlite3_index_info"/>
  14714. structure.
  14715. </summary>
  14716. <param name="nConstraint">
  14717. The number of <see cref="T:System.Data.SQLite.SQLiteIndexConstraint"/> instances to
  14718. pre-allocate space for.
  14719. </param>
  14720. <param name="nOrderBy">
  14721. The number of <see cref="T:System.Data.SQLite.SQLiteIndexOrderBy"/> instances to
  14722. pre-allocate space for.
  14723. </param>
  14724. <returns>
  14725. The newly allocated native
  14726. <see cref="T:System.Data.SQLite.UnsafeNativeMethods.sqlite3_index_info"/> structure
  14727. -OR- <see cref="F:System.IntPtr.Zero"/> if it could not be fully allocated.
  14728. </returns>
  14729. </member>
  14730. <member name="M:System.Data.SQLite.SQLiteIndex.FreeNative(System.IntPtr)">
  14731. <summary>
  14732. Frees all the memory associated with a native
  14733. <see cref="T:System.Data.SQLite.UnsafeNativeMethods.sqlite3_index_info"/>
  14734. structure.
  14735. </summary>
  14736. <param name="pIndex">
  14737. The native pointer to the native sqlite3_index_info structure to
  14738. free.
  14739. </param>
  14740. </member>
  14741. <member name="M:System.Data.SQLite.SQLiteIndex.FromIntPtr(System.IntPtr,System.Boolean,System.Data.SQLite.SQLiteIndex@)">
  14742. <summary>
  14743. Converts a native pointer to a native sqlite3_index_info structure
  14744. into a new <see cref="T:System.Data.SQLite.SQLiteIndex"/> object instance.
  14745. </summary>
  14746. <param name="pIndex">
  14747. The native pointer to the native sqlite3_index_info structure to
  14748. convert.
  14749. </param>
  14750. <param name="includeOutput">
  14751. Non-zero to include fields from the outputs portion of the native
  14752. structure; otherwise, the "output" fields will not be read.
  14753. </param>
  14754. <param name="index">
  14755. Upon success, this parameter will be modified to contain the newly
  14756. created <see cref="T:System.Data.SQLite.SQLiteIndex"/> object instance.
  14757. </param>
  14758. </member>
  14759. <member name="M:System.Data.SQLite.SQLiteIndex.ToIntPtr(System.Data.SQLite.SQLiteIndex,System.IntPtr,System.Boolean)">
  14760. <summary>
  14761. Populates the outputs of a pre-allocated native sqlite3_index_info
  14762. structure using an existing <see cref="T:System.Data.SQLite.SQLiteIndex"/> object
  14763. instance.
  14764. </summary>
  14765. <param name="index">
  14766. The existing <see cref="T:System.Data.SQLite.SQLiteIndex"/> object instance containing
  14767. the output data to use.
  14768. </param>
  14769. <param name="pIndex">
  14770. The native pointer to the pre-allocated native sqlite3_index_info
  14771. structure.
  14772. </param>
  14773. <param name="includeInput">
  14774. Non-zero to include fields from the inputs portion of the native
  14775. structure; otherwise, the "input" fields will not be written.
  14776. </param>
  14777. </member>
  14778. <member name="P:System.Data.SQLite.SQLiteIndex.Inputs">
  14779. <summary>
  14780. The <see cref="T:System.Data.SQLite.SQLiteIndexInputs"/> object instance containing
  14781. the inputs to the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)"/>
  14782. method.
  14783. </summary>
  14784. </member>
  14785. <member name="P:System.Data.SQLite.SQLiteIndex.Outputs">
  14786. <summary>
  14787. The <see cref="T:System.Data.SQLite.SQLiteIndexOutputs"/> object instance containing
  14788. the outputs from the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)"/>
  14789. method.
  14790. </summary>
  14791. </member>
  14792. <member name="T:System.Data.SQLite.SQLiteVirtualTable">
  14793. <summary>
  14794. This class represents a managed virtual table implementation. It is
  14795. not sealed and should be used as the base class for any user-defined
  14796. virtual table classes implemented in managed code.
  14797. </summary>
  14798. </member>
  14799. <member name="F:System.Data.SQLite.SQLiteVirtualTable.ModuleNameIndex">
  14800. <summary>
  14801. The index within the array of strings provided to the
  14802. <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Create(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/> and
  14803. <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Connect(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/> methods containing the
  14804. name of the module implementing this virtual table.
  14805. </summary>
  14806. </member>
  14807. <member name="F:System.Data.SQLite.SQLiteVirtualTable.DatabaseNameIndex">
  14808. <summary>
  14809. The index within the array of strings provided to the
  14810. <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Create(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/> and
  14811. <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Connect(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/> methods containing the
  14812. name of the database containing this virtual table.
  14813. </summary>
  14814. </member>
  14815. <member name="F:System.Data.SQLite.SQLiteVirtualTable.TableNameIndex">
  14816. <summary>
  14817. The index within the array of strings provided to the
  14818. <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Create(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/> and
  14819. <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Connect(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/> methods containing the
  14820. name of the virtual table.
  14821. </summary>
  14822. </member>
  14823. <member name="M:System.Data.SQLite.SQLiteVirtualTable.#ctor(System.String[])">
  14824. <summary>
  14825. Constructs an instance of this class.
  14826. </summary>
  14827. <param name="arguments">
  14828. The original array of strings provided to the
  14829. <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Create(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/> and
  14830. <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Connect(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/> methods.
  14831. </param>
  14832. </member>
  14833. <member name="M:System.Data.SQLite.SQLiteVirtualTable.BestIndex(System.Data.SQLite.SQLiteIndex)">
  14834. <summary>
  14835. This method should normally be used by the
  14836. <see cref="M:System.Data.SQLite.ISQLiteManagedModule.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)"/> method in order to
  14837. perform index selection based on the constraints provided by the
  14838. SQLite core library.
  14839. </summary>
  14840. <param name="index">
  14841. The <see cref="T:System.Data.SQLite.SQLiteIndex"/> object instance containing all the
  14842. data for the inputs and outputs relating to index selection.
  14843. </param>
  14844. <returns>
  14845. Non-zero upon success.
  14846. </returns>
  14847. </member>
  14848. <member name="M:System.Data.SQLite.SQLiteVirtualTable.Rename(System.String)">
  14849. <summary>
  14850. Attempts to record the renaming of the virtual table associated
  14851. with this object instance.
  14852. </summary>
  14853. <param name="name">
  14854. The new name for the virtual table.
  14855. </param>
  14856. <returns>
  14857. Non-zero upon success.
  14858. </returns>
  14859. </member>
  14860. <member name="M:System.Data.SQLite.SQLiteVirtualTable.Dispose">
  14861. <summary>
  14862. Disposes of this object instance.
  14863. </summary>
  14864. </member>
  14865. <member name="M:System.Data.SQLite.SQLiteVirtualTable.CheckDisposed">
  14866. <summary>
  14867. Throws an <see cref="T:System.ObjectDisposedException"/> if this object
  14868. instance has been disposed.
  14869. </summary>
  14870. </member>
  14871. <member name="M:System.Data.SQLite.SQLiteVirtualTable.Dispose(System.Boolean)">
  14872. <summary>
  14873. Disposes of this object instance.
  14874. </summary>
  14875. <param name="disposing">
  14876. Non-zero if this method is being called from the
  14877. <see cref="M:System.Data.SQLite.SQLiteVirtualTable.Dispose"/> method. Zero if this method is being called
  14878. from the finalizer.
  14879. </param>
  14880. </member>
  14881. <member name="M:System.Data.SQLite.SQLiteVirtualTable.Finalize">
  14882. <summary>
  14883. Finalizes this object instance.
  14884. </summary>
  14885. </member>
  14886. <member name="P:System.Data.SQLite.SQLiteVirtualTable.Arguments">
  14887. <summary>
  14888. The original array of strings provided to the
  14889. <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Create(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/> and
  14890. <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Connect(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/> methods.
  14891. </summary>
  14892. </member>
  14893. <member name="P:System.Data.SQLite.SQLiteVirtualTable.ModuleName">
  14894. <summary>
  14895. The name of the module implementing this virtual table.
  14896. </summary>
  14897. </member>
  14898. <member name="P:System.Data.SQLite.SQLiteVirtualTable.DatabaseName">
  14899. <summary>
  14900. The name of the database containing this virtual table.
  14901. </summary>
  14902. </member>
  14903. <member name="P:System.Data.SQLite.SQLiteVirtualTable.TableName">
  14904. <summary>
  14905. The name of the virtual table.
  14906. </summary>
  14907. </member>
  14908. <member name="P:System.Data.SQLite.SQLiteVirtualTable.Index">
  14909. <summary>
  14910. The <see cref="T:System.Data.SQLite.SQLiteIndex"/> object instance containing all the
  14911. data for the inputs and outputs relating to the most recent index
  14912. selection.
  14913. </summary>
  14914. </member>
  14915. <member name="P:System.Data.SQLite.SQLiteVirtualTable.NativeHandle">
  14916. <summary>
  14917. Returns the underlying SQLite native handle associated with this
  14918. object instance.
  14919. </summary>
  14920. </member>
  14921. <member name="T:System.Data.SQLite.SQLiteVirtualTableCursor">
  14922. <summary>
  14923. This class represents a managed virtual table cursor implementation.
  14924. It is not sealed and should be used as the base class for any
  14925. user-defined virtual table cursor classes implemented in managed code.
  14926. </summary>
  14927. </member>
  14928. <member name="F:System.Data.SQLite.SQLiteVirtualTableCursor.InvalidRowIndex">
  14929. <summary>
  14930. This value represents an invalid integer row sequence number.
  14931. </summary>
  14932. </member>
  14933. <member name="F:System.Data.SQLite.SQLiteVirtualTableCursor.rowIndex">
  14934. <summary>
  14935. The field holds the integer row sequence number for the current row
  14936. pointed to by this cursor object instance.
  14937. </summary>
  14938. </member>
  14939. <member name="M:System.Data.SQLite.SQLiteVirtualTableCursor.#ctor(System.Data.SQLite.SQLiteVirtualTable)">
  14940. <summary>
  14941. Constructs an instance of this class.
  14942. </summary>
  14943. <param name="table">
  14944. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance associated
  14945. with this object instance.
  14946. </param>
  14947. </member>
  14948. <member name="M:System.Data.SQLite.SQLiteVirtualTableCursor.#ctor">
  14949. <summary>
  14950. Constructs an instance of this class.
  14951. </summary>
  14952. </member>
  14953. <member name="M:System.Data.SQLite.SQLiteVirtualTableCursor.TryPersistValues(System.Data.SQLite.SQLiteValue[])">
  14954. <summary>
  14955. Attempts to persist the specified <see cref="T:System.Data.SQLite.SQLiteValue"/> object
  14956. instances in order to make them available after the
  14957. <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Filter(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int32,System.String,System.Data.SQLite.SQLiteValue[])"/> method returns.
  14958. </summary>
  14959. <param name="values">
  14960. The array of <see cref="T:System.Data.SQLite.SQLiteValue"/> object instances to be
  14961. persisted.
  14962. </param>
  14963. <returns>
  14964. The number of <see cref="T:System.Data.SQLite.SQLiteValue"/> object instances that were
  14965. successfully persisted.
  14966. </returns>
  14967. </member>
  14968. <member name="M:System.Data.SQLite.SQLiteVirtualTableCursor.Filter(System.Int32,System.String,System.Data.SQLite.SQLiteValue[])">
  14969. <summary>
  14970. This method should normally be used by the
  14971. <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Filter(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int32,System.String,System.Data.SQLite.SQLiteValue[])"/> method in order to
  14972. perform filtering of the result rows and/or to record the filtering
  14973. criteria provided by the SQLite core library.
  14974. </summary>
  14975. <param name="indexNumber">
  14976. Number used to help identify the selected index.
  14977. </param>
  14978. <param name="indexString">
  14979. String used to help identify the selected index.
  14980. </param>
  14981. <param name="values">
  14982. The values corresponding to each column in the selected index.
  14983. </param>
  14984. </member>
  14985. <member name="M:System.Data.SQLite.SQLiteVirtualTableCursor.GetRowIndex">
  14986. <summary>
  14987. Determines the integer row sequence number for the current row.
  14988. </summary>
  14989. <returns>
  14990. The integer row sequence number for the current row -OR- zero if
  14991. it cannot be determined.
  14992. </returns>
  14993. </member>
  14994. <member name="M:System.Data.SQLite.SQLiteVirtualTableCursor.NextRowIndex">
  14995. <summary>
  14996. Adjusts the integer row sequence number so that it refers to the
  14997. next row.
  14998. </summary>
  14999. </member>
  15000. <member name="M:System.Data.SQLite.SQLiteVirtualTableCursor.Dispose">
  15001. <summary>
  15002. Disposes of this object instance.
  15003. </summary>
  15004. </member>
  15005. <member name="M:System.Data.SQLite.SQLiteVirtualTableCursor.CheckDisposed">
  15006. <summary>
  15007. Throws an <see cref="T:System.ObjectDisposedException"/> if this object
  15008. instance has been disposed.
  15009. </summary>
  15010. </member>
  15011. <member name="M:System.Data.SQLite.SQLiteVirtualTableCursor.Dispose(System.Boolean)">
  15012. <summary>
  15013. Disposes of this object instance.
  15014. </summary>
  15015. <param name="disposing">
  15016. Non-zero if this method is being called from the
  15017. <see cref="M:System.Data.SQLite.SQLiteVirtualTableCursor.Dispose"/> method. Zero if this method is being called
  15018. from the finalizer.
  15019. </param>
  15020. </member>
  15021. <member name="M:System.Data.SQLite.SQLiteVirtualTableCursor.Finalize">
  15022. <summary>
  15023. Finalizes this object instance.
  15024. </summary>
  15025. </member>
  15026. <member name="P:System.Data.SQLite.SQLiteVirtualTableCursor.Table">
  15027. <summary>
  15028. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance associated
  15029. with this object instance.
  15030. </summary>
  15031. </member>
  15032. <member name="P:System.Data.SQLite.SQLiteVirtualTableCursor.IndexNumber">
  15033. <summary>
  15034. Number used to help identify the selected index. This value will
  15035. be set via the <see cref="M:System.Data.SQLite.SQLiteVirtualTableCursor.Filter(System.Int32,System.String,System.Data.SQLite.SQLiteValue[])"/> method.
  15036. </summary>
  15037. </member>
  15038. <member name="P:System.Data.SQLite.SQLiteVirtualTableCursor.IndexString">
  15039. <summary>
  15040. String used to help identify the selected index. This value will
  15041. be set via the <see cref="M:System.Data.SQLite.SQLiteVirtualTableCursor.Filter(System.Int32,System.String,System.Data.SQLite.SQLiteValue[])"/> method.
  15042. </summary>
  15043. </member>
  15044. <member name="P:System.Data.SQLite.SQLiteVirtualTableCursor.Values">
  15045. <summary>
  15046. The values used to filter the rows returned via this cursor object
  15047. instance. This value will be set via the <see cref="M:System.Data.SQLite.SQLiteVirtualTableCursor.Filter(System.Int32,System.String,System.Data.SQLite.SQLiteValue[])"/>
  15048. method.
  15049. </summary>
  15050. </member>
  15051. <member name="P:System.Data.SQLite.SQLiteVirtualTableCursor.NativeHandle">
  15052. <summary>
  15053. Returns the underlying SQLite native handle associated with this
  15054. object instance.
  15055. </summary>
  15056. </member>
  15057. <member name="T:System.Data.SQLite.ISQLiteManagedModule">
  15058. <summary>
  15059. This interface represents a virtual table implementation written in
  15060. managed code.
  15061. </summary>
  15062. </member>
  15063. <member name="M:System.Data.SQLite.ISQLiteManagedModule.Create(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)">
  15064. <summary>
  15065. This method is called in response to the
  15066. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> method.
  15067. </summary>
  15068. <param name="connection">
  15069. The <see cref="T:System.Data.SQLite.SQLiteConnection"/> object instance associated with
  15070. the virtual table.
  15071. </param>
  15072. <param name="pClientData">
  15073. The native user-data pointer associated with this module, as it was
  15074. provided to the SQLite core library when the native module instance
  15075. was created.
  15076. </param>
  15077. <param name="arguments">
  15078. The module name, database name, virtual table name, and all other
  15079. arguments passed to the CREATE VIRTUAL TABLE statement.
  15080. </param>
  15081. <param name="table">
  15082. Upon success, this parameter must be modified to contain the
  15083. <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance associated with
  15084. the virtual table.
  15085. </param>
  15086. <param name="error">
  15087. Upon failure, this parameter must be modified to contain an error
  15088. message.
  15089. </param>
  15090. <returns>
  15091. A standard SQLite return code.
  15092. </returns>
  15093. </member>
  15094. <member name="M:System.Data.SQLite.ISQLiteManagedModule.Connect(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)">
  15095. <summary>
  15096. This method is called in response to the
  15097. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> method.
  15098. </summary>
  15099. <param name="connection">
  15100. The <see cref="T:System.Data.SQLite.SQLiteConnection"/> object instance associated with
  15101. the virtual table.
  15102. </param>
  15103. <param name="pClientData">
  15104. The native user-data pointer associated with this module, as it was
  15105. provided to the SQLite core library when the native module instance
  15106. was created.
  15107. </param>
  15108. <param name="arguments">
  15109. The module name, database name, virtual table name, and all other
  15110. arguments passed to the CREATE VIRTUAL TABLE statement.
  15111. </param>
  15112. <param name="table">
  15113. Upon success, this parameter must be modified to contain the
  15114. <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance associated with
  15115. the virtual table.
  15116. </param>
  15117. <param name="error">
  15118. Upon failure, this parameter must be modified to contain an error
  15119. message.
  15120. </param>
  15121. <returns>
  15122. A standard SQLite return code.
  15123. </returns>
  15124. </member>
  15125. <member name="M:System.Data.SQLite.ISQLiteManagedModule.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)">
  15126. <summary>
  15127. This method is called in response to the
  15128. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xBestIndex(System.IntPtr,System.IntPtr)"/> method.
  15129. </summary>
  15130. <param name="table">
  15131. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance associated
  15132. with this virtual table.
  15133. </param>
  15134. <param name="index">
  15135. The <see cref="T:System.Data.SQLite.SQLiteIndex"/> object instance containing all the
  15136. data for the inputs and outputs relating to index selection.
  15137. </param>
  15138. <returns>
  15139. A standard SQLite return code.
  15140. </returns>
  15141. </member>
  15142. <member name="M:System.Data.SQLite.ISQLiteManagedModule.Disconnect(System.Data.SQLite.SQLiteVirtualTable)">
  15143. <summary>
  15144. This method is called in response to the
  15145. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDisconnect(System.IntPtr)"/> method.
  15146. </summary>
  15147. <param name="table">
  15148. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance associated
  15149. with this virtual table.
  15150. </param>
  15151. <returns>
  15152. A standard SQLite return code.
  15153. </returns>
  15154. </member>
  15155. <member name="M:System.Data.SQLite.ISQLiteManagedModule.Destroy(System.Data.SQLite.SQLiteVirtualTable)">
  15156. <summary>
  15157. This method is called in response to the
  15158. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDestroy(System.IntPtr)"/> method.
  15159. </summary>
  15160. <param name="table">
  15161. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance associated
  15162. with this virtual table.
  15163. </param>
  15164. <returns>
  15165. A standard SQLite return code.
  15166. </returns>
  15167. </member>
  15168. <member name="M:System.Data.SQLite.ISQLiteManagedModule.Open(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteVirtualTableCursor@)">
  15169. <summary>
  15170. This method is called in response to the
  15171. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xOpen(System.IntPtr,System.IntPtr@)"/> method.
  15172. </summary>
  15173. <param name="table">
  15174. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance associated
  15175. with this virtual table.
  15176. </param>
  15177. <param name="cursor">
  15178. Upon success, this parameter must be modified to contain the
  15179. <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor"/> object instance associated
  15180. with the newly opened virtual table cursor.
  15181. </param>
  15182. <returns>
  15183. A standard SQLite return code.
  15184. </returns>
  15185. </member>
  15186. <member name="M:System.Data.SQLite.ISQLiteManagedModule.Close(System.Data.SQLite.SQLiteVirtualTableCursor)">
  15187. <summary>
  15188. This method is called in response to the
  15189. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xClose(System.IntPtr)"/> method.
  15190. </summary>
  15191. <param name="cursor">
  15192. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor"/> object instance
  15193. associated with the previously opened virtual table cursor to be
  15194. used.
  15195. </param>
  15196. <returns>
  15197. A standard SQLite return code.
  15198. </returns>
  15199. </member>
  15200. <member name="M:System.Data.SQLite.ISQLiteManagedModule.Filter(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int32,System.String,System.Data.SQLite.SQLiteValue[])">
  15201. <summary>
  15202. This method is called in response to the
  15203. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFilter(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)"/> method.
  15204. </summary>
  15205. <param name="cursor">
  15206. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor"/> object instance
  15207. associated with the previously opened virtual table cursor to be
  15208. used.
  15209. </param>
  15210. <param name="indexNumber">
  15211. Number used to help identify the selected index.
  15212. </param>
  15213. <param name="indexString">
  15214. String used to help identify the selected index.
  15215. </param>
  15216. <param name="values">
  15217. The values corresponding to each column in the selected index.
  15218. </param>
  15219. <returns>
  15220. A standard SQLite return code.
  15221. </returns>
  15222. </member>
  15223. <member name="M:System.Data.SQLite.ISQLiteManagedModule.Next(System.Data.SQLite.SQLiteVirtualTableCursor)">
  15224. <summary>
  15225. This method is called in response to the
  15226. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xNext(System.IntPtr)"/> method.
  15227. </summary>
  15228. <param name="cursor">
  15229. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor"/> object instance
  15230. associated with the previously opened virtual table cursor to be
  15231. used.
  15232. </param>
  15233. <returns>
  15234. A standard SQLite return code.
  15235. </returns>
  15236. </member>
  15237. <member name="M:System.Data.SQLite.ISQLiteManagedModule.Eof(System.Data.SQLite.SQLiteVirtualTableCursor)">
  15238. <summary>
  15239. This method is called in response to the
  15240. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xEof(System.IntPtr)"/> method.
  15241. </summary>
  15242. <param name="cursor">
  15243. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor"/> object instance
  15244. associated with the previously opened virtual table cursor to be
  15245. used.
  15246. </param>
  15247. <returns>
  15248. Non-zero if no more rows are available; zero otherwise.
  15249. </returns>
  15250. </member>
  15251. <member name="M:System.Data.SQLite.ISQLiteManagedModule.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)">
  15252. <summary>
  15253. This method is called in response to the
  15254. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xColumn(System.IntPtr,System.IntPtr,System.Int32)"/> method.
  15255. </summary>
  15256. <param name="cursor">
  15257. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor"/> object instance
  15258. associated with the previously opened virtual table cursor to be
  15259. used.
  15260. </param>
  15261. <param name="context">
  15262. The <see cref="T:System.Data.SQLite.SQLiteContext"/> object instance to be used for
  15263. returning the specified column value to the SQLite core library.
  15264. </param>
  15265. <param name="index">
  15266. The zero-based index corresponding to the column containing the
  15267. value to be returned.
  15268. </param>
  15269. <returns>
  15270. A standard SQLite return code.
  15271. </returns>
  15272. </member>
  15273. <member name="M:System.Data.SQLite.ISQLiteManagedModule.RowId(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int64@)">
  15274. <summary>
  15275. This method is called in response to the
  15276. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRowId(System.IntPtr,System.Int64@)"/> method.
  15277. </summary>
  15278. <param name="cursor">
  15279. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor"/> object instance
  15280. associated with the previously opened virtual table cursor to be
  15281. used.
  15282. </param>
  15283. <param name="rowId">
  15284. Upon success, this parameter must be modified to contain the unique
  15285. integer row identifier for the current row for the specified cursor.
  15286. </param>
  15287. <returns>
  15288. A standard SQLite return code.
  15289. </returns>
  15290. </member>
  15291. <member name="M:System.Data.SQLite.ISQLiteManagedModule.Update(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteValue[],System.Int64@)">
  15292. <summary>
  15293. This method is called in response to the
  15294. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xUpdate(System.IntPtr,System.Int32,System.IntPtr,System.Int64@)"/> method.
  15295. </summary>
  15296. <param name="table">
  15297. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance associated
  15298. with this virtual table.
  15299. </param>
  15300. <param name="values">
  15301. The array of <see cref="T:System.Data.SQLite.SQLiteValue"/> object instances containing
  15302. the new or modified column values, if any.
  15303. </param>
  15304. <param name="rowId">
  15305. Upon success, this parameter must be modified to contain the unique
  15306. integer row identifier for the row that was inserted, if any.
  15307. </param>
  15308. <returns>
  15309. A standard SQLite return code.
  15310. </returns>
  15311. </member>
  15312. <member name="M:System.Data.SQLite.ISQLiteManagedModule.Begin(System.Data.SQLite.SQLiteVirtualTable)">
  15313. <summary>
  15314. This method is called in response to the
  15315. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xBegin(System.IntPtr)"/> method.
  15316. </summary>
  15317. <param name="table">
  15318. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance associated
  15319. with this virtual table.
  15320. </param>
  15321. <returns>
  15322. A standard SQLite return code.
  15323. </returns>
  15324. </member>
  15325. <member name="M:System.Data.SQLite.ISQLiteManagedModule.Sync(System.Data.SQLite.SQLiteVirtualTable)">
  15326. <summary>
  15327. This method is called in response to the
  15328. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xSync(System.IntPtr)"/> method.
  15329. </summary>
  15330. <param name="table">
  15331. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance associated
  15332. with this virtual table.
  15333. </param>
  15334. <returns>
  15335. A standard SQLite return code.
  15336. </returns>
  15337. </member>
  15338. <member name="M:System.Data.SQLite.ISQLiteManagedModule.Commit(System.Data.SQLite.SQLiteVirtualTable)">
  15339. <summary>
  15340. This method is called in response to the
  15341. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCommit(System.IntPtr)"/> method.
  15342. </summary>
  15343. <param name="table">
  15344. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance associated
  15345. with this virtual table.
  15346. </param>
  15347. <returns>
  15348. A standard SQLite return code.
  15349. </returns>
  15350. </member>
  15351. <member name="M:System.Data.SQLite.ISQLiteManagedModule.Rollback(System.Data.SQLite.SQLiteVirtualTable)">
  15352. <summary>
  15353. This method is called in response to the
  15354. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRollback(System.IntPtr)"/> method.
  15355. </summary>
  15356. <param name="table">
  15357. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance associated
  15358. with this virtual table.
  15359. </param>
  15360. <returns>
  15361. A standard SQLite return code.
  15362. </returns>
  15363. </member>
  15364. <member name="M:System.Data.SQLite.ISQLiteManagedModule.FindFunction(System.Data.SQLite.SQLiteVirtualTable,System.Int32,System.String,System.Data.SQLite.SQLiteFunction@,System.IntPtr@)">
  15365. <summary>
  15366. This method is called in response to the
  15367. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,System.IntPtr@)"/> method.
  15368. </summary>
  15369. <param name="table">
  15370. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance associated
  15371. with this virtual table.
  15372. </param>
  15373. <param name="argumentCount">
  15374. The number of arguments to the function being sought.
  15375. </param>
  15376. <param name="name">
  15377. The name of the function being sought.
  15378. </param>
  15379. <param name="function">
  15380. Upon success, this parameter must be modified to contain the
  15381. <see cref="T:System.Data.SQLite.SQLiteFunction"/> object instance responsible for
  15382. implementing the specified function.
  15383. </param>
  15384. <param name="pClientData">
  15385. Upon success, this parameter must be modified to contain the
  15386. native user-data pointer associated with
  15387. <paramref name="function"/>.
  15388. </param>
  15389. <returns>
  15390. Non-zero if the specified function was found; zero otherwise.
  15391. </returns>
  15392. </member>
  15393. <member name="M:System.Data.SQLite.ISQLiteManagedModule.Rename(System.Data.SQLite.SQLiteVirtualTable,System.String)">
  15394. <summary>
  15395. This method is called in response to the
  15396. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRename(System.IntPtr,System.IntPtr)"/> method.
  15397. </summary>
  15398. <param name="table">
  15399. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance associated
  15400. with this virtual table.
  15401. </param>
  15402. <param name="newName">
  15403. The new name for the virtual table.
  15404. </param>
  15405. <returns>
  15406. A standard SQLite return code.
  15407. </returns>
  15408. </member>
  15409. <member name="M:System.Data.SQLite.ISQLiteManagedModule.Savepoint(System.Data.SQLite.SQLiteVirtualTable,System.Int32)">
  15410. <summary>
  15411. This method is called in response to the
  15412. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xSavepoint(System.IntPtr,System.Int32)"/> method.
  15413. </summary>
  15414. <param name="table">
  15415. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance associated
  15416. with this virtual table.
  15417. </param>
  15418. <param name="savepoint">
  15419. This is an integer identifier under which the the current state of
  15420. the virtual table should be saved.
  15421. </param>
  15422. <returns>
  15423. A standard SQLite return code.
  15424. </returns>
  15425. </member>
  15426. <member name="M:System.Data.SQLite.ISQLiteManagedModule.Release(System.Data.SQLite.SQLiteVirtualTable,System.Int32)">
  15427. <summary>
  15428. This method is called in response to the
  15429. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRelease(System.IntPtr,System.Int32)"/> method.
  15430. </summary>
  15431. <param name="table">
  15432. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance associated
  15433. with this virtual table.
  15434. </param>
  15435. <param name="savepoint">
  15436. This is an integer used to indicate that any saved states with an
  15437. identifier greater than or equal to this should be deleted by the
  15438. virtual table.
  15439. </param>
  15440. <returns>
  15441. A standard SQLite return code.
  15442. </returns>
  15443. </member>
  15444. <member name="M:System.Data.SQLite.ISQLiteManagedModule.RollbackTo(System.Data.SQLite.SQLiteVirtualTable,System.Int32)">
  15445. <summary>
  15446. This method is called in response to the
  15447. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRollbackTo(System.IntPtr,System.Int32)"/> method.
  15448. </summary>
  15449. <param name="table">
  15450. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance associated
  15451. with this virtual table.
  15452. </param>
  15453. <param name="savepoint">
  15454. This is an integer identifier used to specify a specific saved
  15455. state for the virtual table for it to restore itself back to, which
  15456. should also have the effect of deleting all saved states with an
  15457. integer identifier greater than this one.
  15458. </param>
  15459. <returns>
  15460. A standard SQLite return code.
  15461. </returns>
  15462. </member>
  15463. <member name="P:System.Data.SQLite.ISQLiteManagedModule.Declared">
  15464. <summary>
  15465. Returns non-zero if the schema for the virtual table has been
  15466. declared.
  15467. </summary>
  15468. </member>
  15469. <member name="P:System.Data.SQLite.ISQLiteManagedModule.Name">
  15470. <summary>
  15471. Returns the name of the module as it was registered with the SQLite
  15472. core library.
  15473. </summary>
  15474. </member>
  15475. <member name="T:System.Data.SQLite.SQLiteMemory">
  15476. <summary>
  15477. This class contains static methods that are used to allocate,
  15478. manipulate, and free native memory provided by the SQLite core library.
  15479. </summary>
  15480. </member>
  15481. <member name="M:System.Data.SQLite.SQLiteMemory.CanUseSize64">
  15482. <summary>
  15483. Determines if the native sqlite3_msize() API can be used, based on
  15484. the available version of the SQLite core library.
  15485. </summary>
  15486. <returns>
  15487. Non-zero if the native sqlite3_msize() API is supported by the
  15488. SQLite core library.
  15489. </returns>
  15490. </member>
  15491. <member name="M:System.Data.SQLite.SQLiteMemory.Allocate(System.Int32)">
  15492. <summary>
  15493. Allocates at least the specified number of bytes of native memory
  15494. via the SQLite core library sqlite3_malloc() function and returns
  15495. the resulting native pointer. If the TRACK_MEMORY_BYTES option
  15496. was enabled at compile-time, adjusts the number of bytes currently
  15497. allocated by this class.
  15498. </summary>
  15499. <param name="size">
  15500. The number of bytes to allocate.
  15501. </param>
  15502. <returns>
  15503. The native pointer that points to a block of memory of at least the
  15504. specified size -OR- <see cref="F:System.IntPtr.Zero"/> if the memory could
  15505. not be allocated.
  15506. </returns>
  15507. </member>
  15508. <member name="M:System.Data.SQLite.SQLiteMemory.Allocate64(System.UInt64)">
  15509. <summary>
  15510. Allocates at least the specified number of bytes of native memory
  15511. via the SQLite core library sqlite3_malloc64() function and returns
  15512. the resulting native pointer. If the TRACK_MEMORY_BYTES option
  15513. was enabled at compile-time, adjusts the number of bytes currently
  15514. allocated by this class.
  15515. </summary>
  15516. <param name="size">
  15517. The number of bytes to allocate.
  15518. </param>
  15519. <returns>
  15520. The native pointer that points to a block of memory of at least the
  15521. specified size -OR- <see cref="F:System.IntPtr.Zero"/> if the memory could
  15522. not be allocated.
  15523. </returns>
  15524. </member>
  15525. <member name="M:System.Data.SQLite.SQLiteMemory.AllocateUntracked(System.Int32)">
  15526. <summary>
  15527. Allocates at least the specified number of bytes of native memory
  15528. via the SQLite core library sqlite3_malloc() function and returns
  15529. the resulting native pointer without adjusting the number of
  15530. allocated bytes currently tracked by this class. This is useful
  15531. when dealing with blocks of memory that will be freed directly by
  15532. the SQLite core library.
  15533. </summary>
  15534. <param name="size">
  15535. The number of bytes to allocate.
  15536. </param>
  15537. <returns>
  15538. The native pointer that points to a block of memory of at least the
  15539. specified size -OR- <see cref="F:System.IntPtr.Zero"/> if the memory could
  15540. not be allocated.
  15541. </returns>
  15542. </member>
  15543. <member name="M:System.Data.SQLite.SQLiteMemory.Allocate64Untracked(System.UInt64)">
  15544. <summary>
  15545. Allocates at least the specified number of bytes of native memory
  15546. via the SQLite core library sqlite3_malloc64() function and returns
  15547. the resulting native pointer without adjusting the number of
  15548. allocated bytes currently tracked by this class. This is useful
  15549. when dealing with blocks of memory that will be freed directly by
  15550. the SQLite core library.
  15551. </summary>
  15552. <param name="size">
  15553. The number of bytes to allocate.
  15554. </param>
  15555. <returns>
  15556. The native pointer that points to a block of memory of at least the
  15557. specified size -OR- <see cref="F:System.IntPtr.Zero"/> if the memory could
  15558. not be allocated.
  15559. </returns>
  15560. </member>
  15561. <member name="M:System.Data.SQLite.SQLiteMemory.Size(System.IntPtr)">
  15562. <summary>
  15563. Gets and returns the actual size of the specified memory block
  15564. that was previously obtained from the <see cref="M:System.Data.SQLite.SQLiteMemory.Allocate(System.Int32)"/>,
  15565. <see cref="M:System.Data.SQLite.SQLiteMemory.Allocate64(System.UInt64)"/>, <see cref="M:System.Data.SQLite.SQLiteMemory.AllocateUntracked(System.Int32)"/>, or
  15566. <see cref="M:System.Data.SQLite.SQLiteMemory.Allocate64Untracked(System.UInt64)"/> methods or directly from the
  15567. SQLite core library.
  15568. </summary>
  15569. <param name="pMemory">
  15570. The native pointer to the memory block previously obtained from
  15571. the <see cref="M:System.Data.SQLite.SQLiteMemory.Allocate(System.Int32)"/>, <see cref="M:System.Data.SQLite.SQLiteMemory.Allocate64(System.UInt64)"/>,
  15572. <see cref="M:System.Data.SQLite.SQLiteMemory.AllocateUntracked(System.Int32)"/>, or
  15573. <see cref="M:System.Data.SQLite.SQLiteMemory.Allocate64Untracked(System.UInt64)"/> methods or directly from the
  15574. SQLite core library.
  15575. </param>
  15576. <returns>
  15577. The actual size, in bytes, of the memory block specified via the
  15578. native pointer.
  15579. </returns>
  15580. </member>
  15581. <member name="M:System.Data.SQLite.SQLiteMemory.Size64(System.IntPtr)">
  15582. <summary>
  15583. Gets and returns the actual size of the specified memory block
  15584. that was previously obtained from the <see cref="M:System.Data.SQLite.SQLiteMemory.Allocate(System.Int32)"/>,
  15585. <see cref="M:System.Data.SQLite.SQLiteMemory.Allocate64(System.UInt64)"/>, <see cref="M:System.Data.SQLite.SQLiteMemory.AllocateUntracked(System.Int32)"/>, or
  15586. <see cref="M:System.Data.SQLite.SQLiteMemory.Allocate64Untracked(System.UInt64)"/> methods or directly from the
  15587. SQLite core library.
  15588. </summary>
  15589. <param name="pMemory">
  15590. The native pointer to the memory block previously obtained from
  15591. the <see cref="M:System.Data.SQLite.SQLiteMemory.Allocate(System.Int32)"/>, <see cref="M:System.Data.SQLite.SQLiteMemory.Allocate64(System.UInt64)"/>,
  15592. <see cref="M:System.Data.SQLite.SQLiteMemory.AllocateUntracked(System.Int32)"/>, or
  15593. <see cref="M:System.Data.SQLite.SQLiteMemory.Allocate64Untracked(System.UInt64)"/> methods or directly from the
  15594. SQLite core library.
  15595. </param>
  15596. <returns>
  15597. The actual size, in bytes, of the memory block specified via the
  15598. native pointer.
  15599. </returns>
  15600. </member>
  15601. <member name="M:System.Data.SQLite.SQLiteMemory.Free(System.IntPtr)">
  15602. <summary>
  15603. Frees a memory block previously obtained from the
  15604. <see cref="M:System.Data.SQLite.SQLiteMemory.Allocate(System.Int32)"/> or <see cref="M:System.Data.SQLite.SQLiteMemory.Allocate64(System.UInt64)"/> methods. If
  15605. the TRACK_MEMORY_BYTES option was enabled at compile-time, adjusts
  15606. the number of bytes currently allocated by this class.
  15607. </summary>
  15608. <param name="pMemory">
  15609. The native pointer to the memory block previously obtained from the
  15610. <see cref="M:System.Data.SQLite.SQLiteMemory.Allocate(System.Int32)"/> or <see cref="M:System.Data.SQLite.SQLiteMemory.Allocate64(System.UInt64)"/> methods.
  15611. </param>
  15612. </member>
  15613. <member name="M:System.Data.SQLite.SQLiteMemory.FreeUntracked(System.IntPtr)">
  15614. <summary>
  15615. Frees a memory block previously obtained from the SQLite core
  15616. library without adjusting the number of allocated bytes currently
  15617. tracked by this class. This is useful when dealing with blocks of
  15618. memory that were not allocated using this class.
  15619. </summary>
  15620. <param name="pMemory">
  15621. The native pointer to the memory block previously obtained from the
  15622. SQLite core library.
  15623. </param>
  15624. </member>
  15625. <member name="T:System.Data.SQLite.SQLiteString">
  15626. <summary>
  15627. This class contains static methods that are used to deal with native
  15628. UTF-8 string pointers to be used with the SQLite core library.
  15629. </summary>
  15630. </member>
  15631. <member name="F:System.Data.SQLite.SQLiteString.ThirtyBits">
  15632. <summary>
  15633. This is the maximum possible length for the native UTF-8 encoded
  15634. strings used with the SQLite core library.
  15635. </summary>
  15636. </member>
  15637. <member name="F:System.Data.SQLite.SQLiteString.Utf8Encoding">
  15638. <summary>
  15639. This is the <see cref="T:System.Text.Encoding"/> object instance used to handle
  15640. conversions from/to UTF-8.
  15641. </summary>
  15642. </member>
  15643. <member name="M:System.Data.SQLite.SQLiteString.GetUtf8BytesFromString(System.String)">
  15644. <summary>
  15645. Converts the specified managed string into the UTF-8 encoding and
  15646. returns the array of bytes containing its representation in that
  15647. encoding.
  15648. </summary>
  15649. <param name="value">
  15650. The managed string to convert.
  15651. </param>
  15652. <returns>
  15653. The array of bytes containing the representation of the managed
  15654. string in the UTF-8 encoding or null upon failure.
  15655. </returns>
  15656. </member>
  15657. <member name="M:System.Data.SQLite.SQLiteString.GetStringFromUtf8Bytes(System.Byte[])">
  15658. <summary>
  15659. Converts the specified array of bytes representing a string in the
  15660. UTF-8 encoding and returns a managed string.
  15661. </summary>
  15662. <param name="bytes">
  15663. The array of bytes to convert.
  15664. </param>
  15665. <returns>
  15666. The managed string or null upon failure.
  15667. </returns>
  15668. </member>
  15669. <member name="M:System.Data.SQLite.SQLiteString.ProbeForUtf8ByteLength(System.IntPtr,System.Int32)">
  15670. <summary>
  15671. Probes a native pointer to a string in the UTF-8 encoding for its
  15672. terminating NUL character, within the specified length limit.
  15673. </summary>
  15674. <param name="pValue">
  15675. The native NUL-terminated string pointer.
  15676. </param>
  15677. <param name="limit">
  15678. The maximum length of the native string, in bytes.
  15679. </param>
  15680. <returns>
  15681. The length of the native string, in bytes -OR- zero if the length
  15682. could not be determined.
  15683. </returns>
  15684. </member>
  15685. <member name="M:System.Data.SQLite.SQLiteString.StringFromUtf8IntPtr(System.IntPtr)">
  15686. <summary>
  15687. Converts the specified native NUL-terminated UTF-8 string pointer
  15688. into a managed string.
  15689. </summary>
  15690. <param name="pValue">
  15691. The native NUL-terminated UTF-8 string pointer.
  15692. </param>
  15693. <returns>
  15694. The managed string or null upon failure.
  15695. </returns>
  15696. </member>
  15697. <member name="M:System.Data.SQLite.SQLiteString.StringFromUtf8IntPtr(System.IntPtr,System.Int32)">
  15698. <summary>
  15699. Converts the specified native UTF-8 string pointer of the specified
  15700. length into a managed string.
  15701. </summary>
  15702. <param name="pValue">
  15703. The native UTF-8 string pointer.
  15704. </param>
  15705. <param name="length">
  15706. The length of the native string, in bytes.
  15707. </param>
  15708. <returns>
  15709. The managed string or null upon failure.
  15710. </returns>
  15711. </member>
  15712. <member name="M:System.Data.SQLite.SQLiteString.Utf8IntPtrFromString(System.String)">
  15713. <summary>
  15714. Converts the specified managed string into a native NUL-terminated
  15715. UTF-8 string pointer using memory obtained from the SQLite core
  15716. library.
  15717. </summary>
  15718. <param name="value">
  15719. The managed string to convert.
  15720. </param>
  15721. <returns>
  15722. The native NUL-terminated UTF-8 string pointer or
  15723. <see cref="F:System.IntPtr.Zero"/> upon failure.
  15724. </returns>
  15725. </member>
  15726. <member name="M:System.Data.SQLite.SQLiteString.Utf8IntPtrFromString(System.String,System.Boolean)">
  15727. <summary>
  15728. Converts the specified managed string into a native NUL-terminated
  15729. UTF-8 string pointer using memory obtained from the SQLite core
  15730. library.
  15731. </summary>
  15732. <param name="value">
  15733. The managed string to convert.
  15734. </param>
  15735. <param name="tracked">
  15736. Non-zero to obtain memory from the SQLite core library without
  15737. adjusting the number of allocated bytes currently being tracked
  15738. by the <see cref="T:System.Data.SQLite.SQLiteMemory"/> class.
  15739. </param>
  15740. <returns>
  15741. The native NUL-terminated UTF-8 string pointer or
  15742. <see cref="F:System.IntPtr.Zero"/> upon failure.
  15743. </returns>
  15744. </member>
  15745. <member name="M:System.Data.SQLite.SQLiteString.Utf8IntPtrFromString(System.String,System.Int32@)">
  15746. <summary>
  15747. Converts the specified managed string into a native NUL-terminated
  15748. UTF-8 string pointer using memory obtained from the SQLite core
  15749. library.
  15750. </summary>
  15751. <param name="value">
  15752. The managed string to convert.
  15753. </param>
  15754. <param name="length">
  15755. The length of the native string, in bytes.
  15756. </param>
  15757. <returns>
  15758. The native NUL-terminated UTF-8 string pointer or
  15759. <see cref="F:System.IntPtr.Zero"/> upon failure.
  15760. </returns>
  15761. </member>
  15762. <member name="M:System.Data.SQLite.SQLiteString.Utf8IntPtrFromString(System.String,System.Boolean,System.Int32@)">
  15763. <summary>
  15764. Converts the specified managed string into a native NUL-terminated
  15765. UTF-8 string pointer using memory obtained from the SQLite core
  15766. library.
  15767. </summary>
  15768. <param name="value">
  15769. The managed string to convert.
  15770. </param>
  15771. <param name="tracked">
  15772. Non-zero to obtain memory from the SQLite core library without
  15773. adjusting the number of allocated bytes currently being tracked
  15774. by the <see cref="T:System.Data.SQLite.SQLiteMemory"/> class.
  15775. </param>
  15776. <param name="length">
  15777. The length of the native string, in bytes.
  15778. </param>
  15779. <returns>
  15780. The native NUL-terminated UTF-8 string pointer or
  15781. <see cref="F:System.IntPtr.Zero"/> upon failure.
  15782. </returns>
  15783. </member>
  15784. <member name="M:System.Data.SQLite.SQLiteString.StringArrayFromUtf8SizeAndIntPtr(System.Int32,System.IntPtr)">
  15785. <summary>
  15786. Converts a logical array of native NUL-terminated UTF-8 string
  15787. pointers into an array of managed strings.
  15788. </summary>
  15789. <param name="argc">
  15790. The number of elements in the logical array of native
  15791. NUL-terminated UTF-8 string pointers.
  15792. </param>
  15793. <param name="argv">
  15794. The native pointer to the logical array of native NUL-terminated
  15795. UTF-8 string pointers to convert.
  15796. </param>
  15797. <returns>
  15798. The array of managed strings or null upon failure.
  15799. </returns>
  15800. </member>
  15801. <member name="M:System.Data.SQLite.SQLiteString.Utf8IntPtrArrayFromStringArray(System.String[],System.Boolean)">
  15802. <summary>
  15803. Converts an array of managed strings into an array of native
  15804. NUL-terminated UTF-8 string pointers.
  15805. </summary>
  15806. <param name="values">
  15807. The array of managed strings to convert.
  15808. </param>
  15809. <param name="tracked">
  15810. Non-zero to obtain memory from the SQLite core library without
  15811. adjusting the number of allocated bytes currently being tracked
  15812. by the <see cref="T:System.Data.SQLite.SQLiteMemory"/> class.
  15813. </param>
  15814. <returns>
  15815. The array of native NUL-terminated UTF-8 string pointers or null
  15816. upon failure.
  15817. </returns>
  15818. </member>
  15819. <member name="T:System.Data.SQLite.SQLiteBytes">
  15820. <summary>
  15821. This class contains static methods that are used to deal with native
  15822. pointers to memory blocks that logically contain arrays of bytes to be
  15823. used with the SQLite core library.
  15824. </summary>
  15825. </member>
  15826. <member name="M:System.Data.SQLite.SQLiteBytes.FromIntPtr(System.IntPtr,System.Int32)">
  15827. <summary>
  15828. Converts a native pointer to a logical array of bytes of the
  15829. specified length into a managed byte array.
  15830. </summary>
  15831. <param name="pValue">
  15832. The native pointer to the logical array of bytes to convert.
  15833. </param>
  15834. <param name="length">
  15835. The length, in bytes, of the logical array of bytes to convert.
  15836. </param>
  15837. <returns>
  15838. The managed byte array or null upon failure.
  15839. </returns>
  15840. </member>
  15841. <member name="M:System.Data.SQLite.SQLiteBytes.ToIntPtr(System.Byte[])">
  15842. <summary>
  15843. Converts a managed byte array into a native pointer to a logical
  15844. array of bytes.
  15845. </summary>
  15846. <param name="value">
  15847. The managed byte array to convert.
  15848. </param>
  15849. <returns>
  15850. The native pointer to a logical byte array or null upon failure.
  15851. </returns>
  15852. </member>
  15853. <member name="M:System.Data.SQLite.SQLiteBytes.ToIntPtr(System.Byte[],System.Int32@)">
  15854. <summary>
  15855. Converts a managed byte array into a native pointer to a logical
  15856. array of bytes.
  15857. </summary>
  15858. <param name="value">
  15859. The managed byte array to convert.
  15860. </param>
  15861. <param name="length">
  15862. The length, in bytes, of the converted logical array of bytes.
  15863. </param>
  15864. <returns>
  15865. The native pointer to a logical byte array or null upon failure.
  15866. </returns>
  15867. </member>
  15868. <member name="T:System.Data.SQLite.SQLiteMarshal">
  15869. <summary>
  15870. This class contains static methods that are used to perform several
  15871. low-level data marshalling tasks between native and managed code.
  15872. </summary>
  15873. </member>
  15874. <member name="M:System.Data.SQLite.SQLiteMarshal.IntPtrForOffset(System.IntPtr,System.Int32)">
  15875. <summary>
  15876. Returns a new <see cref="T:System.IntPtr"/> object instance based on the
  15877. specified <see cref="T:System.IntPtr"/> object instance and an integer
  15878. offset.
  15879. </summary>
  15880. <param name="pointer">
  15881. The <see cref="T:System.IntPtr"/> object instance representing the base
  15882. memory location.
  15883. </param>
  15884. <param name="offset">
  15885. The integer offset from the base memory location that the new
  15886. <see cref="T:System.IntPtr"/> object instance should point to.
  15887. </param>
  15888. <returns>
  15889. The new <see cref="T:System.IntPtr"/> object instance.
  15890. </returns>
  15891. </member>
  15892. <member name="M:System.Data.SQLite.SQLiteMarshal.RoundUp(System.Int32,System.Int32)">
  15893. <summary>
  15894. Rounds up an integer size to the next multiple of the alignment.
  15895. </summary>
  15896. <param name="size">
  15897. The size, in bytes, to be rounded up.
  15898. </param>
  15899. <param name="alignment">
  15900. The required alignment for the return value.
  15901. </param>
  15902. <returns>
  15903. The size, in bytes, rounded up to the next multiple of the
  15904. alignment. This value may end up being the same as the original
  15905. size.
  15906. </returns>
  15907. </member>
  15908. <member name="M:System.Data.SQLite.SQLiteMarshal.NextOffsetOf(System.Int32,System.Int32,System.Int32)">
  15909. <summary>
  15910. Determines the offset, in bytes, of the next structure member.
  15911. </summary>
  15912. <param name="offset">
  15913. The offset, in bytes, of the current structure member.
  15914. </param>
  15915. <param name="size">
  15916. The size, in bytes, of the current structure member.
  15917. </param>
  15918. <param name="alignment">
  15919. The alignment, in bytes, of the next structure member.
  15920. </param>
  15921. <returns>
  15922. The offset, in bytes, of the next structure member.
  15923. </returns>
  15924. </member>
  15925. <member name="M:System.Data.SQLite.SQLiteMarshal.ReadInt32(System.IntPtr,System.Int32)">
  15926. <summary>
  15927. Reads a <see cref="T:System.Int32"/> value from the specified memory
  15928. location.
  15929. </summary>
  15930. <param name="pointer">
  15931. The <see cref="T:System.IntPtr"/> object instance representing the base
  15932. memory location.
  15933. </param>
  15934. <param name="offset">
  15935. The integer offset from the base memory location where the
  15936. <see cref="T:System.Int32"/> value to be read is located.
  15937. </param>
  15938. <returns>
  15939. The <see cref="T:System.Int32"/> value at the specified memory location.
  15940. </returns>
  15941. </member>
  15942. <member name="M:System.Data.SQLite.SQLiteMarshal.ReadInt64(System.IntPtr,System.Int32)">
  15943. <summary>
  15944. Reads a <see cref="T:System.Int64"/> value from the specified memory
  15945. location.
  15946. </summary>
  15947. <param name="pointer">
  15948. The <see cref="T:System.IntPtr"/> object instance representing the base
  15949. memory location.
  15950. </param>
  15951. <param name="offset">
  15952. The integer offset from the base memory location where the
  15953. <see cref="T:System.Int64"/> value to be read is located.
  15954. </param>
  15955. <returns>
  15956. The <see cref="T:System.Int64"/> value at the specified memory location.
  15957. </returns>
  15958. </member>
  15959. <member name="M:System.Data.SQLite.SQLiteMarshal.ReadDouble(System.IntPtr,System.Int32)">
  15960. <summary>
  15961. Reads a <see cref="T:System.Double"/> value from the specified memory
  15962. location.
  15963. </summary>
  15964. <param name="pointer">
  15965. The <see cref="T:System.IntPtr"/> object instance representing the base
  15966. memory location.
  15967. </param>
  15968. <param name="offset">
  15969. The integer offset from the base memory location where the
  15970. <see cref="T:System.Double"/> to be read is located.
  15971. </param>
  15972. <returns>
  15973. The <see cref="T:System.Double"/> value at the specified memory location.
  15974. </returns>
  15975. </member>
  15976. <member name="M:System.Data.SQLite.SQLiteMarshal.ReadIntPtr(System.IntPtr,System.Int32)">
  15977. <summary>
  15978. Reads an <see cref="T:System.IntPtr"/> value from the specified memory
  15979. location.
  15980. </summary>
  15981. <param name="pointer">
  15982. The <see cref="T:System.IntPtr"/> object instance representing the base
  15983. memory location.
  15984. </param>
  15985. <param name="offset">
  15986. The integer offset from the base memory location where the
  15987. <see cref="T:System.IntPtr"/> value to be read is located.
  15988. </param>
  15989. <returns>
  15990. The <see cref="T:System.IntPtr"/> value at the specified memory location.
  15991. </returns>
  15992. </member>
  15993. <member name="M:System.Data.SQLite.SQLiteMarshal.WriteInt32(System.IntPtr,System.Int32,System.Int32)">
  15994. <summary>
  15995. Writes an <see cref="T:System.Int32"/> value to the specified memory
  15996. location.
  15997. </summary>
  15998. <param name="pointer">
  15999. The <see cref="T:System.IntPtr"/> object instance representing the base
  16000. memory location.
  16001. </param>
  16002. <param name="offset">
  16003. The integer offset from the base memory location where the
  16004. <see cref="T:System.Int32"/> value to be written is located.
  16005. </param>
  16006. <param name="value">
  16007. The <see cref="T:System.Int32"/> value to write.
  16008. </param>
  16009. </member>
  16010. <member name="M:System.Data.SQLite.SQLiteMarshal.WriteInt64(System.IntPtr,System.Int32,System.Int64)">
  16011. <summary>
  16012. Writes an <see cref="T:System.Int64"/> value to the specified memory
  16013. location.
  16014. </summary>
  16015. <param name="pointer">
  16016. The <see cref="T:System.IntPtr"/> object instance representing the base
  16017. memory location.
  16018. </param>
  16019. <param name="offset">
  16020. The integer offset from the base memory location where the
  16021. <see cref="T:System.Int64"/> value to be written is located.
  16022. </param>
  16023. <param name="value">
  16024. The <see cref="T:System.Int64"/> value to write.
  16025. </param>
  16026. </member>
  16027. <member name="M:System.Data.SQLite.SQLiteMarshal.WriteDouble(System.IntPtr,System.Int32,System.Double)">
  16028. <summary>
  16029. Writes a <see cref="T:System.Double"/> value to the specified memory
  16030. location.
  16031. </summary>
  16032. <param name="pointer">
  16033. The <see cref="T:System.IntPtr"/> object instance representing the base
  16034. memory location.
  16035. </param>
  16036. <param name="offset">
  16037. The integer offset from the base memory location where the
  16038. <see cref="T:System.Double"/> value to be written is located.
  16039. </param>
  16040. <param name="value">
  16041. The <see cref="T:System.Double"/> value to write.
  16042. </param>
  16043. </member>
  16044. <member name="M:System.Data.SQLite.SQLiteMarshal.WriteIntPtr(System.IntPtr,System.Int32,System.IntPtr)">
  16045. <summary>
  16046. Writes a <see cref="T:System.IntPtr"/> value to the specified memory
  16047. location.
  16048. </summary>
  16049. <param name="pointer">
  16050. The <see cref="T:System.IntPtr"/> object instance representing the base
  16051. memory location.
  16052. </param>
  16053. <param name="offset">
  16054. The integer offset from the base memory location where the
  16055. <see cref="T:System.IntPtr"/> value to be written is located.
  16056. </param>
  16057. <param name="value">
  16058. The <see cref="T:System.IntPtr"/> value to write.
  16059. </param>
  16060. </member>
  16061. <member name="M:System.Data.SQLite.SQLiteMarshal.GetHashCode(System.Object,System.Boolean)">
  16062. <summary>
  16063. Generates a hash code value for the object.
  16064. </summary>
  16065. <param name="value">
  16066. The object instance used to calculate the hash code.
  16067. </param>
  16068. <param name="identity">
  16069. Non-zero if different object instances with the same value should
  16070. generate different hash codes, where applicable. This parameter
  16071. has no effect on the .NET Compact Framework.
  16072. </param>
  16073. <returns>
  16074. The hash code value -OR- zero if the object is null.
  16075. </returns>
  16076. </member>
  16077. <member name="T:System.Data.SQLite.SQLiteModule">
  16078. <summary>
  16079. This class represents a managed virtual table module implementation.
  16080. It is not sealed and must be used as the base class for any
  16081. user-defined virtual table module classes implemented in managed code.
  16082. </summary>
  16083. </member>
  16084. <member name="F:System.Data.SQLite.SQLiteModule.DefaultModuleVersion">
  16085. <summary>
  16086. The default version of the native sqlite3_module structure in use.
  16087. </summary>
  16088. </member>
  16089. <member name="F:System.Data.SQLite.SQLiteModule.nativeModule">
  16090. <summary>
  16091. This field is used to store the native sqlite3_module structure
  16092. associated with this object instance.
  16093. </summary>
  16094. </member>
  16095. <member name="F:System.Data.SQLite.SQLiteModule.destroyModule">
  16096. <summary>
  16097. This field is used to store the destructor delegate to be passed to
  16098. the SQLite core library via the sqlite3_create_disposable_module()
  16099. function.
  16100. </summary>
  16101. </member>
  16102. <member name="F:System.Data.SQLite.SQLiteModule.disposableModule">
  16103. <summary>
  16104. This field is used to store a pointer to the native sqlite3_module
  16105. structure returned by the sqlite3_create_disposable_module
  16106. function.
  16107. </summary>
  16108. </member>
  16109. <member name="F:System.Data.SQLite.SQLiteModule.tables">
  16110. <summary>
  16111. This field is used to store the virtual table instances associated
  16112. with this module. The native pointer to the sqlite3_vtab derived
  16113. structure is used to key into this collection.
  16114. </summary>
  16115. </member>
  16116. <member name="F:System.Data.SQLite.SQLiteModule.cursors">
  16117. <summary>
  16118. This field is used to store the virtual table cursor instances
  16119. associated with this module. The native pointer to the
  16120. sqlite3_vtab_cursor derived structure is used to key into this
  16121. collection.
  16122. </summary>
  16123. </member>
  16124. <member name="F:System.Data.SQLite.SQLiteModule.functions">
  16125. <summary>
  16126. This field is used to store the virtual table function instances
  16127. associated with this module. The case-insensitive function name
  16128. and the number of arguments (with -1 meaning "any") are used to
  16129. construct the string that is used to key into this collection.
  16130. </summary>
  16131. </member>
  16132. <member name="M:System.Data.SQLite.SQLiteModule.#ctor(System.String)">
  16133. <summary>
  16134. Constructs an instance of this class.
  16135. </summary>
  16136. <param name="name">
  16137. The name of the module. This parameter cannot be null.
  16138. </param>
  16139. </member>
  16140. <member name="M:System.Data.SQLite.SQLiteModule.CreateDisposableModule(System.IntPtr)">
  16141. <summary>
  16142. Calls the native SQLite core library in order to create a new
  16143. disposable module containing the implementation of a virtual table.
  16144. </summary>
  16145. <param name="pDb">
  16146. The native database connection pointer to use.
  16147. </param>
  16148. <returns>
  16149. Non-zero upon success.
  16150. </returns>
  16151. </member>
  16152. <member name="M:System.Data.SQLite.SQLiteModule.xDestroyModule(System.IntPtr)">
  16153. <summary>
  16154. This method is called by the SQLite core library when the native
  16155. module associated with this object instance is being destroyed due
  16156. to its parent connection being closed. It may also be called by
  16157. the "vtshim" module if/when the sqlite3_dispose_module() function
  16158. is called.
  16159. </summary>
  16160. <param name="pClientData">
  16161. The native user-data pointer associated with this module, as it was
  16162. provided to the SQLite core library when the native module instance
  16163. was created.
  16164. </param>
  16165. </member>
  16166. <member name="M:System.Data.SQLite.SQLiteModule.AllocateNativeModule">
  16167. <summary>
  16168. Creates and returns the native sqlite_module structure using the
  16169. configured (or default) <see cref="T:System.Data.SQLite.ISQLiteNativeModule"/>
  16170. interface implementation.
  16171. </summary>
  16172. <returns>
  16173. The native sqlite_module structure using the configured (or
  16174. default) <see cref="T:System.Data.SQLite.ISQLiteNativeModule"/> interface
  16175. implementation.
  16176. </returns>
  16177. </member>
  16178. <member name="M:System.Data.SQLite.SQLiteModule.AllocateNativeModule(System.Data.SQLite.ISQLiteNativeModule)">
  16179. <summary>
  16180. Creates and returns the native sqlite_module structure using the
  16181. specified <see cref="T:System.Data.SQLite.ISQLiteNativeModule"/> interface
  16182. implementation.
  16183. </summary>
  16184. <param name="module">
  16185. The <see cref="T:System.Data.SQLite.ISQLiteNativeModule"/> interface implementation to
  16186. use.
  16187. </param>
  16188. <returns>
  16189. The native sqlite_module structure using the specified
  16190. <see cref="T:System.Data.SQLite.ISQLiteNativeModule"/> interface implementation.
  16191. </returns>
  16192. </member>
  16193. <member name="M:System.Data.SQLite.SQLiteModule.CopyNativeModule(System.Data.SQLite.UnsafeNativeMethods.sqlite3_module)">
  16194. <summary>
  16195. Creates a copy of the specified
  16196. <see cref="T:System.Data.SQLite.UnsafeNativeMethods.sqlite3_module"/> object instance,
  16197. using default implementations for the contained delegates when
  16198. necessary.
  16199. </summary>
  16200. <param name="module">
  16201. The <see cref="T:System.Data.SQLite.UnsafeNativeMethods.sqlite3_module"/> object
  16202. instance to copy.
  16203. </param>
  16204. <returns>
  16205. The new <see cref="T:System.Data.SQLite.UnsafeNativeMethods.sqlite3_module"/> object
  16206. instance.
  16207. </returns>
  16208. </member>
  16209. <member name="M:System.Data.SQLite.SQLiteModule.CreateOrConnect(System.Boolean,System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)">
  16210. <summary>
  16211. Calls one of the virtual table initialization methods.
  16212. </summary>
  16213. <param name="create">
  16214. Non-zero to call the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Create(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/>
  16215. method; otherwise, the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Connect(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/>
  16216. method will be called.
  16217. </param>
  16218. <param name="pDb">
  16219. The native database connection handle.
  16220. </param>
  16221. <param name="pAux">
  16222. The original native pointer value that was provided to the
  16223. sqlite3_create_module(), sqlite3_create_module_v2() or
  16224. sqlite3_create_disposable_module() functions.
  16225. </param>
  16226. <param name="argc">
  16227. The number of arguments from the CREATE VIRTUAL TABLE statement.
  16228. </param>
  16229. <param name="argv">
  16230. The array of string arguments from the CREATE VIRTUAL TABLE
  16231. statement.
  16232. </param>
  16233. <param name="pVtab">
  16234. Upon success, this parameter must be modified to point to the newly
  16235. created native sqlite3_vtab derived structure.
  16236. </param>
  16237. <param name="pError">
  16238. Upon failure, this parameter must be modified to point to the error
  16239. message, with the underlying memory having been obtained from the
  16240. sqlite3_malloc() function.
  16241. </param>
  16242. <returns>
  16243. A standard SQLite return code.
  16244. </returns>
  16245. </member>
  16246. <member name="M:System.Data.SQLite.SQLiteModule.DestroyOrDisconnect(System.Boolean,System.IntPtr)">
  16247. <summary>
  16248. Calls one of the virtual table finalization methods.
  16249. </summary>
  16250. <param name="destroy">
  16251. Non-zero to call the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Destroy(System.Data.SQLite.SQLiteVirtualTable)"/>
  16252. method; otherwise, the
  16253. <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Disconnect(System.Data.SQLite.SQLiteVirtualTable)"/> method will be
  16254. called.
  16255. </param>
  16256. <param name="pVtab">
  16257. The native pointer to the sqlite3_vtab derived structure.
  16258. </param>
  16259. <returns>
  16260. A standard SQLite return code.
  16261. </returns>
  16262. </member>
  16263. <member name="M:System.Data.SQLite.SQLiteModule.SetTableError(System.Data.SQLite.SQLiteModule,System.IntPtr,System.Boolean,System.Boolean,System.String)">
  16264. <summary>
  16265. Arranges for the specified error message to be placed into the
  16266. zErrMsg field of a sqlite3_vtab derived structure, freeing the
  16267. existing error message, if any.
  16268. </summary>
  16269. <param name="module">
  16270. The <see cref="T:System.Data.SQLite.SQLiteModule"/> object instance to be used.
  16271. </param>
  16272. <param name="pVtab">
  16273. The native pointer to the sqlite3_vtab derived structure.
  16274. </param>
  16275. <param name="logErrors">
  16276. Non-zero if this error message should also be logged using the
  16277. <see cref="T:System.Data.SQLite.SQLiteLog"/> class.
  16278. </param>
  16279. <param name="logExceptions">
  16280. Non-zero if caught exceptions should be logged using the
  16281. <see cref="T:System.Data.SQLite.SQLiteLog"/> class.
  16282. </param>
  16283. <param name="error">
  16284. The error message.
  16285. </param>
  16286. <returns>
  16287. Non-zero upon success.
  16288. </returns>
  16289. </member>
  16290. <member name="M:System.Data.SQLite.SQLiteModule.SetTableError(System.Data.SQLite.SQLiteModule,System.Data.SQLite.SQLiteVirtualTable,System.Boolean,System.Boolean,System.String)">
  16291. <summary>
  16292. Arranges for the specified error message to be placed into the
  16293. zErrMsg field of a sqlite3_vtab derived structure, freeing the
  16294. existing error message, if any.
  16295. </summary>
  16296. <param name="module">
  16297. The <see cref="T:System.Data.SQLite.SQLiteModule"/> object instance to be used.
  16298. </param>
  16299. <param name="table">
  16300. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance used to
  16301. lookup the native pointer to the sqlite3_vtab derived structure.
  16302. </param>
  16303. <param name="logErrors">
  16304. Non-zero if this error message should also be logged using the
  16305. <see cref="T:System.Data.SQLite.SQLiteLog"/> class.
  16306. </param>
  16307. <param name="logExceptions">
  16308. Non-zero if caught exceptions should be logged using the
  16309. <see cref="T:System.Data.SQLite.SQLiteLog"/> class.
  16310. </param>
  16311. <param name="error">
  16312. The error message.
  16313. </param>
  16314. <returns>
  16315. Non-zero upon success.
  16316. </returns>
  16317. </member>
  16318. <member name="M:System.Data.SQLite.SQLiteModule.SetCursorError(System.Data.SQLite.SQLiteModule,System.IntPtr,System.Boolean,System.Boolean,System.String)">
  16319. <summary>
  16320. Arranges for the specified error message to be placed into the
  16321. zErrMsg field of a sqlite3_vtab derived structure, freeing the
  16322. existing error message, if any.
  16323. </summary>
  16324. <param name="module">
  16325. The <see cref="T:System.Data.SQLite.SQLiteModule"/> object instance to be used.
  16326. </param>
  16327. <param name="pCursor">
  16328. The native pointer to the sqlite3_vtab_cursor derived structure
  16329. used to get the native pointer to the sqlite3_vtab derived
  16330. structure.
  16331. </param>
  16332. <param name="logErrors">
  16333. Non-zero if this error message should also be logged using the
  16334. <see cref="T:System.Data.SQLite.SQLiteLog"/> class.
  16335. </param>
  16336. <param name="logExceptions">
  16337. Non-zero if caught exceptions should be logged using the
  16338. <see cref="T:System.Data.SQLite.SQLiteLog"/> class.
  16339. </param>
  16340. <param name="error">
  16341. The error message.
  16342. </param>
  16343. <returns>
  16344. Non-zero upon success.
  16345. </returns>
  16346. </member>
  16347. <member name="M:System.Data.SQLite.SQLiteModule.SetCursorError(System.Data.SQLite.SQLiteModule,System.Data.SQLite.SQLiteVirtualTableCursor,System.Boolean,System.Boolean,System.String)">
  16348. <summary>
  16349. Arranges for the specified error message to be placed into the
  16350. zErrMsg field of a sqlite3_vtab derived structure, freeing the
  16351. existing error message, if any.
  16352. </summary>
  16353. <param name="module">
  16354. The <see cref="T:System.Data.SQLite.SQLiteModule"/> object instance to be used.
  16355. </param>
  16356. <param name="cursor">
  16357. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor"/> object instance used to
  16358. lookup the native pointer to the sqlite3_vtab derived structure.
  16359. </param>
  16360. <param name="logErrors">
  16361. Non-zero if this error message should also be logged using the
  16362. <see cref="T:System.Data.SQLite.SQLiteLog"/> class.
  16363. </param>
  16364. <param name="logExceptions">
  16365. Non-zero if caught exceptions should be logged using the
  16366. <see cref="T:System.Data.SQLite.SQLiteLog"/> class.
  16367. </param>
  16368. <param name="error">
  16369. The error message.
  16370. </param>
  16371. <returns>
  16372. Non-zero upon success.
  16373. </returns>
  16374. </member>
  16375. <member name="M:System.Data.SQLite.SQLiteModule.GetNativeModuleImpl">
  16376. <summary>
  16377. Gets and returns the <see cref="T:System.Data.SQLite.ISQLiteNativeModule"/> interface
  16378. implementation to be used when creating the native sqlite3_module
  16379. structure. Derived classes may override this method to supply an
  16380. alternate implementation for the <see cref="T:System.Data.SQLite.ISQLiteNativeModule"/>
  16381. interface.
  16382. </summary>
  16383. <returns>
  16384. The <see cref="T:System.Data.SQLite.ISQLiteNativeModule"/> interface implementation to
  16385. be used when populating the native sqlite3_module structure. If
  16386. the returned value is null, the private methods provided by the
  16387. <see cref="T:System.Data.SQLite.SQLiteModule"/> class and relating to the
  16388. <see cref="T:System.Data.SQLite.ISQLiteNativeModule"/> interface will be used to
  16389. create the necessary delegates.
  16390. </returns>
  16391. </member>
  16392. <member name="M:System.Data.SQLite.SQLiteModule.CreateNativeModuleImpl">
  16393. <summary>
  16394. Creates and returns the <see cref="T:System.Data.SQLite.ISQLiteNativeModule"/>
  16395. interface implementation corresponding to the current
  16396. <see cref="T:System.Data.SQLite.SQLiteModule"/> object instance.
  16397. </summary>
  16398. <returns>
  16399. The <see cref="T:System.Data.SQLite.ISQLiteNativeModule"/> interface implementation
  16400. corresponding to the current <see cref="T:System.Data.SQLite.SQLiteModule"/> object
  16401. instance.
  16402. </returns>
  16403. </member>
  16404. <member name="M:System.Data.SQLite.SQLiteModule.AllocateTable">
  16405. <summary>
  16406. Allocates a native sqlite3_vtab derived structure and returns a
  16407. native pointer to it.
  16408. </summary>
  16409. <returns>
  16410. A native pointer to a native sqlite3_vtab derived structure.
  16411. </returns>
  16412. </member>
  16413. <member name="M:System.Data.SQLite.SQLiteModule.ZeroTable(System.IntPtr)">
  16414. <summary>
  16415. Zeros out the fields of a native sqlite3_vtab derived structure.
  16416. </summary>
  16417. <param name="pVtab">
  16418. The native pointer to the native sqlite3_vtab derived structure to
  16419. zero.
  16420. </param>
  16421. </member>
  16422. <member name="M:System.Data.SQLite.SQLiteModule.FreeTable(System.IntPtr)">
  16423. <summary>
  16424. Frees a native sqlite3_vtab structure using the provided native
  16425. pointer to it.
  16426. </summary>
  16427. <param name="pVtab">
  16428. A native pointer to a native sqlite3_vtab derived structure.
  16429. </param>
  16430. </member>
  16431. <member name="M:System.Data.SQLite.SQLiteModule.AllocateCursor">
  16432. <summary>
  16433. Allocates a native sqlite3_vtab_cursor derived structure and
  16434. returns a native pointer to it.
  16435. </summary>
  16436. <returns>
  16437. A native pointer to a native sqlite3_vtab_cursor derived structure.
  16438. </returns>
  16439. </member>
  16440. <member name="M:System.Data.SQLite.SQLiteModule.FreeCursor(System.IntPtr)">
  16441. <summary>
  16442. Frees a native sqlite3_vtab_cursor structure using the provided
  16443. native pointer to it.
  16444. </summary>
  16445. <param name="pCursor">
  16446. A native pointer to a native sqlite3_vtab_cursor derived structure.
  16447. </param>
  16448. </member>
  16449. <member name="M:System.Data.SQLite.SQLiteModule.TableFromCursor(System.Data.SQLite.SQLiteModule,System.IntPtr)">
  16450. <summary>
  16451. Reads and returns the native pointer to the sqlite3_vtab derived
  16452. structure based on the native pointer to the sqlite3_vtab_cursor
  16453. derived structure.
  16454. </summary>
  16455. <param name="module">
  16456. The <see cref="T:System.Data.SQLite.SQLiteModule"/> object instance to be used.
  16457. </param>
  16458. <param name="pCursor">
  16459. The native pointer to the sqlite3_vtab_cursor derived structure
  16460. from which to read the native pointer to the sqlite3_vtab derived
  16461. structure.
  16462. </param>
  16463. <returns>
  16464. The native pointer to the sqlite3_vtab derived structure -OR-
  16465. <see cref="F:System.IntPtr.Zero"/> if it cannot be determined.
  16466. </returns>
  16467. </member>
  16468. <member name="M:System.Data.SQLite.SQLiteModule.TableFromCursor(System.IntPtr)">
  16469. <summary>
  16470. Reads and returns the native pointer to the sqlite3_vtab derived
  16471. structure based on the native pointer to the sqlite3_vtab_cursor
  16472. derived structure.
  16473. </summary>
  16474. <param name="pCursor">
  16475. The native pointer to the sqlite3_vtab_cursor derived structure
  16476. from which to read the native pointer to the sqlite3_vtab derived
  16477. structure.
  16478. </param>
  16479. <returns>
  16480. The native pointer to the sqlite3_vtab derived structure -OR-
  16481. <see cref="F:System.IntPtr.Zero"/> if it cannot be determined.
  16482. </returns>
  16483. </member>
  16484. <member name="M:System.Data.SQLite.SQLiteModule.TableFromIntPtr(System.IntPtr)">
  16485. <summary>
  16486. Looks up and returns the <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object
  16487. instance based on the native pointer to the sqlite3_vtab derived
  16488. structure.
  16489. </summary>
  16490. <param name="pVtab">
  16491. The native pointer to the sqlite3_vtab derived structure.
  16492. </param>
  16493. <returns>
  16494. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance or null if
  16495. the corresponding one cannot be found.
  16496. </returns>
  16497. </member>
  16498. <member name="M:System.Data.SQLite.SQLiteModule.TableToIntPtr(System.Data.SQLite.SQLiteVirtualTable)">
  16499. <summary>
  16500. Allocates and returns a native pointer to a sqlite3_vtab derived
  16501. structure and creates an association between it and the specified
  16502. <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance.
  16503. </summary>
  16504. <param name="table">
  16505. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance to be used
  16506. when creating the association.
  16507. </param>
  16508. <returns>
  16509. The native pointer to a sqlite3_vtab derived structure or
  16510. <see cref="F:System.IntPtr.Zero"/> if the method fails for any reason.
  16511. </returns>
  16512. </member>
  16513. <member name="M:System.Data.SQLite.SQLiteModule.CursorFromIntPtr(System.IntPtr,System.IntPtr)">
  16514. <summary>
  16515. Looks up and returns the <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor"/>
  16516. object instance based on the native pointer to the
  16517. sqlite3_vtab_cursor derived structure.
  16518. </summary>
  16519. <param name="pVtab">
  16520. The native pointer to the sqlite3_vtab derived structure.
  16521. </param>
  16522. <param name="pCursor">
  16523. The native pointer to the sqlite3_vtab_cursor derived structure.
  16524. </param>
  16525. <returns>
  16526. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor"/> object instance or null
  16527. if the corresponding one cannot be found.
  16528. </returns>
  16529. </member>
  16530. <member name="M:System.Data.SQLite.SQLiteModule.CursorToIntPtr(System.Data.SQLite.SQLiteVirtualTableCursor)">
  16531. <summary>
  16532. Allocates and returns a native pointer to a sqlite3_vtab_cursor
  16533. derived structure and creates an association between it and the
  16534. specified <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor"/> object instance.
  16535. </summary>
  16536. <param name="cursor">
  16537. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor"/> object instance to be
  16538. used when creating the association.
  16539. </param>
  16540. <returns>
  16541. The native pointer to a sqlite3_vtab_cursor derived structure or
  16542. <see cref="F:System.IntPtr.Zero"/> if the method fails for any reason.
  16543. </returns>
  16544. </member>
  16545. <member name="M:System.Data.SQLite.SQLiteModule.GetFunctionKey(System.Int32,System.String,System.Data.SQLite.SQLiteFunction)">
  16546. <summary>
  16547. Deterimines the key that should be used to identify and store the
  16548. <see cref="T:System.Data.SQLite.SQLiteFunction"/> object instance for the virtual table
  16549. (i.e. to be returned via the
  16550. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,System.IntPtr@)"/> method).
  16551. </summary>
  16552. <param name="argumentCount">
  16553. The number of arguments to the virtual table function.
  16554. </param>
  16555. <param name="name">
  16556. The name of the virtual table function.
  16557. </param>
  16558. <param name="function">
  16559. The <see cref="T:System.Data.SQLite.SQLiteFunction"/> object instance associated with
  16560. this virtual table function.
  16561. </param>
  16562. <returns>
  16563. The string that should be used to identify and store the virtual
  16564. table function instance. This method cannot return null. If null
  16565. is returned from this method, the behavior is undefined.
  16566. </returns>
  16567. </member>
  16568. <member name="M:System.Data.SQLite.SQLiteModule.DeclareTable(System.Data.SQLite.SQLiteConnection,System.String,System.String@)">
  16569. <summary>
  16570. Attempts to declare the schema for the virtual table using the
  16571. specified database connection.
  16572. </summary>
  16573. <param name="connection">
  16574. The <see cref="T:System.Data.SQLite.SQLiteConnection"/> object instance to use when
  16575. declaring the schema of the virtual table. This parameter may not
  16576. be null.
  16577. </param>
  16578. <param name="sql">
  16579. The string containing the CREATE TABLE statement that completely
  16580. describes the schema for the virtual table. This parameter may not
  16581. be null.
  16582. </param>
  16583. <param name="error">
  16584. Upon failure, this parameter must be modified to contain an error
  16585. message.
  16586. </param>
  16587. <returns>
  16588. A standard SQLite return code.
  16589. </returns>
  16590. </member>
  16591. <member name="M:System.Data.SQLite.SQLiteModule.DeclareFunction(System.Data.SQLite.SQLiteConnection,System.Int32,System.String,System.String@)">
  16592. <summary>
  16593. Calls the native SQLite core library in order to declare a virtual
  16594. table function in response to a call into the
  16595. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/>
  16596. or <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> virtual table
  16597. methods.
  16598. </summary>
  16599. <param name="connection">
  16600. The <see cref="T:System.Data.SQLite.SQLiteConnection"/> object instance to use when
  16601. declaring the schema of the virtual table.
  16602. </param>
  16603. <param name="argumentCount">
  16604. The number of arguments to the function being declared.
  16605. </param>
  16606. <param name="name">
  16607. The name of the function being declared.
  16608. </param>
  16609. <param name="error">
  16610. Upon success, the contents of this parameter are undefined. Upon
  16611. failure, it should contain an appropriate error message.
  16612. </param>
  16613. <returns>
  16614. A standard SQLite return code.
  16615. </returns>
  16616. </member>
  16617. <member name="M:System.Data.SQLite.SQLiteModule.SetTableError(System.IntPtr,System.String)">
  16618. <summary>
  16619. Arranges for the specified error message to be placed into the
  16620. zErrMsg field of a sqlite3_vtab derived structure, freeing the
  16621. existing error message, if any.
  16622. </summary>
  16623. <param name="pVtab">
  16624. The native pointer to the sqlite3_vtab derived structure.
  16625. </param>
  16626. <param name="error">
  16627. The error message.
  16628. </param>
  16629. <returns>
  16630. Non-zero upon success.
  16631. </returns>
  16632. </member>
  16633. <member name="M:System.Data.SQLite.SQLiteModule.SetTableError(System.Data.SQLite.SQLiteVirtualTable,System.String)">
  16634. <summary>
  16635. Arranges for the specified error message to be placed into the
  16636. zErrMsg field of a sqlite3_vtab derived structure, freeing the
  16637. existing error message, if any.
  16638. </summary>
  16639. <param name="table">
  16640. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance used to
  16641. lookup the native pointer to the sqlite3_vtab derived structure.
  16642. </param>
  16643. <param name="error">
  16644. The error message.
  16645. </param>
  16646. <returns>
  16647. Non-zero upon success.
  16648. </returns>
  16649. </member>
  16650. <member name="M:System.Data.SQLite.SQLiteModule.SetCursorError(System.Data.SQLite.SQLiteVirtualTableCursor,System.String)">
  16651. <summary>
  16652. Arranges for the specified error message to be placed into the
  16653. zErrMsg field of a sqlite3_vtab derived structure, freeing the
  16654. existing error message, if any.
  16655. </summary>
  16656. <param name="cursor">
  16657. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor"/> object instance used to
  16658. lookup the native pointer to the sqlite3_vtab derived structure.
  16659. </param>
  16660. <param name="error">
  16661. The error message.
  16662. </param>
  16663. <returns>
  16664. Non-zero upon success.
  16665. </returns>
  16666. </member>
  16667. <member name="M:System.Data.SQLite.SQLiteModule.SetEstimatedCost(System.Data.SQLite.SQLiteIndex,System.Nullable{System.Double})">
  16668. <summary>
  16669. Modifies the specified <see cref="T:System.Data.SQLite.SQLiteIndex"/> object instance
  16670. to contain the specified estimated cost.
  16671. </summary>
  16672. <param name="index">
  16673. The <see cref="T:System.Data.SQLite.SQLiteIndex"/> object instance to modify.
  16674. </param>
  16675. <param name="estimatedCost">
  16676. The estimated cost value to use. Using a null value means that the
  16677. default value provided by the SQLite core library should be used.
  16678. </param>
  16679. <returns>
  16680. Non-zero upon success.
  16681. </returns>
  16682. </member>
  16683. <member name="M:System.Data.SQLite.SQLiteModule.SetEstimatedCost(System.Data.SQLite.SQLiteIndex)">
  16684. <summary>
  16685. Modifies the specified <see cref="T:System.Data.SQLite.SQLiteIndex"/> object instance
  16686. to contain the default estimated cost.
  16687. </summary>
  16688. <param name="index">
  16689. The <see cref="T:System.Data.SQLite.SQLiteIndex"/> object instance to modify.
  16690. </param>
  16691. <returns>
  16692. Non-zero upon success.
  16693. </returns>
  16694. </member>
  16695. <member name="M:System.Data.SQLite.SQLiteModule.SetEstimatedRows(System.Data.SQLite.SQLiteIndex,System.Nullable{System.Int64})">
  16696. <summary>
  16697. Modifies the specified <see cref="T:System.Data.SQLite.SQLiteIndex"/> object instance
  16698. to contain the specified estimated rows.
  16699. </summary>
  16700. <param name="index">
  16701. The <see cref="T:System.Data.SQLite.SQLiteIndex"/> object instance to modify.
  16702. </param>
  16703. <param name="estimatedRows">
  16704. The estimated rows value to use. Using a null value means that the
  16705. default value provided by the SQLite core library should be used.
  16706. </param>
  16707. <returns>
  16708. Non-zero upon success.
  16709. </returns>
  16710. </member>
  16711. <member name="M:System.Data.SQLite.SQLiteModule.SetEstimatedRows(System.Data.SQLite.SQLiteIndex)">
  16712. <summary>
  16713. Modifies the specified <see cref="T:System.Data.SQLite.SQLiteIndex"/> object instance
  16714. to contain the default estimated rows.
  16715. </summary>
  16716. <param name="index">
  16717. The <see cref="T:System.Data.SQLite.SQLiteIndex"/> object instance to modify.
  16718. </param>
  16719. <returns>
  16720. Non-zero upon success.
  16721. </returns>
  16722. </member>
  16723. <member name="M:System.Data.SQLite.SQLiteModule.SetIndexFlags(System.Data.SQLite.SQLiteIndex,System.Nullable{System.Data.SQLite.SQLiteIndexFlags})">
  16724. <summary>
  16725. Modifies the specified <see cref="T:System.Data.SQLite.SQLiteIndex"/> object instance
  16726. to contain the specified flags.
  16727. </summary>
  16728. <param name="index">
  16729. The <see cref="T:System.Data.SQLite.SQLiteIndex"/> object instance to modify.
  16730. </param>
  16731. <param name="indexFlags">
  16732. The index flags value to use. Using a null value means that the
  16733. default value provided by the SQLite core library should be used.
  16734. </param>
  16735. <returns>
  16736. Non-zero upon success.
  16737. </returns>
  16738. </member>
  16739. <member name="M:System.Data.SQLite.SQLiteModule.SetIndexFlags(System.Data.SQLite.SQLiteIndex)">
  16740. <summary>
  16741. Modifies the specified <see cref="T:System.Data.SQLite.SQLiteIndex"/> object instance
  16742. to contain the default index flags.
  16743. </summary>
  16744. <param name="index">
  16745. The <see cref="T:System.Data.SQLite.SQLiteIndex"/> object instance to modify.
  16746. </param>
  16747. <returns>
  16748. Non-zero upon success.
  16749. </returns>
  16750. </member>
  16751. <member name="M:System.Data.SQLite.SQLiteModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)">
  16752. <summary>
  16753. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> method.
  16754. </summary>
  16755. <param name="pDb">
  16756. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> method.
  16757. </param>
  16758. <param name="pAux">
  16759. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> method.
  16760. </param>
  16761. <param name="argc">
  16762. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> method.
  16763. </param>
  16764. <param name="argv">
  16765. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> method.
  16766. </param>
  16767. <param name="pVtab">
  16768. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> method.
  16769. </param>
  16770. <param name="pError">
  16771. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> method.
  16772. </param>
  16773. <returns>
  16774. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> method.
  16775. </returns>
  16776. </member>
  16777. <member name="M:System.Data.SQLite.SQLiteModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)">
  16778. <summary>
  16779. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> method.
  16780. </summary>
  16781. <param name="pDb">
  16782. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> method.
  16783. </param>
  16784. <param name="pAux">
  16785. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> method.
  16786. </param>
  16787. <param name="argc">
  16788. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> method.
  16789. </param>
  16790. <param name="argv">
  16791. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> method.
  16792. </param>
  16793. <param name="pVtab">
  16794. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> method.
  16795. </param>
  16796. <param name="pError">
  16797. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> method.
  16798. </param>
  16799. <returns>
  16800. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> method.
  16801. </returns>
  16802. </member>
  16803. <member name="M:System.Data.SQLite.SQLiteModule.xBestIndex(System.IntPtr,System.IntPtr)">
  16804. <summary>
  16805. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xBestIndex(System.IntPtr,System.IntPtr)"/> method.
  16806. </summary>
  16807. <param name="pVtab">
  16808. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xBestIndex(System.IntPtr,System.IntPtr)"/> method.
  16809. </param>
  16810. <param name="pIndex">
  16811. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xBestIndex(System.IntPtr,System.IntPtr)"/> method.
  16812. </param>
  16813. <returns>
  16814. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xBestIndex(System.IntPtr,System.IntPtr)"/> method.
  16815. </returns>
  16816. </member>
  16817. <member name="M:System.Data.SQLite.SQLiteModule.xDisconnect(System.IntPtr)">
  16818. <summary>
  16819. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDisconnect(System.IntPtr)"/> method.
  16820. </summary>
  16821. <param name="pVtab">
  16822. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDisconnect(System.IntPtr)"/> method.
  16823. </param>
  16824. <returns>
  16825. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDisconnect(System.IntPtr)"/> method.
  16826. </returns>
  16827. </member>
  16828. <member name="M:System.Data.SQLite.SQLiteModule.xDestroy(System.IntPtr)">
  16829. <summary>
  16830. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDestroy(System.IntPtr)"/> method.
  16831. </summary>
  16832. <param name="pVtab">
  16833. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDestroy(System.IntPtr)"/> method.
  16834. </param>
  16835. <returns>
  16836. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDestroy(System.IntPtr)"/> method.
  16837. </returns>
  16838. </member>
  16839. <member name="M:System.Data.SQLite.SQLiteModule.xOpen(System.IntPtr,System.IntPtr@)">
  16840. <summary>
  16841. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xOpen(System.IntPtr,System.IntPtr@)"/> method.
  16842. </summary>
  16843. <param name="pVtab">
  16844. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xOpen(System.IntPtr,System.IntPtr@)"/> method.
  16845. </param>
  16846. <param name="pCursor">
  16847. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xOpen(System.IntPtr,System.IntPtr@)"/> method.
  16848. </param>
  16849. <returns>
  16850. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xOpen(System.IntPtr,System.IntPtr@)"/> method.
  16851. </returns>
  16852. </member>
  16853. <member name="M:System.Data.SQLite.SQLiteModule.xClose(System.IntPtr)">
  16854. <summary>
  16855. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xClose(System.IntPtr)"/> method.
  16856. </summary>
  16857. <param name="pCursor">
  16858. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xClose(System.IntPtr)"/> method.
  16859. </param>
  16860. <returns>
  16861. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xClose(System.IntPtr)"/> method.
  16862. </returns>
  16863. </member>
  16864. <member name="M:System.Data.SQLite.SQLiteModule.xFilter(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)">
  16865. <summary>
  16866. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFilter(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)"/> method.
  16867. </summary>
  16868. <param name="pCursor">
  16869. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFilter(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)"/> method.
  16870. </param>
  16871. <param name="idxNum">
  16872. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFilter(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)"/> method.
  16873. </param>
  16874. <param name="idxStr">
  16875. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFilter(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)"/> method.
  16876. </param>
  16877. <param name="argc">
  16878. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFilter(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)"/> method.
  16879. </param>
  16880. <param name="argv">
  16881. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFilter(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)"/> method.
  16882. </param>
  16883. <returns>
  16884. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFilter(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)"/> method.
  16885. </returns>
  16886. </member>
  16887. <member name="M:System.Data.SQLite.SQLiteModule.xNext(System.IntPtr)">
  16888. <summary>
  16889. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xNext(System.IntPtr)"/> method.
  16890. </summary>
  16891. <param name="pCursor">
  16892. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xNext(System.IntPtr)"/> method.
  16893. </param>
  16894. <returns>
  16895. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xNext(System.IntPtr)"/> method.
  16896. </returns>
  16897. </member>
  16898. <member name="M:System.Data.SQLite.SQLiteModule.xEof(System.IntPtr)">
  16899. <summary>
  16900. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xEof(System.IntPtr)"/> method.
  16901. </summary>
  16902. <param name="pCursor">
  16903. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xEof(System.IntPtr)"/> method.
  16904. </param>
  16905. <returns>
  16906. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xEof(System.IntPtr)"/> method.
  16907. </returns>
  16908. </member>
  16909. <member name="M:System.Data.SQLite.SQLiteModule.xColumn(System.IntPtr,System.IntPtr,System.Int32)">
  16910. <summary>
  16911. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xColumn(System.IntPtr,System.IntPtr,System.Int32)"/> method.
  16912. </summary>
  16913. <param name="pCursor">
  16914. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xColumn(System.IntPtr,System.IntPtr,System.Int32)"/> method.
  16915. </param>
  16916. <param name="pContext">
  16917. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xColumn(System.IntPtr,System.IntPtr,System.Int32)"/> method.
  16918. </param>
  16919. <param name="index">
  16920. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xColumn(System.IntPtr,System.IntPtr,System.Int32)"/> method.
  16921. </param>
  16922. <returns>
  16923. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xColumn(System.IntPtr,System.IntPtr,System.Int32)"/> method.
  16924. </returns>
  16925. </member>
  16926. <member name="M:System.Data.SQLite.SQLiteModule.xRowId(System.IntPtr,System.Int64@)">
  16927. <summary>
  16928. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRowId(System.IntPtr,System.Int64@)"/> method.
  16929. </summary>
  16930. <param name="pCursor">
  16931. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRowId(System.IntPtr,System.Int64@)"/> method.
  16932. </param>
  16933. <param name="rowId">
  16934. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRowId(System.IntPtr,System.Int64@)"/> method.
  16935. </param>
  16936. <returns>
  16937. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRowId(System.IntPtr,System.Int64@)"/> method.
  16938. </returns>
  16939. </member>
  16940. <member name="M:System.Data.SQLite.SQLiteModule.xUpdate(System.IntPtr,System.Int32,System.IntPtr,System.Int64@)">
  16941. <summary>
  16942. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xUpdate(System.IntPtr,System.Int32,System.IntPtr,System.Int64@)"/> method.
  16943. </summary>
  16944. <param name="pVtab">
  16945. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xUpdate(System.IntPtr,System.Int32,System.IntPtr,System.Int64@)"/> method.
  16946. </param>
  16947. <param name="argc">
  16948. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xUpdate(System.IntPtr,System.Int32,System.IntPtr,System.Int64@)"/> method.
  16949. </param>
  16950. <param name="argv">
  16951. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xUpdate(System.IntPtr,System.Int32,System.IntPtr,System.Int64@)"/> method.
  16952. </param>
  16953. <param name="rowId">
  16954. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xUpdate(System.IntPtr,System.Int32,System.IntPtr,System.Int64@)"/> method.
  16955. </param>
  16956. <returns>
  16957. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xUpdate(System.IntPtr,System.Int32,System.IntPtr,System.Int64@)"/> method.
  16958. </returns>
  16959. </member>
  16960. <member name="M:System.Data.SQLite.SQLiteModule.xBegin(System.IntPtr)">
  16961. <summary>
  16962. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xBegin(System.IntPtr)"/> method.
  16963. </summary>
  16964. <param name="pVtab">
  16965. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xBegin(System.IntPtr)"/> method.
  16966. </param>
  16967. <returns>
  16968. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xBegin(System.IntPtr)"/> method.
  16969. </returns>
  16970. </member>
  16971. <member name="M:System.Data.SQLite.SQLiteModule.xSync(System.IntPtr)">
  16972. <summary>
  16973. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xSync(System.IntPtr)"/> method.
  16974. </summary>
  16975. <param name="pVtab">
  16976. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xSync(System.IntPtr)"/> method.
  16977. </param>
  16978. <returns>
  16979. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xSync(System.IntPtr)"/> method.
  16980. </returns>
  16981. </member>
  16982. <member name="M:System.Data.SQLite.SQLiteModule.xCommit(System.IntPtr)">
  16983. <summary>
  16984. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCommit(System.IntPtr)"/> method.
  16985. </summary>
  16986. <param name="pVtab">
  16987. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCommit(System.IntPtr)"/> method.
  16988. </param>
  16989. <returns>
  16990. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCommit(System.IntPtr)"/> method.
  16991. </returns>
  16992. </member>
  16993. <member name="M:System.Data.SQLite.SQLiteModule.xRollback(System.IntPtr)">
  16994. <summary>
  16995. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRollback(System.IntPtr)"/> method.
  16996. </summary>
  16997. <param name="pVtab">
  16998. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRollback(System.IntPtr)"/> method.
  16999. </param>
  17000. <returns>
  17001. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRollback(System.IntPtr)"/> method.
  17002. </returns>
  17003. </member>
  17004. <member name="M:System.Data.SQLite.SQLiteModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,System.IntPtr@)">
  17005. <summary>
  17006. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,System.IntPtr@)"/> method.
  17007. </summary>
  17008. <param name="pVtab">
  17009. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,System.IntPtr@)"/> method.
  17010. </param>
  17011. <param name="nArg">
  17012. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,System.IntPtr@)"/> method.
  17013. </param>
  17014. <param name="zName">
  17015. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,System.IntPtr@)"/> method.
  17016. </param>
  17017. <param name="callback">
  17018. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,System.IntPtr@)"/> method.
  17019. </param>
  17020. <param name="pClientData">
  17021. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,System.IntPtr@)"/> method.
  17022. </param>
  17023. <returns>
  17024. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,System.IntPtr@)"/> method.
  17025. </returns>
  17026. </member>
  17027. <member name="M:System.Data.SQLite.SQLiteModule.xRename(System.IntPtr,System.IntPtr)">
  17028. <summary>
  17029. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRename(System.IntPtr,System.IntPtr)"/> method.
  17030. </summary>
  17031. <param name="pVtab">
  17032. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRename(System.IntPtr,System.IntPtr)"/> method.
  17033. </param>
  17034. <param name="zNew">
  17035. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRename(System.IntPtr,System.IntPtr)"/> method.
  17036. </param>
  17037. <returns>
  17038. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRename(System.IntPtr,System.IntPtr)"/> method.
  17039. </returns>
  17040. </member>
  17041. <member name="M:System.Data.SQLite.SQLiteModule.xSavepoint(System.IntPtr,System.Int32)">
  17042. <summary>
  17043. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xSavepoint(System.IntPtr,System.Int32)"/> method.
  17044. </summary>
  17045. <param name="pVtab">
  17046. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xSavepoint(System.IntPtr,System.Int32)"/> method.
  17047. </param>
  17048. <param name="iSavepoint">
  17049. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xSavepoint(System.IntPtr,System.Int32)"/> method.
  17050. </param>
  17051. <returns>
  17052. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xSavepoint(System.IntPtr,System.Int32)"/> method.
  17053. </returns>
  17054. </member>
  17055. <member name="M:System.Data.SQLite.SQLiteModule.xRelease(System.IntPtr,System.Int32)">
  17056. <summary>
  17057. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRelease(System.IntPtr,System.Int32)"/> method.
  17058. </summary>
  17059. <param name="pVtab">
  17060. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRelease(System.IntPtr,System.Int32)"/> method.
  17061. </param>
  17062. <param name="iSavepoint">
  17063. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRelease(System.IntPtr,System.Int32)"/> method.
  17064. </param>
  17065. <returns>
  17066. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRelease(System.IntPtr,System.Int32)"/> method.
  17067. </returns>
  17068. </member>
  17069. <member name="M:System.Data.SQLite.SQLiteModule.xRollbackTo(System.IntPtr,System.Int32)">
  17070. <summary>
  17071. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRollbackTo(System.IntPtr,System.Int32)"/> method.
  17072. </summary>
  17073. <param name="pVtab">
  17074. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRollbackTo(System.IntPtr,System.Int32)"/> method.
  17075. </param>
  17076. <param name="iSavepoint">
  17077. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRollbackTo(System.IntPtr,System.Int32)"/> method.
  17078. </param>
  17079. <returns>
  17080. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRollbackTo(System.IntPtr,System.Int32)"/> method.
  17081. </returns>
  17082. </member>
  17083. <member name="M:System.Data.SQLite.SQLiteModule.Create(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)">
  17084. <summary>
  17085. This method is called in response to the
  17086. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> method.
  17087. </summary>
  17088. <param name="connection">
  17089. The <see cref="T:System.Data.SQLite.SQLiteConnection"/> object instance associated with
  17090. the virtual table.
  17091. </param>
  17092. <param name="pClientData">
  17093. The native user-data pointer associated with this module, as it was
  17094. provided to the SQLite core library when the native module instance
  17095. was created.
  17096. </param>
  17097. <param name="arguments">
  17098. The module name, database name, virtual table name, and all other
  17099. arguments passed to the CREATE VIRTUAL TABLE statement.
  17100. </param>
  17101. <param name="table">
  17102. Upon success, this parameter must be modified to contain the
  17103. <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance associated with
  17104. the virtual table.
  17105. </param>
  17106. <param name="error">
  17107. Upon failure, this parameter must be modified to contain an error
  17108. message.
  17109. </param>
  17110. <returns>
  17111. A standard SQLite return code.
  17112. </returns>
  17113. </member>
  17114. <member name="M:System.Data.SQLite.SQLiteModule.Connect(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)">
  17115. <summary>
  17116. This method is called in response to the
  17117. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> method.
  17118. </summary>
  17119. <param name="connection">
  17120. The <see cref="T:System.Data.SQLite.SQLiteConnection"/> object instance associated with
  17121. the virtual table.
  17122. </param>
  17123. <param name="pClientData">
  17124. The native user-data pointer associated with this module, as it was
  17125. provided to the SQLite core library when the native module instance
  17126. was created.
  17127. </param>
  17128. <param name="arguments">
  17129. The module name, database name, virtual table name, and all other
  17130. arguments passed to the CREATE VIRTUAL TABLE statement.
  17131. </param>
  17132. <param name="table">
  17133. Upon success, this parameter must be modified to contain the
  17134. <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance associated with
  17135. the virtual table.
  17136. </param>
  17137. <param name="error">
  17138. Upon failure, this parameter must be modified to contain an error
  17139. message.
  17140. </param>
  17141. <returns>
  17142. A standard SQLite return code.
  17143. </returns>
  17144. </member>
  17145. <member name="M:System.Data.SQLite.SQLiteModule.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)">
  17146. <summary>
  17147. This method is called in response to the
  17148. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xBestIndex(System.IntPtr,System.IntPtr)"/> method.
  17149. </summary>
  17150. <param name="table">
  17151. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance associated
  17152. with this virtual table.
  17153. </param>
  17154. <param name="index">
  17155. The <see cref="T:System.Data.SQLite.SQLiteIndex"/> object instance containing all the
  17156. data for the inputs and outputs relating to index selection.
  17157. </param>
  17158. <returns>
  17159. A standard SQLite return code.
  17160. </returns>
  17161. </member>
  17162. <member name="M:System.Data.SQLite.SQLiteModule.Disconnect(System.Data.SQLite.SQLiteVirtualTable)">
  17163. <summary>
  17164. This method is called in response to the
  17165. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDisconnect(System.IntPtr)"/> method.
  17166. </summary>
  17167. <param name="table">
  17168. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance associated
  17169. with this virtual table.
  17170. </param>
  17171. <returns>
  17172. A standard SQLite return code.
  17173. </returns>
  17174. </member>
  17175. <member name="M:System.Data.SQLite.SQLiteModule.Destroy(System.Data.SQLite.SQLiteVirtualTable)">
  17176. <summary>
  17177. This method is called in response to the
  17178. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDestroy(System.IntPtr)"/> method.
  17179. </summary>
  17180. <param name="table">
  17181. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance associated
  17182. with this virtual table.
  17183. </param>
  17184. <returns>
  17185. A standard SQLite return code.
  17186. </returns>
  17187. </member>
  17188. <member name="M:System.Data.SQLite.SQLiteModule.Open(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteVirtualTableCursor@)">
  17189. <summary>
  17190. This method is called in response to the
  17191. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xOpen(System.IntPtr,System.IntPtr@)"/> method.
  17192. </summary>
  17193. <param name="table">
  17194. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance associated
  17195. with this virtual table.
  17196. </param>
  17197. <param name="cursor">
  17198. Upon success, this parameter must be modified to contain the
  17199. <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor"/> object instance associated
  17200. with the newly opened virtual table cursor.
  17201. </param>
  17202. <returns>
  17203. A standard SQLite return code.
  17204. </returns>
  17205. </member>
  17206. <member name="M:System.Data.SQLite.SQLiteModule.Close(System.Data.SQLite.SQLiteVirtualTableCursor)">
  17207. <summary>
  17208. This method is called in response to the
  17209. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xClose(System.IntPtr)"/> method.
  17210. </summary>
  17211. <param name="cursor">
  17212. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor"/> object instance
  17213. associated with the previously opened virtual table cursor to be
  17214. used.
  17215. </param>
  17216. <returns>
  17217. A standard SQLite return code.
  17218. </returns>
  17219. </member>
  17220. <member name="M:System.Data.SQLite.SQLiteModule.Filter(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int32,System.String,System.Data.SQLite.SQLiteValue[])">
  17221. <summary>
  17222. This method is called in response to the
  17223. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFilter(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)"/> method.
  17224. </summary>
  17225. <param name="cursor">
  17226. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor"/> object instance
  17227. associated with the previously opened virtual table cursor to be
  17228. used.
  17229. </param>
  17230. <param name="indexNumber">
  17231. Number used to help identify the selected index.
  17232. </param>
  17233. <param name="indexString">
  17234. String used to help identify the selected index.
  17235. </param>
  17236. <param name="values">
  17237. The values corresponding to each column in the selected index.
  17238. </param>
  17239. <returns>
  17240. A standard SQLite return code.
  17241. </returns>
  17242. </member>
  17243. <member name="M:System.Data.SQLite.SQLiteModule.Next(System.Data.SQLite.SQLiteVirtualTableCursor)">
  17244. <summary>
  17245. This method is called in response to the
  17246. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xNext(System.IntPtr)"/> method.
  17247. </summary>
  17248. <param name="cursor">
  17249. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor"/> object instance
  17250. associated with the previously opened virtual table cursor to be
  17251. used.
  17252. </param>
  17253. <returns>
  17254. A standard SQLite return code.
  17255. </returns>
  17256. </member>
  17257. <member name="M:System.Data.SQLite.SQLiteModule.Eof(System.Data.SQLite.SQLiteVirtualTableCursor)">
  17258. <summary>
  17259. This method is called in response to the
  17260. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xEof(System.IntPtr)"/> method.
  17261. </summary>
  17262. <param name="cursor">
  17263. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor"/> object instance
  17264. associated with the previously opened virtual table cursor to be
  17265. used.
  17266. </param>
  17267. <returns>
  17268. Non-zero if no more rows are available; zero otherwise.
  17269. </returns>
  17270. </member>
  17271. <member name="M:System.Data.SQLite.SQLiteModule.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)">
  17272. <summary>
  17273. This method is called in response to the
  17274. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xColumn(System.IntPtr,System.IntPtr,System.Int32)"/> method.
  17275. </summary>
  17276. <param name="cursor">
  17277. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor"/> object instance
  17278. associated with the previously opened virtual table cursor to be
  17279. used.
  17280. </param>
  17281. <param name="context">
  17282. The <see cref="T:System.Data.SQLite.SQLiteContext"/> object instance to be used for
  17283. returning the specified column value to the SQLite core library.
  17284. </param>
  17285. <param name="index">
  17286. The zero-based index corresponding to the column containing the
  17287. value to be returned.
  17288. </param>
  17289. <returns>
  17290. A standard SQLite return code.
  17291. </returns>
  17292. </member>
  17293. <member name="M:System.Data.SQLite.SQLiteModule.RowId(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int64@)">
  17294. <summary>
  17295. This method is called in response to the
  17296. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRowId(System.IntPtr,System.Int64@)"/> method.
  17297. </summary>
  17298. <param name="cursor">
  17299. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor"/> object instance
  17300. associated with the previously opened virtual table cursor to be
  17301. used.
  17302. </param>
  17303. <param name="rowId">
  17304. Upon success, this parameter must be modified to contain the unique
  17305. integer row identifier for the current row for the specified cursor.
  17306. </param>
  17307. <returns>
  17308. A standard SQLite return code.
  17309. </returns>
  17310. </member>
  17311. <member name="M:System.Data.SQLite.SQLiteModule.Update(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteValue[],System.Int64@)">
  17312. <summary>
  17313. This method is called in response to the
  17314. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xUpdate(System.IntPtr,System.Int32,System.IntPtr,System.Int64@)"/> method.
  17315. </summary>
  17316. <param name="table">
  17317. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance associated
  17318. with this virtual table.
  17319. </param>
  17320. <param name="values">
  17321. The array of <see cref="T:System.Data.SQLite.SQLiteValue"/> object instances containing
  17322. the new or modified column values, if any.
  17323. </param>
  17324. <param name="rowId">
  17325. Upon success, this parameter must be modified to contain the unique
  17326. integer row identifier for the row that was inserted, if any.
  17327. </param>
  17328. <returns>
  17329. A standard SQLite return code.
  17330. </returns>
  17331. </member>
  17332. <member name="M:System.Data.SQLite.SQLiteModule.Begin(System.Data.SQLite.SQLiteVirtualTable)">
  17333. <summary>
  17334. This method is called in response to the
  17335. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xBegin(System.IntPtr)"/> method.
  17336. </summary>
  17337. <param name="table">
  17338. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance associated
  17339. with this virtual table.
  17340. </param>
  17341. <returns>
  17342. A standard SQLite return code.
  17343. </returns>
  17344. </member>
  17345. <member name="M:System.Data.SQLite.SQLiteModule.Sync(System.Data.SQLite.SQLiteVirtualTable)">
  17346. <summary>
  17347. This method is called in response to the
  17348. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xSync(System.IntPtr)"/> method.
  17349. </summary>
  17350. <param name="table">
  17351. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance associated
  17352. with this virtual table.
  17353. </param>
  17354. <returns>
  17355. A standard SQLite return code.
  17356. </returns>
  17357. </member>
  17358. <member name="M:System.Data.SQLite.SQLiteModule.Commit(System.Data.SQLite.SQLiteVirtualTable)">
  17359. <summary>
  17360. This method is called in response to the
  17361. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCommit(System.IntPtr)"/> method.
  17362. </summary>
  17363. <param name="table">
  17364. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance associated
  17365. with this virtual table.
  17366. </param>
  17367. <returns>
  17368. A standard SQLite return code.
  17369. </returns>
  17370. </member>
  17371. <member name="M:System.Data.SQLite.SQLiteModule.Rollback(System.Data.SQLite.SQLiteVirtualTable)">
  17372. <summary>
  17373. This method is called in response to the
  17374. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRollback(System.IntPtr)"/> method.
  17375. </summary>
  17376. <param name="table">
  17377. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance associated
  17378. with this virtual table.
  17379. </param>
  17380. <returns>
  17381. A standard SQLite return code.
  17382. </returns>
  17383. </member>
  17384. <member name="M:System.Data.SQLite.SQLiteModule.FindFunction(System.Data.SQLite.SQLiteVirtualTable,System.Int32,System.String,System.Data.SQLite.SQLiteFunction@,System.IntPtr@)">
  17385. <summary>
  17386. This method is called in response to the
  17387. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,System.IntPtr@)"/> method.
  17388. </summary>
  17389. <param name="table">
  17390. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance associated
  17391. with this virtual table.
  17392. </param>
  17393. <param name="argumentCount">
  17394. The number of arguments to the function being sought.
  17395. </param>
  17396. <param name="name">
  17397. The name of the function being sought.
  17398. </param>
  17399. <param name="function">
  17400. Upon success, this parameter must be modified to contain the
  17401. <see cref="T:System.Data.SQLite.SQLiteFunction"/> object instance responsible for
  17402. implementing the specified function.
  17403. </param>
  17404. <param name="pClientData">
  17405. Upon success, this parameter must be modified to contain the
  17406. native user-data pointer associated with
  17407. <paramref name="function"/>.
  17408. </param>
  17409. <returns>
  17410. Non-zero if the specified function was found; zero otherwise.
  17411. </returns>
  17412. </member>
  17413. <member name="M:System.Data.SQLite.SQLiteModule.Rename(System.Data.SQLite.SQLiteVirtualTable,System.String)">
  17414. <summary>
  17415. This method is called in response to the
  17416. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRename(System.IntPtr,System.IntPtr)"/> method.
  17417. </summary>
  17418. <param name="table">
  17419. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance associated
  17420. with this virtual table.
  17421. </param>
  17422. <param name="newName">
  17423. The new name for the virtual table.
  17424. </param>
  17425. <returns>
  17426. A standard SQLite return code.
  17427. </returns>
  17428. </member>
  17429. <member name="M:System.Data.SQLite.SQLiteModule.Savepoint(System.Data.SQLite.SQLiteVirtualTable,System.Int32)">
  17430. <summary>
  17431. This method is called in response to the
  17432. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xSavepoint(System.IntPtr,System.Int32)"/> method.
  17433. </summary>
  17434. <param name="table">
  17435. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance associated
  17436. with this virtual table.
  17437. </param>
  17438. <param name="savepoint">
  17439. This is an integer identifier under which the the current state of
  17440. the virtual table should be saved.
  17441. </param>
  17442. <returns>
  17443. A standard SQLite return code.
  17444. </returns>
  17445. </member>
  17446. <member name="M:System.Data.SQLite.SQLiteModule.Release(System.Data.SQLite.SQLiteVirtualTable,System.Int32)">
  17447. <summary>
  17448. This method is called in response to the
  17449. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRelease(System.IntPtr,System.Int32)"/> method.
  17450. </summary>
  17451. <param name="table">
  17452. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance associated
  17453. with this virtual table.
  17454. </param>
  17455. <param name="savepoint">
  17456. This is an integer used to indicate that any saved states with an
  17457. identifier greater than or equal to this should be deleted by the
  17458. virtual table.
  17459. </param>
  17460. <returns>
  17461. A standard SQLite return code.
  17462. </returns>
  17463. </member>
  17464. <member name="M:System.Data.SQLite.SQLiteModule.RollbackTo(System.Data.SQLite.SQLiteVirtualTable,System.Int32)">
  17465. <summary>
  17466. This method is called in response to the
  17467. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRollbackTo(System.IntPtr,System.Int32)"/> method.
  17468. </summary>
  17469. <param name="table">
  17470. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance associated
  17471. with this virtual table.
  17472. </param>
  17473. <param name="savepoint">
  17474. This is an integer identifier used to specify a specific saved
  17475. state for the virtual table for it to restore itself back to, which
  17476. should also have the effect of deleting all saved states with an
  17477. integer identifier greater than this one.
  17478. </param>
  17479. <returns>
  17480. A standard SQLite return code.
  17481. </returns>
  17482. </member>
  17483. <member name="M:System.Data.SQLite.SQLiteModule.Dispose">
  17484. <summary>
  17485. Disposes of this object instance.
  17486. </summary>
  17487. </member>
  17488. <member name="M:System.Data.SQLite.SQLiteModule.CheckDisposed">
  17489. <summary>
  17490. Throws an <see cref="T:System.ObjectDisposedException"/> if this object
  17491. instance has been disposed.
  17492. </summary>
  17493. </member>
  17494. <member name="M:System.Data.SQLite.SQLiteModule.Dispose(System.Boolean)">
  17495. <summary>
  17496. Disposes of this object instance.
  17497. </summary>
  17498. <param name="disposing">
  17499. Non-zero if this method is being called from the
  17500. <see cref="M:System.Data.SQLite.SQLiteModule.Dispose"/> method. Zero if this method is being
  17501. called from the finalizer.
  17502. </param>
  17503. </member>
  17504. <member name="M:System.Data.SQLite.SQLiteModule.Finalize">
  17505. <summary>
  17506. Finalizes this object instance.
  17507. </summary>
  17508. </member>
  17509. <member name="P:System.Data.SQLite.SQLiteModule.LogErrorsNoThrow">
  17510. <summary>
  17511. Returns or sets a boolean value indicating whether virtual table
  17512. errors should be logged using the <see cref="T:System.Data.SQLite.SQLiteLog"/> class.
  17513. </summary>
  17514. </member>
  17515. <member name="P:System.Data.SQLite.SQLiteModule.LogExceptionsNoThrow">
  17516. <summary>
  17517. Returns or sets a boolean value indicating whether exceptions
  17518. caught in the
  17519. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDisconnect(System.IntPtr)"/> method,
  17520. the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDestroy(System.IntPtr)"/> method,
  17521. the <see cref="M:System.Data.SQLite.SQLiteModule.SetTableError(System.IntPtr,System.String)"/> method,
  17522. the <see cref="M:System.Data.SQLite.SQLiteModule.SetTableError(System.Data.SQLite.SQLiteVirtualTable,System.String)"/> method,
  17523. and the <see cref="M:System.Data.SQLite.SQLiteModule.Dispose"/> method should be logged using the
  17524. <see cref="T:System.Data.SQLite.SQLiteLog"/> class.
  17525. </summary>
  17526. </member>
  17527. <member name="P:System.Data.SQLite.SQLiteModule.LogErrors">
  17528. <summary>
  17529. Returns or sets a boolean value indicating whether virtual table
  17530. errors should be logged using the <see cref="T:System.Data.SQLite.SQLiteLog"/> class.
  17531. </summary>
  17532. </member>
  17533. <member name="P:System.Data.SQLite.SQLiteModule.LogExceptions">
  17534. <summary>
  17535. Returns or sets a boolean value indicating whether exceptions
  17536. caught in the
  17537. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDisconnect(System.IntPtr)"/> method,
  17538. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDestroy(System.IntPtr)"/> method, and the
  17539. <see cref="M:System.Data.SQLite.SQLiteModule.Dispose"/> method should be logged using the
  17540. <see cref="T:System.Data.SQLite.SQLiteLog"/> class.
  17541. </summary>
  17542. </member>
  17543. <member name="P:System.Data.SQLite.SQLiteModule.Declared">
  17544. <summary>
  17545. Returns non-zero if the schema for the virtual table has been
  17546. declared.
  17547. </summary>
  17548. </member>
  17549. <member name="P:System.Data.SQLite.SQLiteModule.Name">
  17550. <summary>
  17551. Returns the name of the module as it was registered with the SQLite
  17552. core library.
  17553. </summary>
  17554. </member>
  17555. <member name="T:System.Data.SQLite.SQLiteModule.SQLiteNativeModule">
  17556. <summary>
  17557. This class implements the <see cref="T:System.Data.SQLite.ISQLiteNativeModule"/>
  17558. interface by forwarding those method calls to the
  17559. <see cref="T:System.Data.SQLite.SQLiteModule"/> object instance it contains. If the
  17560. contained <see cref="T:System.Data.SQLite.SQLiteModule"/> object instance is null, all
  17561. the <see cref="T:System.Data.SQLite.ISQLiteNativeModule"/> methods simply generate an
  17562. error.
  17563. </summary>
  17564. </member>
  17565. <member name="F:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.DefaultLogErrors">
  17566. <summary>
  17567. This is the value that is always used for the "logErrors"
  17568. parameter to the various static error handling methods provided
  17569. by the <see cref="T:System.Data.SQLite.SQLiteModule"/> class.
  17570. </summary>
  17571. </member>
  17572. <member name="F:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.DefaultLogExceptions">
  17573. <summary>
  17574. This is the value that is always used for the "logExceptions"
  17575. parameter to the various static error handling methods provided
  17576. by the <see cref="T:System.Data.SQLite.SQLiteModule"/> class.
  17577. </summary>
  17578. </member>
  17579. <member name="F:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.ModuleNotAvailableErrorMessage">
  17580. <summary>
  17581. This is the error message text used when the contained
  17582. <see cref="T:System.Data.SQLite.SQLiteModule"/> object instance is not available
  17583. for any reason.
  17584. </summary>
  17585. </member>
  17586. <member name="F:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.module">
  17587. <summary>
  17588. The <see cref="T:System.Data.SQLite.SQLiteModule"/> object instance used to provide
  17589. an implementation of the <see cref="T:System.Data.SQLite.ISQLiteNativeModule"/>
  17590. interface.
  17591. </summary>
  17592. </member>
  17593. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.#ctor(System.Data.SQLite.SQLiteModule)">
  17594. <summary>
  17595. Constructs an instance of this class.
  17596. </summary>
  17597. <param name="module">
  17598. The <see cref="T:System.Data.SQLite.SQLiteModule"/> object instance used to provide
  17599. an implementation of the <see cref="T:System.Data.SQLite.ISQLiteNativeModule"/>
  17600. interface.
  17601. </param>
  17602. </member>
  17603. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.ModuleNotAvailableTableError(System.IntPtr)">
  17604. <summary>
  17605. Sets the table error message to one that indicates the native
  17606. module implementation is not available.
  17607. </summary>
  17608. <param name="pVtab">
  17609. The native pointer to the sqlite3_vtab derived structure.
  17610. </param>
  17611. <returns>
  17612. The value of <see cref="F:System.Data.SQLite.SQLiteErrorCode.Error"/>.
  17613. </returns>
  17614. </member>
  17615. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.ModuleNotAvailableCursorError(System.IntPtr)">
  17616. <summary>
  17617. Sets the table error message to one that indicates the native
  17618. module implementation is not available.
  17619. </summary>
  17620. <param name="pCursor">
  17621. The native pointer to the sqlite3_vtab_cursor derived
  17622. structure.
  17623. </param>
  17624. <returns>
  17625. The value of <see cref="F:System.Data.SQLite.SQLiteErrorCode.Error"/>.
  17626. </returns>
  17627. </member>
  17628. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)">
  17629. <summary>
  17630. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> method.
  17631. </summary>
  17632. <param name="pDb">
  17633. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> method.
  17634. </param>
  17635. <param name="pAux">
  17636. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> method.
  17637. </param>
  17638. <param name="argc">
  17639. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> method.
  17640. </param>
  17641. <param name="argv">
  17642. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> method.
  17643. </param>
  17644. <param name="pVtab">
  17645. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> method.
  17646. </param>
  17647. <param name="pError">
  17648. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> method.
  17649. </param>
  17650. <returns>
  17651. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> method.
  17652. </returns>
  17653. </member>
  17654. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)">
  17655. <summary>
  17656. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> method.
  17657. </summary>
  17658. <param name="pDb">
  17659. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> method.
  17660. </param>
  17661. <param name="pAux">
  17662. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> method.
  17663. </param>
  17664. <param name="argc">
  17665. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> method.
  17666. </param>
  17667. <param name="argv">
  17668. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> method.
  17669. </param>
  17670. <param name="pVtab">
  17671. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> method.
  17672. </param>
  17673. <param name="pError">
  17674. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> method.
  17675. </param>
  17676. <returns>
  17677. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)"/> method.
  17678. </returns>
  17679. </member>
  17680. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xBestIndex(System.IntPtr,System.IntPtr)">
  17681. <summary>
  17682. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xBestIndex(System.IntPtr,System.IntPtr)"/> method.
  17683. </summary>
  17684. <param name="pVtab">
  17685. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xBestIndex(System.IntPtr,System.IntPtr)"/> method.
  17686. </param>
  17687. <param name="pIndex">
  17688. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xBestIndex(System.IntPtr,System.IntPtr)"/> method.
  17689. </param>
  17690. <returns>
  17691. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xBestIndex(System.IntPtr,System.IntPtr)"/> method.
  17692. </returns>
  17693. </member>
  17694. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xDisconnect(System.IntPtr)">
  17695. <summary>
  17696. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDisconnect(System.IntPtr)"/> method.
  17697. </summary>
  17698. <param name="pVtab">
  17699. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDisconnect(System.IntPtr)"/> method.
  17700. </param>
  17701. <returns>
  17702. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDisconnect(System.IntPtr)"/> method.
  17703. </returns>
  17704. </member>
  17705. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xDestroy(System.IntPtr)">
  17706. <summary>
  17707. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDestroy(System.IntPtr)"/> method.
  17708. </summary>
  17709. <param name="pVtab">
  17710. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDestroy(System.IntPtr)"/> method.
  17711. </param>
  17712. <returns>
  17713. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDestroy(System.IntPtr)"/> method.
  17714. </returns>
  17715. </member>
  17716. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xOpen(System.IntPtr,System.IntPtr@)">
  17717. <summary>
  17718. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xOpen(System.IntPtr,System.IntPtr@)"/> method.
  17719. </summary>
  17720. <param name="pVtab">
  17721. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xOpen(System.IntPtr,System.IntPtr@)"/> method.
  17722. </param>
  17723. <param name="pCursor">
  17724. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xOpen(System.IntPtr,System.IntPtr@)"/> method.
  17725. </param>
  17726. <returns>
  17727. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xOpen(System.IntPtr,System.IntPtr@)"/> method.
  17728. </returns>
  17729. </member>
  17730. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xClose(System.IntPtr)">
  17731. <summary>
  17732. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xClose(System.IntPtr)"/> method.
  17733. </summary>
  17734. <param name="pCursor">
  17735. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xClose(System.IntPtr)"/> method.
  17736. </param>
  17737. <returns>
  17738. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xClose(System.IntPtr)"/> method.
  17739. </returns>
  17740. </member>
  17741. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xFilter(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)">
  17742. <summary>
  17743. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFilter(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)"/> method.
  17744. </summary>
  17745. <param name="pCursor">
  17746. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFilter(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)"/> method.
  17747. </param>
  17748. <param name="idxNum">
  17749. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFilter(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)"/> method.
  17750. </param>
  17751. <param name="idxStr">
  17752. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFilter(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)"/> method.
  17753. </param>
  17754. <param name="argc">
  17755. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFilter(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)"/> method.
  17756. </param>
  17757. <param name="argv">
  17758. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFilter(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)"/> method.
  17759. </param>
  17760. <returns>
  17761. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFilter(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)"/> method.
  17762. </returns>
  17763. </member>
  17764. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xNext(System.IntPtr)">
  17765. <summary>
  17766. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xNext(System.IntPtr)"/> method.
  17767. </summary>
  17768. <param name="pCursor">
  17769. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xNext(System.IntPtr)"/> method.
  17770. </param>
  17771. <returns>
  17772. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xNext(System.IntPtr)"/> method.
  17773. </returns>
  17774. </member>
  17775. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xEof(System.IntPtr)">
  17776. <summary>
  17777. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xEof(System.IntPtr)"/> method.
  17778. </summary>
  17779. <param name="pCursor">
  17780. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xEof(System.IntPtr)"/> method.
  17781. </param>
  17782. <returns>
  17783. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xEof(System.IntPtr)"/> method.
  17784. </returns>
  17785. </member>
  17786. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xColumn(System.IntPtr,System.IntPtr,System.Int32)">
  17787. <summary>
  17788. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xColumn(System.IntPtr,System.IntPtr,System.Int32)"/> method.
  17789. </summary>
  17790. <param name="pCursor">
  17791. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xColumn(System.IntPtr,System.IntPtr,System.Int32)"/> method.
  17792. </param>
  17793. <param name="pContext">
  17794. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xColumn(System.IntPtr,System.IntPtr,System.Int32)"/> method.
  17795. </param>
  17796. <param name="index">
  17797. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xColumn(System.IntPtr,System.IntPtr,System.Int32)"/> method.
  17798. </param>
  17799. <returns>
  17800. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xColumn(System.IntPtr,System.IntPtr,System.Int32)"/> method.
  17801. </returns>
  17802. </member>
  17803. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xRowId(System.IntPtr,System.Int64@)">
  17804. <summary>
  17805. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRowId(System.IntPtr,System.Int64@)"/> method.
  17806. </summary>
  17807. <param name="pCursor">
  17808. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRowId(System.IntPtr,System.Int64@)"/> method.
  17809. </param>
  17810. <param name="rowId">
  17811. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRowId(System.IntPtr,System.Int64@)"/> method.
  17812. </param>
  17813. <returns>
  17814. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRowId(System.IntPtr,System.Int64@)"/> method.
  17815. </returns>
  17816. </member>
  17817. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xUpdate(System.IntPtr,System.Int32,System.IntPtr,System.Int64@)">
  17818. <summary>
  17819. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xUpdate(System.IntPtr,System.Int32,System.IntPtr,System.Int64@)"/> method.
  17820. </summary>
  17821. <param name="pVtab">
  17822. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xUpdate(System.IntPtr,System.Int32,System.IntPtr,System.Int64@)"/> method.
  17823. </param>
  17824. <param name="argc">
  17825. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xUpdate(System.IntPtr,System.Int32,System.IntPtr,System.Int64@)"/> method.
  17826. </param>
  17827. <param name="argv">
  17828. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xUpdate(System.IntPtr,System.Int32,System.IntPtr,System.Int64@)"/> method.
  17829. </param>
  17830. <param name="rowId">
  17831. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xUpdate(System.IntPtr,System.Int32,System.IntPtr,System.Int64@)"/> method.
  17832. </param>
  17833. <returns>
  17834. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xUpdate(System.IntPtr,System.Int32,System.IntPtr,System.Int64@)"/> method.
  17835. </returns>
  17836. </member>
  17837. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xBegin(System.IntPtr)">
  17838. <summary>
  17839. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xBegin(System.IntPtr)"/> method.
  17840. </summary>
  17841. <param name="pVtab">
  17842. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xBegin(System.IntPtr)"/> method.
  17843. </param>
  17844. <returns>
  17845. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xBegin(System.IntPtr)"/> method.
  17846. </returns>
  17847. </member>
  17848. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xSync(System.IntPtr)">
  17849. <summary>
  17850. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xSync(System.IntPtr)"/> method.
  17851. </summary>
  17852. <param name="pVtab">
  17853. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xSync(System.IntPtr)"/> method.
  17854. </param>
  17855. <returns>
  17856. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xSync(System.IntPtr)"/> method.
  17857. </returns>
  17858. </member>
  17859. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xCommit(System.IntPtr)">
  17860. <summary>
  17861. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCommit(System.IntPtr)"/> method.
  17862. </summary>
  17863. <param name="pVtab">
  17864. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCommit(System.IntPtr)"/> method.
  17865. </param>
  17866. <returns>
  17867. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCommit(System.IntPtr)"/> method.
  17868. </returns>
  17869. </member>
  17870. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xRollback(System.IntPtr)">
  17871. <summary>
  17872. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRollback(System.IntPtr)"/> method.
  17873. </summary>
  17874. <param name="pVtab">
  17875. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRollback(System.IntPtr)"/> method.
  17876. </param>
  17877. <returns>
  17878. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRollback(System.IntPtr)"/> method.
  17879. </returns>
  17880. </member>
  17881. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,System.IntPtr@)">
  17882. <summary>
  17883. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,System.IntPtr@)"/> method.
  17884. </summary>
  17885. <param name="pVtab">
  17886. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,System.IntPtr@)"/> method.
  17887. </param>
  17888. <param name="nArg">
  17889. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,System.IntPtr@)"/> method.
  17890. </param>
  17891. <param name="zName">
  17892. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,System.IntPtr@)"/> method.
  17893. </param>
  17894. <param name="callback">
  17895. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,System.IntPtr@)"/> method.
  17896. </param>
  17897. <param name="pClientData">
  17898. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,System.IntPtr@)"/> method.
  17899. </param>
  17900. <returns>
  17901. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,System.IntPtr@)"/> method.
  17902. </returns>
  17903. </member>
  17904. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xRename(System.IntPtr,System.IntPtr)">
  17905. <summary>
  17906. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRename(System.IntPtr,System.IntPtr)"/> method.
  17907. </summary>
  17908. <param name="pVtab">
  17909. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRename(System.IntPtr,System.IntPtr)"/> method.
  17910. </param>
  17911. <param name="zNew">
  17912. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRename(System.IntPtr,System.IntPtr)"/> method.
  17913. </param>
  17914. <returns>
  17915. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRename(System.IntPtr,System.IntPtr)"/> method.
  17916. </returns>
  17917. </member>
  17918. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xSavepoint(System.IntPtr,System.Int32)">
  17919. <summary>
  17920. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xSavepoint(System.IntPtr,System.Int32)"/> method.
  17921. </summary>
  17922. <param name="pVtab">
  17923. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xSavepoint(System.IntPtr,System.Int32)"/> method.
  17924. </param>
  17925. <param name="iSavepoint">
  17926. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xSavepoint(System.IntPtr,System.Int32)"/> method.
  17927. </param>
  17928. <returns>
  17929. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xSavepoint(System.IntPtr,System.Int32)"/> method.
  17930. </returns>
  17931. </member>
  17932. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xRelease(System.IntPtr,System.Int32)">
  17933. <summary>
  17934. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRelease(System.IntPtr,System.Int32)"/> method.
  17935. </summary>
  17936. <param name="pVtab">
  17937. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRelease(System.IntPtr,System.Int32)"/> method.
  17938. </param>
  17939. <param name="iSavepoint">
  17940. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRelease(System.IntPtr,System.Int32)"/> method.
  17941. </param>
  17942. <returns>
  17943. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRelease(System.IntPtr,System.Int32)"/> method.
  17944. </returns>
  17945. </member>
  17946. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xRollbackTo(System.IntPtr,System.Int32)">
  17947. <summary>
  17948. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRollbackTo(System.IntPtr,System.Int32)"/> method.
  17949. </summary>
  17950. <param name="pVtab">
  17951. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRollbackTo(System.IntPtr,System.Int32)"/> method.
  17952. </param>
  17953. <param name="iSavepoint">
  17954. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRollbackTo(System.IntPtr,System.Int32)"/> method.
  17955. </param>
  17956. <returns>
  17957. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRollbackTo(System.IntPtr,System.Int32)"/> method.
  17958. </returns>
  17959. </member>
  17960. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.Dispose">
  17961. <summary>
  17962. Disposes of this object instance.
  17963. </summary>
  17964. </member>
  17965. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.CheckDisposed">
  17966. <summary>
  17967. Throws an <see cref="T:System.ObjectDisposedException"/> if this object
  17968. instance has been disposed.
  17969. </summary>
  17970. </member>
  17971. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.Dispose(System.Boolean)">
  17972. <summary>
  17973. Disposes of this object instance.
  17974. </summary>
  17975. <param name="disposing">
  17976. Non-zero if this method is being called from the
  17977. <see cref="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.Dispose"/> method. Zero if this method is being
  17978. called from the finalizer.
  17979. </param>
  17980. </member>
  17981. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.Finalize">
  17982. <summary>
  17983. Finalizes this object instance.
  17984. </summary>
  17985. </member>
  17986. <member name="T:System.Data.SQLite.SQLiteModuleCommon">
  17987. <summary>
  17988. This class contains some virtual methods that may be useful for other
  17989. virtual table classes. It specifically does NOT implement any of the
  17990. <see cref="T:System.Data.SQLite.ISQLiteManagedModule"/> interface methods.
  17991. </summary>
  17992. </member>
  17993. <member name="T:System.Data.SQLite.SQLiteModuleNoop">
  17994. <summary>
  17995. This class implements a virtual table module that does nothing by
  17996. providing "empty" implementations for all of the
  17997. <see cref="T:System.Data.SQLite.ISQLiteManagedModule"/> interface methods. The result
  17998. codes returned by these "empty" method implementations may be
  17999. controlled on a per-method basis by using and/or overriding the
  18000. <see cref="M:System.Data.SQLite.SQLiteModuleNoop.GetDefaultResultCode"/>,
  18001. <see cref="M:System.Data.SQLite.SQLiteModuleNoop.ResultCodeToEofResult(System.Data.SQLite.SQLiteErrorCode)"/>,
  18002. <see cref="M:System.Data.SQLite.SQLiteModuleNoop.ResultCodeToFindFunctionResult(System.Data.SQLite.SQLiteErrorCode)"/>,
  18003. <see cref="M:System.Data.SQLite.SQLiteModuleNoop.GetMethodResultCode(System.String)"/>, and
  18004. <see cref="M:System.Data.SQLite.SQLiteModuleNoop.SetMethodResultCode(System.String,System.Data.SQLite.SQLiteErrorCode)"/> methods from within derived classes.
  18005. </summary>
  18006. </member>
  18007. <member name="F:System.Data.SQLite.SQLiteModuleNoop.resultCodes">
  18008. <summary>
  18009. This field is used to store the <see cref="T:System.Data.SQLite.SQLiteErrorCode"/>
  18010. values to return, on a per-method basis, for all methods that are
  18011. part of the <see cref="T:System.Data.SQLite.ISQLiteManagedModule"/> interface.
  18012. </summary>
  18013. </member>
  18014. <member name="M:System.Data.SQLite.SQLiteModuleNoop.#ctor(System.String)">
  18015. <summary>
  18016. Constructs an instance of this class.
  18017. </summary>
  18018. <param name="name">
  18019. The name of the module. This parameter cannot be null.
  18020. </param>
  18021. </member>
  18022. <member name="M:System.Data.SQLite.SQLiteModuleNoop.GetDefaultResultCode">
  18023. <summary>
  18024. Determines the default <see cref="T:System.Data.SQLite.SQLiteErrorCode"/> value to be
  18025. returned by methods of the <see cref="T:System.Data.SQLite.ISQLiteManagedModule"/>
  18026. interface that lack an overridden implementation in all classes
  18027. derived from the <see cref="T:System.Data.SQLite.SQLiteModuleNoop"/> class.
  18028. </summary>
  18029. <returns>
  18030. The <see cref="T:System.Data.SQLite.SQLiteErrorCode"/> value that should be returned
  18031. by all <see cref="T:System.Data.SQLite.ISQLiteManagedModule"/> interface methods unless
  18032. a more specific result code has been set for that interface method.
  18033. </returns>
  18034. </member>
  18035. <member name="M:System.Data.SQLite.SQLiteModuleNoop.ResultCodeToEofResult(System.Data.SQLite.SQLiteErrorCode)">
  18036. <summary>
  18037. Converts a <see cref="T:System.Data.SQLite.SQLiteErrorCode"/> value into a boolean
  18038. return value for use with the
  18039. <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Eof(System.Data.SQLite.SQLiteVirtualTableCursor)"/> method.
  18040. </summary>
  18041. <param name="resultCode">
  18042. The <see cref="T:System.Data.SQLite.SQLiteErrorCode"/> value to convert.
  18043. </param>
  18044. <returns>
  18045. The <see cref="T:System.Boolean"/> value.
  18046. </returns>
  18047. </member>
  18048. <member name="M:System.Data.SQLite.SQLiteModuleNoop.ResultCodeToFindFunctionResult(System.Data.SQLite.SQLiteErrorCode)">
  18049. <summary>
  18050. Converts a <see cref="T:System.Data.SQLite.SQLiteErrorCode"/> value into a boolean
  18051. return value for use with the
  18052. <see cref="M:System.Data.SQLite.ISQLiteManagedModule.FindFunction(System.Data.SQLite.SQLiteVirtualTable,System.Int32,System.String,System.Data.SQLite.SQLiteFunction@,System.IntPtr@)"/> method.
  18053. </summary>
  18054. <param name="resultCode">
  18055. The <see cref="T:System.Data.SQLite.SQLiteErrorCode"/> value to convert.
  18056. </param>
  18057. <returns>
  18058. The <see cref="T:System.Boolean"/> value.
  18059. </returns>
  18060. </member>
  18061. <member name="M:System.Data.SQLite.SQLiteModuleNoop.GetMethodResultCode(System.String)">
  18062. <summary>
  18063. Determines the <see cref="T:System.Data.SQLite.SQLiteErrorCode"/> value that should be
  18064. returned by the specified <see cref="T:System.Data.SQLite.ISQLiteManagedModule"/>
  18065. interface method if it lack an overridden implementation. If no
  18066. specific <see cref="T:System.Data.SQLite.SQLiteErrorCode"/> value is available (or set)
  18067. for the specified method, the <see cref="T:System.Data.SQLite.SQLiteErrorCode"/> value
  18068. returned by the <see cref="M:System.Data.SQLite.SQLiteModuleNoop.GetDefaultResultCode"/> method will be
  18069. returned instead.
  18070. </summary>
  18071. <param name="methodName">
  18072. The name of the method. Currently, this method must be part of
  18073. the <see cref="T:System.Data.SQLite.ISQLiteManagedModule"/> interface.
  18074. </param>
  18075. <returns>
  18076. The <see cref="T:System.Data.SQLite.SQLiteErrorCode"/> value that should be returned
  18077. by the <see cref="T:System.Data.SQLite.ISQLiteManagedModule"/> interface method.
  18078. </returns>
  18079. </member>
  18080. <member name="M:System.Data.SQLite.SQLiteModuleNoop.SetMethodResultCode(System.String,System.Data.SQLite.SQLiteErrorCode)">
  18081. <summary>
  18082. Sets the <see cref="T:System.Data.SQLite.SQLiteErrorCode"/> value that should be
  18083. returned by the specified <see cref="T:System.Data.SQLite.ISQLiteManagedModule"/>
  18084. interface method if it lack an overridden implementation.
  18085. </summary>
  18086. <param name="methodName">
  18087. The name of the method. Currently, this method must be part of
  18088. the <see cref="T:System.Data.SQLite.ISQLiteManagedModule"/> interface.
  18089. </param>
  18090. <param name="resultCode">
  18091. The <see cref="T:System.Data.SQLite.SQLiteErrorCode"/> value that should be returned
  18092. by the <see cref="T:System.Data.SQLite.ISQLiteManagedModule"/> interface method.
  18093. </param>
  18094. <returns>
  18095. Non-zero upon success.
  18096. </returns>
  18097. </member>
  18098. <member name="M:System.Data.SQLite.SQLiteModuleNoop.Create(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)">
  18099. <summary>
  18100. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Create(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/> method.
  18101. </summary>
  18102. <param name="connection">
  18103. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Create(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/> method.
  18104. </param>
  18105. <param name="pClientData">
  18106. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Create(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/> method.
  18107. </param>
  18108. <param name="arguments">
  18109. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Create(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/> method.
  18110. </param>
  18111. <param name="table">
  18112. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Create(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/> method.
  18113. </param>
  18114. <param name="error">
  18115. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Create(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/> method.
  18116. </param>
  18117. <returns>
  18118. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Create(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/> method.
  18119. </returns>
  18120. </member>
  18121. <member name="M:System.Data.SQLite.SQLiteModuleNoop.Connect(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)">
  18122. <summary>
  18123. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Connect(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/> method.
  18124. </summary>
  18125. <param name="connection">
  18126. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Connect(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/> method.
  18127. </param>
  18128. <param name="pClientData">
  18129. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Connect(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/> method.
  18130. </param>
  18131. <param name="arguments">
  18132. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Connect(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/> method.
  18133. </param>
  18134. <param name="table">
  18135. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Connect(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/> method.
  18136. </param>
  18137. <param name="error">
  18138. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Connect(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/> method.
  18139. </param>
  18140. <returns>
  18141. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Connect(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/> method.
  18142. </returns>
  18143. </member>
  18144. <member name="M:System.Data.SQLite.SQLiteModuleNoop.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)">
  18145. <summary>
  18146. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)"/> method.
  18147. </summary>
  18148. <param name="table">
  18149. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)"/> method.
  18150. </param>
  18151. <param name="index">
  18152. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)"/> method.
  18153. </param>
  18154. <returns>
  18155. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)"/> method.
  18156. </returns>
  18157. </member>
  18158. <member name="M:System.Data.SQLite.SQLiteModuleNoop.Disconnect(System.Data.SQLite.SQLiteVirtualTable)">
  18159. <summary>
  18160. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Disconnect(System.Data.SQLite.SQLiteVirtualTable)"/> method.
  18161. </summary>
  18162. <param name="table">
  18163. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Disconnect(System.Data.SQLite.SQLiteVirtualTable)"/> method.
  18164. </param>
  18165. <returns>
  18166. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Disconnect(System.Data.SQLite.SQLiteVirtualTable)"/> method.
  18167. </returns>
  18168. </member>
  18169. <member name="M:System.Data.SQLite.SQLiteModuleNoop.Destroy(System.Data.SQLite.SQLiteVirtualTable)">
  18170. <summary>
  18171. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Destroy(System.Data.SQLite.SQLiteVirtualTable)"/> method.
  18172. </summary>
  18173. <param name="table">
  18174. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Destroy(System.Data.SQLite.SQLiteVirtualTable)"/> method.
  18175. </param>
  18176. <returns>
  18177. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Destroy(System.Data.SQLite.SQLiteVirtualTable)"/> method.
  18178. </returns>
  18179. </member>
  18180. <member name="M:System.Data.SQLite.SQLiteModuleNoop.Open(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteVirtualTableCursor@)">
  18181. <summary>
  18182. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Open(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteVirtualTableCursor@)"/> method.
  18183. </summary>
  18184. <param name="table">
  18185. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Open(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteVirtualTableCursor@)"/> method.
  18186. </param>
  18187. <param name="cursor">
  18188. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Open(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteVirtualTableCursor@)"/> method.
  18189. </param>
  18190. <returns>
  18191. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Open(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteVirtualTableCursor@)"/> method.
  18192. </returns>
  18193. </member>
  18194. <member name="M:System.Data.SQLite.SQLiteModuleNoop.Close(System.Data.SQLite.SQLiteVirtualTableCursor)">
  18195. <summary>
  18196. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Close(System.Data.SQLite.SQLiteVirtualTableCursor)"/> method.
  18197. </summary>
  18198. <param name="cursor">
  18199. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Close(System.Data.SQLite.SQLiteVirtualTableCursor)"/> method.
  18200. </param>
  18201. <returns>
  18202. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Close(System.Data.SQLite.SQLiteVirtualTableCursor)"/> method.
  18203. </returns>
  18204. </member>
  18205. <member name="M:System.Data.SQLite.SQLiteModuleNoop.Filter(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int32,System.String,System.Data.SQLite.SQLiteValue[])">
  18206. <summary>
  18207. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Filter(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int32,System.String,System.Data.SQLite.SQLiteValue[])"/> method.
  18208. </summary>
  18209. <param name="cursor">
  18210. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Filter(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int32,System.String,System.Data.SQLite.SQLiteValue[])"/> method.
  18211. </param>
  18212. <param name="indexNumber">
  18213. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Filter(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int32,System.String,System.Data.SQLite.SQLiteValue[])"/> method.
  18214. </param>
  18215. <param name="indexString">
  18216. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Filter(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int32,System.String,System.Data.SQLite.SQLiteValue[])"/> method.
  18217. </param>
  18218. <param name="values">
  18219. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Filter(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int32,System.String,System.Data.SQLite.SQLiteValue[])"/> method.
  18220. </param>
  18221. <returns>
  18222. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Filter(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int32,System.String,System.Data.SQLite.SQLiteValue[])"/> method.
  18223. </returns>
  18224. </member>
  18225. <member name="M:System.Data.SQLite.SQLiteModuleNoop.Next(System.Data.SQLite.SQLiteVirtualTableCursor)">
  18226. <summary>
  18227. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Next(System.Data.SQLite.SQLiteVirtualTableCursor)"/> method.
  18228. </summary>
  18229. <param name="cursor">
  18230. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Next(System.Data.SQLite.SQLiteVirtualTableCursor)"/> method.
  18231. </param>
  18232. <returns>
  18233. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Next(System.Data.SQLite.SQLiteVirtualTableCursor)"/> method.
  18234. </returns>
  18235. </member>
  18236. <member name="M:System.Data.SQLite.SQLiteModuleNoop.Eof(System.Data.SQLite.SQLiteVirtualTableCursor)">
  18237. <summary>
  18238. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Eof(System.Data.SQLite.SQLiteVirtualTableCursor)"/> method.
  18239. </summary>
  18240. <param name="cursor">
  18241. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Eof(System.Data.SQLite.SQLiteVirtualTableCursor)"/> method.
  18242. </param>
  18243. <returns>
  18244. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Eof(System.Data.SQLite.SQLiteVirtualTableCursor)"/> method.
  18245. </returns>
  18246. </member>
  18247. <member name="M:System.Data.SQLite.SQLiteModuleNoop.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)">
  18248. <summary>
  18249. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)"/> method.
  18250. </summary>
  18251. <param name="cursor">
  18252. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)"/> method.
  18253. </param>
  18254. <param name="context">
  18255. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)"/> method.
  18256. </param>
  18257. <param name="index">
  18258. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)"/> method.
  18259. </param>
  18260. <returns>
  18261. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)"/> method.
  18262. </returns>
  18263. </member>
  18264. <member name="M:System.Data.SQLite.SQLiteModuleNoop.RowId(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int64@)">
  18265. <summary>
  18266. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.RowId(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int64@)"/> method.
  18267. </summary>
  18268. <param name="cursor">
  18269. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.RowId(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int64@)"/> method.
  18270. </param>
  18271. <param name="rowId">
  18272. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.RowId(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int64@)"/> method.
  18273. </param>
  18274. <returns>
  18275. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.RowId(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int64@)"/> method.
  18276. </returns>
  18277. </member>
  18278. <member name="M:System.Data.SQLite.SQLiteModuleNoop.Update(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteValue[],System.Int64@)">
  18279. <summary>
  18280. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Update(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteValue[],System.Int64@)"/> method.
  18281. </summary>
  18282. <param name="table">
  18283. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Update(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteValue[],System.Int64@)"/> method.
  18284. </param>
  18285. <param name="values">
  18286. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Update(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteValue[],System.Int64@)"/> method.
  18287. </param>
  18288. <param name="rowId">
  18289. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Update(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteValue[],System.Int64@)"/> method.
  18290. </param>
  18291. <returns>
  18292. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Update(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteValue[],System.Int64@)"/> method.
  18293. </returns>
  18294. </member>
  18295. <member name="M:System.Data.SQLite.SQLiteModuleNoop.Begin(System.Data.SQLite.SQLiteVirtualTable)">
  18296. <summary>
  18297. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Begin(System.Data.SQLite.SQLiteVirtualTable)"/> method.
  18298. </summary>
  18299. <param name="table">
  18300. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Begin(System.Data.SQLite.SQLiteVirtualTable)"/> method.
  18301. </param>
  18302. <returns>
  18303. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Begin(System.Data.SQLite.SQLiteVirtualTable)"/> method.
  18304. </returns>
  18305. </member>
  18306. <member name="M:System.Data.SQLite.SQLiteModuleNoop.Sync(System.Data.SQLite.SQLiteVirtualTable)">
  18307. <summary>
  18308. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Sync(System.Data.SQLite.SQLiteVirtualTable)"/> method.
  18309. </summary>
  18310. <param name="table">
  18311. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Sync(System.Data.SQLite.SQLiteVirtualTable)"/> method.
  18312. </param>
  18313. <returns>
  18314. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Sync(System.Data.SQLite.SQLiteVirtualTable)"/> method.
  18315. </returns>
  18316. </member>
  18317. <member name="M:System.Data.SQLite.SQLiteModuleNoop.Commit(System.Data.SQLite.SQLiteVirtualTable)">
  18318. <summary>
  18319. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Commit(System.Data.SQLite.SQLiteVirtualTable)"/> method.
  18320. </summary>
  18321. <param name="table">
  18322. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Commit(System.Data.SQLite.SQLiteVirtualTable)"/> method.
  18323. </param>
  18324. <returns>
  18325. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Commit(System.Data.SQLite.SQLiteVirtualTable)"/> method.
  18326. </returns>
  18327. </member>
  18328. <member name="M:System.Data.SQLite.SQLiteModuleNoop.Rollback(System.Data.SQLite.SQLiteVirtualTable)">
  18329. <summary>
  18330. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Rollback(System.Data.SQLite.SQLiteVirtualTable)"/> method.
  18331. </summary>
  18332. <param name="table">
  18333. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Rollback(System.Data.SQLite.SQLiteVirtualTable)"/> method.
  18334. </param>
  18335. <returns>
  18336. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Rollback(System.Data.SQLite.SQLiteVirtualTable)"/> method.
  18337. </returns>
  18338. </member>
  18339. <member name="M:System.Data.SQLite.SQLiteModuleNoop.FindFunction(System.Data.SQLite.SQLiteVirtualTable,System.Int32,System.String,System.Data.SQLite.SQLiteFunction@,System.IntPtr@)">
  18340. <summary>
  18341. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.FindFunction(System.Data.SQLite.SQLiteVirtualTable,System.Int32,System.String,System.Data.SQLite.SQLiteFunction@,System.IntPtr@)"/> method.
  18342. </summary>
  18343. <param name="table">
  18344. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.FindFunction(System.Data.SQLite.SQLiteVirtualTable,System.Int32,System.String,System.Data.SQLite.SQLiteFunction@,System.IntPtr@)"/> method.
  18345. </param>
  18346. <param name="argumentCount">
  18347. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.FindFunction(System.Data.SQLite.SQLiteVirtualTable,System.Int32,System.String,System.Data.SQLite.SQLiteFunction@,System.IntPtr@)"/> method.
  18348. </param>
  18349. <param name="name">
  18350. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.FindFunction(System.Data.SQLite.SQLiteVirtualTable,System.Int32,System.String,System.Data.SQLite.SQLiteFunction@,System.IntPtr@)"/> method.
  18351. </param>
  18352. <param name="function">
  18353. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.FindFunction(System.Data.SQLite.SQLiteVirtualTable,System.Int32,System.String,System.Data.SQLite.SQLiteFunction@,System.IntPtr@)"/> method.
  18354. </param>
  18355. <param name="pClientData">
  18356. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.FindFunction(System.Data.SQLite.SQLiteVirtualTable,System.Int32,System.String,System.Data.SQLite.SQLiteFunction@,System.IntPtr@)"/> method.
  18357. </param>
  18358. <returns>
  18359. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.FindFunction(System.Data.SQLite.SQLiteVirtualTable,System.Int32,System.String,System.Data.SQLite.SQLiteFunction@,System.IntPtr@)"/> method.
  18360. </returns>
  18361. </member>
  18362. <member name="M:System.Data.SQLite.SQLiteModuleNoop.Rename(System.Data.SQLite.SQLiteVirtualTable,System.String)">
  18363. <summary>
  18364. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Rename(System.Data.SQLite.SQLiteVirtualTable,System.String)"/> method.
  18365. </summary>
  18366. <param name="table">
  18367. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Rename(System.Data.SQLite.SQLiteVirtualTable,System.String)"/> method.
  18368. </param>
  18369. <param name="newName">
  18370. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Rename(System.Data.SQLite.SQLiteVirtualTable,System.String)"/> method.
  18371. </param>
  18372. <returns>
  18373. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Rename(System.Data.SQLite.SQLiteVirtualTable,System.String)"/> method.
  18374. </returns>
  18375. </member>
  18376. <member name="M:System.Data.SQLite.SQLiteModuleNoop.Savepoint(System.Data.SQLite.SQLiteVirtualTable,System.Int32)">
  18377. <summary>
  18378. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Savepoint(System.Data.SQLite.SQLiteVirtualTable,System.Int32)"/> method.
  18379. </summary>
  18380. <param name="table">
  18381. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Savepoint(System.Data.SQLite.SQLiteVirtualTable,System.Int32)"/> method.
  18382. </param>
  18383. <param name="savepoint">
  18384. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Savepoint(System.Data.SQLite.SQLiteVirtualTable,System.Int32)"/> method.
  18385. </param>
  18386. <returns>
  18387. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Savepoint(System.Data.SQLite.SQLiteVirtualTable,System.Int32)"/> method.
  18388. </returns>
  18389. </member>
  18390. <member name="M:System.Data.SQLite.SQLiteModuleNoop.Release(System.Data.SQLite.SQLiteVirtualTable,System.Int32)">
  18391. <summary>
  18392. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Release(System.Data.SQLite.SQLiteVirtualTable,System.Int32)"/> method.
  18393. </summary>
  18394. <param name="table">
  18395. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Release(System.Data.SQLite.SQLiteVirtualTable,System.Int32)"/> method.
  18396. </param>
  18397. <param name="savepoint">
  18398. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Release(System.Data.SQLite.SQLiteVirtualTable,System.Int32)"/> method.
  18399. </param>
  18400. <returns>
  18401. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Release(System.Data.SQLite.SQLiteVirtualTable,System.Int32)"/> method.
  18402. </returns>
  18403. </member>
  18404. <member name="M:System.Data.SQLite.SQLiteModuleNoop.RollbackTo(System.Data.SQLite.SQLiteVirtualTable,System.Int32)">
  18405. <summary>
  18406. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.RollbackTo(System.Data.SQLite.SQLiteVirtualTable,System.Int32)"/> method.
  18407. </summary>
  18408. <param name="table">
  18409. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.RollbackTo(System.Data.SQLite.SQLiteVirtualTable,System.Int32)"/> method.
  18410. </param>
  18411. <param name="savepoint">
  18412. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.RollbackTo(System.Data.SQLite.SQLiteVirtualTable,System.Int32)"/> method.
  18413. </param>
  18414. <returns>
  18415. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.RollbackTo(System.Data.SQLite.SQLiteVirtualTable,System.Int32)"/> method.
  18416. </returns>
  18417. </member>
  18418. <member name="M:System.Data.SQLite.SQLiteModuleNoop.CheckDisposed">
  18419. <summary>
  18420. Throws an <see cref="T:System.ObjectDisposedException"/> if this object
  18421. instance has been disposed.
  18422. </summary>
  18423. </member>
  18424. <member name="M:System.Data.SQLite.SQLiteModuleNoop.Dispose(System.Boolean)">
  18425. <summary>
  18426. Disposes of this object instance.
  18427. </summary>
  18428. <param name="disposing">
  18429. Non-zero if this method is being called from the
  18430. <see cref="M:System.IDisposable.Dispose"/> method. Zero if this method is
  18431. being called from the finalizer.
  18432. </param>
  18433. </member>
  18434. <member name="F:System.Data.SQLite.SQLiteModuleCommon.declareSql">
  18435. <summary>
  18436. The CREATE TABLE statement used to declare the schema for the
  18437. virtual table.
  18438. </summary>
  18439. </member>
  18440. <member name="F:System.Data.SQLite.SQLiteModuleCommon.objectIdentity">
  18441. <summary>
  18442. Non-zero if different object instances with the same value should
  18443. generate different row identifiers, where applicable. This has no
  18444. effect on the .NET Compact Framework.
  18445. </summary>
  18446. </member>
  18447. <member name="M:System.Data.SQLite.SQLiteModuleCommon.#ctor(System.String)">
  18448. <summary>
  18449. Constructs an instance of this class.
  18450. </summary>
  18451. <param name="name">
  18452. The name of the module. This parameter cannot be null.
  18453. </param>
  18454. </member>
  18455. <member name="M:System.Data.SQLite.SQLiteModuleCommon.#ctor(System.String,System.Boolean)">
  18456. <summary>
  18457. Constructs an instance of this class.
  18458. </summary>
  18459. <param name="name">
  18460. The name of the module. This parameter cannot be null.
  18461. </param>
  18462. <param name="objectIdentity">
  18463. Non-zero if different object instances with the same value should
  18464. generate different row identifiers, where applicable. This
  18465. parameter has no effect on the .NET Compact Framework.
  18466. </param>
  18467. </member>
  18468. <member name="M:System.Data.SQLite.SQLiteModuleCommon.GetSqlForDeclareTable">
  18469. <summary>
  18470. Determines the SQL statement used to declare the virtual table.
  18471. This method should be overridden in derived classes if they require
  18472. a custom virtual table schema.
  18473. </summary>
  18474. <returns>
  18475. The SQL statement used to declare the virtual table -OR- null if it
  18476. cannot be determined.
  18477. </returns>
  18478. </member>
  18479. <member name="M:System.Data.SQLite.SQLiteModuleCommon.CursorTypeMismatchError(System.Data.SQLite.SQLiteVirtualTableCursor,System.Type)">
  18480. <summary>
  18481. Sets the table error message to one that indicates the virtual
  18482. table cursor is of the wrong type.
  18483. </summary>
  18484. <param name="cursor">
  18485. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor"/> object instance.
  18486. </param>
  18487. <param name="type">
  18488. The <see cref="T:System.Type"/> that the virtual table cursor should be.
  18489. </param>
  18490. <returns>
  18491. The value of <see cref="F:System.Data.SQLite.SQLiteErrorCode.Error"/>.
  18492. </returns>
  18493. </member>
  18494. <member name="M:System.Data.SQLite.SQLiteModuleCommon.GetStringFromObject(System.Data.SQLite.SQLiteVirtualTableCursor,System.Object)">
  18495. <summary>
  18496. Determines the string to return as the column value for the object
  18497. instance value.
  18498. </summary>
  18499. <param name="cursor">
  18500. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor"/> object instance
  18501. associated with the previously opened virtual table cursor to be
  18502. used.
  18503. </param>
  18504. <param name="value">
  18505. The object instance to return a string representation for.
  18506. </param>
  18507. <returns>
  18508. The string representation of the specified object instance or null
  18509. upon failure.
  18510. </returns>
  18511. </member>
  18512. <member name="M:System.Data.SQLite.SQLiteModuleCommon.MakeRowId(System.Int32,System.Int32)">
  18513. <summary>
  18514. Constructs an <see cref="T:System.Int64"/> unique row identifier from two
  18515. <see cref="T:System.Int32"/> values. The first <see cref="T:System.Int32"/> value
  18516. must contain the row sequence number for the current row and the
  18517. second value must contain the hash code of the key column value
  18518. for the current row.
  18519. </summary>
  18520. <param name="rowIndex">
  18521. The integer row sequence number for the current row.
  18522. </param>
  18523. <param name="hashCode">
  18524. The hash code of the key column value for the current row.
  18525. </param>
  18526. <returns>
  18527. The unique row identifier or zero upon failure.
  18528. </returns>
  18529. </member>
  18530. <member name="M:System.Data.SQLite.SQLiteModuleCommon.GetRowIdFromObject(System.Data.SQLite.SQLiteVirtualTableCursor,System.Object)">
  18531. <summary>
  18532. Determines the unique row identifier for the current row.
  18533. </summary>
  18534. <param name="cursor">
  18535. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor"/> object instance
  18536. associated with the previously opened virtual table cursor to be
  18537. used.
  18538. </param>
  18539. <param name="value">
  18540. The object instance to return a unique row identifier for.
  18541. </param>
  18542. <returns>
  18543. The unique row identifier or zero upon failure.
  18544. </returns>
  18545. </member>
  18546. <member name="M:System.Data.SQLite.SQLiteModuleCommon.CheckDisposed">
  18547. <summary>
  18548. Throws an <see cref="T:System.ObjectDisposedException"/> if this object
  18549. instance has been disposed.
  18550. </summary>
  18551. </member>
  18552. <member name="M:System.Data.SQLite.SQLiteModuleCommon.Dispose(System.Boolean)">
  18553. <summary>
  18554. Disposes of this object instance.
  18555. </summary>
  18556. <param name="disposing">
  18557. Non-zero if this method is being called from the
  18558. <see cref="M:System.IDisposable.Dispose"/> method. Zero if this method is
  18559. being called from the finalizer.
  18560. </param>
  18561. </member>
  18562. <member name="T:System.Data.SQLite.SQLiteVirtualTableCursorEnumerator">
  18563. <summary>
  18564. This class represents a virtual table cursor to be used with the
  18565. <see cref="T:System.Data.SQLite.SQLiteModuleEnumerable"/> class. It is not sealed and may
  18566. be used as the base class for any user-defined virtual table cursor
  18567. class that wraps an <see cref="T:System.Collections.IEnumerator"/> object instance.
  18568. </summary>
  18569. </member>
  18570. <member name="F:System.Data.SQLite.SQLiteVirtualTableCursorEnumerator.enumerator">
  18571. <summary>
  18572. The <see cref="T:System.Collections.IEnumerator"/> instance provided when this cursor
  18573. was created.
  18574. </summary>
  18575. </member>
  18576. <member name="F:System.Data.SQLite.SQLiteVirtualTableCursorEnumerator.endOfEnumerator">
  18577. <summary>
  18578. This value will be non-zero if false has been returned from the
  18579. <see cref="M:System.Collections.IEnumerator.MoveNext"/> method.
  18580. </summary>
  18581. </member>
  18582. <member name="M:System.Data.SQLite.SQLiteVirtualTableCursorEnumerator.#ctor(System.Data.SQLite.SQLiteVirtualTable,System.Collections.IEnumerator)">
  18583. <summary>
  18584. Constructs an instance of this class.
  18585. </summary>
  18586. <param name="table">
  18587. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance associated
  18588. with this object instance.
  18589. </param>
  18590. <param name="enumerator">
  18591. The <see cref="T:System.Collections.IEnumerator"/> instance to expose as a virtual
  18592. table cursor.
  18593. </param>
  18594. </member>
  18595. <member name="M:System.Data.SQLite.SQLiteVirtualTableCursorEnumerator.MoveNext">
  18596. <summary>
  18597. Advances to the next row of the virtual table cursor using the
  18598. <see cref="M:System.Collections.IEnumerator.MoveNext"/> method of the
  18599. <see cref="T:System.Collections.IEnumerator"/> object instance.
  18600. </summary>
  18601. <returns>
  18602. Non-zero if the current row is valid; zero otherwise. If zero is
  18603. returned, no further rows are available.
  18604. </returns>
  18605. </member>
  18606. <member name="M:System.Data.SQLite.SQLiteVirtualTableCursorEnumerator.Reset">
  18607. <summary>
  18608. Resets the virtual table cursor position, also invalidating the
  18609. current row, using the <see cref="M:System.Collections.IEnumerator.Reset"/> method of
  18610. the <see cref="T:System.Collections.IEnumerator"/> object instance.
  18611. </summary>
  18612. </member>
  18613. <member name="M:System.Data.SQLite.SQLiteVirtualTableCursorEnumerator.Close">
  18614. <summary>
  18615. Closes the virtual table cursor. This method must not throw any
  18616. exceptions.
  18617. </summary>
  18618. </member>
  18619. <member name="M:System.Data.SQLite.SQLiteVirtualTableCursorEnumerator.CheckClosed">
  18620. <summary>
  18621. Throws an <see cref="T:System.InvalidOperationException"/> if the virtual
  18622. table cursor has been closed.
  18623. </summary>
  18624. </member>
  18625. <member name="M:System.Data.SQLite.SQLiteVirtualTableCursorEnumerator.CheckDisposed">
  18626. <summary>
  18627. Throws an <see cref="T:System.ObjectDisposedException"/> if this object
  18628. instance has been disposed.
  18629. </summary>
  18630. </member>
  18631. <member name="M:System.Data.SQLite.SQLiteVirtualTableCursorEnumerator.Dispose(System.Boolean)">
  18632. <summary>
  18633. Disposes of this object instance.
  18634. </summary>
  18635. <param name="disposing">
  18636. Non-zero if this method is being called from the
  18637. <see cref="M:System.IDisposable.Dispose"/> method. Zero if this method is
  18638. being called from the finalizer.
  18639. </param>
  18640. </member>
  18641. <member name="P:System.Data.SQLite.SQLiteVirtualTableCursorEnumerator.Current">
  18642. <summary>
  18643. Returns the value for the current row of the virtual table cursor
  18644. using the <see cref="P:System.Collections.IEnumerator.Current"/> property of the
  18645. <see cref="T:System.Collections.IEnumerator"/> object instance.
  18646. </summary>
  18647. </member>
  18648. <member name="P:System.Data.SQLite.SQLiteVirtualTableCursorEnumerator.EndOfEnumerator">
  18649. <summary>
  18650. Returns non-zero if the end of the virtual table cursor has been
  18651. seen (i.e. no more rows are available, including the current one).
  18652. </summary>
  18653. </member>
  18654. <member name="P:System.Data.SQLite.SQLiteVirtualTableCursorEnumerator.IsOpen">
  18655. <summary>
  18656. Returns non-zero if the virtual table cursor is open.
  18657. </summary>
  18658. </member>
  18659. <member name="T:System.Data.SQLite.SQLiteModuleEnumerable">
  18660. <summary>
  18661. This class implements a virtual table module that exposes an
  18662. <see cref="T:System.Collections.IEnumerable"/> object instance as a read-only virtual
  18663. table. It is not sealed and may be used as the base class for any
  18664. user-defined virtual table class that wraps an
  18665. <see cref="T:System.Collections.IEnumerable"/> object instance. The following short
  18666. example shows it being used to treat an array of strings as a table
  18667. data source:
  18668. <code>
  18669. public static class Sample
  18670. {
  18671. public static void Main()
  18672. {
  18673. using (SQLiteConnection connection = new SQLiteConnection(
  18674. "Data Source=:memory:;"))
  18675. {
  18676. connection.Open();
  18677. connection.CreateModule(new SQLiteModuleEnumerable(
  18678. "sampleModule", new string[] { "one", "two", "three" }));
  18679. using (SQLiteCommand command = connection.CreateCommand())
  18680. {
  18681. command.CommandText =
  18682. "CREATE VIRTUAL TABLE t1 USING sampleModule;";
  18683. command.ExecuteNonQuery();
  18684. }
  18685. using (SQLiteCommand command = connection.CreateCommand())
  18686. {
  18687. command.CommandText = "SELECT * FROM t1;";
  18688. using (SQLiteDataReader dataReader = command.ExecuteReader())
  18689. {
  18690. while (dataReader.Read())
  18691. Console.WriteLine(dataReader[0].ToString());
  18692. }
  18693. }
  18694. connection.Close();
  18695. }
  18696. }
  18697. }
  18698. </code>
  18699. </summary>
  18700. </member>
  18701. <member name="F:System.Data.SQLite.SQLiteModuleEnumerable.enumerable">
  18702. <summary>
  18703. The <see cref="T:System.Collections.IEnumerable"/> instance containing the backing data
  18704. for the virtual table.
  18705. </summary>
  18706. </member>
  18707. <member name="F:System.Data.SQLite.SQLiteModuleEnumerable.objectIdentity">
  18708. <summary>
  18709. Non-zero if different object instances with the same value should
  18710. generate different row identifiers, where applicable. This has no
  18711. effect on the .NET Compact Framework.
  18712. </summary>
  18713. </member>
  18714. <member name="M:System.Data.SQLite.SQLiteModuleEnumerable.#ctor(System.String,System.Collections.IEnumerable)">
  18715. <summary>
  18716. Constructs an instance of this class.
  18717. </summary>
  18718. <param name="name">
  18719. The name of the module. This parameter cannot be null.
  18720. </param>
  18721. <param name="enumerable">
  18722. The <see cref="T:System.Collections.IEnumerable"/> instance to expose as a virtual
  18723. table. This parameter cannot be null.
  18724. </param>
  18725. </member>
  18726. <member name="M:System.Data.SQLite.SQLiteModuleEnumerable.#ctor(System.String,System.Collections.IEnumerable,System.Boolean)">
  18727. <summary>
  18728. Constructs an instance of this class.
  18729. </summary>
  18730. <param name="name">
  18731. The name of the module. This parameter cannot be null.
  18732. </param>
  18733. <param name="enumerable">
  18734. The <see cref="T:System.Collections.IEnumerable"/> instance to expose as a virtual
  18735. table. This parameter cannot be null.
  18736. </param>
  18737. <param name="objectIdentity">
  18738. Non-zero if different object instances with the same value should
  18739. generate different row identifiers, where applicable. This
  18740. parameter has no effect on the .NET Compact Framework.
  18741. </param>
  18742. </member>
  18743. <member name="M:System.Data.SQLite.SQLiteModuleEnumerable.CursorEndOfEnumeratorError(System.Data.SQLite.SQLiteVirtualTableCursor)">
  18744. <summary>
  18745. Sets the table error message to one that indicates the virtual
  18746. table cursor has no current row.
  18747. </summary>
  18748. <param name="cursor">
  18749. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor"/> object instance.
  18750. </param>
  18751. <returns>
  18752. The value of <see cref="F:System.Data.SQLite.SQLiteErrorCode.Error"/>.
  18753. </returns>
  18754. </member>
  18755. <member name="M:System.Data.SQLite.SQLiteModuleEnumerable.Create(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)">
  18756. <summary>
  18757. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Create(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/> method.
  18758. </summary>
  18759. <param name="connection">
  18760. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Create(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/> method.
  18761. </param>
  18762. <param name="pClientData">
  18763. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Create(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/> method.
  18764. </param>
  18765. <param name="arguments">
  18766. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Create(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/> method.
  18767. </param>
  18768. <param name="table">
  18769. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Create(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/> method.
  18770. </param>
  18771. <param name="error">
  18772. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Create(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/> method.
  18773. </param>
  18774. <returns>
  18775. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Create(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/> method.
  18776. </returns>
  18777. </member>
  18778. <member name="M:System.Data.SQLite.SQLiteModuleEnumerable.Connect(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)">
  18779. <summary>
  18780. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Connect(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/> method.
  18781. </summary>
  18782. <param name="connection">
  18783. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Connect(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/> method.
  18784. </param>
  18785. <param name="pClientData">
  18786. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Connect(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/> method.
  18787. </param>
  18788. <param name="arguments">
  18789. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Connect(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/> method.
  18790. </param>
  18791. <param name="table">
  18792. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Connect(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/> method.
  18793. </param>
  18794. <param name="error">
  18795. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Connect(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/> method.
  18796. </param>
  18797. <returns>
  18798. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Connect(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)"/> method.
  18799. </returns>
  18800. </member>
  18801. <member name="M:System.Data.SQLite.SQLiteModuleEnumerable.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)">
  18802. <summary>
  18803. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)"/> method.
  18804. </summary>
  18805. <param name="table">
  18806. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)"/> method.
  18807. </param>
  18808. <param name="index">
  18809. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)"/> method.
  18810. </param>
  18811. <returns>
  18812. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)"/> method.
  18813. </returns>
  18814. </member>
  18815. <member name="M:System.Data.SQLite.SQLiteModuleEnumerable.Disconnect(System.Data.SQLite.SQLiteVirtualTable)">
  18816. <summary>
  18817. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Disconnect(System.Data.SQLite.SQLiteVirtualTable)"/> method.
  18818. </summary>
  18819. <param name="table">
  18820. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Disconnect(System.Data.SQLite.SQLiteVirtualTable)"/> method.
  18821. </param>
  18822. <returns>
  18823. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Disconnect(System.Data.SQLite.SQLiteVirtualTable)"/> method.
  18824. </returns>
  18825. </member>
  18826. <member name="M:System.Data.SQLite.SQLiteModuleEnumerable.Destroy(System.Data.SQLite.SQLiteVirtualTable)">
  18827. <summary>
  18828. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Destroy(System.Data.SQLite.SQLiteVirtualTable)"/> method.
  18829. </summary>
  18830. <param name="table">
  18831. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Destroy(System.Data.SQLite.SQLiteVirtualTable)"/> method.
  18832. </param>
  18833. <returns>
  18834. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Destroy(System.Data.SQLite.SQLiteVirtualTable)"/> method.
  18835. </returns>
  18836. </member>
  18837. <member name="M:System.Data.SQLite.SQLiteModuleEnumerable.Open(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteVirtualTableCursor@)">
  18838. <summary>
  18839. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Open(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteVirtualTableCursor@)"/> method.
  18840. </summary>
  18841. <param name="table">
  18842. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Open(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteVirtualTableCursor@)"/> method.
  18843. </param>
  18844. <param name="cursor">
  18845. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Open(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteVirtualTableCursor@)"/> method.
  18846. </param>
  18847. <returns>
  18848. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Open(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteVirtualTableCursor@)"/> method.
  18849. </returns>
  18850. </member>
  18851. <member name="M:System.Data.SQLite.SQLiteModuleEnumerable.Close(System.Data.SQLite.SQLiteVirtualTableCursor)">
  18852. <summary>
  18853. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Close(System.Data.SQLite.SQLiteVirtualTableCursor)"/> method.
  18854. </summary>
  18855. <param name="cursor">
  18856. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Close(System.Data.SQLite.SQLiteVirtualTableCursor)"/> method.
  18857. </param>
  18858. <returns>
  18859. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Close(System.Data.SQLite.SQLiteVirtualTableCursor)"/> method.
  18860. </returns>
  18861. </member>
  18862. <member name="M:System.Data.SQLite.SQLiteModuleEnumerable.Filter(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int32,System.String,System.Data.SQLite.SQLiteValue[])">
  18863. <summary>
  18864. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Filter(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int32,System.String,System.Data.SQLite.SQLiteValue[])"/> method.
  18865. </summary>
  18866. <param name="cursor">
  18867. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Filter(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int32,System.String,System.Data.SQLite.SQLiteValue[])"/> method.
  18868. </param>
  18869. <param name="indexNumber">
  18870. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Filter(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int32,System.String,System.Data.SQLite.SQLiteValue[])"/> method.
  18871. </param>
  18872. <param name="indexString">
  18873. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Filter(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int32,System.String,System.Data.SQLite.SQLiteValue[])"/> method.
  18874. </param>
  18875. <param name="values">
  18876. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Filter(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int32,System.String,System.Data.SQLite.SQLiteValue[])"/> method.
  18877. </param>
  18878. <returns>
  18879. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Filter(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int32,System.String,System.Data.SQLite.SQLiteValue[])"/> method.
  18880. </returns>
  18881. </member>
  18882. <member name="M:System.Data.SQLite.SQLiteModuleEnumerable.Next(System.Data.SQLite.SQLiteVirtualTableCursor)">
  18883. <summary>
  18884. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Next(System.Data.SQLite.SQLiteVirtualTableCursor)"/> method.
  18885. </summary>
  18886. <param name="cursor">
  18887. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Next(System.Data.SQLite.SQLiteVirtualTableCursor)"/> method.
  18888. </param>
  18889. <returns>
  18890. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Next(System.Data.SQLite.SQLiteVirtualTableCursor)"/> method.
  18891. </returns>
  18892. </member>
  18893. <member name="M:System.Data.SQLite.SQLiteModuleEnumerable.Eof(System.Data.SQLite.SQLiteVirtualTableCursor)">
  18894. <summary>
  18895. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Eof(System.Data.SQLite.SQLiteVirtualTableCursor)"/> method.
  18896. </summary>
  18897. <param name="cursor">
  18898. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Eof(System.Data.SQLite.SQLiteVirtualTableCursor)"/> method.
  18899. </param>
  18900. <returns>
  18901. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Eof(System.Data.SQLite.SQLiteVirtualTableCursor)"/> method.
  18902. </returns>
  18903. </member>
  18904. <member name="M:System.Data.SQLite.SQLiteModuleEnumerable.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)">
  18905. <summary>
  18906. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)"/> method.
  18907. </summary>
  18908. <param name="cursor">
  18909. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)"/> method.
  18910. </param>
  18911. <param name="context">
  18912. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)"/> method.
  18913. </param>
  18914. <param name="index">
  18915. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)"/> method.
  18916. </param>
  18917. <returns>
  18918. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)"/> method.
  18919. </returns>
  18920. </member>
  18921. <member name="M:System.Data.SQLite.SQLiteModuleEnumerable.RowId(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int64@)">
  18922. <summary>
  18923. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.RowId(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int64@)"/> method.
  18924. </summary>
  18925. <param name="cursor">
  18926. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.RowId(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int64@)"/> method.
  18927. </param>
  18928. <param name="rowId">
  18929. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.RowId(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int64@)"/> method.
  18930. </param>
  18931. <returns>
  18932. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.RowId(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int64@)"/> method.
  18933. </returns>
  18934. </member>
  18935. <member name="M:System.Data.SQLite.SQLiteModuleEnumerable.Update(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteValue[],System.Int64@)">
  18936. <summary>
  18937. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Update(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteValue[],System.Int64@)"/> method.
  18938. </summary>
  18939. <param name="table">
  18940. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Update(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteValue[],System.Int64@)"/> method.
  18941. </param>
  18942. <param name="values">
  18943. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Update(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteValue[],System.Int64@)"/> method.
  18944. </param>
  18945. <param name="rowId">
  18946. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Update(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteValue[],System.Int64@)"/> method.
  18947. </param>
  18948. <returns>
  18949. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Update(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteValue[],System.Int64@)"/> method.
  18950. </returns>
  18951. </member>
  18952. <member name="M:System.Data.SQLite.SQLiteModuleEnumerable.Rename(System.Data.SQLite.SQLiteVirtualTable,System.String)">
  18953. <summary>
  18954. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Rename(System.Data.SQLite.SQLiteVirtualTable,System.String)"/> method.
  18955. </summary>
  18956. <param name="table">
  18957. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Rename(System.Data.SQLite.SQLiteVirtualTable,System.String)"/> method.
  18958. </param>
  18959. <param name="newName">
  18960. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Rename(System.Data.SQLite.SQLiteVirtualTable,System.String)"/> method.
  18961. </param>
  18962. <returns>
  18963. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Rename(System.Data.SQLite.SQLiteVirtualTable,System.String)"/> method.
  18964. </returns>
  18965. </member>
  18966. <member name="M:System.Data.SQLite.SQLiteModuleEnumerable.CheckDisposed">
  18967. <summary>
  18968. Throws an <see cref="T:System.ObjectDisposedException"/> if this object
  18969. instance has been disposed.
  18970. </summary>
  18971. </member>
  18972. <member name="M:System.Data.SQLite.SQLiteModuleEnumerable.Dispose(System.Boolean)">
  18973. <summary>
  18974. Disposes of this object instance.
  18975. </summary>
  18976. <param name="disposing">
  18977. Non-zero if this method is being called from the
  18978. <see cref="M:System.IDisposable.Dispose"/> method. Zero if this method is
  18979. being called from the finalizer.
  18980. </param>
  18981. </member>
  18982. <member name="T:System.Data.SQLite.Generic.SQLiteVirtualTableCursorEnumerator`1">
  18983. <summary>
  18984. This class represents a virtual table cursor to be used with the
  18985. <see cref="T:System.Data.SQLite.SQLiteModuleEnumerable"/> class. It is not sealed and may
  18986. be used as the base class for any user-defined virtual table cursor
  18987. class that wraps an <see cref="T:System.Collections.Generic.IEnumerator`1"/> object instance.
  18988. </summary>
  18989. </member>
  18990. <member name="F:System.Data.SQLite.Generic.SQLiteVirtualTableCursorEnumerator`1.enumerator">
  18991. <summary>
  18992. The <see cref="T:System.Collections.Generic.IEnumerator`1"/> instance provided when this
  18993. cursor was created.
  18994. </summary>
  18995. </member>
  18996. <member name="M:System.Data.SQLite.Generic.SQLiteVirtualTableCursorEnumerator`1.#ctor(System.Data.SQLite.SQLiteVirtualTable,System.Collections.Generic.IEnumerator{`0})">
  18997. <summary>
  18998. Constructs an instance of this class.
  18999. </summary>
  19000. <param name="table">
  19001. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable"/> object instance associated
  19002. with this object instance.
  19003. </param>
  19004. <param name="enumerator">
  19005. The <see cref="T:System.Collections.Generic.IEnumerator`1"/> instance to expose as a virtual
  19006. table cursor.
  19007. </param>
  19008. </member>
  19009. <member name="M:System.Data.SQLite.Generic.SQLiteVirtualTableCursorEnumerator`1.Close">
  19010. <summary>
  19011. Closes the virtual table cursor. This method must not throw any
  19012. exceptions.
  19013. </summary>
  19014. </member>
  19015. <member name="M:System.Data.SQLite.Generic.SQLiteVirtualTableCursorEnumerator`1.CheckDisposed">
  19016. <summary>
  19017. Throws an <see cref="T:System.ObjectDisposedException"/> if this object
  19018. instance has been disposed.
  19019. </summary>
  19020. </member>
  19021. <member name="M:System.Data.SQLite.Generic.SQLiteVirtualTableCursorEnumerator`1.Dispose(System.Boolean)">
  19022. <summary>
  19023. Disposes of this object instance.
  19024. </summary>
  19025. <param name="disposing">
  19026. Non-zero if this method is being called from the
  19027. <see cref="M:System.IDisposable.Dispose"/> method. Zero if this method is
  19028. being called from the finalizer.
  19029. </param>
  19030. </member>
  19031. <member name="P:System.Data.SQLite.Generic.SQLiteVirtualTableCursorEnumerator`1.System#Collections#Generic#IEnumerator{T}#Current">
  19032. <summary>
  19033. Returns the value for the current row of the virtual table cursor
  19034. using the <see cref="P:System.Collections.Generic.IEnumerator`1.Current"/> property of the
  19035. <see cref="T:System.Collections.Generic.IEnumerator`1"/> object instance.
  19036. </summary>
  19037. </member>
  19038. <member name="T:System.Data.SQLite.Generic.SQLiteModuleEnumerable`1">
  19039. <summary>
  19040. This class implements a virtual table module that exposes an
  19041. <see cref="T:System.Collections.Generic.IEnumerable`1"/> object instance as a read-only virtual
  19042. table. It is not sealed and may be used as the base class for any
  19043. user-defined virtual table class that wraps an
  19044. <see cref="T:System.Collections.Generic.IEnumerable`1"/> object instance.
  19045. </summary>
  19046. </member>
  19047. <member name="F:System.Data.SQLite.Generic.SQLiteModuleEnumerable`1.enumerable">
  19048. <summary>
  19049. The <see cref="T:System.Collections.Generic.IEnumerable`1"/> instance containing the backing
  19050. data for the virtual table.
  19051. </summary>
  19052. </member>
  19053. <member name="M:System.Data.SQLite.Generic.SQLiteModuleEnumerable`1.#ctor(System.String,System.Collections.Generic.IEnumerable{`0})">
  19054. <summary>
  19055. Constructs an instance of this class.
  19056. </summary>
  19057. <param name="name">
  19058. The name of the module. This parameter cannot be null.
  19059. </param>
  19060. <param name="enumerable">
  19061. The <see cref="T:System.Collections.Generic.IEnumerable`1"/> instance to expose as a virtual
  19062. table. This parameter cannot be null.
  19063. </param>
  19064. </member>
  19065. <member name="M:System.Data.SQLite.Generic.SQLiteModuleEnumerable`1.Open(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteVirtualTableCursor@)">
  19066. <summary>
  19067. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Open(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteVirtualTableCursor@)"/> method.
  19068. </summary>
  19069. <param name="table">
  19070. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Open(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteVirtualTableCursor@)"/> method.
  19071. </param>
  19072. <param name="cursor">
  19073. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Open(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteVirtualTableCursor@)"/> method.
  19074. </param>
  19075. <returns>
  19076. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Open(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteVirtualTableCursor@)"/> method.
  19077. </returns>
  19078. </member>
  19079. <member name="M:System.Data.SQLite.Generic.SQLiteModuleEnumerable`1.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)">
  19080. <summary>
  19081. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)"/> method.
  19082. </summary>
  19083. <param name="cursor">
  19084. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)"/> method.
  19085. </param>
  19086. <param name="context">
  19087. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)"/> method.
  19088. </param>
  19089. <param name="index">
  19090. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)"/> method.
  19091. </param>
  19092. <returns>
  19093. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)"/> method.
  19094. </returns>
  19095. </member>
  19096. <member name="M:System.Data.SQLite.Generic.SQLiteModuleEnumerable`1.CheckDisposed">
  19097. <summary>
  19098. Throws an <see cref="T:System.ObjectDisposedException"/> if this object
  19099. instance has been disposed.
  19100. </summary>
  19101. </member>
  19102. <member name="M:System.Data.SQLite.Generic.SQLiteModuleEnumerable`1.Dispose(System.Boolean)">
  19103. <summary>
  19104. Disposes of this object instance.
  19105. </summary>
  19106. <param name="disposing">
  19107. Non-zero if this method is being called from the
  19108. <see cref="M:System.IDisposable.Dispose"/> method. Zero if this method is
  19109. being called from the finalizer.
  19110. </param>
  19111. </member>
  19112. <member name="T:System.Data.SQLite.SQLiteChangeSetConflictType">
  19113. <summary>
  19114. This enumerated type represents a type of conflict seen when apply
  19115. changes from a change set or patch set.
  19116. </summary>
  19117. </member>
  19118. <member name="F:System.Data.SQLite.SQLiteChangeSetConflictType.Data">
  19119. <summary>
  19120. This value is seen when processing a DELETE or UPDATE change if a
  19121. row with the required PRIMARY KEY fields is present in the
  19122. database, but one or more other (non primary-key) fields modified
  19123. by the update do not contain the expected "before" values.
  19124. </summary>
  19125. </member>
  19126. <member name="F:System.Data.SQLite.SQLiteChangeSetConflictType.NotFound">
  19127. <summary>
  19128. This value is seen when processing a DELETE or UPDATE change if a
  19129. row with the required PRIMARY KEY fields is not present in the
  19130. database. There is no conflicting row in this case.
  19131. The results of invoking the
  19132. <see cref="M:System.Data.SQLite.ISQLiteChangeSetMetadataItem.GetConflictValue(System.Int32)"/>
  19133. method are undefined.
  19134. </summary>
  19135. </member>
  19136. <member name="F:System.Data.SQLite.SQLiteChangeSetConflictType.Conflict">
  19137. <summary>
  19138. This value is seen when processing an INSERT change if the
  19139. operation would result in duplicate primary key values.
  19140. The conflicting row in this case is the database row with the
  19141. matching primary key.
  19142. </summary>
  19143. </member>
  19144. <member name="F:System.Data.SQLite.SQLiteChangeSetConflictType.Constraint">
  19145. <summary>
  19146. If a non-foreign key constraint violation occurs while applying a
  19147. change (i.e. a UNIQUE, CHECK or NOT NULL constraint), the conflict
  19148. callback will see this value.
  19149. There is no conflicting row in this case. The results of invoking
  19150. the <see cref="M:System.Data.SQLite.ISQLiteChangeSetMetadataItem.GetConflictValue(System.Int32)"/>
  19151. method are undefined.
  19152. </summary>
  19153. </member>
  19154. <member name="F:System.Data.SQLite.SQLiteChangeSetConflictType.ForeignKey">
  19155. <summary>
  19156. If foreign key handling is enabled, and applying a changes leaves
  19157. the database in a state containing foreign key violations, this
  19158. value will be seen exactly once before the changes are committed.
  19159. If the conflict handler
  19160. <see cref="F:System.Data.SQLite.SQLiteChangeSetConflictResult.Omit"/>, the changes,
  19161. including those that caused the foreign key constraint violation,
  19162. are committed. Or, if it returns
  19163. <see cref="F:System.Data.SQLite.SQLiteChangeSetConflictResult.Abort"/>, the changes are
  19164. rolled back.
  19165. No current or conflicting row information is provided. The only
  19166. method it is possible to call on the supplied
  19167. <see cref="T:System.Data.SQLite.ISQLiteChangeSetMetadataItem"/> object is
  19168. <see cref="P:System.Data.SQLite.ISQLiteChangeSetMetadataItem.NumberOfForeignKeyConflicts"/>.
  19169. </summary>
  19170. </member>
  19171. <member name="T:System.Data.SQLite.SQLiteChangeSetConflictResult">
  19172. <summary>
  19173. This enumerated type represents the result of a user-defined conflict
  19174. resolution callback.
  19175. </summary>
  19176. </member>
  19177. <member name="F:System.Data.SQLite.SQLiteChangeSetConflictResult.Omit">
  19178. <summary>
  19179. If a conflict callback returns this value no special action is
  19180. taken. The change that caused the conflict is not applied. The
  19181. application of changes continues with the next change.
  19182. </summary>
  19183. </member>
  19184. <member name="F:System.Data.SQLite.SQLiteChangeSetConflictResult.Replace">
  19185. <summary>
  19186. This value may only be returned from a conflict callback if the
  19187. type of conflict was <see cref="F:System.Data.SQLite.SQLiteChangeSetConflictType.Data"/>
  19188. or <see cref="F:System.Data.SQLite.SQLiteChangeSetConflictType.Conflict"/>. If this is
  19189. not the case, any changes applied so far are rolled back and the
  19190. call to
  19191. <see cref="M:System.Data.SQLite.ISQLiteChangeSet.Apply(System.Data.SQLite.SessionConflictCallback,System.Data.SQLite.SessionTableFilterCallback,System.Object)"/>
  19192. will raise a <see cref="T:System.Data.SQLite.SQLiteException"/> with an error code of
  19193. <see cref="F:System.Data.SQLite.SQLiteErrorCode.Misuse"/>.
  19194. If this value is returned for a
  19195. <see cref="F:System.Data.SQLite.SQLiteChangeSetConflictType.Data"/> conflict, then the
  19196. conflicting row is either updated or deleted, depending on the type
  19197. of change.
  19198. If this value is returned for a
  19199. <see cref="F:System.Data.SQLite.SQLiteChangeSetConflictType.Conflict"/> conflict, then
  19200. the conflicting row is removed from the database and a second
  19201. attempt to apply the change is made. If this second attempt fails,
  19202. the original row is restored to the database before continuing.
  19203. </summary>
  19204. </member>
  19205. <member name="F:System.Data.SQLite.SQLiteChangeSetConflictResult.Abort">
  19206. <summary>
  19207. If this value is returned, any changes applied so far are rolled
  19208. back and the call to
  19209. <see cref="M:System.Data.SQLite.ISQLiteChangeSet.Apply(System.Data.SQLite.SessionConflictCallback,System.Data.SQLite.SessionTableFilterCallback,System.Object)"/>
  19210. will raise a <see cref="T:System.Data.SQLite.SQLiteException"/> with an error code of
  19211. <see cref="F:System.Data.SQLite.SQLiteErrorCode.Abort"/>.
  19212. </summary>
  19213. </member>
  19214. <member name="T:System.Data.SQLite.SQLiteChangeSetStartFlags">
  19215. <summary>
  19216. This enumerated type represents possible flags that may be passed
  19217. to the appropriate overloads of various change set creation methods.
  19218. </summary>
  19219. </member>
  19220. <member name="F:System.Data.SQLite.SQLiteChangeSetStartFlags.None">
  19221. <summary>
  19222. No special handling.
  19223. </summary>
  19224. </member>
  19225. <member name="F:System.Data.SQLite.SQLiteChangeSetStartFlags.Invert">
  19226. <summary>
  19227. Invert the change set while iterating through it.
  19228. This is equivalent to inverting a change set using
  19229. <see cref="M:System.Data.SQLite.ISQLiteChangeSet.Invert"/> before
  19230. applying it. It is an error to specify this flag
  19231. with a patch set.
  19232. </summary>
  19233. </member>
  19234. <member name="T:System.Data.SQLite.SessionTableFilterCallback">
  19235. <summary>
  19236. This callback is invoked when a determination must be made about
  19237. whether changes to a specific table should be tracked -OR- applied.
  19238. It will not be called for tables that are already attached to a
  19239. <see cref="T:System.Data.SQLite.ISQLiteSession"/>.
  19240. </summary>
  19241. <param name="clientData">
  19242. The optional application-defined context data that was originally
  19243. passed to the <see cref="M:System.Data.SQLite.ISQLiteSession.SetTableFilter(System.Data.SQLite.SessionTableFilterCallback,System.Object)"/> or
  19244. <see cref="M:System.Data.SQLite.ISQLiteChangeSet.Apply(System.Data.SQLite.SessionConflictCallback,System.Data.SQLite.SessionTableFilterCallback,System.Object)"/>
  19245. methods. This value may be null.
  19246. </param>
  19247. <param name="name">
  19248. The name of the table.
  19249. </param>
  19250. <returns>
  19251. Non-zero if changes to the table should be considered; otherwise,
  19252. zero. Throwing an exception from this callback will result in
  19253. undefined behavior.
  19254. </returns>
  19255. </member>
  19256. <member name="T:System.Data.SQLite.SessionConflictCallback">
  19257. <summary>
  19258. This callback is invoked when there is a conflict while apply changes
  19259. to a database.
  19260. </summary>
  19261. <param name="clientData">
  19262. The optional application-defined context data that was originally
  19263. passed to the
  19264. <see cref="M:System.Data.SQLite.ISQLiteChangeSet.Apply(System.Data.SQLite.SessionConflictCallback,System.Data.SQLite.SessionTableFilterCallback,System.Object)"/>
  19265. method. This value may be null.
  19266. </param>
  19267. <param name="type">
  19268. The type of this conflict.
  19269. </param>
  19270. <param name="item">
  19271. The <see cref="T:System.Data.SQLite.ISQLiteChangeSetMetadataItem"/> object associated with
  19272. this conflict. This value may not be null; however, only properties
  19273. that are applicable to the conflict type will be available. Further
  19274. information on this is available within the descriptions of the
  19275. available <see cref="T:System.Data.SQLite.SQLiteChangeSetConflictType"/> values.
  19276. </param>
  19277. <returns>
  19278. A <see cref="T:System.Data.SQLite.SQLiteChangeSetConflictResult"/> value that indicates the
  19279. action to be taken in order to resolve the conflict. Throwing an
  19280. exception from this callback will result in undefined behavior.
  19281. </returns>
  19282. </member>
  19283. <member name="T:System.Data.SQLite.ISQLiteChangeSet">
  19284. <summary>
  19285. This interface contains methods used to manipulate a set of changes for
  19286. a database.
  19287. </summary>
  19288. </member>
  19289. <member name="M:System.Data.SQLite.ISQLiteChangeSet.Invert">
  19290. <summary>
  19291. This method "inverts" the set of changes within this instance.
  19292. Applying an inverted set of changes to a database reverses the
  19293. effects of applying the uninverted changes. Specifically:
  19294. <![CDATA[<ul>]]><![CDATA[<li>]]>
  19295. Each DELETE change is changed to an INSERT, and
  19296. <![CDATA[</li>]]><![CDATA[<li>]]>
  19297. Each INSERT change is changed to a DELETE, and
  19298. <![CDATA[</li>]]><![CDATA[<li>]]>
  19299. For each UPDATE change, the old.* and new.* values are exchanged.
  19300. <![CDATA[</li>]]><![CDATA[</ul>]]>
  19301. This method does not change the order in which changes appear
  19302. within the set of changes. It merely reverses the sense of each
  19303. individual change.
  19304. </summary>
  19305. <returns>
  19306. The new <see cref="T:System.Data.SQLite.ISQLiteChangeSet"/> instance that represents
  19307. the resulting set of changes -OR- null if it is not available.
  19308. </returns>
  19309. </member>
  19310. <member name="M:System.Data.SQLite.ISQLiteChangeSet.CombineWith(System.Data.SQLite.ISQLiteChangeSet)">
  19311. <summary>
  19312. This method combines the specified set of changes with the ones
  19313. contained in this instance.
  19314. </summary>
  19315. <param name="changeSet">
  19316. The changes to be combined with those in this instance.
  19317. </param>
  19318. <returns>
  19319. The new <see cref="T:System.Data.SQLite.ISQLiteChangeSet"/> instance that represents
  19320. the resulting set of changes -OR- null if it is not available.
  19321. </returns>
  19322. </member>
  19323. <member name="M:System.Data.SQLite.ISQLiteChangeSet.Apply(System.Data.SQLite.SessionConflictCallback,System.Object)">
  19324. <summary>
  19325. Attempts to apply the set of changes in this instance to the
  19326. associated database.
  19327. </summary>
  19328. <param name="conflictCallback">
  19329. The <see cref="T:System.Data.SQLite.SessionConflictCallback"/> delegate that will need
  19330. to handle any conflicting changes that may arise.
  19331. </param>
  19332. <param name="clientData">
  19333. The optional application-defined context data. This value may be
  19334. null.
  19335. </param>
  19336. </member>
  19337. <member name="M:System.Data.SQLite.ISQLiteChangeSet.Apply(System.Data.SQLite.SessionConflictCallback,System.Data.SQLite.SessionTableFilterCallback,System.Object)">
  19338. <summary>
  19339. Attempts to apply the set of changes in this instance to the
  19340. associated database.
  19341. </summary>
  19342. <param name="conflictCallback">
  19343. The <see cref="T:System.Data.SQLite.SessionConflictCallback"/> delegate that will need
  19344. to handle any conflicting changes that may arise.
  19345. </param>
  19346. <param name="tableFilterCallback">
  19347. The optional <see cref="T:System.Data.SQLite.SessionTableFilterCallback"/> delegate
  19348. that can be used to filter the list of tables impacted by the set
  19349. of changes.
  19350. </param>
  19351. <param name="clientData">
  19352. The optional application-defined context data. This value may be
  19353. null.
  19354. </param>
  19355. </member>
  19356. <member name="T:System.Data.SQLite.ISQLiteChangeGroup">
  19357. <summary>
  19358. This interface contains methods used to manipulate multiple sets of
  19359. changes for a database.
  19360. </summary>
  19361. </member>
  19362. <member name="M:System.Data.SQLite.ISQLiteChangeGroup.AddChangeSet(System.Byte[])">
  19363. <summary>
  19364. Attempts to add a change set (or patch set) to this change group
  19365. instance. The underlying data must be contained entirely within
  19366. the <paramref name="rawData" /> byte array.
  19367. </summary>
  19368. <param name="rawData">
  19369. The raw byte data for the specified change set (or patch set).
  19370. </param>
  19371. </member>
  19372. <member name="M:System.Data.SQLite.ISQLiteChangeGroup.AddChangeSet(System.IO.Stream)">
  19373. <summary>
  19374. Attempts to add a change set (or patch set) to this change group
  19375. instance. The underlying data will be read from the specified
  19376. <see cref="T:System.IO.Stream"/>.
  19377. </summary>
  19378. <param name="stream">
  19379. The <see cref="T:System.IO.Stream"/> instance containing the raw change set
  19380. (or patch set) data to read.
  19381. </param>
  19382. </member>
  19383. <member name="M:System.Data.SQLite.ISQLiteChangeGroup.CreateChangeSet(System.Byte[]@)">
  19384. <summary>
  19385. Attempts to create and return, via <paramref name="rawData" />, the
  19386. combined set of changes represented by this change group instance.
  19387. </summary>
  19388. <param name="rawData">
  19389. Upon success, this will contain the raw byte data for all the
  19390. changes in this change group instance.
  19391. </param>
  19392. </member>
  19393. <member name="M:System.Data.SQLite.ISQLiteChangeGroup.CreateChangeSet(System.IO.Stream)">
  19394. <summary>
  19395. Attempts to create and write, via <paramref name="stream"/>, the
  19396. combined set of changes represented by this change group instance.
  19397. </summary>
  19398. <param name="stream">
  19399. Upon success, the raw byte data for all the changes in this change
  19400. group instance will be written to this <see cref="T:System.IO.Stream"/>.
  19401. </param>
  19402. </member>
  19403. <member name="T:System.Data.SQLite.ISQLiteChangeSetMetadataItem">
  19404. <summary>
  19405. This interface contains properties and methods used to fetch metadata
  19406. about one change within a set of changes for a database.
  19407. </summary>
  19408. </member>
  19409. <member name="M:System.Data.SQLite.ISQLiteChangeSetMetadataItem.GetOldValue(System.Int32)">
  19410. <summary>
  19411. Queries and returns the original value of a given column for this
  19412. change. This method may only be called when the
  19413. <see cref="P:System.Data.SQLite.ISQLiteChangeSetMetadataItem.OperationCode"/> has a value of
  19414. <see cref="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Update"/> or
  19415. <see cref="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Delete"/>.
  19416. </summary>
  19417. <param name="columnIndex">
  19418. The index for the column. This value must be between zero and one
  19419. less than the total number of columns for this table.
  19420. </param>
  19421. <returns>
  19422. The original value of a given column for this change.
  19423. </returns>
  19424. </member>
  19425. <member name="M:System.Data.SQLite.ISQLiteChangeSetMetadataItem.GetNewValue(System.Int32)">
  19426. <summary>
  19427. Queries and returns the updated value of a given column for this
  19428. change. This method may only be called when the
  19429. <see cref="P:System.Data.SQLite.ISQLiteChangeSetMetadataItem.OperationCode"/> has a value of
  19430. <see cref="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Insert"/> or
  19431. <see cref="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Update"/>.
  19432. </summary>
  19433. <param name="columnIndex">
  19434. The index for the column. This value must be between zero and one
  19435. less than the total number of columns for this table.
  19436. </param>
  19437. <returns>
  19438. The updated value of a given column for this change.
  19439. </returns>
  19440. </member>
  19441. <member name="M:System.Data.SQLite.ISQLiteChangeSetMetadataItem.GetConflictValue(System.Int32)">
  19442. <summary>
  19443. Queries and returns the conflicting value of a given column for
  19444. this change. This method may only be called from within a
  19445. <see cref="T:System.Data.SQLite.SessionConflictCallback"/> delegate when the conflict
  19446. type is <see cref="F:System.Data.SQLite.SQLiteChangeSetConflictType.Data"/> or
  19447. <see cref="F:System.Data.SQLite.SQLiteChangeSetConflictType.Conflict"/>.
  19448. </summary>
  19449. <param name="columnIndex">
  19450. The index for the column. This value must be between zero and one
  19451. less than the total number of columns for this table.
  19452. </param>
  19453. <returns>
  19454. The conflicting value of a given column for this change.
  19455. </returns>
  19456. </member>
  19457. <member name="P:System.Data.SQLite.ISQLiteChangeSetMetadataItem.TableName">
  19458. <summary>
  19459. The name of the table the change was made to.
  19460. </summary>
  19461. </member>
  19462. <member name="P:System.Data.SQLite.ISQLiteChangeSetMetadataItem.NumberOfColumns">
  19463. <summary>
  19464. The number of columns impacted by this change. This value can be
  19465. used to determine the highest valid column index that may be used
  19466. with the <see cref="M:System.Data.SQLite.ISQLiteChangeSetMetadataItem.GetOldValue(System.Int32)"/>, <see cref="M:System.Data.SQLite.ISQLiteChangeSetMetadataItem.GetNewValue(System.Int32)"/>,
  19467. and <see cref="M:System.Data.SQLite.ISQLiteChangeSetMetadataItem.GetConflictValue(System.Int32)"/> methods of this interface. It
  19468. will be this value minus one.
  19469. </summary>
  19470. </member>
  19471. <member name="P:System.Data.SQLite.ISQLiteChangeSetMetadataItem.OperationCode">
  19472. <summary>
  19473. This will contain the value
  19474. <see cref="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Insert"/>,
  19475. <see cref="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Update"/>, or
  19476. <see cref="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Delete"/>, corresponding to
  19477. the overall type of change this item represents.
  19478. </summary>
  19479. </member>
  19480. <member name="P:System.Data.SQLite.ISQLiteChangeSetMetadataItem.Indirect">
  19481. <summary>
  19482. Non-zero if this change is considered to be indirect (i.e. as
  19483. though they were made via a trigger or foreign key action).
  19484. </summary>
  19485. </member>
  19486. <member name="P:System.Data.SQLite.ISQLiteChangeSetMetadataItem.PrimaryKeyColumns">
  19487. <summary>
  19488. This array contains a <see cref="T:System.Boolean"/> for each column in
  19489. the table associated with this change. The element will be zero
  19490. if the column is not part of the primary key; otherwise, it will
  19491. be non-zero.
  19492. </summary>
  19493. </member>
  19494. <member name="P:System.Data.SQLite.ISQLiteChangeSetMetadataItem.NumberOfForeignKeyConflicts">
  19495. <summary>
  19496. This method may only be called from within a
  19497. <see cref="T:System.Data.SQLite.SessionConflictCallback"/> delegate when the conflict
  19498. type is <see cref="F:System.Data.SQLite.SQLiteChangeSetConflictType.ForeignKey"/>. It
  19499. returns the total number of known foreign key violations in the
  19500. destination database.
  19501. </summary>
  19502. </member>
  19503. <member name="T:System.Data.SQLite.ISQLiteSession">
  19504. <summary>
  19505. This interface contains methods to query and manipulate the state of a
  19506. change tracking session for a database.
  19507. </summary>
  19508. </member>
  19509. <member name="M:System.Data.SQLite.ISQLiteSession.IsEnabled">
  19510. <summary>
  19511. Determines if this session is currently tracking changes to its
  19512. associated database.
  19513. </summary>
  19514. <returns>
  19515. Non-zero if changes to the associated database are being trakced;
  19516. otherwise, zero.
  19517. </returns>
  19518. </member>
  19519. <member name="M:System.Data.SQLite.ISQLiteSession.SetToEnabled">
  19520. <summary>
  19521. Enables tracking of changes to the associated database.
  19522. </summary>
  19523. </member>
  19524. <member name="M:System.Data.SQLite.ISQLiteSession.SetToDisabled">
  19525. <summary>
  19526. Disables tracking of changes to the associated database.
  19527. </summary>
  19528. </member>
  19529. <member name="M:System.Data.SQLite.ISQLiteSession.IsIndirect">
  19530. <summary>
  19531. Determines if this session is currently set to mark changes as
  19532. indirect (i.e. as though they were made via a trigger or foreign
  19533. key action).
  19534. </summary>
  19535. <returns>
  19536. Non-zero if changes to the associated database are being marked as
  19537. indirect; otherwise, zero.
  19538. </returns>
  19539. </member>
  19540. <member name="M:System.Data.SQLite.ISQLiteSession.SetToIndirect">
  19541. <summary>
  19542. Sets the indirect flag for this session. Subsequent changes will
  19543. be marked as indirect until this flag is changed again.
  19544. </summary>
  19545. </member>
  19546. <member name="M:System.Data.SQLite.ISQLiteSession.SetToDirect">
  19547. <summary>
  19548. Clears the indirect flag for this session. Subsequent changes will
  19549. be marked as direct until this flag is changed again.
  19550. </summary>
  19551. </member>
  19552. <member name="M:System.Data.SQLite.ISQLiteSession.IsEmpty">
  19553. <summary>
  19554. Determines if there are any tracked changes currently within the
  19555. data for this session.
  19556. </summary>
  19557. <returns>
  19558. Non-zero if there are no changes within the data for this session;
  19559. otherwise, zero.
  19560. </returns>
  19561. </member>
  19562. <member name="M:System.Data.SQLite.ISQLiteSession.GetMemoryBytesInUse">
  19563. <summary>
  19564. This method attempts to determine the amount of memory used by the
  19565. session.
  19566. </summary>
  19567. <returns>
  19568. Number of bytes used by the session -OR- negative one if its value
  19569. cannot be obtained.
  19570. </returns>
  19571. </member>
  19572. <member name="M:System.Data.SQLite.ISQLiteSession.AttachTable(System.String)">
  19573. <summary>
  19574. Upon success, causes changes to the specified table(s) to start
  19575. being tracked. Any tables impacted by calls to this method will
  19576. not cause the <see cref="T:System.Data.SQLite.SessionTableFilterCallback"/> callback
  19577. to be invoked.
  19578. </summary>
  19579. <param name="name">
  19580. The name of the table to be tracked -OR- null to track all
  19581. applicable tables within this database.
  19582. </param>
  19583. </member>
  19584. <member name="M:System.Data.SQLite.ISQLiteSession.SetTableFilter(System.Data.SQLite.SessionTableFilterCallback,System.Object)">
  19585. <summary>
  19586. This method is used to set the table filter for this instance.
  19587. </summary>
  19588. <param name="callback">
  19589. The table filter callback -OR- null to clear any existing table
  19590. filter callback.
  19591. </param>
  19592. <param name="clientData">
  19593. The optional application-defined context data. This value may be
  19594. null.
  19595. </param>
  19596. </member>
  19597. <member name="M:System.Data.SQLite.ISQLiteSession.CreateChangeSet(System.Byte[]@)">
  19598. <summary>
  19599. Attempts to create and return, via <paramref name="rawData" />, the
  19600. combined set of changes represented by this session instance.
  19601. </summary>
  19602. <param name="rawData">
  19603. Upon success, this will contain the raw byte data for all the
  19604. changes in this session instance.
  19605. </param>
  19606. </member>
  19607. <member name="M:System.Data.SQLite.ISQLiteSession.CreateChangeSet(System.IO.Stream)">
  19608. <summary>
  19609. Attempts to create and write, via <paramref name="stream"/>, the
  19610. combined set of changes represented by this session instance.
  19611. </summary>
  19612. <param name="stream">
  19613. Upon success, the raw byte data for all the changes in this session
  19614. instance will be written to this <see cref="T:System.IO.Stream"/>.
  19615. </param>
  19616. </member>
  19617. <member name="M:System.Data.SQLite.ISQLiteSession.CreatePatchSet(System.Byte[]@)">
  19618. <summary>
  19619. Attempts to create and return, via <paramref name="rawData" />, the
  19620. combined set of changes represented by this session instance as a
  19621. patch set.
  19622. </summary>
  19623. <param name="rawData">
  19624. Upon success, this will contain the raw byte data for all the
  19625. changes in this session instance.
  19626. </param>
  19627. </member>
  19628. <member name="M:System.Data.SQLite.ISQLiteSession.CreatePatchSet(System.IO.Stream)">
  19629. <summary>
  19630. Attempts to create and write, via <paramref name="stream"/>, the
  19631. combined set of changes represented by this session instance as a
  19632. patch set.
  19633. </summary>
  19634. <param name="stream">
  19635. Upon success, the raw byte data for all the changes in this session
  19636. instance will be written to this <see cref="T:System.IO.Stream"/>.
  19637. </param>
  19638. </member>
  19639. <member name="M:System.Data.SQLite.ISQLiteSession.LoadDifferencesFromTable(System.String,System.String)">
  19640. <summary>
  19641. This method loads the differences between two tables [with the same
  19642. name, set of columns, and primary key definition] into this session
  19643. instance.
  19644. </summary>
  19645. <param name="fromDatabaseName">
  19646. The name of the database containing the table with the original
  19647. data (i.e. it will need updating in order to be identical to the
  19648. one within the database associated with this session instance).
  19649. </param>
  19650. <param name="tableName">
  19651. The name of the table.
  19652. </param>
  19653. </member>
  19654. <member name="T:System.Data.SQLite.SQLiteSessionHelpers">
  19655. <summary>
  19656. This class contains some static helper methods for use within this
  19657. subsystem.
  19658. </summary>
  19659. </member>
  19660. <member name="M:System.Data.SQLite.SQLiteSessionHelpers.CheckRawData(System.Byte[])">
  19661. <summary>
  19662. This method checks the byte array specified by the caller to make
  19663. sure it will be usable.
  19664. </summary>
  19665. <param name="rawData">
  19666. A byte array provided by the caller into one of the public methods
  19667. for the classes that belong to this subsystem. This value cannot
  19668. be null or represent an empty array; otherwise, an appropriate
  19669. exception will be thrown.
  19670. </param>
  19671. </member>
  19672. <member name="T:System.Data.SQLite.SQLiteConnectionLock">
  19673. <summary>
  19674. This class is used to hold the native connection handle associated with
  19675. a <see cref="T:System.Data.SQLite.SQLiteConnection"/> open until this subsystem is totally
  19676. done with it. This class is for internal use by this subsystem only.
  19677. </summary>
  19678. </member>
  19679. <member name="F:System.Data.SQLite.SQLiteConnectionLock.LockNopSql">
  19680. <summary>
  19681. The SQL statement used when creating the native statement handle.
  19682. There are no special requirements for this other than counting as
  19683. an "open statement handle".
  19684. </summary>
  19685. </member>
  19686. <member name="F:System.Data.SQLite.SQLiteConnectionLock.StatementMessageFormat">
  19687. <summary>
  19688. The format of the error message used when reporting, during object
  19689. disposal, that the statement handle is still open (i.e. because
  19690. this situation is considered a fairly serious programming error).
  19691. </summary>
  19692. </member>
  19693. <member name="F:System.Data.SQLite.SQLiteConnectionLock.handle">
  19694. <summary>
  19695. The wrapped native connection handle associated with this lock.
  19696. </summary>
  19697. </member>
  19698. <member name="F:System.Data.SQLite.SQLiteConnectionLock.flags">
  19699. <summary>
  19700. The flags associated with the connection represented by the
  19701. <see cref="F:System.Data.SQLite.SQLiteConnectionLock.handle"/> value.
  19702. </summary>
  19703. </member>
  19704. <member name="F:System.Data.SQLite.SQLiteConnectionLock.statement">
  19705. <summary>
  19706. The native statement handle for this lock. The garbage collector
  19707. cannot cause this statement to be finalized; therefore, it will
  19708. serve to hold the associated native connection open until it is
  19709. freed manually using the <see cref="M:System.Data.SQLite.SQLiteConnectionLock.Unlock"/> method.
  19710. </summary>
  19711. </member>
  19712. <member name="M:System.Data.SQLite.SQLiteConnectionLock.#ctor(System.Data.SQLite.SQLiteConnectionHandle,System.Data.SQLite.SQLiteConnectionFlags,System.Boolean)">
  19713. <summary>
  19714. Constructs a new instance of this class using the specified wrapped
  19715. native connection handle and associated flags.
  19716. </summary>
  19717. <param name="handle">
  19718. The wrapped native connection handle to be associated with this
  19719. lock.
  19720. </param>
  19721. <param name="flags">
  19722. The flags associated with the connection represented by the
  19723. <paramref name="handle"/> value.
  19724. </param>
  19725. <param name="autoLock">
  19726. Non-zero if the <see cref="M:System.Data.SQLite.SQLiteConnectionLock.Lock"/> method should be called prior
  19727. to returning from this constructor.
  19728. </param>
  19729. </member>
  19730. <member name="M:System.Data.SQLite.SQLiteConnectionLock.GetHandle">
  19731. <summary>
  19732. Queries and returns the wrapped native connection handle for this
  19733. instance.
  19734. </summary>
  19735. <returns>
  19736. The wrapped native connection handle for this instance -OR- null
  19737. if it is unavailable.
  19738. </returns>
  19739. </member>
  19740. <member name="M:System.Data.SQLite.SQLiteConnectionLock.GetFlags">
  19741. <summary>
  19742. Queries and returns the flags associated with the connection for
  19743. this instance.
  19744. </summary>
  19745. <returns>
  19746. The <see cref="T:System.Data.SQLite.SQLiteConnectionFlags"/> value. There is no return
  19747. value reserved to indicate an error.
  19748. </returns>
  19749. </member>
  19750. <member name="M:System.Data.SQLite.SQLiteConnectionLock.GetIntPtr">
  19751. <summary>
  19752. Queries and returns the native connection handle for this instance.
  19753. </summary>
  19754. <returns>
  19755. The native connection handle for this instance. If this value is
  19756. unavailable or invalid an exception will be thrown.
  19757. </returns>
  19758. </member>
  19759. <member name="M:System.Data.SQLite.SQLiteConnectionLock.Lock">
  19760. <summary>
  19761. This method attempts to "lock" the associated native connection
  19762. handle by preparing a SQL statement that will not be finalized
  19763. until the <see cref="M:System.Data.SQLite.SQLiteConnectionLock.Unlock"/> method is called (i.e. and which
  19764. cannot be done by the garbage collector). If the statement is
  19765. already prepared, nothing is done. If the statement cannot be
  19766. prepared for any reason, an exception will be thrown.
  19767. </summary>
  19768. </member>
  19769. <member name="M:System.Data.SQLite.SQLiteConnectionLock.Unlock">
  19770. <summary>
  19771. This method attempts to "unlock" the associated native connection
  19772. handle by finalizing the previously prepared statement. If the
  19773. statement is already finalized, nothing is done. If the statement
  19774. cannot be finalized for any reason, an exception will be thrown.
  19775. </summary>
  19776. </member>
  19777. <member name="M:System.Data.SQLite.SQLiteConnectionLock.Dispose">
  19778. <summary>
  19779. Disposes of this object instance.
  19780. </summary>
  19781. </member>
  19782. <member name="F:System.Data.SQLite.SQLiteConnectionLock.disposed">
  19783. <summary>
  19784. Non-zero if this object instance has been disposed.
  19785. </summary>
  19786. </member>
  19787. <member name="M:System.Data.SQLite.SQLiteConnectionLock.CheckDisposed">
  19788. <summary>
  19789. Throws an exception if this object instance has been disposed.
  19790. </summary>
  19791. </member>
  19792. <member name="M:System.Data.SQLite.SQLiteConnectionLock.Dispose(System.Boolean)">
  19793. <summary>
  19794. Disposes or finalizes this object instance.
  19795. </summary>
  19796. <param name="disposing">
  19797. Non-zero if this object is being disposed; otherwise, this object
  19798. is being finalized.
  19799. </param>
  19800. </member>
  19801. <member name="M:System.Data.SQLite.SQLiteConnectionLock.Finalize">
  19802. <summary>
  19803. Finalizes this object instance.
  19804. </summary>
  19805. </member>
  19806. <member name="T:System.Data.SQLite.SQLiteChangeSetIterator">
  19807. <summary>
  19808. This class manages the native change set iterator. It is used as the
  19809. base class for the <see cref="T:System.Data.SQLite.SQLiteMemoryChangeSetIterator"/> and
  19810. <see cref="T:System.Data.SQLite.SQLiteStreamChangeSetIterator"/> classes. It knows how to
  19811. advance the native iterator handle as well as finalize it.
  19812. </summary>
  19813. </member>
  19814. <member name="F:System.Data.SQLite.SQLiteChangeSetIterator.iterator">
  19815. <summary>
  19816. The native change set (a.k.a. iterator) handle.
  19817. </summary>
  19818. </member>
  19819. <member name="F:System.Data.SQLite.SQLiteChangeSetIterator.ownHandle">
  19820. <summary>
  19821. Non-zero if this instance owns the native iterator handle in the
  19822. <see cref="F:System.Data.SQLite.SQLiteChangeSetIterator.iterator"/> field. In that case, this instance will
  19823. finalize the native iterator handle upon being disposed or
  19824. finalized.
  19825. </summary>
  19826. </member>
  19827. <member name="M:System.Data.SQLite.SQLiteChangeSetIterator.#ctor(System.IntPtr,System.Boolean)">
  19828. <summary>
  19829. Constructs a new instance of this class using the specified native
  19830. iterator handle.
  19831. </summary>
  19832. <param name="iterator">
  19833. The native iterator handle to use.
  19834. </param>
  19835. <param name="ownHandle">
  19836. Non-zero if this instance is to take ownership of the native
  19837. iterator handle specified by <paramref name="iterator" />.
  19838. </param>
  19839. </member>
  19840. <member name="M:System.Data.SQLite.SQLiteChangeSetIterator.CheckHandle">
  19841. <summary>
  19842. Throws an exception if the native iterator handle is invalid.
  19843. </summary>
  19844. </member>
  19845. <member name="M:System.Data.SQLite.SQLiteChangeSetIterator.GetIntPtr">
  19846. <summary>
  19847. Used to query the native iterator handle. This method is only used
  19848. by the <see cref="T:System.Data.SQLite.SQLiteChangeSetMetadataItem"/> class.
  19849. </summary>
  19850. <returns>
  19851. The native iterator handle -OR- <see cref="F:System.IntPtr.Zero"/> if it
  19852. is not available.
  19853. </returns>
  19854. </member>
  19855. <member name="M:System.Data.SQLite.SQLiteChangeSetIterator.Next">
  19856. <summary>
  19857. Attempts to advance the native iterator handle to its next item.
  19858. </summary>
  19859. <returns>
  19860. Non-zero if the native iterator handle was advanced and contains
  19861. more data; otherwise, zero. If the underlying native API returns
  19862. an unexpected value then an exception will be thrown.
  19863. </returns>
  19864. </member>
  19865. <member name="M:System.Data.SQLite.SQLiteChangeSetIterator.Attach(System.IntPtr)">
  19866. <summary>
  19867. Attempts to create an instance of this class that is associated
  19868. with the specified native iterator handle. Ownership of the
  19869. native iterator handle is NOT transferred to the new instance of
  19870. this class.
  19871. </summary>
  19872. <param name="iterator">
  19873. The native iterator handle to use.
  19874. </param>
  19875. <returns>
  19876. The new instance of this class. No return value is reserved to
  19877. indicate an error; however, if the native iterator handle is not
  19878. valid, any subsequent attempt to make use of it via the returned
  19879. instance of this class may throw exceptions.
  19880. </returns>
  19881. </member>
  19882. <member name="M:System.Data.SQLite.SQLiteChangeSetIterator.Dispose">
  19883. <summary>
  19884. Disposes of this object instance.
  19885. </summary>
  19886. </member>
  19887. <member name="F:System.Data.SQLite.SQLiteChangeSetIterator.disposed">
  19888. <summary>
  19889. Non-zero if this object instance has been disposed.
  19890. </summary>
  19891. </member>
  19892. <member name="M:System.Data.SQLite.SQLiteChangeSetIterator.CheckDisposed">
  19893. <summary>
  19894. Throws an exception if this object instance has been disposed.
  19895. </summary>
  19896. </member>
  19897. <member name="M:System.Data.SQLite.SQLiteChangeSetIterator.Dispose(System.Boolean)">
  19898. <summary>
  19899. Disposes or finalizes this object instance.
  19900. </summary>
  19901. <param name="disposing">
  19902. Non-zero if this object is being disposed; otherwise, this object
  19903. is being finalized.
  19904. </param>
  19905. </member>
  19906. <member name="M:System.Data.SQLite.SQLiteChangeSetIterator.Finalize">
  19907. <summary>
  19908. Finalizes this object instance.
  19909. </summary>
  19910. </member>
  19911. <member name="T:System.Data.SQLite.SQLiteMemoryChangeSetIterator">
  19912. <summary>
  19913. This class manages the native change set iterator for a set of changes
  19914. contained entirely in memory.
  19915. </summary>
  19916. </member>
  19917. <member name="F:System.Data.SQLite.SQLiteMemoryChangeSetIterator.pData">
  19918. <summary>
  19919. The native memory buffer allocated to contain the set of changes
  19920. associated with this instance. This will always be freed when this
  19921. instance is disposed or finalized.
  19922. </summary>
  19923. </member>
  19924. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSetIterator.#ctor(System.IntPtr,System.IntPtr,System.Boolean)">
  19925. <summary>
  19926. Constructs an instance of this class using the specified native
  19927. memory buffer and native iterator handle.
  19928. </summary>
  19929. <param name="pData">
  19930. The native memory buffer to use.
  19931. </param>
  19932. <param name="iterator">
  19933. The native iterator handle to use.
  19934. </param>
  19935. <param name="ownHandle">
  19936. Non-zero if this instance is to take ownership of the native
  19937. iterator handle specified by <paramref name="iterator" />.
  19938. </param>
  19939. </member>
  19940. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSetIterator.Create(System.Byte[])">
  19941. <summary>
  19942. Attempts to create an instance of this class using the specified
  19943. raw byte data.
  19944. </summary>
  19945. <param name="rawData">
  19946. The raw byte data containing the set of changes for this native
  19947. iterator.
  19948. </param>
  19949. <returns>
  19950. The new instance of this class -OR- null if it cannot be created.
  19951. </returns>
  19952. </member>
  19953. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSetIterator.Create(System.Byte[],System.Data.SQLite.SQLiteChangeSetStartFlags)">
  19954. <summary>
  19955. Attempts to create an instance of this class using the specified
  19956. raw byte data.
  19957. </summary>
  19958. <param name="rawData">
  19959. The raw byte data containing the set of changes for this native
  19960. iterator.
  19961. </param>
  19962. <param name="flags">
  19963. The flags used to create the change set iterator.
  19964. </param>
  19965. <returns>
  19966. The new instance of this class -OR- null if it cannot be created.
  19967. </returns>
  19968. </member>
  19969. <member name="F:System.Data.SQLite.SQLiteMemoryChangeSetIterator.disposed">
  19970. <summary>
  19971. Non-zero if this object instance has been disposed.
  19972. </summary>
  19973. </member>
  19974. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSetIterator.CheckDisposed">
  19975. <summary>
  19976. Throws an exception if this object instance has been disposed.
  19977. </summary>
  19978. </member>
  19979. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSetIterator.Dispose(System.Boolean)">
  19980. <summary>
  19981. Disposes or finalizes this object instance.
  19982. </summary>
  19983. <param name="disposing">
  19984. Non-zero if this object is being disposed; otherwise, this object
  19985. is being finalized.
  19986. </param>
  19987. </member>
  19988. <member name="T:System.Data.SQLite.SQLiteStreamChangeSetIterator">
  19989. <summary>
  19990. This class manages the native change set iterator for a set of changes
  19991. backed by a <see cref="T:System.IO.Stream"/> instance.
  19992. </summary>
  19993. </member>
  19994. <member name="F:System.Data.SQLite.SQLiteStreamChangeSetIterator.streamAdapter">
  19995. <summary>
  19996. The <see cref="T:System.Data.SQLite.SQLiteStreamAdapter"/> instance that is managing
  19997. the underlying <see cref="T:System.IO.Stream"/> used as the backing store for
  19998. the set of changes associated with this native change set iterator.
  19999. </summary>
  20000. </member>
  20001. <member name="M:System.Data.SQLite.SQLiteStreamChangeSetIterator.#ctor(System.Data.SQLite.SQLiteStreamAdapter,System.IntPtr,System.Boolean)">
  20002. <summary>
  20003. Constructs an instance of this class using the specified native
  20004. iterator handle and <see cref="T:System.Data.SQLite.SQLiteStreamAdapter"/>.
  20005. </summary>
  20006. <param name="streamAdapter">
  20007. The <see cref="T:System.Data.SQLite.SQLiteStreamAdapter"/> instance to use.
  20008. </param>
  20009. <param name="iterator">
  20010. The native iterator handle to use.
  20011. </param>
  20012. <param name="ownHandle">
  20013. Non-zero if this instance is to take ownership of the native
  20014. iterator handle specified by <paramref name="iterator"/>.
  20015. </param>
  20016. </member>
  20017. <member name="M:System.Data.SQLite.SQLiteStreamChangeSetIterator.Create(System.IO.Stream,System.Data.SQLite.SQLiteConnectionFlags)">
  20018. <summary>
  20019. Attempts to create an instance of this class using the specified
  20020. <see cref="T:System.IO.Stream"/>.
  20021. </summary>
  20022. <param name="stream">
  20023. The <see cref="T:System.IO.Stream"/> where the raw byte data for the set of
  20024. changes may be read.
  20025. </param>
  20026. <param name="connectionFlags">
  20027. The flags associated with the parent connection.
  20028. </param>
  20029. <returns>
  20030. The new instance of this class -OR- null if it cannot be created.
  20031. </returns>
  20032. </member>
  20033. <member name="M:System.Data.SQLite.SQLiteStreamChangeSetIterator.Create(System.IO.Stream,System.Data.SQLite.SQLiteConnectionFlags,System.Data.SQLite.SQLiteChangeSetStartFlags)">
  20034. <summary>
  20035. Attempts to create an instance of this class using the specified
  20036. <see cref="T:System.IO.Stream"/>.
  20037. </summary>
  20038. <param name="stream">
  20039. The <see cref="T:System.IO.Stream"/> where the raw byte data for the set of
  20040. changes may be read.
  20041. </param>
  20042. <param name="connectionFlags">
  20043. The flags associated with the parent connection.
  20044. </param>
  20045. <param name="startFlags">
  20046. The flags used to create the change set iterator.
  20047. </param>
  20048. <returns>
  20049. The new instance of this class -OR- null if it cannot be created.
  20050. </returns>
  20051. </member>
  20052. <member name="F:System.Data.SQLite.SQLiteStreamChangeSetIterator.disposed">
  20053. <summary>
  20054. Non-zero if this object instance has been disposed.
  20055. </summary>
  20056. </member>
  20057. <member name="M:System.Data.SQLite.SQLiteStreamChangeSetIterator.CheckDisposed">
  20058. <summary>
  20059. Throws an exception if this object instance has been disposed.
  20060. </summary>
  20061. </member>
  20062. <member name="M:System.Data.SQLite.SQLiteStreamChangeSetIterator.Dispose(System.Boolean)">
  20063. <summary>
  20064. Disposes or finalizes this object instance.
  20065. </summary>
  20066. <param name="disposing">
  20067. Non-zero if this object is being disposed; otherwise, this object
  20068. is being finalized.
  20069. </param>
  20070. </member>
  20071. <member name="T:System.Data.SQLite.SQLiteStreamAdapter">
  20072. <summary>
  20073. This class is used to act as a bridge between a <see cref="T:System.IO.Stream"/>
  20074. instance and the delegates used with the native streaming API.
  20075. </summary>
  20076. </member>
  20077. <member name="F:System.Data.SQLite.SQLiteStreamAdapter.stream">
  20078. <summary>
  20079. The managed stream instance used to in order to service the native
  20080. delegates for both input and output.
  20081. </summary>
  20082. </member>
  20083. <member name="F:System.Data.SQLite.SQLiteStreamAdapter.flags">
  20084. <summary>
  20085. The flags associated with the connection.
  20086. </summary>
  20087. </member>
  20088. <member name="F:System.Data.SQLite.SQLiteStreamAdapter.xInput">
  20089. <summary>
  20090. The delegate used to provide input to the native streaming API.
  20091. It will be null -OR- point to the <see cref="M:System.Data.SQLite.SQLiteStreamAdapter.Input(System.IntPtr,System.IntPtr,System.Int32@)"/> method.
  20092. </summary>
  20093. </member>
  20094. <member name="F:System.Data.SQLite.SQLiteStreamAdapter.xOutput">
  20095. <summary>
  20096. The delegate used to provide output to the native streaming API.
  20097. It will be null -OR- point to the <see cref="M:System.Data.SQLite.SQLiteStreamAdapter.Output(System.IntPtr,System.IntPtr,System.Int32)"/> method.
  20098. </summary>
  20099. </member>
  20100. <member name="M:System.Data.SQLite.SQLiteStreamAdapter.#ctor(System.IO.Stream,System.Data.SQLite.SQLiteConnectionFlags)">
  20101. <summary>
  20102. Constructs a new instance of this class using the specified managed
  20103. stream and connection flags.
  20104. </summary>
  20105. <param name="stream">
  20106. The managed stream instance to be used in order to service the
  20107. native delegates for both input and output.
  20108. </param>
  20109. <param name="flags">
  20110. The flags associated with the parent connection.
  20111. </param>
  20112. </member>
  20113. <member name="M:System.Data.SQLite.SQLiteStreamAdapter.GetFlags">
  20114. <summary>
  20115. Queries and returns the flags associated with the connection for
  20116. this instance.
  20117. </summary>
  20118. <returns>
  20119. The <see cref="T:System.Data.SQLite.SQLiteConnectionFlags"/> value. There is no return
  20120. value reserved to indicate an error.
  20121. </returns>
  20122. </member>
  20123. <member name="M:System.Data.SQLite.SQLiteStreamAdapter.GetInputDelegate">
  20124. <summary>
  20125. Returns a delegate that wraps the <see cref="M:System.Data.SQLite.SQLiteStreamAdapter.Input(System.IntPtr,System.IntPtr,System.Int32@)"/> method,
  20126. creating it first if necessary.
  20127. </summary>
  20128. <returns>
  20129. A delegate that refers to the <see cref="M:System.Data.SQLite.SQLiteStreamAdapter.Input(System.IntPtr,System.IntPtr,System.Int32@)"/> method.
  20130. </returns>
  20131. </member>
  20132. <member name="M:System.Data.SQLite.SQLiteStreamAdapter.GetOutputDelegate">
  20133. <summary>
  20134. Returns a delegate that wraps the <see cref="M:System.Data.SQLite.SQLiteStreamAdapter.Output(System.IntPtr,System.IntPtr,System.Int32)"/> method,
  20135. creating it first if necessary.
  20136. </summary>
  20137. <returns>
  20138. A delegate that refers to the <see cref="M:System.Data.SQLite.SQLiteStreamAdapter.Output(System.IntPtr,System.IntPtr,System.Int32)"/> method.
  20139. </returns>
  20140. </member>
  20141. <member name="M:System.Data.SQLite.SQLiteStreamAdapter.Input(System.IntPtr,System.IntPtr,System.Int32@)">
  20142. <summary>
  20143. This method attempts to read <paramref name="nData"/> bytes from
  20144. the managed stream, writing them to the <paramref name="pData"/>
  20145. buffer.
  20146. </summary>
  20147. <param name="context">
  20148. Optional extra context information. Currently, this will always
  20149. have a value of <see cref="F:System.IntPtr.Zero"/>.
  20150. </param>
  20151. <param name="pData">
  20152. A preallocated native buffer to receive the requested input bytes.
  20153. It must be at least <paramref name="nData"/> bytes in size.
  20154. </param>
  20155. <param name="nData">
  20156. Upon entry, the number of bytes to read. Upon exit, the number of
  20157. bytes actually read. This value may be zero upon exit.
  20158. </param>
  20159. <returns>
  20160. The value <see cref="F:System.Data.SQLite.SQLiteErrorCode.Ok"/> upon success -OR- an
  20161. appropriate error code upon failure.
  20162. </returns>
  20163. </member>
  20164. <member name="M:System.Data.SQLite.SQLiteStreamAdapter.Output(System.IntPtr,System.IntPtr,System.Int32)">
  20165. <summary>
  20166. This method attempts to write <paramref name="nData"/> bytes to
  20167. the managed stream, reading them from the <paramref name="pData"/>
  20168. buffer.
  20169. </summary>
  20170. <param name="context">
  20171. Optional extra context information. Currently, this will always
  20172. have a value of <see cref="F:System.IntPtr.Zero"/>.
  20173. </param>
  20174. <param name="pData">
  20175. A preallocated native buffer containing the requested output
  20176. bytes. It must be at least <paramref name="nData"/> bytes in
  20177. size.
  20178. </param>
  20179. <param name="nData">
  20180. The number of bytes to write.
  20181. </param>
  20182. <returns>
  20183. The value <see cref="F:System.Data.SQLite.SQLiteErrorCode.Ok"/> upon success -OR- an
  20184. appropriate error code upon failure.
  20185. </returns>
  20186. </member>
  20187. <member name="M:System.Data.SQLite.SQLiteStreamAdapter.Dispose">
  20188. <summary>
  20189. Disposes of this object instance.
  20190. </summary>
  20191. </member>
  20192. <member name="F:System.Data.SQLite.SQLiteStreamAdapter.disposed">
  20193. <summary>
  20194. Non-zero if this object instance has been disposed.
  20195. </summary>
  20196. </member>
  20197. <member name="M:System.Data.SQLite.SQLiteStreamAdapter.CheckDisposed">
  20198. <summary>
  20199. Throws an exception if this object instance has been disposed.
  20200. </summary>
  20201. </member>
  20202. <member name="M:System.Data.SQLite.SQLiteStreamAdapter.Dispose(System.Boolean)">
  20203. <summary>
  20204. Disposes or finalizes this object instance.
  20205. </summary>
  20206. <param name="disposing">
  20207. Non-zero if this object is being disposed; otherwise, this object
  20208. is being finalized.
  20209. </param>
  20210. </member>
  20211. <member name="M:System.Data.SQLite.SQLiteStreamAdapter.Finalize">
  20212. <summary>
  20213. Finalizes this object instance.
  20214. </summary>
  20215. </member>
  20216. <member name="T:System.Data.SQLite.SQLiteSessionStreamManager">
  20217. <summary>
  20218. This class manages a collection of <see cref="T:System.Data.SQLite.SQLiteStreamAdapter"/>
  20219. instances. When used, it takes responsibility for creating, returning,
  20220. and disposing of its <see cref="T:System.Data.SQLite.SQLiteStreamAdapter"/> instances.
  20221. </summary>
  20222. </member>
  20223. <member name="F:System.Data.SQLite.SQLiteSessionStreamManager.streamAdapters">
  20224. <summary>
  20225. The managed collection of <see cref="T:System.Data.SQLite.SQLiteStreamAdapter"/>
  20226. instances, keyed by their associated <see cref="T:System.IO.Stream"/>
  20227. instance.
  20228. </summary>
  20229. </member>
  20230. <member name="F:System.Data.SQLite.SQLiteSessionStreamManager.flags">
  20231. <summary>
  20232. The flags associated with the connection.
  20233. </summary>
  20234. </member>
  20235. <member name="M:System.Data.SQLite.SQLiteSessionStreamManager.#ctor(System.Data.SQLite.SQLiteConnectionFlags)">
  20236. <summary>
  20237. Constructs a new instance of this class using the specified
  20238. connection flags.
  20239. </summary>
  20240. <param name="flags">
  20241. The flags associated with the parent connection.
  20242. </param>
  20243. </member>
  20244. <member name="M:System.Data.SQLite.SQLiteSessionStreamManager.InitializeStreamAdapters">
  20245. <summary>
  20246. Makes sure the collection of <see cref="T:System.Data.SQLite.SQLiteStreamAdapter"/>
  20247. is created.
  20248. </summary>
  20249. </member>
  20250. <member name="M:System.Data.SQLite.SQLiteSessionStreamManager.DisposeStreamAdapters">
  20251. <summary>
  20252. Makes sure the collection of <see cref="T:System.Data.SQLite.SQLiteStreamAdapter"/>
  20253. is disposed.
  20254. </summary>
  20255. </member>
  20256. <member name="M:System.Data.SQLite.SQLiteSessionStreamManager.GetAdapter(System.IO.Stream)">
  20257. <summary>
  20258. Attempts to return a <see cref="T:System.Data.SQLite.SQLiteStreamAdapter"/> instance
  20259. suitable for the specified <see cref="T:System.IO.Stream"/>.
  20260. </summary>
  20261. <param name="stream">
  20262. The <see cref="T:System.IO.Stream"/> instance. If this value is null, a null
  20263. value will be returned.
  20264. </param>
  20265. <returns>
  20266. A <see cref="T:System.Data.SQLite.SQLiteStreamAdapter"/> instance. Typically, these
  20267. are always freshly created; however, this method is designed to
  20268. return the existing <see cref="T:System.Data.SQLite.SQLiteStreamAdapter"/> instance
  20269. associated with the specified stream, should one exist.
  20270. </returns>
  20271. </member>
  20272. <member name="M:System.Data.SQLite.SQLiteSessionStreamManager.Dispose">
  20273. <summary>
  20274. Disposes of this object instance.
  20275. </summary>
  20276. </member>
  20277. <member name="F:System.Data.SQLite.SQLiteSessionStreamManager.disposed">
  20278. <summary>
  20279. Non-zero if this object instance has been disposed.
  20280. </summary>
  20281. </member>
  20282. <member name="M:System.Data.SQLite.SQLiteSessionStreamManager.CheckDisposed">
  20283. <summary>
  20284. Throws an exception if this object instance has been disposed.
  20285. </summary>
  20286. </member>
  20287. <member name="M:System.Data.SQLite.SQLiteSessionStreamManager.Dispose(System.Boolean)">
  20288. <summary>
  20289. Disposes or finalizes this object instance.
  20290. </summary>
  20291. <param name="disposing">
  20292. Non-zero if this object is being disposed; otherwise, this object
  20293. is being finalized.
  20294. </param>
  20295. </member>
  20296. <member name="M:System.Data.SQLite.SQLiteSessionStreamManager.Finalize">
  20297. <summary>
  20298. Finalizes this object instance.
  20299. </summary>
  20300. </member>
  20301. <member name="T:System.Data.SQLite.SQLiteChangeGroup">
  20302. <summary>
  20303. This class represents a group of change sets (or patch sets).
  20304. </summary>
  20305. </member>
  20306. <member name="F:System.Data.SQLite.SQLiteChangeGroup.streamManager">
  20307. <summary>
  20308. The <see cref="T:System.Data.SQLite.SQLiteSessionStreamManager"/> instance associated
  20309. with this change group.
  20310. </summary>
  20311. </member>
  20312. <member name="F:System.Data.SQLite.SQLiteChangeGroup.flags">
  20313. <summary>
  20314. The flags associated with the connection.
  20315. </summary>
  20316. </member>
  20317. <member name="F:System.Data.SQLite.SQLiteChangeGroup.changeGroup">
  20318. <summary>
  20319. The native handle for this change group. This will be deleted when
  20320. this instance is disposed or finalized.
  20321. </summary>
  20322. </member>
  20323. <member name="M:System.Data.SQLite.SQLiteChangeGroup.#ctor(System.Data.SQLite.SQLiteConnectionFlags)">
  20324. <summary>
  20325. Constructs a new instance of this class using the specified
  20326. connection flags.
  20327. </summary>
  20328. <param name="flags">
  20329. The flags associated with the parent connection.
  20330. </param>
  20331. </member>
  20332. <member name="M:System.Data.SQLite.SQLiteChangeGroup.CheckHandle">
  20333. <summary>
  20334. Throws an exception if the native change group handle is invalid.
  20335. </summary>
  20336. </member>
  20337. <member name="M:System.Data.SQLite.SQLiteChangeGroup.InitializeHandle">
  20338. <summary>
  20339. Makes sure the native change group handle is valid, creating it if
  20340. necessary.
  20341. </summary>
  20342. </member>
  20343. <member name="M:System.Data.SQLite.SQLiteChangeGroup.InitializeStreamManager">
  20344. <summary>
  20345. Makes sure the <see cref="T:System.Data.SQLite.SQLiteSessionStreamManager"/> instance
  20346. is available, creating it if necessary.
  20347. </summary>
  20348. </member>
  20349. <member name="M:System.Data.SQLite.SQLiteChangeGroup.GetStreamAdapter(System.IO.Stream)">
  20350. <summary>
  20351. Attempts to return a <see cref="T:System.Data.SQLite.SQLiteStreamAdapter"/> instance
  20352. suitable for the specified <see cref="T:System.IO.Stream"/>.
  20353. </summary>
  20354. <param name="stream">
  20355. The <see cref="T:System.IO.Stream"/> instance. If this value is null, a null
  20356. value will be returned.
  20357. </param>
  20358. <returns>
  20359. A <see cref="T:System.Data.SQLite.SQLiteStreamAdapter"/> instance. Typically, these
  20360. are always freshly created; however, this method is designed to
  20361. return the existing <see cref="T:System.Data.SQLite.SQLiteStreamAdapter"/> instance
  20362. associated with the specified stream, should one exist.
  20363. </returns>
  20364. </member>
  20365. <member name="M:System.Data.SQLite.SQLiteChangeGroup.AddChangeSet(System.Byte[])">
  20366. <summary>
  20367. Attempts to add a change set (or patch set) to this change group
  20368. instance. The underlying data must be contained entirely within
  20369. the <paramref name="rawData" /> byte array.
  20370. </summary>
  20371. <param name="rawData">
  20372. The raw byte data for the specified change set (or patch set).
  20373. </param>
  20374. </member>
  20375. <member name="M:System.Data.SQLite.SQLiteChangeGroup.AddChangeSet(System.IO.Stream)">
  20376. <summary>
  20377. Attempts to add a change set (or patch set) to this change group
  20378. instance. The underlying data will be read from the specified
  20379. <see cref="T:System.IO.Stream"/>.
  20380. </summary>
  20381. <param name="stream">
  20382. The <see cref="T:System.IO.Stream"/> instance containing the raw change set
  20383. (or patch set) data to read.
  20384. </param>
  20385. </member>
  20386. <member name="M:System.Data.SQLite.SQLiteChangeGroup.CreateChangeSet(System.Byte[]@)">
  20387. <summary>
  20388. Attempts to create and return, via <paramref name="rawData" />, the
  20389. combined set of changes represented by this change group instance.
  20390. </summary>
  20391. <param name="rawData">
  20392. Upon success, this will contain the raw byte data for all the
  20393. changes in this change group instance.
  20394. </param>
  20395. </member>
  20396. <member name="M:System.Data.SQLite.SQLiteChangeGroup.CreateChangeSet(System.IO.Stream)">
  20397. <summary>
  20398. Attempts to create and write, via <paramref name="stream"/>, the
  20399. combined set of changes represented by this change group instance.
  20400. </summary>
  20401. <param name="stream">
  20402. Upon success, the raw byte data for all the changes in this change
  20403. group instance will be written to this <see cref="T:System.IO.Stream"/>.
  20404. </param>
  20405. </member>
  20406. <member name="M:System.Data.SQLite.SQLiteChangeGroup.Dispose">
  20407. <summary>
  20408. Disposes of this object instance.
  20409. </summary>
  20410. </member>
  20411. <member name="F:System.Data.SQLite.SQLiteChangeGroup.disposed">
  20412. <summary>
  20413. Non-zero if this object instance has been disposed.
  20414. </summary>
  20415. </member>
  20416. <member name="M:System.Data.SQLite.SQLiteChangeGroup.CheckDisposed">
  20417. <summary>
  20418. Throws an exception if this object instance has been disposed.
  20419. </summary>
  20420. </member>
  20421. <member name="M:System.Data.SQLite.SQLiteChangeGroup.Dispose(System.Boolean)">
  20422. <summary>
  20423. Disposes or finalizes this object instance.
  20424. </summary>
  20425. <param name="disposing">
  20426. Non-zero if this object is being disposed; otherwise, this object
  20427. is being finalized.
  20428. </param>
  20429. </member>
  20430. <member name="M:System.Data.SQLite.SQLiteChangeGroup.Finalize">
  20431. <summary>
  20432. Finalizes this object instance.
  20433. </summary>
  20434. </member>
  20435. <member name="T:System.Data.SQLite.SQLiteSession">
  20436. <summary>
  20437. This class represents the change tracking session associated with a
  20438. database.
  20439. </summary>
  20440. </member>
  20441. <member name="F:System.Data.SQLite.SQLiteSession.streamManager">
  20442. <summary>
  20443. The <see cref="T:System.Data.SQLite.SQLiteSessionStreamManager"/> instance associated
  20444. with this session.
  20445. </summary>
  20446. </member>
  20447. <member name="F:System.Data.SQLite.SQLiteSession.databaseName">
  20448. <summary>
  20449. The name of the database (e.g. "main") for this session.
  20450. </summary>
  20451. </member>
  20452. <member name="F:System.Data.SQLite.SQLiteSession.session">
  20453. <summary>
  20454. The native handle for this session. This will be deleted when
  20455. this instance is disposed or finalized.
  20456. </summary>
  20457. </member>
  20458. <member name="F:System.Data.SQLite.SQLiteSession.xFilter">
  20459. <summary>
  20460. The delegate used to provide table filtering to the native API.
  20461. It will be null -OR- point to the <see cref="M:System.Data.SQLite.SQLiteSession.Filter(System.IntPtr,System.IntPtr)"/> method.
  20462. </summary>
  20463. </member>
  20464. <member name="F:System.Data.SQLite.SQLiteSession.tableFilterCallback">
  20465. <summary>
  20466. The managed callback used to filter tables for this session. Set
  20467. via the <see cref="M:System.Data.SQLite.SQLiteSession.SetTableFilter(System.Data.SQLite.SessionTableFilterCallback,System.Object)"/> method.
  20468. </summary>
  20469. </member>
  20470. <member name="F:System.Data.SQLite.SQLiteSession.tableFilterClientData">
  20471. <summary>
  20472. The optional application-defined context data that was passed to
  20473. the <see cref="M:System.Data.SQLite.SQLiteSession.SetTableFilter(System.Data.SQLite.SessionTableFilterCallback,System.Object)"/> method. This value may be null.
  20474. </summary>
  20475. </member>
  20476. <member name="M:System.Data.SQLite.SQLiteSession.#ctor(System.Data.SQLite.SQLiteConnectionHandle,System.Data.SQLite.SQLiteConnectionFlags,System.String)">
  20477. <summary>
  20478. Constructs a new instance of this class using the specified wrapped
  20479. native connection handle and associated flags.
  20480. </summary>
  20481. <param name="handle">
  20482. The wrapped native connection handle to be associated with this
  20483. session.
  20484. </param>
  20485. <param name="flags">
  20486. The flags associated with the connection represented by the
  20487. <paramref name="handle" /> value.
  20488. </param>
  20489. <param name="databaseName">
  20490. The name of the database (e.g. "main") for this session.
  20491. </param>
  20492. </member>
  20493. <member name="M:System.Data.SQLite.SQLiteSession.CheckHandle">
  20494. <summary>
  20495. Throws an exception if the native session handle is invalid.
  20496. </summary>
  20497. </member>
  20498. <member name="M:System.Data.SQLite.SQLiteSession.InitializeHandle">
  20499. <summary>
  20500. Makes sure the native session handle is valid, creating it if
  20501. necessary.
  20502. </summary>
  20503. </member>
  20504. <member name="M:System.Data.SQLite.SQLiteSession.ApplyTableFilter(System.Data.SQLite.SessionTableFilterCallback,System.Object)">
  20505. <summary>
  20506. This method sets up the internal table filtering associated state
  20507. of this instance.
  20508. </summary>
  20509. <param name="callback">
  20510. The table filter callback -OR- null to clear any existing table
  20511. filter callback.
  20512. </param>
  20513. <param name="clientData">
  20514. The optional application-defined context data. This value may be
  20515. null.
  20516. </param>
  20517. <returns>
  20518. The <see cref="T:System.Data.SQLite.UnsafeNativeMethods.xSessionFilter"/> native
  20519. delegate -OR- null to clear any existing table filter.
  20520. </returns>
  20521. </member>
  20522. <member name="M:System.Data.SQLite.SQLiteSession.InitializeStreamManager">
  20523. <summary>
  20524. Makes sure the <see cref="T:System.Data.SQLite.SQLiteSessionStreamManager"/> instance
  20525. is available, creating it if necessary.
  20526. </summary>
  20527. </member>
  20528. <member name="M:System.Data.SQLite.SQLiteSession.GetStreamAdapter(System.IO.Stream)">
  20529. <summary>
  20530. Attempts to return a <see cref="T:System.Data.SQLite.SQLiteStreamAdapter"/> instance
  20531. suitable for the specified <see cref="T:System.IO.Stream"/>.
  20532. </summary>
  20533. <param name="stream">
  20534. The <see cref="T:System.IO.Stream"/> instance. If this value is null, a null
  20535. value will be returned.
  20536. </param>
  20537. <returns>
  20538. A <see cref="T:System.Data.SQLite.SQLiteStreamAdapter"/> instance. Typically, these
  20539. are always freshly created; however, this method is designed to
  20540. return the existing <see cref="T:System.Data.SQLite.SQLiteStreamAdapter"/> instance
  20541. associated with the specified stream, should one exist.
  20542. </returns>
  20543. </member>
  20544. <member name="M:System.Data.SQLite.SQLiteSession.Filter(System.IntPtr,System.IntPtr)">
  20545. <summary>
  20546. This method is called when determining if a table needs to be
  20547. included in the tracked changes for the associated database.
  20548. </summary>
  20549. <param name="context">
  20550. Optional extra context information. Currently, this will always
  20551. have a value of <see cref="F:System.IntPtr.Zero"/>.
  20552. </param>
  20553. <param name="pTblName">
  20554. The native pointer to the name of the table.
  20555. </param>
  20556. <returns>
  20557. Non-zero if changes to the specified table should be considered;
  20558. otherwise, zero.
  20559. </returns>
  20560. </member>
  20561. <member name="M:System.Data.SQLite.SQLiteSession.IsEnabled">
  20562. <summary>
  20563. Determines if this session is currently tracking changes to its
  20564. associated database.
  20565. </summary>
  20566. <returns>
  20567. Non-zero if changes to the associated database are being trakced;
  20568. otherwise, zero.
  20569. </returns>
  20570. </member>
  20571. <member name="M:System.Data.SQLite.SQLiteSession.SetToEnabled">
  20572. <summary>
  20573. Enables tracking of changes to the associated database.
  20574. </summary>
  20575. </member>
  20576. <member name="M:System.Data.SQLite.SQLiteSession.SetToDisabled">
  20577. <summary>
  20578. Disables tracking of changes to the associated database.
  20579. </summary>
  20580. </member>
  20581. <member name="M:System.Data.SQLite.SQLiteSession.IsIndirect">
  20582. <summary>
  20583. Determines if this session is currently set to mark changes as
  20584. indirect (i.e. as though they were made via a trigger or foreign
  20585. key action).
  20586. </summary>
  20587. <returns>
  20588. Non-zero if changes to the associated database are being marked as
  20589. indirect; otherwise, zero.
  20590. </returns>
  20591. </member>
  20592. <member name="M:System.Data.SQLite.SQLiteSession.SetToIndirect">
  20593. <summary>
  20594. Sets the indirect flag for this session. Subsequent changes will
  20595. be marked as indirect until this flag is changed again.
  20596. </summary>
  20597. </member>
  20598. <member name="M:System.Data.SQLite.SQLiteSession.SetToDirect">
  20599. <summary>
  20600. Clears the indirect flag for this session. Subsequent changes will
  20601. be marked as direct until this flag is changed again.
  20602. </summary>
  20603. </member>
  20604. <member name="M:System.Data.SQLite.SQLiteSession.IsEmpty">
  20605. <summary>
  20606. Determines if there are any tracked changes currently within the
  20607. data for this session.
  20608. </summary>
  20609. <returns>
  20610. Non-zero if there are no changes within the data for this session;
  20611. otherwise, zero.
  20612. </returns>
  20613. </member>
  20614. <member name="M:System.Data.SQLite.SQLiteSession.GetMemoryBytesInUse">
  20615. <summary>
  20616. This method attempts to determine the amount of memory used by the
  20617. session.
  20618. </summary>
  20619. <returns>
  20620. The number of bytes used by the session.
  20621. </returns>
  20622. </member>
  20623. <member name="M:System.Data.SQLite.SQLiteSession.AttachTable(System.String)">
  20624. <summary>
  20625. Upon success, causes changes to the specified table(s) to start
  20626. being tracked. Any tables impacted by calls to this method will
  20627. not cause the <see cref="T:System.Data.SQLite.SessionTableFilterCallback"/> callback
  20628. to be invoked.
  20629. </summary>
  20630. <param name="name">
  20631. The name of the table to be tracked -OR- null to track all
  20632. applicable tables within this database.
  20633. </param>
  20634. </member>
  20635. <member name="M:System.Data.SQLite.SQLiteSession.SetTableFilter(System.Data.SQLite.SessionTableFilterCallback,System.Object)">
  20636. <summary>
  20637. This method is used to set the table filter for this instance.
  20638. </summary>
  20639. <param name="callback">
  20640. The table filter callback -OR- null to clear any existing table
  20641. filter callback.
  20642. </param>
  20643. <param name="clientData">
  20644. The optional application-defined context data. This value may be
  20645. null.
  20646. </param>
  20647. </member>
  20648. <member name="M:System.Data.SQLite.SQLiteSession.CreateChangeSet(System.Byte[]@)">
  20649. <summary>
  20650. Attempts to create and return, via <paramref name="rawData" />, the
  20651. set of changes represented by this session instance.
  20652. </summary>
  20653. <param name="rawData">
  20654. Upon success, this will contain the raw byte data for all the
  20655. changes in this session instance.
  20656. </param>
  20657. </member>
  20658. <member name="M:System.Data.SQLite.SQLiteSession.CreateChangeSet(System.IO.Stream)">
  20659. <summary>
  20660. Attempts to create and write, via <paramref name="stream"/>, the
  20661. set of changes represented by this session instance.
  20662. </summary>
  20663. <param name="stream">
  20664. Upon success, the raw byte data for all the changes in this session
  20665. instance will be written to this <see cref="T:System.IO.Stream"/>.
  20666. </param>
  20667. </member>
  20668. <member name="M:System.Data.SQLite.SQLiteSession.CreatePatchSet(System.Byte[]@)">
  20669. <summary>
  20670. Attempts to create and return, via <paramref name="rawData" />, the
  20671. set of changes represented by this session instance as a patch set.
  20672. </summary>
  20673. <param name="rawData">
  20674. Upon success, this will contain the raw byte data for all the
  20675. changes in this session instance.
  20676. </param>
  20677. </member>
  20678. <member name="M:System.Data.SQLite.SQLiteSession.CreatePatchSet(System.IO.Stream)">
  20679. <summary>
  20680. Attempts to create and write, via <paramref name="stream"/>, the
  20681. set of changes represented by this session instance as a patch set.
  20682. </summary>
  20683. <param name="stream">
  20684. Upon success, the raw byte data for all the changes in this session
  20685. instance will be written to this <see cref="T:System.IO.Stream"/>.
  20686. </param>
  20687. </member>
  20688. <member name="M:System.Data.SQLite.SQLiteSession.LoadDifferencesFromTable(System.String,System.String)">
  20689. <summary>
  20690. This method loads the differences between two tables [with the same
  20691. name, set of columns, and primary key definition] into this session
  20692. instance.
  20693. </summary>
  20694. <param name="fromDatabaseName">
  20695. The name of the database containing the table with the original
  20696. data (i.e. it will need updating in order to be identical to the
  20697. one within the database associated with this session instance).
  20698. </param>
  20699. <param name="tableName">
  20700. The name of the table.
  20701. </param>
  20702. </member>
  20703. <member name="F:System.Data.SQLite.SQLiteSession.disposed">
  20704. <summary>
  20705. Non-zero if this object instance has been disposed.
  20706. </summary>
  20707. </member>
  20708. <member name="M:System.Data.SQLite.SQLiteSession.CheckDisposed">
  20709. <summary>
  20710. Throws an exception if this object instance has been disposed.
  20711. </summary>
  20712. </member>
  20713. <member name="M:System.Data.SQLite.SQLiteSession.Dispose(System.Boolean)">
  20714. <summary>
  20715. Disposes or finalizes this object instance.
  20716. </summary>
  20717. <param name="disposing">
  20718. Non-zero if this object is being disposed; otherwise, this object
  20719. is being finalized.
  20720. </param>
  20721. </member>
  20722. <member name="T:System.Data.SQLite.SQLiteChangeSetBase">
  20723. <summary>
  20724. This class represents the abstract concept of a set of changes. It
  20725. acts as the base class for the <see cref="T:System.Data.SQLite.SQLiteMemoryChangeSet"/>
  20726. and <see cref="T:System.Data.SQLite.SQLiteStreamChangeSet"/> classes. It derives from
  20727. the <see cref="T:System.Data.SQLite.SQLiteConnectionLock"/> class, which is used to hold
  20728. the underlying native connection handle open until the instances of
  20729. this class are disposed or finalized. It also provides the ability
  20730. to construct wrapped native delegates of the
  20731. <see cref="T:System.Data.SQLite.UnsafeNativeMethods.xSessionFilter"/> and
  20732. <see cref="T:System.Data.SQLite.UnsafeNativeMethods.xSessionConflict"/> types.
  20733. </summary>
  20734. </member>
  20735. <member name="M:System.Data.SQLite.SQLiteChangeSetBase.#ctor(System.Data.SQLite.SQLiteConnectionHandle,System.Data.SQLite.SQLiteConnectionFlags)">
  20736. <summary>
  20737. Constructs an instance of this class using the specified wrapped
  20738. native connection handle.
  20739. </summary>
  20740. <param name="handle">
  20741. The wrapped native connection handle to be associated with this
  20742. change set.
  20743. </param>
  20744. <param name="flags">
  20745. The flags associated with the connection represented by the
  20746. <paramref name="handle" /> value.
  20747. </param>
  20748. </member>
  20749. <member name="M:System.Data.SQLite.SQLiteChangeSetBase.CreateMetadataItem(System.IntPtr)">
  20750. <summary>
  20751. Creates and returns a concrete implementation of the
  20752. <see cref="T:System.Data.SQLite.ISQLiteChangeSetMetadataItem"/> interface.
  20753. </summary>
  20754. <param name="iterator">
  20755. The native iterator handle to use.
  20756. </param>
  20757. <returns>
  20758. An instance of the <see cref="T:System.Data.SQLite.ISQLiteChangeSetMetadataItem"/>
  20759. interface, which can be used to fetch metadata associated with
  20760. the current item in this set of changes.
  20761. </returns>
  20762. </member>
  20763. <member name="M:System.Data.SQLite.SQLiteChangeSetBase.GetDelegate(System.Data.SQLite.SessionTableFilterCallback,System.Object)">
  20764. <summary>
  20765. Attempts to create a
  20766. <see cref="T:System.Data.SQLite.UnsafeNativeMethods.xSessionFilter"/> native delegate
  20767. that invokes the specified
  20768. <see cref="T:System.Data.SQLite.SessionTableFilterCallback"/> delegate.
  20769. </summary>
  20770. <param name="tableFilterCallback">
  20771. The <see cref="T:System.Data.SQLite.SessionTableFilterCallback"/> to invoke when the
  20772. <see cref="T:System.Data.SQLite.UnsafeNativeMethods.xSessionFilter"/> native delegate
  20773. is called. If this value is null then null is returned.
  20774. </param>
  20775. <param name="clientData">
  20776. The optional application-defined context data. This value may be
  20777. null.
  20778. </param>
  20779. <returns>
  20780. The created <see cref="T:System.Data.SQLite.UnsafeNativeMethods.xSessionFilter"/>
  20781. native delegate -OR- null if it cannot be created.
  20782. </returns>
  20783. </member>
  20784. <member name="M:System.Data.SQLite.SQLiteChangeSetBase.GetDelegate(System.Data.SQLite.SessionConflictCallback,System.Object)">
  20785. <summary>
  20786. Attempts to create a
  20787. <see cref="T:System.Data.SQLite.UnsafeNativeMethods.xSessionConflict"/> native delegate
  20788. that invokes the specified
  20789. <see cref="T:System.Data.SQLite.SessionConflictCallback"/> delegate.
  20790. </summary>
  20791. <param name="conflictCallback">
  20792. The <see cref="T:System.Data.SQLite.SessionConflictCallback"/> to invoke when the
  20793. <see cref="T:System.Data.SQLite.UnsafeNativeMethods.xSessionConflict"/> native delegate
  20794. is called. If this value is null then null is returned.
  20795. </param>
  20796. <param name="clientData">
  20797. The optional application-defined context data. This value may be
  20798. null.
  20799. </param>
  20800. <returns>
  20801. The created <see cref="T:System.Data.SQLite.UnsafeNativeMethods.xSessionConflict"/>
  20802. native delegate -OR- null if it cannot be created.
  20803. </returns>
  20804. </member>
  20805. <member name="F:System.Data.SQLite.SQLiteChangeSetBase.disposed">
  20806. <summary>
  20807. Non-zero if this object instance has been disposed.
  20808. </summary>
  20809. </member>
  20810. <member name="M:System.Data.SQLite.SQLiteChangeSetBase.CheckDisposed">
  20811. <summary>
  20812. Throws an exception if this object instance has been disposed.
  20813. </summary>
  20814. </member>
  20815. <member name="M:System.Data.SQLite.SQLiteChangeSetBase.Dispose(System.Boolean)">
  20816. <summary>
  20817. Disposes or finalizes this object instance.
  20818. </summary>
  20819. <param name="disposing">
  20820. Non-zero if this object is being disposed; otherwise, this object
  20821. is being finalized.
  20822. </param>
  20823. </member>
  20824. <member name="T:System.Data.SQLite.SQLiteMemoryChangeSet">
  20825. <summary>
  20826. This class represents a set of changes contained entirely in memory.
  20827. </summary>
  20828. </member>
  20829. <member name="F:System.Data.SQLite.SQLiteMemoryChangeSet.rawData">
  20830. <summary>
  20831. The raw byte data for this set of changes. Since this data must
  20832. be marshalled to a native memory buffer before being used, there
  20833. must be enough memory available to store at least two times the
  20834. amount of data contained within it.
  20835. </summary>
  20836. </member>
  20837. <member name="F:System.Data.SQLite.SQLiteMemoryChangeSet.startFlags">
  20838. <summary>
  20839. The flags used to create the change set iterator.
  20840. </summary>
  20841. </member>
  20842. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSet.#ctor(System.Byte[],System.Data.SQLite.SQLiteConnectionHandle,System.Data.SQLite.SQLiteConnectionFlags)">
  20843. <summary>
  20844. Constructs an instance of this class using the specified raw byte
  20845. data and wrapped native connection handle.
  20846. </summary>
  20847. <param name="rawData">
  20848. The raw byte data for the specified change set (or patch set).
  20849. </param>
  20850. <param name="handle">
  20851. The wrapped native connection handle to be associated with this
  20852. set of changes.
  20853. </param>
  20854. <param name="connectionFlags">
  20855. The flags associated with the connection represented by the
  20856. <paramref name="handle" /> value.
  20857. </param>
  20858. </member>
  20859. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSet.#ctor(System.Byte[],System.Data.SQLite.SQLiteConnectionHandle,System.Data.SQLite.SQLiteConnectionFlags,System.Data.SQLite.SQLiteChangeSetStartFlags)">
  20860. <summary>
  20861. Constructs an instance of this class using the specified raw byte
  20862. data and wrapped native connection handle.
  20863. </summary>
  20864. <param name="rawData">
  20865. The raw byte data for the specified change set (or patch set).
  20866. </param>
  20867. <param name="handle">
  20868. The wrapped native connection handle to be associated with this
  20869. set of changes.
  20870. </param>
  20871. <param name="connectionFlags">
  20872. The flags associated with the connection represented by the
  20873. <paramref name="handle" /> value.
  20874. </param>
  20875. <param name="startFlags">
  20876. The flags used to create the change set iterator.
  20877. </param>
  20878. </member>
  20879. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSet.Invert">
  20880. <summary>
  20881. This method "inverts" the set of changes within this instance.
  20882. Applying an inverted set of changes to a database reverses the
  20883. effects of applying the uninverted changes. Specifically:
  20884. <![CDATA[<ul>]]><![CDATA[<li>]]>
  20885. Each DELETE change is changed to an INSERT, and
  20886. <![CDATA[</li>]]><![CDATA[<li>]]>
  20887. Each INSERT change is changed to a DELETE, and
  20888. <![CDATA[</li>]]><![CDATA[<li>]]>
  20889. For each UPDATE change, the old.* and new.* values are exchanged.
  20890. <![CDATA[</li>]]><![CDATA[</ul>]]>
  20891. This method does not change the order in which changes appear
  20892. within the set of changes. It merely reverses the sense of each
  20893. individual change.
  20894. </summary>
  20895. <returns>
  20896. The new <see cref="T:System.Data.SQLite.ISQLiteChangeSet"/> instance that represents
  20897. the resulting set of changes.
  20898. </returns>
  20899. </member>
  20900. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSet.CombineWith(System.Data.SQLite.ISQLiteChangeSet)">
  20901. <summary>
  20902. This method combines the specified set of changes with the ones
  20903. contained in this instance.
  20904. </summary>
  20905. <param name="changeSet">
  20906. The changes to be combined with those in this instance.
  20907. </param>
  20908. <returns>
  20909. The new <see cref="T:System.Data.SQLite.ISQLiteChangeSet"/> instance that represents
  20910. the resulting set of changes.
  20911. </returns>
  20912. </member>
  20913. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSet.Apply(System.Data.SQLite.SessionConflictCallback,System.Object)">
  20914. <summary>
  20915. Attempts to apply the set of changes in this instance to the
  20916. associated database.
  20917. </summary>
  20918. <param name="conflictCallback">
  20919. The <see cref="T:System.Data.SQLite.SessionConflictCallback"/> delegate that will need
  20920. to handle any conflicting changes that may arise.
  20921. </param>
  20922. <param name="clientData">
  20923. The optional application-defined context data. This value may be
  20924. null.
  20925. </param>
  20926. </member>
  20927. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSet.Apply(System.Data.SQLite.SessionConflictCallback,System.Data.SQLite.SessionTableFilterCallback,System.Object)">
  20928. <summary>
  20929. Attempts to apply the set of changes in this instance to the
  20930. associated database.
  20931. </summary>
  20932. <param name="conflictCallback">
  20933. The <see cref="T:System.Data.SQLite.SessionConflictCallback"/> delegate that will need
  20934. to handle any conflicting changes that may arise.
  20935. </param>
  20936. <param name="tableFilterCallback">
  20937. The optional <see cref="T:System.Data.SQLite.SessionTableFilterCallback"/> delegate
  20938. that can be used to filter the list of tables impacted by the set
  20939. of changes.
  20940. </param>
  20941. <param name="clientData">
  20942. The optional application-defined context data. This value may be
  20943. null.
  20944. </param>
  20945. </member>
  20946. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSet.GetEnumerator">
  20947. <summary>
  20948. Creates an <see cref="T:System.Collections.IEnumerator"/> capable of iterating over the
  20949. items within this set of changes.
  20950. </summary>
  20951. <returns>
  20952. The new <see cref="T:System.Collections.Generic.IEnumerator`1"/>
  20953. instance.
  20954. </returns>
  20955. </member>
  20956. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSet.System#Collections#IEnumerable#GetEnumerator">
  20957. <summary>
  20958. Creates an <see cref="T:System.Collections.IEnumerator"/> capable of iterating over the
  20959. items within this set of changes.
  20960. </summary>
  20961. <returns>
  20962. The new <see cref="T:System.Collections.IEnumerator"/> instance.
  20963. </returns>
  20964. </member>
  20965. <member name="F:System.Data.SQLite.SQLiteMemoryChangeSet.disposed">
  20966. <summary>
  20967. Non-zero if this object instance has been disposed.
  20968. </summary>
  20969. </member>
  20970. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSet.CheckDisposed">
  20971. <summary>
  20972. Throws an exception if this object instance has been disposed.
  20973. </summary>
  20974. </member>
  20975. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSet.Dispose(System.Boolean)">
  20976. <summary>
  20977. Disposes or finalizes this object instance.
  20978. </summary>
  20979. <param name="disposing">
  20980. Non-zero if this object is being disposed; otherwise, this object
  20981. is being finalized.
  20982. </param>
  20983. </member>
  20984. <member name="T:System.Data.SQLite.SQLiteStreamChangeSet">
  20985. <summary>
  20986. This class represents a set of changes that are backed by a
  20987. <see cref="T:System.IO.Stream"/> instance.
  20988. </summary>
  20989. </member>
  20990. <member name="F:System.Data.SQLite.SQLiteStreamChangeSet.inputStreamAdapter">
  20991. <summary>
  20992. The <see cref="T:System.Data.SQLite.SQLiteStreamAdapter"/> instance that is managing
  20993. the underlying input <see cref="T:System.IO.Stream"/> used as the backing
  20994. store for the set of changes associated with this instance.
  20995. </summary>
  20996. </member>
  20997. <member name="F:System.Data.SQLite.SQLiteStreamChangeSet.outputStreamAdapter">
  20998. <summary>
  20999. The <see cref="T:System.Data.SQLite.SQLiteStreamAdapter"/> instance that is managing
  21000. the underlying output <see cref="T:System.IO.Stream"/> used as the backing
  21001. store for the set of changes generated by the <see cref="M:System.Data.SQLite.SQLiteStreamChangeSet.Invert"/>
  21002. or <see cref="M:System.Data.SQLite.SQLiteStreamChangeSet.CombineWith(System.Data.SQLite.ISQLiteChangeSet)"/> methods.
  21003. </summary>
  21004. </member>
  21005. <member name="F:System.Data.SQLite.SQLiteStreamChangeSet.inputStream">
  21006. <summary>
  21007. The <see cref="T:System.IO.Stream"/> instance used as the backing store for
  21008. the set of changes associated with this instance.
  21009. </summary>
  21010. </member>
  21011. <member name="F:System.Data.SQLite.SQLiteStreamChangeSet.outputStream">
  21012. <summary>
  21013. The <see cref="T:System.IO.Stream"/> instance used as the backing store for
  21014. the set of changes generated by the <see cref="M:System.Data.SQLite.SQLiteStreamChangeSet.Invert"/> or
  21015. <see cref="M:System.Data.SQLite.SQLiteStreamChangeSet.CombineWith(System.Data.SQLite.ISQLiteChangeSet)"/> methods.
  21016. </summary>
  21017. </member>
  21018. <member name="F:System.Data.SQLite.SQLiteStreamChangeSet.startFlags">
  21019. <summary>
  21020. The flags used to create the change set iterator.
  21021. </summary>
  21022. </member>
  21023. <member name="M:System.Data.SQLite.SQLiteStreamChangeSet.#ctor(System.IO.Stream,System.IO.Stream,System.Data.SQLite.SQLiteConnectionHandle,System.Data.SQLite.SQLiteConnectionFlags)">
  21024. <summary>
  21025. Constructs an instance of this class using the specified streams
  21026. and wrapped native connection handle.
  21027. </summary>
  21028. <param name="inputStream">
  21029. The <see cref="T:System.IO.Stream"/> where the raw byte data for the set of
  21030. changes may be read.
  21031. </param>
  21032. <param name="outputStream">
  21033. The <see cref="T:System.IO.Stream"/> where the raw byte data for resulting
  21034. sets of changes may be written.
  21035. </param>
  21036. <param name="handle">
  21037. The wrapped native connection handle to be associated with this
  21038. set of changes.
  21039. </param>
  21040. <param name="connectionFlags">
  21041. The flags associated with the connection represented by the
  21042. <paramref name="handle"/> value.
  21043. </param>
  21044. </member>
  21045. <member name="M:System.Data.SQLite.SQLiteStreamChangeSet.#ctor(System.IO.Stream,System.IO.Stream,System.Data.SQLite.SQLiteConnectionHandle,System.Data.SQLite.SQLiteConnectionFlags,System.Data.SQLite.SQLiteChangeSetStartFlags)">
  21046. <summary>
  21047. Constructs an instance of this class using the specified streams
  21048. and wrapped native connection handle.
  21049. </summary>
  21050. <param name="inputStream">
  21051. The <see cref="T:System.IO.Stream"/> where the raw byte data for the set of
  21052. changes may be read.
  21053. </param>
  21054. <param name="outputStream">
  21055. The <see cref="T:System.IO.Stream"/> where the raw byte data for resulting
  21056. sets of changes may be written.
  21057. </param>
  21058. <param name="handle">
  21059. The wrapped native connection handle to be associated with this
  21060. set of changes.
  21061. </param>
  21062. <param name="connectionFlags">
  21063. The flags associated with the connection represented by the
  21064. <paramref name="handle"/> value.
  21065. </param>
  21066. <param name="startFlags">
  21067. The flags used to create the change set iterator.
  21068. </param>
  21069. </member>
  21070. <member name="M:System.Data.SQLite.SQLiteStreamChangeSet.CheckInputStream">
  21071. <summary>
  21072. Throws an exception if the input stream or its associated stream
  21073. adapter are invalid.
  21074. </summary>
  21075. </member>
  21076. <member name="M:System.Data.SQLite.SQLiteStreamChangeSet.CheckOutputStream">
  21077. <summary>
  21078. Throws an exception if the output stream or its associated stream
  21079. adapter are invalid.
  21080. </summary>
  21081. </member>
  21082. <member name="M:System.Data.SQLite.SQLiteStreamChangeSet.Invert">
  21083. <summary>
  21084. This method "inverts" the set of changes within this instance.
  21085. Applying an inverted set of changes to a database reverses the
  21086. effects of applying the uninverted changes. Specifically:
  21087. <![CDATA[<ul>]]><![CDATA[<li>]]>
  21088. Each DELETE change is changed to an INSERT, and
  21089. <![CDATA[</li>]]><![CDATA[<li>]]>
  21090. Each INSERT change is changed to a DELETE, and
  21091. <![CDATA[</li>]]><![CDATA[<li>]]>
  21092. For each UPDATE change, the old.* and new.* values are exchanged.
  21093. <![CDATA[</li>]]><![CDATA[</ul>]]>
  21094. This method does not change the order in which changes appear
  21095. within the set of changes. It merely reverses the sense of each
  21096. individual change.
  21097. </summary>
  21098. <returns>
  21099. Since the resulting set of changes is written to the output stream,
  21100. this method always returns null.
  21101. </returns>
  21102. </member>
  21103. <member name="M:System.Data.SQLite.SQLiteStreamChangeSet.CombineWith(System.Data.SQLite.ISQLiteChangeSet)">
  21104. <summary>
  21105. This method combines the specified set of changes with the ones
  21106. contained in this instance.
  21107. </summary>
  21108. <param name="changeSet">
  21109. The changes to be combined with those in this instance.
  21110. </param>
  21111. <returns>
  21112. Since the resulting set of changes is written to the output stream,
  21113. this method always returns null.
  21114. </returns>
  21115. </member>
  21116. <member name="M:System.Data.SQLite.SQLiteStreamChangeSet.Apply(System.Data.SQLite.SessionConflictCallback,System.Object)">
  21117. <summary>
  21118. Attempts to apply the set of changes in this instance to the
  21119. associated database.
  21120. </summary>
  21121. <param name="conflictCallback">
  21122. The <see cref="T:System.Data.SQLite.SessionConflictCallback"/> delegate that will need
  21123. to handle any conflicting changes that may arise.
  21124. </param>
  21125. <param name="clientData">
  21126. The optional application-defined context data. This value may be
  21127. null.
  21128. </param>
  21129. </member>
  21130. <member name="M:System.Data.SQLite.SQLiteStreamChangeSet.Apply(System.Data.SQLite.SessionConflictCallback,System.Data.SQLite.SessionTableFilterCallback,System.Object)">
  21131. <summary>
  21132. Attempts to apply the set of changes in this instance to the
  21133. associated database.
  21134. </summary>
  21135. <param name="conflictCallback">
  21136. The <see cref="T:System.Data.SQLite.SessionConflictCallback"/> delegate that will need
  21137. to handle any conflicting changes that may arise.
  21138. </param>
  21139. <param name="tableFilterCallback">
  21140. The optional <see cref="T:System.Data.SQLite.SessionTableFilterCallback"/> delegate
  21141. that can be used to filter the list of tables impacted by the set
  21142. of changes.
  21143. </param>
  21144. <param name="clientData">
  21145. The optional application-defined context data. This value may be
  21146. null.
  21147. </param>
  21148. </member>
  21149. <member name="M:System.Data.SQLite.SQLiteStreamChangeSet.GetEnumerator">
  21150. <summary>
  21151. Creates an <see cref="T:System.Collections.IEnumerator"/> capable of iterating over the
  21152. items within this set of changes.
  21153. </summary>
  21154. <returns>
  21155. The new <see cref="T:System.Collections.Generic.IEnumerator`1"/>
  21156. instance.
  21157. </returns>
  21158. </member>
  21159. <member name="M:System.Data.SQLite.SQLiteStreamChangeSet.System#Collections#IEnumerable#GetEnumerator">
  21160. <summary>
  21161. Creates an <see cref="T:System.Collections.IEnumerator"/> capable of iterating over the
  21162. items within this set of changes.
  21163. </summary>
  21164. <returns>
  21165. The new <see cref="T:System.Collections.IEnumerator"/> instance.
  21166. </returns>
  21167. </member>
  21168. <member name="F:System.Data.SQLite.SQLiteStreamChangeSet.disposed">
  21169. <summary>
  21170. Non-zero if this object instance has been disposed.
  21171. </summary>
  21172. </member>
  21173. <member name="M:System.Data.SQLite.SQLiteStreamChangeSet.CheckDisposed">
  21174. <summary>
  21175. Throws an exception if this object instance has been disposed.
  21176. </summary>
  21177. </member>
  21178. <member name="M:System.Data.SQLite.SQLiteStreamChangeSet.Dispose(System.Boolean)">
  21179. <summary>
  21180. Disposes or finalizes this object instance.
  21181. </summary>
  21182. <param name="disposing">
  21183. Non-zero if this object is being disposed; otherwise, this object
  21184. is being finalized.
  21185. </param>
  21186. </member>
  21187. <member name="T:System.Data.SQLite.SQLiteChangeSetEnumerator">
  21188. <summary>
  21189. This class represents an <see cref="T:System.Collections.IEnumerator"/> that is capable of
  21190. enumerating over a set of changes. It serves as the base class for the
  21191. <see cref="T:System.Data.SQLite.SQLiteMemoryChangeSetEnumerator"/> and
  21192. <see cref="T:System.Data.SQLite.SQLiteStreamChangeSetEnumerator"/> classes. It manages and
  21193. owns an instance of the <see cref="T:System.Data.SQLite.SQLiteChangeSetIterator"/> class.
  21194. </summary>
  21195. </member>
  21196. <member name="F:System.Data.SQLite.SQLiteChangeSetEnumerator.iterator">
  21197. <summary>
  21198. This managed change set iterator is managed and owned by this
  21199. class. It will be disposed when this class is disposed.
  21200. </summary>
  21201. </member>
  21202. <member name="M:System.Data.SQLite.SQLiteChangeSetEnumerator.#ctor(System.Data.SQLite.SQLiteChangeSetIterator)">
  21203. <summary>
  21204. Constructs an instance of this class using the specified managed
  21205. change set iterator.
  21206. </summary>
  21207. <param name="iterator">
  21208. The managed iterator instance to use.
  21209. </param>
  21210. </member>
  21211. <member name="M:System.Data.SQLite.SQLiteChangeSetEnumerator.CheckIterator">
  21212. <summary>
  21213. Throws an exception if the managed iterator instance is invalid.
  21214. </summary>
  21215. </member>
  21216. <member name="M:System.Data.SQLite.SQLiteChangeSetEnumerator.SetIterator(System.Data.SQLite.SQLiteChangeSetIterator)">
  21217. <summary>
  21218. Sets the managed iterator instance to a new value.
  21219. </summary>
  21220. <param name="iterator">
  21221. The new managed iterator instance to use.
  21222. </param>
  21223. </member>
  21224. <member name="M:System.Data.SQLite.SQLiteChangeSetEnumerator.CloseIterator">
  21225. <summary>
  21226. Disposes of the managed iterator instance and sets its value to
  21227. null.
  21228. </summary>
  21229. </member>
  21230. <member name="M:System.Data.SQLite.SQLiteChangeSetEnumerator.ResetIterator(System.Data.SQLite.SQLiteChangeSetIterator)">
  21231. <summary>
  21232. Disposes of the existing managed iterator instance and then sets it
  21233. to a new value.
  21234. </summary>
  21235. <param name="iterator">
  21236. The new managed iterator instance to use.
  21237. </param>
  21238. </member>
  21239. <member name="M:System.Data.SQLite.SQLiteChangeSetEnumerator.MoveNext">
  21240. <summary>
  21241. Attempts to advance to the next item in the set of changes.
  21242. </summary>
  21243. <returns>
  21244. Non-zero if more items are available; otherwise, zero.
  21245. </returns>
  21246. </member>
  21247. <member name="M:System.Data.SQLite.SQLiteChangeSetEnumerator.Reset">
  21248. <summary>
  21249. Throws <see cref="T:System.NotImplementedException"/> because not all the
  21250. derived classes are able to support reset functionality.
  21251. </summary>
  21252. </member>
  21253. <member name="M:System.Data.SQLite.SQLiteChangeSetEnumerator.Dispose">
  21254. <summary>
  21255. Disposes of this object instance.
  21256. </summary>
  21257. </member>
  21258. <member name="F:System.Data.SQLite.SQLiteChangeSetEnumerator.disposed">
  21259. <summary>
  21260. Non-zero if this object instance has been disposed.
  21261. </summary>
  21262. </member>
  21263. <member name="M:System.Data.SQLite.SQLiteChangeSetEnumerator.CheckDisposed">
  21264. <summary>
  21265. Throws an exception if this object instance has been disposed.
  21266. </summary>
  21267. </member>
  21268. <member name="M:System.Data.SQLite.SQLiteChangeSetEnumerator.Dispose(System.Boolean)">
  21269. <summary>
  21270. Disposes or finalizes this object instance.
  21271. </summary>
  21272. <param name="disposing">
  21273. Non-zero if this object is being disposed; otherwise, this object
  21274. is being finalized.
  21275. </param>
  21276. </member>
  21277. <member name="M:System.Data.SQLite.SQLiteChangeSetEnumerator.Finalize">
  21278. <summary>
  21279. Finalizes this object instance.
  21280. </summary>
  21281. </member>
  21282. <member name="P:System.Data.SQLite.SQLiteChangeSetEnumerator.Current">
  21283. <summary>
  21284. Returns the current change within the set of changes, represented
  21285. by a <see cref="T:System.Data.SQLite.ISQLiteChangeSetMetadataItem"/> instance.
  21286. </summary>
  21287. </member>
  21288. <member name="P:System.Data.SQLite.SQLiteChangeSetEnumerator.System#Collections#IEnumerator#Current">
  21289. <summary>
  21290. Returns the current change within the set of changes, represented
  21291. by a <see cref="T:System.Data.SQLite.ISQLiteChangeSetMetadataItem"/> instance.
  21292. </summary>
  21293. </member>
  21294. <member name="T:System.Data.SQLite.SQLiteMemoryChangeSetEnumerator">
  21295. <summary>
  21296. This class represents an <see cref="T:System.Collections.IEnumerator"/> that is capable of
  21297. enumerating over a set of changes contained entirely in memory.
  21298. </summary>
  21299. </member>
  21300. <member name="F:System.Data.SQLite.SQLiteMemoryChangeSetEnumerator.rawData">
  21301. <summary>
  21302. The raw byte data for this set of changes. Since this data must
  21303. be marshalled to a native memory buffer before being used, there
  21304. must be enough memory available to store at least two times the
  21305. amount of data contained within it.
  21306. </summary>
  21307. </member>
  21308. <member name="F:System.Data.SQLite.SQLiteMemoryChangeSetEnumerator.flags">
  21309. <summary>
  21310. The flags used to create the change set iterator.
  21311. </summary>
  21312. </member>
  21313. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSetEnumerator.#ctor(System.Byte[])">
  21314. <summary>
  21315. Constructs an instance of this class using the specified raw byte
  21316. data.
  21317. </summary>
  21318. <param name="rawData">
  21319. The raw byte data containing the set of changes for this
  21320. enumerator.
  21321. </param>
  21322. </member>
  21323. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSetEnumerator.#ctor(System.Byte[],System.Data.SQLite.SQLiteChangeSetStartFlags)">
  21324. <summary>
  21325. Constructs an instance of this class using the specified raw byte
  21326. data.
  21327. </summary>
  21328. <param name="rawData">
  21329. The raw byte data containing the set of changes for this
  21330. enumerator.
  21331. </param>
  21332. <param name="flags">
  21333. The flags used to create the change set iterator.
  21334. </param>
  21335. </member>
  21336. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSetEnumerator.Reset">
  21337. <summary>
  21338. Resets the enumerator to its initial position.
  21339. </summary>
  21340. </member>
  21341. <member name="F:System.Data.SQLite.SQLiteMemoryChangeSetEnumerator.disposed">
  21342. <summary>
  21343. Non-zero if this object instance has been disposed.
  21344. </summary>
  21345. </member>
  21346. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSetEnumerator.CheckDisposed">
  21347. <summary>
  21348. Throws an exception if this object instance has been disposed.
  21349. </summary>
  21350. </member>
  21351. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSetEnumerator.Dispose(System.Boolean)">
  21352. <summary>
  21353. Disposes or finalizes this object instance.
  21354. </summary>
  21355. <param name="disposing">
  21356. Non-zero if this object is being disposed; otherwise, this object
  21357. is being finalized.
  21358. </param>
  21359. </member>
  21360. <member name="T:System.Data.SQLite.SQLiteStreamChangeSetEnumerator">
  21361. <summary>
  21362. This class represents an <see cref="T:System.Collections.IEnumerator"/> that is capable of
  21363. enumerating over a set of changes backed by a <see cref="T:System.IO.Stream"/>
  21364. instance.
  21365. </summary>
  21366. </member>
  21367. <member name="M:System.Data.SQLite.SQLiteStreamChangeSetEnumerator.#ctor(System.IO.Stream,System.Data.SQLite.SQLiteConnectionFlags)">
  21368. <summary>
  21369. Constructs an instance of this class using the specified stream.
  21370. </summary>
  21371. <param name="stream">
  21372. The <see cref="T:System.IO.Stream"/> where the raw byte data for the set of
  21373. changes may be read.
  21374. </param>
  21375. <param name="connectionFlags">
  21376. The flags associated with the parent connection.
  21377. </param>
  21378. </member>
  21379. <member name="M:System.Data.SQLite.SQLiteStreamChangeSetEnumerator.#ctor(System.IO.Stream,System.Data.SQLite.SQLiteConnectionFlags,System.Data.SQLite.SQLiteChangeSetStartFlags)">
  21380. <summary>
  21381. Constructs an instance of this class using the specified stream.
  21382. </summary>
  21383. <param name="stream">
  21384. The <see cref="T:System.IO.Stream"/> where the raw byte data for the set of
  21385. changes may be read.
  21386. </param>
  21387. <param name="connectionFlags">
  21388. The flags associated with the parent connection.
  21389. </param>
  21390. <param name="startFlags">
  21391. The flags used to create the change set iterator.
  21392. </param>
  21393. </member>
  21394. <member name="F:System.Data.SQLite.SQLiteStreamChangeSetEnumerator.disposed">
  21395. <summary>
  21396. Non-zero if this object instance has been disposed.
  21397. </summary>
  21398. </member>
  21399. <member name="M:System.Data.SQLite.SQLiteStreamChangeSetEnumerator.CheckDisposed">
  21400. <summary>
  21401. Throws an exception if this object instance has been disposed.
  21402. </summary>
  21403. </member>
  21404. <member name="M:System.Data.SQLite.SQLiteStreamChangeSetEnumerator.Dispose(System.Boolean)">
  21405. <summary>
  21406. Disposes or finalizes this object instance.
  21407. </summary>
  21408. <param name="disposing">
  21409. Non-zero if this object is being disposed; otherwise, this object
  21410. is being finalized.
  21411. </param>
  21412. </member>
  21413. <member name="T:System.Data.SQLite.SQLiteChangeSetMetadataItem">
  21414. <summary>
  21415. This interface implements properties and methods used to fetch metadata
  21416. about one change within a set of changes for a database.
  21417. </summary>
  21418. </member>
  21419. <member name="F:System.Data.SQLite.SQLiteChangeSetMetadataItem.iterator">
  21420. <summary>
  21421. The <see cref="T:System.Data.SQLite.SQLiteChangeSetIterator"/> instance to use. This
  21422. will NOT be owned by this class and will not be disposed upon this
  21423. class being disposed or finalized.
  21424. </summary>
  21425. </member>
  21426. <member name="M:System.Data.SQLite.SQLiteChangeSetMetadataItem.#ctor(System.Data.SQLite.SQLiteChangeSetIterator)">
  21427. <summary>
  21428. Constructs an instance of this class using the specified iterator
  21429. instance.
  21430. </summary>
  21431. <param name="iterator">
  21432. The managed iterator instance to use.
  21433. </param>
  21434. </member>
  21435. <member name="M:System.Data.SQLite.SQLiteChangeSetMetadataItem.CheckIterator">
  21436. <summary>
  21437. Throws an exception if the managed iterator instance is invalid.
  21438. </summary>
  21439. </member>
  21440. <member name="M:System.Data.SQLite.SQLiteChangeSetMetadataItem.PopulateOperationMetadata">
  21441. <summary>
  21442. Populates the underlying data for the <see cref="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.TableName"/>,
  21443. <see cref="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.NumberOfColumns"/>, <see cref="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.OperationCode"/>, and
  21444. <see cref="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.Indirect"/> properties, using the appropriate native
  21445. API.
  21446. </summary>
  21447. </member>
  21448. <member name="M:System.Data.SQLite.SQLiteChangeSetMetadataItem.PopulatePrimaryKeyColumns">
  21449. <summary>
  21450. Populates the underlying data for the
  21451. <see cref="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.PrimaryKeyColumns"/> property using the appropriate
  21452. native API.
  21453. </summary>
  21454. </member>
  21455. <member name="M:System.Data.SQLite.SQLiteChangeSetMetadataItem.PopulateNumberOfForeignKeyConflicts">
  21456. <summary>
  21457. Populates the underlying data for the
  21458. <see cref="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.NumberOfForeignKeyConflicts"/> property using the
  21459. appropriate native API.
  21460. </summary>
  21461. </member>
  21462. <member name="F:System.Data.SQLite.SQLiteChangeSetMetadataItem.tableName">
  21463. <summary>
  21464. Backing field for the <see cref="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.TableName"/> property. This value
  21465. will be null if this field has not yet been populated via the
  21466. underlying native API.
  21467. </summary>
  21468. </member>
  21469. <member name="F:System.Data.SQLite.SQLiteChangeSetMetadataItem.numberOfColumns">
  21470. <summary>
  21471. Backing field for the <see cref="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.NumberOfColumns"/> property. This
  21472. value will be null if this field has not yet been populated via the
  21473. underlying native API.
  21474. </summary>
  21475. </member>
  21476. <member name="F:System.Data.SQLite.SQLiteChangeSetMetadataItem.operationCode">
  21477. <summary>
  21478. Backing field for the <see cref="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.OperationCode"/> property. This
  21479. value will be null if this field has not yet been populated via the
  21480. underlying native API.
  21481. </summary>
  21482. </member>
  21483. <member name="F:System.Data.SQLite.SQLiteChangeSetMetadataItem.indirect">
  21484. <summary>
  21485. Backing field for the <see cref="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.Indirect"/> property. This value
  21486. will be null if this field has not yet been populated via the
  21487. underlying native API.
  21488. </summary>
  21489. </member>
  21490. <member name="F:System.Data.SQLite.SQLiteChangeSetMetadataItem.primaryKeyColumns">
  21491. <summary>
  21492. Backing field for the <see cref="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.PrimaryKeyColumns"/> property.
  21493. This value will be null if this field has not yet been populated
  21494. via the underlying native API.
  21495. </summary>
  21496. </member>
  21497. <member name="F:System.Data.SQLite.SQLiteChangeSetMetadataItem.numberOfForeignKeyConflicts">
  21498. <summary>
  21499. Backing field for the <see cref="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.NumberOfForeignKeyConflicts"/>
  21500. property. This value will be null if this field has not yet been
  21501. populated via the underlying native API.
  21502. </summary>
  21503. </member>
  21504. <member name="M:System.Data.SQLite.SQLiteChangeSetMetadataItem.GetOldValue(System.Int32)">
  21505. <summary>
  21506. Queries and returns the original value of a given column for this
  21507. change. This method may only be called when the
  21508. <see cref="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.OperationCode"/> has a value of
  21509. <see cref="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Update"/> or
  21510. <see cref="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Delete"/>.
  21511. </summary>
  21512. <param name="columnIndex">
  21513. The index for the column. This value must be between zero and one
  21514. less than the total number of columns for this table.
  21515. </param>
  21516. <returns>
  21517. The original value of a given column for this change.
  21518. </returns>
  21519. </member>
  21520. <member name="M:System.Data.SQLite.SQLiteChangeSetMetadataItem.GetNewValue(System.Int32)">
  21521. <summary>
  21522. Queries and returns the updated value of a given column for this
  21523. change. This method may only be called when the
  21524. <see cref="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.OperationCode"/> has a value of
  21525. <see cref="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Insert"/> or
  21526. <see cref="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Update"/>.
  21527. </summary>
  21528. <param name="columnIndex">
  21529. The index for the column. This value must be between zero and one
  21530. less than the total number of columns for this table.
  21531. </param>
  21532. <returns>
  21533. The updated value of a given column for this change.
  21534. </returns>
  21535. </member>
  21536. <member name="M:System.Data.SQLite.SQLiteChangeSetMetadataItem.GetConflictValue(System.Int32)">
  21537. <summary>
  21538. Queries and returns the conflicting value of a given column for
  21539. this change. This method may only be called from within a
  21540. <see cref="T:System.Data.SQLite.SessionConflictCallback"/> delegate when the conflict
  21541. type is <see cref="F:System.Data.SQLite.SQLiteChangeSetConflictType.Data"/> or
  21542. <see cref="F:System.Data.SQLite.SQLiteChangeSetConflictType.Conflict"/>.
  21543. </summary>
  21544. <param name="columnIndex">
  21545. The index for the column. This value must be between zero and one
  21546. less than the total number of columns for this table.
  21547. </param>
  21548. <returns>
  21549. The conflicting value of a given column for this change.
  21550. </returns>
  21551. </member>
  21552. <member name="M:System.Data.SQLite.SQLiteChangeSetMetadataItem.Dispose">
  21553. <summary>
  21554. Disposes of this object instance.
  21555. </summary>
  21556. </member>
  21557. <member name="F:System.Data.SQLite.SQLiteChangeSetMetadataItem.disposed">
  21558. <summary>
  21559. Non-zero if this object instance has been disposed.
  21560. </summary>
  21561. </member>
  21562. <member name="M:System.Data.SQLite.SQLiteChangeSetMetadataItem.CheckDisposed">
  21563. <summary>
  21564. Throws an exception if this object instance has been disposed.
  21565. </summary>
  21566. </member>
  21567. <member name="M:System.Data.SQLite.SQLiteChangeSetMetadataItem.Dispose(System.Boolean)">
  21568. <summary>
  21569. Disposes or finalizes this object instance.
  21570. </summary>
  21571. <param name="disposing">
  21572. Non-zero if this object is being disposed; otherwise, this object
  21573. is being finalized.
  21574. </param>
  21575. </member>
  21576. <member name="M:System.Data.SQLite.SQLiteChangeSetMetadataItem.Finalize">
  21577. <summary>
  21578. Finalizes this object instance.
  21579. </summary>
  21580. </member>
  21581. <member name="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.TableName">
  21582. <summary>
  21583. The name of the table the change was made to.
  21584. </summary>
  21585. </member>
  21586. <member name="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.NumberOfColumns">
  21587. <summary>
  21588. The number of columns impacted by this change. This value can be
  21589. used to determine the highest valid column index that may be used
  21590. with the <see cref="M:System.Data.SQLite.SQLiteChangeSetMetadataItem.GetOldValue(System.Int32)"/>, <see cref="M:System.Data.SQLite.SQLiteChangeSetMetadataItem.GetNewValue(System.Int32)"/>,
  21591. and <see cref="M:System.Data.SQLite.SQLiteChangeSetMetadataItem.GetConflictValue(System.Int32)"/> methods of this interface. It
  21592. will be this value minus one.
  21593. </summary>
  21594. </member>
  21595. <member name="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.OperationCode">
  21596. <summary>
  21597. This will contain the value
  21598. <see cref="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Insert"/>,
  21599. <see cref="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Update"/>, or
  21600. <see cref="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Delete"/>, corresponding to
  21601. the overall type of change this item represents.
  21602. </summary>
  21603. </member>
  21604. <member name="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.Indirect">
  21605. <summary>
  21606. Non-zero if this change is considered to be indirect (i.e. as
  21607. though they were made via a trigger or foreign key action).
  21608. </summary>
  21609. </member>
  21610. <member name="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.PrimaryKeyColumns">
  21611. <summary>
  21612. This array contains a <see cref="T:System.Boolean"/> for each column in
  21613. the table associated with this change. The element will be zero
  21614. if the column is not part of the primary key; otherwise, it will
  21615. be non-zero.
  21616. </summary>
  21617. </member>
  21618. <member name="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.NumberOfForeignKeyConflicts">
  21619. <summary>
  21620. This method may only be called from within a
  21621. <see cref="T:System.Data.SQLite.SessionConflictCallback"/> delegate when the conflict
  21622. type is <see cref="F:System.Data.SQLite.SQLiteChangeSetConflictType.ForeignKey"/>. It
  21623. returns the total number of known foreign key violations in the
  21624. destination database.
  21625. </summary>
  21626. </member>
  21627. </members>
  21628. </doc>