懒人记时 代码仓库
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.

21379 lines
1.0 MiB

преди 2 години
  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="F:System.Data.SQLite.SQLite3.dbName">
  70. <summary>
  71. This field is used to refer to memory allocated for the
  72. SQLITE_DBCONFIG_MAINDBNAME value used with the native
  73. "sqlite3_db_config" API. If allocated, the associated
  74. memeory will be freed when the underlying connection is
  75. closed.
  76. </summary>
  77. </member>
  78. <member name="F:System.Data.SQLite.SQLite3._sql">
  79. <summary>
  80. The opaque pointer returned to us by the sqlite provider
  81. </summary>
  82. </member>
  83. <member name="F:System.Data.SQLite.SQLite3._functions">
  84. <summary>
  85. The user-defined functions registered on this connection
  86. </summary>
  87. </member>
  88. <member name="F:System.Data.SQLite.SQLite3._shimExtensionFileName">
  89. <summary>
  90. This is the name of the native library file that contains the
  91. "vtshim" extension [wrapper].
  92. </summary>
  93. </member>
  94. <member name="F:System.Data.SQLite.SQLite3._shimIsLoadNeeded">
  95. <summary>
  96. This is the flag indicate whether the native library file that
  97. contains the "vtshim" extension must be dynamically loaded by
  98. this class prior to use.
  99. </summary>
  100. </member>
  101. <member name="F:System.Data.SQLite.SQLite3._shimExtensionProcName">
  102. <summary>
  103. This is the name of the native entry point for the "vtshim"
  104. extension [wrapper].
  105. </summary>
  106. </member>
  107. <member name="F:System.Data.SQLite.SQLite3._modules">
  108. <summary>
  109. The modules created using this connection.
  110. </summary>
  111. </member>
  112. <member name="M:System.Data.SQLite.SQLite3.#ctor(System.Data.SQLite.SQLiteDateFormats,System.DateTimeKind,System.String,System.IntPtr,System.String,System.Boolean)">
  113. <summary>
  114. Constructs the object used to interact with the SQLite core library
  115. using the UTF-8 text encoding.
  116. </summary>
  117. <param name="fmt">
  118. The DateTime format to be used when converting string values to a
  119. DateTime and binding DateTime parameters.
  120. </param>
  121. <param name="kind">
  122. The <see cref="T:System.DateTimeKind" /> to be used when creating DateTime
  123. values.
  124. </param>
  125. <param name="fmtString">
  126. The format string to be used when parsing and formatting DateTime
  127. values.
  128. </param>
  129. <param name="db">
  130. The native handle to be associated with the database connection.
  131. </param>
  132. <param name="fileName">
  133. The fully qualified file name associated with <paramref name="db "/>.
  134. </param>
  135. <param name="ownHandle">
  136. Non-zero if the newly created object instance will need to dispose
  137. of <paramref name="db" /> when it is no longer needed.
  138. </param>
  139. </member>
  140. <member name="M:System.Data.SQLite.SQLite3.DisposeModules">
  141. <summary>
  142. This method attempts to dispose of all the <see cref="T:System.Data.SQLite.SQLiteModule" /> derived
  143. object instances currently associated with the native database connection.
  144. </summary>
  145. </member>
  146. <member name="M:System.Data.SQLite.SQLite3.GetCancelCount">
  147. <summary>
  148. Returns the number of times the <see cref="M:System.Data.SQLite.SQLite3.Cancel" /> method has been
  149. called.
  150. </summary>
  151. </member>
  152. <member name="M:System.Data.SQLite.SQLite3.ShouldThrowForCancel">
  153. <summary>
  154. This method determines whether or not a <see cref="T:System.Data.SQLite.SQLiteException" />
  155. with a return code of <see cref="F:System.Data.SQLite.SQLiteErrorCode.Interrupt" /> should
  156. be thrown after making a call into the SQLite core library.
  157. </summary>
  158. <returns>
  159. Non-zero if a <see cref="T:System.Data.SQLite.SQLiteException" /> to be thrown. This method
  160. will only return non-zero if the <see cref="M:System.Data.SQLite.SQLite3.Cancel" /> method was called
  161. one or more times during a call into the SQLite core library (e.g. when
  162. the sqlite3_prepare*() or sqlite3_step() APIs are used).
  163. </returns>
  164. </member>
  165. <member name="M:System.Data.SQLite.SQLite3.ResetCancelCount">
  166. <summary>
  167. Resets the value of the <see cref="F:System.Data.SQLite.SQLite3._cancelCount" /> field.
  168. </summary>
  169. </member>
  170. <member name="M:System.Data.SQLite.SQLite3.Cancel">
  171. <summary>
  172. Attempts to interrupt the query currently executing on the associated
  173. native database connection.
  174. </summary>
  175. </member>
  176. <member name="M:System.Data.SQLite.SQLite3.BindFunction(System.Data.SQLite.SQLiteFunctionAttribute,System.Data.SQLite.SQLiteFunction,System.Data.SQLite.SQLiteConnectionFlags)">
  177. <summary>
  178. This function binds a user-defined function to the connection.
  179. </summary>
  180. <param name="functionAttribute">
  181. The <see cref="T:System.Data.SQLite.SQLiteFunctionAttribute"/> object instance containing
  182. the metadata for the function to be bound.
  183. </param>
  184. <param name="function">
  185. The <see cref="T:System.Data.SQLite.SQLiteFunction"/> object instance that implements the
  186. function to be bound.
  187. </param>
  188. <param name="flags">
  189. The flags associated with the parent connection object.
  190. </param>
  191. </member>
  192. <member name="M:System.Data.SQLite.SQLite3.UnbindFunction(System.Data.SQLite.SQLiteFunctionAttribute,System.Data.SQLite.SQLiteConnectionFlags)">
  193. <summary>
  194. This function binds a user-defined function to the connection.
  195. </summary>
  196. <param name="functionAttribute">
  197. The <see cref="T:System.Data.SQLite.SQLiteFunctionAttribute"/> object instance containing
  198. the metadata for the function to be unbound.
  199. </param>
  200. <param name="flags">
  201. The flags associated with the parent connection object.
  202. </param>
  203. <returns>Non-zero if the function was unbound and removed.</returns>
  204. </member>
  205. <member name="P:System.Data.SQLite.SQLite3.OwnHandle">
  206. <summary>
  207. Returns non-zero if the underlying native connection handle is owned
  208. by this instance.
  209. </summary>
  210. </member>
  211. <member name="P:System.Data.SQLite.SQLite3.Functions">
  212. <summary>
  213. Returns the logical list of functions associated with this connection.
  214. </summary>
  215. </member>
  216. <member name="M:System.Data.SQLite.SQLite3.ReleaseMemory">
  217. <summary>
  218. Attempts to free as much heap memory as possible for the database connection.
  219. </summary>
  220. <returns>A standard SQLite return code (i.e. zero for success and non-zero for failure).</returns>
  221. </member>
  222. <member name="M:System.Data.SQLite.SQLite3.StaticReleaseMemory(System.Int32,System.Boolean,System.Boolean,System.Int32@,System.Boolean@,System.UInt32@)">
  223. <summary>
  224. Attempts to free N bytes of heap memory by deallocating non-essential memory
  225. allocations held by the database library. Memory used to cache database pages
  226. to improve performance is an example of non-essential memory. This is a no-op
  227. returning zero if the SQLite core library was not compiled with the compile-time
  228. option SQLITE_ENABLE_MEMORY_MANAGEMENT. Optionally, attempts to reset and/or
  229. compact the Win32 native heap, if applicable.
  230. </summary>
  231. <param name="nBytes">
  232. The requested number of bytes to free.
  233. </param>
  234. <param name="reset">
  235. Non-zero to attempt a heap reset.
  236. </param>
  237. <param name="compact">
  238. Non-zero to attempt heap compaction.
  239. </param>
  240. <param name="nFree">
  241. The number of bytes actually freed. This value may be zero.
  242. </param>
  243. <param name="resetOk">
  244. This value will be non-zero if the heap reset was successful.
  245. </param>
  246. <param name="nLargest">
  247. The size of the largest committed free block in the heap, in bytes.
  248. This value will be zero unless heap compaction is enabled.
  249. </param>
  250. <returns>
  251. A standard SQLite return code (i.e. zero for success and non-zero
  252. for failure).
  253. </returns>
  254. </member>
  255. <member name="M:System.Data.SQLite.SQLite3.Shutdown">
  256. <summary>
  257. Shutdown the SQLite engine so that it can be restarted with different
  258. configuration options. We depend on auto initialization to recover.
  259. </summary>
  260. <returns>Returns a standard SQLite result code.</returns>
  261. </member>
  262. <member name="M:System.Data.SQLite.SQLite3.StaticShutdown(System.Boolean)">
  263. <summary>
  264. Shutdown the SQLite engine so that it can be restarted with different
  265. configuration options. We depend on auto initialization to recover.
  266. </summary>
  267. <param name="directories">
  268. Non-zero to reset the database and temporary directories to their
  269. default values, which should be null for both. This parameter has no
  270. effect on non-Windows operating systems.
  271. </param>
  272. <returns>Returns a standard SQLite result code.</returns>
  273. </member>
  274. <member name="M:System.Data.SQLite.SQLite3.IsOpen">
  275. <summary>
  276. Determines if the associated native connection handle is open.
  277. </summary>
  278. <returns>
  279. Non-zero if the associated native connection handle is open.
  280. </returns>
  281. </member>
  282. <member name="M:System.Data.SQLite.SQLite3.GetFileName(System.String)">
  283. <summary>
  284. Returns the fully qualified path and file name for the currently open
  285. database, if any.
  286. </summary>
  287. <param name="dbName">
  288. The name of the attached database to query.
  289. </param>
  290. <returns>
  291. The fully qualified path and file name for the currently open database,
  292. if any.
  293. </returns>
  294. </member>
  295. <member name="M:System.Data.SQLite.SQLite3.IsAllowedToUsePool(System.Data.SQLite.SQLiteOpenFlagsEnum)">
  296. <summary>
  297. This method attempts to determine if a database connection opened
  298. with the specified <see cref="T:System.Data.SQLite.SQLiteOpenFlagsEnum" /> should be
  299. allowed into the connection pool.
  300. </summary>
  301. <param name="openFlags">
  302. The <see cref="T:System.Data.SQLite.SQLiteOpenFlagsEnum" /> that were specified when the
  303. connection was opened.
  304. </param>
  305. <returns>
  306. Non-zero if the connection should (eventually) be allowed into the
  307. connection pool; otherwise, zero.
  308. </returns>
  309. </member>
  310. <member name="F:System.Data.SQLite.SQLite3.have_errstr">
  311. <summary>
  312. Has the sqlite3_errstr() core library API been checked for yet?
  313. If so, is it present?
  314. </summary>
  315. </member>
  316. <member name="M:System.Data.SQLite.SQLite3.GetErrorString(System.Data.SQLite.SQLiteErrorCode)">
  317. <summary>
  318. Returns the error message for the specified SQLite return code using
  319. the sqlite3_errstr() function, falling back to the internal lookup
  320. table if necessary.
  321. WARNING: Do not remove this method, it is used via reflection.
  322. </summary>
  323. <param name="rc">The SQLite return code.</param>
  324. <returns>The error message or null if it cannot be found.</returns>
  325. </member>
  326. <member name="F:System.Data.SQLite.SQLite3.have_stmt_readonly">
  327. <summary>
  328. Has the sqlite3_stmt_readonly() core library API been checked for yet?
  329. If so, is it present?
  330. </summary>
  331. </member>
  332. <member name="M:System.Data.SQLite.SQLite3.IsReadOnly(System.Data.SQLite.SQLiteStatement)">
  333. <summary>
  334. Returns non-zero if the specified statement is read-only in nature.
  335. </summary>
  336. <param name="stmt">The statement to check.</param>
  337. <returns>True if the outer query is read-only.</returns>
  338. </member>
  339. <member name="F:System.Data.SQLite.SQLite3.forceLogPrepare">
  340. <summary>
  341. This field is used to keep track of whether or not the
  342. "SQLite_ForceLogPrepare" environment variable has been queried. If so,
  343. it will only be non-zero if the environment variable was present.
  344. </summary>
  345. </member>
  346. <member name="F:System.Data.SQLite.SQLite3.forceLogLifecycle">
  347. <summary>
  348. This field is used to keep track of whether or not the
  349. "SQLite_ForceLogLifecycle" environment variable has been queried. If
  350. so, it will only be non-zero if the environment variable was present.
  351. </summary>
  352. </member>
  353. <member name="M:System.Data.SQLite.SQLite3.ForceLogPrepare">
  354. <summary>
  355. Determines if all calls to prepare a SQL query will be logged,
  356. regardless of the flags for the associated connection.
  357. </summary>
  358. <returns>
  359. Non-zero to log all calls to prepare a SQL query.
  360. </returns>
  361. </member>
  362. <member name="M:System.Data.SQLite.SQLite3.ForceLogLifecycle">
  363. <summary>
  364. Determines if calls into key members pertaining to the lifecycle of
  365. connections and their associated classes will be logged, regardless
  366. of the flags for the associated connection.
  367. </summary>
  368. <returns>
  369. Non-zero to log calls into key members pertaining to the lifecycle of
  370. connections and their associated classes (e.g. LINQ, EF6, etc).
  371. </returns>
  372. </member>
  373. <member name="M:System.Data.SQLite.SQLite3.GetShimExtensionFileName(System.Boolean@)">
  374. <summary>
  375. Determines the file name of the native library containing the native
  376. "vtshim" extension -AND- whether it should be dynamically loaded by
  377. this class.
  378. </summary>
  379. <param name="isLoadNeeded">
  380. This output parameter will be set to non-zero if the returned native
  381. library file name should be dynamically loaded prior to attempting
  382. the creation of native disposable extension modules.
  383. </param>
  384. <returns>
  385. The file name of the native library containing the native "vtshim"
  386. extension -OR- null if it cannot be determined.
  387. </returns>
  388. </member>
  389. <member name="M:System.Data.SQLite.SQLite3.CreateModule(System.Data.SQLite.SQLiteModule,System.Data.SQLite.SQLiteConnectionFlags)">
  390. <summary>
  391. Calls the native SQLite core library in order to create a disposable
  392. module containing the implementation of a virtual table.
  393. </summary>
  394. <param name="module">
  395. The module object to be used when creating the native disposable module.
  396. </param>
  397. <param name="flags">
  398. The flags for the associated <see cref="T:System.Data.SQLite.SQLiteConnection" /> object instance.
  399. </param>
  400. </member>
  401. <member name="M:System.Data.SQLite.SQLite3.DisposeModule(System.Data.SQLite.SQLiteModule,System.Data.SQLite.SQLiteConnectionFlags)">
  402. <summary>
  403. Calls the native SQLite core library in order to cleanup the resources
  404. associated with a module containing the implementation of a virtual table.
  405. </summary>
  406. <param name="module">
  407. The module object previously passed to the <see cref="M:System.Data.SQLite.SQLite3.CreateModule(System.Data.SQLite.SQLiteModule,System.Data.SQLite.SQLiteConnectionFlags)" />
  408. method.
  409. </param>
  410. <param name="flags">
  411. The flags for the associated <see cref="T:System.Data.SQLite.SQLiteConnection" /> object instance.
  412. </param>
  413. </member>
  414. <member name="M:System.Data.SQLite.SQLite3.DeclareVirtualTable(System.Data.SQLite.SQLiteModule,System.String,System.String@)">
  415. <summary>
  416. Calls the native SQLite core library in order to declare a virtual table
  417. 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@)" />
  418. or <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> virtual table methods.
  419. </summary>
  420. <param name="module">
  421. The virtual table module that is to be responsible for the virtual table
  422. being declared.
  423. </param>
  424. <param name="strSql">
  425. The string containing the SQL statement describing the virtual table to
  426. be declared.
  427. </param>
  428. <param name="error">
  429. Upon success, the contents of this parameter are undefined. Upon failure,
  430. it should contain an appropriate error message.
  431. </param>
  432. <returns>
  433. A standard SQLite return code.
  434. </returns>
  435. </member>
  436. <member name="M:System.Data.SQLite.SQLite3.DeclareVirtualFunction(System.Data.SQLite.SQLiteModule,System.Int32,System.String,System.String@)">
  437. <summary>
  438. Calls the native SQLite core library in order to declare a virtual table
  439. 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@)" />
  440. or <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> virtual table methods.
  441. </summary>
  442. <param name="module">
  443. The virtual table module that is to be responsible for the virtual table
  444. function being declared.
  445. </param>
  446. <param name="argumentCount">
  447. The number of arguments to the function being declared.
  448. </param>
  449. <param name="name">
  450. The name of the function being declared.
  451. </param>
  452. <param name="error">
  453. Upon success, the contents of this parameter are undefined. Upon failure,
  454. it should contain an appropriate error message.
  455. </param>
  456. <returns>
  457. A standard SQLite return code.
  458. </returns>
  459. </member>
  460. <member name="M:System.Data.SQLite.SQLite3.GetStatusDbOpsNames">
  461. <summary>
  462. Builds an error message string fragment containing the
  463. defined values of the <see cref="T:System.Data.SQLite.SQLiteStatusOpsEnum" />
  464. enumeration.
  465. </summary>
  466. <returns>
  467. The built string fragment.
  468. </returns>
  469. </member>
  470. <member name="M:System.Data.SQLite.SQLite3.GetLimitOpsNames">
  471. <summary>
  472. Builds an error message string fragment containing the
  473. defined values of the <see cref="T:System.Data.SQLite.SQLiteLimitOpsEnum" />
  474. enumeration.
  475. </summary>
  476. <returns>
  477. The built string fragment.
  478. </returns>
  479. </member>
  480. <member name="M:System.Data.SQLite.SQLite3.GetConfigDbOpsNames">
  481. <summary>
  482. Builds an error message string fragment containing the
  483. defined values of the <see cref="T:System.Data.SQLite.SQLiteConfigDbOpsEnum" />
  484. enumeration.
  485. </summary>
  486. <returns>
  487. The built string fragment.
  488. </returns>
  489. </member>
  490. <member name="M:System.Data.SQLite.SQLite3.GetStatusParameter(System.Data.SQLite.SQLiteStatusOpsEnum,System.Boolean,System.Int32@,System.Int32@)">
  491. <summary>
  492. Returns the current and/or highwater values for the specified
  493. database status parameter.
  494. </summary>
  495. <param name="option">
  496. The database status parameter to query.
  497. </param>
  498. <param name="reset">
  499. Non-zero to reset the highwater value to the current value.
  500. </param>
  501. <param name="current">
  502. If applicable, receives the current value.
  503. </param>
  504. <param name="highwater">
  505. If applicable, receives the highwater value.
  506. </param>
  507. <returns>
  508. A standard SQLite return code.
  509. </returns>
  510. </member>
  511. <member name="M:System.Data.SQLite.SQLite3.SetLimitOption(System.Data.SQLite.SQLiteLimitOpsEnum,System.Int32)">
  512. <summary>
  513. Change a limit value for the database.
  514. </summary>
  515. <param name="option">
  516. The database limit to change.
  517. </param>
  518. <param name="value">
  519. The new value for the specified limit.
  520. </param>
  521. <returns>
  522. The old value for the specified limit -OR- negative one if an error
  523. occurs.
  524. </returns>
  525. </member>
  526. <member name="M:System.Data.SQLite.SQLite3.SetConfigurationOption(System.Data.SQLite.SQLiteConfigDbOpsEnum,System.Object)">
  527. <summary>
  528. Change a configuration option value for the database.
  529. </summary>
  530. <param name="option">
  531. The database configuration option to change.
  532. </param>
  533. <param name="value">
  534. The new value for the specified configuration option.
  535. </param>
  536. <returns>
  537. A standard SQLite return code.
  538. </returns>
  539. </member>
  540. <member name="M:System.Data.SQLite.SQLite3.SetLoadExtension(System.Boolean)">
  541. <summary>
  542. Enables or disables extension loading by SQLite.
  543. </summary>
  544. <param name="bOnOff">
  545. True to enable loading of extensions, false to disable.
  546. </param>
  547. </member>
  548. <member name="M:System.Data.SQLite.SQLite3.LoadExtension(System.String,System.String)">
  549. <summary>
  550. Loads a SQLite extension library from the named file.
  551. </summary>
  552. <param name="fileName">
  553. The name of the dynamic link library file containing the extension.
  554. </param>
  555. <param name="procName">
  556. The name of the exported function used to initialize the extension.
  557. If null, the default "sqlite3_extension_init" will be used.
  558. </param>
  559. </member>
  560. <member name="M:System.Data.SQLite.SQLite3.SetExtendedResultCodes(System.Boolean)">
  561. Enables or disables extended result codes returned by SQLite
  562. </member>
  563. <member name="M:System.Data.SQLite.SQLite3.ResultCode">
  564. Gets the last SQLite error code
  565. </member>
  566. <member name="M:System.Data.SQLite.SQLite3.ExtendedResultCode">
  567. Gets the last SQLite extended error code
  568. </member>
  569. <member name="M:System.Data.SQLite.SQLite3.LogMessage(System.Data.SQLite.SQLiteErrorCode,System.String)">
  570. Add a log message via the SQLite sqlite3_log interface.
  571. </member>
  572. <member name="M:System.Data.SQLite.SQLite3.StaticLogMessage(System.Data.SQLite.SQLiteErrorCode,System.String)">
  573. Add a log message via the SQLite sqlite3_log interface.
  574. </member>
  575. <member name="M:System.Data.SQLite.SQLite3.SetLogCallback(System.Data.SQLite.SQLiteLogCallback)">
  576. <summary>
  577. Allows the setting of a logging callback invoked by SQLite when a
  578. log event occurs. Only one callback may be set. If NULL is passed,
  579. the logging callback is unregistered.
  580. </summary>
  581. <param name="func">The callback function to invoke.</param>
  582. <returns>Returns a result code</returns>
  583. </member>
  584. <member name="M:System.Data.SQLite.SQLite3.AppendError(System.Text.StringBuilder,System.String)">
  585. <summary>
  586. Appends an error message and an appropriate line-ending to a <see cref="T:System.Text.StringBuilder" />
  587. instance. This is useful because the .NET Compact Framework has a slightly different set
  588. of supported methods for the <see cref="T:System.Text.StringBuilder" /> class.
  589. </summary>
  590. <param name="builder">
  591. The <see cref="T:System.Text.StringBuilder" /> instance to append to.
  592. </param>
  593. <param name="message">
  594. The message to append. It will be followed by an appropriate line-ending.
  595. </param>
  596. </member>
  597. <member name="M:System.Data.SQLite.SQLite3.UnhookNativeCallbacks(System.Boolean,System.Boolean)">
  598. <summary>
  599. This method attempts to cause the SQLite native library to invalidate
  600. its function pointers that refer to this instance. This is necessary
  601. to prevent calls from native code into delegates that may have been
  602. garbage collected. Normally, these types of issues can only arise for
  603. connections that are added to the pool; howver, it is good practice to
  604. unconditionally invalidate function pointers that may refer to objects
  605. being disposed.
  606. </summary>
  607. <param name="includeGlobal">
  608. Non-zero to also invalidate global function pointers (i.e. those that
  609. are not directly associated with this connection on the native side).
  610. </param>
  611. <param name="canThrow">
  612. Non-zero if this method is being executed within a context where it can
  613. throw an exception in the event of failure; otherwise, zero.
  614. </param>
  615. <returns>
  616. Non-zero if this method was successful; otherwise, zero.
  617. </returns>
  618. </member>
  619. <member name="M:System.Data.SQLite.SQLite3.FreeDbName(System.Boolean)">
  620. <summary>
  621. This method attempts to free the cached database name used with the
  622. <see cref="M:System.Data.SQLite.SQLite3.SetConfigurationOption(System.Data.SQLite.SQLiteConfigDbOpsEnum,System.Object)" /> method.
  623. </summary>
  624. <param name="canThrow">
  625. Non-zero if this method is being executed within a context where it can
  626. throw an exception in the event of failure; otherwise, zero.
  627. </param>
  628. <returns>
  629. Non-zero if this method was successful; otherwise, zero.
  630. </returns>
  631. </member>
  632. <member name="M:System.Data.SQLite.SQLite3.InitializeBackup(System.Data.SQLite.SQLiteConnection,System.String,System.String)">
  633. <summary>
  634. Creates a new SQLite backup object based on the provided destination
  635. database connection. The source database connection is the one
  636. associated with this object. The source and destination database
  637. connections cannot be the same.
  638. </summary>
  639. <param name="destCnn">The destination database connection.</param>
  640. <param name="destName">The destination database name.</param>
  641. <param name="sourceName">The source database name.</param>
  642. <returns>The newly created backup object.</returns>
  643. </member>
  644. <member name="M:System.Data.SQLite.SQLite3.StepBackup(System.Data.SQLite.SQLiteBackup,System.Int32,System.Boolean@)">
  645. <summary>
  646. Copies up to N pages from the source database to the destination
  647. database associated with the specified backup object.
  648. </summary>
  649. <param name="backup">The backup object to use.</param>
  650. <param name="nPage">
  651. The number of pages to copy, negative to copy all remaining pages.
  652. </param>
  653. <param name="retry">
  654. Set to true if the operation needs to be retried due to database
  655. locking issues; otherwise, set to false.
  656. </param>
  657. <returns>
  658. True if there are more pages to be copied, false otherwise.
  659. </returns>
  660. </member>
  661. <member name="M:System.Data.SQLite.SQLite3.RemainingBackup(System.Data.SQLite.SQLiteBackup)">
  662. <summary>
  663. Returns the number of pages remaining to be copied from the source
  664. database to the destination database associated with the specified
  665. backup object.
  666. </summary>
  667. <param name="backup">The backup object to check.</param>
  668. <returns>The number of pages remaining to be copied.</returns>
  669. </member>
  670. <member name="M:System.Data.SQLite.SQLite3.PageCountBackup(System.Data.SQLite.SQLiteBackup)">
  671. <summary>
  672. Returns the total number of pages in the source database associated
  673. with the specified backup object.
  674. </summary>
  675. <param name="backup">The backup object to check.</param>
  676. <returns>The total number of pages in the source database.</returns>
  677. </member>
  678. <member name="M:System.Data.SQLite.SQLite3.FinishBackup(System.Data.SQLite.SQLiteBackup)">
  679. <summary>
  680. Destroys the backup object, rolling back any backup that may be in
  681. progess.
  682. </summary>
  683. <param name="backup">The backup object to destroy.</param>
  684. </member>
  685. <member name="M:System.Data.SQLite.SQLite3.IsInitialized">
  686. <summary>
  687. Determines if the SQLite core library has been initialized for the
  688. current process.
  689. </summary>
  690. <returns>
  691. A boolean indicating whether or not the SQLite core library has been
  692. initialized for the current process.
  693. </returns>
  694. </member>
  695. <member name="M:System.Data.SQLite.SQLite3.StaticIsInitialized">
  696. <summary>
  697. Determines if the SQLite core library has been initialized for the
  698. current process.
  699. </summary>
  700. <returns>
  701. A boolean indicating whether or not the SQLite core library has been
  702. initialized for the current process.
  703. </returns>
  704. </member>
  705. <member name="M:System.Data.SQLite.SQLite3.GetValue(System.Data.SQLite.SQLiteStatement,System.Data.SQLite.SQLiteConnectionFlags,System.Int32,System.Data.SQLite.SQLiteType)">
  706. <summary>
  707. Helper function to retrieve a column of data from an active statement.
  708. </summary>
  709. <param name="stmt">The statement being step()'d through</param>
  710. <param name="flags">The flags associated with the connection.</param>
  711. <param name="index">The column index to retrieve</param>
  712. <param name="typ">The type of data contained in the column. If Uninitialized, this function will retrieve the datatype information.</param>
  713. <returns>Returns the data in the column</returns>
  714. </member>
  715. <member name="T:System.Data.SQLite.SQLite3_UTF16">
  716. <summary>
  717. Alternate SQLite3 object, overriding many text behaviors to support UTF-16 (Unicode)
  718. </summary>
  719. </member>
  720. <member name="M:System.Data.SQLite.SQLite3_UTF16.#ctor(System.Data.SQLite.SQLiteDateFormats,System.DateTimeKind,System.String,System.IntPtr,System.String,System.Boolean)">
  721. <summary>
  722. Constructs the object used to interact with the SQLite core library
  723. using the UTF-8 text encoding.
  724. </summary>
  725. <param name="fmt">
  726. The DateTime format to be used when converting string values to a
  727. DateTime and binding DateTime parameters.
  728. </param>
  729. <param name="kind">
  730. The <see cref="T:System.DateTimeKind" /> to be used when creating DateTime
  731. values.
  732. </param>
  733. <param name="fmtString">
  734. The format string to be used when parsing and formatting DateTime
  735. values.
  736. </param>
  737. <param name="db">
  738. The native handle to be associated with the database connection.
  739. </param>
  740. <param name="fileName">
  741. The fully qualified file name associated with <paramref name="db" />.
  742. </param>
  743. <param name="ownHandle">
  744. Non-zero if the newly created object instance will need to dispose
  745. of <paramref name="db" /> when it is no longer needed.
  746. </param>
  747. </member>
  748. <member name="M:System.Data.SQLite.SQLite3_UTF16.ToString(System.IntPtr,System.Int32)">
  749. <summary>
  750. Overrides SQLiteConvert.ToString() to marshal UTF-16 strings instead of UTF-8
  751. </summary>
  752. <param name="b">A pointer to a UTF-16 string</param>
  753. <param name="nbytelen">The length (IN BYTES) of the string</param>
  754. <returns>A .NET string</returns>
  755. </member>
  756. <member name="T:System.Data.SQLite.SQLiteBackup">
  757. <summary>
  758. Represents a single SQL backup in SQLite.
  759. </summary>
  760. </member>
  761. <member name="F:System.Data.SQLite.SQLiteBackup._sql">
  762. <summary>
  763. The underlying SQLite object this backup is bound to.
  764. </summary>
  765. </member>
  766. <member name="F:System.Data.SQLite.SQLiteBackup._sqlite_backup">
  767. <summary>
  768. The actual backup handle.
  769. </summary>
  770. </member>
  771. <member name="F:System.Data.SQLite.SQLiteBackup._destDb">
  772. <summary>
  773. The destination database for the backup.
  774. </summary>
  775. </member>
  776. <member name="F:System.Data.SQLite.SQLiteBackup._zDestName">
  777. <summary>
  778. The destination database name for the backup.
  779. </summary>
  780. </member>
  781. <member name="F:System.Data.SQLite.SQLiteBackup._sourceDb">
  782. <summary>
  783. The source database for the backup.
  784. </summary>
  785. </member>
  786. <member name="F:System.Data.SQLite.SQLiteBackup._zSourceName">
  787. <summary>
  788. The source database name for the backup.
  789. </summary>
  790. </member>
  791. <member name="F:System.Data.SQLite.SQLiteBackup._stepResult">
  792. <summary>
  793. The last result from the StepBackup method of the SQLite3 class.
  794. This is used to determine if the call to the FinishBackup method of
  795. the SQLite3 class should throw an exception when it receives a non-Ok
  796. return code from the core SQLite library.
  797. </summary>
  798. </member>
  799. <member name="M:System.Data.SQLite.SQLiteBackup.#ctor(System.Data.SQLite.SQLiteBase,System.Data.SQLite.SQLiteBackupHandle,System.IntPtr,System.Byte[],System.IntPtr,System.Byte[])">
  800. <summary>
  801. Initializes the backup.
  802. </summary>
  803. <param name="sqlbase">The base SQLite object.</param>
  804. <param name="backup">The backup handle.</param>
  805. <param name="destDb">The destination database for the backup.</param>
  806. <param name="zDestName">The destination database name for the backup.</param>
  807. <param name="sourceDb">The source database for the backup.</param>
  808. <param name="zSourceName">The source database name for the backup.</param>
  809. </member>
  810. <member name="M:System.Data.SQLite.SQLiteBackup.Dispose">
  811. <summary>
  812. Disposes and finalizes the backup.
  813. </summary>
  814. </member>
  815. <member name="T:System.Data.SQLite.SQLiteBase">
  816. <summary>
  817. This internal class provides the foundation of SQLite support. It defines all the abstract members needed to implement
  818. a SQLite data provider, and inherits from SQLiteConvert which allows for simple translations of string to and from SQLite.
  819. </summary>
  820. </member>
  821. <member name="F:System.Data.SQLite.SQLiteBase.COR_E_EXCEPTION">
  822. <summary>
  823. The error code used for logging exceptions caught in user-provided
  824. code.
  825. </summary>
  826. </member>
  827. <member name="P:System.Data.SQLite.SQLiteBase.Version">
  828. <summary>
  829. Returns a string representing the active version of SQLite
  830. </summary>
  831. </member>
  832. <member name="P:System.Data.SQLite.SQLiteBase.VersionNumber">
  833. <summary>
  834. Returns an integer representing the active version of SQLite
  835. </summary>
  836. </member>
  837. <member name="M:System.Data.SQLite.SQLiteBase.IsReadOnly(System.String)">
  838. <summary>
  839. Returns non-zero if this connection to the database is read-only.
  840. </summary>
  841. </member>
  842. <member name="P:System.Data.SQLite.SQLiteBase.LastInsertRowId">
  843. <summary>
  844. Returns the rowid of the most recent successful INSERT into the database from this connection.
  845. </summary>
  846. </member>
  847. <member name="P:System.Data.SQLite.SQLiteBase.Changes">
  848. <summary>
  849. Returns the number of changes the last executing insert/update caused.
  850. </summary>
  851. </member>
  852. <member name="P:System.Data.SQLite.SQLiteBase.MemoryUsed">
  853. <summary>
  854. Returns the amount of memory (in bytes) currently in use by the SQLite core library. This is not really a per-connection
  855. value, it is global to the process.
  856. </summary>
  857. </member>
  858. <member name="P:System.Data.SQLite.SQLiteBase.MemoryHighwater">
  859. <summary>
  860. Returns the maximum amount of memory (in bytes) used by the SQLite core library since the high-water mark was last reset.
  861. This is not really a per-connection value, it is global to the process.
  862. </summary>
  863. </member>
  864. <member name="P:System.Data.SQLite.SQLiteBase.OwnHandle">
  865. <summary>
  866. Returns non-zero if the underlying native connection handle is owned by this instance.
  867. </summary>
  868. </member>
  869. <member name="P:System.Data.SQLite.SQLiteBase.Functions">
  870. <summary>
  871. Returns the logical list of functions associated with this connection.
  872. </summary>
  873. </member>
  874. <member name="M:System.Data.SQLite.SQLiteBase.SetMemoryStatus(System.Boolean)">
  875. <summary>
  876. Sets the status of the memory usage tracking subsystem in the SQLite core library. By default, this is enabled.
  877. If this is disabled, memory usage tracking will not be performed. This is not really a per-connection value, it is
  878. global to the process.
  879. </summary>
  880. <param name="value">Non-zero to enable memory usage tracking, zero otherwise.</param>
  881. <returns>A standard SQLite return code (i.e. zero for success and non-zero for failure).</returns>
  882. </member>
  883. <member name="M:System.Data.SQLite.SQLiteBase.ReleaseMemory">
  884. <summary>
  885. Attempts to free as much heap memory as possible for the database connection.
  886. </summary>
  887. <returns>A standard SQLite return code (i.e. zero for success and non-zero for failure).</returns>
  888. </member>
  889. <member name="M:System.Data.SQLite.SQLiteBase.Shutdown">
  890. <summary>
  891. Shutdown the SQLite engine so that it can be restarted with different config options.
  892. We depend on auto initialization to recover.
  893. </summary>
  894. </member>
  895. <member name="M:System.Data.SQLite.SQLiteBase.IsOpen">
  896. <summary>
  897. Determines if the associated native connection handle is open.
  898. </summary>
  899. <returns>
  900. Non-zero if a database connection is open.
  901. </returns>
  902. </member>
  903. <member name="M:System.Data.SQLite.SQLiteBase.GetFileName(System.String)">
  904. <summary>
  905. Returns the fully qualified path and file name for the currently open
  906. database, if any.
  907. </summary>
  908. <param name="dbName">
  909. The name of the attached database to query.
  910. </param>
  911. <returns>
  912. The fully qualified path and file name for the currently open database,
  913. if any.
  914. </returns>
  915. </member>
  916. <member name="M:System.Data.SQLite.SQLiteBase.Open(System.String,System.String,System.Data.SQLite.SQLiteConnectionFlags,System.Data.SQLite.SQLiteOpenFlagsEnum,System.Int32,System.Boolean)">
  917. <summary>
  918. Opens a database.
  919. </summary>
  920. <remarks>
  921. Implementers should call SQLiteFunction.BindFunctions() and save the array after opening a connection
  922. to bind all attributed user-defined functions and collating sequences to the new connection.
  923. </remarks>
  924. <param name="strFilename">The filename of the database to open. SQLite automatically creates it if it doesn't exist.</param>
  925. <param name="vfsName">The name of the VFS to use -OR- null to use the default VFS.</param>
  926. <param name="connectionFlags">The flags associated with the parent connection object</param>
  927. <param name="openFlags">The open flags to use when creating the connection</param>
  928. <param name="maxPoolSize">The maximum size of the pool for the given filename</param>
  929. <param name="usePool">If true, the connection can be pulled from the connection pool</param>
  930. </member>
  931. <member name="M:System.Data.SQLite.SQLiteBase.Close(System.Boolean)">
  932. <summary>
  933. Closes the currently-open database.
  934. </summary>
  935. <remarks>
  936. After the database has been closed implemeters should call SQLiteFunction.UnbindFunctions() to deallocate all interop allocated
  937. memory associated with the user-defined functions and collating sequences tied to the closed connection.
  938. </remarks>
  939. <param name="disposing">Non-zero if connection is being disposed, zero otherwise.</param>
  940. </member>
  941. <member name="M:System.Data.SQLite.SQLiteBase.SetTimeout(System.Int32)">
  942. <summary>
  943. Sets the busy timeout on the connection. SQLiteCommand will call this before executing any command.
  944. </summary>
  945. <param name="nTimeoutMS">The number of milliseconds to wait before returning SQLITE_BUSY</param>
  946. </member>
  947. <member name="M:System.Data.SQLite.SQLiteBase.GetLastError">
  948. <summary>
  949. Returns the text of the last error issued by SQLite
  950. </summary>
  951. <returns></returns>
  952. </member>
  953. <member name="M:System.Data.SQLite.SQLiteBase.GetLastError(System.String)">
  954. <summary>
  955. Returns the text of the last error issued by SQLite -OR- the specified default error text if
  956. none is available from the SQLite core library.
  957. </summary>
  958. <param name="defValue">
  959. The error text to return in the event that one is not available from the SQLite core library.
  960. </param>
  961. <returns>
  962. The error text.
  963. </returns>
  964. </member>
  965. <member name="M:System.Data.SQLite.SQLiteBase.ClearPool">
  966. <summary>
  967. When pooling is enabled, force this connection to be disposed rather than returned to the pool
  968. </summary>
  969. </member>
  970. <member name="M:System.Data.SQLite.SQLiteBase.CountPool">
  971. <summary>
  972. When pooling is enabled, returns the number of pool entries matching the current file name.
  973. </summary>
  974. <returns>The number of pool entries matching the current file name.</returns>
  975. </member>
  976. <member name="M:System.Data.SQLite.SQLiteBase.Prepare(System.Data.SQLite.SQLiteConnection,System.String,System.Data.SQLite.SQLiteStatement,System.UInt32,System.String@)">
  977. <summary>
  978. Prepares a SQL statement for execution.
  979. </summary>
  980. <param name="cnn">The source connection preparing the command. Can be null for any caller except LINQ</param>
  981. <param name="strSql">The SQL command text to prepare</param>
  982. <param name="previous">The previous statement in a multi-statement command, or null if no previous statement exists</param>
  983. <param name="timeoutMS">The timeout to wait before aborting the prepare</param>
  984. <param name="strRemain">The remainder of the statement that was not processed. Each call to prepare parses the
  985. SQL up to to either the end of the text or to the first semi-colon delimiter. The remaining text is returned
  986. here for a subsequent call to Prepare() until all the text has been processed.</param>
  987. <returns>Returns an initialized SQLiteStatement.</returns>
  988. </member>
  989. <member name="M:System.Data.SQLite.SQLiteBase.Step(System.Data.SQLite.SQLiteStatement)">
  990. <summary>
  991. Steps through a prepared statement.
  992. </summary>
  993. <param name="stmt">The SQLiteStatement to step through</param>
  994. <returns>True if a row was returned, False if not.</returns>
  995. </member>
  996. <member name="M:System.Data.SQLite.SQLiteBase.IsReadOnly(System.Data.SQLite.SQLiteStatement)">
  997. <summary>
  998. Returns non-zero if the specified statement is read-only in nature.
  999. </summary>
  1000. <param name="stmt">The statement to check.</param>
  1001. <returns>True if the outer query is read-only.</returns>
  1002. </member>
  1003. <member name="M:System.Data.SQLite.SQLiteBase.Reset(System.Data.SQLite.SQLiteStatement)">
  1004. <summary>
  1005. Resets a prepared statement so it can be executed again. If the error returned is SQLITE_SCHEMA,
  1006. transparently attempt to rebuild the SQL statement and throw an error if that was not possible.
  1007. </summary>
  1008. <param name="stmt">The statement to reset</param>
  1009. <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>
  1010. </member>
  1011. <member name="M:System.Data.SQLite.SQLiteBase.Cancel">
  1012. <summary>
  1013. Attempts to interrupt the query currently executing on the associated
  1014. native database connection.
  1015. </summary>
  1016. </member>
  1017. <member name="M:System.Data.SQLite.SQLiteBase.BindFunction(System.Data.SQLite.SQLiteFunctionAttribute,System.Data.SQLite.SQLiteFunction,System.Data.SQLite.SQLiteConnectionFlags)">
  1018. <summary>
  1019. This function binds a user-defined function to the connection.
  1020. </summary>
  1021. <param name="functionAttribute">
  1022. The <see cref="T:System.Data.SQLite.SQLiteFunctionAttribute"/> object instance containing
  1023. the metadata for the function to be bound.
  1024. </param>
  1025. <param name="function">
  1026. The <see cref="T:System.Data.SQLite.SQLiteFunction"/> object instance that implements the
  1027. function to be bound.
  1028. </param>
  1029. <param name="flags">
  1030. The flags associated with the parent connection object.
  1031. </param>
  1032. </member>
  1033. <member name="M:System.Data.SQLite.SQLiteBase.UnbindFunction(System.Data.SQLite.SQLiteFunctionAttribute,System.Data.SQLite.SQLiteConnectionFlags)">
  1034. <summary>
  1035. This function unbinds a user-defined function from the connection.
  1036. </summary>
  1037. <param name="functionAttribute">
  1038. The <see cref="T:System.Data.SQLite.SQLiteFunctionAttribute"/> object instance containing
  1039. the metadata for the function to be unbound.
  1040. </param>
  1041. <param name="flags">
  1042. The flags associated with the parent connection object.
  1043. </param>
  1044. <returns>Non-zero if the function was unbound.</returns>
  1045. </member>
  1046. <member name="M:System.Data.SQLite.SQLiteBase.CreateModule(System.Data.SQLite.SQLiteModule,System.Data.SQLite.SQLiteConnectionFlags)">
  1047. <summary>
  1048. Calls the native SQLite core library in order to create a disposable
  1049. module containing the implementation of a virtual table.
  1050. </summary>
  1051. <param name="module">
  1052. The module object to be used when creating the native disposable module.
  1053. </param>
  1054. <param name="flags">
  1055. The flags for the associated <see cref="T:System.Data.SQLite.SQLiteConnection" /> object instance.
  1056. </param>
  1057. </member>
  1058. <member name="M:System.Data.SQLite.SQLiteBase.DisposeModule(System.Data.SQLite.SQLiteModule,System.Data.SQLite.SQLiteConnectionFlags)">
  1059. <summary>
  1060. Calls the native SQLite core library in order to cleanup the resources
  1061. associated with a module containing the implementation of a virtual table.
  1062. </summary>
  1063. <param name="module">
  1064. The module object previously passed to the <see cref="M:System.Data.SQLite.SQLiteBase.CreateModule(System.Data.SQLite.SQLiteModule,System.Data.SQLite.SQLiteConnectionFlags)" />
  1065. method.
  1066. </param>
  1067. <param name="flags">
  1068. The flags for the associated <see cref="T:System.Data.SQLite.SQLiteConnection" /> object instance.
  1069. </param>
  1070. </member>
  1071. <member name="M:System.Data.SQLite.SQLiteBase.DeclareVirtualTable(System.Data.SQLite.SQLiteModule,System.String,System.String@)">
  1072. <summary>
  1073. Calls the native SQLite core library in order to declare a virtual table
  1074. 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@)" />
  1075. or <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> virtual table methods.
  1076. </summary>
  1077. <param name="module">
  1078. The virtual table module that is to be responsible for the virtual table
  1079. being declared.
  1080. </param>
  1081. <param name="strSql">
  1082. The string containing the SQL statement describing the virtual table to
  1083. be declared.
  1084. </param>
  1085. <param name="error">
  1086. Upon success, the contents of this parameter are undefined. Upon failure,
  1087. it should contain an appropriate error message.
  1088. </param>
  1089. <returns>
  1090. A standard SQLite return code.
  1091. </returns>
  1092. </member>
  1093. <member name="M:System.Data.SQLite.SQLiteBase.DeclareVirtualFunction(System.Data.SQLite.SQLiteModule,System.Int32,System.String,System.String@)">
  1094. <summary>
  1095. Calls the native SQLite core library in order to declare a virtual table
  1096. 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@)" />
  1097. or <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> virtual table methods.
  1098. </summary>
  1099. <param name="module">
  1100. The virtual table module that is to be responsible for the virtual table
  1101. function being declared.
  1102. </param>
  1103. <param name="argumentCount">
  1104. The number of arguments to the function being declared.
  1105. </param>
  1106. <param name="name">
  1107. The name of the function being declared.
  1108. </param>
  1109. <param name="error">
  1110. Upon success, the contents of this parameter are undefined. Upon failure,
  1111. it should contain an appropriate error message.
  1112. </param>
  1113. <returns>
  1114. A standard SQLite return code.
  1115. </returns>
  1116. </member>
  1117. <member name="M:System.Data.SQLite.SQLiteBase.GetStatusParameter(System.Data.SQLite.SQLiteStatusOpsEnum,System.Boolean,System.Int32@,System.Int32@)">
  1118. <summary>
  1119. Returns the current and/or highwater values for the specified database status parameter.
  1120. </summary>
  1121. <param name="option">
  1122. The database status parameter to query.
  1123. </param>
  1124. <param name="reset">
  1125. Non-zero to reset the highwater value to the current value.
  1126. </param>
  1127. <param name="current">
  1128. If applicable, receives the current value.
  1129. </param>
  1130. <param name="highwater">
  1131. If applicable, receives the highwater value.
  1132. </param>
  1133. <returns>
  1134. A standard SQLite return code.
  1135. </returns>
  1136. </member>
  1137. <member name="M:System.Data.SQLite.SQLiteBase.SetLimitOption(System.Data.SQLite.SQLiteLimitOpsEnum,System.Int32)">
  1138. <summary>
  1139. Change a limit value for the database.
  1140. </summary>
  1141. <param name="option">
  1142. The database limit to change.
  1143. </param>
  1144. <param name="value">
  1145. The new value for the specified limit.
  1146. </param>
  1147. <returns>
  1148. The old value for the specified limit -OR- negative one if an error
  1149. occurs.
  1150. </returns>
  1151. </member>
  1152. <member name="M:System.Data.SQLite.SQLiteBase.SetConfigurationOption(System.Data.SQLite.SQLiteConfigDbOpsEnum,System.Object)">
  1153. <summary>
  1154. Change a configuration option value for the database.
  1155. </summary>
  1156. <param name="option">
  1157. The database configuration option to change.
  1158. </param>
  1159. <param name="value">
  1160. The new value for the specified configuration option.
  1161. </param>
  1162. <returns>
  1163. A standard SQLite return code.
  1164. </returns>
  1165. </member>
  1166. <member name="M:System.Data.SQLite.SQLiteBase.SetLoadExtension(System.Boolean)">
  1167. <summary>
  1168. Enables or disables extension loading by SQLite.
  1169. </summary>
  1170. <param name="bOnOff">
  1171. True to enable loading of extensions, false to disable.
  1172. </param>
  1173. </member>
  1174. <member name="M:System.Data.SQLite.SQLiteBase.LoadExtension(System.String,System.String)">
  1175. <summary>
  1176. Loads a SQLite extension library from the named file.
  1177. </summary>
  1178. <param name="fileName">
  1179. The name of the dynamic link library file containing the extension.
  1180. </param>
  1181. <param name="procName">
  1182. The name of the exported function used to initialize the extension.
  1183. If null, the default "sqlite3_extension_init" will be used.
  1184. </param>
  1185. </member>
  1186. <member name="M:System.Data.SQLite.SQLiteBase.SetExtendedResultCodes(System.Boolean)">
  1187. <summary>
  1188. Enables or disables extened result codes returned by SQLite
  1189. </summary>
  1190. <param name="bOnOff">true to enable extended result codes, false to disable.</param>
  1191. <returns></returns>
  1192. </member>
  1193. <member name="M:System.Data.SQLite.SQLiteBase.ResultCode">
  1194. <summary>
  1195. Returns the numeric result code for the most recent failed SQLite API call
  1196. associated with the database connection.
  1197. </summary>
  1198. <returns>Result code</returns>
  1199. </member>
  1200. <member name="M:System.Data.SQLite.SQLiteBase.ExtendedResultCode">
  1201. <summary>
  1202. Returns the extended numeric result code for the most recent failed SQLite API call
  1203. associated with the database connection.
  1204. </summary>
  1205. <returns>Extended result code</returns>
  1206. </member>
  1207. <member name="M:System.Data.SQLite.SQLiteBase.LogMessage(System.Data.SQLite.SQLiteErrorCode,System.String)">
  1208. <summary>
  1209. Add a log message via the SQLite sqlite3_log interface.
  1210. </summary>
  1211. <param name="iErrCode">Error code to be logged with the message.</param>
  1212. <param name="zMessage">String to be logged. Unlike the SQLite sqlite3_log()
  1213. interface, this should be pre-formatted. Consider using the
  1214. String.Format() function.</param>
  1215. <returns></returns>
  1216. </member>
  1217. <member name="M:System.Data.SQLite.SQLiteBase.IsInitialized">
  1218. <summary>
  1219. Checks if the SQLite core library has been initialized in the current process.
  1220. </summary>
  1221. <returns>
  1222. Non-zero if the SQLite core library has been initialized in the current process,
  1223. zero otherwise.
  1224. </returns>
  1225. </member>
  1226. <member name="P:System.Data.SQLite.SQLiteBase.AutoCommit">
  1227. <summary>
  1228. Returns non-zero if the given database connection is in autocommit mode.
  1229. Autocommit mode is on by default. Autocommit mode is disabled by a BEGIN
  1230. statement. Autocommit mode is re-enabled by a COMMIT or ROLLBACK.
  1231. </summary>
  1232. </member>
  1233. <member name="M:System.Data.SQLite.SQLiteBase.InitializeBackup(System.Data.SQLite.SQLiteConnection,System.String,System.String)">
  1234. <summary>
  1235. Creates a new SQLite backup object based on the provided destination
  1236. database connection. The source database connection is the one
  1237. associated with this object. The source and destination database
  1238. connections cannot be the same.
  1239. </summary>
  1240. <param name="destCnn">The destination database connection.</param>
  1241. <param name="destName">The destination database name.</param>
  1242. <param name="sourceName">The source database name.</param>
  1243. <returns>The newly created backup object.</returns>
  1244. </member>
  1245. <member name="M:System.Data.SQLite.SQLiteBase.StepBackup(System.Data.SQLite.SQLiteBackup,System.Int32,System.Boolean@)">
  1246. <summary>
  1247. Copies up to N pages from the source database to the destination
  1248. database associated with the specified backup object.
  1249. </summary>
  1250. <param name="backup">The backup object to use.</param>
  1251. <param name="nPage">
  1252. The number of pages to copy or negative to copy all remaining pages.
  1253. </param>
  1254. <param name="retry">
  1255. Set to true if the operation needs to be retried due to database
  1256. locking issues.
  1257. </param>
  1258. <returns>
  1259. True if there are more pages to be copied, false otherwise.
  1260. </returns>
  1261. </member>
  1262. <member name="M:System.Data.SQLite.SQLiteBase.RemainingBackup(System.Data.SQLite.SQLiteBackup)">
  1263. <summary>
  1264. Returns the number of pages remaining to be copied from the source
  1265. database to the destination database associated with the specified
  1266. backup object.
  1267. </summary>
  1268. <param name="backup">The backup object to check.</param>
  1269. <returns>The number of pages remaining to be copied.</returns>
  1270. </member>
  1271. <member name="M:System.Data.SQLite.SQLiteBase.PageCountBackup(System.Data.SQLite.SQLiteBackup)">
  1272. <summary>
  1273. Returns the total number of pages in the source database associated
  1274. with the specified backup object.
  1275. </summary>
  1276. <param name="backup">The backup object to check.</param>
  1277. <returns>The total number of pages in the source database.</returns>
  1278. </member>
  1279. <member name="M:System.Data.SQLite.SQLiteBase.FinishBackup(System.Data.SQLite.SQLiteBackup)">
  1280. <summary>
  1281. Destroys the backup object, rolling back any backup that may be in
  1282. progess.
  1283. </summary>
  1284. <param name="backup">The backup object to destroy.</param>
  1285. </member>
  1286. <member name="M:System.Data.SQLite.SQLiteBase.FallbackGetErrorString(System.Data.SQLite.SQLiteErrorCode)">
  1287. <summary>
  1288. Returns the error message for the specified SQLite return code using
  1289. the internal static lookup table.
  1290. </summary>
  1291. <param name="rc">The SQLite return code.</param>
  1292. <returns>The error message or null if it cannot be found.</returns>
  1293. </member>
  1294. <member name="T:System.Data.SQLite.ISQLiteSchemaExtensions">
  1295. <summary>
  1296. </summary>
  1297. </member>
  1298. <member name="M:System.Data.SQLite.ISQLiteSchemaExtensions.BuildTempSchema(System.Data.SQLite.SQLiteConnection)">
  1299. <summary>
  1300. Creates temporary tables on the connection so schema information can be queried.
  1301. </summary>
  1302. <param name="connection">
  1303. The connection upon which to build the schema tables.
  1304. </param>
  1305. </member>
  1306. <member name="T:System.Data.SQLite.SQLiteConnectionFlags">
  1307. <summary>
  1308. The extra behavioral flags that can be applied to a connection.
  1309. </summary>
  1310. </member>
  1311. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.None">
  1312. <summary>
  1313. No extra flags.
  1314. </summary>
  1315. </member>
  1316. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.LogPrepare">
  1317. <summary>
  1318. Enable logging of all SQL statements to be prepared.
  1319. </summary>
  1320. </member>
  1321. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.LogPreBind">
  1322. <summary>
  1323. Enable logging of all bound parameter types and raw values.
  1324. </summary>
  1325. </member>
  1326. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.LogBind">
  1327. <summary>
  1328. Enable logging of all bound parameter strongly typed values.
  1329. </summary>
  1330. </member>
  1331. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.LogCallbackException">
  1332. <summary>
  1333. Enable logging of all exceptions caught from user-provided
  1334. managed code called from native code via delegates.
  1335. </summary>
  1336. </member>
  1337. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.LogBackup">
  1338. <summary>
  1339. Enable logging of backup API errors.
  1340. </summary>
  1341. </member>
  1342. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.NoExtensionFunctions">
  1343. <summary>
  1344. Skip adding the extension functions provided by the native
  1345. interop assembly.
  1346. </summary>
  1347. </member>
  1348. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.BindUInt32AsInt64">
  1349. <summary>
  1350. When binding parameter values with the <see cref="T:System.UInt32" />
  1351. type, use the interop method that accepts an <see cref="T:System.Int64" />
  1352. value.
  1353. </summary>
  1354. </member>
  1355. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.BindAllAsText">
  1356. <summary>
  1357. When binding parameter values, always bind them as though they were
  1358. plain text (i.e. no numeric, date/time, or other conversions should
  1359. be attempted).
  1360. </summary>
  1361. </member>
  1362. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.GetAllAsText">
  1363. <summary>
  1364. When returning column values, always return them as though they were
  1365. plain text (i.e. no numeric, date/time, or other conversions should
  1366. be attempted).
  1367. </summary>
  1368. </member>
  1369. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.NoLoadExtension">
  1370. <summary>
  1371. Prevent this <see cref="T:System.Data.SQLite.SQLiteConnection" /> object instance from
  1372. loading extensions.
  1373. </summary>
  1374. </member>
  1375. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.NoCreateModule">
  1376. <summary>
  1377. Prevent this <see cref="T:System.Data.SQLite.SQLiteConnection" /> object instance from
  1378. creating virtual table modules.
  1379. </summary>
  1380. </member>
  1381. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.NoBindFunctions">
  1382. <summary>
  1383. Skip binding any functions provided by other managed assemblies when
  1384. opening the connection.
  1385. </summary>
  1386. </member>
  1387. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.NoLogModule">
  1388. <summary>
  1389. Skip setting the logging related properties of the
  1390. <see cref="T:System.Data.SQLite.SQLiteModule" /> object instance that was passed to
  1391. the <see cref="M:System.Data.SQLite.SQLiteConnection.CreateModule(System.Data.SQLite.SQLiteModule)" /> method.
  1392. </summary>
  1393. </member>
  1394. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.LogModuleError">
  1395. <summary>
  1396. Enable logging of all virtual table module errors seen by the
  1397. <see cref="M:System.Data.SQLite.SQLiteModule.SetTableError(System.IntPtr,System.String)" /> method.
  1398. </summary>
  1399. </member>
  1400. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.LogModuleException">
  1401. <summary>
  1402. Enable logging of certain virtual table module exceptions that cannot
  1403. be easily discovered via other means.
  1404. </summary>
  1405. </member>
  1406. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.TraceWarning">
  1407. <summary>
  1408. Enable tracing of potentially important [non-fatal] error conditions
  1409. that cannot be easily reported through other means.
  1410. </summary>
  1411. </member>
  1412. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.ConvertInvariantText">
  1413. <summary>
  1414. When binding parameter values, always use the invariant culture when
  1415. converting their values from strings.
  1416. </summary>
  1417. </member>
  1418. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.BindInvariantText">
  1419. <summary>
  1420. When binding parameter values, always use the invariant culture when
  1421. converting their values to strings.
  1422. </summary>
  1423. </member>
  1424. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.NoConnectionPool">
  1425. <summary>
  1426. Disable using the connection pool by default. If the "Pooling"
  1427. connection string property is specified, its value will override
  1428. this flag. The precise outcome of combining this flag with the
  1429. <see cref="F:System.Data.SQLite.SQLiteConnectionFlags.UseConnectionPool" /> flag is unspecified; however,
  1430. one of the flags will be in effect.
  1431. </summary>
  1432. </member>
  1433. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.UseConnectionPool">
  1434. <summary>
  1435. Enable using the connection pool by default. If the "Pooling"
  1436. connection string property is specified, its value will override
  1437. this flag. The precise outcome of combining this flag with the
  1438. <see cref="F:System.Data.SQLite.SQLiteConnectionFlags.NoConnectionPool" /> flag is unspecified; however,
  1439. one of the flags will be in effect.
  1440. </summary>
  1441. </member>
  1442. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.UseConnectionTypes">
  1443. <summary>
  1444. Enable using per-connection mappings between type names and
  1445. <see cref="T:System.Data.DbType" /> values. Also see the
  1446. <see cref="M:System.Data.SQLite.SQLiteConnection.ClearTypeMappings" />,
  1447. <see cref="M:System.Data.SQLite.SQLiteConnection.GetTypeMappings" />, and
  1448. <see cref="M:System.Data.SQLite.SQLiteConnection.AddTypeMapping(System.String,System.Data.DbType,System.Boolean)" /> methods. These
  1449. per-connection mappings, when present, override the corresponding
  1450. global mappings.
  1451. </summary>
  1452. </member>
  1453. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.NoGlobalTypes">
  1454. <summary>
  1455. Disable using global mappings between type names and
  1456. <see cref="T:System.Data.DbType" /> values. This may be useful in some very narrow
  1457. cases; however, if there are no per-connection type mappings, the
  1458. fallback defaults will be used for both type names and their
  1459. associated <see cref="T:System.Data.DbType" /> values. Therefore, use of this flag
  1460. is not recommended.
  1461. </summary>
  1462. </member>
  1463. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.StickyHasRows">
  1464. <summary>
  1465. When the <see cref="P:System.Data.SQLite.SQLiteDataReader.HasRows" /> property is used, it
  1466. should return non-zero if there were ever any rows in the associated
  1467. result sets.
  1468. </summary>
  1469. </member>
  1470. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.StrictEnlistment">
  1471. <summary>
  1472. Enable "strict" transaction enlistment semantics. Setting this flag
  1473. will cause an exception to be thrown if an attempt is made to enlist
  1474. in a transaction with an unavailable or unsupported isolation level.
  1475. In the future, more extensive checks may be enabled by this flag as
  1476. well.
  1477. </summary>
  1478. </member>
  1479. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.MapIsolationLevels">
  1480. <summary>
  1481. Enable mapping of unsupported transaction isolation levels to the
  1482. closest supported transaction isolation level.
  1483. </summary>
  1484. </member>
  1485. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.DetectTextAffinity">
  1486. <summary>
  1487. When returning column values, attempt to detect the affinity of
  1488. textual values by checking if they fully conform to those of the
  1489. <see cref="F:System.Data.SQLite.TypeAffinity.Null" />,
  1490. <see cref="F:System.Data.SQLite.TypeAffinity.Int64" />,
  1491. <see cref="F:System.Data.SQLite.TypeAffinity.Double" />,
  1492. or <see cref="F:System.Data.SQLite.TypeAffinity.DateTime" /> types.
  1493. </summary>
  1494. </member>
  1495. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.DetectStringType">
  1496. <summary>
  1497. When returning column values, attempt to detect the type of
  1498. string values by checking if they fully conform to those of
  1499. the <see cref="F:System.Data.SQLite.TypeAffinity.Null" />,
  1500. <see cref="F:System.Data.SQLite.TypeAffinity.Int64" />,
  1501. <see cref="F:System.Data.SQLite.TypeAffinity.Double" />,
  1502. or <see cref="F:System.Data.SQLite.TypeAffinity.DateTime" /> types.
  1503. </summary>
  1504. </member>
  1505. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.NoConvertSettings">
  1506. <summary>
  1507. Skip querying runtime configuration settings for use by the
  1508. <see cref="T:System.Data.SQLite.SQLiteConvert" /> class, including the default
  1509. <see cref="T:System.Data.DbType" /> value and default database type name.
  1510. <b>NOTE: If the <see cref="P:System.Data.SQLite.SQLiteConnection.DefaultDbType" />
  1511. and/or <see cref="P:System.Data.SQLite.SQLiteConnection.DefaultTypeName" />
  1512. properties are not set explicitly nor set via their connection
  1513. string properties and repeated calls to determine these runtime
  1514. configuration settings are seen to be a problem, this flag
  1515. should be set.</b>
  1516. </summary>
  1517. </member>
  1518. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.BindDateTimeWithKind">
  1519. <summary>
  1520. When binding parameter values with the <see cref="T:System.DateTime" />
  1521. type, take their <see cref="T:System.DateTimeKind" /> into account as
  1522. well as that of the associated <see cref="T:System.Data.SQLite.SQLiteConnection" />.
  1523. </summary>
  1524. </member>
  1525. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.RollbackOnException">
  1526. <summary>
  1527. If an exception is caught when raising the
  1528. <see cref="E:System.Data.SQLite.SQLiteConnection.Commit" /> event, the transaction
  1529. should be rolled back. If this is not specified, the transaction
  1530. will continue the commit process instead.
  1531. </summary>
  1532. </member>
  1533. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.DenyOnException">
  1534. <summary>
  1535. If an exception is caught when raising the
  1536. <see cref="E:System.Data.SQLite.SQLiteConnection.Authorize" /> event, the action should
  1537. should be denied. If this is not specified, the action will be
  1538. allowed instead.
  1539. </summary>
  1540. </member>
  1541. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.InterruptOnException">
  1542. <summary>
  1543. If an exception is caught when raising the
  1544. <see cref="E:System.Data.SQLite.SQLiteConnection.Progress" /> event, the operation
  1545. should be interrupted. If this is not specified, the operation
  1546. will simply continue.
  1547. </summary>
  1548. </member>
  1549. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.UnbindFunctionsOnClose">
  1550. <summary>
  1551. Attempt to unbind all functions provided by other managed assemblies
  1552. when closing the connection.
  1553. </summary>
  1554. </member>
  1555. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.NoVerifyTextAffinity">
  1556. <summary>
  1557. When returning column values as a <see cref="T:System.String" />, skip
  1558. verifying their affinity.
  1559. </summary>
  1560. </member>
  1561. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.UseConnectionBindValueCallbacks">
  1562. <summary>
  1563. Enable using per-connection mappings between type names and
  1564. <see cref="T:System.Data.SQLite.SQLiteBindValueCallback" /> values. Also see the
  1565. <see cref="M:System.Data.SQLite.SQLiteConnection.ClearTypeCallbacks" />,
  1566. <see cref="M:System.Data.SQLite.SQLiteConnection.TryGetTypeCallbacks(System.String,System.Data.SQLite.SQLiteTypeCallbacks@)" />, and
  1567. <see cref="M:System.Data.SQLite.SQLiteConnection.SetTypeCallbacks(System.String,System.Data.SQLite.SQLiteTypeCallbacks)" /> methods.
  1568. </summary>
  1569. </member>
  1570. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.UseConnectionReadValueCallbacks">
  1571. <summary>
  1572. Enable using per-connection mappings between type names and
  1573. <see cref="T:System.Data.SQLite.SQLiteReadValueCallback" /> values. Also see the
  1574. <see cref="M:System.Data.SQLite.SQLiteConnection.ClearTypeCallbacks" />,
  1575. <see cref="M:System.Data.SQLite.SQLiteConnection.TryGetTypeCallbacks(System.String,System.Data.SQLite.SQLiteTypeCallbacks@)" />, and
  1576. <see cref="M:System.Data.SQLite.SQLiteConnection.SetTypeCallbacks(System.String,System.Data.SQLite.SQLiteTypeCallbacks)" /> methods.
  1577. </summary>
  1578. </member>
  1579. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.UseParameterNameForTypeName">
  1580. <summary>
  1581. If the database type name has not been explicitly set for the
  1582. parameter specified, fallback to using the parameter name.
  1583. </summary>
  1584. </member>
  1585. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.UseParameterDbTypeForTypeName">
  1586. <summary>
  1587. If the database type name has not been explicitly set for the
  1588. parameter specified, fallback to using the database type name
  1589. associated with the <see cref="T:System.Data.DbType" /> value.
  1590. </summary>
  1591. </member>
  1592. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.NoVerifyTypeAffinity">
  1593. <summary>
  1594. When returning column values, skip verifying their affinity.
  1595. </summary>
  1596. </member>
  1597. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.AllowNestedTransactions">
  1598. <summary>
  1599. Allow transactions to be nested. The outermost transaction still
  1600. controls whether or not any changes are ultimately committed or
  1601. rolled back. All non-outermost transactions are implemented using
  1602. the SAVEPOINT construct.
  1603. </summary>
  1604. </member>
  1605. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.BindDecimalAsText">
  1606. <summary>
  1607. When binding parameter values, always bind <see cref="T:System.Decimal" />
  1608. values as though they were plain text (i.e. not <see cref="T:System.Decimal" />,
  1609. which is the legacy behavior).
  1610. </summary>
  1611. </member>
  1612. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.GetDecimalAsText">
  1613. <summary>
  1614. When returning column values, always return <see cref="T:System.Decimal" />
  1615. values as though they were plain text (i.e. not <see cref="T:System.Double" />,
  1616. which is the legacy behavior).
  1617. </summary>
  1618. </member>
  1619. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.BindInvariantDecimal">
  1620. <summary>
  1621. When binding <see cref="T:System.Decimal" /> parameter values, always use
  1622. the invariant culture when converting their values to strings.
  1623. </summary>
  1624. </member>
  1625. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.GetInvariantDecimal">
  1626. <summary>
  1627. When returning <see cref="T:System.Decimal" /> column values, always use
  1628. the invariant culture when converting their values from strings.
  1629. </summary>
  1630. </member>
  1631. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.WaitForEnlistmentReset">
  1632. <summary>
  1633. <b>EXPERIMENTAL</b> --
  1634. Enable waiting for the enlistment to be reset prior to attempting
  1635. to create a new enlistment. This may be necessary due to the
  1636. semantics used by distributed transactions, which complete
  1637. asynchronously.
  1638. </summary>
  1639. </member>
  1640. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.GetInvariantInt64">
  1641. <summary>
  1642. When returning <see cref="T:System.Int64" /> column values, always use
  1643. the invariant culture when converting their values from strings.
  1644. </summary>
  1645. </member>
  1646. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.GetInvariantDouble">
  1647. <summary>
  1648. When returning <see cref="T:System.Double" /> column values, always use
  1649. the invariant culture when converting their values from strings.
  1650. </summary>
  1651. </member>
  1652. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.StrictConformance">
  1653. <summary>
  1654. <b>EXPERIMENTAL</b> --
  1655. Enable strict conformance to the ADO.NET standard, e.g. use of
  1656. thrown exceptions to indicate common error conditions.
  1657. </summary>
  1658. </member>
  1659. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.HidePassword">
  1660. <summary>
  1661. <b>EXPERIMENTAL</b> --
  1662. When opening a connection, attempt to hide the password from the
  1663. connection string, etc. Given the memory architecture of the CLR,
  1664. (and P/Invoke) this is not 100% reliable and should not be relied
  1665. upon for security critical uses or applications.
  1666. </summary>
  1667. </member>
  1668. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.BindAndGetAllAsText">
  1669. <summary>
  1670. When binding parameter values or returning column values, always
  1671. treat them as though they were plain text (i.e. no numeric,
  1672. date/time, or other conversions should be attempted).
  1673. </summary>
  1674. </member>
  1675. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.ConvertAndBindInvariantText">
  1676. <summary>
  1677. When binding parameter values, always use the invariant culture when
  1678. converting their values to strings or from strings.
  1679. </summary>
  1680. </member>
  1681. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.BindAndGetAllAsInvariantText">
  1682. <summary>
  1683. When binding parameter values or returning column values, always
  1684. treat them as though they were plain text (i.e. no numeric,
  1685. date/time, or other conversions should be attempted) and always
  1686. use the invariant culture when converting their values to strings.
  1687. </summary>
  1688. </member>
  1689. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.ConvertAndBindAndGetAllAsInvariantText">
  1690. <summary>
  1691. When binding parameter values or returning column values, always
  1692. treat them as though they were plain text (i.e. no numeric,
  1693. date/time, or other conversions should be attempted) and always
  1694. use the invariant culture when converting their values to strings
  1695. or from strings.
  1696. </summary>
  1697. </member>
  1698. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.UseConnectionAllValueCallbacks">
  1699. <summary>
  1700. Enables use of all per-connection value handling callbacks.
  1701. </summary>
  1702. </member>
  1703. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.UseParameterAnythingForTypeName">
  1704. <summary>
  1705. Enables use of all applicable <see cref="T:System.Data.SQLite.SQLiteParameter" />
  1706. properties as fallbacks for the database type name.
  1707. </summary>
  1708. </member>
  1709. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.LogAll">
  1710. <summary>
  1711. Enable all logging.
  1712. </summary>
  1713. </member>
  1714. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.LogDefault">
  1715. <summary>
  1716. The default logging related flags for new connections.
  1717. </summary>
  1718. </member>
  1719. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.Default">
  1720. <summary>
  1721. The default extra flags for new connections.
  1722. </summary>
  1723. </member>
  1724. <member name="F:System.Data.SQLite.SQLiteConnectionFlags.DefaultAndLogAll">
  1725. <summary>
  1726. The default extra flags for new connections with all logging enabled.
  1727. </summary>
  1728. </member>
  1729. <member name="T:System.Data.SQLite.SQLiteStatusOpsEnum">
  1730. <summary>
  1731. These are the supported status parameters for use with the native
  1732. SQLite library.
  1733. </summary>
  1734. </member>
  1735. <member name="F:System.Data.SQLite.SQLiteStatusOpsEnum.SQLITE_DBSTATUS_LOOKASIDE_USED">
  1736. <summary>
  1737. This parameter returns the number of lookaside memory slots
  1738. currently checked out.
  1739. </summary>
  1740. </member>
  1741. <member name="F:System.Data.SQLite.SQLiteStatusOpsEnum.SQLITE_DBSTATUS_CACHE_USED">
  1742. <summary>
  1743. This parameter returns the approximate number of bytes of
  1744. heap memory used by all pager caches associated with the
  1745. database connection. The highwater mark associated with
  1746. SQLITE_DBSTATUS_CACHE_USED is always 0.
  1747. </summary>
  1748. </member>
  1749. <member name="F:System.Data.SQLite.SQLiteStatusOpsEnum.SQLITE_DBSTATUS_SCHEMA_USED">
  1750. <summary>
  1751. This parameter returns the approximate number of bytes of
  1752. heap memory used to store the schema for all databases
  1753. associated with the connection - main, temp, and any ATTACH-ed
  1754. databases. The full amount of memory used by the schemas is
  1755. reported, even if the schema memory is shared with other
  1756. database connections due to shared cache mode being enabled.
  1757. The highwater mark associated with SQLITE_DBSTATUS_SCHEMA_USED
  1758. is always 0.
  1759. </summary>
  1760. </member>
  1761. <member name="F:System.Data.SQLite.SQLiteStatusOpsEnum.SQLITE_DBSTATUS_STMT_USED">
  1762. <summary>
  1763. This parameter returns the number malloc attempts that might
  1764. have been satisfied using lookaside memory but failed due to
  1765. all lookaside memory already being in use. Only the high-water
  1766. value is meaningful; the current value is always zero.
  1767. </summary>
  1768. </member>
  1769. <member name="F:System.Data.SQLite.SQLiteStatusOpsEnum.SQLITE_DBSTATUS_LOOKASIDE_HIT">
  1770. <summary>
  1771. This parameter returns the number malloc attempts that were
  1772. satisfied using lookaside memory. Only the high-water value
  1773. is meaningful; the current value is always zero.
  1774. </summary>
  1775. </member>
  1776. <member name="F:System.Data.SQLite.SQLiteStatusOpsEnum.SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE">
  1777. <summary>
  1778. This parameter returns the number malloc attempts that might
  1779. have been satisfied using lookaside memory but failed due to
  1780. the amount of memory requested being larger than the lookaside
  1781. slot size. Only the high-water value is meaningful; the current
  1782. value is always zero.
  1783. </summary>
  1784. </member>
  1785. <member name="F:System.Data.SQLite.SQLiteStatusOpsEnum.SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL">
  1786. <summary>
  1787. This parameter returns the number malloc attempts that might
  1788. have been satisfied using lookaside memory but failed due to
  1789. the amount of memory requested being larger than the lookaside
  1790. slot size. Only the high-water value is meaningful; the current
  1791. value is always zero.
  1792. </summary>
  1793. </member>
  1794. <member name="F:System.Data.SQLite.SQLiteStatusOpsEnum.SQLITE_DBSTATUS_CACHE_HIT">
  1795. <summary>
  1796. This parameter returns the number of pager cache hits that
  1797. have occurred. The highwater mark associated with
  1798. SQLITE_DBSTATUS_CACHE_HIT is always 0.
  1799. </summary>
  1800. </member>
  1801. <member name="F:System.Data.SQLite.SQLiteStatusOpsEnum.SQLITE_DBSTATUS_CACHE_MISS">
  1802. <summary>
  1803. This parameter returns the number of pager cache misses that
  1804. have occurred. The highwater mark associated with
  1805. SQLITE_DBSTATUS_CACHE_MISS is always 0.
  1806. </summary>
  1807. </member>
  1808. <member name="F:System.Data.SQLite.SQLiteStatusOpsEnum.SQLITE_DBSTATUS_CACHE_WRITE">
  1809. <summary>
  1810. This parameter returns the number of dirty cache entries that
  1811. have been written to disk. Specifically, the number of pages
  1812. written to the wal file in wal mode databases, or the number
  1813. of pages written to the database file in rollback mode
  1814. databases. Any pages written as part of transaction rollback
  1815. or database recovery operations are not included. If an IO or
  1816. other error occurs while writing a page to disk, the effect
  1817. on subsequent SQLITE_DBSTATUS_CACHE_WRITE requests is
  1818. undefined. The highwater mark associated with
  1819. SQLITE_DBSTATUS_CACHE_WRITE is always 0.
  1820. </summary>
  1821. </member>
  1822. <member name="F:System.Data.SQLite.SQLiteStatusOpsEnum.SQLITE_DBSTATUS_DEFERRED_FKS">
  1823. <summary>
  1824. This parameter returns zero for the current value if and only
  1825. if all foreign key constraints (deferred or immediate) have
  1826. been resolved. The highwater mark is always 0.
  1827. </summary>
  1828. </member>
  1829. <member name="F:System.Data.SQLite.SQLiteStatusOpsEnum.SQLITE_DBSTATUS_CACHE_USED_SHARED">
  1830. <summary>
  1831. This parameter is similar to DBSTATUS_CACHE_USED, except that
  1832. if a pager cache is shared between two or more connections the
  1833. bytes of heap memory used by that pager cache is divided evenly
  1834. between the attached connections. In other words, if none of
  1835. the pager caches associated with the database connection are
  1836. shared, this request returns the same value as DBSTATUS_CACHE_USED.
  1837. Or, if one or more or the pager caches are shared, the value
  1838. returned by this call will be smaller than that returned by
  1839. DBSTATUS_CACHE_USED. The highwater mark associated with
  1840. SQLITE_DBSTATUS_CACHE_USED_SHARED is always 0.
  1841. </summary>
  1842. </member>
  1843. <member name="F:System.Data.SQLite.SQLiteStatusOpsEnum.SQLITE_DBSTATUS_CACHE_SPILL">
  1844. <summary>
  1845. This parameter returns the number of dirty cache entries that have
  1846. been written to disk in the middle of a transaction due to the page
  1847. cache overflowing. Transactions are more efficient if they are
  1848. written to disk all at once. When pages spill mid-transaction, that
  1849. introduces additional overhead. This parameter can be used help
  1850. identify inefficiencies that can be resolved by increasing the cache
  1851. size.
  1852. </summary>
  1853. </member>
  1854. <member name="T:System.Data.SQLite.SQLiteConfigDbOpsEnum">
  1855. <summary>
  1856. These are the supported configuration verbs for use with the native
  1857. SQLite library. They are used with the
  1858. <see cref="M:System.Data.SQLite.SQLiteConnection.SetConfigurationOption(System.Data.SQLite.SQLiteConfigDbOpsEnum,System.Object)" /> method.
  1859. </summary>
  1860. </member>
  1861. <member name="F:System.Data.SQLite.SQLiteConfigDbOpsEnum.SQLITE_DBCONFIG_NONE">
  1862. <summary>
  1863. This value represents an unknown (or invalid) option, do not use it.
  1864. </summary>
  1865. </member>
  1866. <member name="F:System.Data.SQLite.SQLiteConfigDbOpsEnum.SQLITE_DBCONFIG_MAINDBNAME">
  1867. <summary>
  1868. This option is used to change the name of the "main" database
  1869. schema. The sole argument is a pointer to a constant UTF8 string
  1870. which will become the new schema name in place of "main".
  1871. </summary>
  1872. </member>
  1873. <member name="F:System.Data.SQLite.SQLiteConfigDbOpsEnum.SQLITE_DBCONFIG_LOOKASIDE">
  1874. <summary>
  1875. This option is used to configure the lookaside memory allocator.
  1876. The value must be an array with three elements. The second element
  1877. must be an <see cref="T:System.Int32" /> containing the size of each buffer
  1878. slot. The third element must be an <see cref="T:System.Int32" /> containing
  1879. the number of slots. The first element must be an <see cref="T:System.IntPtr" />
  1880. that points to a native memory buffer of bytes equal to or greater
  1881. than the product of the second and third element values.
  1882. </summary>
  1883. </member>
  1884. <member name="F:System.Data.SQLite.SQLiteConfigDbOpsEnum.SQLITE_DBCONFIG_ENABLE_FKEY">
  1885. <summary>
  1886. This option is used to enable or disable the enforcement of
  1887. foreign key constraints.
  1888. </summary>
  1889. </member>
  1890. <member name="F:System.Data.SQLite.SQLiteConfigDbOpsEnum.SQLITE_DBCONFIG_ENABLE_TRIGGER">
  1891. <summary>
  1892. This option is used to enable or disable triggers.
  1893. </summary>
  1894. </member>
  1895. <member name="F:System.Data.SQLite.SQLiteConfigDbOpsEnum.SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER">
  1896. <summary>
  1897. This option is used to enable or disable the two-argument version
  1898. of the fts3_tokenizer() function which is part of the FTS3 full-text
  1899. search engine extension.
  1900. </summary>
  1901. </member>
  1902. <member name="F:System.Data.SQLite.SQLiteConfigDbOpsEnum.SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION">
  1903. <summary>
  1904. This option is used to enable or disable the loading of extensions.
  1905. </summary>
  1906. </member>
  1907. <member name="F:System.Data.SQLite.SQLiteConfigDbOpsEnum.SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE">
  1908. <summary>
  1909. This option is used to enable or disable the automatic checkpointing
  1910. when a WAL database is closed.
  1911. </summary>
  1912. </member>
  1913. <member name="F:System.Data.SQLite.SQLiteConfigDbOpsEnum.SQLITE_DBCONFIG_ENABLE_QPSG">
  1914. <summary>
  1915. This option is used to enable or disable the query planner stability
  1916. guarantee (QPSG).
  1917. </summary>
  1918. </member>
  1919. <member name="F:System.Data.SQLite.SQLiteConfigDbOpsEnum.SQLITE_DBCONFIG_TRIGGER_EQP">
  1920. <summary>
  1921. This option is used to enable or disable the extra EXPLAIN QUERY PLAN
  1922. output for trigger programs.
  1923. </summary>
  1924. </member>
  1925. <member name="F:System.Data.SQLite.SQLiteConfigDbOpsEnum.SQLITE_DBCONFIG_RESET_DATABASE">
  1926. <summary>
  1927. This option is used as part of the process to reset a database back
  1928. to an empty state. Because resetting a database is destructive and
  1929. irreversible, the process requires the use of this obscure flag and
  1930. multiple steps to help ensure that it does not happen by accident.
  1931. </summary>
  1932. </member>
  1933. <member name="F:System.Data.SQLite.SQLiteConfigDbOpsEnum.SQLITE_DBCONFIG_DEFENSIVE">
  1934. <summary>
  1935. This option activates or deactivates the "defensive" flag for a
  1936. database connection. When the defensive flag is enabled, language
  1937. features that allow ordinary SQL to deliberately corrupt the database
  1938. file are disabled. The disabled features include but are not limited
  1939. to the following:
  1940. <![CDATA[<ul>]]>
  1941. <![CDATA[<li>]]>
  1942. The PRAGMA writable_schema=ON statement.
  1943. <![CDATA[</li>]]>
  1944. <![CDATA[<li>]]>
  1945. The PRAGMA journal_mode=OFF statement.
  1946. <![CDATA[</li>]]>
  1947. <![CDATA[<li>]]>
  1948. Writes to the sqlite_dbpage virtual table.
  1949. <![CDATA[</li>]]>
  1950. <![CDATA[<li>]]>
  1951. Direct writes to shadow tables.
  1952. <![CDATA[</li>]]>
  1953. <![CDATA[</ul>]]>
  1954. </summary>
  1955. </member>
  1956. <member name="F:System.Data.SQLite.SQLiteConfigDbOpsEnum.SQLITE_DBCONFIG_WRITABLE_SCHEMA">
  1957. <summary>
  1958. This option activates or deactivates the "writable_schema" flag.
  1959. </summary>
  1960. </member>
  1961. <member name="F:System.Data.SQLite.SQLiteConfigDbOpsEnum.SQLITE_DBCONFIG_LEGACY_ALTER_TABLE">
  1962. <summary>
  1963. This option activates or deactivates the legacy behavior of the ALTER
  1964. TABLE RENAME command such it behaves as it did prior to version 3.24.0
  1965. (2018-06-04).
  1966. </summary>
  1967. </member>
  1968. <member name="F:System.Data.SQLite.SQLiteConfigDbOpsEnum.SQLITE_DBCONFIG_DQS_DML">
  1969. <summary>
  1970. This option activates or deactivates the legacy double-quoted string
  1971. literal misfeature for DML statement only, that is DELETE, INSERT,
  1972. SELECT, and UPDATE statements.
  1973. </summary>
  1974. </member>
  1975. <member name="F:System.Data.SQLite.SQLiteConfigDbOpsEnum.SQLITE_DBCONFIG_DQS_DDL">
  1976. <summary>
  1977. This option activates or deactivates the legacy double-quoted string
  1978. literal misfeature for DDL statements, such as CREATE TABLE and CREATE
  1979. INDEX.
  1980. </summary>
  1981. </member>
  1982. <member name="F:System.Data.SQLite.SQLiteConfigDbOpsEnum.SQLITE_DBCONFIG_ENABLE_VIEW">
  1983. <summary>
  1984. This option is used to enable or disable CREATE VIEW.
  1985. </summary>
  1986. </member>
  1987. <member name="F:System.Data.SQLite.SQLiteConfigDbOpsEnum.SQLITE_DBCONFIG_LEGACY_FILE_FORMAT">
  1988. <summary>
  1989. This option activates or deactivates the legacy file format flag.
  1990. </summary>
  1991. </member>
  1992. <member name="F:System.Data.SQLite.SQLiteConfigDbOpsEnum.SQLITE_DBCONFIG_TRUSTED_SCHEMA">
  1993. <summary>
  1994. This option tells SQLite to assume that database schemas (i.e. the
  1995. contents of the sqlite_master tables) are untainted by malicious
  1996. content. When the trusted schema option is disabled, SQLite takes
  1997. additional defensive steps to protect the application from harm
  1998. including:
  1999. <![CDATA[<ul>]]>
  2000. <![CDATA[<li>]]>
  2001. Prohibit the use of SQL functions inside triggers, views, CHECK
  2002. constraints, DEFAULT clauses, expression indexes, partial indexes,
  2003. or generated columns unless those functions are tagged with
  2004. SQLITE_INNOCUOUS.
  2005. <![CDATA[</li>]]>
  2006. <![CDATA[<li>]]>
  2007. Prohibit the use of virtual tables inside of triggers or views
  2008. unless those virtual tables are tagged with SQLITE_VTAB_INNOCUOUS.
  2009. <![CDATA[</ul>]]>
  2010. This setting defaults to "on" for legacy compatibility, however
  2011. all applications are advised to turn it off if possible. This
  2012. setting can also be controlled using the PRAGMA trusted_schema
  2013. statement.
  2014. </summary>
  2015. </member>
  2016. <member name="T:System.Data.SQLite.SQLiteTraceFlags">
  2017. <summary>
  2018. These constants are used with the sqlite3_trace_v2() API and the
  2019. callbacks registered by it.
  2020. </summary>
  2021. </member>
  2022. <member name="T:System.Data.SQLite.SQLiteLimitOpsEnum">
  2023. <summary>
  2024. These constants are used with the sqlite3_limit() API.
  2025. </summary>
  2026. </member>
  2027. <member name="F:System.Data.SQLite.SQLiteLimitOpsEnum.SQLITE_LIMIT_NONE">
  2028. <summary>
  2029. This value represents an unknown (or invalid) limit, do not use it.
  2030. </summary>
  2031. </member>
  2032. <member name="F:System.Data.SQLite.SQLiteLimitOpsEnum.SQLITE_LIMIT_LENGTH">
  2033. <summary>
  2034. The maximum size of any string or BLOB or table row, in bytes.
  2035. </summary>
  2036. </member>
  2037. <member name="F:System.Data.SQLite.SQLiteLimitOpsEnum.SQLITE_LIMIT_SQL_LENGTH">
  2038. <summary>
  2039. The maximum length of an SQL statement, in bytes.
  2040. </summary>
  2041. </member>
  2042. <member name="F:System.Data.SQLite.SQLiteLimitOpsEnum.SQLITE_LIMIT_COLUMN">
  2043. <summary>
  2044. The maximum number of columns in a table definition or in the
  2045. result set of a SELECT or the maximum number of columns in an
  2046. index or in an ORDER BY or GROUP BY clause.
  2047. </summary>
  2048. </member>
  2049. <member name="F:System.Data.SQLite.SQLiteLimitOpsEnum.SQLITE_LIMIT_EXPR_DEPTH">
  2050. <summary>
  2051. The maximum depth of the parse tree on any expression.
  2052. </summary>
  2053. </member>
  2054. <member name="F:System.Data.SQLite.SQLiteLimitOpsEnum.SQLITE_LIMIT_COMPOUND_SELECT">
  2055. <summary>
  2056. The maximum number of terms in a compound SELECT statement.
  2057. </summary>
  2058. </member>
  2059. <member name="F:System.Data.SQLite.SQLiteLimitOpsEnum.SQLITE_LIMIT_VDBE_OP">
  2060. <summary>
  2061. The maximum number of instructions in a virtual machine program
  2062. used to implement an SQL statement. If sqlite3_prepare_v2() or
  2063. the equivalent tries to allocate space for more than this many
  2064. opcodes in a single prepared statement, an SQLITE_NOMEM error
  2065. is returned.
  2066. </summary>
  2067. </member>
  2068. <member name="F:System.Data.SQLite.SQLiteLimitOpsEnum.SQLITE_LIMIT_FUNCTION_ARG">
  2069. <summary>
  2070. The maximum number of arguments on a function.
  2071. </summary>
  2072. </member>
  2073. <member name="F:System.Data.SQLite.SQLiteLimitOpsEnum.SQLITE_LIMIT_ATTACHED">
  2074. <summary>
  2075. The maximum number of attached databases.
  2076. </summary>
  2077. </member>
  2078. <member name="F:System.Data.SQLite.SQLiteLimitOpsEnum.SQLITE_LIMIT_LIKE_PATTERN_LENGTH">
  2079. <summary>
  2080. The maximum length of the pattern argument to the LIKE or GLOB
  2081. operators.
  2082. </summary>
  2083. </member>
  2084. <member name="F:System.Data.SQLite.SQLiteLimitOpsEnum.SQLITE_LIMIT_VARIABLE_NUMBER">
  2085. <summary>
  2086. The maximum index number of any parameter in an SQL statement.
  2087. </summary>
  2088. </member>
  2089. <member name="F:System.Data.SQLite.SQLiteLimitOpsEnum.SQLITE_LIMIT_TRIGGER_DEPTH">
  2090. <summary>
  2091. The maximum depth of recursion for triggers.
  2092. </summary>
  2093. </member>
  2094. <member name="F:System.Data.SQLite.SQLiteLimitOpsEnum.SQLITE_LIMIT_WORKER_THREADS">
  2095. <summary>
  2096. The maximum number of auxiliary worker threads that a single
  2097. prepared statement may start.
  2098. </summary>
  2099. </member>
  2100. <member name="T:System.Data.SQLite.SQLiteBlob">
  2101. <summary>
  2102. Represents a single SQL blob in SQLite.
  2103. </summary>
  2104. </member>
  2105. <member name="F:System.Data.SQLite.SQLiteBlob._sql">
  2106. <summary>
  2107. The underlying SQLite object this blob is bound to.
  2108. </summary>
  2109. </member>
  2110. <member name="F:System.Data.SQLite.SQLiteBlob._sqlite_blob">
  2111. <summary>
  2112. The actual blob handle.
  2113. </summary>
  2114. </member>
  2115. <member name="M:System.Data.SQLite.SQLiteBlob.#ctor(System.Data.SQLite.SQLiteBase,System.Data.SQLite.SQLiteBlobHandle)">
  2116. <summary>
  2117. Initializes the blob.
  2118. </summary>
  2119. <param name="sqlbase">The base SQLite object.</param>
  2120. <param name="blob">The blob handle.</param>
  2121. </member>
  2122. <member name="M:System.Data.SQLite.SQLiteBlob.Create(System.Data.SQLite.SQLiteDataReader,System.Int32,System.Boolean)">
  2123. <summary>
  2124. Creates a <see cref="T:System.Data.SQLite.SQLiteBlob" /> object. This will not work
  2125. for tables that were created WITHOUT ROWID -OR- if the query
  2126. does not include the "rowid" column or one of its aliases -OR-
  2127. if the <see cref="T:System.Data.SQLite.SQLiteDataReader" /> was not created with the
  2128. <see cref="F:System.Data.CommandBehavior.KeyInfo" /> flag.
  2129. </summary>
  2130. <param name="dataReader">
  2131. The <see cref="T:System.Data.SQLite.SQLiteDataReader" /> instance with a result set
  2132. containing the desired blob column.
  2133. </param>
  2134. <param name="i">
  2135. The index of the blob column.
  2136. </param>
  2137. <param name="readOnly">
  2138. Non-zero to open the blob object for read-only access.
  2139. </param>
  2140. <returns>
  2141. The newly created <see cref="T:System.Data.SQLite.SQLiteBlob" /> instance -OR- null
  2142. if an error occurs.
  2143. </returns>
  2144. </member>
  2145. <member name="M:System.Data.SQLite.SQLiteBlob.Create(System.Data.SQLite.SQLiteConnection,System.String,System.String,System.String,System.Int64,System.Boolean)">
  2146. <summary>
  2147. Creates a <see cref="T:System.Data.SQLite.SQLiteBlob" /> object. This will not work
  2148. for tables that were created WITHOUT ROWID.
  2149. </summary>
  2150. <param name="connection">
  2151. The connection to use when opening the blob object.
  2152. </param>
  2153. <param name="databaseName">
  2154. The name of the database containing the blob object.
  2155. </param>
  2156. <param name="tableName">
  2157. The name of the table containing the blob object.
  2158. </param>
  2159. <param name="columnName">
  2160. The name of the column containing the blob object.
  2161. </param>
  2162. <param name="rowId">
  2163. The integer identifier for the row associated with the desired
  2164. blob object.
  2165. </param>
  2166. <param name="readOnly">
  2167. Non-zero to open the blob object for read-only access.
  2168. </param>
  2169. <returns>
  2170. The newly created <see cref="T:System.Data.SQLite.SQLiteBlob" /> instance -OR- null
  2171. if an error occurs.
  2172. </returns>
  2173. </member>
  2174. <member name="M:System.Data.SQLite.SQLiteBlob.CheckOpen">
  2175. <summary>
  2176. Throws an exception if the blob object does not appear to be open.
  2177. </summary>
  2178. </member>
  2179. <member name="M:System.Data.SQLite.SQLiteBlob.VerifyParameters(System.Byte[],System.Int32,System.Int32)">
  2180. <summary>
  2181. Throws an exception if an invalid read/write parameter is detected.
  2182. </summary>
  2183. <param name="buffer">
  2184. When reading, this array will be populated with the bytes read from
  2185. the underlying database blob. When writing, this array contains new
  2186. values for the specified portion of the underlying database blob.
  2187. </param>
  2188. <param name="count">
  2189. The number of bytes to read or write.
  2190. </param>
  2191. <param name="offset">
  2192. The byte offset, relative to the start of the underlying database
  2193. blob, where the read or write operation will begin.
  2194. </param>
  2195. </member>
  2196. <member name="M:System.Data.SQLite.SQLiteBlob.Reopen(System.Int64)">
  2197. <summary>
  2198. Retargets this object to an underlying database blob for a
  2199. different row; the database, table, and column remain exactly
  2200. the same. If this operation fails for any reason, this blob
  2201. object is automatically disposed.
  2202. </summary>
  2203. <param name="rowId">
  2204. The integer identifier for the new row.
  2205. </param>
  2206. </member>
  2207. <member name="M:System.Data.SQLite.SQLiteBlob.GetCount">
  2208. <summary>
  2209. Queries the total number of bytes for the underlying database blob.
  2210. </summary>
  2211. <returns>
  2212. The total number of bytes for the underlying database blob.
  2213. </returns>
  2214. </member>
  2215. <member name="M:System.Data.SQLite.SQLiteBlob.Read(System.Byte[],System.Int32,System.Int32)">
  2216. <summary>
  2217. Reads data from the underlying database blob.
  2218. </summary>
  2219. <param name="buffer">
  2220. This array will be populated with the bytes read from the
  2221. underlying database blob.
  2222. </param>
  2223. <param name="count">
  2224. The number of bytes to read.
  2225. </param>
  2226. <param name="offset">
  2227. The byte offset, relative to the start of the underlying
  2228. database blob, where the read operation will begin.
  2229. </param>
  2230. </member>
  2231. <member name="M:System.Data.SQLite.SQLiteBlob.Write(System.Byte[],System.Int32,System.Int32)">
  2232. <summary>
  2233. Writes data into the underlying database blob.
  2234. </summary>
  2235. <param name="buffer">
  2236. This array contains the new values for the specified portion of
  2237. the underlying database blob.
  2238. </param>
  2239. <param name="count">
  2240. The number of bytes to write.
  2241. </param>
  2242. <param name="offset">
  2243. The byte offset, relative to the start of the underlying
  2244. database blob, where the write operation will begin.
  2245. </param>
  2246. </member>
  2247. <member name="M:System.Data.SQLite.SQLiteBlob.Close">
  2248. <summary>
  2249. Closes the blob, freeing the associated resources.
  2250. </summary>
  2251. </member>
  2252. <member name="M:System.Data.SQLite.SQLiteBlob.Dispose">
  2253. <summary>
  2254. Disposes and finalizes the blob.
  2255. </summary>
  2256. </member>
  2257. <member name="M:System.Data.SQLite.SQLiteBlob.Finalize">
  2258. <summary>
  2259. The destructor.
  2260. </summary>
  2261. </member>
  2262. <member name="T:System.Data.SQLite.SQLiteCommand">
  2263. <summary>
  2264. SQLite implementation of DbCommand.
  2265. </summary>
  2266. </member>
  2267. <member name="F:System.Data.SQLite.SQLiteCommand.DefaultConnectionString">
  2268. <summary>
  2269. The default connection string to be used when creating a temporary
  2270. connection to execute a command via the static
  2271. <see cref="M:System.Data.SQLite.SQLiteCommand.Execute(System.String,System.Data.SQLite.SQLiteExecuteType,System.String,System.Object[])" /> or
  2272. <see cref="M:System.Data.SQLite.SQLiteCommand.Execute(System.String,System.Data.SQLite.SQLiteExecuteType,System.Data.CommandBehavior,System.String,System.Object[])" />
  2273. methods.
  2274. </summary>
  2275. </member>
  2276. <member name="F:System.Data.SQLite.SQLiteCommand._commandText">
  2277. <summary>
  2278. The command text this command is based on
  2279. </summary>
  2280. </member>
  2281. <member name="F:System.Data.SQLite.SQLiteCommand._cnn">
  2282. <summary>
  2283. The connection the command is associated with
  2284. </summary>
  2285. </member>
  2286. <member name="F:System.Data.SQLite.SQLiteCommand._version">
  2287. <summary>
  2288. The version of the connection the command is associated with
  2289. </summary>
  2290. </member>
  2291. <member name="F:System.Data.SQLite.SQLiteCommand._activeReader">
  2292. <summary>
  2293. Indicates whether or not a DataReader is active on the command.
  2294. </summary>
  2295. </member>
  2296. <member name="F:System.Data.SQLite.SQLiteCommand._commandTimeout">
  2297. <summary>
  2298. The timeout for the command, kludged because SQLite doesn't support per-command timeout values
  2299. </summary>
  2300. </member>
  2301. <member name="F:System.Data.SQLite.SQLiteCommand._designTimeVisible">
  2302. <summary>
  2303. Designer support
  2304. </summary>
  2305. </member>
  2306. <member name="F:System.Data.SQLite.SQLiteCommand._updateRowSource">
  2307. <summary>
  2308. Used by DbDataAdapter to determine updating behavior
  2309. </summary>
  2310. </member>
  2311. <member name="F:System.Data.SQLite.SQLiteCommand._parameterCollection">
  2312. <summary>
  2313. The collection of parameters for the command
  2314. </summary>
  2315. </member>
  2316. <member name="F:System.Data.SQLite.SQLiteCommand._statementList">
  2317. <summary>
  2318. The SQL command text, broken into individual SQL statements as they are executed
  2319. </summary>
  2320. </member>
  2321. <member name="F:System.Data.SQLite.SQLiteCommand._remainingText">
  2322. <summary>
  2323. Unprocessed SQL text that has not been executed
  2324. </summary>
  2325. </member>
  2326. <member name="F:System.Data.SQLite.SQLiteCommand._transaction">
  2327. <summary>
  2328. Transaction associated with this command
  2329. </summary>
  2330. </member>
  2331. <member name="M:System.Data.SQLite.SQLiteCommand.#ctor">
  2332. <overloads>
  2333. Constructs a new SQLiteCommand
  2334. </overloads>
  2335. <summary>
  2336. Default constructor
  2337. </summary>
  2338. </member>
  2339. <member name="M:System.Data.SQLite.SQLiteCommand.#ctor(System.String)">
  2340. <summary>
  2341. Initializes the command with the given command text
  2342. </summary>
  2343. <param name="commandText">The SQL command text</param>
  2344. </member>
  2345. <member name="M:System.Data.SQLite.SQLiteCommand.#ctor(System.String,System.Data.SQLite.SQLiteConnection)">
  2346. <summary>
  2347. Initializes the command with the given SQL command text and attach the command to the specified
  2348. connection.
  2349. </summary>
  2350. <param name="commandText">The SQL command text</param>
  2351. <param name="connection">The connection to associate with the command</param>
  2352. </member>
  2353. <member name="M:System.Data.SQLite.SQLiteCommand.#ctor(System.Data.SQLite.SQLiteConnection)">
  2354. <summary>
  2355. Initializes the command and associates it with the specified connection.
  2356. </summary>
  2357. <param name="connection">The connection to associate with the command</param>
  2358. </member>
  2359. <member name="M:System.Data.SQLite.SQLiteCommand.#ctor(System.String,System.Data.SQLite.SQLiteConnection,System.Data.SQLite.SQLiteTransaction)">
  2360. <summary>
  2361. Initializes a command with the given SQL, connection and transaction
  2362. </summary>
  2363. <param name="commandText">The SQL command text</param>
  2364. <param name="connection">The connection to associate with the command</param>
  2365. <param name="transaction">The transaction the command should be associated with</param>
  2366. </member>
  2367. <member name="M:System.Data.SQLite.SQLiteCommand.Dispose(System.Boolean)">
  2368. <summary>
  2369. Disposes of the command and clears all member variables
  2370. </summary>
  2371. <param name="disposing">Whether or not the class is being explicitly or implicitly disposed</param>
  2372. </member>
  2373. <member name="M:System.Data.SQLite.SQLiteCommand.GetFlags(System.Data.SQLite.SQLiteCommand)">
  2374. <summary>
  2375. This method attempts to query the flags associated with the database
  2376. connection in use. If the database connection is disposed, the default
  2377. flags will be returned.
  2378. </summary>
  2379. <param name="command">
  2380. The command containing the databse connection to query the flags from.
  2381. </param>
  2382. <returns>
  2383. The connection flags value.
  2384. </returns>
  2385. </member>
  2386. <member name="M:System.Data.SQLite.SQLiteCommand.ClearCommands">
  2387. <summary>
  2388. Clears and destroys all statements currently prepared
  2389. </summary>
  2390. </member>
  2391. <member name="M:System.Data.SQLite.SQLiteCommand.BuildNextCommand">
  2392. <summary>
  2393. Builds an array of prepared statements for each complete SQL statement in the command text
  2394. </summary>
  2395. </member>
  2396. <member name="M:System.Data.SQLite.SQLiteCommand.Cancel">
  2397. <summary>
  2398. Not implemented
  2399. </summary>
  2400. </member>
  2401. <member name="P:System.Data.SQLite.SQLiteCommand.CommandText">
  2402. <summary>
  2403. The SQL command text associated with the command
  2404. </summary>
  2405. </member>
  2406. <member name="P:System.Data.SQLite.SQLiteCommand.CommandTimeout">
  2407. <summary>
  2408. The amount of time to wait for the connection to become available before erroring out
  2409. </summary>
  2410. </member>
  2411. <member name="P:System.Data.SQLite.SQLiteCommand.CommandType">
  2412. <summary>
  2413. The type of the command. SQLite only supports CommandType.Text
  2414. </summary>
  2415. </member>
  2416. <member name="M:System.Data.SQLite.SQLiteCommand.CreateDbParameter">
  2417. <summary>
  2418. Forwards to the local CreateParameter() function
  2419. </summary>
  2420. <returns></returns>
  2421. </member>
  2422. <member name="M:System.Data.SQLite.SQLiteCommand.CreateParameter">
  2423. <summary>
  2424. Create a new parameter
  2425. </summary>
  2426. <returns></returns>
  2427. </member>
  2428. <member name="P:System.Data.SQLite.SQLiteCommand.Connection">
  2429. <summary>
  2430. The connection associated with this command
  2431. </summary>
  2432. </member>
  2433. <member name="P:System.Data.SQLite.SQLiteCommand.DbConnection">
  2434. <summary>
  2435. Forwards to the local Connection property
  2436. </summary>
  2437. </member>
  2438. <member name="P:System.Data.SQLite.SQLiteCommand.Parameters">
  2439. <summary>
  2440. Returns the SQLiteParameterCollection for the given command
  2441. </summary>
  2442. </member>
  2443. <member name="P:System.Data.SQLite.SQLiteCommand.DbParameterCollection">
  2444. <summary>
  2445. Forwards to the local Parameters property
  2446. </summary>
  2447. </member>
  2448. <member name="P:System.Data.SQLite.SQLiteCommand.Transaction">
  2449. <summary>
  2450. The transaction associated with this command. SQLite only supports one transaction per connection, so this property forwards to the
  2451. command's underlying connection.
  2452. </summary>
  2453. </member>
  2454. <member name="P:System.Data.SQLite.SQLiteCommand.DbTransaction">
  2455. <summary>
  2456. Forwards to the local Transaction property
  2457. </summary>
  2458. </member>
  2459. <member name="M:System.Data.SQLite.SQLiteCommand.VerifyOnly">
  2460. <summary>
  2461. Verifies that all SQL queries associated with the current command text
  2462. can be successfully compiled. A <see cref="T:System.Data.SQLite.SQLiteException" /> will be
  2463. raised if any errors occur.
  2464. </summary>
  2465. </member>
  2466. <member name="M:System.Data.SQLite.SQLiteCommand.InitializeForReader">
  2467. <summary>
  2468. This function ensures there are no active readers, that we have a valid connection,
  2469. that the connection is open, that all statements are prepared and all parameters are assigned
  2470. in preparation for allocating a data reader.
  2471. </summary>
  2472. </member>
  2473. <member name="M:System.Data.SQLite.SQLiteCommand.ExecuteDbDataReader(System.Data.CommandBehavior)">
  2474. <summary>
  2475. Creates a new SQLiteDataReader to execute/iterate the array of SQLite prepared statements
  2476. </summary>
  2477. <param name="behavior">The behavior the data reader should adopt</param>
  2478. <returns>Returns a SQLiteDataReader object</returns>
  2479. </member>
  2480. <member name="M:System.Data.SQLite.SQLiteCommand.Execute(System.String,System.Data.SQLite.SQLiteExecuteType,System.String,System.Object[])">
  2481. <summary>
  2482. This method creates a new connection, executes the query using the given
  2483. execution type, closes the connection, and returns the results. If the
  2484. connection string is null, a temporary in-memory database connection will
  2485. be used.
  2486. </summary>
  2487. <param name="commandText">
  2488. The text of the command to be executed.
  2489. </param>
  2490. <param name="executeType">
  2491. The execution type for the command. This is used to determine which method
  2492. of the command object to call, which then determines the type of results
  2493. returned, if any.
  2494. </param>
  2495. <param name="connectionString">
  2496. The connection string to the database to be opened, used, and closed. If
  2497. this parameter is null, a temporary in-memory databse will be used.
  2498. </param>
  2499. <param name="args">
  2500. The SQL parameter values to be used when building the command object to be
  2501. executed, if any.
  2502. </param>
  2503. <returns>
  2504. The results of the query -OR- null if no results were produced from the
  2505. given execution type.
  2506. </returns>
  2507. </member>
  2508. <member name="M:System.Data.SQLite.SQLiteCommand.Execute(System.String,System.Data.SQLite.SQLiteExecuteType,System.Data.CommandBehavior,System.String,System.Object[])">
  2509. <summary>
  2510. This method creates a new connection, executes the query using the given
  2511. execution type and command behavior, closes the connection unless a data
  2512. reader is created, and returns the results. If the connection string is
  2513. null, a temporary in-memory database connection will be used.
  2514. </summary>
  2515. <param name="commandText">
  2516. The text of the command to be executed.
  2517. </param>
  2518. <param name="executeType">
  2519. The execution type for the command. This is used to determine which method
  2520. of the command object to call, which then determines the type of results
  2521. returned, if any.
  2522. </param>
  2523. <param name="commandBehavior">
  2524. The command behavior flags for the command.
  2525. </param>
  2526. <param name="connectionString">
  2527. The connection string to the database to be opened, used, and closed. If
  2528. this parameter is null, a temporary in-memory databse will be used.
  2529. </param>
  2530. <param name="args">
  2531. The SQL parameter values to be used when building the command object to be
  2532. executed, if any.
  2533. </param>
  2534. <returns>
  2535. The results of the query -OR- null if no results were produced from the
  2536. given execution type.
  2537. </returns>
  2538. </member>
  2539. <member name="M:System.Data.SQLite.SQLiteCommand.Execute(System.String,System.Data.SQLite.SQLiteExecuteType,System.Data.CommandBehavior,System.Data.SQLite.SQLiteConnection,System.Object[])">
  2540. <summary>
  2541. This method executes a query using the given execution type and command
  2542. behavior and returns the results.
  2543. </summary>
  2544. <param name="commandText">
  2545. The text of the command to be executed.
  2546. </param>
  2547. <param name="executeType">
  2548. The execution type for the command. This is used to determine which method
  2549. of the command object to call, which then determines the type of results
  2550. returned, if any.
  2551. </param>
  2552. <param name="commandBehavior">
  2553. The command behavior flags for the command.
  2554. </param>
  2555. <param name="connection">
  2556. The connection used to create and execute the command.
  2557. </param>
  2558. <param name="args">
  2559. The SQL parameter values to be used when building the command object to be
  2560. executed, if any.
  2561. </param>
  2562. <returns>
  2563. The results of the query -OR- null if no results were produced from the
  2564. given execution type.
  2565. </returns>
  2566. </member>
  2567. <member name="M:System.Data.SQLite.SQLiteCommand.ExecuteReader(System.Data.CommandBehavior)">
  2568. <summary>
  2569. Overrides the default behavior to return a SQLiteDataReader specialization class
  2570. </summary>
  2571. <param name="behavior">The flags to be associated with the reader.</param>
  2572. <returns>A SQLiteDataReader</returns>
  2573. </member>
  2574. <member name="M:System.Data.SQLite.SQLiteCommand.ExecuteReader">
  2575. <summary>
  2576. Overrides the default behavior of DbDataReader to return a specialized SQLiteDataReader class
  2577. </summary>
  2578. <returns>A SQLiteDataReader</returns>
  2579. </member>
  2580. <member name="M:System.Data.SQLite.SQLiteCommand.ResetDataReader">
  2581. <summary>
  2582. Called by the SQLiteDataReader when the data reader is closed.
  2583. </summary>
  2584. </member>
  2585. <member name="M:System.Data.SQLite.SQLiteCommand.ExecuteNonQuery">
  2586. <summary>
  2587. Execute the command and return the number of rows inserted/updated affected by it.
  2588. </summary>
  2589. <returns>The number of rows inserted/updated affected by it.</returns>
  2590. </member>
  2591. <member name="M:System.Data.SQLite.SQLiteCommand.ExecuteNonQuery(System.Data.CommandBehavior)">
  2592. <summary>
  2593. Execute the command and return the number of rows inserted/updated affected by it.
  2594. </summary>
  2595. <param name="behavior">The flags to be associated with the reader.</param>
  2596. <returns>The number of rows inserted/updated affected by it.</returns>
  2597. </member>
  2598. <member name="M:System.Data.SQLite.SQLiteCommand.ExecuteScalar">
  2599. <summary>
  2600. Execute the command and return the first column of the first row of the resultset
  2601. (if present), or null if no resultset was returned.
  2602. </summary>
  2603. <returns>The first column of the first row of the first resultset from the query.</returns>
  2604. </member>
  2605. <member name="M:System.Data.SQLite.SQLiteCommand.ExecuteScalar(System.Data.CommandBehavior)">
  2606. <summary>
  2607. Execute the command and return the first column of the first row of the resultset
  2608. (if present), or null if no resultset was returned.
  2609. </summary>
  2610. <param name="behavior">The flags to be associated with the reader.</param>
  2611. <returns>The first column of the first row of the first resultset from the query.</returns>
  2612. </member>
  2613. <member name="M:System.Data.SQLite.SQLiteCommand.Reset">
  2614. <summary>
  2615. This method resets all the prepared statements held by this instance
  2616. back to their initial states, ready to be re-executed.
  2617. </summary>
  2618. </member>
  2619. <member name="M:System.Data.SQLite.SQLiteCommand.Reset(System.Boolean,System.Boolean)">
  2620. <summary>
  2621. This method resets all the prepared statements held by this instance
  2622. back to their initial states, ready to be re-executed.
  2623. </summary>
  2624. <param name="clearBindings">
  2625. Non-zero if the parameter bindings should be cleared as well.
  2626. </param>
  2627. <param name="ignoreErrors">
  2628. If this is zero, a <see cref="T:System.Data.SQLite.SQLiteException" /> may be thrown for
  2629. any unsuccessful return codes from the native library; otherwise, a
  2630. <see cref="T:System.Data.SQLite.SQLiteException" /> will only be thrown if the connection
  2631. or its state is invalid.
  2632. </param>
  2633. </member>
  2634. <member name="M:System.Data.SQLite.SQLiteCommand.Prepare">
  2635. <summary>
  2636. Does nothing. Commands are prepared as they are executed the first time, and kept in prepared state afterwards.
  2637. </summary>
  2638. </member>
  2639. <member name="P:System.Data.SQLite.SQLiteCommand.UpdatedRowSource">
  2640. <summary>
  2641. Sets the method the SQLiteCommandBuilder uses to determine how to update inserted or updated rows in a DataTable.
  2642. </summary>
  2643. </member>
  2644. <member name="P:System.Data.SQLite.SQLiteCommand.DesignTimeVisible">
  2645. <summary>
  2646. Determines if the command is visible at design time. Defaults to True.
  2647. </summary>
  2648. </member>
  2649. <member name="M:System.Data.SQLite.SQLiteCommand.Clone">
  2650. <summary>
  2651. Clones a command, including all its parameters
  2652. </summary>
  2653. <returns>A new SQLiteCommand with the same commandtext, connection and parameters</returns>
  2654. </member>
  2655. <member name="T:System.Data.SQLite.SQLiteCommandBuilder">
  2656. <summary>
  2657. SQLite implementation of DbCommandBuilder.
  2658. </summary>
  2659. </member>
  2660. <member name="M:System.Data.SQLite.SQLiteCommandBuilder.#ctor">
  2661. <summary>
  2662. Default constructor
  2663. </summary>
  2664. </member>
  2665. <member name="M:System.Data.SQLite.SQLiteCommandBuilder.#ctor(System.Data.SQLite.SQLiteDataAdapter)">
  2666. <summary>
  2667. Initializes the command builder and associates it with the specified data adapter.
  2668. </summary>
  2669. <param name="adp"></param>
  2670. </member>
  2671. <member name="M:System.Data.SQLite.SQLiteCommandBuilder.Dispose(System.Boolean)">
  2672. <summary>
  2673. Cleans up resources (native and managed) associated with the current instance.
  2674. </summary>
  2675. <param name="disposing">
  2676. Zero when being disposed via garbage collection; otherwise, non-zero.
  2677. </param>
  2678. </member>
  2679. <member name="M:System.Data.SQLite.SQLiteCommandBuilder.ApplyParameterInfo(System.Data.Common.DbParameter,System.Data.DataRow,System.Data.StatementType,System.Boolean)">
  2680. <summary>
  2681. Minimal amount of parameter processing. Primarily sets the DbType for the parameter equal to the provider type in the schema
  2682. </summary>
  2683. <param name="parameter">The parameter to use in applying custom behaviors to a row</param>
  2684. <param name="row">The row to apply the parameter to</param>
  2685. <param name="statementType">The type of statement</param>
  2686. <param name="whereClause">Whether the application of the parameter is part of a WHERE clause</param>
  2687. </member>
  2688. <member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetParameterName(System.String)">
  2689. <summary>
  2690. Returns a valid named parameter
  2691. </summary>
  2692. <param name="parameterName">The name of the parameter</param>
  2693. <returns>Error</returns>
  2694. </member>
  2695. <member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetParameterName(System.Int32)">
  2696. <summary>
  2697. Returns a named parameter for the given ordinal
  2698. </summary>
  2699. <param name="parameterOrdinal">The i of the parameter</param>
  2700. <returns>Error</returns>
  2701. </member>
  2702. <member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetParameterPlaceholder(System.Int32)">
  2703. <summary>
  2704. Returns a placeholder character for the specified parameter i.
  2705. </summary>
  2706. <param name="parameterOrdinal">The index of the parameter to provide a placeholder for</param>
  2707. <returns>Returns a named parameter</returns>
  2708. </member>
  2709. <member name="M:System.Data.SQLite.SQLiteCommandBuilder.SetRowUpdatingHandler(System.Data.Common.DbDataAdapter)">
  2710. <summary>
  2711. Sets the handler for receiving row updating events. Used by the DbCommandBuilder to autogenerate SQL
  2712. statements that may not have previously been generated.
  2713. </summary>
  2714. <param name="adapter">A data adapter to receive events on.</param>
  2715. </member>
  2716. <member name="P:System.Data.SQLite.SQLiteCommandBuilder.DataAdapter">
  2717. <summary>
  2718. Gets/sets the DataAdapter for this CommandBuilder
  2719. </summary>
  2720. </member>
  2721. <member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetDeleteCommand">
  2722. <summary>
  2723. Returns the automatically-generated SQLite command to delete rows from the database
  2724. </summary>
  2725. <returns></returns>
  2726. </member>
  2727. <member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetDeleteCommand(System.Boolean)">
  2728. <summary>
  2729. Returns the automatically-generated SQLite command to delete rows from the database
  2730. </summary>
  2731. <param name="useColumnsForParameterNames"></param>
  2732. <returns></returns>
  2733. </member>
  2734. <member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetUpdateCommand">
  2735. <summary>
  2736. Returns the automatically-generated SQLite command to update rows in the database
  2737. </summary>
  2738. <returns></returns>
  2739. </member>
  2740. <member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetUpdateCommand(System.Boolean)">
  2741. <summary>
  2742. Returns the automatically-generated SQLite command to update rows in the database
  2743. </summary>
  2744. <param name="useColumnsForParameterNames"></param>
  2745. <returns></returns>
  2746. </member>
  2747. <member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetInsertCommand">
  2748. <summary>
  2749. Returns the automatically-generated SQLite command to insert rows into the database
  2750. </summary>
  2751. <returns></returns>
  2752. </member>
  2753. <member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetInsertCommand(System.Boolean)">
  2754. <summary>
  2755. Returns the automatically-generated SQLite command to insert rows into the database
  2756. </summary>
  2757. <param name="useColumnsForParameterNames"></param>
  2758. <returns></returns>
  2759. </member>
  2760. <member name="P:System.Data.SQLite.SQLiteCommandBuilder.CatalogLocation">
  2761. <summary>
  2762. Overridden to hide its property from the designer
  2763. </summary>
  2764. </member>
  2765. <member name="P:System.Data.SQLite.SQLiteCommandBuilder.CatalogSeparator">
  2766. <summary>
  2767. Overridden to hide its property from the designer
  2768. </summary>
  2769. </member>
  2770. <member name="P:System.Data.SQLite.SQLiteCommandBuilder.QuotePrefix">
  2771. <summary>
  2772. Overridden to hide its property from the designer
  2773. </summary>
  2774. </member>
  2775. <member name="P:System.Data.SQLite.SQLiteCommandBuilder.QuoteSuffix">
  2776. <summary>
  2777. Overridden to hide its property from the designer
  2778. </summary>
  2779. </member>
  2780. <member name="M:System.Data.SQLite.SQLiteCommandBuilder.QuoteIdentifier(System.String)">
  2781. <summary>
  2782. Places brackets around an identifier
  2783. </summary>
  2784. <param name="unquotedIdentifier">The identifier to quote</param>
  2785. <returns>The bracketed identifier</returns>
  2786. </member>
  2787. <member name="M:System.Data.SQLite.SQLiteCommandBuilder.UnquoteIdentifier(System.String)">
  2788. <summary>
  2789. Removes brackets around an identifier
  2790. </summary>
  2791. <param name="quotedIdentifier">The quoted (bracketed) identifier</param>
  2792. <returns>The undecorated identifier</returns>
  2793. </member>
  2794. <member name="P:System.Data.SQLite.SQLiteCommandBuilder.SchemaSeparator">
  2795. <summary>
  2796. Overridden to hide its property from the designer
  2797. </summary>
  2798. </member>
  2799. <member name="M:System.Data.SQLite.SQLiteCommandBuilder.GetSchemaTable(System.Data.Common.DbCommand)">
  2800. <summary>
  2801. Override helper, which can help the base command builder choose the right keys for the given query
  2802. </summary>
  2803. <param name="sourceCommand"></param>
  2804. <returns></returns>
  2805. </member>
  2806. <member name="T:System.Data.SQLite.SQLiteDataReaderValue">
  2807. <summary>
  2808. This class represents a single value to be returned
  2809. from the <see cref="T:System.Data.SQLite.SQLiteDataReader" /> class via
  2810. its <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBlob(System.Int32,System.Boolean)" />,
  2811. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBoolean(System.Int32)" />,
  2812. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetByte(System.Int32)" />,
  2813. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)" />,
  2814. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChar(System.Int32)" />,
  2815. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)" />,
  2816. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetDateTime(System.Int32)" />,
  2817. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetDecimal(System.Int32)" />,
  2818. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetDouble(System.Int32)" />,
  2819. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetFloat(System.Int32)" />,
  2820. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetGuid(System.Int32)" />,
  2821. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetInt16(System.Int32)" />,
  2822. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetInt32(System.Int32)" />,
  2823. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetInt64(System.Int32)" />,
  2824. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetString(System.Int32)" />, or
  2825. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetValue(System.Int32)" /> method. If the value of the
  2826. associated public field of this class is null upon returning from the
  2827. callback, the null value will only be used if the return type for the
  2828. <see cref="T:System.Data.SQLite.SQLiteDataReader" /> method called is not a value type.
  2829. If the value to be returned from the <see cref="T:System.Data.SQLite.SQLiteDataReader" />
  2830. method is unsuitable (e.g. null with a value type), an exception will
  2831. be thrown.
  2832. </summary>
  2833. </member>
  2834. <member name="F:System.Data.SQLite.SQLiteDataReaderValue.BlobValue">
  2835. <summary>
  2836. The value to be returned from the
  2837. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBlob(System.Int32,System.Boolean)" /> method -OR- null to
  2838. indicate an error.
  2839. </summary>
  2840. </member>
  2841. <member name="F:System.Data.SQLite.SQLiteDataReaderValue.BooleanValue">
  2842. <summary>
  2843. The value to be returned from the
  2844. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBoolean(System.Int32)" /> method -OR- null to
  2845. indicate an error.
  2846. </summary>
  2847. </member>
  2848. <member name="F:System.Data.SQLite.SQLiteDataReaderValue.ByteValue">
  2849. <summary>
  2850. The value to be returned from the
  2851. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetByte(System.Int32)" /> method -OR- null to
  2852. indicate an error.
  2853. </summary>
  2854. </member>
  2855. <member name="F:System.Data.SQLite.SQLiteDataReaderValue.BytesValue">
  2856. <summary>
  2857. The value to be returned from the
  2858. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)" /> method.
  2859. </summary>
  2860. </member>
  2861. <member name="F:System.Data.SQLite.SQLiteDataReaderValue.CharValue">
  2862. <summary>
  2863. The value to be returned from the
  2864. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChar(System.Int32)" /> method -OR- null to
  2865. indicate an error.
  2866. </summary>
  2867. </member>
  2868. <member name="F:System.Data.SQLite.SQLiteDataReaderValue.CharsValue">
  2869. <summary>
  2870. The value to be returned from the
  2871. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)" /> method.
  2872. </summary>
  2873. </member>
  2874. <member name="F:System.Data.SQLite.SQLiteDataReaderValue.DateTimeValue">
  2875. <summary>
  2876. The value to be returned from the
  2877. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetDateTime(System.Int32)" /> method -OR- null to
  2878. indicate an error.
  2879. </summary>
  2880. </member>
  2881. <member name="F:System.Data.SQLite.SQLiteDataReaderValue.DecimalValue">
  2882. <summary>
  2883. The value to be returned from the
  2884. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetDecimal(System.Int32)" /> method -OR- null to
  2885. indicate an error.
  2886. </summary>
  2887. </member>
  2888. <member name="F:System.Data.SQLite.SQLiteDataReaderValue.DoubleValue">
  2889. <summary>
  2890. The value to be returned from the
  2891. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetDouble(System.Int32)" /> method -OR- null to
  2892. indicate an error.
  2893. </summary>
  2894. </member>
  2895. <member name="F:System.Data.SQLite.SQLiteDataReaderValue.FloatValue">
  2896. <summary>
  2897. The value to be returned from the
  2898. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetFloat(System.Int32)" /> method -OR- null to
  2899. indicate an error.
  2900. </summary>
  2901. </member>
  2902. <member name="F:System.Data.SQLite.SQLiteDataReaderValue.GuidValue">
  2903. <summary>
  2904. The value to be returned from the
  2905. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetGuid(System.Int32)" /> method -OR- null to
  2906. indicate an error.
  2907. </summary>
  2908. </member>
  2909. <member name="F:System.Data.SQLite.SQLiteDataReaderValue.Int16Value">
  2910. <summary>
  2911. The value to be returned from the
  2912. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetInt16(System.Int32)" /> method -OR- null to
  2913. indicate an error.
  2914. </summary>
  2915. </member>
  2916. <member name="F:System.Data.SQLite.SQLiteDataReaderValue.Int32Value">
  2917. <summary>
  2918. The value to be returned from the
  2919. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetInt32(System.Int32)" /> method -OR- null to
  2920. indicate an error.
  2921. </summary>
  2922. </member>
  2923. <member name="F:System.Data.SQLite.SQLiteDataReaderValue.Int64Value">
  2924. <summary>
  2925. The value to be returned from the
  2926. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetInt64(System.Int32)" /> method -OR- null to
  2927. indicate an error.
  2928. </summary>
  2929. </member>
  2930. <member name="F:System.Data.SQLite.SQLiteDataReaderValue.StringValue">
  2931. <summary>
  2932. The value to be returned from the
  2933. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetString(System.Int32)" /> method.
  2934. </summary>
  2935. </member>
  2936. <member name="F:System.Data.SQLite.SQLiteDataReaderValue.Value">
  2937. <summary>
  2938. The value to be returned from the
  2939. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetValue(System.Int32)" /> method.
  2940. </summary>
  2941. </member>
  2942. <member name="T:System.Data.SQLite.SQLiteReadEventArgs">
  2943. <summary>
  2944. This class represents the parameters that are provided
  2945. to the <see cref="T:System.Data.SQLite.SQLiteDataReader" /> methods, with
  2946. the exception of the column index (provided separately).
  2947. </summary>
  2948. </member>
  2949. <member name="T:System.Data.SQLite.SQLiteReadBlobEventArgs">
  2950. <summary>
  2951. This class represents the parameters that are provided to
  2952. the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBlob(System.Int32,System.Boolean)" /> method, with
  2953. the exception of the column index (provided separately).
  2954. </summary>
  2955. </member>
  2956. <member name="F:System.Data.SQLite.SQLiteReadBlobEventArgs.readOnly">
  2957. <summary>
  2958. Provides the underlying storage for the
  2959. <see cref="P:System.Data.SQLite.SQLiteReadBlobEventArgs.ReadOnly" /> property.
  2960. </summary>
  2961. </member>
  2962. <member name="M:System.Data.SQLite.SQLiteReadBlobEventArgs.#ctor(System.Boolean)">
  2963. <summary>
  2964. Constructs an instance of this class to pass into a user-defined
  2965. callback associated with the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBlob(System.Int32,System.Boolean)" />
  2966. method.
  2967. </summary>
  2968. <param name="readOnly">
  2969. The value that was originally specified for the "readOnly"
  2970. parameter to the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBlob(System.Int32,System.Boolean)" /> method.
  2971. </param>
  2972. </member>
  2973. <member name="P:System.Data.SQLite.SQLiteReadBlobEventArgs.ReadOnly">
  2974. <summary>
  2975. The value that was originally specified for the "readOnly"
  2976. parameter to the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBlob(System.Int32,System.Boolean)" /> method.
  2977. </summary>
  2978. </member>
  2979. <member name="T:System.Data.SQLite.SQLiteReadArrayEventArgs">
  2980. <summary>
  2981. This class represents the parameters that are provided
  2982. to the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)" /> and
  2983. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)" /> methods, with
  2984. the exception of the column index (provided separately).
  2985. </summary>
  2986. </member>
  2987. <member name="F:System.Data.SQLite.SQLiteReadArrayEventArgs.dataOffset">
  2988. <summary>
  2989. Provides the underlying storage for the
  2990. <see cref="P:System.Data.SQLite.SQLiteReadArrayEventArgs.DataOffset" /> property.
  2991. </summary>
  2992. </member>
  2993. <member name="F:System.Data.SQLite.SQLiteReadArrayEventArgs.byteBuffer">
  2994. <summary>
  2995. Provides the underlying storage for the
  2996. <see cref="P:System.Data.SQLite.SQLiteReadArrayEventArgs.ByteBuffer" /> property.
  2997. </summary>
  2998. </member>
  2999. <member name="F:System.Data.SQLite.SQLiteReadArrayEventArgs.charBuffer">
  3000. <summary>
  3001. Provides the underlying storage for the
  3002. <see cref="P:System.Data.SQLite.SQLiteReadArrayEventArgs.CharBuffer" /> property.
  3003. </summary>
  3004. </member>
  3005. <member name="F:System.Data.SQLite.SQLiteReadArrayEventArgs.bufferOffset">
  3006. <summary>
  3007. Provides the underlying storage for the
  3008. <see cref="P:System.Data.SQLite.SQLiteReadArrayEventArgs.BufferOffset" /> property.
  3009. </summary>
  3010. </member>
  3011. <member name="F:System.Data.SQLite.SQLiteReadArrayEventArgs.length">
  3012. <summary>
  3013. Provides the underlying storage for the
  3014. <see cref="P:System.Data.SQLite.SQLiteReadArrayEventArgs.Length" /> property.
  3015. </summary>
  3016. </member>
  3017. <member name="M:System.Data.SQLite.SQLiteReadArrayEventArgs.#ctor(System.Int64,System.Byte[],System.Int32,System.Int32)">
  3018. <summary>
  3019. Constructs an instance of this class to pass into a user-defined
  3020. callback associated with the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)" />
  3021. method.
  3022. </summary>
  3023. <param name="dataOffset">
  3024. The value that was originally specified for the "dataOffset"
  3025. parameter to the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)" /> or
  3026. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)" /> methods.
  3027. </param>
  3028. <param name="byteBuffer">
  3029. The value that was originally specified for the "buffer"
  3030. parameter to the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)" />
  3031. method.
  3032. </param>
  3033. <param name="bufferOffset">
  3034. The value that was originally specified for the "bufferOffset"
  3035. parameter to the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)" /> or
  3036. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)" /> methods.
  3037. </param>
  3038. <param name="length">
  3039. The value that was originally specified for the "length"
  3040. parameter to the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)" /> or
  3041. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)" /> methods.
  3042. </param>
  3043. </member>
  3044. <member name="M:System.Data.SQLite.SQLiteReadArrayEventArgs.#ctor(System.Int64,System.Char[],System.Int32,System.Int32)">
  3045. <summary>
  3046. Constructs an instance of this class to pass into a user-defined
  3047. callback associated with the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)" />
  3048. method.
  3049. </summary>
  3050. <param name="dataOffset">
  3051. The value that was originally specified for the "dataOffset"
  3052. parameter to the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)" /> or
  3053. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)" /> methods.
  3054. </param>
  3055. <param name="charBuffer">
  3056. The value that was originally specified for the "buffer"
  3057. parameter to the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)" />
  3058. method.
  3059. </param>
  3060. <param name="bufferOffset">
  3061. The value that was originally specified for the "bufferOffset"
  3062. parameter to the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)" /> or
  3063. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)" /> methods.
  3064. </param>
  3065. <param name="length">
  3066. The value that was originally specified for the "length"
  3067. parameter to the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)" /> or
  3068. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)" /> methods.
  3069. </param>
  3070. </member>
  3071. <member name="P:System.Data.SQLite.SQLiteReadArrayEventArgs.DataOffset">
  3072. <summary>
  3073. The value that was originally specified for the "dataOffset"
  3074. parameter to the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)" /> or
  3075. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)" /> methods.
  3076. </summary>
  3077. </member>
  3078. <member name="P:System.Data.SQLite.SQLiteReadArrayEventArgs.ByteBuffer">
  3079. <summary>
  3080. The value that was originally specified for the "buffer"
  3081. parameter to the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)" />
  3082. method.
  3083. </summary>
  3084. </member>
  3085. <member name="P:System.Data.SQLite.SQLiteReadArrayEventArgs.CharBuffer">
  3086. <summary>
  3087. The value that was originally specified for the "buffer"
  3088. parameter to the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)" />
  3089. method.
  3090. </summary>
  3091. </member>
  3092. <member name="P:System.Data.SQLite.SQLiteReadArrayEventArgs.BufferOffset">
  3093. <summary>
  3094. The value that was originally specified for the "bufferOffset"
  3095. parameter to the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)" /> or
  3096. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)" /> methods.
  3097. </summary>
  3098. </member>
  3099. <member name="P:System.Data.SQLite.SQLiteReadArrayEventArgs.Length">
  3100. <summary>
  3101. The value that was originally specified for the "length"
  3102. parameter to the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)" /> or
  3103. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)" /> methods.
  3104. </summary>
  3105. </member>
  3106. <member name="T:System.Data.SQLite.SQLiteReadValueEventArgs">
  3107. <summary>
  3108. This class represents the parameters and return values for the
  3109. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBlob(System.Int32,System.Boolean)" />,
  3110. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBoolean(System.Int32)" />,
  3111. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetByte(System.Int32)" />,
  3112. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)" />,
  3113. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChar(System.Int32)" />,
  3114. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)" />,
  3115. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetDateTime(System.Int32)" />,
  3116. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetDecimal(System.Int32)" />,
  3117. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetDouble(System.Int32)" />,
  3118. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetFloat(System.Int32)" />,
  3119. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetGuid(System.Int32)" />,
  3120. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetInt16(System.Int32)" />,
  3121. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetInt32(System.Int32)" />,
  3122. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetInt64(System.Int32)" />,
  3123. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetString(System.Int32)" />, and
  3124. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetValue(System.Int32)" /> methods.
  3125. </summary>
  3126. </member>
  3127. <member name="F:System.Data.SQLite.SQLiteReadValueEventArgs.methodName">
  3128. <summary>
  3129. Provides the underlying storage for the
  3130. <see cref="P:System.Data.SQLite.SQLiteReadValueEventArgs.MethodName" /> property.
  3131. </summary>
  3132. </member>
  3133. <member name="F:System.Data.SQLite.SQLiteReadValueEventArgs.extraEventArgs">
  3134. <summary>
  3135. Provides the underlying storage for the
  3136. <see cref="P:System.Data.SQLite.SQLiteReadValueEventArgs.ExtraEventArgs" /> property.
  3137. </summary>
  3138. </member>
  3139. <member name="F:System.Data.SQLite.SQLiteReadValueEventArgs.value">
  3140. <summary>
  3141. Provides the underlying storage for the
  3142. <see cref="P:System.Data.SQLite.SQLiteReadValueEventArgs.Value" /> property.
  3143. </summary>
  3144. </member>
  3145. <member name="M:System.Data.SQLite.SQLiteReadValueEventArgs.#ctor(System.String,System.Data.SQLite.SQLiteReadEventArgs,System.Data.SQLite.SQLiteDataReaderValue)">
  3146. <summary>
  3147. Constructs a new instance of this class. Depending on the method
  3148. being called, the <paramref name="extraEventArgs" /> and/or
  3149. <paramref name="value" /> parameters may be null.
  3150. </summary>
  3151. <param name="methodName">
  3152. The name of the <see cref="T:System.Data.SQLite.SQLiteDataReader" /> method that was
  3153. responsible for invoking this callback.
  3154. </param>
  3155. <param name="extraEventArgs">
  3156. If the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)" /> or
  3157. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)" /> method is being called,
  3158. this object will contain the array related parameters for that
  3159. method. If the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBlob(System.Int32,System.Boolean)" /> method is
  3160. being called, this object will contain the blob related parameters
  3161. for that method.
  3162. </param>
  3163. <param name="value">
  3164. This may be used by the callback to set the return value for the
  3165. called <see cref="T:System.Data.SQLite.SQLiteDataReader" /> method.
  3166. </param>
  3167. </member>
  3168. <member name="P:System.Data.SQLite.SQLiteReadValueEventArgs.MethodName">
  3169. <summary>
  3170. The name of the <see cref="T:System.Data.SQLite.SQLiteDataReader" /> method that was
  3171. responsible for invoking this callback.
  3172. </summary>
  3173. </member>
  3174. <member name="P:System.Data.SQLite.SQLiteReadValueEventArgs.ExtraEventArgs">
  3175. <summary>
  3176. If the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)" /> or
  3177. <see cref="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)" /> method is being called,
  3178. this object will contain the array related parameters for that
  3179. method. If the <see cref="M:System.Data.SQLite.SQLiteDataReader.GetBlob(System.Int32,System.Boolean)" /> method is
  3180. being called, this object will contain the blob related parameters
  3181. for that method.
  3182. </summary>
  3183. </member>
  3184. <member name="P:System.Data.SQLite.SQLiteReadValueEventArgs.Value">
  3185. <summary>
  3186. This may be used by the callback to set the return value for the
  3187. called <see cref="T:System.Data.SQLite.SQLiteDataReader" /> method.
  3188. </summary>
  3189. </member>
  3190. <member name="T:System.Data.SQLite.SQLiteBindValueCallback">
  3191. <summary>
  3192. This represents a method that will be called in response to a request to
  3193. bind a parameter to a command. If an exception is thrown, it will cause
  3194. the parameter binding operation to fail -AND- it will continue to unwind
  3195. the call stack.
  3196. </summary>
  3197. <param name="convert">
  3198. The <see cref="T:System.Data.SQLite.SQLiteConvert" /> instance in use.
  3199. </param>
  3200. <param name="command">
  3201. The <see cref="T:System.Data.SQLite.SQLiteCommand" /> instance in use.
  3202. </param>
  3203. <param name="flags">
  3204. The flags associated with the <see cref="T:System.Data.SQLite.SQLiteConnection" /> instance
  3205. in use.
  3206. </param>
  3207. <param name="parameter">
  3208. The <see cref="T:System.Data.SQLite.SQLiteParameter" /> instance being bound to the command.
  3209. </param>
  3210. <param name="typeName">
  3211. The database type name associated with this callback.
  3212. </param>
  3213. <param name="index">
  3214. The ordinal of the parameter being bound to the command.
  3215. </param>
  3216. <param name="userData">
  3217. The data originally used when registering this callback.
  3218. </param>
  3219. <param name="complete">
  3220. Non-zero if the default handling for the parameter binding call should
  3221. be skipped (i.e. the parameter should not be bound at all). Great care
  3222. should be used when setting this to non-zero.
  3223. </param>
  3224. </member>
  3225. <member name="T:System.Data.SQLite.SQLiteReadValueCallback">
  3226. <summary>
  3227. This represents a method that will be called in response to a request
  3228. to read a value from a data reader. If an exception is thrown, it will
  3229. cause the data reader operation to fail -AND- it will continue to unwind
  3230. the call stack.
  3231. </summary>
  3232. <param name="convert">
  3233. The <see cref="T:System.Data.SQLite.SQLiteConvert" /> instance in use.
  3234. </param>
  3235. <param name="dataReader">
  3236. The <see cref="T:System.Data.SQLite.SQLiteDataReader" /> instance in use.
  3237. </param>
  3238. <param name="flags">
  3239. The flags associated with the <see cref="T:System.Data.SQLite.SQLiteConnection" /> instance
  3240. in use.
  3241. </param>
  3242. <param name="eventArgs">
  3243. The parameter and return type data for the column being read from the
  3244. data reader.
  3245. </param>
  3246. <param name="typeName">
  3247. The database type name associated with this callback.
  3248. </param>
  3249. <param name="index">
  3250. The zero based index of the column being read from the data reader.
  3251. </param>
  3252. <param name="userData">
  3253. The data originally used when registering this callback.
  3254. </param>
  3255. <param name="complete">
  3256. Non-zero if the default handling for the data reader call should be
  3257. skipped. If this is set to non-zero and the necessary return value
  3258. is unavailable or unsuitable, an exception will be thrown.
  3259. </param>
  3260. </member>
  3261. <member name="T:System.Data.SQLite.SQLiteTypeCallbacks">
  3262. <summary>
  3263. This class represents the custom data type handling callbacks
  3264. for a single type name.
  3265. </summary>
  3266. </member>
  3267. <member name="F:System.Data.SQLite.SQLiteTypeCallbacks.typeName">
  3268. <summary>
  3269. Provides the underlying storage for the
  3270. <see cref="P:System.Data.SQLite.SQLiteTypeCallbacks.TypeName" /> property.
  3271. </summary>
  3272. </member>
  3273. <member name="F:System.Data.SQLite.SQLiteTypeCallbacks.bindValueCallback">
  3274. <summary>
  3275. Provides the underlying storage for the
  3276. <see cref="P:System.Data.SQLite.SQLiteTypeCallbacks.BindValueCallback" /> property.
  3277. </summary>
  3278. </member>
  3279. <member name="F:System.Data.SQLite.SQLiteTypeCallbacks.readValueCallback">
  3280. <summary>
  3281. Provides the underlying storage for the
  3282. <see cref="P:System.Data.SQLite.SQLiteTypeCallbacks.ReadValueCallback" /> property.
  3283. </summary>
  3284. </member>
  3285. <member name="F:System.Data.SQLite.SQLiteTypeCallbacks.bindValueUserData">
  3286. <summary>
  3287. Provides the underlying storage for the
  3288. <see cref="P:System.Data.SQLite.SQLiteTypeCallbacks.BindValueUserData" /> property.
  3289. </summary>
  3290. </member>
  3291. <member name="F:System.Data.SQLite.SQLiteTypeCallbacks.readValueUserData">
  3292. <summary>
  3293. Provides the underlying storage for the
  3294. <see cref="P:System.Data.SQLite.SQLiteTypeCallbacks.ReadValueUserData" /> property.
  3295. </summary>
  3296. </member>
  3297. <member name="M:System.Data.SQLite.SQLiteTypeCallbacks.#ctor(System.Data.SQLite.SQLiteBindValueCallback,System.Data.SQLite.SQLiteReadValueCallback,System.Object,System.Object)">
  3298. <summary>
  3299. Constructs an instance of this class.
  3300. </summary>
  3301. <param name="bindValueCallback">
  3302. The custom paramater binding callback. This parameter may be null.
  3303. </param>
  3304. <param name="readValueCallback">
  3305. The custom data reader value callback. This parameter may be null.
  3306. </param>
  3307. <param name="bindValueUserData">
  3308. The extra data to pass into the parameter binding callback. This
  3309. parameter may be null.
  3310. </param>
  3311. <param name="readValueUserData">
  3312. The extra data to pass into the data reader value callback. This
  3313. parameter may be null.
  3314. </param>
  3315. </member>
  3316. <member name="M:System.Data.SQLite.SQLiteTypeCallbacks.Create(System.Data.SQLite.SQLiteBindValueCallback,System.Data.SQLite.SQLiteReadValueCallback,System.Object,System.Object)">
  3317. <summary>
  3318. Creates an instance of the <see cref="T:System.Data.SQLite.SQLiteTypeCallbacks" /> class.
  3319. </summary>
  3320. <param name="bindValueCallback">
  3321. The custom paramater binding callback. This parameter may be null.
  3322. </param>
  3323. <param name="readValueCallback">
  3324. The custom data reader value callback. This parameter may be null.
  3325. </param>
  3326. <param name="bindValueUserData">
  3327. The extra data to pass into the parameter binding callback. This
  3328. parameter may be null.
  3329. </param>
  3330. <param name="readValueUserData">
  3331. The extra data to pass into the data reader value callback. This
  3332. parameter may be null.
  3333. </param>
  3334. </member>
  3335. <member name="P:System.Data.SQLite.SQLiteTypeCallbacks.TypeName">
  3336. <summary>
  3337. The database type name that the callbacks contained in this class
  3338. will apply to. This value may not be null.
  3339. </summary>
  3340. </member>
  3341. <member name="P:System.Data.SQLite.SQLiteTypeCallbacks.BindValueCallback">
  3342. <summary>
  3343. The custom paramater binding callback. This value may be null.
  3344. </summary>
  3345. </member>
  3346. <member name="P:System.Data.SQLite.SQLiteTypeCallbacks.ReadValueCallback">
  3347. <summary>
  3348. The custom data reader value callback. This value may be null.
  3349. </summary>
  3350. </member>
  3351. <member name="P:System.Data.SQLite.SQLiteTypeCallbacks.BindValueUserData">
  3352. <summary>
  3353. The extra data to pass into the parameter binding callback. This
  3354. value may be null.
  3355. </summary>
  3356. </member>
  3357. <member name="P:System.Data.SQLite.SQLiteTypeCallbacks.ReadValueUserData">
  3358. <summary>
  3359. The extra data to pass into the data reader value callback. This
  3360. value may be null.
  3361. </summary>
  3362. </member>
  3363. <member name="T:System.Data.SQLite.SQLiteTypeCallbacksMap">
  3364. <summary>
  3365. This class represents the mappings between database type names
  3366. and their associated custom data type handling callbacks.
  3367. </summary>
  3368. </member>
  3369. <member name="M:System.Data.SQLite.SQLiteTypeCallbacksMap.#ctor">
  3370. <summary>
  3371. Constructs an (empty) instance of this class.
  3372. </summary>
  3373. </member>
  3374. <member name="T:System.Data.SQLite.ConnectionEventArgs">
  3375. <summary>
  3376. Event data for connection event handlers.
  3377. </summary>
  3378. </member>
  3379. <member name="F:System.Data.SQLite.ConnectionEventArgs.EventType">
  3380. <summary>
  3381. The type of event being raised.
  3382. </summary>
  3383. </member>
  3384. <member name="F:System.Data.SQLite.ConnectionEventArgs.EventArgs">
  3385. <summary>
  3386. The <see cref="T:System.Data.StateChangeEventArgs" /> associated with this event, if any.
  3387. </summary>
  3388. </member>
  3389. <member name="F:System.Data.SQLite.ConnectionEventArgs.Transaction">
  3390. <summary>
  3391. The transaction associated with this event, if any.
  3392. </summary>
  3393. </member>
  3394. <member name="F:System.Data.SQLite.ConnectionEventArgs.Command">
  3395. <summary>
  3396. The command associated with this event, if any.
  3397. </summary>
  3398. </member>
  3399. <member name="F:System.Data.SQLite.ConnectionEventArgs.DataReader">
  3400. <summary>
  3401. The data reader associated with this event, if any.
  3402. </summary>
  3403. </member>
  3404. <member name="F:System.Data.SQLite.ConnectionEventArgs.CriticalHandle">
  3405. <summary>
  3406. The critical handle associated with this event, if any.
  3407. </summary>
  3408. </member>
  3409. <member name="F:System.Data.SQLite.ConnectionEventArgs.Text">
  3410. <summary>
  3411. Command or message text associated with this event, if any.
  3412. </summary>
  3413. </member>
  3414. <member name="F:System.Data.SQLite.ConnectionEventArgs.Data">
  3415. <summary>
  3416. Extra data associated with this event, if any.
  3417. </summary>
  3418. </member>
  3419. <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)">
  3420. <summary>
  3421. Constructs the object.
  3422. </summary>
  3423. <param name="eventType">The type of event being raised.</param>
  3424. <param name="eventArgs">The base <see cref="F:System.Data.SQLite.ConnectionEventArgs.EventArgs" /> associated
  3425. with this event, if any.</param>
  3426. <param name="transaction">The transaction associated with this event, if any.</param>
  3427. <param name="command">The command associated with this event, if any.</param>
  3428. <param name="dataReader">The data reader associated with this event, if any.</param>
  3429. <param name="criticalHandle">The critical handle associated with this event, if any.</param>
  3430. <param name="text">The command or message text, if any.</param>
  3431. <param name="data">The extra data, if any.</param>
  3432. </member>
  3433. <member name="T:System.Data.SQLite.SQLiteConnectionEventHandler">
  3434. <summary>
  3435. Raised when an event pertaining to a connection occurs.
  3436. </summary>
  3437. <param name="sender">The connection involved.</param>
  3438. <param name="e">Extra information about the event.</param>
  3439. </member>
  3440. <member name="T:System.Data.SQLite.SQLiteConnection">
  3441. <summary>
  3442. SQLite implentation of DbConnection.
  3443. </summary>
  3444. <remarks>
  3445. The <see cref="P:System.Data.SQLite.SQLiteConnection.ConnectionString" /> property can contain the following parameter(s), delimited with a semi-colon:
  3446. <list type="table">
  3447. <listheader>
  3448. <term>Parameter</term>
  3449. <term>Values</term>
  3450. <term>Required</term>
  3451. <term>Default</term>
  3452. </listheader>
  3453. <item>
  3454. <description>Data Source</description>
  3455. <description>
  3456. This may be a file name, the string ":memory:", or any supported URI (starting with SQLite 3.7.7).
  3457. Starting with release 1.0.86.0, in order to use more than one consecutive backslash (e.g. for a
  3458. UNC path), each of the adjoining backslash characters must be doubled (e.g. "\\Network\Share\test.db"
  3459. would become "\\\\Network\Share\test.db").
  3460. </description>
  3461. <description>Y</description>
  3462. <description></description>
  3463. </item>
  3464. <item>
  3465. <description>Uri</description>
  3466. <description>
  3467. If specified, this must be a file name that starts with "file://", "file:", or "/". Any leading
  3468. "file://" or "file:" prefix will be stripped off and the resulting file name will be used to open
  3469. the database.
  3470. </description>
  3471. <description>N</description>
  3472. <description>null</description>
  3473. </item>
  3474. <item>
  3475. <description>FullUri</description>
  3476. <description>
  3477. If specified, this must be a URI in a format recognized by the SQLite core library (starting with
  3478. SQLite 3.7.7). It will be passed verbatim to the SQLite core library.
  3479. </description>
  3480. <description>N</description>
  3481. <description>null</description>
  3482. </item>
  3483. <item>
  3484. <description>Version</description>
  3485. <description>3</description>
  3486. <description>N</description>
  3487. <description>3</description>
  3488. </item>
  3489. <item>
  3490. <description>UseUTF16Encoding</description>
  3491. <description>
  3492. <b>True</b> - The UTF-16 encoding should be used.
  3493. <br/>
  3494. <b>False</b> - The UTF-8 encoding should be used.
  3495. </description>
  3496. <description>N</description>
  3497. <description>False</description>
  3498. </item>
  3499. <item>
  3500. <description>DefaultDbType</description>
  3501. <description>
  3502. This is the default <see cref="T:System.Data.DbType" /> to use when one cannot be determined based on the
  3503. column metadata and the configured type mappings.
  3504. </description>
  3505. <description>N</description>
  3506. <description>null</description>
  3507. </item>
  3508. <item>
  3509. <description>DefaultTypeName</description>
  3510. <description>
  3511. This is the default type name to use when one cannot be determined based on the column metadata
  3512. and the configured type mappings.
  3513. </description>
  3514. <description>N</description>
  3515. <description>null</description>
  3516. </item>
  3517. <item>
  3518. <description>NoDefaultFlags</description>
  3519. <description>
  3520. <b>True</b> - Do not combine the specified (or existing) connection flags with the value of the
  3521. <see cref="P:System.Data.SQLite.SQLiteConnection.DefaultFlags" /> property.
  3522. <br/>
  3523. <b>False</b> - Combine the specified (or existing) connection flags with the value of the
  3524. <see cref="P:System.Data.SQLite.SQLiteConnection.DefaultFlags" /> property.
  3525. </description>
  3526. <description>N</description>
  3527. <description>False</description>
  3528. </item>
  3529. <item>
  3530. <description>NoSharedFlags</description>
  3531. <description>
  3532. <b>True</b> - Do not combine the specified (or existing) connection flags with the value of the
  3533. <see cref="P:System.Data.SQLite.SQLiteConnection.SharedFlags" /> property.
  3534. <br/>
  3535. <b>False</b> - Combine the specified (or existing) connection flags with the value of the
  3536. <see cref="P:System.Data.SQLite.SQLiteConnection.SharedFlags" /> property.
  3537. </description>
  3538. <description>N</description>
  3539. <description>False</description>
  3540. </item>
  3541. <item>
  3542. <description>VfsName</description>
  3543. <description>
  3544. The name of the VFS to use when opening the database connection.
  3545. If this is not specified, the default VFS will be used.
  3546. </description>
  3547. <description>N</description>
  3548. <description>null</description>
  3549. </item>
  3550. <item>
  3551. <description>ZipVfsVersion</description>
  3552. <description>
  3553. If non-null, this is the "version" of ZipVFS to use. This requires
  3554. the System.Data.SQLite interop assembly -AND- primary managed assembly
  3555. to be compiled with the INTEROP_INCLUDE_ZIPVFS option; otherwise, this
  3556. property does nothing. The valid values are "v2" and "v3". Using
  3557. anyother value will cause an exception to be thrown. Please see the
  3558. ZipVFS documentation for more information on how to use this parameter.
  3559. </description>
  3560. <description>N</description>
  3561. <description>null</description>
  3562. </item>
  3563. <item>
  3564. <description>DateTimeFormat</description>
  3565. <description>
  3566. <b>Ticks</b> - Use the value of DateTime.Ticks.<br/>
  3567. <b>ISO8601</b> - Use the ISO-8601 format. Uses the "yyyy-MM-dd HH:mm:ss.FFFFFFFK" format for UTC
  3568. DateTime values and "yyyy-MM-dd HH:mm:ss.FFFFFFF" format for local DateTime values).<br/>
  3569. <b>JulianDay</b> - The interval of time in days and fractions of a day since January 1, 4713 BC.<br/>
  3570. <b>UnixEpoch</b> - The whole number of seconds since the Unix epoch (January 1, 1970).<br/>
  3571. <b>InvariantCulture</b> - Any culture-independent string value that the .NET Framework can interpret as a valid DateTime.<br/>
  3572. <b>CurrentCulture</b> - Any string value that the .NET Framework can interpret as a valid DateTime using the current culture.</description>
  3573. <description>N</description>
  3574. <description>ISO8601</description>
  3575. </item>
  3576. <item>
  3577. <description>DateTimeKind</description>
  3578. <description>
  3579. <b>Unspecified</b> - Not specified as either UTC or local time.
  3580. <br/>
  3581. <b>Utc</b> - The time represented is UTC.
  3582. <br/>
  3583. <b>Local</b> - The time represented is local time.
  3584. </description>
  3585. <description>N</description>
  3586. <description>Unspecified</description>
  3587. </item>
  3588. <item>
  3589. <description>DateTimeFormatString</description>
  3590. <description>
  3591. The exact DateTime format string to use for all formatting and parsing of all DateTime
  3592. values for this connection.
  3593. </description>
  3594. <description>N</description>
  3595. <description>null</description>
  3596. </item>
  3597. <item>
  3598. <description>BaseSchemaName</description>
  3599. <description>
  3600. Some base data classes in the framework (e.g. those that build SQL queries dynamically)
  3601. assume that an ADO.NET provider cannot support an alternate catalog (i.e. database) without supporting
  3602. alternate schemas as well; however, SQLite does not fit into this model. Therefore, this value is used
  3603. as a placeholder and removed prior to preparing any SQL statements that may contain it.
  3604. </description>
  3605. <description>N</description>
  3606. <description>sqlite_default_schema</description>
  3607. </item>
  3608. <item>
  3609. <description>BinaryGUID</description>
  3610. <description>
  3611. <b>True</b> - Store GUID columns in binary form
  3612. <br/>
  3613. <b>False</b> - Store GUID columns as text
  3614. </description>
  3615. <description>N</description>
  3616. <description>True</description>
  3617. </item>
  3618. <item>
  3619. <description>Cache Size</description>
  3620. <description>
  3621. If the argument N is positive then the suggested cache size is set to N.
  3622. If the argument N is negative, then the number of cache pages is adjusted
  3623. to use approximately abs(N*4096) bytes of memory. Backwards compatibility
  3624. note: The behavior of cache_size with a negative N was different in SQLite
  3625. versions prior to 3.7.10. In version 3.7.9 and earlier, the number of
  3626. pages in the cache was set to the absolute value of N.
  3627. </description>
  3628. <description>N</description>
  3629. <description>-2000</description>
  3630. </item>
  3631. <item>
  3632. <description>Synchronous</description>
  3633. <description>
  3634. <b>Normal</b> - Normal file flushing behavior
  3635. <br/>
  3636. <b>Full</b> - Full flushing after all writes
  3637. <br/>
  3638. <b>Off</b> - Underlying OS flushes I/O's
  3639. </description>
  3640. <description>N</description>
  3641. <description>Full</description>
  3642. </item>
  3643. <item>
  3644. <description>Page Size</description>
  3645. <description>{size in bytes}</description>
  3646. <description>N</description>
  3647. <description>4096</description>
  3648. </item>
  3649. <item>
  3650. <description>Password</description>
  3651. <description>
  3652. {password} - Using this parameter requires that the legacy CryptoAPI based
  3653. codec (or the SQLite Encryption Extension) be enabled at compile-time for
  3654. both the native interop assembly and the core managed assemblies; otherwise,
  3655. using this parameter may result in an exception being thrown when attempting
  3656. to open the connection.
  3657. </description>
  3658. <description>N</description>
  3659. <description></description>
  3660. </item>
  3661. <item>
  3662. <description>HexPassword</description>
  3663. <description>
  3664. {hexPassword} - Must contain a sequence of zero or more hexadecimal encoded
  3665. byte values without a leading "0x" prefix. Using this parameter requires
  3666. that the legacy CryptoAPI based codec (or the SQLite Encryption Extension)
  3667. be enabled at compile-time for both the native interop assembly and the
  3668. core managed assemblies; otherwise, using this parameter may result in an
  3669. exception being thrown when attempting to open the connection.
  3670. </description>
  3671. <description>N</description>
  3672. <description></description>
  3673. </item>
  3674. <item>
  3675. <description>Enlist</description>
  3676. <description>
  3677. <b>Y</b> - Automatically enlist in distributed transactions
  3678. <br/>
  3679. <b>N</b> - No automatic enlistment
  3680. </description>
  3681. <description>N</description>
  3682. <description>Y</description>
  3683. </item>
  3684. <item>
  3685. <description>Pooling</description>
  3686. <description>
  3687. <b>True</b> - Use connection pooling.<br/>
  3688. <b>False</b> - Do not use connection pooling.<br/><br/>
  3689. <b>WARNING:</b> When using the default connection pool implementation,
  3690. setting this property to True should be avoided by applications that make
  3691. use of COM (either directly or indirectly) due to possible deadlocks that
  3692. can occur during the finalization of some COM objects.
  3693. </description>
  3694. <description>N</description>
  3695. <description>False</description>
  3696. </item>
  3697. <item>
  3698. <description>FailIfMissing</description>
  3699. <description>
  3700. <b>True</b> - Don't create the database if it does not exist, throw an error instead
  3701. <br/>
  3702. <b>False</b> - Automatically create the database if it does not exist
  3703. </description>
  3704. <description>N</description>
  3705. <description>False</description>
  3706. </item>
  3707. <item>
  3708. <description>Max Page Count</description>
  3709. <description>{size in pages} - Limits the maximum number of pages (limits the size) of the database</description>
  3710. <description>N</description>
  3711. <description>0</description>
  3712. </item>
  3713. <item>
  3714. <description>Legacy Format</description>
  3715. <description>
  3716. <b>True</b> - Use the more compatible legacy 3.x database format
  3717. <br/>
  3718. <b>False</b> - Use the newer 3.3x database format which compresses numbers more effectively
  3719. </description>
  3720. <description>N</description>
  3721. <description>False</description>
  3722. </item>
  3723. <item>
  3724. <description>Default Timeout</description>
  3725. <description>{time in seconds}<br/>The default command timeout</description>
  3726. <description>N</description>
  3727. <description>30</description>
  3728. </item>
  3729. <item>
  3730. <description>BusyTimeout</description>
  3731. <description>{time in milliseconds}<br/>Sets the busy timeout for the core library.</description>
  3732. <description>N</description>
  3733. <description>0</description>
  3734. </item>
  3735. <item>
  3736. <description>WaitTimeout</description>
  3737. <description>{time in milliseconds}<br/>
  3738. <b>EXPERIMENTAL</b> -- The wait timeout to use with
  3739. <see cref="M:System.Data.SQLite.SQLiteConnection.WaitForEnlistmentReset(System.Int32,System.Nullable{System.Boolean})" /> method. This is only used when
  3740. waiting for the enlistment to be reset prior to enlisting in a transaction,
  3741. and then only when the appropriate connection flag is set.</description>
  3742. <description>N</description>
  3743. <description>30000</description>
  3744. </item>
  3745. <item>
  3746. <description>Journal Mode</description>
  3747. <description>
  3748. <b>Delete</b> - Delete the journal file after a commit.
  3749. <br/>
  3750. <b>Persist</b> - Zero out and leave the journal file on disk after a
  3751. commit.
  3752. <br/>
  3753. <b>Off</b> - Disable the rollback journal entirely. This saves disk I/O
  3754. but at the expense of database safety and integrity. If the application
  3755. using SQLite crashes in the middle of a transaction when this journaling
  3756. mode is set, then the database file will very likely go corrupt.
  3757. <br/>
  3758. <b>Truncate</b> - Truncate the journal file to zero-length instead of
  3759. deleting it.
  3760. <br/>
  3761. <b>Memory</b> - Store the journal in volatile RAM. This saves disk I/O
  3762. but at the expense of database safety and integrity. If the application
  3763. using SQLite crashes in the middle of a transaction when this journaling
  3764. mode is set, then the database file will very likely go corrupt.
  3765. <br/>
  3766. <b>Wal</b> - Use a write-ahead log instead of a rollback journal.
  3767. </description>
  3768. <description>N</description>
  3769. <description>Delete</description>
  3770. </item>
  3771. <item>
  3772. <description>Read Only</description>
  3773. <description>
  3774. <b>True</b> - Open the database for read only access
  3775. <br/>
  3776. <b>False</b> - Open the database for normal read/write access
  3777. </description>
  3778. <description>N</description>
  3779. <description>False</description>
  3780. </item>
  3781. <item>
  3782. <description>Max Pool Size</description>
  3783. <description>The maximum number of connections for the given connection string that can be in the connection pool</description>
  3784. <description>N</description>
  3785. <description>100</description>
  3786. </item>
  3787. <item>
  3788. <description>Default IsolationLevel</description>
  3789. <description>The default transaciton isolation level</description>
  3790. <description>N</description>
  3791. <description>Serializable</description>
  3792. </item>
  3793. <item>
  3794. <description>Foreign Keys</description>
  3795. <description>Enable foreign key constraints</description>
  3796. <description>N</description>
  3797. <description>False</description>
  3798. </item>
  3799. <item>
  3800. <description>Flags</description>
  3801. <description>Extra behavioral flags for the connection. See the <see cref="T:System.Data.SQLite.SQLiteConnectionFlags" /> enumeration for possible values.</description>
  3802. <description>N</description>
  3803. <description>Default</description>
  3804. </item>
  3805. <item>
  3806. <description>SetDefaults</description>
  3807. <description>
  3808. <b>True</b> - Apply the default connection settings to the opened database.<br/>
  3809. <b>False</b> - Skip applying the default connection settings to the opened database.
  3810. </description>
  3811. <description>N</description>
  3812. <description>True</description>
  3813. </item>
  3814. <item>
  3815. <description>ToFullPath</description>
  3816. <description>
  3817. <b>True</b> - Attempt to expand the data source file name to a fully qualified path before opening.
  3818. <br/>
  3819. <b>False</b> - Skip attempting to expand the data source file name to a fully qualified path before opening.
  3820. </description>
  3821. <description>N</description>
  3822. <description>True</description>
  3823. </item>
  3824. <item>
  3825. <description>PrepareRetries</description>
  3826. <description>
  3827. The maximum number of retries when preparing SQL to be executed. This
  3828. normally only applies to preparation errors resulting from the database
  3829. schema being changed.
  3830. </description>
  3831. <description>N</description>
  3832. <description>3</description>
  3833. </item>
  3834. <item>
  3835. <description>ProgressOps</description>
  3836. <description>
  3837. The approximate number of virtual machine instructions between progress
  3838. events. In order for progress events to actually fire, the event handler
  3839. must be added to the <see cref="E:System.Data.SQLite.SQLiteConnection.Progress" /> event as well.
  3840. </description>
  3841. <description>N</description>
  3842. <description>0</description>
  3843. </item>
  3844. <item>
  3845. <description>Recursive Triggers</description>
  3846. <description>
  3847. <b>True</b> - Enable the recursive trigger capability.
  3848. <b>False</b> - Disable the recursive trigger capability.
  3849. </description>
  3850. <description>N</description>
  3851. <description>False</description>
  3852. </item>
  3853. </list>
  3854. </remarks>
  3855. </member>
  3856. <member name="F:System.Data.SQLite.SQLiteConnection.BadDbType">
  3857. <summary>
  3858. The "invalid value" for the <see cref="T:System.Data.DbType" /> enumeration used
  3859. by the <see cref="P:System.Data.SQLite.SQLiteConnection.DefaultDbType" /> property. This constant is shared
  3860. by this class and the SQLiteConnectionStringBuilder class.
  3861. </summary>
  3862. </member>
  3863. <member name="F:System.Data.SQLite.SQLiteConnection.DefaultBaseSchemaName">
  3864. <summary>
  3865. The default "stub" (i.e. placeholder) base schema name to use when
  3866. returning column schema information. Used as the initial value of
  3867. the BaseSchemaName property. This should start with "sqlite_*"
  3868. because those names are reserved for use by SQLite (i.e. they cannot
  3869. be confused with the names of user objects).
  3870. </summary>
  3871. </member>
  3872. <member name="F:System.Data.SQLite.SQLiteConnection._assembly">
  3873. <summary>
  3874. The managed assembly containing this type.
  3875. </summary>
  3876. </member>
  3877. <member name="F:System.Data.SQLite.SQLiteConnection._syncRoot">
  3878. <summary>
  3879. Object used to synchronize access to the static instance data
  3880. for this class.
  3881. </summary>
  3882. </member>
  3883. <member name="E:System.Data.SQLite.SQLiteConnection._handlers">
  3884. <summary>
  3885. Static variable to store the connection event handlers to call.
  3886. </summary>
  3887. </member>
  3888. <member name="F:System.Data.SQLite.SQLiteConnection._sharedFlags">
  3889. <summary>
  3890. The extra connection flags to be used for all opened connections.
  3891. </summary>
  3892. </member>
  3893. <member name="F:System.Data.SQLite.SQLiteConnection._lastConnectionInOpen">
  3894. <summary>
  3895. The <see cref="T:System.Data.SQLite.SQLiteConnection" /> instance (for this thread) that
  3896. had the most recent call to <see cref="M:System.Data.SQLite.SQLiteConnection.Open" />.
  3897. </summary>
  3898. </member>
  3899. <member name="F:System.Data.SQLite.SQLiteConnection._connectionState">
  3900. <summary>
  3901. State of the current connection
  3902. </summary>
  3903. </member>
  3904. <member name="F:System.Data.SQLite.SQLiteConnection._connectionString">
  3905. <summary>
  3906. The connection string
  3907. </summary>
  3908. </member>
  3909. <member name="F:System.Data.SQLite.SQLiteConnection._transactionLevel">
  3910. <summary>
  3911. Nesting level of the transactions open on the connection
  3912. </summary>
  3913. </member>
  3914. <member name="F:System.Data.SQLite.SQLiteConnection._transactionSequence">
  3915. <summary>
  3916. Transaction counter for the connection. Currently, this is only used
  3917. to build SAVEPOINT names.
  3918. </summary>
  3919. </member>
  3920. <member name="F:System.Data.SQLite.SQLiteConnection._noDispose">
  3921. <summary>
  3922. If this flag is non-zero, the <see cref="M:System.Data.SQLite.SQLiteConnection.Dispose" /> method will have
  3923. no effect; however, the <see cref="M:System.Data.SQLite.SQLiteConnection.Close" /> method will continue to
  3924. behave as normal.
  3925. </summary>
  3926. </member>
  3927. <member name="F:System.Data.SQLite.SQLiteConnection._disposing">
  3928. <summary>
  3929. If set, then the connection is currently being disposed.
  3930. </summary>
  3931. </member>
  3932. <member name="F:System.Data.SQLite.SQLiteConnection._defaultIsolation">
  3933. <summary>
  3934. The default isolation level for new transactions
  3935. </summary>
  3936. </member>
  3937. <member name="F:System.Data.SQLite.SQLiteConnection._enlistmentSyncRoot">
  3938. <summary>
  3939. This object is used with lock statements to synchronize access to the
  3940. <see cref="F:System.Data.SQLite.SQLiteConnection._enlistment" /> field, below.
  3941. </summary>
  3942. </member>
  3943. <member name="F:System.Data.SQLite.SQLiteConnection._enlistment">
  3944. <summary>
  3945. Whether or not the connection is enlisted in a distrubuted transaction
  3946. </summary>
  3947. </member>
  3948. <member name="F:System.Data.SQLite.SQLiteConnection._typeNames">
  3949. <summary>
  3950. The per-connection mappings between type names and <see cref="T:System.Data.DbType" />
  3951. values. These mappings override the corresponding global mappings.
  3952. </summary>
  3953. </member>
  3954. <member name="F:System.Data.SQLite.SQLiteConnection._typeCallbacks">
  3955. <summary>
  3956. The per-connection mappings between type names and optional callbacks
  3957. for parameter binding and value reading.
  3958. </summary>
  3959. </member>
  3960. <member name="F:System.Data.SQLite.SQLiteConnection._sql">
  3961. <summary>
  3962. The base SQLite object to interop with
  3963. </summary>
  3964. </member>
  3965. <member name="F:System.Data.SQLite.SQLiteConnection._dataSource">
  3966. <summary>
  3967. The database filename minus path and extension
  3968. </summary>
  3969. </member>
  3970. <member name="F:System.Data.SQLite.SQLiteConnection._baseSchemaName">
  3971. <summary>
  3972. The "stub" (i.e. placeholder) base schema name to use when returning
  3973. column schema information.
  3974. </summary>
  3975. </member>
  3976. <member name="F:System.Data.SQLite.SQLiteConnection._flags">
  3977. <summary>
  3978. The extra behavioral flags for this connection, if any. See the
  3979. <see cref="T:System.Data.SQLite.SQLiteConnectionFlags" /> enumeration for a list of
  3980. possible values.
  3981. </summary>
  3982. </member>
  3983. <member name="F:System.Data.SQLite.SQLiteConnection._cachedSettings">
  3984. <summary>
  3985. The cached values for all settings that have been fetched on behalf
  3986. of this connection. This cache may be cleared by calling the
  3987. <see cref="M:System.Data.SQLite.SQLiteConnection.ClearCachedSettings" /> method.
  3988. </summary>
  3989. </member>
  3990. <member name="F:System.Data.SQLite.SQLiteConnection._defaultDbType">
  3991. <summary>
  3992. The default databse type for this connection. This value will only
  3993. be used if the <see cref="F:System.Data.SQLite.SQLiteConnectionFlags.UseConnectionTypes" />
  3994. flag is set.
  3995. </summary>
  3996. </member>
  3997. <member name="F:System.Data.SQLite.SQLiteConnection._defaultTypeName">
  3998. <summary>
  3999. The default databse type name for this connection. This value will only
  4000. be used if the <see cref="F:System.Data.SQLite.SQLiteConnectionFlags.UseConnectionTypes" />
  4001. flag is set.
  4002. </summary>
  4003. </member>
  4004. <member name="F:System.Data.SQLite.SQLiteConnection._vfsName">
  4005. <summary>
  4006. The name of the VFS to be used when opening the database connection.
  4007. </summary>
  4008. </member>
  4009. <member name="F:System.Data.SQLite.SQLiteConnection._defaultTimeout">
  4010. <summary>
  4011. Default command timeout
  4012. </summary>
  4013. </member>
  4014. <member name="F:System.Data.SQLite.SQLiteConnection._busyTimeout">
  4015. <summary>
  4016. The default busy timeout to use with the SQLite core library. This is
  4017. only used when opening a connection.
  4018. </summary>
  4019. </member>
  4020. <member name="F:System.Data.SQLite.SQLiteConnection._waitTimeout">
  4021. <summary>
  4022. The default wait timeout to use with <see cref="M:System.Data.SQLite.SQLiteConnection.WaitForEnlistmentReset(System.Int32,System.Nullable{System.Boolean})" />
  4023. method. This is only used when waiting for the enlistment to be reset
  4024. prior to enlisting in a transaction, and then only when the appropriate
  4025. connection flag is set.
  4026. </summary>
  4027. </member>
  4028. <member name="F:System.Data.SQLite.SQLiteConnection._prepareRetries">
  4029. <summary>
  4030. The maximum number of retries when preparing SQL to be executed. This
  4031. normally only applies to preparation errors resulting from the database
  4032. schema being changed.
  4033. </summary>
  4034. </member>
  4035. <member name="F:System.Data.SQLite.SQLiteConnection._progressOps">
  4036. <summary>
  4037. The approximate number of virtual machine instructions between progress
  4038. events. In order for progress events to actually fire, the event handler
  4039. must be added to the <see cref="E:System.Data.SQLite.SQLiteConnection.Progress" /> event as
  4040. well. This value will only be used when opening the database.
  4041. </summary>
  4042. </member>
  4043. <member name="F:System.Data.SQLite.SQLiteConnection._parseViaFramework">
  4044. <summary>
  4045. Non-zero if the built-in (i.e. framework provided) connection string
  4046. parser should be used when opening the connection.
  4047. </summary>
  4048. </member>
  4049. <member name="E:System.Data.SQLite.SQLiteConnection.StateChange">
  4050. <summary>
  4051. This event is raised whenever the database is opened or closed.
  4052. </summary>
  4053. </member>
  4054. <member name="M:System.Data.SQLite.SQLiteConnection.#ctor">
  4055. <overloads>
  4056. Constructs a new SQLiteConnection object
  4057. </overloads>
  4058. <summary>
  4059. Default constructor
  4060. </summary>
  4061. </member>
  4062. <member name="M:System.Data.SQLite.SQLiteConnection.#ctor(System.String)">
  4063. <summary>
  4064. Initializes the connection with the specified connection string.
  4065. </summary>
  4066. <param name="connectionString">The connection string to use.</param>
  4067. </member>
  4068. <member name="M:System.Data.SQLite.SQLiteConnection.#ctor(System.IntPtr,System.String,System.Boolean)">
  4069. <summary>
  4070. Initializes the connection with a pre-existing native connection handle.
  4071. This constructor overload is intended to be used only by the private
  4072. <see cref="M:System.Data.SQLite.SQLiteModule.CreateOrConnect(System.Boolean,System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> method.
  4073. </summary>
  4074. <param name="db">
  4075. The native connection handle to use.
  4076. </param>
  4077. <param name="fileName">
  4078. The file name corresponding to the native connection handle.
  4079. </param>
  4080. <param name="ownHandle">
  4081. Non-zero if this instance owns the native connection handle and
  4082. should dispose of it when it is no longer needed.
  4083. </param>
  4084. </member>
  4085. <member name="M:System.Data.SQLite.SQLiteConnection.#ctor(System.String,System.Boolean)">
  4086. <summary>
  4087. Initializes the connection with the specified connection string.
  4088. </summary>
  4089. <param name="connectionString">
  4090. The connection string to use.
  4091. </param>
  4092. <param name="parseViaFramework">
  4093. Non-zero to parse the connection string using the built-in (i.e.
  4094. framework provided) parser when opening the connection.
  4095. </param>
  4096. </member>
  4097. <member name="M:System.Data.SQLite.SQLiteConnection.#ctor(System.Data.SQLite.SQLiteConnection)">
  4098. <summary>
  4099. Clones the settings and connection string from an existing connection. If the existing connection is already open, this
  4100. function will open its own connection, enumerate any attached databases of the original connection, and automatically
  4101. attach to them.
  4102. </summary>
  4103. <param name="connection">The connection to copy the settings from.</param>
  4104. </member>
  4105. <member name="M:System.Data.SQLite.SQLiteConnection.GetNativeHandle(System.Data.SQLite.SQLiteConnection)">
  4106. <summary>
  4107. Attempts to lookup the native handle associated with the connection. An exception will
  4108. be thrown if this cannot be accomplished.
  4109. </summary>
  4110. <param name="connection">
  4111. The connection associated with the desired native handle.
  4112. </param>
  4113. <returns>
  4114. The native handle associated with the connection or <see cref="F:System.IntPtr.Zero" /> if it
  4115. cannot be determined.
  4116. </returns>
  4117. </member>
  4118. <member name="M:System.Data.SQLite.SQLiteConnection.OnChanged(System.Data.SQLite.SQLiteConnection,System.Data.SQLite.ConnectionEventArgs)">
  4119. <summary>
  4120. Raises the <see cref="E:System.Data.SQLite.SQLiteConnection.Changed" /> event.
  4121. </summary>
  4122. <param name="connection">
  4123. The connection associated with this event. If this parameter is not
  4124. null and the specified connection cannot raise events, then the
  4125. registered event handlers will not be invoked.
  4126. </param>
  4127. <param name="e">
  4128. A <see cref="T:System.Data.SQLite.ConnectionEventArgs" /> that contains the event data.
  4129. </param>
  4130. </member>
  4131. <member name="E:System.Data.SQLite.SQLiteConnection.Changed">
  4132. <summary>
  4133. This event is raised when events related to the lifecycle of a
  4134. SQLiteConnection object occur.
  4135. </summary>
  4136. </member>
  4137. <member name="P:System.Data.SQLite.SQLiteConnection.ConnectionPool">
  4138. <summary>
  4139. This property is used to obtain or set the custom connection pool
  4140. implementation to use, if any. Setting this property to null will
  4141. cause the default connection pool implementation to be used.
  4142. </summary>
  4143. </member>
  4144. <member name="M:System.Data.SQLite.SQLiteConnection.CreateHandle(System.IntPtr)">
  4145. <summary>
  4146. Creates and returns a new managed database connection handle. This
  4147. method is intended to be used by implementations of the
  4148. <see cref="T:System.Data.SQLite.ISQLiteConnectionPool" /> interface only. In theory, it
  4149. could be used by other classes; however, that usage is not supported.
  4150. </summary>
  4151. <param name="nativeHandle">
  4152. This must be a native database connection handle returned by the
  4153. SQLite core library and it must remain valid and open during the
  4154. entire duration of the calling method.
  4155. </param>
  4156. <returns>
  4157. The new managed database connection handle or null if it cannot be
  4158. created.
  4159. </returns>
  4160. </member>
  4161. <member name="M:System.Data.SQLite.SQLiteConnection.BackupDatabase(System.Data.SQLite.SQLiteConnection,System.String,System.String,System.Int32,System.Data.SQLite.SQLiteBackupCallback,System.Int32)">
  4162. <summary>
  4163. Backs up the database, using the specified database connection as the
  4164. destination.
  4165. </summary>
  4166. <param name="destination">The destination database connection.</param>
  4167. <param name="destinationName">The destination database name.</param>
  4168. <param name="sourceName">The source database name.</param>
  4169. <param name="pages">
  4170. The number of pages to copy at a time -OR- a negative value to copy all
  4171. pages. When a negative value is used, the <paramref name="callback" />
  4172. may never be invoked.
  4173. </param>
  4174. <param name="callback">
  4175. The method to invoke between each step of the backup process. This
  4176. parameter may be null (i.e. no callbacks will be performed). If the
  4177. callback returns false -OR- throws an exception, the backup is canceled.
  4178. </param>
  4179. <param name="retryMilliseconds">
  4180. The number of milliseconds to sleep after encountering a locking error
  4181. during the backup process. A value less than zero means that no sleep
  4182. should be performed.
  4183. </param>
  4184. </member>
  4185. <member name="M:System.Data.SQLite.SQLiteConnection.ClearCachedSettings">
  4186. <summary>
  4187. Clears the per-connection cached settings.
  4188. </summary>
  4189. <returns>
  4190. The total number of per-connection settings cleared.
  4191. </returns>
  4192. </member>
  4193. <member name="M:System.Data.SQLite.SQLiteConnection.TryGetCachedSetting(System.String,System.Object,System.Object@)">
  4194. <summary>
  4195. Queries and returns the value of the specified setting, using the
  4196. cached setting names and values for this connection, when available.
  4197. </summary>
  4198. <param name="name">
  4199. The name of the setting.
  4200. </param>
  4201. <param name="default">
  4202. The value to be returned if the setting has not been set explicitly
  4203. or cannot be determined.
  4204. </param>
  4205. <param name="value">
  4206. The value of the cached setting is stored here if found; otherwise,
  4207. the value of <paramref name="default" /> is stored here.
  4208. </param>
  4209. <returns>
  4210. Non-zero if the cached setting was found; otherwise, zero.
  4211. </returns>
  4212. </member>
  4213. <member name="M:System.Data.SQLite.SQLiteConnection.SetCachedSetting(System.String,System.Object)">
  4214. <summary>
  4215. Adds or sets the cached setting specified by <paramref name="name" />
  4216. to the value specified by <paramref name="value" />.
  4217. </summary>
  4218. <param name="name">
  4219. The name of the cached setting to add or replace.
  4220. </param>
  4221. <param name="value">
  4222. The new value of the cached setting.
  4223. </param>
  4224. </member>
  4225. <member name="M:System.Data.SQLite.SQLiteConnection.ClearTypeMappings">
  4226. <summary>
  4227. Clears the per-connection type mappings.
  4228. </summary>
  4229. <returns>
  4230. The total number of per-connection type mappings cleared.
  4231. </returns>
  4232. </member>
  4233. <member name="M:System.Data.SQLite.SQLiteConnection.GetTypeMappings">
  4234. <summary>
  4235. Returns the per-connection type mappings.
  4236. </summary>
  4237. <returns>
  4238. The per-connection type mappings -OR- null if they are unavailable.
  4239. </returns>
  4240. </member>
  4241. <member name="M:System.Data.SQLite.SQLiteConnection.AddTypeMapping(System.String,System.Data.DbType,System.Boolean)">
  4242. <summary>
  4243. Adds a per-connection type mapping, possibly replacing one or more
  4244. that already exist.
  4245. </summary>
  4246. <param name="typeName">
  4247. The case-insensitive database type name (e.g. "MYDATE"). The value
  4248. of this parameter cannot be null. Using an empty string value (or
  4249. a string value consisting entirely of whitespace) for this parameter
  4250. is not recommended.
  4251. </param>
  4252. <param name="dataType">
  4253. The <see cref="T:System.Data.DbType" /> value that should be associated with the
  4254. specified type name.
  4255. </param>
  4256. <param name="primary">
  4257. Non-zero if this mapping should be considered to be the primary one
  4258. for the specified <see cref="T:System.Data.DbType" />.
  4259. </param>
  4260. <returns>
  4261. A negative value if nothing was done. Zero if no per-connection type
  4262. mappings were replaced (i.e. it was a pure add operation). More than
  4263. zero if some per-connection type mappings were replaced.
  4264. </returns>
  4265. </member>
  4266. <member name="M:System.Data.SQLite.SQLiteConnection.ClearTypeCallbacks">
  4267. <summary>
  4268. Clears the per-connection type callbacks.
  4269. </summary>
  4270. <returns>
  4271. The total number of per-connection type callbacks cleared.
  4272. </returns>
  4273. </member>
  4274. <member name="M:System.Data.SQLite.SQLiteConnection.TryGetTypeCallbacks(System.String,System.Data.SQLite.SQLiteTypeCallbacks@)">
  4275. <summary>
  4276. Attempts to get the per-connection type callbacks for the specified
  4277. database type name.
  4278. </summary>
  4279. <param name="typeName">
  4280. The database type name.
  4281. </param>
  4282. <param name="callbacks">
  4283. Upon success, this parameter will contain the object holding the
  4284. callbacks for the database type name. Upon failure, this parameter
  4285. will be null.
  4286. </param>
  4287. <returns>
  4288. Non-zero upon success; otherwise, zero.
  4289. </returns>
  4290. </member>
  4291. <member name="M:System.Data.SQLite.SQLiteConnection.SetTypeCallbacks(System.String,System.Data.SQLite.SQLiteTypeCallbacks)">
  4292. <summary>
  4293. Sets, resets, or clears the per-connection type callbacks for the
  4294. specified database type name.
  4295. </summary>
  4296. <param name="typeName">
  4297. The database type name.
  4298. </param>
  4299. <param name="callbacks">
  4300. The object holding the callbacks for the database type name. If
  4301. this parameter is null, any callbacks for the database type name
  4302. will be removed if they are present.
  4303. </param>
  4304. <returns>
  4305. Non-zero if callbacks were set or removed; otherwise, zero.
  4306. </returns>
  4307. </member>
  4308. <member name="M:System.Data.SQLite.SQLiteConnection.BindFunction(System.Data.SQLite.SQLiteFunctionAttribute,System.Data.SQLite.SQLiteFunction)">
  4309. <summary>
  4310. Attempts to bind the specified <see cref="T:System.Data.SQLite.SQLiteFunction" /> object
  4311. instance to this connection.
  4312. </summary>
  4313. <param name="functionAttribute">
  4314. The <see cref="T:System.Data.SQLite.SQLiteFunctionAttribute" /> object instance containing
  4315. the metadata for the function to be bound.
  4316. </param>
  4317. <param name="function">
  4318. The <see cref="T:System.Data.SQLite.SQLiteFunction" /> object instance that implements the
  4319. function to be bound.
  4320. </param>
  4321. </member>
  4322. <member name="M:System.Data.SQLite.SQLiteConnection.BindFunction(System.Data.SQLite.SQLiteFunctionAttribute,System.Delegate,System.Delegate)">
  4323. <summary>
  4324. Attempts to bind the specified <see cref="T:System.Data.SQLite.SQLiteFunction" /> object
  4325. instance to this connection.
  4326. </summary>
  4327. <param name="functionAttribute">
  4328. The <see cref="T:System.Data.SQLite.SQLiteFunctionAttribute" /> object instance containing
  4329. the metadata for the function to be bound.
  4330. </param>
  4331. <param name="callback1">
  4332. A <see cref="T:System.Delegate" /> object instance that helps implement the
  4333. function to be bound. For scalar functions, this corresponds to the
  4334. <see cref="T:System.Data.SQLite.SQLiteInvokeDelegate" /> type. For aggregate functions,
  4335. this corresponds to the <see cref="T:System.Data.SQLite.SQLiteStepDelegate" /> type. For
  4336. collation functions, this corresponds to the
  4337. <see cref="T:System.Data.SQLite.SQLiteCompareDelegate" /> type.
  4338. </param>
  4339. <param name="callback2">
  4340. A <see cref="T:System.Delegate" /> object instance that helps implement the
  4341. function to be bound. For aggregate functions, this corresponds to the
  4342. <see cref="T:System.Data.SQLite.SQLiteFinalDelegate" /> type. For other callback types, it
  4343. is not used and must be null.
  4344. </param>
  4345. </member>
  4346. <member name="M:System.Data.SQLite.SQLiteConnection.UnbindFunction(System.Data.SQLite.SQLiteFunctionAttribute)">
  4347. <summary>
  4348. Attempts to unbind the specified <see cref="T:System.Data.SQLite.SQLiteFunction" /> object
  4349. instance to this connection.
  4350. </summary>
  4351. <param name="functionAttribute">
  4352. The <see cref="T:System.Data.SQLite.SQLiteFunctionAttribute" /> object instance containing
  4353. the metadata for the function to be unbound.
  4354. </param>
  4355. <returns>Non-zero if the function was unbound.</returns>
  4356. </member>
  4357. <member name="M:System.Data.SQLite.SQLiteConnection.UnbindAllFunctions(System.Boolean)">
  4358. <summary>
  4359. This method unbinds all registered (known) functions -OR- all previously
  4360. bound user-defined functions from this connection.
  4361. </summary>
  4362. <param name="registered">
  4363. Non-zero to unbind all registered (known) functions -OR- zero to unbind
  4364. all functions currently bound to the connection.
  4365. </param>
  4366. <returns>
  4367. Non-zero if all the specified user-defined functions were unbound.
  4368. </returns>
  4369. </member>
  4370. <member name="M:System.Data.SQLite.SQLiteConnection.ParseConnectionString(System.String,System.Boolean,System.Boolean)">
  4371. <summary>
  4372. Parses a connection string into component parts using the custom
  4373. connection string parser. An exception may be thrown if the syntax
  4374. of the connection string is incorrect.
  4375. </summary>
  4376. <param name="connectionString">
  4377. The connection string to parse.
  4378. </param>
  4379. <param name="parseViaFramework">
  4380. Non-zero to parse the connection string using the algorithm provided
  4381. by the framework itself. This is not applicable when running on the
  4382. .NET Compact Framework.
  4383. </param>
  4384. <param name="allowNameOnly">
  4385. Non-zero if names are allowed without values.
  4386. </param>
  4387. <returns>
  4388. The list of key/value pairs corresponding to the parameters specified
  4389. within the connection string.
  4390. </returns>
  4391. </member>
  4392. <member name="M:System.Data.SQLite.SQLiteConnection.ParseConnectionString(System.Data.SQLite.SQLiteConnection,System.String,System.Boolean,System.Boolean)">
  4393. <summary>
  4394. Parses a connection string into component parts using the custom
  4395. connection string parser. An exception may be thrown if the syntax
  4396. of the connection string is incorrect.
  4397. </summary>
  4398. <param name="connection">
  4399. The connection that will be using the parsed connection string.
  4400. </param>
  4401. <param name="connectionString">
  4402. The connection string to parse.
  4403. </param>
  4404. <param name="parseViaFramework">
  4405. Non-zero to parse the connection string using the algorithm provided
  4406. by the framework itself. This is not applicable when running on the
  4407. .NET Compact Framework.
  4408. </param>
  4409. <param name="allowNameOnly">
  4410. Non-zero if names are allowed without values.
  4411. </param>
  4412. <returns>
  4413. The list of key/value pairs corresponding to the parameters specified
  4414. within the connection string.
  4415. </returns>
  4416. </member>
  4417. <member name="M:System.Data.SQLite.SQLiteConnection.Dispose">
  4418. <summary>
  4419. Disposes and finalizes the connection, if applicable.
  4420. </summary>
  4421. </member>
  4422. <member name="M:System.Data.SQLite.SQLiteConnection.Dispose(System.Boolean)">
  4423. <summary>
  4424. Cleans up resources (native and managed) associated with the current instance.
  4425. </summary>
  4426. <param name="disposing">
  4427. Zero when being disposed via garbage collection; otherwise, non-zero.
  4428. </param>
  4429. </member>
  4430. <member name="M:System.Data.SQLite.SQLiteConnection.Clone">
  4431. <summary>
  4432. Creates a clone of the connection. All attached databases and user-defined functions are cloned. If the existing connection is open, the cloned connection
  4433. will also be opened.
  4434. </summary>
  4435. <returns></returns>
  4436. </member>
  4437. <member name="M:System.Data.SQLite.SQLiteConnection.CreateFile(System.String)">
  4438. <summary>
  4439. Creates a database file. This just creates a zero-byte file which SQLite
  4440. will turn into a database when the file is opened properly.
  4441. </summary>
  4442. <param name="databaseFileName">The file to create</param>
  4443. </member>
  4444. <member name="M:System.Data.SQLite.SQLiteConnection.OnStateChange(System.Data.ConnectionState,System.Data.StateChangeEventArgs@)">
  4445. <summary>
  4446. Raises the state change event when the state of the connection changes
  4447. </summary>
  4448. <param name="newState">The new connection state. If this is different
  4449. from the previous state, the <see cref="E:System.Data.SQLite.SQLiteConnection.StateChange" /> event is
  4450. raised.</param>
  4451. <param name="eventArgs">The event data created for the raised event, if
  4452. it was actually raised.</param>
  4453. </member>
  4454. <member name="M:System.Data.SQLite.SQLiteConnection.GetFallbackDefaultIsolationLevel">
  4455. <summary>
  4456. Determines and returns the fallback default isolation level when one cannot be
  4457. obtained from an existing connection instance.
  4458. </summary>
  4459. <returns>
  4460. The fallback default isolation level for this connection instance -OR-
  4461. <see cref="F:System.Data.IsolationLevel.Unspecified" /> if it cannot be determined.
  4462. </returns>
  4463. </member>
  4464. <member name="M:System.Data.SQLite.SQLiteConnection.GetDefaultIsolationLevel">
  4465. <summary>
  4466. Determines and returns the default isolation level for this connection instance.
  4467. </summary>
  4468. <returns>
  4469. The default isolation level for this connection instance -OR-
  4470. <see cref="F:System.Data.IsolationLevel.Unspecified" /> if it cannot be determined.
  4471. </returns>
  4472. </member>
  4473. <member name="M:System.Data.SQLite.SQLiteConnection.BeginTransaction(System.Data.IsolationLevel,System.Boolean)">
  4474. <summary>
  4475. OBSOLETE. Creates a new SQLiteTransaction if one isn't already active on the connection.
  4476. </summary>
  4477. <param name="isolationLevel">This parameter is ignored.</param>
  4478. <param name="deferredLock">When TRUE, SQLite defers obtaining a write lock until a write operation is requested.
  4479. When FALSE, a writelock is obtained immediately. The default is TRUE, but in a multi-threaded multi-writer
  4480. environment, one may instead choose to lock the database immediately to avoid any possible writer deadlock.</param>
  4481. <returns>Returns a SQLiteTransaction object.</returns>
  4482. </member>
  4483. <member name="M:System.Data.SQLite.SQLiteConnection.BeginTransaction(System.Boolean)">
  4484. <summary>
  4485. OBSOLETE. Creates a new SQLiteTransaction if one isn't already active on the connection.
  4486. </summary>
  4487. <param name="deferredLock">When TRUE, SQLite defers obtaining a write lock until a write operation is requested.
  4488. When FALSE, a writelock is obtained immediately. The default is false, but in a multi-threaded multi-writer
  4489. environment, one may instead choose to lock the database immediately to avoid any possible writer deadlock.</param>
  4490. <returns>Returns a SQLiteTransaction object.</returns>
  4491. </member>
  4492. <member name="M:System.Data.SQLite.SQLiteConnection.BeginTransaction(System.Data.IsolationLevel)">
  4493. <summary>
  4494. Creates a new <see cref="T:System.Data.SQLite.SQLiteTransaction" /> if one isn't already active on the connection.
  4495. </summary>
  4496. <param name="isolationLevel">Supported isolation levels are Serializable, ReadCommitted and Unspecified.</param>
  4497. <remarks>
  4498. Unspecified will use the default isolation level specified in the connection string. If no isolation level is specified in the
  4499. connection string, Serializable is used.
  4500. Serializable transactions are the default. In this mode, the engine gets an immediate lock on the database, and no other threads
  4501. may begin a transaction. Other threads may read from the database, but not write.
  4502. With a ReadCommitted isolation level, locks are deferred and elevated as needed. It is possible for multiple threads to start
  4503. a transaction in ReadCommitted mode, but if a thread attempts to commit a transaction while another thread
  4504. has a ReadCommitted lock, it may timeout or cause a deadlock on both threads until both threads' CommandTimeout's are reached.
  4505. </remarks>
  4506. <returns>Returns a SQLiteTransaction object.</returns>
  4507. </member>
  4508. <member name="M:System.Data.SQLite.SQLiteConnection.BeginTransaction">
  4509. <summary>
  4510. Creates a new <see cref="T:System.Data.SQLite.SQLiteTransaction" /> if one isn't already
  4511. active on the connection.
  4512. </summary>
  4513. <returns>Returns the new transaction object.</returns>
  4514. </member>
  4515. <member name="M:System.Data.SQLite.SQLiteConnection.BeginDbTransaction(System.Data.IsolationLevel)">
  4516. <summary>
  4517. Forwards to the local <see cref="M:System.Data.SQLite.SQLiteConnection.BeginTransaction(System.Data.IsolationLevel)" /> function
  4518. </summary>
  4519. <param name="isolationLevel">Supported isolation levels are Unspecified, Serializable, and ReadCommitted</param>
  4520. <returns></returns>
  4521. </member>
  4522. <member name="M:System.Data.SQLite.SQLiteConnection.ChangeDatabase(System.String)">
  4523. <summary>
  4524. This method is not implemented; however, the <see cref="E:System.Data.SQLite.SQLiteConnection.Changed" />
  4525. event will still be raised.
  4526. </summary>
  4527. <param name="databaseName"></param>
  4528. </member>
  4529. <member name="M:System.Data.SQLite.SQLiteConnection.Close">
  4530. <summary>
  4531. When the database connection is closed, all commands linked to this connection are automatically reset.
  4532. </summary>
  4533. </member>
  4534. <member name="P:System.Data.SQLite.SQLiteConnection.PoolCount">
  4535. <summary>
  4536. Returns the number of pool entries for the file name associated with this connection.
  4537. </summary>
  4538. </member>
  4539. <member name="M:System.Data.SQLite.SQLiteConnection.ClearPool(System.Data.SQLite.SQLiteConnection)">
  4540. <summary>
  4541. Clears the connection pool associated with the connection. Any other active connections using the same database file
  4542. will be discarded instead of returned to the pool when they are closed.
  4543. </summary>
  4544. <param name="connection"></param>
  4545. </member>
  4546. <member name="M:System.Data.SQLite.SQLiteConnection.ClearAllPools">
  4547. <summary>
  4548. Clears all connection pools. Any active connections will be discarded instead of sent to the pool when they are closed.
  4549. </summary>
  4550. </member>
  4551. <member name="P:System.Data.SQLite.SQLiteConnection.ConnectionString">
  4552. <summary>
  4553. The connection string containing the parameters for the connection
  4554. </summary>
  4555. <remarks>
  4556. For the complete list of supported connection string properties,
  4557. please see <see cref="T:System.Data.SQLite.SQLiteConnection" />.
  4558. </remarks>
  4559. </member>
  4560. <member name="M:System.Data.SQLite.SQLiteConnection.CreateCommand">
  4561. <summary>
  4562. Create a new <see cref="T:System.Data.SQLite.SQLiteCommand" /> and associate it with this connection.
  4563. </summary>
  4564. <returns>Returns a new command object already assigned to this connection.</returns>
  4565. </member>
  4566. <member name="M:System.Data.SQLite.SQLiteConnection.CreateDbCommand">
  4567. <summary>
  4568. Forwards to the local <see cref="M:System.Data.SQLite.SQLiteConnection.CreateCommand" /> function.
  4569. </summary>
  4570. <returns></returns>
  4571. </member>
  4572. <member name="M:System.Data.SQLite.SQLiteConnection.CreateSession(System.String)">
  4573. <summary>
  4574. Attempts to create a new <see cref="T:System.Data.SQLite.ISQLiteSession" /> object instance
  4575. using this connection and the specified database name.
  4576. </summary>
  4577. <param name="databaseName">
  4578. The name of the database for the newly created session.
  4579. </param>
  4580. <returns>
  4581. The newly created session -OR- null if it cannot be created.
  4582. </returns>
  4583. </member>
  4584. <member name="M:System.Data.SQLite.SQLiteConnection.CreateChangeSet(System.Byte[])">
  4585. <summary>
  4586. Attempts to create a new <see cref="T:System.Data.SQLite.ISQLiteChangeSet" /> object instance
  4587. using this connection and the specified raw data.
  4588. </summary>
  4589. <param name="rawData">
  4590. The raw data that contains a change set (or patch set).
  4591. </param>
  4592. <returns>
  4593. The newly created change set -OR- null if it cannot be created.
  4594. </returns>
  4595. </member>
  4596. <member name="M:System.Data.SQLite.SQLiteConnection.CreateChangeSet(System.Byte[],System.Data.SQLite.SQLiteChangeSetStartFlags)">
  4597. <summary>
  4598. Attempts to create a new <see cref="T:System.Data.SQLite.ISQLiteChangeSet" /> object instance
  4599. using this connection and the specified raw data.
  4600. </summary>
  4601. <param name="rawData">
  4602. The raw data that contains a change set (or patch set).
  4603. </param>
  4604. <param name="flags">
  4605. The flags used to create the change set iterator.
  4606. </param>
  4607. <returns>
  4608. The newly created change set -OR- null if it cannot be created.
  4609. </returns>
  4610. </member>
  4611. <member name="M:System.Data.SQLite.SQLiteConnection.CreateChangeSet(System.IO.Stream,System.IO.Stream)">
  4612. <summary>
  4613. Attempts to create a new <see cref="T:System.Data.SQLite.ISQLiteChangeSet" /> object instance
  4614. using this connection and the specified stream.
  4615. </summary>
  4616. <param name="inputStream">
  4617. The stream where the raw data that contains a change set (or patch set)
  4618. may be read.
  4619. </param>
  4620. <param name="outputStream">
  4621. The stream where the raw data that contains a change set (or patch set)
  4622. may be written.
  4623. </param>
  4624. <returns>
  4625. The newly created change set -OR- null if it cannot be created.
  4626. </returns>
  4627. </member>
  4628. <member name="M:System.Data.SQLite.SQLiteConnection.CreateChangeSet(System.IO.Stream,System.IO.Stream,System.Data.SQLite.SQLiteChangeSetStartFlags)">
  4629. <summary>
  4630. Attempts to create a new <see cref="T:System.Data.SQLite.ISQLiteChangeSet" /> object instance
  4631. using this connection and the specified stream.
  4632. </summary>
  4633. <param name="inputStream">
  4634. The stream where the raw data that contains a change set (or patch set)
  4635. may be read.
  4636. </param>
  4637. <param name="outputStream">
  4638. The stream where the raw data that contains a change set (or patch set)
  4639. may be written.
  4640. </param>
  4641. <param name="flags">
  4642. The flags used to create the change set iterator.
  4643. </param>
  4644. <returns>
  4645. The newly created change set -OR- null if it cannot be created.
  4646. </returns>
  4647. </member>
  4648. <member name="M:System.Data.SQLite.SQLiteConnection.CreateChangeGroup">
  4649. <summary>
  4650. Attempts to create a new <see cref="T:System.Data.SQLite.ISQLiteChangeGroup" /> object
  4651. instance using this connection.
  4652. </summary>
  4653. <returns>
  4654. The newly created change group -OR- null if it cannot be created.
  4655. </returns>
  4656. </member>
  4657. <member name="P:System.Data.SQLite.SQLiteConnection.DataSource">
  4658. <summary>
  4659. Returns the data source file name without extension or path.
  4660. </summary>
  4661. </member>
  4662. <member name="P:System.Data.SQLite.SQLiteConnection.FileName">
  4663. <summary>
  4664. Returns the fully qualified path and file name for the currently open
  4665. database, if any.
  4666. </summary>
  4667. </member>
  4668. <member name="P:System.Data.SQLite.SQLiteConnection.Database">
  4669. <summary>
  4670. Returns the string "main".
  4671. </summary>
  4672. </member>
  4673. <member name="M:System.Data.SQLite.SQLiteConnection.ShouldUseLegacyConnectionStringParser(System.Data.SQLite.SQLiteConnection)">
  4674. <summary>
  4675. Determines if the legacy connection string parser should be used.
  4676. </summary>
  4677. <param name="connection">
  4678. The connection that will be using the parsed connection string.
  4679. </param>
  4680. <returns>
  4681. Non-zero if the legacy connection string parser should be used.
  4682. </returns>
  4683. </member>
  4684. <member name="M:System.Data.SQLite.SQLiteConnection.ParseConnectionString(System.String,System.Boolean)">
  4685. <summary>
  4686. Parses a connection string into component parts using the custom
  4687. connection string parser. An exception may be thrown if the syntax
  4688. of the connection string is incorrect.
  4689. </summary>
  4690. <param name="connectionString">
  4691. The connection string to parse.
  4692. </param>
  4693. <param name="allowNameOnly">
  4694. Non-zero if names are allowed without values.
  4695. </param>
  4696. <returns>
  4697. The list of key/value pairs corresponding to the parameters specified
  4698. within the connection string.
  4699. </returns>
  4700. </member>
  4701. <member name="M:System.Data.SQLite.SQLiteConnection.ParseConnectionString(System.Data.SQLite.SQLiteConnection,System.String,System.Boolean)">
  4702. <summary>
  4703. Parses a connection string into component parts using the custom
  4704. connection string parser. An exception may be thrown if the syntax
  4705. of the connection string is incorrect.
  4706. </summary>
  4707. <param name="connection">
  4708. The connection that will be using the parsed connection string.
  4709. </param>
  4710. <param name="connectionString">
  4711. The connection string to parse.
  4712. </param>
  4713. <param name="allowNameOnly">
  4714. Non-zero if names are allowed without values.
  4715. </param>
  4716. <returns>
  4717. The list of key/value pairs corresponding to the parameters specified
  4718. within the connection string.
  4719. </returns>
  4720. </member>
  4721. <member name="M:System.Data.SQLite.SQLiteConnection.ParseConnectionStringViaFramework(System.Data.SQLite.SQLiteConnection,System.String,System.Boolean)">
  4722. <summary>
  4723. Parses a connection string using the built-in (i.e. framework provided)
  4724. connection string parser class and returns the key/value pairs. An
  4725. exception may be thrown if the connection string is invalid or cannot be
  4726. parsed. When compiled for the .NET Compact Framework, the custom
  4727. connection string parser is always used instead because the framework
  4728. provided one is unavailable there.
  4729. </summary>
  4730. <param name="connection">
  4731. The connection that will be using the parsed connection string.
  4732. </param>
  4733. <param name="connectionString">
  4734. The connection string to parse.
  4735. </param>
  4736. <param name="strict">
  4737. Non-zero to throw an exception if any connection string values are not of
  4738. the <see cref="T:System.String" /> type. This is not applicable when running on
  4739. the .NET Compact Framework.
  4740. </param>
  4741. <returns>The list of key/value pairs.</returns>
  4742. </member>
  4743. <member name="M:System.Data.SQLite.SQLiteConnection.EnlistTransaction(System.Transactions.Transaction)">
  4744. <summary>
  4745. Manual distributed transaction enlistment support
  4746. </summary>
  4747. <param name="transaction">The distributed transaction to enlist in</param>
  4748. </member>
  4749. <member name="M:System.Data.SQLite.SQLiteConnection.WaitForEnlistmentReset(System.Int32,System.Nullable{System.Boolean})">
  4750. <summary>
  4751. <b>EXPERIMENTAL</b> --
  4752. Waits for the enlistment associated with this connection to be reset.
  4753. This method always throws <see cref="T:System.NotImplementedException" /> when
  4754. running on the .NET Compact Framework.
  4755. </summary>
  4756. <param name="timeoutMilliseconds">
  4757. The approximate maximum number of milliseconds to wait before timing
  4758. out the wait operation.
  4759. </param>
  4760. <param name="returnOnDisposed">
  4761. The return value to use if the connection has been disposed; if this
  4762. value is null, <see cref="T:System.ObjectDisposedException" /> will be raised
  4763. if the connection has been disposed.
  4764. </param>
  4765. <returns>
  4766. Non-zero if the enlistment assciated with this connection was reset;
  4767. otherwise, zero. It should be noted that this method returning a
  4768. non-zero value does not necessarily guarantee that the connection
  4769. can enlist in a new transaction (i.e. due to potentical race with
  4770. other threads); therefore, callers should generally use try/catch
  4771. when calling the <see cref="M:System.Data.SQLite.SQLiteConnection.EnlistTransaction(System.Transactions.Transaction)" /> method.
  4772. </returns>
  4773. </member>
  4774. <member name="M:System.Data.SQLite.SQLiteConnection.FindKey(System.Collections.Generic.SortedList{System.String,System.String},System.String,System.String)">
  4775. <summary>
  4776. Looks for a key in the array of key/values of the parameter string. If not found, return the specified default value
  4777. </summary>
  4778. <param name="items">The list to look in</param>
  4779. <param name="key">The key to find</param>
  4780. <param name="defValue">The default value to return if the key is not found</param>
  4781. <returns>The value corresponding to the specified key, or the default value if not found.</returns>
  4782. </member>
  4783. <member name="M:System.Data.SQLite.SQLiteConnection.TryParseEnum(System.Type,System.String,System.Boolean)">
  4784. <summary>
  4785. Attempts to convert the string value to an enumerated value of the specified type.
  4786. </summary>
  4787. <param name="type">The enumerated type to convert the string value to.</param>
  4788. <param name="value">The string value to be converted.</param>
  4789. <param name="ignoreCase">Non-zero to make the conversion case-insensitive.</param>
  4790. <returns>The enumerated value upon success or null upon error.</returns>
  4791. </member>
  4792. <member name="M:System.Data.SQLite.SQLiteConnection.TryParseByte(System.String,System.Globalization.NumberStyles,System.Byte@)">
  4793. <summary>
  4794. Attempts to convert an input string into a byte value.
  4795. </summary>
  4796. <param name="value">
  4797. The string value to be converted.
  4798. </param>
  4799. <param name="style">
  4800. The number styles to use for the conversion.
  4801. </param>
  4802. <param name="result">
  4803. Upon sucess, this will contain the parsed byte value.
  4804. Upon failure, the value of this parameter is undefined.
  4805. </param>
  4806. <returns>
  4807. Non-zero upon success; zero on failure.
  4808. </returns>
  4809. </member>
  4810. <member name="M:System.Data.SQLite.SQLiteConnection.SetLimitOption(System.Data.SQLite.SQLiteLimitOpsEnum,System.Int32)">
  4811. <summary>
  4812. Change a limit value for the database.
  4813. </summary>
  4814. <param name="option">
  4815. The database limit to change.
  4816. </param>
  4817. <param name="value">
  4818. The new value for the specified limit.
  4819. </param>
  4820. <returns>
  4821. The old value for the specified limit -OR- negative one if an error
  4822. occurs.
  4823. </returns>
  4824. </member>
  4825. <member name="M:System.Data.SQLite.SQLiteConnection.SetConfigurationOption(System.Data.SQLite.SQLiteConfigDbOpsEnum,System.Object)">
  4826. <summary>
  4827. Change a configuration option value for the database.
  4828. </summary>
  4829. <param name="option">
  4830. The database configuration option to change.
  4831. </param>
  4832. <param name="value">
  4833. The new value for the specified configuration option.
  4834. </param>
  4835. </member>
  4836. <member name="M:System.Data.SQLite.SQLiteConnection.EnableExtensions(System.Boolean)">
  4837. <summary>
  4838. Enables or disables extension loading.
  4839. </summary>
  4840. <param name="enable">
  4841. True to enable loading of extensions, false to disable.
  4842. </param>
  4843. </member>
  4844. <member name="M:System.Data.SQLite.SQLiteConnection.LoadExtension(System.String)">
  4845. <summary>
  4846. Loads a SQLite extension library from the named dynamic link library file.
  4847. </summary>
  4848. <param name="fileName">
  4849. The name of the dynamic link library file containing the extension.
  4850. </param>
  4851. </member>
  4852. <member name="M:System.Data.SQLite.SQLiteConnection.LoadExtension(System.String,System.String)">
  4853. <summary>
  4854. Loads a SQLite extension library from the named dynamic link library file.
  4855. </summary>
  4856. <param name="fileName">
  4857. The name of the dynamic link library file containing the extension.
  4858. </param>
  4859. <param name="procName">
  4860. The name of the exported function used to initialize the extension.
  4861. If null, the default "sqlite3_extension_init" will be used.
  4862. </param>
  4863. </member>
  4864. <member name="M:System.Data.SQLite.SQLiteConnection.CreateModule(System.Data.SQLite.SQLiteModule)">
  4865. <summary>
  4866. Creates a disposable module containing the implementation of a virtual
  4867. table.
  4868. </summary>
  4869. <param name="module">
  4870. The module object to be used when creating the disposable module.
  4871. </param>
  4872. </member>
  4873. <member name="M:System.Data.SQLite.SQLiteConnection.FromHexString(System.String)">
  4874. <summary>
  4875. Parses a string containing a sequence of zero or more hexadecimal
  4876. encoded byte values and returns the resulting byte array. The
  4877. "0x" prefix is not allowed on the input string.
  4878. </summary>
  4879. <param name="text">
  4880. The input string containing zero or more hexadecimal encoded byte
  4881. values.
  4882. </param>
  4883. <returns>
  4884. A byte array containing the parsed byte values or null if an error
  4885. was encountered.
  4886. </returns>
  4887. </member>
  4888. <member name="M:System.Data.SQLite.SQLiteConnection.ToHexString(System.Byte[])">
  4889. <summary>
  4890. Creates and returns a string containing the hexadecimal encoded byte
  4891. values from the input array.
  4892. </summary>
  4893. <param name="array">
  4894. The input array of bytes.
  4895. </param>
  4896. <returns>
  4897. The resulting string or null upon failure.
  4898. </returns>
  4899. </member>
  4900. <member name="M:System.Data.SQLite.SQLiteConnection.FromHexString(System.String,System.String@)">
  4901. <summary>
  4902. Parses a string containing a sequence of zero or more hexadecimal
  4903. encoded byte values and returns the resulting byte array. The
  4904. "0x" prefix is not allowed on the input string.
  4905. </summary>
  4906. <param name="text">
  4907. The input string containing zero or more hexadecimal encoded byte
  4908. values.
  4909. </param>
  4910. <param name="error">
  4911. Upon failure, this will contain an appropriate error message.
  4912. </param>
  4913. <returns>
  4914. A byte array containing the parsed byte values or null if an error
  4915. was encountered.
  4916. </returns>
  4917. </member>
  4918. <member name="M:System.Data.SQLite.SQLiteConnection.GetDefaultPooling">
  4919. <summary>
  4920. This method figures out what the default connection pool setting should
  4921. be based on the connection flags. When present, the "Pooling" connection
  4922. string property value always overrides the value returned by this method.
  4923. </summary>
  4924. <returns>
  4925. Non-zero if the connection pool should be enabled by default; otherwise,
  4926. zero.
  4927. </returns>
  4928. </member>
  4929. <member name="M:System.Data.SQLite.SQLiteConnection.GetEffectiveIsolationLevel(System.Data.IsolationLevel)">
  4930. <summary>
  4931. Determines the transaction isolation level that should be used by
  4932. the caller, primarily based upon the one specified by the caller.
  4933. If mapping of transaction isolation levels is enabled, the returned
  4934. transaction isolation level may be significantly different than the
  4935. originally specified one.
  4936. </summary>
  4937. <param name="isolationLevel">
  4938. The originally specified transaction isolation level.
  4939. </param>
  4940. <returns>
  4941. The transaction isolation level that should be used.
  4942. </returns>
  4943. </member>
  4944. <member name="M:System.Data.SQLite.SQLiteConnection.Open">
  4945. <summary>
  4946. Opens the connection using the parameters found in the <see cref="P:System.Data.SQLite.SQLiteConnection.ConnectionString" />.
  4947. </summary>
  4948. </member>
  4949. <member name="M:System.Data.SQLite.SQLiteConnection.OpenAndReturn">
  4950. <summary>
  4951. Opens the connection using the parameters found in the <see cref="P:System.Data.SQLite.SQLiteConnection.ConnectionString" /> and then returns it.
  4952. </summary>
  4953. <returns>The current connection object.</returns>
  4954. </member>
  4955. <member name="P:System.Data.SQLite.SQLiteConnection.DefaultTimeout">
  4956. <summary>
  4957. Gets/sets the default command timeout for newly-created commands. This is especially useful for
  4958. commands used internally such as inside a SQLiteTransaction, where setting the timeout is not possible.
  4959. This can also be set in the ConnectionString with "Default Timeout"
  4960. </summary>
  4961. </member>
  4962. <member name="P:System.Data.SQLite.SQLiteConnection.BusyTimeout">
  4963. <summary>
  4964. Gets/sets the default busy timeout to use with the SQLite core library. This is only used when
  4965. opening a connection.
  4966. </summary>
  4967. </member>
  4968. <member name="P:System.Data.SQLite.SQLiteConnection.WaitTimeout">
  4969. <summary>
  4970. <b>EXPERIMENTAL</b> --
  4971. The wait timeout to use with <see cref="M:System.Data.SQLite.SQLiteConnection.WaitForEnlistmentReset(System.Int32,System.Nullable{System.Boolean})" /> method.
  4972. This is only used when waiting for the enlistment to be reset prior to
  4973. enlisting in a transaction, and then only when the appropriate connection
  4974. flag is set.
  4975. </summary>
  4976. </member>
  4977. <member name="P:System.Data.SQLite.SQLiteConnection.PrepareRetries">
  4978. <summary>
  4979. The maximum number of retries when preparing SQL to be executed. This
  4980. normally only applies to preparation errors resulting from the database
  4981. schema being changed.
  4982. </summary>
  4983. </member>
  4984. <member name="P:System.Data.SQLite.SQLiteConnection.ProgressOps">
  4985. <summary>
  4986. The approximate number of virtual machine instructions between progress
  4987. events. In order for progress events to actually fire, the event handler
  4988. must be added to the <see cref="E:System.Data.SQLite.SQLiteConnection.Progress" /> event as
  4989. well. This value will only be used when the underlying native progress
  4990. callback needs to be changed.
  4991. </summary>
  4992. </member>
  4993. <member name="P:System.Data.SQLite.SQLiteConnection.ParseViaFramework">
  4994. <summary>
  4995. Non-zero if the built-in (i.e. framework provided) connection string
  4996. parser should be used when opening the connection.
  4997. </summary>
  4998. </member>
  4999. <member name="P:System.Data.SQLite.SQLiteConnection.Flags">
  5000. <summary>
  5001. Gets/sets the extra behavioral flags for this connection. See the
  5002. <see cref="T:System.Data.SQLite.SQLiteConnectionFlags" /> enumeration for a list of
  5003. possible values.
  5004. </summary>
  5005. </member>
  5006. <member name="P:System.Data.SQLite.SQLiteConnection.DefaultDbType">
  5007. <summary>
  5008. Gets/sets the default database type for this connection. This value
  5009. will only be used when not null.
  5010. </summary>
  5011. </member>
  5012. <member name="P:System.Data.SQLite.SQLiteConnection.DefaultTypeName">
  5013. <summary>
  5014. Gets/sets the default database type name for this connection. This
  5015. value will only be used when not null.
  5016. </summary>
  5017. </member>
  5018. <member name="P:System.Data.SQLite.SQLiteConnection.VfsName">
  5019. <summary>
  5020. Gets/sets the VFS name for this connection. This value will only be
  5021. used when opening the database.
  5022. </summary>
  5023. </member>
  5024. <member name="P:System.Data.SQLite.SQLiteConnection.OwnHandle">
  5025. <summary>
  5026. Returns non-zero if the underlying native connection handle is
  5027. owned by this instance.
  5028. </summary>
  5029. </member>
  5030. <member name="P:System.Data.SQLite.SQLiteConnection.ServerVersion">
  5031. <summary>
  5032. Returns the version of the underlying SQLite database engine
  5033. </summary>
  5034. </member>
  5035. <member name="P:System.Data.SQLite.SQLiteConnection.LastInsertRowId">
  5036. <summary>
  5037. Returns the rowid of the most recent successful INSERT into the database from this connection.
  5038. </summary>
  5039. </member>
  5040. <member name="M:System.Data.SQLite.SQLiteConnection.Cancel">
  5041. <summary>
  5042. This method causes any pending database operation to abort and return at
  5043. its earliest opportunity. This routine is typically called in response
  5044. to a user action such as pressing "Cancel" or Ctrl-C where the user wants
  5045. a long query operation to halt immediately. It is safe to call this
  5046. routine from any thread. However, it is not safe to call this routine
  5047. with a database connection that is closed or might close before this method
  5048. returns.
  5049. </summary>
  5050. </member>
  5051. <member name="P:System.Data.SQLite.SQLiteConnection.Changes">
  5052. <summary>
  5053. Returns the number of rows changed by the last INSERT, UPDATE, or DELETE statement executed on
  5054. this connection.
  5055. </summary>
  5056. </member>
  5057. <member name="M:System.Data.SQLite.SQLiteConnection.IsReadOnly(System.String)">
  5058. <summary>
  5059. Checks if this connection to the specified database should be considered
  5060. read-only. An exception will be thrown if the database name specified
  5061. via <paramref name="name" /> cannot be found.
  5062. </summary>
  5063. <param name="name">
  5064. The name of a database associated with this connection -OR- null for the
  5065. main database.
  5066. </param>
  5067. <returns>
  5068. Non-zero if this connection to the specified database should be considered
  5069. read-only.
  5070. </returns>
  5071. </member>
  5072. <member name="P:System.Data.SQLite.SQLiteConnection.AutoCommit">
  5073. <summary>
  5074. Returns non-zero if the given database connection is in autocommit mode.
  5075. Autocommit mode is on by default. Autocommit mode is disabled by a BEGIN
  5076. statement. Autocommit mode is re-enabled by a COMMIT or ROLLBACK.
  5077. </summary>
  5078. </member>
  5079. <member name="P:System.Data.SQLite.SQLiteConnection.MemoryUsed">
  5080. <summary>
  5081. Returns the amount of memory (in bytes) currently in use by the SQLite core library.
  5082. </summary>
  5083. </member>
  5084. <member name="P:System.Data.SQLite.SQLiteConnection.MemoryHighwater">
  5085. <summary>
  5086. Returns the maximum amount of memory (in bytes) used by the SQLite core library since the high-water mark was last reset.
  5087. </summary>
  5088. </member>
  5089. <member name="M:System.Data.SQLite.SQLiteConnection.GetMemoryStatistics(System.Collections.Generic.IDictionary{System.String,System.Int64}@)">
  5090. <summary>
  5091. Returns various global memory statistics for the SQLite core library via
  5092. a dictionary of key/value pairs. Currently, only the "MemoryUsed" and
  5093. "MemoryHighwater" keys are returned and they have values that correspond
  5094. to the values that could be obtained via the <see cref="P:System.Data.SQLite.SQLiteConnection.MemoryUsed" />
  5095. and <see cref="P:System.Data.SQLite.SQLiteConnection.MemoryHighwater" /> connection properties.
  5096. </summary>
  5097. <param name="statistics">
  5098. This dictionary will be populated with the global memory statistics. It
  5099. will be created if necessary.
  5100. </param>
  5101. </member>
  5102. <member name="M:System.Data.SQLite.SQLiteConnection.ReleaseMemory">
  5103. <summary>
  5104. Attempts to free as much heap memory as possible for this database connection.
  5105. </summary>
  5106. </member>
  5107. <member name="M:System.Data.SQLite.SQLiteConnection.ReleaseMemory(System.Int32,System.Boolean,System.Boolean,System.Int32@,System.Boolean@,System.UInt32@)">
  5108. <summary>
  5109. Attempts to free N bytes of heap memory by deallocating non-essential memory
  5110. allocations held by the database library. Memory used to cache database pages
  5111. to improve performance is an example of non-essential memory. This is a no-op
  5112. returning zero if the SQLite core library was not compiled with the compile-time
  5113. option SQLITE_ENABLE_MEMORY_MANAGEMENT. Optionally, attempts to reset and/or
  5114. compact the Win32 native heap, if applicable.
  5115. </summary>
  5116. <param name="nBytes">
  5117. The requested number of bytes to free.
  5118. </param>
  5119. <param name="reset">
  5120. Non-zero to attempt a heap reset.
  5121. </param>
  5122. <param name="compact">
  5123. Non-zero to attempt heap compaction.
  5124. </param>
  5125. <param name="nFree">
  5126. The number of bytes actually freed. This value may be zero.
  5127. </param>
  5128. <param name="resetOk">
  5129. This value will be non-zero if the heap reset was successful.
  5130. </param>
  5131. <param name="nLargest">
  5132. The size of the largest committed free block in the heap, in bytes.
  5133. This value will be zero unless heap compaction is enabled.
  5134. </param>
  5135. <returns>
  5136. A standard SQLite return code (i.e. zero for success and non-zero
  5137. for failure).
  5138. </returns>
  5139. </member>
  5140. <member name="M:System.Data.SQLite.SQLiteConnection.SetMemoryStatus(System.Boolean)">
  5141. <summary>
  5142. Sets the status of the memory usage tracking subsystem in the SQLite core library. By default, this is enabled.
  5143. If this is disabled, memory usage tracking will not be performed. This is not really a per-connection value, it is
  5144. global to the process.
  5145. </summary>
  5146. <param name="value">Non-zero to enable memory usage tracking, zero otherwise.</param>
  5147. <returns>A standard SQLite return code (i.e. zero for success and non-zero for failure).</returns>
  5148. </member>
  5149. <member name="P:System.Data.SQLite.SQLiteConnection.DefineConstants">
  5150. <summary>
  5151. Returns a string containing the define constants (i.e. compile-time
  5152. options) used to compile the core managed assembly, delimited with
  5153. spaces.
  5154. </summary>
  5155. </member>
  5156. <member name="P:System.Data.SQLite.SQLiteConnection.SQLiteVersion">
  5157. <summary>
  5158. Returns the version of the underlying SQLite core library.
  5159. </summary>
  5160. </member>
  5161. <member name="P:System.Data.SQLite.SQLiteConnection.SQLiteSourceId">
  5162. <summary>
  5163. This method returns the string whose value is the same as the
  5164. SQLITE_SOURCE_ID C preprocessor macro used when compiling the
  5165. SQLite core library.
  5166. </summary>
  5167. </member>
  5168. <member name="P:System.Data.SQLite.SQLiteConnection.SQLiteCompileOptions">
  5169. <summary>
  5170. Returns a string containing the compile-time options used to
  5171. compile the SQLite core native library, delimited with spaces.
  5172. </summary>
  5173. </member>
  5174. <member name="P:System.Data.SQLite.SQLiteConnection.InteropVersion">
  5175. <summary>
  5176. This method returns the version of the interop SQLite assembly
  5177. used. If the SQLite interop assembly is not in use or the
  5178. necessary information cannot be obtained for any reason, a null
  5179. value may be returned.
  5180. </summary>
  5181. </member>
  5182. <member name="P:System.Data.SQLite.SQLiteConnection.InteropSourceId">
  5183. <summary>
  5184. This method returns the string whose value contains the unique
  5185. identifier for the source checkout used to build the interop
  5186. assembly. If the SQLite interop assembly is not in use or the
  5187. necessary information cannot be obtained for any reason, a null
  5188. value may be returned.
  5189. </summary>
  5190. </member>
  5191. <member name="P:System.Data.SQLite.SQLiteConnection.InteropCompileOptions">
  5192. <summary>
  5193. Returns a string containing the compile-time options used to
  5194. compile the SQLite interop assembly, delimited with spaces.
  5195. </summary>
  5196. </member>
  5197. <member name="P:System.Data.SQLite.SQLiteConnection.ProviderVersion">
  5198. <summary>
  5199. This method returns the version of the managed components used
  5200. to interact with the SQLite core library. If the necessary
  5201. information cannot be obtained for any reason, a null value may
  5202. be returned.
  5203. </summary>
  5204. </member>
  5205. <member name="P:System.Data.SQLite.SQLiteConnection.ProviderSourceId">
  5206. <summary>
  5207. This method returns the string whose value contains the unique
  5208. identifier for the source checkout used to build the managed
  5209. components currently executing. If the necessary information
  5210. cannot be obtained for any reason, a null value may be returned.
  5211. </summary>
  5212. </member>
  5213. <member name="M:System.Data.SQLite.SQLiteConnection.TryGetLastCachedSetting(System.String,System.Object,System.Object@)">
  5214. <summary>
  5215. Queries and returns the value of the specified setting, using the
  5216. cached setting names and values for the last connection that used
  5217. the <see cref="M:System.Data.SQLite.SQLiteConnection.Open" /> method, when available.
  5218. </summary>
  5219. <param name="name">
  5220. The name of the setting.
  5221. </param>
  5222. <param name="default">
  5223. The value to be returned if the setting has not been set explicitly
  5224. or cannot be determined.
  5225. </param>
  5226. <param name="value">
  5227. The value of the cached setting is stored here if found; otherwise,
  5228. the value of <paramref name="default" /> is stored here.
  5229. </param>
  5230. <returns>
  5231. Non-zero if the cached setting was found; otherwise, zero.
  5232. </returns>
  5233. </member>
  5234. <member name="M:System.Data.SQLite.SQLiteConnection.SetLastCachedSetting(System.String,System.Object)">
  5235. <summary>
  5236. Adds or sets the cached setting specified by <paramref name="name" />
  5237. to the value specified by <paramref name="value" /> using the cached
  5238. setting names and values for the last connection that used the
  5239. <see cref="M:System.Data.SQLite.SQLiteConnection.Open" /> method, when available.
  5240. </summary>
  5241. <param name="name">
  5242. The name of the cached setting to add or replace.
  5243. </param>
  5244. <param name="value">
  5245. The new value of the cached setting.
  5246. </param>
  5247. </member>
  5248. <member name="P:System.Data.SQLite.SQLiteConnection.DefaultFlags">
  5249. <summary>
  5250. The default connection flags to be used for all opened connections
  5251. when they are not present in the connection string.
  5252. </summary>
  5253. </member>
  5254. <member name="P:System.Data.SQLite.SQLiteConnection.SharedFlags">
  5255. <summary>
  5256. The extra connection flags to be used for all opened connections.
  5257. </summary>
  5258. </member>
  5259. <member name="P:System.Data.SQLite.SQLiteConnection.State">
  5260. <summary>
  5261. Returns the state of the connection.
  5262. </summary>
  5263. </member>
  5264. <member name="M:System.Data.SQLite.SQLiteConnection.Shutdown">
  5265. <summary>
  5266. Passes a shutdown request to the SQLite core library. Does not throw
  5267. an exception if the shutdown request fails.
  5268. </summary>
  5269. <returns>
  5270. A standard SQLite return code (i.e. zero for success and non-zero for
  5271. failure).
  5272. </returns>
  5273. </member>
  5274. <member name="M:System.Data.SQLite.SQLiteConnection.Shutdown(System.Boolean,System.Boolean)">
  5275. <summary>
  5276. Passes a shutdown request to the SQLite core library. Throws an
  5277. exception if the shutdown request fails and the no-throw parameter
  5278. is non-zero.
  5279. </summary>
  5280. <param name="directories">
  5281. Non-zero to reset the database and temporary directories to their
  5282. default values, which should be null for both.
  5283. </param>
  5284. <param name="noThrow">
  5285. When non-zero, throw an exception if the shutdown request fails.
  5286. </param>
  5287. </member>
  5288. <member name="M:System.Data.SQLite.SQLiteConnection.SetExtendedResultCodes(System.Boolean)">
  5289. Enables or disables extended result codes returned by SQLite
  5290. </member>
  5291. <member name="M:System.Data.SQLite.SQLiteConnection.ResultCode">
  5292. Enables or disables extended result codes returned by SQLite
  5293. </member>
  5294. <member name="M:System.Data.SQLite.SQLiteConnection.ExtendedResultCode">
  5295. Enables or disables extended result codes returned by SQLite
  5296. </member>
  5297. <member name="M:System.Data.SQLite.SQLiteConnection.LogMessage(System.Data.SQLite.SQLiteErrorCode,System.String)">
  5298. Add a log message via the SQLite sqlite3_log interface.
  5299. </member>
  5300. <member name="M:System.Data.SQLite.SQLiteConnection.LogMessage(System.Int32,System.String)">
  5301. Add a log message via the SQLite sqlite3_log interface.
  5302. </member>
  5303. <member name="M:System.Data.SQLite.SQLiteConnection.SetAvRetry(System.Int32@,System.Int32@)">
  5304. <summary>
  5305. Queries or modifies the number of retries or the retry interval (in milliseconds) for
  5306. certain I/O operations that may fail due to anti-virus software.
  5307. </summary>
  5308. <param name="count">The number of times to retry the I/O operation. A negative value
  5309. will cause the current count to be queried and replace that negative value.</param>
  5310. <param name="interval">The number of milliseconds to wait before retrying the I/O
  5311. operation. This number is multiplied by the number of retry attempts so far to come
  5312. up with the final number of milliseconds to wait. A negative value will cause the
  5313. current interval to be queried and replace that negative value.</param>
  5314. <returns>Zero for success, non-zero for error.</returns>
  5315. </member>
  5316. <member name="M:System.Data.SQLite.SQLiteConnection.SetChunkSize(System.Int32)">
  5317. <summary>
  5318. Sets the chunk size for the primary file associated with this database
  5319. connection.
  5320. </summary>
  5321. <param name="size">
  5322. The new chunk size for the main database, in bytes.
  5323. </param>
  5324. <returns>
  5325. Zero for success, non-zero for error.
  5326. </returns>
  5327. </member>
  5328. <member name="M:System.Data.SQLite.SQLiteConnection.UnwrapString(System.String)">
  5329. <summary>
  5330. Removes one set of surrounding single -OR- double quotes from the string
  5331. value and returns the resulting string value. If the string is null, empty,
  5332. or contains quotes that are not balanced, nothing is done and the original
  5333. string value will be returned.
  5334. </summary>
  5335. <param name="value">The string value to process.</param>
  5336. <returns>
  5337. The string value, modified to remove one set of surrounding single -OR-
  5338. double quotes, if applicable.
  5339. </returns>
  5340. </member>
  5341. <member name="M:System.Data.SQLite.SQLiteConnection.GetDataDirectory">
  5342. <summary>
  5343. Determines the directory to be used when dealing with the "|DataDirectory|"
  5344. macro in a database file name.
  5345. </summary>
  5346. <returns>
  5347. The directory to use in place of the "|DataDirectory|" macro -OR- null if it
  5348. cannot be determined.
  5349. </returns>
  5350. </member>
  5351. <member name="M:System.Data.SQLite.SQLiteConnection.ExpandFileName(System.String,System.Boolean)">
  5352. <summary>
  5353. Expand the filename of the data source, resolving the |DataDirectory|
  5354. macro as appropriate.
  5355. </summary>
  5356. <param name="sourceFile">The database filename to expand</param>
  5357. <param name="toFullPath">
  5358. Non-zero if the returned file name should be converted to a full path
  5359. (except when using the .NET Compact Framework).
  5360. </param>
  5361. <returns>The expanded path and filename of the filename</returns>
  5362. </member>
  5363. <member name="M:System.Data.SQLite.SQLiteConnection.GetSchema">
  5364. <overloads>
  5365. The following commands are used to extract schema information out of the database. Valid schema types are:
  5366. <list type="bullet">
  5367. <item>
  5368. <description>MetaDataCollections</description>
  5369. </item>
  5370. <item>
  5371. <description>DataSourceInformation</description>
  5372. </item>
  5373. <item>
  5374. <description>Catalogs</description>
  5375. </item>
  5376. <item>
  5377. <description>Columns</description>
  5378. </item>
  5379. <item>
  5380. <description>ForeignKeys</description>
  5381. </item>
  5382. <item>
  5383. <description>Indexes</description>
  5384. </item>
  5385. <item>
  5386. <description>IndexColumns</description>
  5387. </item>
  5388. <item>
  5389. <description>Tables</description>
  5390. </item>
  5391. <item>
  5392. <description>Views</description>
  5393. </item>
  5394. <item>
  5395. <description>ViewColumns</description>
  5396. </item>
  5397. </list>
  5398. </overloads>
  5399. <summary>
  5400. Returns the MetaDataCollections schema
  5401. </summary>
  5402. <returns>A DataTable of the MetaDataCollections schema</returns>
  5403. </member>
  5404. <member name="M:System.Data.SQLite.SQLiteConnection.GetSchema(System.String)">
  5405. <summary>
  5406. Returns schema information of the specified collection
  5407. </summary>
  5408. <param name="collectionName">The schema collection to retrieve</param>
  5409. <returns>A DataTable of the specified collection</returns>
  5410. </member>
  5411. <member name="M:System.Data.SQLite.SQLiteConnection.GetSchema(System.String,System.String[])">
  5412. <summary>
  5413. Retrieves schema information using the specified constraint(s) for the specified collection
  5414. </summary>
  5415. <param name="collectionName">The collection to retrieve.</param>
  5416. <param name="restrictionValues">
  5417. The restrictions to impose. Typically, this may include:
  5418. <list type="table">
  5419. <listheader>
  5420. <term>restrictionValues element index</term>
  5421. <term>usage</term>
  5422. </listheader>
  5423. <item>
  5424. <description>0</description>
  5425. <description>The database (or catalog) name, if applicable.</description>
  5426. </item>
  5427. <item>
  5428. <description>1</description>
  5429. <description>The schema name. This is not used by this provider.</description>
  5430. </item>
  5431. <item>
  5432. <description>2</description>
  5433. <description>The table name, if applicable.</description>
  5434. </item>
  5435. <item>
  5436. <description>3</description>
  5437. <description>
  5438. Depends on <paramref name="collectionName" />.
  5439. When "IndexColumns", it is the index name; otherwise, it is the column name.
  5440. </description>
  5441. </item>
  5442. <item>
  5443. <description>4</description>
  5444. <description>
  5445. Depends on <paramref name="collectionName" />.
  5446. When "IndexColumns", it is the column name; otherwise, it is not used.
  5447. </description>
  5448. </item>
  5449. </list>
  5450. </param>
  5451. <returns>A DataTable of the specified collection</returns>
  5452. </member>
  5453. <member name="M:System.Data.SQLite.SQLiteConnection.Schema_MetaDataCollections">
  5454. <summary>
  5455. Builds a MetaDataCollections schema datatable
  5456. </summary>
  5457. <returns>DataTable</returns>
  5458. </member>
  5459. <member name="M:System.Data.SQLite.SQLiteConnection.Schema_DataSourceInformation">
  5460. <summary>
  5461. Builds a DataSourceInformation datatable
  5462. </summary>
  5463. <returns>DataTable</returns>
  5464. </member>
  5465. <member name="M:System.Data.SQLite.SQLiteConnection.Schema_Columns(System.String,System.String,System.String)">
  5466. <summary>
  5467. Build a Columns schema
  5468. </summary>
  5469. <param name="strCatalog">The catalog (attached database) to query, can be null</param>
  5470. <param name="strTable">The table to retrieve schema information for, can be null</param>
  5471. <param name="strColumn">The column to retrieve schema information for, can be null</param>
  5472. <returns>DataTable</returns>
  5473. </member>
  5474. <member name="M:System.Data.SQLite.SQLiteConnection.Schema_Indexes(System.String,System.String,System.String)">
  5475. <summary>
  5476. Returns index information for the given database and catalog
  5477. </summary>
  5478. <param name="strCatalog">The catalog (attached database) to query, can be null</param>
  5479. <param name="strIndex">The name of the index to retrieve information for, can be null</param>
  5480. <param name="strTable">The table to retrieve index information for, can be null</param>
  5481. <returns>DataTable</returns>
  5482. </member>
  5483. <member name="M:System.Data.SQLite.SQLiteConnection.Schema_Tables(System.String,System.String,System.String)">
  5484. <summary>
  5485. Retrieves table schema information for the database and catalog
  5486. </summary>
  5487. <param name="strCatalog">The catalog (attached database) to retrieve tables on</param>
  5488. <param name="strTable">The table to retrieve, can be null</param>
  5489. <param name="strType">The table type, can be null</param>
  5490. <returns>DataTable</returns>
  5491. </member>
  5492. <member name="M:System.Data.SQLite.SQLiteConnection.Schema_Views(System.String,System.String)">
  5493. <summary>
  5494. Retrieves view schema information for the database
  5495. </summary>
  5496. <param name="strCatalog">The catalog (attached database) to retrieve views on</param>
  5497. <param name="strView">The view name, can be null</param>
  5498. <returns>DataTable</returns>
  5499. </member>
  5500. <member name="M:System.Data.SQLite.SQLiteConnection.Schema_Catalogs(System.String)">
  5501. <summary>
  5502. Retrieves catalog (attached databases) schema information for the database
  5503. </summary>
  5504. <param name="strCatalog">The catalog to retrieve, can be null</param>
  5505. <returns>DataTable</returns>
  5506. </member>
  5507. <member name="M:System.Data.SQLite.SQLiteConnection.Schema_IndexColumns(System.String,System.String,System.String,System.String)">
  5508. <summary>
  5509. Returns the base column information for indexes in a database
  5510. </summary>
  5511. <param name="strCatalog">The catalog to retrieve indexes for (can be null)</param>
  5512. <param name="strTable">The table to restrict index information by (can be null)</param>
  5513. <param name="strIndex">The index to restrict index information by (can be null)</param>
  5514. <param name="strColumn">The source column to restrict index information by (can be null)</param>
  5515. <returns>A DataTable containing the results</returns>
  5516. </member>
  5517. <member name="M:System.Data.SQLite.SQLiteConnection.Schema_ViewColumns(System.String,System.String,System.String)">
  5518. <summary>
  5519. Returns detailed column information for a specified view
  5520. </summary>
  5521. <param name="strCatalog">The catalog to retrieve columns for (can be null)</param>
  5522. <param name="strView">The view to restrict column information by (can be null)</param>
  5523. <param name="strColumn">The source column to restrict column information by (can be null)</param>
  5524. <returns>A DataTable containing the results</returns>
  5525. </member>
  5526. <member name="M:System.Data.SQLite.SQLiteConnection.Schema_ForeignKeys(System.String,System.String,System.String)">
  5527. <summary>
  5528. Retrieves foreign key information from the specified set of filters
  5529. </summary>
  5530. <param name="strCatalog">An optional catalog to restrict results on</param>
  5531. <param name="strTable">An optional table to restrict results on</param>
  5532. <param name="strKeyName">An optional foreign key name to restrict results on</param>
  5533. <returns>A DataTable with the results of the query</returns>
  5534. </member>
  5535. <member name="E:System.Data.SQLite.SQLiteConnection.Progress">
  5536. <summary>
  5537. This event is raised periodically during long running queries. Changing
  5538. the value of the <see cref="F:System.Data.SQLite.ProgressEventArgs.ReturnCode" /> property will
  5539. determine if the operation in progress will continue or be interrupted.
  5540. For the entire duration of the event, the associated connection and
  5541. statement objects must not be modified, either directly or indirectly, by
  5542. the called code.
  5543. </summary>
  5544. </member>
  5545. <member name="E:System.Data.SQLite.SQLiteConnection.Authorize">
  5546. <summary>
  5547. This event is raised whenever SQLite encounters an action covered by the
  5548. authorizer during query preparation. Changing the value of the
  5549. <see cref="F:System.Data.SQLite.AuthorizerEventArgs.ReturnCode" /> property will determine if
  5550. the specific action will be allowed, ignored, or denied. For the entire
  5551. duration of the event, the associated connection and statement objects
  5552. must not be modified, either directly or indirectly, by the called code.
  5553. </summary>
  5554. </member>
  5555. <member name="E:System.Data.SQLite.SQLiteConnection.Update">
  5556. <summary>
  5557. This event is raised whenever SQLite makes an update/delete/insert into the database on
  5558. this connection. It only applies to the given connection.
  5559. </summary>
  5560. </member>
  5561. <member name="E:System.Data.SQLite.SQLiteConnection.Commit">
  5562. <summary>
  5563. This event is raised whenever SQLite is committing a transaction.
  5564. Return non-zero to trigger a rollback.
  5565. </summary>
  5566. </member>
  5567. <member name="E:System.Data.SQLite.SQLiteConnection.Trace">
  5568. <summary>
  5569. This event is raised whenever SQLite statement first begins executing on
  5570. this connection. It only applies to the given connection.
  5571. </summary>
  5572. </member>
  5573. <member name="E:System.Data.SQLite.SQLiteConnection.RollBack">
  5574. <summary>
  5575. This event is raised whenever SQLite is rolling back a transaction.
  5576. </summary>
  5577. </member>
  5578. <member name="P:System.Data.SQLite.SQLiteConnection.DbProviderFactory">
  5579. <summary>
  5580. Returns the <see cref="T:System.Data.SQLite.SQLiteFactory" /> instance.
  5581. </summary>
  5582. </member>
  5583. <member name="T:System.Data.SQLite.SynchronizationModes">
  5584. <summary>
  5585. The I/O file cache flushing behavior for the connection
  5586. </summary>
  5587. </member>
  5588. <member name="F:System.Data.SQLite.SynchronizationModes.Normal">
  5589. <summary>
  5590. Normal file flushing at critical sections of the code
  5591. </summary>
  5592. </member>
  5593. <member name="F:System.Data.SQLite.SynchronizationModes.Full">
  5594. <summary>
  5595. Full file flushing after every write operation
  5596. </summary>
  5597. </member>
  5598. <member name="F:System.Data.SQLite.SynchronizationModes.Off">
  5599. <summary>
  5600. Use the default operating system's file flushing, SQLite does not explicitly flush the file buffers after writing
  5601. </summary>
  5602. </member>
  5603. <member name="T:System.Data.SQLite.SQLiteProgressEventHandler">
  5604. <summary>
  5605. Raised each time the number of virtual machine instructions is
  5606. approximately equal to the value of the
  5607. <see cref="P:System.Data.SQLite.SQLiteConnection.ProgressOps" /> property.
  5608. </summary>
  5609. <param name="sender">The connection performing the operation.</param>
  5610. <param name="e">A <see cref="T:System.Data.SQLite.ProgressEventArgs" /> that contains the
  5611. event data.</param>
  5612. </member>
  5613. <member name="T:System.Data.SQLite.SQLiteAuthorizerEventHandler">
  5614. <summary>
  5615. Raised when authorization is required to perform an action contained
  5616. within a SQL query.
  5617. </summary>
  5618. <param name="sender">The connection performing the action.</param>
  5619. <param name="e">A <see cref="T:System.Data.SQLite.AuthorizerEventArgs" /> that contains the
  5620. event data.</param>
  5621. </member>
  5622. <member name="T:System.Data.SQLite.SQLiteCommitHandler">
  5623. <summary>
  5624. Raised when a transaction is about to be committed. To roll back a transaction, set the
  5625. rollbackTrans boolean value to true.
  5626. </summary>
  5627. <param name="sender">The connection committing the transaction</param>
  5628. <param name="e">Event arguments on the transaction</param>
  5629. </member>
  5630. <member name="T:System.Data.SQLite.SQLiteUpdateEventHandler">
  5631. <summary>
  5632. Raised when data is inserted, updated and deleted on a given connection
  5633. </summary>
  5634. <param name="sender">The connection committing the transaction</param>
  5635. <param name="e">The event parameters which triggered the event</param>
  5636. </member>
  5637. <member name="T:System.Data.SQLite.SQLiteTraceEventHandler">
  5638. <summary>
  5639. Raised when a statement first begins executing on a given connection
  5640. </summary>
  5641. <param name="sender">The connection executing the statement</param>
  5642. <param name="e">Event arguments of the trace</param>
  5643. </member>
  5644. <member name="T:System.Data.SQLite.SQLiteBackupCallback">
  5645. <summary>
  5646. Raised between each backup step.
  5647. </summary>
  5648. <param name="source">
  5649. The source database connection.
  5650. </param>
  5651. <param name="sourceName">
  5652. The source database name.
  5653. </param>
  5654. <param name="destination">
  5655. The destination database connection.
  5656. </param>
  5657. <param name="destinationName">
  5658. The destination database name.
  5659. </param>
  5660. <param name="pages">
  5661. The number of pages copied with each step.
  5662. </param>
  5663. <param name="remainingPages">
  5664. The number of pages remaining to be copied.
  5665. </param>
  5666. <param name="totalPages">
  5667. The total number of pages in the source database.
  5668. </param>
  5669. <param name="retry">
  5670. Set to true if the operation needs to be retried due to database
  5671. locking issues; otherwise, set to false.
  5672. </param>
  5673. <returns>
  5674. True to continue with the backup process or false to halt the backup
  5675. process, rolling back any changes that have been made so far.
  5676. </returns>
  5677. </member>
  5678. <member name="T:System.Data.SQLite.ProgressEventArgs">
  5679. <summary>
  5680. The event data associated with progress reporting events.
  5681. </summary>
  5682. </member>
  5683. <member name="F:System.Data.SQLite.ProgressEventArgs.UserData">
  5684. <summary>
  5685. The user-defined native data associated with this event. Currently,
  5686. this will always contain the value of <see cref="F:System.IntPtr.Zero" />.
  5687. </summary>
  5688. </member>
  5689. <member name="F:System.Data.SQLite.ProgressEventArgs.ReturnCode">
  5690. <summary>
  5691. The return code for the current call into the progress callback.
  5692. </summary>
  5693. </member>
  5694. <member name="M:System.Data.SQLite.ProgressEventArgs.#ctor">
  5695. <summary>
  5696. Constructs an instance of this class with default property values.
  5697. </summary>
  5698. </member>
  5699. <member name="M:System.Data.SQLite.ProgressEventArgs.#ctor(System.IntPtr,System.Data.SQLite.SQLiteProgressReturnCode)">
  5700. <summary>
  5701. Constructs an instance of this class with specific property values.
  5702. </summary>
  5703. <param name="pUserData">
  5704. The user-defined native data associated with this event.
  5705. </param>
  5706. <param name="returnCode">
  5707. The progress return code.
  5708. </param>
  5709. </member>
  5710. <member name="T:System.Data.SQLite.AuthorizerEventArgs">
  5711. <summary>
  5712. The data associated with a call into the authorizer.
  5713. </summary>
  5714. </member>
  5715. <member name="F:System.Data.SQLite.AuthorizerEventArgs.UserData">
  5716. <summary>
  5717. The user-defined native data associated with this event. Currently,
  5718. this will always contain the value of <see cref="F:System.IntPtr.Zero" />.
  5719. </summary>
  5720. </member>
  5721. <member name="F:System.Data.SQLite.AuthorizerEventArgs.ActionCode">
  5722. <summary>
  5723. The action code responsible for the current call into the authorizer.
  5724. </summary>
  5725. </member>
  5726. <member name="F:System.Data.SQLite.AuthorizerEventArgs.Argument1">
  5727. <summary>
  5728. The first string argument for the current call into the authorizer.
  5729. The exact value will vary based on the action code, see the
  5730. <see cref="T:System.Data.SQLite.SQLiteAuthorizerActionCode" /> enumeration for possible
  5731. values.
  5732. </summary>
  5733. </member>
  5734. <member name="F:System.Data.SQLite.AuthorizerEventArgs.Argument2">
  5735. <summary>
  5736. The second string argument for the current call into the authorizer.
  5737. The exact value will vary based on the action code, see the
  5738. <see cref="T:System.Data.SQLite.SQLiteAuthorizerActionCode" /> enumeration for possible
  5739. values.
  5740. </summary>
  5741. </member>
  5742. <member name="F:System.Data.SQLite.AuthorizerEventArgs.Database">
  5743. <summary>
  5744. The database name for the current call into the authorizer, if
  5745. applicable.
  5746. </summary>
  5747. </member>
  5748. <member name="F:System.Data.SQLite.AuthorizerEventArgs.Context">
  5749. <summary>
  5750. The name of the inner-most trigger or view that is responsible for
  5751. the access attempt or a null value if this access attempt is directly
  5752. from top-level SQL code.
  5753. </summary>
  5754. </member>
  5755. <member name="F:System.Data.SQLite.AuthorizerEventArgs.ReturnCode">
  5756. <summary>
  5757. The return code for the current call into the authorizer.
  5758. </summary>
  5759. </member>
  5760. <member name="M:System.Data.SQLite.AuthorizerEventArgs.#ctor">
  5761. <summary>
  5762. Constructs an instance of this class with default property values.
  5763. </summary>
  5764. </member>
  5765. <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)">
  5766. <summary>
  5767. Constructs an instance of this class with specific property values.
  5768. </summary>
  5769. <param name="pUserData">
  5770. The user-defined native data associated with this event.
  5771. </param>
  5772. <param name="actionCode">
  5773. The authorizer action code.
  5774. </param>
  5775. <param name="argument1">
  5776. The first authorizer argument.
  5777. </param>
  5778. <param name="argument2">
  5779. The second authorizer argument.
  5780. </param>
  5781. <param name="database">
  5782. The database name, if applicable.
  5783. </param>
  5784. <param name="context">
  5785. The name of the inner-most trigger or view that is responsible for
  5786. the access attempt or a null value if this access attempt is directly
  5787. from top-level SQL code.
  5788. </param>
  5789. <param name="returnCode">
  5790. The authorizer return code.
  5791. </param>
  5792. </member>
  5793. <member name="T:System.Data.SQLite.UpdateEventType">
  5794. <summary>
  5795. Whenever an update event is triggered on a connection, this enum will indicate
  5796. exactly what type of operation is being performed.
  5797. </summary>
  5798. </member>
  5799. <member name="F:System.Data.SQLite.UpdateEventType.Delete">
  5800. <summary>
  5801. A row is being deleted from the given database and table
  5802. </summary>
  5803. </member>
  5804. <member name="F:System.Data.SQLite.UpdateEventType.Insert">
  5805. <summary>
  5806. A row is being inserted into the table.
  5807. </summary>
  5808. </member>
  5809. <member name="F:System.Data.SQLite.UpdateEventType.Update">
  5810. <summary>
  5811. A row is being updated in the table.
  5812. </summary>
  5813. </member>
  5814. <member name="T:System.Data.SQLite.UpdateEventArgs">
  5815. <summary>
  5816. Passed during an Update callback, these event arguments detail the type of update operation being performed
  5817. on the given connection.
  5818. </summary>
  5819. </member>
  5820. <member name="F:System.Data.SQLite.UpdateEventArgs.Database">
  5821. <summary>
  5822. The name of the database being updated (usually "main" but can be any attached or temporary database)
  5823. </summary>
  5824. </member>
  5825. <member name="F:System.Data.SQLite.UpdateEventArgs.Table">
  5826. <summary>
  5827. The name of the table being updated
  5828. </summary>
  5829. </member>
  5830. <member name="F:System.Data.SQLite.UpdateEventArgs.Event">
  5831. <summary>
  5832. The type of update being performed (insert/update/delete)
  5833. </summary>
  5834. </member>
  5835. <member name="F:System.Data.SQLite.UpdateEventArgs.RowId">
  5836. <summary>
  5837. The RowId affected by this update.
  5838. </summary>
  5839. </member>
  5840. <member name="T:System.Data.SQLite.CommitEventArgs">
  5841. <summary>
  5842. Event arguments raised when a transaction is being committed
  5843. </summary>
  5844. </member>
  5845. <member name="F:System.Data.SQLite.CommitEventArgs.AbortTransaction">
  5846. <summary>
  5847. Set to true to abort the transaction and trigger a rollback
  5848. </summary>
  5849. </member>
  5850. <member name="T:System.Data.SQLite.TraceEventArgs">
  5851. <summary>
  5852. Passed during an Trace callback, these event arguments contain the UTF-8 rendering of the SQL statement text
  5853. </summary>
  5854. </member>
  5855. <member name="F:System.Data.SQLite.TraceEventArgs.Statement">
  5856. <summary>
  5857. SQL statement text as the statement first begins executing
  5858. </summary>
  5859. </member>
  5860. <member name="T:System.Data.SQLite.ISQLiteConnectionPool">
  5861. <summary>
  5862. This interface represents a custom connection pool implementation
  5863. usable by System.Data.SQLite.
  5864. </summary>
  5865. </member>
  5866. <member name="M:System.Data.SQLite.ISQLiteConnectionPool.GetCounts(System.String,System.Collections.Generic.Dictionary{System.String,System.Int32}@,System.Int32@,System.Int32@,System.Int32@)">
  5867. <summary>
  5868. Counts the number of pool entries matching the specified file name.
  5869. </summary>
  5870. <param name="fileName">
  5871. The file name to match or null to match all files.
  5872. </param>
  5873. <param name="counts">
  5874. The pool entry counts for each matching file.
  5875. </param>
  5876. <param name="openCount">
  5877. The total number of connections successfully opened from any pool.
  5878. </param>
  5879. <param name="closeCount">
  5880. The total number of connections successfully closed from any pool.
  5881. </param>
  5882. <param name="totalCount">
  5883. The total number of pool entries for all matching files.
  5884. </param>
  5885. </member>
  5886. <member name="M:System.Data.SQLite.ISQLiteConnectionPool.ClearPool(System.String)">
  5887. <summary>
  5888. Disposes of all pooled connections associated with the specified
  5889. database file name.
  5890. </summary>
  5891. <param name="fileName">
  5892. The database file name.
  5893. </param>
  5894. </member>
  5895. <member name="M:System.Data.SQLite.ISQLiteConnectionPool.ClearAllPools">
  5896. <summary>
  5897. Disposes of all pooled connections.
  5898. </summary>
  5899. </member>
  5900. <member name="M:System.Data.SQLite.ISQLiteConnectionPool.Add(System.String,System.Object,System.Int32)">
  5901. <summary>
  5902. Adds a connection to the pool of those associated with the
  5903. specified database file name.
  5904. </summary>
  5905. <param name="fileName">
  5906. The database file name.
  5907. </param>
  5908. <param name="handle">
  5909. The database connection handle.
  5910. </param>
  5911. <param name="version">
  5912. The connection pool version at the point the database connection
  5913. handle was received from the connection pool. This is also the
  5914. connection pool version that the database connection handle was
  5915. created under.
  5916. </param>
  5917. </member>
  5918. <member name="M:System.Data.SQLite.ISQLiteConnectionPool.Remove(System.String,System.Int32,System.Int32@)">
  5919. <summary>
  5920. Removes a connection from the pool of those associated with the
  5921. specified database file name with the intent of using it to
  5922. interact with the database.
  5923. </summary>
  5924. <param name="fileName">
  5925. The database file name.
  5926. </param>
  5927. <param name="maxPoolSize">
  5928. The new maximum size of the connection pool for the specified
  5929. database file name.
  5930. </param>
  5931. <param name="version">
  5932. The connection pool version associated with the returned database
  5933. connection handle, if any.
  5934. </param>
  5935. <returns>
  5936. The database connection handle associated with the specified
  5937. database file name or null if it cannot be obtained.
  5938. </returns>
  5939. </member>
  5940. <member name="T:System.Data.SQLite.SQLiteConnectionPool">
  5941. <summary>
  5942. This default method implementations in this class should not be used by
  5943. applications that make use of COM (either directly or indirectly) due
  5944. to possible deadlocks that can occur during finalization of some COM
  5945. objects.
  5946. </summary>
  5947. </member>
  5948. <member name="T:System.Data.SQLite.SQLiteConnectionPool.PoolQueue">
  5949. <summary>
  5950. Keeps track of connections made on a specified file. The PoolVersion
  5951. dictates whether old objects get returned to the pool or discarded
  5952. when no longer in use.
  5953. </summary>
  5954. </member>
  5955. <member name="F:System.Data.SQLite.SQLiteConnectionPool.PoolQueue.Queue">
  5956. <summary>
  5957. The queue of weak references to the actual database connection
  5958. handles.
  5959. </summary>
  5960. </member>
  5961. <member name="F:System.Data.SQLite.SQLiteConnectionPool.PoolQueue.PoolVersion">
  5962. <summary>
  5963. This pool version associated with the database connection
  5964. handles in this pool queue.
  5965. </summary>
  5966. </member>
  5967. <member name="F:System.Data.SQLite.SQLiteConnectionPool.PoolQueue.MaxPoolSize">
  5968. <summary>
  5969. The maximum size of this pool queue.
  5970. </summary>
  5971. </member>
  5972. <member name="M:System.Data.SQLite.SQLiteConnectionPool.PoolQueue.#ctor(System.Int32,System.Int32)">
  5973. <summary>
  5974. Constructs a connection pool queue using the specified version
  5975. and maximum size. Normally, all the database connection
  5976. handles in this pool are associated with a single database file
  5977. name.
  5978. </summary>
  5979. <param name="version">
  5980. The initial pool version for this connection pool queue.
  5981. </param>
  5982. <param name="maxSize">
  5983. The initial maximum size for this connection pool queue.
  5984. </param>
  5985. </member>
  5986. <member name="F:System.Data.SQLite.SQLiteConnectionPool._syncRoot">
  5987. <summary>
  5988. This field is used to synchronize access to the private static data
  5989. in this class.
  5990. </summary>
  5991. </member>
  5992. <member name="F:System.Data.SQLite.SQLiteConnectionPool._connectionPool">
  5993. <summary>
  5994. When this field is non-null, it will be used to provide the
  5995. implementation of all the connection pool methods; otherwise,
  5996. the default method implementations will be used.
  5997. </summary>
  5998. </member>
  5999. <member name="F:System.Data.SQLite.SQLiteConnectionPool._queueList">
  6000. <summary>
  6001. The dictionary of connection pools, based on the normalized file
  6002. name of the SQLite database.
  6003. </summary>
  6004. </member>
  6005. <member name="F:System.Data.SQLite.SQLiteConnectionPool._poolVersion">
  6006. <summary>
  6007. The default version number new pools will get.
  6008. </summary>
  6009. </member>
  6010. <member name="F:System.Data.SQLite.SQLiteConnectionPool._poolOpened">
  6011. <summary>
  6012. The number of connections successfully opened from any pool.
  6013. This value is incremented by the Remove method.
  6014. </summary>
  6015. </member>
  6016. <member name="F:System.Data.SQLite.SQLiteConnectionPool._poolClosed">
  6017. <summary>
  6018. The number of connections successfully closed from any pool.
  6019. This value is incremented by the Add method.
  6020. </summary>
  6021. </member>
  6022. <member name="M:System.Data.SQLite.SQLiteConnectionPool.GetCounts(System.String,System.Collections.Generic.Dictionary{System.String,System.Int32}@,System.Int32@,System.Int32@,System.Int32@)">
  6023. <summary>
  6024. Counts the number of pool entries matching the specified file name.
  6025. </summary>
  6026. <param name="fileName">
  6027. The file name to match or null to match all files.
  6028. </param>
  6029. <param name="counts">
  6030. The pool entry counts for each matching file.
  6031. </param>
  6032. <param name="openCount">
  6033. The total number of connections successfully opened from any pool.
  6034. </param>
  6035. <param name="closeCount">
  6036. The total number of connections successfully closed from any pool.
  6037. </param>
  6038. <param name="totalCount">
  6039. The total number of pool entries for all matching files.
  6040. </param>
  6041. </member>
  6042. <member name="M:System.Data.SQLite.SQLiteConnectionPool.ClearPool(System.String)">
  6043. <summary>
  6044. Disposes of all pooled connections associated with the specified
  6045. database file name.
  6046. </summary>
  6047. <param name="fileName">
  6048. The database file name.
  6049. </param>
  6050. </member>
  6051. <member name="M:System.Data.SQLite.SQLiteConnectionPool.ClearAllPools">
  6052. <summary>
  6053. Disposes of all pooled connections.
  6054. </summary>
  6055. </member>
  6056. <member name="M:System.Data.SQLite.SQLiteConnectionPool.Add(System.String,System.Data.SQLite.SQLiteConnectionHandle,System.Int32)">
  6057. <summary>
  6058. Adds a connection to the pool of those associated with the
  6059. specified database file name.
  6060. </summary>
  6061. <param name="fileName">
  6062. The database file name.
  6063. </param>
  6064. <param name="handle">
  6065. The database connection handle.
  6066. </param>
  6067. <param name="version">
  6068. The connection pool version at the point the database connection
  6069. handle was received from the connection pool. This is also the
  6070. connection pool version that the database connection handle was
  6071. created under.
  6072. </param>
  6073. </member>
  6074. <member name="M:System.Data.SQLite.SQLiteConnectionPool.Remove(System.String,System.Int32,System.Int32@)">
  6075. <summary>
  6076. Removes a connection from the pool of those associated with the
  6077. specified database file name with the intent of using it to
  6078. interact with the database.
  6079. </summary>
  6080. <param name="fileName">
  6081. The database file name.
  6082. </param>
  6083. <param name="maxPoolSize">
  6084. The new maximum size of the connection pool for the specified
  6085. database file name.
  6086. </param>
  6087. <param name="version">
  6088. The connection pool version associated with the returned database
  6089. connection handle, if any.
  6090. </param>
  6091. <returns>
  6092. The database connection handle associated with the specified
  6093. database file name or null if it cannot be obtained.
  6094. </returns>
  6095. </member>
  6096. <member name="M:System.Data.SQLite.SQLiteConnectionPool.GetConnectionPool">
  6097. <summary>
  6098. This method is used to obtain a reference to the custom connection
  6099. pool implementation currently in use, if any.
  6100. </summary>
  6101. <returns>
  6102. The custom connection pool implementation or null if the default
  6103. connection pool implementation should be used.
  6104. </returns>
  6105. </member>
  6106. <member name="M:System.Data.SQLite.SQLiteConnectionPool.SetConnectionPool(System.Data.SQLite.ISQLiteConnectionPool)">
  6107. <summary>
  6108. This method is used to set the reference to the custom connection
  6109. pool implementation to use, if any.
  6110. </summary>
  6111. <param name="connectionPool">
  6112. The custom connection pool implementation to use or null if the
  6113. default connection pool implementation should be used.
  6114. </param>
  6115. </member>
  6116. <member name="M:System.Data.SQLite.SQLiteConnectionPool.ResizePool(System.Data.SQLite.SQLiteConnectionPool.PoolQueue,System.Boolean)">
  6117. <summary>
  6118. We do not have to thread-lock anything in this function, because it
  6119. is only called by other functions above which already take the lock.
  6120. </summary>
  6121. <param name="queue">
  6122. The pool queue to resize.
  6123. </param>
  6124. <param name="add">
  6125. If a function intends to add to the pool, this is true, which
  6126. forces the resize to take one more than it needs from the pool.
  6127. </param>
  6128. </member>
  6129. <member name="T:System.Data.SQLite.SQLiteConnectionStringBuilder">
  6130. <summary>
  6131. SQLite implementation of DbConnectionStringBuilder.
  6132. </summary>
  6133. </member>
  6134. <member name="F:System.Data.SQLite.SQLiteConnectionStringBuilder._properties">
  6135. <summary>
  6136. Properties of this class
  6137. </summary>
  6138. </member>
  6139. <member name="M:System.Data.SQLite.SQLiteConnectionStringBuilder.#ctor">
  6140. <overloads>
  6141. Constructs a new instance of the class
  6142. </overloads>
  6143. <summary>
  6144. Default constructor
  6145. </summary>
  6146. </member>
  6147. <member name="M:System.Data.SQLite.SQLiteConnectionStringBuilder.#ctor(System.String)">
  6148. <summary>
  6149. Constructs a new instance of the class using the specified connection string.
  6150. </summary>
  6151. <param name="connectionString">The connection string to parse</param>
  6152. </member>
  6153. <member name="M:System.Data.SQLite.SQLiteConnectionStringBuilder.Initialize(System.String)">
  6154. <summary>
  6155. Private initializer, which assigns the connection string and resets the builder
  6156. </summary>
  6157. <param name="cnnString">The connection string to assign</param>
  6158. </member>
  6159. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.Version">
  6160. <summary>
  6161. 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.
  6162. </summary>
  6163. </member>
  6164. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.SyncMode">
  6165. <summary>
  6166. Gets/Sets the synchronization mode (file flushing) of the connection string. Default is "Normal".
  6167. </summary>
  6168. </member>
  6169. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.UseUTF16Encoding">
  6170. <summary>
  6171. Gets/Sets the encoding for the connection string. The default is "False" which indicates UTF-8 encoding.
  6172. </summary>
  6173. </member>
  6174. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.Pooling">
  6175. <summary>
  6176. Gets/Sets whether or not to use connection pooling. The default is "False"
  6177. </summary>
  6178. </member>
  6179. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.BinaryGUID">
  6180. <summary>
  6181. Gets/Sets whethor not to store GUID's in binary format. The default is True
  6182. which saves space in the database.
  6183. </summary>
  6184. </member>
  6185. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.DataSource">
  6186. <summary>
  6187. Gets/Sets the filename to open on the connection string.
  6188. </summary>
  6189. </member>
  6190. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.Uri">
  6191. <summary>
  6192. An alternate to the data source property
  6193. </summary>
  6194. </member>
  6195. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.FullUri">
  6196. <summary>
  6197. An alternate to the data source property that uses the SQLite URI syntax.
  6198. </summary>
  6199. </member>
  6200. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.DefaultTimeout">
  6201. <summary>
  6202. Gets/sets the default command timeout for newly-created commands. This is especially useful for
  6203. commands used internally such as inside a SQLiteTransaction, where setting the timeout is not possible.
  6204. </summary>
  6205. </member>
  6206. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.BusyTimeout">
  6207. <summary>
  6208. Gets/sets the busy timeout to use with the SQLite core library.
  6209. </summary>
  6210. </member>
  6211. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.WaitTimeout">
  6212. <summary>
  6213. <b>EXPERIMENTAL</b> --
  6214. The wait timeout to use with
  6215. <see cref="M:System.Data.SQLite.SQLiteConnection.WaitForEnlistmentReset(System.Int32,System.Nullable{System.Boolean})" /> method.
  6216. This is only used when waiting for the enlistment to be reset
  6217. prior to enlisting in a transaction, and then only when the
  6218. appropriate connection flag is set.
  6219. </summary>
  6220. </member>
  6221. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.PrepareRetries">
  6222. <summary>
  6223. Gets/sets the maximum number of retries when preparing SQL to be executed.
  6224. This normally only applies to preparation errors resulting from the database
  6225. schema being changed.
  6226. </summary>
  6227. </member>
  6228. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.ProgressOps">
  6229. <summary>
  6230. Gets/sets the approximate number of virtual machine instructions between
  6231. progress events. In order for progress events to actually fire, the event
  6232. handler must be added to the <see cref="E:System.Data.SQLite.SQLiteConnection.Progress" /> event
  6233. as well.
  6234. </summary>
  6235. </member>
  6236. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.Enlist">
  6237. <summary>
  6238. Determines whether or not the connection will automatically participate
  6239. in the current distributed transaction (if one exists)
  6240. </summary>
  6241. </member>
  6242. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.FailIfMissing">
  6243. <summary>
  6244. If set to true, will throw an exception if the database specified in the connection
  6245. string does not exist. If false, the database will be created automatically.
  6246. </summary>
  6247. </member>
  6248. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.LegacyFormat">
  6249. <summary>
  6250. If enabled, uses the legacy 3.xx format for maximum compatibility, but results in larger
  6251. database sizes.
  6252. </summary>
  6253. </member>
  6254. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.ReadOnly">
  6255. <summary>
  6256. When enabled, the database will be opened for read-only access and writing will be disabled.
  6257. </summary>
  6258. </member>
  6259. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.Password">
  6260. <summary>
  6261. Gets/sets the database encryption password
  6262. </summary>
  6263. </member>
  6264. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.HexPassword">
  6265. <summary>
  6266. Gets/sets the database encryption hexadecimal password
  6267. </summary>
  6268. </member>
  6269. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.PageSize">
  6270. <summary>
  6271. Gets/Sets the page size for the connection.
  6272. </summary>
  6273. </member>
  6274. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.MaxPageCount">
  6275. <summary>
  6276. Gets/Sets the maximum number of pages the database may hold
  6277. </summary>
  6278. </member>
  6279. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.CacheSize">
  6280. <summary>
  6281. Gets/Sets the cache size for the connection.
  6282. </summary>
  6283. </member>
  6284. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.DateTimeFormat">
  6285. <summary>
  6286. Gets/Sets the DateTime format for the connection.
  6287. </summary>
  6288. </member>
  6289. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.DateTimeKind">
  6290. <summary>
  6291. Gets/Sets the DateTime kind for the connection.
  6292. </summary>
  6293. </member>
  6294. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.DateTimeFormatString">
  6295. <summary>
  6296. Gets/sets the DateTime format string used for formatting
  6297. and parsing purposes.
  6298. </summary>
  6299. </member>
  6300. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.BaseSchemaName">
  6301. <summary>
  6302. Gets/Sets the placeholder base schema name used for
  6303. .NET Framework compatibility purposes.
  6304. </summary>
  6305. </member>
  6306. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.JournalMode">
  6307. <summary>
  6308. Determines how SQLite handles the transaction journal file.
  6309. </summary>
  6310. </member>
  6311. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.DefaultIsolationLevel">
  6312. <summary>
  6313. Sets the default isolation level for transactions on the connection.
  6314. </summary>
  6315. </member>
  6316. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.DefaultDbType">
  6317. <summary>
  6318. Gets/sets the default database type for the connection.
  6319. </summary>
  6320. </member>
  6321. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.DefaultTypeName">
  6322. <summary>
  6323. Gets/sets the default type name for the connection.
  6324. </summary>
  6325. </member>
  6326. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.VfsName">
  6327. <summary>
  6328. Gets/sets the VFS name for the connection.
  6329. </summary>
  6330. </member>
  6331. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.ForeignKeys">
  6332. <summary>
  6333. If enabled, use foreign key constraints
  6334. </summary>
  6335. </member>
  6336. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.RecursiveTriggers">
  6337. <summary>
  6338. Enable or disable the recursive trigger capability.
  6339. </summary>
  6340. </member>
  6341. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.ZipVfsVersion">
  6342. <summary>
  6343. If non-null, this is the version of ZipVFS to use. This requires the
  6344. System.Data.SQLite interop assembly -AND- primary managed assembly to
  6345. be compiled with the INTEROP_INCLUDE_ZIPVFS option; otherwise, this
  6346. property does nothing.
  6347. </summary>
  6348. </member>
  6349. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.Flags">
  6350. <summary>
  6351. Gets/Sets the extra behavioral flags.
  6352. </summary>
  6353. </member>
  6354. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.SetDefaults">
  6355. <summary>
  6356. If enabled, apply the default connection settings to opened databases.
  6357. </summary>
  6358. </member>
  6359. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.ToFullPath">
  6360. <summary>
  6361. If enabled, attempt to resolve the provided data source file name to a
  6362. full path before opening.
  6363. </summary>
  6364. </member>
  6365. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.NoDefaultFlags">
  6366. <summary>
  6367. If enabled, skip using the configured default connection flags.
  6368. </summary>
  6369. </member>
  6370. <member name="P:System.Data.SQLite.SQLiteConnectionStringBuilder.NoSharedFlags">
  6371. <summary>
  6372. If enabled, skip using the configured shared connection flags.
  6373. </summary>
  6374. </member>
  6375. <member name="M:System.Data.SQLite.SQLiteConnectionStringBuilder.TryGetValue(System.String,System.Object@)">
  6376. <summary>
  6377. Helper function for retrieving values from the connectionstring
  6378. </summary>
  6379. <param name="keyword">The keyword to retrieve settings for</param>
  6380. <param name="value">The resulting parameter value</param>
  6381. <returns>Returns true if the value was found and returned</returns>
  6382. </member>
  6383. <member name="M:System.Data.SQLite.SQLiteConnectionStringBuilder.FallbackGetProperties(System.Collections.Hashtable)">
  6384. <summary>
  6385. Fallback method for MONO, which doesn't implement DbConnectionStringBuilder.GetProperties()
  6386. </summary>
  6387. <param name="propertyList">The hashtable to fill with property descriptors</param>
  6388. </member>
  6389. <member name="T:System.Data.SQLite.SQLiteConvert">
  6390. <summary>
  6391. This base class provides datatype conversion services for the SQLite provider.
  6392. </summary>
  6393. </member>
  6394. <member name="F:System.Data.SQLite.SQLiteConvert.EscapeChar">
  6395. <summary>
  6396. This character is used to escape other characters, including itself, in
  6397. connection string property names and values.
  6398. </summary>
  6399. </member>
  6400. <member name="F:System.Data.SQLite.SQLiteConvert.QuoteChar">
  6401. <summary>
  6402. This character can be used to wrap connection string property names and
  6403. values. Normally, it is optional; however, when used, it must be the
  6404. first -AND- last character of that connection string property name -OR-
  6405. value.
  6406. </summary>
  6407. </member>
  6408. <member name="F:System.Data.SQLite.SQLiteConvert.AltQuoteChar">
  6409. <summary>
  6410. This character can be used to wrap connection string property names and
  6411. values. Normally, it is optional; however, when used, it must be the
  6412. first -AND- last character of that connection string property name -OR-
  6413. value.
  6414. </summary>
  6415. </member>
  6416. <member name="F:System.Data.SQLite.SQLiteConvert.ValueChar">
  6417. <summary>
  6418. The character is used to separate the name and value for a connection
  6419. string property. This character cannot be present in any connection
  6420. string property name. This character can be present in a connection
  6421. string property value; however, this should be avoided unless deemed
  6422. absolutely necessary.
  6423. </summary>
  6424. </member>
  6425. <member name="F:System.Data.SQLite.SQLiteConvert.PairChar">
  6426. <summary>
  6427. This character is used to separate connection string properties. When
  6428. the "No_SQLiteConnectionNewParser" setting is enabled, this character
  6429. may not appear in connection string property names -OR- values.
  6430. </summary>
  6431. </member>
  6432. <member name="F:System.Data.SQLite.SQLiteConvert.SpecialChars">
  6433. <summary>
  6434. These are the characters that are special to the connection string
  6435. parser.
  6436. </summary>
  6437. </member>
  6438. <member name="F:System.Data.SQLite.SQLiteConvert.FallbackDefaultDbType">
  6439. <summary>
  6440. The fallback default database type when one cannot be obtained from an
  6441. existing connection instance.
  6442. </summary>
  6443. </member>
  6444. <member name="F:System.Data.SQLite.SQLiteConvert.FallbackDefaultTypeName">
  6445. <summary>
  6446. The fallback default database type name when one cannot be obtained from
  6447. an existing connection instance.
  6448. </summary>
  6449. </member>
  6450. <member name="F:System.Data.SQLite.SQLiteConvert.UnixEpoch">
  6451. <summary>
  6452. The value for the Unix epoch (e.g. January 1, 1970 at midnight, in UTC).
  6453. </summary>
  6454. </member>
  6455. <member name="F:System.Data.SQLite.SQLiteConvert.OleAutomationEpochAsJulianDay">
  6456. <summary>
  6457. The value of the OLE Automation epoch represented as a Julian day. This
  6458. field cannot be removed as the test suite relies upon it.
  6459. </summary>
  6460. </member>
  6461. <member name="F:System.Data.SQLite.SQLiteConvert.FullFormat">
  6462. <summary>
  6463. The format string for DateTime values when using the InvariantCulture or CurrentCulture formats.
  6464. </summary>
  6465. </member>
  6466. <member name="F:System.Data.SQLite.SQLiteConvert.MinimumJd">
  6467. <summary>
  6468. This is the minimum Julian Day value supported by this library
  6469. (148731163200000).
  6470. </summary>
  6471. </member>
  6472. <member name="F:System.Data.SQLite.SQLiteConvert.MaximumJd">
  6473. <summary>
  6474. This is the maximum Julian Day value supported by this library
  6475. (464269060799000).
  6476. </summary>
  6477. </member>
  6478. <member name="F:System.Data.SQLite.SQLiteConvert._datetimeFormats">
  6479. <summary>
  6480. An array of ISO-8601 DateTime formats that we support parsing.
  6481. </summary>
  6482. </member>
  6483. <member name="F:System.Data.SQLite.SQLiteConvert._datetimeFormatUtc">
  6484. <summary>
  6485. The internal default format for UTC DateTime values when converting
  6486. to a string.
  6487. </summary>
  6488. </member>
  6489. <member name="F:System.Data.SQLite.SQLiteConvert._datetimeFormatLocal">
  6490. <summary>
  6491. The internal default format for local DateTime values when converting
  6492. to a string.
  6493. </summary>
  6494. </member>
  6495. <member name="F:System.Data.SQLite.SQLiteConvert._utf8">
  6496. <summary>
  6497. An UTF-8 Encoding instance, so we can convert strings to and from UTF-8
  6498. </summary>
  6499. </member>
  6500. <member name="F:System.Data.SQLite.SQLiteConvert._datetimeFormat">
  6501. <summary>
  6502. The default DateTime format for this instance.
  6503. </summary>
  6504. </member>
  6505. <member name="F:System.Data.SQLite.SQLiteConvert._datetimeKind">
  6506. <summary>
  6507. The default DateTimeKind for this instance.
  6508. </summary>
  6509. </member>
  6510. <member name="F:System.Data.SQLite.SQLiteConvert._datetimeFormatString">
  6511. <summary>
  6512. The default DateTime format string for this instance.
  6513. </summary>
  6514. </member>
  6515. <member name="M:System.Data.SQLite.SQLiteConvert.#ctor(System.Data.SQLite.SQLiteDateFormats,System.DateTimeKind,System.String)">
  6516. <summary>
  6517. Initializes the conversion class
  6518. </summary>
  6519. <param name="fmt">The default date/time format to use for this instance</param>
  6520. <param name="kind">The DateTimeKind to use.</param>
  6521. <param name="fmtString">The DateTime format string to use.</param>
  6522. </member>
  6523. <member name="M:System.Data.SQLite.SQLiteConvert.ToUTF8(System.String)">
  6524. <summary>
  6525. Converts a string to a UTF-8 encoded byte array sized to include a null-terminating character.
  6526. </summary>
  6527. <param name="sourceText">The string to convert to UTF-8</param>
  6528. <returns>A byte array containing the converted string plus an extra 0 terminating byte at the end of the array.</returns>
  6529. </member>
  6530. <member name="M:System.Data.SQLite.SQLiteConvert.ToUTF8(System.DateTime)">
  6531. <summary>
  6532. Convert a DateTime to a UTF-8 encoded, zero-terminated byte array.
  6533. </summary>
  6534. <remarks>
  6535. This function is a convenience function, which first calls ToString() on the DateTime, and then calls ToUTF8() with the
  6536. string result.
  6537. </remarks>
  6538. <param name="dateTimeValue">The DateTime to convert.</param>
  6539. <returns>The UTF-8 encoded string, including a 0 terminating byte at the end of the array.</returns>
  6540. </member>
  6541. <member name="M:System.Data.SQLite.SQLiteConvert.ToString(System.IntPtr,System.Int32)">
  6542. <summary>
  6543. Converts a UTF-8 encoded IntPtr of the specified length into a .NET string
  6544. </summary>
  6545. <param name="nativestring">The pointer to the memory where the UTF-8 string is encoded</param>
  6546. <param name="nativestringlen">The number of bytes to decode</param>
  6547. <returns>A string containing the translated character(s)</returns>
  6548. </member>
  6549. <member name="M:System.Data.SQLite.SQLiteConvert.UTF8ToString(System.IntPtr,System.Int32)">
  6550. <summary>
  6551. Converts a UTF-8 encoded IntPtr of the specified length into a .NET string
  6552. </summary>
  6553. <param name="nativestring">The pointer to the memory where the UTF-8 string is encoded</param>
  6554. <param name="nativestringlen">The number of bytes to decode</param>
  6555. <returns>A string containing the translated character(s)</returns>
  6556. </member>
  6557. <member name="M:System.Data.SQLite.SQLiteConvert.isValidJd(System.Int64)">
  6558. <summary>
  6559. Checks if the specified <see cref="T:System.Int64" /> is within the
  6560. supported range for a Julian Day value.
  6561. </summary>
  6562. <param name="jd">
  6563. The Julian Day value to check.
  6564. </param>
  6565. <returns>
  6566. Non-zero if the specified Julian Day value is in the supported
  6567. range; otherwise, zero.
  6568. </returns>
  6569. </member>
  6570. <member name="M:System.Data.SQLite.SQLiteConvert.DoubleToJd(System.Double)">
  6571. <summary>
  6572. Converts a Julian Day value from a <see cref="T:System.Double" /> to an
  6573. <see cref="T:System.Int64" />.
  6574. </summary>
  6575. <param name="julianDay">
  6576. The Julian Day <see cref="T:System.Double" /> value to convert.
  6577. </param>
  6578. <returns>
  6579. The resulting Julian Day <see cref="T:System.Int64" /> value.
  6580. </returns>
  6581. </member>
  6582. <member name="M:System.Data.SQLite.SQLiteConvert.JdToDouble(System.Int64)">
  6583. <summary>
  6584. Converts a Julian Day value from an <see cref="T:System.Int64" /> to a
  6585. <see cref="T:System.Double" />.
  6586. </summary>
  6587. <param name="jd">
  6588. The Julian Day <see cref="T:System.Int64" /> value to convert.
  6589. </param>
  6590. <returns>
  6591. The resulting Julian Day <see cref="T:System.Double" /> value.
  6592. </returns>
  6593. </member>
  6594. <member name="M:System.Data.SQLite.SQLiteConvert.computeYMD(System.Int64,System.Nullable{System.DateTime})">
  6595. <summary>
  6596. Converts a Julian Day value to a <see cref="T:System.DateTime" />.
  6597. This method was translated from the "computeYMD" function in the
  6598. "date.c" file belonging to the SQLite core library.
  6599. </summary>
  6600. <param name="jd">
  6601. The Julian Day value to convert.
  6602. </param>
  6603. <param name="badValue">
  6604. The <see cref="T:System.DateTime" /> value to return in the event that the
  6605. Julian Day is out of the supported range. If this value is null,
  6606. an exception will be thrown instead.
  6607. </param>
  6608. <returns>
  6609. A <see cref="T:System.DateTime" /> value that contains the year, month, and
  6610. day values that are closest to the specified Julian Day value.
  6611. </returns>
  6612. </member>
  6613. <member name="M:System.Data.SQLite.SQLiteConvert.computeHMS(System.Int64,System.Nullable{System.DateTime})">
  6614. <summary>
  6615. Converts a Julian Day value to a <see cref="T:System.DateTime" />.
  6616. This method was translated from the "computeHMS" function in the
  6617. "date.c" file belonging to the SQLite core library.
  6618. </summary>
  6619. <param name="jd">
  6620. The Julian Day value to convert.
  6621. </param>
  6622. <param name="badValue">
  6623. The <see cref="T:System.DateTime" /> value to return in the event that the
  6624. Julian Day value is out of the supported range. If this value is
  6625. null, an exception will be thrown instead.
  6626. </param>
  6627. <returns>
  6628. A <see cref="T:System.DateTime" /> value that contains the hour, minute, and
  6629. second, and millisecond values that are closest to the specified
  6630. Julian Day value.
  6631. </returns>
  6632. </member>
  6633. <member name="M:System.Data.SQLite.SQLiteConvert.computeJD(System.DateTime)">
  6634. <summary>
  6635. Converts a <see cref="T:System.DateTime" /> to a Julian Day value.
  6636. This method was translated from the "computeJD" function in
  6637. the "date.c" file belonging to the SQLite core library.
  6638. Since the range of Julian Day values supported by this method
  6639. includes all possible (valid) values of a <see cref="T:System.DateTime" />
  6640. value, it should be extremely difficult for this method to
  6641. raise an exception or return an undefined result.
  6642. </summary>
  6643. <param name="dateTime">
  6644. The <see cref="T:System.DateTime" /> value to convert. This value
  6645. will be within the range of <see cref="F:System.DateTime.MinValue" />
  6646. (00:00:00.0000000, January 1, 0001) to
  6647. <see cref="F:System.DateTime.MaxValue" /> (23:59:59.9999999, December
  6648. 31, 9999).
  6649. </param>
  6650. <returns>
  6651. The nearest Julian Day value corresponding to the specified
  6652. <see cref="T:System.DateTime" /> value.
  6653. </returns>
  6654. </member>
  6655. <member name="M:System.Data.SQLite.SQLiteConvert.ToDateTime(System.String)">
  6656. <summary>
  6657. Converts a string into a DateTime, using the DateTimeFormat, DateTimeKind,
  6658. and DateTimeFormatString specified for the connection when it was opened.
  6659. </summary>
  6660. <remarks>
  6661. Acceptable ISO8601 DateTime formats are:
  6662. <list type="bullet">
  6663. <item><description>THHmmssK</description></item>
  6664. <item><description>THHmmK</description></item>
  6665. <item><description>HH:mm:ss.FFFFFFFK</description></item>
  6666. <item><description>HH:mm:ssK</description></item>
  6667. <item><description>HH:mmK</description></item>
  6668. <item><description>yyyy-MM-dd HH:mm:ss.FFFFFFFK</description></item>
  6669. <item><description>yyyy-MM-dd HH:mm:ssK</description></item>
  6670. <item><description>yyyy-MM-dd HH:mmK</description></item>
  6671. <item><description>yyyy-MM-ddTHH:mm:ss.FFFFFFFK</description></item>
  6672. <item><description>yyyy-MM-ddTHH:mmK</description></item>
  6673. <item><description>yyyy-MM-ddTHH:mm:ssK</description></item>
  6674. <item><description>yyyyMMddHHmmssK</description></item>
  6675. <item><description>yyyyMMddHHmmK</description></item>
  6676. <item><description>yyyyMMddTHHmmssFFFFFFFK</description></item>
  6677. <item><description>THHmmss</description></item>
  6678. <item><description>THHmm</description></item>
  6679. <item><description>HH:mm:ss.FFFFFFF</description></item>
  6680. <item><description>HH:mm:ss</description></item>
  6681. <item><description>HH:mm</description></item>
  6682. <item><description>yyyy-MM-dd HH:mm:ss.FFFFFFF</description></item>
  6683. <item><description>yyyy-MM-dd HH:mm:ss</description></item>
  6684. <item><description>yyyy-MM-dd HH:mm</description></item>
  6685. <item><description>yyyy-MM-ddTHH:mm:ss.FFFFFFF</description></item>
  6686. <item><description>yyyy-MM-ddTHH:mm</description></item>
  6687. <item><description>yyyy-MM-ddTHH:mm:ss</description></item>
  6688. <item><description>yyyyMMddHHmmss</description></item>
  6689. <item><description>yyyyMMddHHmm</description></item>
  6690. <item><description>yyyyMMddTHHmmssFFFFFFF</description></item>
  6691. <item><description>yyyy-MM-dd</description></item>
  6692. <item><description>yyyyMMdd</description></item>
  6693. <item><description>yy-MM-dd</description></item>
  6694. </list>
  6695. If the string cannot be matched to one of the above formats -OR-
  6696. the DateTimeFormatString if one was provided, an exception will
  6697. be thrown.
  6698. </remarks>
  6699. <param name="dateText">The string containing either a long integer number of 100-nanosecond units since
  6700. System.DateTime.MinValue, a Julian day double, an integer number of seconds since the Unix epoch, a
  6701. culture-independent formatted date and time string, a formatted date and time string in the current
  6702. culture, or an ISO8601-format string.</param>
  6703. <returns>A DateTime value</returns>
  6704. </member>
  6705. <member name="M:System.Data.SQLite.SQLiteConvert.ToDateTime(System.String,System.Data.SQLite.SQLiteDateFormats,System.DateTimeKind,System.String)">
  6706. <summary>
  6707. Converts a string into a DateTime, using the specified DateTimeFormat,
  6708. DateTimeKind and DateTimeFormatString.
  6709. </summary>
  6710. <remarks>
  6711. Acceptable ISO8601 DateTime formats are:
  6712. <list type="bullet">
  6713. <item><description>THHmmssK</description></item>
  6714. <item><description>THHmmK</description></item>
  6715. <item><description>HH:mm:ss.FFFFFFFK</description></item>
  6716. <item><description>HH:mm:ssK</description></item>
  6717. <item><description>HH:mmK</description></item>
  6718. <item><description>yyyy-MM-dd HH:mm:ss.FFFFFFFK</description></item>
  6719. <item><description>yyyy-MM-dd HH:mm:ssK</description></item>
  6720. <item><description>yyyy-MM-dd HH:mmK</description></item>
  6721. <item><description>yyyy-MM-ddTHH:mm:ss.FFFFFFFK</description></item>
  6722. <item><description>yyyy-MM-ddTHH:mmK</description></item>
  6723. <item><description>yyyy-MM-ddTHH:mm:ssK</description></item>
  6724. <item><description>yyyyMMddHHmmssK</description></item>
  6725. <item><description>yyyyMMddHHmmK</description></item>
  6726. <item><description>yyyyMMddTHHmmssFFFFFFFK</description></item>
  6727. <item><description>THHmmss</description></item>
  6728. <item><description>THHmm</description></item>
  6729. <item><description>HH:mm:ss.FFFFFFF</description></item>
  6730. <item><description>HH:mm:ss</description></item>
  6731. <item><description>HH:mm</description></item>
  6732. <item><description>yyyy-MM-dd HH:mm:ss.FFFFFFF</description></item>
  6733. <item><description>yyyy-MM-dd HH:mm:ss</description></item>
  6734. <item><description>yyyy-MM-dd HH:mm</description></item>
  6735. <item><description>yyyy-MM-ddTHH:mm:ss.FFFFFFF</description></item>
  6736. <item><description>yyyy-MM-ddTHH:mm</description></item>
  6737. <item><description>yyyy-MM-ddTHH:mm:ss</description></item>
  6738. <item><description>yyyyMMddHHmmss</description></item>
  6739. <item><description>yyyyMMddHHmm</description></item>
  6740. <item><description>yyyyMMddTHHmmssFFFFFFF</description></item>
  6741. <item><description>yyyy-MM-dd</description></item>
  6742. <item><description>yyyyMMdd</description></item>
  6743. <item><description>yy-MM-dd</description></item>
  6744. </list>
  6745. If the string cannot be matched to one of the above formats -OR-
  6746. the DateTimeFormatString if one was provided, an exception will
  6747. be thrown.
  6748. </remarks>
  6749. <param name="dateText">The string containing either a long integer number of 100-nanosecond units since
  6750. System.DateTime.MinValue, a Julian day double, an integer number of seconds since the Unix epoch, a
  6751. culture-independent formatted date and time string, a formatted date and time string in the current
  6752. culture, or an ISO8601-format string.</param>
  6753. <param name="format">The SQLiteDateFormats to use.</param>
  6754. <param name="kind">The DateTimeKind to use.</param>
  6755. <param name="formatString">The DateTime format string to use.</param>
  6756. <returns>A DateTime value</returns>
  6757. </member>
  6758. <member name="M:System.Data.SQLite.SQLiteConvert.ToDateTime(System.Double)">
  6759. <summary>
  6760. Converts a julianday value into a DateTime
  6761. </summary>
  6762. <param name="julianDay">The value to convert</param>
  6763. <returns>A .NET DateTime</returns>
  6764. </member>
  6765. <member name="M:System.Data.SQLite.SQLiteConvert.ToDateTime(System.Double,System.DateTimeKind)">
  6766. <summary>
  6767. Converts a julianday value into a DateTime
  6768. </summary>
  6769. <param name="julianDay">The value to convert</param>
  6770. <param name="kind">The DateTimeKind to use.</param>
  6771. <returns>A .NET DateTime</returns>
  6772. </member>
  6773. <member name="M:System.Data.SQLite.SQLiteConvert.UnixEpochToDateTime(System.Int64,System.DateTimeKind)">
  6774. <summary>
  6775. Converts the specified number of seconds from the Unix epoch into a
  6776. <see cref="T:System.DateTime" /> value.
  6777. </summary>
  6778. <param name="seconds">
  6779. The number of whole seconds since the Unix epoch.
  6780. </param>
  6781. <param name="kind">
  6782. Either Utc or Local time.
  6783. </param>
  6784. <returns>
  6785. The new <see cref="T:System.DateTime" /> value.
  6786. </returns>
  6787. </member>
  6788. <member name="M:System.Data.SQLite.SQLiteConvert.TicksToDateTime(System.Int64,System.DateTimeKind)">
  6789. <summary>
  6790. Converts the specified number of ticks since the epoch into a
  6791. <see cref="T:System.DateTime" /> value.
  6792. </summary>
  6793. <param name="ticks">
  6794. The number of whole ticks since the epoch.
  6795. </param>
  6796. <param name="kind">
  6797. Either Utc or Local time.
  6798. </param>
  6799. <returns>
  6800. The new <see cref="T:System.DateTime" /> value.
  6801. </returns>
  6802. </member>
  6803. <member name="M:System.Data.SQLite.SQLiteConvert.ToJulianDay(System.DateTime)">
  6804. <summary>
  6805. Converts a DateTime struct to a JulianDay double
  6806. </summary>
  6807. <param name="value">The DateTime to convert</param>
  6808. <returns>The JulianDay value the Datetime represents</returns>
  6809. </member>
  6810. <member name="M:System.Data.SQLite.SQLiteConvert.ToUnixEpoch(System.DateTime)">
  6811. <summary>
  6812. Converts a DateTime struct to the whole number of seconds since the
  6813. Unix epoch.
  6814. </summary>
  6815. <param name="value">The DateTime to convert</param>
  6816. <returns>The whole number of seconds since the Unix epoch</returns>
  6817. </member>
  6818. <member name="M:System.Data.SQLite.SQLiteConvert.GetDateTimeKindFormat(System.DateTimeKind,System.String)">
  6819. <summary>
  6820. Returns the DateTime format string to use for the specified DateTimeKind.
  6821. If <paramref name="formatString" /> is not null, it will be returned verbatim.
  6822. </summary>
  6823. <param name="kind">The DateTimeKind to use.</param>
  6824. <param name="formatString">The DateTime format string to use.</param>
  6825. <returns>
  6826. The DateTime format string to use for the specified DateTimeKind.
  6827. </returns>
  6828. </member>
  6829. <member name="M:System.Data.SQLite.SQLiteConvert.ToString(System.DateTime)">
  6830. <summary>
  6831. Converts a string into a DateTime, using the DateTimeFormat, DateTimeKind,
  6832. and DateTimeFormatString specified for the connection when it was opened.
  6833. </summary>
  6834. <param name="dateValue">The DateTime value to convert</param>
  6835. <returns>Either a string containing the long integer number of 100-nanosecond units since System.DateTime.MinValue, a
  6836. Julian day double, an integer number of seconds since the Unix epoch, a culture-independent formatted date and time
  6837. string, a formatted date and time string in the current culture, or an ISO8601-format date/time string.</returns>
  6838. </member>
  6839. <member name="M:System.Data.SQLite.SQLiteConvert.ToString(System.DateTime,System.Data.SQLite.SQLiteDateFormats,System.DateTimeKind,System.String)">
  6840. <summary>
  6841. Converts a string into a DateTime, using the DateTimeFormat, DateTimeKind,
  6842. and DateTimeFormatString specified for the connection when it was opened.
  6843. </summary>
  6844. <param name="dateValue">The DateTime value to convert</param>
  6845. <param name="format">The SQLiteDateFormats to use.</param>
  6846. <param name="kind">The DateTimeKind to use.</param>
  6847. <param name="formatString">The DateTime format string to use.</param>
  6848. <returns>Either a string containing the long integer number of 100-nanosecond units since System.DateTime.MinValue, a
  6849. Julian day double, an integer number of seconds since the Unix epoch, a culture-independent formatted date and time
  6850. string, a formatted date and time string in the current culture, or an ISO8601-format date/time string.</returns>
  6851. </member>
  6852. <member name="M:System.Data.SQLite.SQLiteConvert.ToDateTime(System.IntPtr,System.Int32)">
  6853. <summary>
  6854. Internal function to convert a UTF-8 encoded IntPtr of the specified length to a DateTime.
  6855. </summary>
  6856. <remarks>
  6857. This is a convenience function, which first calls ToString() on the IntPtr to convert it to a string, then calls
  6858. ToDateTime() on the string to return a DateTime.
  6859. </remarks>
  6860. <param name="ptr">A pointer to the UTF-8 encoded string</param>
  6861. <param name="len">The length in bytes of the string</param>
  6862. <returns>The parsed DateTime value</returns>
  6863. </member>
  6864. <member name="M:System.Data.SQLite.SQLiteConvert.Split(System.String,System.Char)">
  6865. <summary>
  6866. Smart method of splitting a string. Skips quoted elements, removes the quotes.
  6867. </summary>
  6868. <remarks>
  6869. This split function works somewhat like the String.Split() function in that it breaks apart a string into
  6870. pieces and returns the pieces as an array. The primary differences are:
  6871. <list type="bullet">
  6872. <item><description>Only one character can be provided as a separator character</description></item>
  6873. <item><description>Quoted text inside the string is skipped over when searching for the separator, and the quotes are removed.</description></item>
  6874. </list>
  6875. Thus, if splitting the following string looking for a comma:<br/>
  6876. One,Two, "Three, Four", Five<br/>
  6877. <br/>
  6878. The resulting array would contain<br/>
  6879. [0] One<br/>
  6880. [1] Two<br/>
  6881. [2] Three, Four<br/>
  6882. [3] Five<br/>
  6883. <br/>
  6884. Note that the leading and trailing spaces were removed from each item during the split.
  6885. </remarks>
  6886. <param name="source">Source string to split apart</param>
  6887. <param name="separator">Separator character</param>
  6888. <returns>A string array of the split up elements</returns>
  6889. </member>
  6890. <member name="M:System.Data.SQLite.SQLiteConvert.NewSplit(System.String,System.Char,System.Boolean,System.String@)">
  6891. <summary>
  6892. Splits the specified string into multiple strings based on a separator
  6893. and returns the result as an array of strings.
  6894. </summary>
  6895. <param name="value">
  6896. The string to split into pieces based on the separator character. If
  6897. this string is null, null will always be returned. If this string is
  6898. empty, an array of zero strings will always be returned.
  6899. </param>
  6900. <param name="separator">
  6901. The character used to divide the original string into sub-strings.
  6902. This character cannot be a backslash or a double-quote; otherwise, no
  6903. work will be performed and null will be returned.
  6904. </param>
  6905. <param name="keepQuote">
  6906. If this parameter is non-zero, all double-quote characters will be
  6907. retained in the returned list of strings; otherwise, they will be
  6908. dropped.
  6909. </param>
  6910. <param name="error">
  6911. Upon failure, this parameter will be modified to contain an appropriate
  6912. error message.
  6913. </param>
  6914. <returns>
  6915. The new array of strings or null if the input string is null -OR- the
  6916. separator character is a backslash or a double-quote -OR- the string
  6917. contains an unbalanced backslash or double-quote character.
  6918. </returns>
  6919. </member>
  6920. <member name="M:System.Data.SQLite.SQLiteConvert.ToStringWithProvider(System.Object,System.IFormatProvider)">
  6921. <summary>
  6922. Queries and returns the string representation for an object, using the
  6923. specified (or current) format provider.
  6924. </summary>
  6925. <param name="obj">
  6926. The object instance to return the string representation for.
  6927. </param>
  6928. <param name="provider">
  6929. The format provider to use -OR- null if the current format provider for
  6930. the thread should be used instead.
  6931. </param>
  6932. <returns>
  6933. The string representation for the object instance -OR- null if the
  6934. object instance is also null.
  6935. </returns>
  6936. </member>
  6937. <member name="M:System.Data.SQLite.SQLiteConvert.ToBoolean(System.Object,System.IFormatProvider,System.Boolean)">
  6938. <summary>
  6939. Attempts to convert an arbitrary object to the Boolean data type.
  6940. Null object values are converted to false. Throws an exception
  6941. upon failure.
  6942. </summary>
  6943. <param name="obj">
  6944. The object value to convert.
  6945. </param>
  6946. <param name="provider">
  6947. The format provider to use.
  6948. </param>
  6949. <param name="viaFramework">
  6950. If non-zero, a string value will be converted using the
  6951. <see cref="M:System.Convert.ToBoolean(System.Object,System.IFormatProvider)" />
  6952. method; otherwise, the <see cref="M:System.Data.SQLite.SQLiteConvert.ToBoolean(System.String)" />
  6953. method will be used.
  6954. </param>
  6955. <returns>
  6956. The converted boolean value.
  6957. </returns>
  6958. </member>
  6959. <member name="M:System.Data.SQLite.SQLiteConvert.ToBoolean(System.Object)">
  6960. <summary>
  6961. Convert a value to true or false.
  6962. </summary>
  6963. <param name="source">A string or number representing true or false</param>
  6964. <returns></returns>
  6965. </member>
  6966. <member name="M:System.Data.SQLite.SQLiteConvert.ToString(System.Int32)">
  6967. <summary>
  6968. Converts an integer to a string that can be round-tripped using the
  6969. invariant culture.
  6970. </summary>
  6971. <param name="value">
  6972. The integer value to return the string representation for.
  6973. </param>
  6974. <returns>
  6975. The string representation of the specified integer value, using the
  6976. invariant culture.
  6977. </returns>
  6978. </member>
  6979. <member name="M:System.Data.SQLite.SQLiteConvert.ToBoolean(System.String)">
  6980. <summary>
  6981. Attempts to convert a <see cref="T:System.String" /> into a <see cref="T:System.Boolean" />.
  6982. </summary>
  6983. <param name="source">
  6984. The <see cref="T:System.String" /> to convert, cannot be null.
  6985. </param>
  6986. <returns>
  6987. The converted <see cref="T:System.Boolean" /> value.
  6988. </returns>
  6989. <remarks>
  6990. The supported strings are "yes", "no", "y", "n", "on", "off", "0", "1",
  6991. as well as any prefix of the strings <see cref="F:System.Boolean.FalseString" />
  6992. and <see cref="F:System.Boolean.TrueString" />. All strings are treated in a
  6993. case-insensitive manner.
  6994. </remarks>
  6995. </member>
  6996. <member name="M:System.Data.SQLite.SQLiteConvert.SQLiteTypeToType(System.Data.SQLite.SQLiteType)">
  6997. <summary>
  6998. Converts a SQLiteType to a .NET Type object
  6999. </summary>
  7000. <param name="t">The SQLiteType to convert</param>
  7001. <returns>Returns a .NET Type object</returns>
  7002. </member>
  7003. <member name="M:System.Data.SQLite.SQLiteConvert.TypeToDbType(System.Type)">
  7004. <summary>
  7005. For a given intrinsic type, return a DbType
  7006. </summary>
  7007. <param name="typ">The native type to convert</param>
  7008. <returns>The corresponding (closest match) DbType</returns>
  7009. </member>
  7010. <member name="M:System.Data.SQLite.SQLiteConvert.DbTypeToColumnSize(System.Data.DbType)">
  7011. <summary>
  7012. Returns the ColumnSize for the given DbType
  7013. </summary>
  7014. <param name="typ">The DbType to get the size of</param>
  7015. <returns></returns>
  7016. </member>
  7017. <member name="M:System.Data.SQLite.SQLiteConvert.GetDefaultTypeName(System.Data.SQLite.SQLiteConnection)">
  7018. <summary>
  7019. Determines the default database type name to be used when a
  7020. per-connection value is not available.
  7021. </summary>
  7022. <param name="connection">
  7023. The connection context for type mappings, if any.
  7024. </param>
  7025. <returns>
  7026. The default database type name to use.
  7027. </returns>
  7028. </member>
  7029. <member name="M:System.Data.SQLite.SQLiteConvert.DefaultTypeNameWarning(System.Data.DbType,System.Data.SQLite.SQLiteConnectionFlags,System.String)">
  7030. <summary>
  7031. If applicable, issues a trace log message warning about falling back to
  7032. the default database type name.
  7033. </summary>
  7034. <param name="dbType">
  7035. The database value type.
  7036. </param>
  7037. <param name="flags">
  7038. The flags associated with the parent connection object.
  7039. </param>
  7040. <param name="typeName">
  7041. The textual name of the database type.
  7042. </param>
  7043. </member>
  7044. <member name="M:System.Data.SQLite.SQLiteConvert.DefaultDbTypeWarning(System.String,System.Data.SQLite.SQLiteConnectionFlags,System.Nullable{System.Data.DbType})">
  7045. <summary>
  7046. If applicable, issues a trace log message warning about falling back to
  7047. the default database value type.
  7048. </summary>
  7049. <param name="typeName">
  7050. The textual name of the database type.
  7051. </param>
  7052. <param name="flags">
  7053. The flags associated with the parent connection object.
  7054. </param>
  7055. <param name="dbType">
  7056. The database value type.
  7057. </param>
  7058. </member>
  7059. <member name="M:System.Data.SQLite.SQLiteConvert.DbTypeToTypeName(System.Data.SQLite.SQLiteConnection,System.Data.DbType,System.Data.SQLite.SQLiteConnectionFlags)">
  7060. <summary>
  7061. For a given database value type, return the "closest-match" textual database type name.
  7062. </summary>
  7063. <param name="connection">The connection context for custom type mappings, if any.</param>
  7064. <param name="dbType">The database value type.</param>
  7065. <param name="flags">The flags associated with the parent connection object.</param>
  7066. <returns>The type name or an empty string if it cannot be determined.</returns>
  7067. </member>
  7068. <member name="M:System.Data.SQLite.SQLiteConvert.DbTypeToType(System.Data.DbType)">
  7069. <summary>
  7070. Convert a DbType to a Type
  7071. </summary>
  7072. <param name="typ">The DbType to convert from</param>
  7073. <returns>The closest-match .NET type</returns>
  7074. </member>
  7075. <member name="M:System.Data.SQLite.SQLiteConvert.TypeToAffinity(System.Type,System.Data.SQLite.SQLiteConnectionFlags)">
  7076. <summary>
  7077. For a given type, return the closest-match SQLite TypeAffinity, which only understands a very limited subset of types.
  7078. </summary>
  7079. <param name="typ">The type to evaluate</param>
  7080. <param name="flags">The flags associated with the connection.</param>
  7081. <returns>The SQLite type affinity for that type.</returns>
  7082. </member>
  7083. <member name="M:System.Data.SQLite.SQLiteConvert.GetSQLiteDbTypeMap">
  7084. <summary>
  7085. Builds and returns a map containing the database column types
  7086. recognized by this provider.
  7087. </summary>
  7088. <returns>
  7089. A map containing the database column types recognized by this
  7090. provider.
  7091. </returns>
  7092. </member>
  7093. <member name="M:System.Data.SQLite.SQLiteConvert.IsStringDbType(System.Data.DbType)">
  7094. <summary>
  7095. Determines if a database type is considered to be a string.
  7096. </summary>
  7097. <param name="type">
  7098. The database type to check.
  7099. </param>
  7100. <returns>
  7101. Non-zero if the database type is considered to be a string, zero
  7102. otherwise.
  7103. </returns>
  7104. </member>
  7105. <member name="M:System.Data.SQLite.SQLiteConvert.SettingValueToString(System.Object)">
  7106. <summary>
  7107. Determines and returns the runtime configuration setting string that
  7108. should be used in place of the specified object value.
  7109. </summary>
  7110. <param name="value">
  7111. The object value to convert to a string.
  7112. </param>
  7113. <returns>
  7114. Either the string to use in place of the object value -OR- null if it
  7115. cannot be determined.
  7116. </returns>
  7117. </member>
  7118. <member name="M:System.Data.SQLite.SQLiteConvert.GetDefaultDbType(System.Data.SQLite.SQLiteConnection)">
  7119. <summary>
  7120. Determines the default <see cref="T:System.Data.DbType" /> value to be used when a
  7121. per-connection value is not available.
  7122. </summary>
  7123. <param name="connection">
  7124. The connection context for type mappings, if any.
  7125. </param>
  7126. <returns>
  7127. The default <see cref="T:System.Data.DbType" /> value to use.
  7128. </returns>
  7129. </member>
  7130. <member name="M:System.Data.SQLite.SQLiteConvert.GetStringOrNull(System.Object)">
  7131. <summary>
  7132. Converts the object value, which is assumed to have originated
  7133. from a <see cref="T:System.Data.DataRow" />, to a string value.
  7134. </summary>
  7135. <param name="value">
  7136. The value to be converted to a string.
  7137. </param>
  7138. <returns>
  7139. A null value will be returned if the original value is null -OR-
  7140. the original value is <see cref="F:System.DBNull.Value" />. Otherwise,
  7141. the original value will be converted to a string, using its
  7142. (possibly overridden) <see cref="M:System.Object.ToString" /> method and
  7143. then returned.
  7144. </returns>
  7145. </member>
  7146. <member name="M:System.Data.SQLite.SQLiteConvert.LooksLikeNull(System.String)">
  7147. <summary>
  7148. Determines if the specified textual value appears to be a
  7149. <see cref="T:System.DBNull" /> value.
  7150. </summary>
  7151. <param name="text">
  7152. The textual value to inspect.
  7153. </param>
  7154. <returns>
  7155. Non-zero if the text looks like a <see cref="T:System.DBNull" /> value,
  7156. zero otherwise.
  7157. </returns>
  7158. </member>
  7159. <member name="M:System.Data.SQLite.SQLiteConvert.LooksLikeInt64(System.String)">
  7160. <summary>
  7161. Determines if the specified textual value appears to be an
  7162. <see cref="T:System.Int64" /> value.
  7163. </summary>
  7164. <param name="text">
  7165. The textual value to inspect.
  7166. </param>
  7167. <returns>
  7168. Non-zero if the text looks like an <see cref="T:System.Int64" /> value,
  7169. zero otherwise.
  7170. </returns>
  7171. </member>
  7172. <member name="M:System.Data.SQLite.SQLiteConvert.LooksLikeDouble(System.String)">
  7173. <summary>
  7174. Determines if the specified textual value appears to be a
  7175. <see cref="T:System.Double" /> value.
  7176. </summary>
  7177. <param name="text">
  7178. The textual value to inspect.
  7179. </param>
  7180. <returns>
  7181. Non-zero if the text looks like a <see cref="T:System.Double" /> value,
  7182. zero otherwise.
  7183. </returns>
  7184. </member>
  7185. <member name="M:System.Data.SQLite.SQLiteConvert.LooksLikeDateTime(System.Data.SQLite.SQLiteConvert,System.String)">
  7186. <summary>
  7187. Determines if the specified textual value appears to be a
  7188. <see cref="T:System.DateTime" /> value.
  7189. </summary>
  7190. <param name="convert">
  7191. The <see cref="T:System.Data.SQLite.SQLiteConvert" /> object instance configured with
  7192. the chosen <see cref="T:System.DateTime" /> format.
  7193. </param>
  7194. <param name="text">
  7195. The textual value to inspect.
  7196. </param>
  7197. <returns>
  7198. Non-zero if the text looks like a <see cref="T:System.DateTime" /> in the
  7199. configured format, zero otherwise.
  7200. </returns>
  7201. </member>
  7202. <member name="M:System.Data.SQLite.SQLiteConvert.TypeNameToDbType(System.Data.SQLite.SQLiteConnection,System.String,System.Data.SQLite.SQLiteConnectionFlags)">
  7203. <summary>
  7204. For a given textual database type name, return the "closest-match" database type.
  7205. This method is called during query result processing; therefore, its performance
  7206. is critical.
  7207. </summary>
  7208. <param name="connection">The connection context for custom type mappings, if any.</param>
  7209. <param name="typeName">The textual name of the database type to match.</param>
  7210. <param name="flags">The flags associated with the parent connection object.</param>
  7211. <returns>The .NET DBType the text evaluates to.</returns>
  7212. </member>
  7213. <member name="T:System.Data.SQLite.TypeAffinity">
  7214. <summary>
  7215. SQLite has very limited types, and is inherently text-based. The first 5 types below represent the sum of all types SQLite
  7216. understands. The DateTime extension to the spec is for internal use only.
  7217. </summary>
  7218. </member>
  7219. <member name="F:System.Data.SQLite.TypeAffinity.Uninitialized">
  7220. <summary>
  7221. Not used
  7222. </summary>
  7223. </member>
  7224. <member name="F:System.Data.SQLite.TypeAffinity.Int64">
  7225. <summary>
  7226. All integers in SQLite default to Int64
  7227. </summary>
  7228. </member>
  7229. <member name="F:System.Data.SQLite.TypeAffinity.Double">
  7230. <summary>
  7231. All floating point numbers in SQLite default to double
  7232. </summary>
  7233. </member>
  7234. <member name="F:System.Data.SQLite.TypeAffinity.Text">
  7235. <summary>
  7236. The default data type of SQLite is text
  7237. </summary>
  7238. </member>
  7239. <member name="F:System.Data.SQLite.TypeAffinity.Blob">
  7240. <summary>
  7241. Typically blob types are only seen when returned from a function
  7242. </summary>
  7243. </member>
  7244. <member name="F:System.Data.SQLite.TypeAffinity.Null">
  7245. <summary>
  7246. Null types can be returned from functions
  7247. </summary>
  7248. </member>
  7249. <member name="F:System.Data.SQLite.TypeAffinity.DateTime">
  7250. <summary>
  7251. Used internally by this provider
  7252. </summary>
  7253. </member>
  7254. <member name="F:System.Data.SQLite.TypeAffinity.None">
  7255. <summary>
  7256. Used internally by this provider
  7257. </summary>
  7258. </member>
  7259. <member name="T:System.Data.SQLite.SQLiteConnectionEventType">
  7260. <summary>
  7261. These are the event types associated with the
  7262. <see cref="T:System.Data.SQLite.SQLiteConnectionEventHandler" />
  7263. delegate (and its corresponding event) and the
  7264. <see cref="T:System.Data.SQLite.ConnectionEventArgs" /> class.
  7265. </summary>
  7266. </member>
  7267. <member name="F:System.Data.SQLite.SQLiteConnectionEventType.Invalid">
  7268. <summary>
  7269. Not used.
  7270. </summary>
  7271. </member>
  7272. <member name="F:System.Data.SQLite.SQLiteConnectionEventType.Unknown">
  7273. <summary>
  7274. Not used.
  7275. </summary>
  7276. </member>
  7277. <member name="F:System.Data.SQLite.SQLiteConnectionEventType.Opening">
  7278. <summary>
  7279. The connection is being opened.
  7280. </summary>
  7281. </member>
  7282. <member name="F:System.Data.SQLite.SQLiteConnectionEventType.ConnectionString">
  7283. <summary>
  7284. The connection string has been parsed.
  7285. </summary>
  7286. </member>
  7287. <member name="F:System.Data.SQLite.SQLiteConnectionEventType.Opened">
  7288. <summary>
  7289. The connection was opened.
  7290. </summary>
  7291. </member>
  7292. <member name="F:System.Data.SQLite.SQLiteConnectionEventType.ChangeDatabase">
  7293. <summary>
  7294. The <see cref="F:System.Data.SQLite.SQLiteConnectionEventType.ChangeDatabase" /> method was called on the
  7295. connection.
  7296. </summary>
  7297. </member>
  7298. <member name="F:System.Data.SQLite.SQLiteConnectionEventType.NewTransaction">
  7299. <summary>
  7300. A transaction was created using the connection.
  7301. </summary>
  7302. </member>
  7303. <member name="F:System.Data.SQLite.SQLiteConnectionEventType.EnlistTransaction">
  7304. <summary>
  7305. The connection was enlisted into a transaction.
  7306. </summary>
  7307. </member>
  7308. <member name="F:System.Data.SQLite.SQLiteConnectionEventType.NewCommand">
  7309. <summary>
  7310. A command was created using the connection.
  7311. </summary>
  7312. </member>
  7313. <member name="F:System.Data.SQLite.SQLiteConnectionEventType.NewDataReader">
  7314. <summary>
  7315. A data reader was created using the connection.
  7316. </summary>
  7317. </member>
  7318. <member name="F:System.Data.SQLite.SQLiteConnectionEventType.NewCriticalHandle">
  7319. <summary>
  7320. An instance of a <see cref="T:System.Runtime.InteropServices.CriticalHandle" /> derived class has
  7321. been created to wrap a native resource.
  7322. </summary>
  7323. </member>
  7324. <member name="F:System.Data.SQLite.SQLiteConnectionEventType.Closing">
  7325. <summary>
  7326. The connection is being closed.
  7327. </summary>
  7328. </member>
  7329. <member name="F:System.Data.SQLite.SQLiteConnectionEventType.Closed">
  7330. <summary>
  7331. The connection was closed.
  7332. </summary>
  7333. </member>
  7334. <member name="F:System.Data.SQLite.SQLiteConnectionEventType.DisposingCommand">
  7335. <summary>
  7336. A command is being disposed.
  7337. </summary>
  7338. </member>
  7339. <member name="F:System.Data.SQLite.SQLiteConnectionEventType.DisposingDataReader">
  7340. <summary>
  7341. A data reader is being disposed.
  7342. </summary>
  7343. </member>
  7344. <member name="F:System.Data.SQLite.SQLiteConnectionEventType.ClosingDataReader">
  7345. <summary>
  7346. A data reader is being closed.
  7347. </summary>
  7348. </member>
  7349. <member name="F:System.Data.SQLite.SQLiteConnectionEventType.OpenedFromPool">
  7350. <summary>
  7351. A native resource was opened (i.e. obtained) from the pool.
  7352. </summary>
  7353. </member>
  7354. <member name="F:System.Data.SQLite.SQLiteConnectionEventType.ClosedToPool">
  7355. <summary>
  7356. A native resource was closed (i.e. released) to the pool.
  7357. </summary>
  7358. </member>
  7359. <member name="T:System.Data.SQLite.SQLiteDateFormats">
  7360. <summary>
  7361. This implementation of SQLite for ADO.NET can process date/time fields in
  7362. databases in one of six formats.
  7363. </summary>
  7364. <remarks>
  7365. ISO8601 format is more compatible, readable, fully-processable, but less
  7366. accurate as it does not provide time down to fractions of a second.
  7367. JulianDay is the numeric format the SQLite uses internally and is arguably
  7368. the most compatible with 3rd party tools. It is not readable as text
  7369. without post-processing. Ticks less compatible with 3rd party tools that
  7370. query the database, and renders the DateTime field unreadable as text
  7371. without post-processing. UnixEpoch is more compatible with Unix systems.
  7372. InvariantCulture allows the configured format for the invariant culture
  7373. format to be used and is human readable. CurrentCulture allows the
  7374. configured format for the current culture to be used and is also human
  7375. readable.
  7376. The preferred order of choosing a DateTime format is JulianDay, ISO8601,
  7377. and then Ticks. Ticks is mainly present for legacy code support.
  7378. </remarks>
  7379. </member>
  7380. <member name="F:System.Data.SQLite.SQLiteDateFormats.Ticks">
  7381. <summary>
  7382. Use the value of DateTime.Ticks. This value is not recommended and is not well supported with LINQ.
  7383. </summary>
  7384. </member>
  7385. <member name="F:System.Data.SQLite.SQLiteDateFormats.ISO8601">
  7386. <summary>
  7387. Use the ISO-8601 format. Uses the "yyyy-MM-dd HH:mm:ss.FFFFFFFK" format for UTC DateTime values and
  7388. "yyyy-MM-dd HH:mm:ss.FFFFFFF" format for local DateTime values).
  7389. </summary>
  7390. </member>
  7391. <member name="F:System.Data.SQLite.SQLiteDateFormats.JulianDay">
  7392. <summary>
  7393. The interval of time in days and fractions of a day since January 1, 4713 BC.
  7394. </summary>
  7395. </member>
  7396. <member name="F:System.Data.SQLite.SQLiteDateFormats.UnixEpoch">
  7397. <summary>
  7398. The whole number of seconds since the Unix epoch (January 1, 1970).
  7399. </summary>
  7400. </member>
  7401. <member name="F:System.Data.SQLite.SQLiteDateFormats.InvariantCulture">
  7402. <summary>
  7403. Any culture-independent string value that the .NET Framework can interpret as a valid DateTime.
  7404. </summary>
  7405. </member>
  7406. <member name="F:System.Data.SQLite.SQLiteDateFormats.CurrentCulture">
  7407. <summary>
  7408. Any string value that the .NET Framework can interpret as a valid DateTime using the current culture.
  7409. </summary>
  7410. </member>
  7411. <member name="F:System.Data.SQLite.SQLiteDateFormats.Default">
  7412. <summary>
  7413. The default format for this provider.
  7414. </summary>
  7415. </member>
  7416. <member name="T:System.Data.SQLite.SQLiteJournalModeEnum">
  7417. <summary>
  7418. This enum determines how SQLite treats its journal file.
  7419. </summary>
  7420. <remarks>
  7421. By default SQLite will create and delete the journal file when needed during a transaction.
  7422. However, for some computers running certain filesystem monitoring tools, the rapid
  7423. creation and deletion of the journal file can cause those programs to fail, or to interfere with SQLite.
  7424. If a program or virus scanner is interfering with SQLite's journal file, you may receive errors like "unable to open database file"
  7425. when starting a transaction. If this is happening, you may want to change the default journal mode to Persist.
  7426. </remarks>
  7427. </member>
  7428. <member name="F:System.Data.SQLite.SQLiteJournalModeEnum.Default">
  7429. <summary>
  7430. The default mode, this causes SQLite to use the existing journaling mode for the database.
  7431. </summary>
  7432. </member>
  7433. <member name="F:System.Data.SQLite.SQLiteJournalModeEnum.Delete">
  7434. <summary>
  7435. SQLite will create and destroy the journal file as-needed.
  7436. </summary>
  7437. </member>
  7438. <member name="F:System.Data.SQLite.SQLiteJournalModeEnum.Persist">
  7439. <summary>
  7440. When this is set, SQLite will keep the journal file even after a transaction has completed. It's contents will be erased,
  7441. and the journal re-used as often as needed. If it is deleted, it will be recreated the next time it is needed.
  7442. </summary>
  7443. </member>
  7444. <member name="F:System.Data.SQLite.SQLiteJournalModeEnum.Off">
  7445. <summary>
  7446. This option disables the rollback journal entirely. Interrupted transactions or a program crash can cause database
  7447. corruption in this mode!
  7448. </summary>
  7449. </member>
  7450. <member name="F:System.Data.SQLite.SQLiteJournalModeEnum.Truncate">
  7451. <summary>
  7452. SQLite will truncate the journal file to zero-length instead of deleting it.
  7453. </summary>
  7454. </member>
  7455. <member name="F:System.Data.SQLite.SQLiteJournalModeEnum.Memory">
  7456. <summary>
  7457. SQLite will store the journal in volatile RAM. This saves disk I/O but at the expense of database safety and integrity.
  7458. If the application using SQLite crashes in the middle of a transaction when the MEMORY journaling mode is set, then the
  7459. database file will very likely go corrupt.
  7460. </summary>
  7461. </member>
  7462. <member name="F:System.Data.SQLite.SQLiteJournalModeEnum.Wal">
  7463. <summary>
  7464. SQLite uses a write-ahead log instead of a rollback journal to implement transactions. The WAL journaling mode is persistent;
  7465. after being set it stays in effect across multiple database connections and after closing and reopening the database. A database
  7466. in WAL journaling mode can only be accessed by SQLite version 3.7.0 or later.
  7467. </summary>
  7468. </member>
  7469. <member name="T:System.Data.SQLite.SQLiteSynchronousEnum">
  7470. <summary>
  7471. Possible values for the "synchronous" database setting. This setting determines
  7472. how often the database engine calls the xSync method of the VFS.
  7473. </summary>
  7474. </member>
  7475. <member name="F:System.Data.SQLite.SQLiteSynchronousEnum.Default">
  7476. <summary>
  7477. Use the default "synchronous" database setting. Currently, this should be
  7478. the same as using the FULL mode.
  7479. </summary>
  7480. </member>
  7481. <member name="F:System.Data.SQLite.SQLiteSynchronousEnum.Off">
  7482. <summary>
  7483. The database engine continues without syncing as soon as it has handed
  7484. data off to the operating system. If the application running SQLite
  7485. crashes, the data will be safe, but the database might become corrupted
  7486. if the operating system crashes or the computer loses power before that
  7487. data has been written to the disk surface.
  7488. </summary>
  7489. </member>
  7490. <member name="F:System.Data.SQLite.SQLiteSynchronousEnum.Normal">
  7491. <summary>
  7492. The database engine will still sync at the most critical moments, but
  7493. less often than in FULL mode. There is a very small (though non-zero)
  7494. chance that a power failure at just the wrong time could corrupt the
  7495. database in NORMAL mode.
  7496. </summary>
  7497. </member>
  7498. <member name="F:System.Data.SQLite.SQLiteSynchronousEnum.Full">
  7499. <summary>
  7500. The database engine will use the xSync method of the VFS to ensure that
  7501. all content is safely written to the disk surface prior to continuing.
  7502. This ensures that an operating system crash or power failure will not
  7503. corrupt the database. FULL synchronous is very safe, but it is also
  7504. slower.
  7505. </summary>
  7506. </member>
  7507. <member name="T:System.Data.SQLite.SQLiteExecuteType">
  7508. <summary>
  7509. The requested command execution type. This controls which method of the
  7510. <see cref="T:System.Data.SQLite.SQLiteCommand" /> object will be called.
  7511. </summary>
  7512. </member>
  7513. <member name="F:System.Data.SQLite.SQLiteExecuteType.None">
  7514. <summary>
  7515. Do nothing. No method will be called.
  7516. </summary>
  7517. </member>
  7518. <member name="F:System.Data.SQLite.SQLiteExecuteType.NonQuery">
  7519. <summary>
  7520. The command is not expected to return a result -OR- the result is not
  7521. needed. The <see cref="M:System.Data.SQLite.SQLiteCommand.ExecuteNonQuery" /> or
  7522. <see cref="M:System.Data.SQLite.SQLiteCommand.ExecuteNonQuery(System.Data.CommandBehavior)" /> method
  7523. will be called.
  7524. </summary>
  7525. </member>
  7526. <member name="F:System.Data.SQLite.SQLiteExecuteType.Scalar">
  7527. <summary>
  7528. The command is expected to return a scalar result -OR- the result should
  7529. be limited to a scalar result. The <see cref="M:System.Data.SQLite.SQLiteCommand.ExecuteScalar" />
  7530. or <see cref="M:System.Data.SQLite.SQLiteCommand.ExecuteScalar(System.Data.CommandBehavior)" /> method will
  7531. be called.
  7532. </summary>
  7533. </member>
  7534. <member name="F:System.Data.SQLite.SQLiteExecuteType.Reader">
  7535. <summary>
  7536. The command is expected to return <see cref="T:System.Data.SQLite.SQLiteDataReader" /> result.
  7537. The <see cref="M:System.Data.SQLite.SQLiteCommand.ExecuteReader" /> or
  7538. <see cref="M:System.Data.SQLite.SQLiteCommand.ExecuteReader(System.Data.CommandBehavior)" /> method will
  7539. be called.
  7540. </summary>
  7541. </member>
  7542. <member name="F:System.Data.SQLite.SQLiteExecuteType.Default">
  7543. <summary>
  7544. Use the default command execution type. Using this value is the same
  7545. as using the <see cref="F:System.Data.SQLite.SQLiteExecuteType.NonQuery" /> value.
  7546. </summary>
  7547. </member>
  7548. <member name="T:System.Data.SQLite.SQLiteAuthorizerActionCode">
  7549. <summary>
  7550. The action code responsible for the current call into the authorizer.
  7551. </summary>
  7552. </member>
  7553. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.None">
  7554. <summary>
  7555. No action is being performed. This value should not be used from
  7556. external code.
  7557. </summary>
  7558. </member>
  7559. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Copy">
  7560. <summary>
  7561. No longer used.
  7562. </summary>
  7563. </member>
  7564. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.CreateIndex">
  7565. <summary>
  7566. An index will be created. The action-specific arguments are the
  7567. index name and the table name.
  7568. </summary>
  7569. </member>
  7570. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.CreateTable">
  7571. <summary>
  7572. A table will be created. The action-specific arguments are the
  7573. table name and a null value.
  7574. </summary>
  7575. </member>
  7576. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.CreateTempIndex">
  7577. <summary>
  7578. A temporary index will be created. The action-specific arguments
  7579. are the index name and the table name.
  7580. </summary>
  7581. </member>
  7582. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.CreateTempTable">
  7583. <summary>
  7584. A temporary table will be created. The action-specific arguments
  7585. are the table name and a null value.
  7586. </summary>
  7587. </member>
  7588. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.CreateTempTrigger">
  7589. <summary>
  7590. A temporary trigger will be created. The action-specific arguments
  7591. are the trigger name and the table name.
  7592. </summary>
  7593. </member>
  7594. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.CreateTempView">
  7595. <summary>
  7596. A temporary view will be created. The action-specific arguments are
  7597. the view name and a null value.
  7598. </summary>
  7599. </member>
  7600. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.CreateTrigger">
  7601. <summary>
  7602. A trigger will be created. The action-specific arguments are the
  7603. trigger name and the table name.
  7604. </summary>
  7605. </member>
  7606. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.CreateView">
  7607. <summary>
  7608. A view will be created. The action-specific arguments are the view
  7609. name and a null value.
  7610. </summary>
  7611. </member>
  7612. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Delete">
  7613. <summary>
  7614. A DELETE statement will be executed. The action-specific arguments
  7615. are the table name and a null value.
  7616. </summary>
  7617. </member>
  7618. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.DropIndex">
  7619. <summary>
  7620. An index will be dropped. The action-specific arguments are the
  7621. index name and the table name.
  7622. </summary>
  7623. </member>
  7624. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.DropTable">
  7625. <summary>
  7626. A table will be dropped. The action-specific arguments are the tables
  7627. name and a null value.
  7628. </summary>
  7629. </member>
  7630. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.DropTempIndex">
  7631. <summary>
  7632. A temporary index will be dropped. The action-specific arguments are
  7633. the index name and the table name.
  7634. </summary>
  7635. </member>
  7636. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.DropTempTable">
  7637. <summary>
  7638. A temporary table will be dropped. The action-specific arguments are
  7639. the table name and a null value.
  7640. </summary>
  7641. </member>
  7642. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.DropTempTrigger">
  7643. <summary>
  7644. A temporary trigger will be dropped. The action-specific arguments
  7645. are the trigger name and the table name.
  7646. </summary>
  7647. </member>
  7648. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.DropTempView">
  7649. <summary>
  7650. A temporary view will be dropped. The action-specific arguments are
  7651. the view name and a null value.
  7652. </summary>
  7653. </member>
  7654. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.DropTrigger">
  7655. <summary>
  7656. A trigger will be dropped. The action-specific arguments are the
  7657. trigger name and the table name.
  7658. </summary>
  7659. </member>
  7660. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.DropView">
  7661. <summary>
  7662. A view will be dropped. The action-specific arguments are the view
  7663. name and a null value.
  7664. </summary>
  7665. </member>
  7666. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Insert">
  7667. <summary>
  7668. An INSERT statement will be executed. The action-specific arguments
  7669. are the table name and a null value.
  7670. </summary>
  7671. </member>
  7672. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Pragma">
  7673. <summary>
  7674. A PRAGMA statement will be executed. The action-specific arguments
  7675. are the name of the PRAGMA and the new value or a null value.
  7676. </summary>
  7677. </member>
  7678. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Read">
  7679. <summary>
  7680. A table column will be read. The action-specific arguments are the
  7681. table name and the column name.
  7682. </summary>
  7683. </member>
  7684. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Select">
  7685. <summary>
  7686. A SELECT statement will be executed. The action-specific arguments
  7687. are both null values.
  7688. </summary>
  7689. </member>
  7690. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Transaction">
  7691. <summary>
  7692. A transaction will be started, committed, or rolled back. The
  7693. action-specific arguments are the name of the operation (BEGIN,
  7694. COMMIT, or ROLLBACK) and a null value.
  7695. </summary>
  7696. </member>
  7697. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Update">
  7698. <summary>
  7699. An UPDATE statement will be executed. The action-specific arguments
  7700. are the table name and the column name.
  7701. </summary>
  7702. </member>
  7703. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Attach">
  7704. <summary>
  7705. A database will be attached to the connection. The action-specific
  7706. arguments are the database file name and a null value.
  7707. </summary>
  7708. </member>
  7709. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Detach">
  7710. <summary>
  7711. A database will be detached from the connection. The action-specific
  7712. arguments are the database name and a null value.
  7713. </summary>
  7714. </member>
  7715. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.AlterTable">
  7716. <summary>
  7717. The schema of a table will be altered. The action-specific arguments
  7718. are the database name and the table name.
  7719. </summary>
  7720. </member>
  7721. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Reindex">
  7722. <summary>
  7723. An index will be deleted and then recreated. The action-specific
  7724. arguments are the index name and a null value.
  7725. </summary>
  7726. </member>
  7727. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Analyze">
  7728. <summary>
  7729. A table will be analyzed to gathers statistics about it. The
  7730. action-specific arguments are the table name and a null value.
  7731. </summary>
  7732. </member>
  7733. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.CreateVtable">
  7734. <summary>
  7735. A virtual table will be created. The action-specific arguments are
  7736. the table name and the module name.
  7737. </summary>
  7738. </member>
  7739. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.DropVtable">
  7740. <summary>
  7741. A virtual table will be dropped. The action-specific arguments are
  7742. the table name and the module name.
  7743. </summary>
  7744. </member>
  7745. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Function">
  7746. <summary>
  7747. A SQL function will be called. The action-specific arguments are a
  7748. null value and the function name.
  7749. </summary>
  7750. </member>
  7751. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Savepoint">
  7752. <summary>
  7753. A savepoint will be created, released, or rolled back. The
  7754. action-specific arguments are the name of the operation (BEGIN,
  7755. RELEASE, or ROLLBACK) and the savepoint name.
  7756. </summary>
  7757. </member>
  7758. <member name="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Recursive">
  7759. <summary>
  7760. A recursive query will be executed. The action-specific arguments
  7761. are two null values.
  7762. </summary>
  7763. </member>
  7764. <member name="T:System.Data.SQLite.SQLiteProgressReturnCode">
  7765. <summary>
  7766. The possible return codes for the progress callback.
  7767. </summary>
  7768. </member>
  7769. <member name="F:System.Data.SQLite.SQLiteProgressReturnCode.Continue">
  7770. <summary>
  7771. The operation should continue.
  7772. </summary>
  7773. </member>
  7774. <member name="F:System.Data.SQLite.SQLiteProgressReturnCode.Interrupt">
  7775. <summary>
  7776. The operation should be interrupted.
  7777. </summary>
  7778. </member>
  7779. <member name="T:System.Data.SQLite.SQLiteAuthorizerReturnCode">
  7780. <summary>
  7781. The return code for the current call into the authorizer.
  7782. </summary>
  7783. </member>
  7784. <member name="F:System.Data.SQLite.SQLiteAuthorizerReturnCode.Ok">
  7785. <summary>
  7786. The action will be allowed.
  7787. </summary>
  7788. </member>
  7789. <member name="F:System.Data.SQLite.SQLiteAuthorizerReturnCode.Deny">
  7790. <summary>
  7791. The overall action will be disallowed and an error message will be
  7792. returned from the query preparation method.
  7793. </summary>
  7794. </member>
  7795. <member name="F:System.Data.SQLite.SQLiteAuthorizerReturnCode.Ignore">
  7796. <summary>
  7797. The specific action will be disallowed; however, the overall action
  7798. will continue. The exact effects of this return code vary depending
  7799. on the specific action, please refer to the SQLite core library
  7800. documentation for futher details.
  7801. </summary>
  7802. </member>
  7803. <member name="T:System.Data.SQLite.SQLiteType">
  7804. <summary>
  7805. Class used internally to determine the datatype of a column in a resultset
  7806. </summary>
  7807. </member>
  7808. <member name="F:System.Data.SQLite.SQLiteType.Type">
  7809. <summary>
  7810. The DbType of the column, or DbType.Object if it cannot be determined
  7811. </summary>
  7812. </member>
  7813. <member name="F:System.Data.SQLite.SQLiteType.Affinity">
  7814. <summary>
  7815. The affinity of a column, used for expressions or when Type is DbType.Object
  7816. </summary>
  7817. </member>
  7818. <member name="M:System.Data.SQLite.SQLiteType.#ctor">
  7819. <summary>
  7820. Constructs a default instance of this type.
  7821. </summary>
  7822. </member>
  7823. <member name="M:System.Data.SQLite.SQLiteType.#ctor(System.Data.SQLite.TypeAffinity,System.Data.DbType)">
  7824. <summary>
  7825. Constructs an instance of this type with the specified field values.
  7826. </summary>
  7827. <param name="affinity">
  7828. The type affinity to use for the new instance.
  7829. </param>
  7830. <param name="type">
  7831. The database type to use for the new instance.
  7832. </param>
  7833. </member>
  7834. <member name="T:System.Data.SQLite.SQLiteDataAdapter">
  7835. <summary>
  7836. SQLite implementation of DbDataAdapter.
  7837. </summary>
  7838. </member>
  7839. <member name="M:System.Data.SQLite.SQLiteDataAdapter.#ctor">
  7840. <overloads>
  7841. This class is just a shell around the DbDataAdapter. Nothing from
  7842. DbDataAdapter is overridden here, just a few constructors are defined.
  7843. </overloads>
  7844. <summary>
  7845. Default constructor.
  7846. </summary>
  7847. </member>
  7848. <member name="M:System.Data.SQLite.SQLiteDataAdapter.#ctor(System.Data.SQLite.SQLiteCommand)">
  7849. <summary>
  7850. Constructs a data adapter using the specified select command.
  7851. </summary>
  7852. <param name="cmd">
  7853. The select command to associate with the adapter.
  7854. </param>
  7855. </member>
  7856. <member name="M:System.Data.SQLite.SQLiteDataAdapter.#ctor(System.String,System.Data.SQLite.SQLiteConnection)">
  7857. <summary>
  7858. Constructs a data adapter with the supplied select command text and
  7859. associated with the specified connection.
  7860. </summary>
  7861. <param name="commandText">
  7862. The select command text to associate with the data adapter.
  7863. </param>
  7864. <param name="connection">
  7865. The connection to associate with the select command.
  7866. </param>
  7867. </member>
  7868. <member name="M:System.Data.SQLite.SQLiteDataAdapter.#ctor(System.String,System.String)">
  7869. <summary>
  7870. Constructs a data adapter with the specified select command text,
  7871. and using the specified database connection string.
  7872. </summary>
  7873. <param name="commandText">
  7874. The select command text to use to construct a select command.
  7875. </param>
  7876. <param name="connectionString">
  7877. A connection string suitable for passing to a new SQLiteConnection,
  7878. which is associated with the select command.
  7879. </param>
  7880. </member>
  7881. <member name="M:System.Data.SQLite.SQLiteDataAdapter.#ctor(System.String,System.String,System.Boolean)">
  7882. <summary>
  7883. Constructs a data adapter with the specified select command text,
  7884. and using the specified database connection string.
  7885. </summary>
  7886. <param name="commandText">
  7887. The select command text to use to construct a select command.
  7888. </param>
  7889. <param name="connectionString">
  7890. A connection string suitable for passing to a new SQLiteConnection,
  7891. which is associated with the select command.
  7892. </param>
  7893. <param name="parseViaFramework">
  7894. Non-zero to parse the connection string using the built-in (i.e.
  7895. framework provided) parser when opening the connection.
  7896. </param>
  7897. </member>
  7898. <member name="M:System.Data.SQLite.SQLiteDataAdapter.Dispose(System.Boolean)">
  7899. <summary>
  7900. Cleans up resources (native and managed) associated with the current instance.
  7901. </summary>
  7902. <param name="disposing">
  7903. Zero when being disposed via garbage collection; otherwise, non-zero.
  7904. </param>
  7905. </member>
  7906. <member name="E:System.Data.SQLite.SQLiteDataAdapter.RowUpdating">
  7907. <summary>
  7908. Row updating event handler
  7909. </summary>
  7910. </member>
  7911. <member name="E:System.Data.SQLite.SQLiteDataAdapter.RowUpdated">
  7912. <summary>
  7913. Row updated event handler
  7914. </summary>
  7915. </member>
  7916. <member name="M:System.Data.SQLite.SQLiteDataAdapter.OnRowUpdating(System.Data.Common.RowUpdatingEventArgs)">
  7917. <summary>
  7918. Raised by the underlying DbDataAdapter when a row is being updated
  7919. </summary>
  7920. <param name="value">The event's specifics</param>
  7921. </member>
  7922. <member name="M:System.Data.SQLite.SQLiteDataAdapter.OnRowUpdated(System.Data.Common.RowUpdatedEventArgs)">
  7923. <summary>
  7924. Raised by DbDataAdapter after a row is updated
  7925. </summary>
  7926. <param name="value">The event's specifics</param>
  7927. </member>
  7928. <member name="P:System.Data.SQLite.SQLiteDataAdapter.SelectCommand">
  7929. <summary>
  7930. Gets/sets the select command for this DataAdapter
  7931. </summary>
  7932. </member>
  7933. <member name="P:System.Data.SQLite.SQLiteDataAdapter.InsertCommand">
  7934. <summary>
  7935. Gets/sets the insert command for this DataAdapter
  7936. </summary>
  7937. </member>
  7938. <member name="P:System.Data.SQLite.SQLiteDataAdapter.UpdateCommand">
  7939. <summary>
  7940. Gets/sets the update command for this DataAdapter
  7941. </summary>
  7942. </member>
  7943. <member name="P:System.Data.SQLite.SQLiteDataAdapter.DeleteCommand">
  7944. <summary>
  7945. Gets/sets the delete command for this DataAdapter
  7946. </summary>
  7947. </member>
  7948. <member name="T:System.Data.SQLite.SQLiteDataReader">
  7949. <summary>
  7950. SQLite implementation of DbDataReader.
  7951. </summary>
  7952. </member>
  7953. <member name="F:System.Data.SQLite.SQLiteDataReader._command">
  7954. <summary>
  7955. Underlying command this reader is attached to
  7956. </summary>
  7957. </member>
  7958. <member name="F:System.Data.SQLite.SQLiteDataReader._flags">
  7959. <summary>
  7960. The flags pertaining to the associated connection (via the command).
  7961. </summary>
  7962. </member>
  7963. <member name="F:System.Data.SQLite.SQLiteDataReader._activeStatementIndex">
  7964. <summary>
  7965. Index of the current statement in the command being processed
  7966. </summary>
  7967. </member>
  7968. <member name="F:System.Data.SQLite.SQLiteDataReader._activeStatement">
  7969. <summary>
  7970. Current statement being Read()
  7971. </summary>
  7972. </member>
  7973. <member name="F:System.Data.SQLite.SQLiteDataReader._readingState">
  7974. <summary>
  7975. State of the current statement being processed.
  7976. -1 = First Step() executed, so the first Read() will be ignored
  7977. 0 = Actively reading
  7978. 1 = Finished reading
  7979. 2 = Non-row-returning statement, no records
  7980. </summary>
  7981. </member>
  7982. <member name="F:System.Data.SQLite.SQLiteDataReader._rowsAffected">
  7983. <summary>
  7984. Number of records affected by the insert/update statements executed on the command
  7985. </summary>
  7986. </member>
  7987. <member name="F:System.Data.SQLite.SQLiteDataReader._fieldCount">
  7988. <summary>
  7989. Count of fields (columns) in the row-returning statement currently being processed
  7990. </summary>
  7991. </member>
  7992. <member name="F:System.Data.SQLite.SQLiteDataReader._stepCount">
  7993. <summary>
  7994. The number of calls to Step() that have returned true (i.e. the number of rows that
  7995. have been read in the current result set).
  7996. </summary>
  7997. </member>
  7998. <member name="F:System.Data.SQLite.SQLiteDataReader._fieldIndexes">
  7999. <summary>
  8000. Maps the field (column) names to their corresponding indexes within the results.
  8001. </summary>
  8002. </member>
  8003. <member name="F:System.Data.SQLite.SQLiteDataReader._fieldTypeArray">
  8004. <summary>
  8005. Datatypes of active fields (columns) in the current statement, used for type-restricting data
  8006. </summary>
  8007. </member>
  8008. <member name="F:System.Data.SQLite.SQLiteDataReader._commandBehavior">
  8009. <summary>
  8010. The behavior of the datareader
  8011. </summary>
  8012. </member>
  8013. <member name="F:System.Data.SQLite.SQLiteDataReader._disposeCommand">
  8014. <summary>
  8015. If set, then dispose of the command object when the reader is finished
  8016. </summary>
  8017. </member>
  8018. <member name="F:System.Data.SQLite.SQLiteDataReader._throwOnDisposed">
  8019. <summary>
  8020. If set, then raise an exception when the object is accessed after being disposed.
  8021. </summary>
  8022. </member>
  8023. <member name="F:System.Data.SQLite.SQLiteDataReader._keyInfo">
  8024. <summary>
  8025. An array of rowid's for the active statement if CommandBehavior.KeyInfo is specified
  8026. </summary>
  8027. </member>
  8028. <member name="F:System.Data.SQLite.SQLiteDataReader._version">
  8029. <summary>
  8030. Matches the version of the connection.
  8031. </summary>
  8032. </member>
  8033. <member name="F:System.Data.SQLite.SQLiteDataReader._baseSchemaName">
  8034. <summary>
  8035. The "stub" (i.e. placeholder) base schema name to use when returning
  8036. column schema information. Matches the base schema name used by the
  8037. associated connection.
  8038. </summary>
  8039. </member>
  8040. <member name="M:System.Data.SQLite.SQLiteDataReader.#ctor(System.Data.SQLite.SQLiteCommand,System.Data.CommandBehavior)">
  8041. <summary>
  8042. Internal constructor, initializes the datareader and sets up to begin executing statements
  8043. </summary>
  8044. <param name="cmd">The SQLiteCommand this data reader is for</param>
  8045. <param name="behave">The expected behavior of the data reader</param>
  8046. </member>
  8047. <member name="M:System.Data.SQLite.SQLiteDataReader.Dispose(System.Boolean)">
  8048. <summary>
  8049. Dispose of all resources used by this datareader.
  8050. </summary>
  8051. <param name="disposing"></param>
  8052. </member>
  8053. <member name="M:System.Data.SQLite.SQLiteDataReader.Close">
  8054. <summary>
  8055. Closes the datareader, potentially closing the connection as well if CommandBehavior.CloseConnection was specified.
  8056. </summary>
  8057. </member>
  8058. <member name="M:System.Data.SQLite.SQLiteDataReader.CheckClosed">
  8059. <summary>
  8060. Throw an error if the datareader is closed
  8061. </summary>
  8062. </member>
  8063. <member name="M:System.Data.SQLite.SQLiteDataReader.CheckValidRow">
  8064. <summary>
  8065. Throw an error if a row is not loaded
  8066. </summary>
  8067. </member>
  8068. <member name="M:System.Data.SQLite.SQLiteDataReader.GetEnumerator">
  8069. <summary>
  8070. Enumerator support
  8071. </summary>
  8072. <returns>Returns a DbEnumerator object.</returns>
  8073. </member>
  8074. <member name="P:System.Data.SQLite.SQLiteDataReader.Depth">
  8075. <summary>
  8076. Not implemented. Returns 0
  8077. </summary>
  8078. </member>
  8079. <member name="P:System.Data.SQLite.SQLiteDataReader.FieldCount">
  8080. <summary>
  8081. Returns the number of columns in the current resultset
  8082. </summary>
  8083. </member>
  8084. <member name="M:System.Data.SQLite.SQLiteDataReader.RefreshFlags">
  8085. <summary>
  8086. Forces the connection flags cached by this data reader to be refreshed
  8087. from the underlying connection.
  8088. </summary>
  8089. </member>
  8090. <member name="P:System.Data.SQLite.SQLiteDataReader.StepCount">
  8091. <summary>
  8092. Returns the number of rows seen so far in the current result set.
  8093. </summary>
  8094. </member>
  8095. <member name="P:System.Data.SQLite.SQLiteDataReader.VisibleFieldCount">
  8096. <summary>
  8097. Returns the number of visible fields in the current resultset
  8098. </summary>
  8099. </member>
  8100. <member name="M:System.Data.SQLite.SQLiteDataReader.VerifyForGet">
  8101. <summary>
  8102. This method is used to make sure the result set is open and a row is currently available.
  8103. </summary>
  8104. </member>
  8105. <member name="M:System.Data.SQLite.SQLiteDataReader.VerifyType(System.Int32,System.Data.DbType)">
  8106. <summary>
  8107. SQLite is inherently un-typed. All datatypes in SQLite are natively strings. The definition of the columns of a table
  8108. and the affinity of returned types are all we have to go on to type-restrict data in the reader.
  8109. This function attempts to verify that the type of data being requested of a column matches the datatype of the column. In
  8110. 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)
  8111. to a set of known types that closely match that affinity. It's not an exact science, but its the best we can do.
  8112. </summary>
  8113. <returns>
  8114. This function throws an InvalidTypeCast() exception if the requested type doesn't match the column's definition or affinity.
  8115. </returns>
  8116. <param name="i">The index of the column to type-check</param>
  8117. <param name="typ">The type we want to get out of the column</param>
  8118. </member>
  8119. <member name="M:System.Data.SQLite.SQLiteDataReader.InvokeReadValueCallback(System.Int32,System.Data.SQLite.SQLiteReadEventArgs,System.Boolean@)">
  8120. <summary>
  8121. Invokes the data reader value callback configured for the database
  8122. type name associated with the specified column. If no data reader
  8123. value callback is available for the database type name, do nothing.
  8124. </summary>
  8125. <param name="index">
  8126. The index of the column being read.
  8127. </param>
  8128. <param name="eventArgs">
  8129. The extra event data to pass into the callback.
  8130. </param>
  8131. <param name="complete">
  8132. Non-zero if the default handling for the data reader call should be
  8133. skipped. If this is set to non-zero and the necessary return value
  8134. is unavailable or unsuitable, an exception will be thrown.
  8135. </param>
  8136. </member>
  8137. <member name="M:System.Data.SQLite.SQLiteDataReader.GetRowId(System.Int32)">
  8138. <summary>
  8139. Attempts to query the integer identifier for the current row. This
  8140. will not work for tables that were created WITHOUT ROWID -OR- if the
  8141. query does not include the "rowid" column or one of its aliases -OR-
  8142. if the <see cref="T:System.Data.SQLite.SQLiteDataReader" /> was not created with the
  8143. <see cref="F:System.Data.CommandBehavior.KeyInfo"/> flag.
  8144. </summary>
  8145. <param name="i">
  8146. The index of the BLOB column.
  8147. </param>
  8148. <returns>
  8149. The integer identifier for the current row -OR- null if it could not
  8150. be determined.
  8151. </returns>
  8152. </member>
  8153. <member name="M:System.Data.SQLite.SQLiteDataReader.GetBlob(System.Int32,System.Boolean)">
  8154. <summary>
  8155. Retrieves the column as a <see cref="T:System.Data.SQLite.SQLiteBlob" /> object.
  8156. This will not work for tables that were created WITHOUT ROWID
  8157. -OR- if the query does not include the "rowid" column or one
  8158. of its aliases -OR- if the <see cref="T:System.Data.SQLite.SQLiteDataReader" /> was
  8159. not created with the <see cref="F:System.Data.CommandBehavior.KeyInfo" />
  8160. flag.
  8161. </summary>
  8162. <param name="i">The index of the column.</param>
  8163. <param name="readOnly">
  8164. Non-zero to open the blob object for read-only access.
  8165. </param>
  8166. <returns>A new <see cref="T:System.Data.SQLite.SQLiteBlob" /> object.</returns>
  8167. </member>
  8168. <member name="M:System.Data.SQLite.SQLiteDataReader.GetBoolean(System.Int32)">
  8169. <summary>
  8170. Retrieves the column as a boolean value
  8171. </summary>
  8172. <param name="i">The index of the column.</param>
  8173. <returns>bool</returns>
  8174. </member>
  8175. <member name="M:System.Data.SQLite.SQLiteDataReader.GetByte(System.Int32)">
  8176. <summary>
  8177. Retrieves the column as a single byte value
  8178. </summary>
  8179. <param name="i">The index of the column.</param>
  8180. <returns>byte</returns>
  8181. </member>
  8182. <member name="M:System.Data.SQLite.SQLiteDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)">
  8183. <summary>
  8184. Retrieves a column as an array of bytes (blob)
  8185. </summary>
  8186. <param name="i">The index of the column.</param>
  8187. <param name="fieldOffset">The zero-based index of where to begin reading the data</param>
  8188. <param name="buffer">The buffer to write the bytes into</param>
  8189. <param name="bufferoffset">The zero-based index of where to begin writing into the array</param>
  8190. <param name="length">The number of bytes to retrieve</param>
  8191. <returns>The actual number of bytes written into the array</returns>
  8192. <remarks>
  8193. To determine the number of bytes in the column, pass a null value for the buffer. The total length will be returned.
  8194. </remarks>
  8195. </member>
  8196. <member name="M:System.Data.SQLite.SQLiteDataReader.GetChar(System.Int32)">
  8197. <summary>
  8198. Returns the column as a single character
  8199. </summary>
  8200. <param name="i">The index of the column.</param>
  8201. <returns>char</returns>
  8202. </member>
  8203. <member name="M:System.Data.SQLite.SQLiteDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)">
  8204. <summary>
  8205. Retrieves a column as an array of chars (blob)
  8206. </summary>
  8207. <param name="i">The index of the column.</param>
  8208. <param name="fieldoffset">The zero-based index of where to begin reading the data</param>
  8209. <param name="buffer">The buffer to write the characters into</param>
  8210. <param name="bufferoffset">The zero-based index of where to begin writing into the array</param>
  8211. <param name="length">The number of bytes to retrieve</param>
  8212. <returns>The actual number of characters written into the array</returns>
  8213. <remarks>
  8214. To determine the number of characters in the column, pass a null value for the buffer. The total length will be returned.
  8215. </remarks>
  8216. </member>
  8217. <member name="M:System.Data.SQLite.SQLiteDataReader.GetDataTypeName(System.Int32)">
  8218. <summary>
  8219. Retrieves the name of the back-end datatype of the column
  8220. </summary>
  8221. <param name="i">The index of the column.</param>
  8222. <returns>string</returns>
  8223. </member>
  8224. <member name="M:System.Data.SQLite.SQLiteDataReader.GetDateTime(System.Int32)">
  8225. <summary>
  8226. Retrieve the column as a date/time value
  8227. </summary>
  8228. <param name="i">The index of the column.</param>
  8229. <returns>DateTime</returns>
  8230. </member>
  8231. <member name="M:System.Data.SQLite.SQLiteDataReader.GetDecimal(System.Int32)">
  8232. <summary>
  8233. Retrieve the column as a decimal value
  8234. </summary>
  8235. <param name="i">The index of the column.</param>
  8236. <returns>decimal</returns>
  8237. </member>
  8238. <member name="M:System.Data.SQLite.SQLiteDataReader.GetDouble(System.Int32)">
  8239. <summary>
  8240. Returns the column as a double
  8241. </summary>
  8242. <param name="i">The index of the column.</param>
  8243. <returns>double</returns>
  8244. </member>
  8245. <member name="M:System.Data.SQLite.SQLiteDataReader.GetFieldAffinity(System.Int32)">
  8246. <summary>
  8247. Determines and returns the <see cref="T:System.Data.SQLite.TypeAffinity" /> of the
  8248. specified column.
  8249. </summary>
  8250. <param name="i">
  8251. The index of the column.
  8252. </param>
  8253. <returns>
  8254. The <see cref="T:System.Data.SQLite.TypeAffinity" /> associated with the specified
  8255. column, if any.
  8256. </returns>
  8257. </member>
  8258. <member name="M:System.Data.SQLite.SQLiteDataReader.GetFieldType(System.Int32)">
  8259. <summary>
  8260. Returns the .NET type of a given column
  8261. </summary>
  8262. <param name="i">The index of the column.</param>
  8263. <returns>Type</returns>
  8264. </member>
  8265. <member name="M:System.Data.SQLite.SQLiteDataReader.GetFloat(System.Int32)">
  8266. <summary>
  8267. Returns a column as a float value
  8268. </summary>
  8269. <param name="i">The index of the column.</param>
  8270. <returns>float</returns>
  8271. </member>
  8272. <member name="M:System.Data.SQLite.SQLiteDataReader.GetGuid(System.Int32)">
  8273. <summary>
  8274. Returns the column as a Guid
  8275. </summary>
  8276. <param name="i">The index of the column.</param>
  8277. <returns>Guid</returns>
  8278. </member>
  8279. <member name="M:System.Data.SQLite.SQLiteDataReader.GetInt16(System.Int32)">
  8280. <summary>
  8281. Returns the column as a short
  8282. </summary>
  8283. <param name="i">The index of the column.</param>
  8284. <returns>Int16</returns>
  8285. </member>
  8286. <member name="M:System.Data.SQLite.SQLiteDataReader.GetInt32(System.Int32)">
  8287. <summary>
  8288. Retrieves the column as an int
  8289. </summary>
  8290. <param name="i">The index of the column.</param>
  8291. <returns>Int32</returns>
  8292. </member>
  8293. <member name="M:System.Data.SQLite.SQLiteDataReader.GetInt64(System.Int32)">
  8294. <summary>
  8295. Retrieves the column as a long
  8296. </summary>
  8297. <param name="i">The index of the column.</param>
  8298. <returns>Int64</returns>
  8299. </member>
  8300. <member name="M:System.Data.SQLite.SQLiteDataReader.GetName(System.Int32)">
  8301. <summary>
  8302. Retrieves the name of the column
  8303. </summary>
  8304. <param name="i">The index of the column.</param>
  8305. <returns>string</returns>
  8306. </member>
  8307. <member name="M:System.Data.SQLite.SQLiteDataReader.GetDatabaseName(System.Int32)">
  8308. <summary>
  8309. Returns the name of the database associated with the specified column.
  8310. </summary>
  8311. <param name="i">The index of the column.</param>
  8312. <returns>string</returns>
  8313. </member>
  8314. <member name="M:System.Data.SQLite.SQLiteDataReader.GetTableName(System.Int32)">
  8315. <summary>
  8316. Returns the name of the table associated with the specified column.
  8317. </summary>
  8318. <param name="i">The index of the column.</param>
  8319. <returns>string</returns>
  8320. </member>
  8321. <member name="M:System.Data.SQLite.SQLiteDataReader.GetOriginalName(System.Int32)">
  8322. <summary>
  8323. Returns the original name of the specified column.
  8324. </summary>
  8325. <param name="i">The index of the column.</param>
  8326. <returns>string</returns>
  8327. </member>
  8328. <member name="M:System.Data.SQLite.SQLiteDataReader.GetOrdinal(System.String)">
  8329. <summary>
  8330. Retrieves the i of a column, given its name
  8331. </summary>
  8332. <param name="name">The name of the column to retrieve</param>
  8333. <returns>The int i of the column</returns>
  8334. </member>
  8335. <member name="M:System.Data.SQLite.SQLiteDataReader.GetSchemaTable">
  8336. <summary>
  8337. Schema information in SQLite is difficult to map into .NET conventions, so a lot of work must be done
  8338. to gather the necessary information so it can be represented in an ADO.NET manner.
  8339. </summary>
  8340. <returns>Returns a DataTable containing the schema information for the active SELECT statement being processed.</returns>
  8341. </member>
  8342. <member name="M:System.Data.SQLite.SQLiteDataReader.GetString(System.Int32)">
  8343. <summary>
  8344. Retrieves the column as a string
  8345. </summary>
  8346. <param name="i">The index of the column.</param>
  8347. <returns>string</returns>
  8348. </member>
  8349. <member name="M:System.Data.SQLite.SQLiteDataReader.GetValue(System.Int32)">
  8350. <summary>
  8351. Retrieves the column as an object corresponding to the underlying datatype of the column
  8352. </summary>
  8353. <param name="i">The index of the column.</param>
  8354. <returns>object</returns>
  8355. </member>
  8356. <member name="M:System.Data.SQLite.SQLiteDataReader.GetValues(System.Object[])">
  8357. <summary>
  8358. Retreives the values of multiple columns, up to the size of the supplied array
  8359. </summary>
  8360. <param name="values">The array to fill with values from the columns in the current resultset</param>
  8361. <returns>The number of columns retrieved</returns>
  8362. </member>
  8363. <member name="M:System.Data.SQLite.SQLiteDataReader.GetValues">
  8364. <summary>
  8365. Returns a collection containing all the column names and values for the
  8366. current row of data in the current resultset, if any. If there is no
  8367. current row or no current resultset, an exception may be thrown.
  8368. </summary>
  8369. <returns>
  8370. The collection containing the column name and value information for the
  8371. current row of data in the current resultset or null if this information
  8372. cannot be obtained.
  8373. </returns>
  8374. </member>
  8375. <member name="P:System.Data.SQLite.SQLiteDataReader.HasRows">
  8376. <summary>
  8377. Returns True if the resultset has rows that can be fetched
  8378. </summary>
  8379. </member>
  8380. <member name="P:System.Data.SQLite.SQLiteDataReader.IsClosed">
  8381. <summary>
  8382. Returns True if the data reader is closed
  8383. </summary>
  8384. </member>
  8385. <member name="M:System.Data.SQLite.SQLiteDataReader.IsDBNull(System.Int32)">
  8386. <summary>
  8387. Returns True if the specified column is null
  8388. </summary>
  8389. <param name="i">The index of the column.</param>
  8390. <returns>True or False</returns>
  8391. </member>
  8392. <member name="M:System.Data.SQLite.SQLiteDataReader.NextResult">
  8393. <summary>
  8394. Moves to the next resultset in multiple row-returning SQL command.
  8395. </summary>
  8396. <returns>True if the command was successful and a new resultset is available, False otherwise.</returns>
  8397. </member>
  8398. <member name="M:System.Data.SQLite.SQLiteDataReader.GetConnection(System.Data.SQLite.SQLiteDataReader)">
  8399. <summary>
  8400. This method attempts to query the database connection associated with
  8401. the data reader in use. If the underlying command or connection is
  8402. unavailable, a null value will be returned.
  8403. </summary>
  8404. <returns>
  8405. The connection object -OR- null if it is unavailable.
  8406. </returns>
  8407. </member>
  8408. <member name="M:System.Data.SQLite.SQLiteDataReader.GetSQLiteType(System.Data.SQLite.SQLiteType,System.String)">
  8409. <summary>
  8410. Retrieves the SQLiteType for a given column and row value.
  8411. </summary>
  8412. <param name="oldType">
  8413. The original SQLiteType structure, based only on the column.
  8414. </param>
  8415. <param name="text">
  8416. The textual value of the column for a given row.
  8417. </param>
  8418. <returns>
  8419. The SQLiteType structure.
  8420. </returns>
  8421. </member>
  8422. <member name="M:System.Data.SQLite.SQLiteDataReader.GetSQLiteType(System.Data.SQLite.SQLiteConnectionFlags,System.Int32)">
  8423. <summary>
  8424. Retrieves the SQLiteType for a given column, and caches it to avoid repetetive interop calls.
  8425. </summary>
  8426. <param name="flags">The flags associated with the parent connection object.</param>
  8427. <param name="i">The index of the column.</param>
  8428. <returns>A SQLiteType structure</returns>
  8429. </member>
  8430. <member name="M:System.Data.SQLite.SQLiteDataReader.Read">
  8431. <summary>
  8432. Reads the next row from the resultset
  8433. </summary>
  8434. <returns>True if a new row was successfully loaded and is ready for processing</returns>
  8435. </member>
  8436. <member name="P:System.Data.SQLite.SQLiteDataReader.RecordsAffected">
  8437. <summary>
  8438. Returns the number of rows affected by the statement being executed.
  8439. The value returned may not be accurate for DDL statements. Also, it
  8440. will be -1 for any statement that does not modify the database (e.g.
  8441. SELECT). If an otherwise read-only statement modifies the database
  8442. indirectly (e.g. via a virtual table or user-defined function), the
  8443. value returned is undefined.
  8444. </summary>
  8445. </member>
  8446. <member name="P:System.Data.SQLite.SQLiteDataReader.Item(System.String)">
  8447. <summary>
  8448. Indexer to retrieve data from a column given its name
  8449. </summary>
  8450. <param name="name">The name of the column to retrieve data for</param>
  8451. <returns>The value contained in the column</returns>
  8452. </member>
  8453. <member name="P:System.Data.SQLite.SQLiteDataReader.Item(System.Int32)">
  8454. <summary>
  8455. Indexer to retrieve data from a column given its i
  8456. </summary>
  8457. <param name="i">The index of the column.</param>
  8458. <returns>The value contained in the column</returns>
  8459. </member>
  8460. <member name="T:System.Data.SQLite.SQLiteException">
  8461. <summary>
  8462. SQLite exception class.
  8463. </summary>
  8464. </member>
  8465. <member name="F:System.Data.SQLite.SQLiteException.FACILITY_SQLITE">
  8466. <summary>
  8467. This value was copied from the "WinError.h" file included with the
  8468. Platform SDK for Windows 10.
  8469. </summary>
  8470. </member>
  8471. <member name="M:System.Data.SQLite.SQLiteException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  8472. <summary>
  8473. Private constructor for use with serialization.
  8474. </summary>
  8475. <param name="info">
  8476. Holds the serialized object data about the exception being thrown.
  8477. </param>
  8478. <param name="context">
  8479. Contains contextual information about the source or destination.
  8480. </param>
  8481. </member>
  8482. <member name="M:System.Data.SQLite.SQLiteException.#ctor(System.Data.SQLite.SQLiteErrorCode,System.String)">
  8483. <summary>
  8484. Public constructor for generating a SQLite exception given the error
  8485. code and message.
  8486. </summary>
  8487. <param name="errorCode">
  8488. The SQLite return code to report.
  8489. </param>
  8490. <param name="message">
  8491. Message text to go along with the return code message text.
  8492. </param>
  8493. </member>
  8494. <member name="M:System.Data.SQLite.SQLiteException.#ctor(System.String)">
  8495. <summary>
  8496. Public constructor that uses the base class constructor for the error
  8497. message.
  8498. </summary>
  8499. <param name="message">Error message text.</param>
  8500. </member>
  8501. <member name="M:System.Data.SQLite.SQLiteException.#ctor">
  8502. <summary>
  8503. Public constructor that uses the default base class constructor.
  8504. </summary>
  8505. </member>
  8506. <member name="M:System.Data.SQLite.SQLiteException.#ctor(System.String,System.Exception)">
  8507. <summary>
  8508. Public constructor that uses the base class constructor for the error
  8509. message and inner exception.
  8510. </summary>
  8511. <param name="message">Error message text.</param>
  8512. <param name="innerException">The original (inner) exception.</param>
  8513. </member>
  8514. <member name="M:System.Data.SQLite.SQLiteException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  8515. <summary>
  8516. Adds extra information to the serialized object data specific to this
  8517. class type. This is only used for serialization.
  8518. </summary>
  8519. <param name="info">
  8520. Holds the serialized object data about the exception being thrown.
  8521. </param>
  8522. <param name="context">
  8523. Contains contextual information about the source or destination.
  8524. </param>
  8525. </member>
  8526. <member name="P:System.Data.SQLite.SQLiteException.ResultCode">
  8527. <summary>
  8528. Gets the associated SQLite result code for this exception as a
  8529. <see cref="T:System.Data.SQLite.SQLiteErrorCode" />. This property returns the same
  8530. underlying value as the <see cref="P:System.Data.SQLite.SQLiteException.ErrorCode" /> property.
  8531. </summary>
  8532. </member>
  8533. <member name="P:System.Data.SQLite.SQLiteException.ErrorCode">
  8534. <summary>
  8535. Gets the associated SQLite return code for this exception as an
  8536. <see cref="T:System.Int32" />. For desktop versions of the .NET Framework,
  8537. this property overrides the property of the same name within the
  8538. <see cref="T:System.Runtime.InteropServices.ExternalException" />
  8539. class. This property returns the same underlying value as the
  8540. <see cref="P:System.Data.SQLite.SQLiteException.ResultCode" /> property.
  8541. </summary>
  8542. </member>
  8543. <member name="M:System.Data.SQLite.SQLiteException.Initialize">
  8544. <summary>
  8545. This method performs extra initialization tasks. It may be called by
  8546. any of the constructors of this class. It must not throw exceptions.
  8547. </summary>
  8548. </member>
  8549. <member name="M:System.Data.SQLite.SQLiteException.MakeHResult(System.Int32,System.Boolean)">
  8550. <summary>
  8551. Maps a Win32 error code to an HRESULT.
  8552. </summary>
  8553. <param name="errorCode">
  8554. The specified Win32 error code. It must be within the range of zero
  8555. (0) to 0xFFFF (65535).
  8556. </param>
  8557. <param name="success">
  8558. Non-zero if the HRESULT should indicate success; otherwise, zero.
  8559. </param>
  8560. <returns>
  8561. The integer value of the HRESULT.
  8562. </returns>
  8563. </member>
  8564. <member name="M:System.Data.SQLite.SQLiteException.GetHResultForErrorCode(System.Data.SQLite.SQLiteErrorCode)">
  8565. <summary>
  8566. Attempts to map the specified <see cref="T:System.Data.SQLite.SQLiteErrorCode" /> onto an
  8567. existing HRESULT -OR- a Win32 error code wrapped in an HRESULT. The
  8568. mappings may not have perfectly matching semantics; however, they do
  8569. have the benefit of being unique within the context of this exception
  8570. type.
  8571. </summary>
  8572. <param name="errorCode">
  8573. The <see cref="T:System.Data.SQLite.SQLiteErrorCode" /> to map.
  8574. </param>
  8575. <returns>
  8576. The integer HRESULT value -OR- null if there is no known mapping.
  8577. </returns>
  8578. </member>
  8579. <member name="M:System.Data.SQLite.SQLiteException.GetErrorString(System.Data.SQLite.SQLiteErrorCode)">
  8580. <summary>
  8581. Returns the error message for the specified SQLite return code.
  8582. </summary>
  8583. <param name="errorCode">The SQLite return code.</param>
  8584. <returns>The error message or null if it cannot be found.</returns>
  8585. </member>
  8586. <member name="M:System.Data.SQLite.SQLiteException.GetStockErrorMessage(System.Data.SQLite.SQLiteErrorCode,System.String)">
  8587. <summary>
  8588. Returns the composite error message based on the SQLite return code
  8589. and the optional detailed error message.
  8590. </summary>
  8591. <param name="errorCode">The SQLite return code.</param>
  8592. <param name="message">Optional detailed error message.</param>
  8593. <returns>Error message text for the return code.</returns>
  8594. </member>
  8595. <member name="T:System.Data.SQLite.SQLiteErrorCode">
  8596. <summary>
  8597. SQLite error codes. Actually, this enumeration represents a return code,
  8598. which may also indicate success in one of several ways (e.g. SQLITE_OK,
  8599. SQLITE_ROW, and SQLITE_DONE). Therefore, the name of this enumeration is
  8600. something of a misnomer.
  8601. </summary>
  8602. </member>
  8603. <member name="F:System.Data.SQLite.SQLiteErrorCode.Unknown">
  8604. <summary>
  8605. The error code is unknown. This error code
  8606. is only used by the managed wrapper itself.
  8607. </summary>
  8608. </member>
  8609. <member name="F:System.Data.SQLite.SQLiteErrorCode.Ok">
  8610. <summary>
  8611. Successful result
  8612. </summary>
  8613. </member>
  8614. <member name="F:System.Data.SQLite.SQLiteErrorCode.Error">
  8615. <summary>
  8616. SQL error or missing database
  8617. </summary>
  8618. </member>
  8619. <member name="F:System.Data.SQLite.SQLiteErrorCode.Internal">
  8620. <summary>
  8621. Internal logic error in SQLite
  8622. </summary>
  8623. </member>
  8624. <member name="F:System.Data.SQLite.SQLiteErrorCode.Perm">
  8625. <summary>
  8626. Access permission denied
  8627. </summary>
  8628. </member>
  8629. <member name="F:System.Data.SQLite.SQLiteErrorCode.Abort">
  8630. <summary>
  8631. Callback routine requested an abort
  8632. </summary>
  8633. </member>
  8634. <member name="F:System.Data.SQLite.SQLiteErrorCode.Busy">
  8635. <summary>
  8636. The database file is locked
  8637. </summary>
  8638. </member>
  8639. <member name="F:System.Data.SQLite.SQLiteErrorCode.Locked">
  8640. <summary>
  8641. A table in the database is locked
  8642. </summary>
  8643. </member>
  8644. <member name="F:System.Data.SQLite.SQLiteErrorCode.NoMem">
  8645. <summary>
  8646. A malloc() failed
  8647. </summary>
  8648. </member>
  8649. <member name="F:System.Data.SQLite.SQLiteErrorCode.ReadOnly">
  8650. <summary>
  8651. Attempt to write a readonly database
  8652. </summary>
  8653. </member>
  8654. <member name="F:System.Data.SQLite.SQLiteErrorCode.Interrupt">
  8655. <summary>
  8656. Operation terminated by sqlite3_interrupt()
  8657. </summary>
  8658. </member>
  8659. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr">
  8660. <summary>
  8661. Some kind of disk I/O error occurred
  8662. </summary>
  8663. </member>
  8664. <member name="F:System.Data.SQLite.SQLiteErrorCode.Corrupt">
  8665. <summary>
  8666. The database disk image is malformed
  8667. </summary>
  8668. </member>
  8669. <member name="F:System.Data.SQLite.SQLiteErrorCode.NotFound">
  8670. <summary>
  8671. Unknown opcode in sqlite3_file_control()
  8672. </summary>
  8673. </member>
  8674. <member name="F:System.Data.SQLite.SQLiteErrorCode.Full">
  8675. <summary>
  8676. Insertion failed because database is full
  8677. </summary>
  8678. </member>
  8679. <member name="F:System.Data.SQLite.SQLiteErrorCode.CantOpen">
  8680. <summary>
  8681. Unable to open the database file
  8682. </summary>
  8683. </member>
  8684. <member name="F:System.Data.SQLite.SQLiteErrorCode.Protocol">
  8685. <summary>
  8686. Database lock protocol error
  8687. </summary>
  8688. </member>
  8689. <member name="F:System.Data.SQLite.SQLiteErrorCode.Empty">
  8690. <summary>
  8691. Database is empty
  8692. </summary>
  8693. </member>
  8694. <member name="F:System.Data.SQLite.SQLiteErrorCode.Schema">
  8695. <summary>
  8696. The database schema changed
  8697. </summary>
  8698. </member>
  8699. <member name="F:System.Data.SQLite.SQLiteErrorCode.TooBig">
  8700. <summary>
  8701. String or BLOB exceeds size limit
  8702. </summary>
  8703. </member>
  8704. <member name="F:System.Data.SQLite.SQLiteErrorCode.Constraint">
  8705. <summary>
  8706. Abort due to constraint violation
  8707. </summary>
  8708. </member>
  8709. <member name="F:System.Data.SQLite.SQLiteErrorCode.Mismatch">
  8710. <summary>
  8711. Data type mismatch
  8712. </summary>
  8713. </member>
  8714. <member name="F:System.Data.SQLite.SQLiteErrorCode.Misuse">
  8715. <summary>
  8716. Library used incorrectly
  8717. </summary>
  8718. </member>
  8719. <member name="F:System.Data.SQLite.SQLiteErrorCode.NoLfs">
  8720. <summary>
  8721. Uses OS features not supported on host
  8722. </summary>
  8723. </member>
  8724. <member name="F:System.Data.SQLite.SQLiteErrorCode.Auth">
  8725. <summary>
  8726. Authorization denied
  8727. </summary>
  8728. </member>
  8729. <member name="F:System.Data.SQLite.SQLiteErrorCode.Format">
  8730. <summary>
  8731. Auxiliary database format error
  8732. </summary>
  8733. </member>
  8734. <member name="F:System.Data.SQLite.SQLiteErrorCode.Range">
  8735. <summary>
  8736. 2nd parameter to sqlite3_bind out of range
  8737. </summary>
  8738. </member>
  8739. <member name="F:System.Data.SQLite.SQLiteErrorCode.NotADb">
  8740. <summary>
  8741. File opened that is not a database file
  8742. </summary>
  8743. </member>
  8744. <member name="F:System.Data.SQLite.SQLiteErrorCode.Notice">
  8745. <summary>
  8746. Notifications from sqlite3_log()
  8747. </summary>
  8748. </member>
  8749. <member name="F:System.Data.SQLite.SQLiteErrorCode.Warning">
  8750. <summary>
  8751. Warnings from sqlite3_log()
  8752. </summary>
  8753. </member>
  8754. <member name="F:System.Data.SQLite.SQLiteErrorCode.Row">
  8755. <summary>
  8756. sqlite3_step() has another row ready
  8757. </summary>
  8758. </member>
  8759. <member name="F:System.Data.SQLite.SQLiteErrorCode.Done">
  8760. <summary>
  8761. sqlite3_step() has finished executing
  8762. </summary>
  8763. </member>
  8764. <member name="F:System.Data.SQLite.SQLiteErrorCode.NonExtendedMask">
  8765. <summary>
  8766. Used to mask off extended result codes
  8767. </summary>
  8768. </member>
  8769. <member name="F:System.Data.SQLite.SQLiteErrorCode.Error_Missing_CollSeq">
  8770. <summary>
  8771. A collation sequence was referenced by a schema and it cannot be
  8772. found.
  8773. </summary>
  8774. </member>
  8775. <member name="F:System.Data.SQLite.SQLiteErrorCode.Error_Retry">
  8776. <summary>
  8777. An internal operation failed and it may succeed if retried.
  8778. </summary>
  8779. </member>
  8780. <member name="F:System.Data.SQLite.SQLiteErrorCode.Error_Snapshot">
  8781. <summary>
  8782. The specified snapshot has been overwritten by a checkpoint.
  8783. </summary>
  8784. </member>
  8785. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Read">
  8786. <summary>
  8787. A file read operation failed.
  8788. </summary>
  8789. </member>
  8790. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Short_Read">
  8791. <summary>
  8792. A file read operation returned less data than requested.
  8793. </summary>
  8794. </member>
  8795. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Write">
  8796. <summary>
  8797. A file write operation failed.
  8798. </summary>
  8799. </member>
  8800. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Fsync">
  8801. <summary>
  8802. A file synchronization operation failed.
  8803. </summary>
  8804. </member>
  8805. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Dir_Fsync">
  8806. <summary>
  8807. A directory synchronization operation failed.
  8808. </summary>
  8809. </member>
  8810. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Truncate">
  8811. <summary>
  8812. A file truncate operation failed.
  8813. </summary>
  8814. </member>
  8815. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Fstat">
  8816. <summary>
  8817. A file metadata operation failed.
  8818. </summary>
  8819. </member>
  8820. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Unlock">
  8821. <summary>
  8822. A file unlock operation failed.
  8823. </summary>
  8824. </member>
  8825. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_RdLock">
  8826. <summary>
  8827. A file lock operation failed.
  8828. </summary>
  8829. </member>
  8830. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Delete">
  8831. <summary>
  8832. A file delete operation failed.
  8833. </summary>
  8834. </member>
  8835. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Blocked">
  8836. <summary>
  8837. Not currently used.
  8838. </summary>
  8839. </member>
  8840. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_NoMem">
  8841. <summary>
  8842. Out-of-memory during a file operation.
  8843. </summary>
  8844. </member>
  8845. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Access">
  8846. <summary>
  8847. A file existence/status operation failed.
  8848. </summary>
  8849. </member>
  8850. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_CheckReservedLock">
  8851. <summary>
  8852. A check for a reserved lock failed.
  8853. </summary>
  8854. </member>
  8855. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Lock">
  8856. <summary>
  8857. A file lock operation failed.
  8858. </summary>
  8859. </member>
  8860. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Close">
  8861. <summary>
  8862. A file close operation failed.
  8863. </summary>
  8864. </member>
  8865. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Dir_Close">
  8866. <summary>
  8867. A directory close operation failed.
  8868. </summary>
  8869. </member>
  8870. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_ShmOpen">
  8871. <summary>
  8872. A shared memory open operation failed.
  8873. </summary>
  8874. </member>
  8875. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_ShmSize">
  8876. <summary>
  8877. A shared memory size operation failed.
  8878. </summary>
  8879. </member>
  8880. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_ShmLock">
  8881. <summary>
  8882. A shared memory lock operation failed.
  8883. </summary>
  8884. </member>
  8885. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_ShmMap">
  8886. <summary>
  8887. A shared memory map operation failed.
  8888. </summary>
  8889. </member>
  8890. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Seek">
  8891. <summary>
  8892. A file seek operation failed.
  8893. </summary>
  8894. </member>
  8895. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Delete_NoEnt">
  8896. <summary>
  8897. A file delete operation failed because it does not exist.
  8898. </summary>
  8899. </member>
  8900. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Mmap">
  8901. <summary>
  8902. A file memory mapping operation failed.
  8903. </summary>
  8904. </member>
  8905. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_GetTempPath">
  8906. <summary>
  8907. The temporary directory path could not be obtained.
  8908. </summary>
  8909. </member>
  8910. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_ConvPath">
  8911. <summary>
  8912. A path string conversion operation failed.
  8913. </summary>
  8914. </member>
  8915. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_VNode">
  8916. <summary>
  8917. Reserved.
  8918. </summary>
  8919. </member>
  8920. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Auth">
  8921. <summary>
  8922. An attempt to authenticate failed.
  8923. </summary>
  8924. </member>
  8925. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Begin_Atomic">
  8926. <summary>
  8927. An attempt to begin a file system transaction failed.
  8928. </summary>
  8929. </member>
  8930. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Commit_Atomic">
  8931. <summary>
  8932. An attempt to commit a file system transaction failed.
  8933. </summary>
  8934. </member>
  8935. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Rollback_Atomic">
  8936. <summary>
  8937. An attempt to rollback a file system transaction failed.
  8938. </summary>
  8939. </member>
  8940. <member name="F:System.Data.SQLite.SQLiteErrorCode.IoErr_Data">
  8941. <summary>
  8942. Data read from the file system appears to be incorrect.
  8943. </summary>
  8944. </member>
  8945. <member name="F:System.Data.SQLite.SQLiteErrorCode.Locked_SharedCache">
  8946. <summary>
  8947. A database table is locked in shared-cache mode.
  8948. </summary>
  8949. </member>
  8950. <member name="F:System.Data.SQLite.SQLiteErrorCode.Locked_Vtab">
  8951. <summary>
  8952. A virtual table in the database is locked.
  8953. </summary>
  8954. </member>
  8955. <member name="F:System.Data.SQLite.SQLiteErrorCode.Busy_Recovery">
  8956. <summary>
  8957. A database file is locked due to a recovery operation.
  8958. </summary>
  8959. </member>
  8960. <member name="F:System.Data.SQLite.SQLiteErrorCode.Busy_Snapshot">
  8961. <summary>
  8962. A database file is locked due to snapshot semantics.
  8963. </summary>
  8964. </member>
  8965. <member name="F:System.Data.SQLite.SQLiteErrorCode.Busy_Timeout">
  8966. <summary>
  8967. An internal timeout was encountered while waiting for a database lock.
  8968. </summary>
  8969. </member>
  8970. <member name="F:System.Data.SQLite.SQLiteErrorCode.CantOpen_NoTempDir">
  8971. <summary>
  8972. A database file cannot be opened because no temporary directory is available.
  8973. </summary>
  8974. </member>
  8975. <member name="F:System.Data.SQLite.SQLiteErrorCode.CantOpen_IsDir">
  8976. <summary>
  8977. A database file cannot be opened because its path represents a directory.
  8978. </summary>
  8979. </member>
  8980. <member name="F:System.Data.SQLite.SQLiteErrorCode.CantOpen_FullPath">
  8981. <summary>
  8982. A database file cannot be opened because its full path could not be obtained.
  8983. </summary>
  8984. </member>
  8985. <member name="F:System.Data.SQLite.SQLiteErrorCode.CantOpen_ConvPath">
  8986. <summary>
  8987. A database file cannot be opened because a path string conversion operation failed.
  8988. </summary>
  8989. </member>
  8990. <member name="F:System.Data.SQLite.SQLiteErrorCode.CantOpen_DirtyWal">
  8991. <summary>
  8992. No longer used.
  8993. </summary>
  8994. </member>
  8995. <member name="F:System.Data.SQLite.SQLiteErrorCode.CantOpen_SymLink">
  8996. <summary>
  8997. A database file is a symbolic link and cannot be opened.
  8998. </summary>
  8999. </member>
  9000. <member name="F:System.Data.SQLite.SQLiteErrorCode.Corrupt_Vtab">
  9001. <summary>
  9002. A virtual table is malformed.
  9003. </summary>
  9004. </member>
  9005. <member name="F:System.Data.SQLite.SQLiteErrorCode.Corrupt_Sequence">
  9006. <summary>
  9007. A required sequence table is missing or corrupt.
  9008. </summary>
  9009. </member>
  9010. <member name="F:System.Data.SQLite.SQLiteErrorCode.Corrupt_Index">
  9011. <summary>
  9012. An index entry that should be present is missing.
  9013. </summary>
  9014. </member>
  9015. <member name="F:System.Data.SQLite.SQLiteErrorCode.ReadOnly_Recovery">
  9016. <summary>
  9017. A database file is read-only due to a recovery operation.
  9018. </summary>
  9019. </member>
  9020. <member name="F:System.Data.SQLite.SQLiteErrorCode.ReadOnly_CantLock">
  9021. <summary>
  9022. A database file is read-only because a lock could not be obtained.
  9023. </summary>
  9024. </member>
  9025. <member name="F:System.Data.SQLite.SQLiteErrorCode.ReadOnly_Rollback">
  9026. <summary>
  9027. A database file is read-only because it needs rollback processing.
  9028. </summary>
  9029. </member>
  9030. <member name="F:System.Data.SQLite.SQLiteErrorCode.ReadOnly_DbMoved">
  9031. <summary>
  9032. A database file is read-only because it was moved while open.
  9033. </summary>
  9034. </member>
  9035. <member name="F:System.Data.SQLite.SQLiteErrorCode.ReadOnly_CantInit">
  9036. <summary>
  9037. The shared-memory file is read-only and it should be read-write.
  9038. </summary>
  9039. </member>
  9040. <member name="F:System.Data.SQLite.SQLiteErrorCode.ReadOnly_Directory">
  9041. <summary>
  9042. Unable to create journal file because the directory is read-only.
  9043. </summary>
  9044. </member>
  9045. <member name="F:System.Data.SQLite.SQLiteErrorCode.Abort_Rollback">
  9046. <summary>
  9047. An operation is being aborted due to rollback processing.
  9048. </summary>
  9049. </member>
  9050. <member name="F:System.Data.SQLite.SQLiteErrorCode.Constraint_Check">
  9051. <summary>
  9052. A CHECK constraint failed.
  9053. </summary>
  9054. </member>
  9055. <member name="F:System.Data.SQLite.SQLiteErrorCode.Constraint_CommitHook">
  9056. <summary>
  9057. A commit hook produced a unsuccessful return code.
  9058. </summary>
  9059. </member>
  9060. <member name="F:System.Data.SQLite.SQLiteErrorCode.Constraint_ForeignKey">
  9061. <summary>
  9062. A FOREIGN KEY constraint failed.
  9063. </summary>
  9064. </member>
  9065. <member name="F:System.Data.SQLite.SQLiteErrorCode.Constraint_Function">
  9066. <summary>
  9067. Not currently used.
  9068. </summary>
  9069. </member>
  9070. <member name="F:System.Data.SQLite.SQLiteErrorCode.Constraint_NotNull">
  9071. <summary>
  9072. A NOT NULL constraint failed.
  9073. </summary>
  9074. </member>
  9075. <member name="F:System.Data.SQLite.SQLiteErrorCode.Constraint_PrimaryKey">
  9076. <summary>
  9077. A PRIMARY KEY constraint failed.
  9078. </summary>
  9079. </member>
  9080. <member name="F:System.Data.SQLite.SQLiteErrorCode.Constraint_Trigger">
  9081. <summary>
  9082. The RAISE function was used by a trigger-program.
  9083. </summary>
  9084. </member>
  9085. <member name="F:System.Data.SQLite.SQLiteErrorCode.Constraint_Unique">
  9086. <summary>
  9087. A UNIQUE constraint failed.
  9088. </summary>
  9089. </member>
  9090. <member name="F:System.Data.SQLite.SQLiteErrorCode.Constraint_Vtab">
  9091. <summary>
  9092. Not currently used.
  9093. </summary>
  9094. </member>
  9095. <member name="F:System.Data.SQLite.SQLiteErrorCode.Constraint_RowId">
  9096. <summary>
  9097. A ROWID constraint failed.
  9098. </summary>
  9099. </member>
  9100. <member name="F:System.Data.SQLite.SQLiteErrorCode.Constraint_Pinned">
  9101. <summary>
  9102. A database cursor is busy and cannot be moved.
  9103. </summary>
  9104. </member>
  9105. <member name="F:System.Data.SQLite.SQLiteErrorCode.Notice_Recover_Wal">
  9106. <summary>
  9107. Frames were recovered from the WAL log file.
  9108. </summary>
  9109. </member>
  9110. <member name="F:System.Data.SQLite.SQLiteErrorCode.Notice_Recover_Rollback">
  9111. <summary>
  9112. Pages were recovered from the journal file.
  9113. </summary>
  9114. </member>
  9115. <member name="F:System.Data.SQLite.SQLiteErrorCode.Warning_AutoIndex">
  9116. <summary>
  9117. An automatic index was created to process a query.
  9118. </summary>
  9119. </member>
  9120. <member name="F:System.Data.SQLite.SQLiteErrorCode.Auth_User">
  9121. <summary>
  9122. User authentication failed.
  9123. </summary>
  9124. </member>
  9125. <member name="F:System.Data.SQLite.SQLiteErrorCode.Ok_Load_Permanently">
  9126. <summary>
  9127. Success. Prevents the extension from unloading until the process
  9128. terminates.
  9129. </summary>
  9130. </member>
  9131. <member name="F:System.Data.SQLite.SQLiteErrorCode.Ok_SymLink">
  9132. <summary>
  9133. Success. The specified file name refers to a symbolic link.
  9134. </summary>
  9135. </member>
  9136. <member name="T:System.Data.SQLite.SQLiteFactory">
  9137. <summary>
  9138. SQLite implementation of <see cref="T:System.Data.Common.DbProviderFactory" />.
  9139. </summary>
  9140. <summary>
  9141. SQLite implementation of <see cref="T:System.IServiceProvider" />.
  9142. </summary>
  9143. </member>
  9144. <member name="M:System.Data.SQLite.SQLiteFactory.#ctor">
  9145. <summary>
  9146. Constructs a new instance.
  9147. </summary>
  9148. </member>
  9149. <member name="M:System.Data.SQLite.SQLiteFactory.Dispose">
  9150. <summary>
  9151. Cleans up resources (native and managed) associated with the current instance.
  9152. </summary>
  9153. </member>
  9154. <member name="M:System.Data.SQLite.SQLiteFactory.Finalize">
  9155. <summary>
  9156. Cleans up resources associated with the current instance.
  9157. </summary>
  9158. </member>
  9159. <member name="E:System.Data.SQLite.SQLiteFactory.Log">
  9160. <summary>
  9161. This event is raised whenever SQLite raises a logging event.
  9162. Note that this should be set as one of the first things in the
  9163. application. This event is provided for backward compatibility only.
  9164. New code should use the <see cref="T:System.Data.SQLite.SQLiteLog" /> class instead.
  9165. </summary>
  9166. </member>
  9167. <member name="F:System.Data.SQLite.SQLiteFactory.Instance">
  9168. <summary>
  9169. Static instance member which returns an instanced <see cref="T:System.Data.SQLite.SQLiteFactory" /> class.
  9170. </summary>
  9171. </member>
  9172. <member name="M:System.Data.SQLite.SQLiteFactory.CreateCommand">
  9173. <summary>
  9174. Creates and returns a new <see cref="T:System.Data.SQLite.SQLiteCommand" /> object.
  9175. </summary>
  9176. <returns>The new object.</returns>
  9177. </member>
  9178. <member name="M:System.Data.SQLite.SQLiteFactory.CreateCommandBuilder">
  9179. <summary>
  9180. Creates and returns a new <see cref="T:System.Data.SQLite.SQLiteCommandBuilder" /> object.
  9181. </summary>
  9182. <returns>The new object.</returns>
  9183. </member>
  9184. <member name="M:System.Data.SQLite.SQLiteFactory.CreateConnection">
  9185. <summary>
  9186. Creates and returns a new <see cref="T:System.Data.SQLite.SQLiteConnection" /> object.
  9187. </summary>
  9188. <returns>The new object.</returns>
  9189. </member>
  9190. <member name="M:System.Data.SQLite.SQLiteFactory.CreateConnectionStringBuilder">
  9191. <summary>
  9192. Creates and returns a new <see cref="T:System.Data.SQLite.SQLiteConnectionStringBuilder" /> object.
  9193. </summary>
  9194. <returns>The new object.</returns>
  9195. </member>
  9196. <member name="M:System.Data.SQLite.SQLiteFactory.CreateDataAdapter">
  9197. <summary>
  9198. Creates and returns a new <see cref="T:System.Data.SQLite.SQLiteDataAdapter" /> object.
  9199. </summary>
  9200. <returns>The new object.</returns>
  9201. </member>
  9202. <member name="M:System.Data.SQLite.SQLiteFactory.CreateParameter">
  9203. <summary>
  9204. Creates and returns a new <see cref="T:System.Data.SQLite.SQLiteParameter" /> object.
  9205. </summary>
  9206. <returns>The new object.</returns>
  9207. </member>
  9208. <member name="M:System.Data.SQLite.SQLiteFactory.PreInitialize">
  9209. <summary>
  9210. This method is called to perform preliminary static initialization
  9211. necessary for this class.
  9212. </summary>
  9213. </member>
  9214. <member name="M:System.Data.SQLite.SQLiteFactory.InitializeDbProviderServices">
  9215. <summary>
  9216. This method is called to perform some of the static initialization
  9217. necessary for this class.
  9218. </summary>
  9219. </member>
  9220. <member name="M:System.Data.SQLite.SQLiteFactory.System#IServiceProvider#GetService(System.Type)">
  9221. <summary>
  9222. Will provide a <see cref="T:System.IServiceProvider" /> object in .NET 3.5.
  9223. </summary>
  9224. <param name="serviceType">The class or interface type to query for.</param>
  9225. <returns></returns>
  9226. </member>
  9227. <member name="T:System.Data.SQLite.SQLiteFunction">
  9228. <summary>
  9229. This abstract class is designed to handle user-defined functions easily. An instance of the derived class is made for each
  9230. connection to the database.
  9231. </summary>
  9232. <remarks>
  9233. Although there is one instance of a class derived from SQLiteFunction per database connection, the derived class has no access
  9234. to the underlying connection. This is necessary to deter implementers from thinking it would be a good idea to make database
  9235. calls during processing.
  9236. It is important to distinguish between a per-connection instance, and a per-SQL statement context. One instance of this class
  9237. services all SQL statements being stepped through on that connection, and there can be many. One should never store per-statement
  9238. information in member variables of user-defined function classes.
  9239. For aggregate functions, always create and store your per-statement data in the contextData object on the 1st step. This data will
  9240. be automatically freed for you (and Dispose() called if the item supports IDisposable) when the statement completes.
  9241. </remarks>
  9242. </member>
  9243. <member name="F:System.Data.SQLite.SQLiteFunction._base">
  9244. <summary>
  9245. The base connection this function is attached to
  9246. </summary>
  9247. </member>
  9248. <member name="F:System.Data.SQLite.SQLiteFunction._contextDataList">
  9249. <summary>
  9250. Internal array used to keep track of aggregate function context data
  9251. </summary>
  9252. </member>
  9253. <member name="F:System.Data.SQLite.SQLiteFunction._flags">
  9254. <summary>
  9255. The connection flags associated with this object (this should be the
  9256. same value as the flags associated with the parent connection object).
  9257. </summary>
  9258. </member>
  9259. <member name="F:System.Data.SQLite.SQLiteFunction._InvokeFunc">
  9260. <summary>
  9261. Holds a reference to the callback function for user functions
  9262. </summary>
  9263. </member>
  9264. <member name="F:System.Data.SQLite.SQLiteFunction._StepFunc">
  9265. <summary>
  9266. Holds a reference to the callbakc function for stepping in an aggregate function
  9267. </summary>
  9268. </member>
  9269. <member name="F:System.Data.SQLite.SQLiteFunction._FinalFunc">
  9270. <summary>
  9271. Holds a reference to the callback function for finalizing an aggregate function
  9272. </summary>
  9273. </member>
  9274. <member name="F:System.Data.SQLite.SQLiteFunction._CompareFunc">
  9275. <summary>
  9276. Holds a reference to the callback function for collating sequences
  9277. </summary>
  9278. </member>
  9279. <member name="F:System.Data.SQLite.SQLiteFunction._context">
  9280. <summary>
  9281. Current context of the current callback. Only valid during a callback
  9282. </summary>
  9283. </member>
  9284. <member name="F:System.Data.SQLite.SQLiteFunction._registeredFunctions">
  9285. <summary>
  9286. This static dictionary contains all the registered (known) user-defined
  9287. functions declared using the proper attributes. The contained dictionary
  9288. values are always null and are not currently used.
  9289. </summary>
  9290. </member>
  9291. <member name="M:System.Data.SQLite.SQLiteFunction.#ctor">
  9292. <summary>
  9293. Internal constructor, initializes the function's internal variables.
  9294. </summary>
  9295. </member>
  9296. <member name="M:System.Data.SQLite.SQLiteFunction.#ctor(System.Data.SQLite.SQLiteDateFormats,System.DateTimeKind,System.String,System.Boolean)">
  9297. <summary>
  9298. Constructs an instance of this class using the specified data-type
  9299. conversion parameters.
  9300. </summary>
  9301. <param name="format">
  9302. The DateTime format to be used when converting string values to a
  9303. DateTime and binding DateTime parameters.
  9304. </param>
  9305. <param name="kind">
  9306. The <see cref="T:System.DateTimeKind" /> to be used when creating DateTime
  9307. values.
  9308. </param>
  9309. <param name="formatString">
  9310. The format string to be used when parsing and formatting DateTime
  9311. values.
  9312. </param>
  9313. <param name="utf16">
  9314. Non-zero to create a UTF-16 data-type conversion context; otherwise,
  9315. a UTF-8 data-type conversion context will be created.
  9316. </param>
  9317. </member>
  9318. <member name="M:System.Data.SQLite.SQLiteFunction.Dispose">
  9319. <summary>
  9320. Disposes of any active contextData variables that were not automatically cleaned up. Sometimes this can happen if
  9321. someone closes the connection while a DataReader is open.
  9322. </summary>
  9323. </member>
  9324. <member name="M:System.Data.SQLite.SQLiteFunction.Dispose(System.Boolean)">
  9325. <summary>
  9326. Placeholder for a user-defined disposal routine
  9327. </summary>
  9328. <param name="disposing">True if the object is being disposed explicitly</param>
  9329. </member>
  9330. <member name="M:System.Data.SQLite.SQLiteFunction.Finalize">
  9331. <summary>
  9332. Cleans up resources associated with the current instance.
  9333. </summary>
  9334. </member>
  9335. <member name="P:System.Data.SQLite.SQLiteFunction.SQLiteConvert">
  9336. <summary>
  9337. Returns a reference to the underlying connection's SQLiteConvert class, which can be used to convert
  9338. strings and DateTime's into the current connection's encoding schema.
  9339. </summary>
  9340. </member>
  9341. <member name="M:System.Data.SQLite.SQLiteFunction.Invoke(System.Object[])">
  9342. <summary>
  9343. Scalar functions override this method to do their magic.
  9344. </summary>
  9345. <remarks>
  9346. Parameters passed to functions have only an affinity for a certain data type, there is no underlying schema available
  9347. to force them into a certain type. Therefore the only types you will ever see as parameters are
  9348. DBNull.Value, Int64, Double, String or byte[] array.
  9349. </remarks>
  9350. <param name="args">The arguments for the command to process</param>
  9351. <returns>You may return most simple types as a return value, null or DBNull.Value to return null, DateTime, or
  9352. you may return an Exception-derived class if you wish to return an error to SQLite. Do not actually throw the error,
  9353. just return it!</returns>
  9354. </member>
  9355. <member name="M:System.Data.SQLite.SQLiteFunction.Step(System.Object[],System.Int32,System.Object@)">
  9356. <summary>
  9357. Aggregate functions override this method to do their magic.
  9358. </summary>
  9359. <remarks>
  9360. Typically you'll be updating whatever you've placed in the contextData field and returning as quickly as possible.
  9361. </remarks>
  9362. <param name="args">The arguments for the command to process</param>
  9363. <param name="stepNumber">The 1-based step number. This is incrememted each time the step method is called.</param>
  9364. <param name="contextData">A placeholder for implementers to store contextual data pertaining to the current context.</param>
  9365. </member>
  9366. <member name="M:System.Data.SQLite.SQLiteFunction.Final(System.Object)">
  9367. <summary>
  9368. Aggregate functions override this method to finish their aggregate processing.
  9369. </summary>
  9370. <remarks>
  9371. If you implemented your aggregate function properly,
  9372. you've been recording and keeping track of your data in the contextData object provided, and now at this stage you should have
  9373. all the information you need in there to figure out what to return.
  9374. NOTE: It is possible to arrive here without receiving a previous call to Step(), in which case the contextData will
  9375. be null. This can happen when no rows were returned. You can either return null, or 0 or some other custom return value
  9376. if that is the case.
  9377. </remarks>
  9378. <param name="contextData">Your own assigned contextData, provided for you so you can return your final results.</param>
  9379. <returns>You may return most simple types as a return value, null or DBNull.Value to return null, DateTime, or
  9380. you may return an Exception-derived class if you wish to return an error to SQLite. Do not actually throw the error,
  9381. just return it!
  9382. </returns>
  9383. </member>
  9384. <member name="M:System.Data.SQLite.SQLiteFunction.Compare(System.String,System.String)">
  9385. <summary>
  9386. User-defined collating sequences override this method to provide a custom string sorting algorithm.
  9387. </summary>
  9388. <param name="param1">The first string to compare.</param>
  9389. <param name="param2">The second strnig to compare.</param>
  9390. <returns>1 if param1 is greater than param2, 0 if they are equal, or -1 if param1 is less than param2.</returns>
  9391. </member>
  9392. <member name="M:System.Data.SQLite.SQLiteFunction.ConvertParams(System.Int32,System.IntPtr)">
  9393. <summary>
  9394. Converts an IntPtr array of context arguments to an object array containing the resolved parameters the pointers point to.
  9395. </summary>
  9396. <remarks>
  9397. Parameters passed to functions have only an affinity for a certain data type, there is no underlying schema available
  9398. to force them into a certain type. Therefore the only types you will ever see as parameters are
  9399. DBNull.Value, Int64, Double, String or byte[] array.
  9400. </remarks>
  9401. <param name="nArgs">The number of arguments</param>
  9402. <param name="argsptr">A pointer to the array of arguments</param>
  9403. <returns>An object array of the arguments once they've been converted to .NET values</returns>
  9404. </member>
  9405. <member name="M:System.Data.SQLite.SQLiteFunction.SetReturnValue(System.IntPtr,System.Object)">
  9406. <summary>
  9407. Takes the return value from Invoke() and Final() and figures out how to return it to SQLite's context.
  9408. </summary>
  9409. <param name="context">The context the return value applies to</param>
  9410. <param name="returnValue">The parameter to return to SQLite</param>
  9411. </member>
  9412. <member name="M:System.Data.SQLite.SQLiteFunction.ScalarCallback(System.IntPtr,System.Int32,System.IntPtr)">
  9413. <summary>
  9414. Internal scalar callback function, which wraps the raw context pointer and calls the virtual Invoke() method.
  9415. WARNING: Must not throw exceptions.
  9416. </summary>
  9417. <param name="context">A raw context pointer</param>
  9418. <param name="nArgs">Number of arguments passed in</param>
  9419. <param name="argsptr">A pointer to the array of arguments</param>
  9420. </member>
  9421. <member name="M:System.Data.SQLite.SQLiteFunction.CompareCallback(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)">
  9422. <summary>
  9423. Internal collating sequence function, which wraps up the raw string pointers and executes the Compare() virtual function.
  9424. WARNING: Must not throw exceptions.
  9425. </summary>
  9426. <param name="ptr">Not used</param>
  9427. <param name="len1">Length of the string pv1</param>
  9428. <param name="ptr1">Pointer to the first string to compare</param>
  9429. <param name="len2">Length of the string pv2</param>
  9430. <param name="ptr2">Pointer to the second string to compare</param>
  9431. <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
  9432. than the second. Returns 0 if an exception is caught.</returns>
  9433. </member>
  9434. <member name="M:System.Data.SQLite.SQLiteFunction.CompareCallback16(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)">
  9435. <summary>
  9436. Internal collating sequence function, which wraps up the raw string pointers and executes the Compare() virtual function.
  9437. WARNING: Must not throw exceptions.
  9438. </summary>
  9439. <param name="ptr">Not used</param>
  9440. <param name="len1">Length of the string pv1</param>
  9441. <param name="ptr1">Pointer to the first string to compare</param>
  9442. <param name="len2">Length of the string pv2</param>
  9443. <param name="ptr2">Pointer to the second string to compare</param>
  9444. <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
  9445. than the second. Returns 0 if an exception is caught.</returns>
  9446. </member>
  9447. <member name="M:System.Data.SQLite.SQLiteFunction.StepCallback(System.IntPtr,System.Int32,System.IntPtr)">
  9448. <summary>
  9449. The internal aggregate Step function callback, which wraps the raw context pointer and calls the virtual Step() method.
  9450. WARNING: Must not throw exceptions.
  9451. </summary>
  9452. <remarks>
  9453. This function takes care of doing the lookups and getting the important information put together to call the Step() function.
  9454. That includes pulling out the user's contextData and updating it after the call is made. We use a sorted list for this so
  9455. binary searches can be done to find the data.
  9456. </remarks>
  9457. <param name="context">A raw context pointer</param>
  9458. <param name="nArgs">Number of arguments passed in</param>
  9459. <param name="argsptr">A pointer to the array of arguments</param>
  9460. </member>
  9461. <member name="M:System.Data.SQLite.SQLiteFunction.FinalCallback(System.IntPtr)">
  9462. <summary>
  9463. An internal aggregate Final function callback, which wraps the context pointer and calls the virtual Final() method.
  9464. WARNING: Must not throw exceptions.
  9465. </summary>
  9466. <param name="context">A raw context pointer</param>
  9467. </member>
  9468. <member name="M:System.Data.SQLite.SQLiteFunction.#cctor">
  9469. <summary>
  9470. Using reflection, enumerate all assemblies in the current appdomain looking for classes that
  9471. have a SQLiteFunctionAttribute attribute, and registering them accordingly.
  9472. </summary>
  9473. </member>
  9474. <member name="M:System.Data.SQLite.SQLiteFunction.RegisterFunction(System.Type)">
  9475. <summary>
  9476. Manual method of registering a function. The type must still have the SQLiteFunctionAttributes in order to work
  9477. properly, but this is a workaround for the Compact Framework where enumerating assemblies is not currently supported.
  9478. </summary>
  9479. <param name="typ">The type of the function to register</param>
  9480. </member>
  9481. <member name="M:System.Data.SQLite.SQLiteFunction.RegisterFunction(System.String,System.Int32,System.Data.SQLite.FunctionType,System.Type,System.Delegate,System.Delegate)">
  9482. <summary>
  9483. Alternative method of registering a function. This method
  9484. does not require the specified type to be annotated with
  9485. <see cref="T:System.Data.SQLite.SQLiteFunctionAttribute" />.
  9486. </summary>
  9487. <param name="name">
  9488. The name of the function to register.
  9489. </param>
  9490. <param name="argumentCount">
  9491. The number of arguments accepted by the function.
  9492. </param>
  9493. <param name="functionType">
  9494. The type of SQLite function being resitered (e.g. scalar,
  9495. aggregate, or collating sequence).
  9496. </param>
  9497. <param name="instanceType">
  9498. The <see cref="T:System.Type" /> that actually implements the function.
  9499. This will only be used if the <paramref name="callback1" />
  9500. and <paramref name="callback2" /> parameters are null.
  9501. </param>
  9502. <param name="callback1">
  9503. The <see cref="T:System.Delegate" /> to be used for all calls into the
  9504. <see cref="M:System.Data.SQLite.SQLiteFunction.Invoke(System.Object[])" />,
  9505. <see cref="M:System.Data.SQLite.SQLiteFunction.Step(System.Object[],System.Int32,System.Object@)" />,
  9506. and <see cref="M:System.Data.SQLite.SQLiteFunction.Compare(System.String,System.String)" /> virtual methods.
  9507. </param>
  9508. <param name="callback2">
  9509. The <see cref="T:System.Delegate" /> to be used for all calls into the
  9510. <see cref="M:System.Data.SQLite.SQLiteFunction.Final(System.Object)" /> virtual method. This
  9511. parameter is only necessary for aggregate functions.
  9512. </param>
  9513. </member>
  9514. <member name="M:System.Data.SQLite.SQLiteFunction.ReplaceFunction(System.Data.SQLite.SQLiteFunctionAttribute,System.Object)">
  9515. <summary>
  9516. Replaces a registered function, disposing of the associated (old)
  9517. value if necessary.
  9518. </summary>
  9519. <param name="at">
  9520. The attribute that describes the function to replace.
  9521. </param>
  9522. <param name="newValue">
  9523. The new value to use.
  9524. </param>
  9525. <returns>
  9526. Non-zero if an existing registered function was replaced; otherwise,
  9527. zero.
  9528. </returns>
  9529. </member>
  9530. <member name="M:System.Data.SQLite.SQLiteFunction.CreateFunction(System.Data.SQLite.SQLiteFunctionAttribute,System.Data.SQLite.SQLiteFunction@)">
  9531. <summary>
  9532. Creates a <see cref="T:System.Data.SQLite.SQLiteFunction" /> instance based on the specified
  9533. <see cref="T:System.Data.SQLite.SQLiteFunctionAttribute" />.
  9534. </summary>
  9535. <param name="functionAttribute">
  9536. The <see cref="T:System.Data.SQLite.SQLiteFunctionAttribute" /> containing the metadata about
  9537. the function to create.
  9538. </param>
  9539. <param name="function">
  9540. The created function -OR- null if the function could not be created.
  9541. </param>
  9542. <returns>
  9543. Non-zero if the function was created; otherwise, zero.
  9544. </returns>
  9545. </member>
  9546. <member name="M:System.Data.SQLite.SQLiteFunction.BindFunctions(System.Data.SQLite.SQLiteBase,System.Data.SQLite.SQLiteConnectionFlags)">
  9547. <summary>
  9548. Called by the SQLiteBase derived classes, this method binds all registered (known) user-defined functions to a connection.
  9549. It is done this way so that all user-defined functions will access the database using the same encoding scheme
  9550. as the connection (UTF-8 or UTF-16).
  9551. </summary>
  9552. <remarks>
  9553. The wrapper functions that interop with SQLite will create a unique cookie value, which internally is a pointer to
  9554. all the wrapped callback functions. The interop function uses it to map CDecl callbacks to StdCall callbacks.
  9555. </remarks>
  9556. <param name="sqlbase">The base object on which the functions are to bind.</param>
  9557. <param name="flags">The flags associated with the parent connection object.</param>
  9558. <returns>Returns a logical list of functions which the connection should retain until it is closed.</returns>
  9559. </member>
  9560. <member name="M:System.Data.SQLite.SQLiteFunction.UnbindAllFunctions(System.Data.SQLite.SQLiteBase,System.Data.SQLite.SQLiteConnectionFlags,System.Boolean)">
  9561. <summary>
  9562. Called by the SQLiteBase derived classes, this method unbinds all registered (known)
  9563. functions -OR- all previously bound user-defined functions from a connection.
  9564. </summary>
  9565. <param name="sqlbase">The base object from which the functions are to be unbound.</param>
  9566. <param name="flags">The flags associated with the parent connection object.</param>
  9567. <param name="registered">
  9568. Non-zero to unbind all registered (known) functions -OR- zero to unbind all functions
  9569. currently bound to the connection.
  9570. </param>
  9571. <returns>Non-zero if all the specified user-defined functions were unbound.</returns>
  9572. </member>
  9573. <member name="M:System.Data.SQLite.SQLiteFunction.BindFunction(System.Data.SQLite.SQLiteBase,System.Data.SQLite.SQLiteFunctionAttribute,System.Data.SQLite.SQLiteFunction,System.Data.SQLite.SQLiteConnectionFlags)">
  9574. <summary>
  9575. This function binds a user-defined function to a connection.
  9576. </summary>
  9577. <param name="sqliteBase">
  9578. The <see cref="T:System.Data.SQLite.SQLiteBase" /> object instance associated with the
  9579. <see cref="T:System.Data.SQLite.SQLiteConnection" /> that the function should be bound to.
  9580. </param>
  9581. <param name="functionAttribute">
  9582. The <see cref="T:System.Data.SQLite.SQLiteFunctionAttribute"/> object instance containing
  9583. the metadata for the function to be bound.
  9584. </param>
  9585. <param name="function">
  9586. The <see cref="T:System.Data.SQLite.SQLiteFunction"/> object instance that implements the
  9587. function to be bound.
  9588. </param>
  9589. <param name="flags">
  9590. The flags associated with the parent connection object.
  9591. </param>
  9592. </member>
  9593. <member name="M:System.Data.SQLite.SQLiteFunction.UnbindFunction(System.Data.SQLite.SQLiteBase,System.Data.SQLite.SQLiteFunctionAttribute,System.Data.SQLite.SQLiteFunction,System.Data.SQLite.SQLiteConnectionFlags)">
  9594. <summary>
  9595. This function unbinds a user-defined functions from a connection.
  9596. </summary>
  9597. <param name="sqliteBase">
  9598. The <see cref="T:System.Data.SQLite.SQLiteBase" /> object instance associated with the
  9599. <see cref="T:System.Data.SQLite.SQLiteConnection" /> that the function should be bound to.
  9600. </param>
  9601. <param name="functionAttribute">
  9602. The <see cref="T:System.Data.SQLite.SQLiteFunctionAttribute"/> object instance containing
  9603. the metadata for the function to be bound.
  9604. </param>
  9605. <param name="function">
  9606. The <see cref="T:System.Data.SQLite.SQLiteFunction"/> object instance that implements the
  9607. function to be bound.
  9608. </param>
  9609. <param name="flags">
  9610. The flags associated with the parent connection object.
  9611. </param>
  9612. <returns>Non-zero if the function was unbound.</returns>
  9613. </member>
  9614. <member name="T:System.Data.SQLite.SQLiteInvokeDelegate">
  9615. <summary>
  9616. This <see cref="T:System.Delegate" /> type is used with the
  9617. <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Invoke(System.Object[])" /> method.
  9618. </summary>
  9619. <param name="param0">
  9620. This is always the string literal "Invoke".
  9621. </param>
  9622. <param name="args">
  9623. The arguments for the scalar function.
  9624. </param>
  9625. <returns>
  9626. The result of the scalar function.
  9627. </returns>
  9628. </member>
  9629. <member name="T:System.Data.SQLite.SQLiteStepDelegate">
  9630. <summary>
  9631. This <see cref="T:System.Delegate" /> type is used with the
  9632. <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Step(System.Object[],System.Int32,System.Object@)" /> method.
  9633. </summary>
  9634. <param name="param0">
  9635. This is always the string literal "Step".
  9636. </param>
  9637. <param name="args">
  9638. The arguments for the aggregate function.
  9639. </param>
  9640. <param name="stepNumber">
  9641. The step number (one based). This is incrememted each time the
  9642. <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Step(System.Object[],System.Int32,System.Object@)" /> method is called.
  9643. </param>
  9644. <param name="contextData">
  9645. A placeholder for implementers to store contextual data pertaining
  9646. to the current context.
  9647. </param>
  9648. </member>
  9649. <member name="T:System.Data.SQLite.SQLiteFinalDelegate">
  9650. <summary>
  9651. This <see cref="T:System.Delegate" /> type is used with the
  9652. <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Final(System.Object)" /> method.
  9653. </summary>
  9654. <param name="param0">
  9655. This is always the string literal "Final".
  9656. </param>
  9657. <param name="contextData">
  9658. A placeholder for implementers to store contextual data pertaining
  9659. to the current context.
  9660. </param>
  9661. <returns>
  9662. The result of the aggregate function.
  9663. </returns>
  9664. </member>
  9665. <member name="T:System.Data.SQLite.SQLiteCompareDelegate">
  9666. <summary>
  9667. This <see cref="T:System.Delegate" /> type is used with the
  9668. <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Compare(System.String,System.String)" /> method.
  9669. </summary>
  9670. <param name="param0">
  9671. This is always the string literal "Compare".
  9672. </param>
  9673. <param name="param1">
  9674. The first string to compare.
  9675. </param>
  9676. <param name="param2">
  9677. The second strnig to compare.
  9678. </param>
  9679. <returns>
  9680. A positive integer if the <paramref name="param1" /> parameter is
  9681. greater than the <paramref name="param2" /> parameter, a negative
  9682. integer if the <paramref name="param1" /> parameter is less than
  9683. the <paramref name="param2" /> parameter, or zero if they are
  9684. equal.
  9685. </returns>
  9686. </member>
  9687. <member name="T:System.Data.SQLite.SQLiteDelegateFunction">
  9688. <summary>
  9689. This class implements a SQLite function using a <see cref="T:System.Delegate" />.
  9690. All the virtual methods of the <see cref="T:System.Data.SQLite.SQLiteFunction" /> class are
  9691. implemented using calls to the <see cref="T:System.Data.SQLite.SQLiteInvokeDelegate" />,
  9692. <see cref="T:System.Data.SQLite.SQLiteStepDelegate" />, <see cref="T:System.Data.SQLite.SQLiteFinalDelegate" />,
  9693. and <see cref="T:System.Data.SQLite.SQLiteCompareDelegate" /> strongly typed delegate types
  9694. or via the <see cref="M:System.Delegate.DynamicInvoke(System.Object[])" /> method.
  9695. The arguments are presented in the same order they appear in
  9696. the associated <see cref="T:System.Data.SQLite.SQLiteFunction" /> methods with one exception:
  9697. the first argument is the name of the virtual method being implemented.
  9698. </summary>
  9699. </member>
  9700. <member name="F:System.Data.SQLite.SQLiteDelegateFunction.NoCallbackError">
  9701. <summary>
  9702. This error message is used by the overridden virtual methods when
  9703. a required <see cref="T:System.Delegate" /> property (e.g.
  9704. <see cref="P:System.Data.SQLite.SQLiteDelegateFunction.Callback1" /> or <see cref="P:System.Data.SQLite.SQLiteDelegateFunction.Callback2" />) has not been
  9705. set.
  9706. </summary>
  9707. </member>
  9708. <member name="F:System.Data.SQLite.SQLiteDelegateFunction.ResultInt32Error">
  9709. <summary>
  9710. This error message is used by the overridden <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Compare(System.String,System.String)" />
  9711. method when the result does not have a type of <see cref="T:System.Int32" />.
  9712. </summary>
  9713. </member>
  9714. <member name="M:System.Data.SQLite.SQLiteDelegateFunction.#ctor">
  9715. <summary>
  9716. Constructs an empty instance of this class.
  9717. </summary>
  9718. </member>
  9719. <member name="M:System.Data.SQLite.SQLiteDelegateFunction.#ctor(System.Delegate,System.Delegate)">
  9720. <summary>
  9721. Constructs an instance of this class using the specified
  9722. <see cref="T:System.Delegate" /> as the <see cref="T:System.Data.SQLite.SQLiteFunction" />
  9723. implementation.
  9724. </summary>
  9725. <param name="callback1">
  9726. The <see cref="T:System.Delegate" /> to be used for all calls into the
  9727. <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
  9728. <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Compare(System.String,System.String)" /> virtual methods needed by the
  9729. <see cref="T:System.Data.SQLite.SQLiteFunction" /> base class.
  9730. </param>
  9731. <param name="callback2">
  9732. The <see cref="T:System.Delegate" /> to be used for all calls into the
  9733. <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Final(System.Object)" /> virtual methods needed by the
  9734. <see cref="T:System.Data.SQLite.SQLiteFunction" /> base class.
  9735. </param>
  9736. </member>
  9737. <member name="M:System.Data.SQLite.SQLiteDelegateFunction.GetInvokeArgs(System.Object[],System.Boolean)">
  9738. <summary>
  9739. Returns the list of arguments for the <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Invoke(System.Object[])" /> method,
  9740. as an <see cref="T:System.Array" /> of <see cref="T:System.Object" />. The first
  9741. argument is always the literal string "Invoke".
  9742. </summary>
  9743. <param name="args">
  9744. The original arguments received by the <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Invoke(System.Object[])" /> method.
  9745. </param>
  9746. <param name="earlyBound">
  9747. Non-zero if the returned arguments are going to be used with the
  9748. <see cref="T:System.Data.SQLite.SQLiteInvokeDelegate" /> type; otherwise, zero.
  9749. </param>
  9750. <returns>
  9751. The arguments to pass to the configured <see cref="T:System.Delegate" />.
  9752. </returns>
  9753. </member>
  9754. <member name="M:System.Data.SQLite.SQLiteDelegateFunction.GetStepArgs(System.Object[],System.Int32,System.Object,System.Boolean)">
  9755. <summary>
  9756. Returns the list of arguments for the <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Step(System.Object[],System.Int32,System.Object@)" /> method,
  9757. as an <see cref="T:System.Array" /> of <see cref="T:System.Object" />. The first
  9758. argument is always the literal string "Step".
  9759. </summary>
  9760. <param name="args">
  9761. The original arguments received by the <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Step(System.Object[],System.Int32,System.Object@)" /> method.
  9762. </param>
  9763. <param name="stepNumber">
  9764. The step number (one based). This is incrememted each time the
  9765. <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Step(System.Object[],System.Int32,System.Object@)" /> method is called.
  9766. </param>
  9767. <param name="contextData">
  9768. A placeholder for implementers to store contextual data pertaining
  9769. to the current context.
  9770. </param>
  9771. <param name="earlyBound">
  9772. Non-zero if the returned arguments are going to be used with the
  9773. <see cref="T:System.Data.SQLite.SQLiteStepDelegate" /> type; otherwise, zero.
  9774. </param>
  9775. <returns>
  9776. The arguments to pass to the configured <see cref="T:System.Delegate" />.
  9777. </returns>
  9778. </member>
  9779. <member name="M:System.Data.SQLite.SQLiteDelegateFunction.UpdateStepArgs(System.Object[],System.Object@,System.Boolean)">
  9780. <summary>
  9781. Updates the output arguments for the <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Step(System.Object[],System.Int32,System.Object@)" /> method,
  9782. using an <see cref="T:System.Array" /> of <see cref="T:System.Object" />. The first
  9783. argument is always the literal string "Step". Currently, only the
  9784. <paramref name="contextData" /> parameter is updated.
  9785. </summary>
  9786. <param name="args">
  9787. The original arguments received by the <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Step(System.Object[],System.Int32,System.Object@)" /> method.
  9788. </param>
  9789. <param name="contextData">
  9790. A placeholder for implementers to store contextual data pertaining
  9791. to the current context.
  9792. </param>
  9793. <param name="earlyBound">
  9794. Non-zero if the returned arguments are going to be used with the
  9795. <see cref="T:System.Data.SQLite.SQLiteStepDelegate" /> type; otherwise, zero.
  9796. </param>
  9797. <returns>
  9798. The arguments to pass to the configured <see cref="T:System.Delegate" />.
  9799. </returns>
  9800. </member>
  9801. <member name="M:System.Data.SQLite.SQLiteDelegateFunction.GetFinalArgs(System.Object,System.Boolean)">
  9802. <summary>
  9803. Returns the list of arguments for the <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Final(System.Object)" /> method,
  9804. as an <see cref="T:System.Array" /> of <see cref="T:System.Object" />. The first
  9805. argument is always the literal string "Final".
  9806. </summary>
  9807. <param name="contextData">
  9808. A placeholder for implementers to store contextual data pertaining
  9809. to the current context.
  9810. </param>
  9811. <param name="earlyBound">
  9812. Non-zero if the returned arguments are going to be used with the
  9813. <see cref="T:System.Data.SQLite.SQLiteFinalDelegate" /> type; otherwise, zero.
  9814. </param>
  9815. <returns>
  9816. The arguments to pass to the configured <see cref="T:System.Delegate" />.
  9817. </returns>
  9818. </member>
  9819. <member name="M:System.Data.SQLite.SQLiteDelegateFunction.GetCompareArgs(System.String,System.String,System.Boolean)">
  9820. <summary>
  9821. Returns the list of arguments for the <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Compare(System.String,System.String)" /> method,
  9822. as an <see cref="T:System.Array" /> of <see cref="T:System.Object" />. The first
  9823. argument is always the literal string "Compare".
  9824. </summary>
  9825. <param name="param1">
  9826. The first string to compare.
  9827. </param>
  9828. <param name="param2">
  9829. The second strnig to compare.
  9830. </param>
  9831. <param name="earlyBound">
  9832. Non-zero if the returned arguments are going to be used with the
  9833. <see cref="T:System.Data.SQLite.SQLiteCompareDelegate" /> type; otherwise, zero.
  9834. </param>
  9835. <returns>
  9836. The arguments to pass to the configured <see cref="T:System.Delegate" />.
  9837. </returns>
  9838. </member>
  9839. <member name="P:System.Data.SQLite.SQLiteDelegateFunction.Callback1">
  9840. <summary>
  9841. The <see cref="T:System.Delegate" /> to be used for all calls into the
  9842. <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
  9843. <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Compare(System.String,System.String)" /> virtual methods needed by the
  9844. <see cref="T:System.Data.SQLite.SQLiteFunction" /> base class.
  9845. </summary>
  9846. </member>
  9847. <member name="P:System.Data.SQLite.SQLiteDelegateFunction.Callback2">
  9848. <summary>
  9849. The <see cref="T:System.Delegate" /> to be used for all calls into the
  9850. <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Final(System.Object)" /> virtual methods needed by the
  9851. <see cref="T:System.Data.SQLite.SQLiteFunction" /> base class.
  9852. </summary>
  9853. </member>
  9854. <member name="M:System.Data.SQLite.SQLiteDelegateFunction.Invoke(System.Object[])">
  9855. <summary>
  9856. This virtual method is the implementation for scalar functions.
  9857. See the <see cref="M:System.Data.SQLite.SQLiteFunction.Invoke(System.Object[])" /> method for more
  9858. details.
  9859. </summary>
  9860. <param name="args">
  9861. The arguments for the scalar function.
  9862. </param>
  9863. <returns>
  9864. The result of the scalar function.
  9865. </returns>
  9866. </member>
  9867. <member name="M:System.Data.SQLite.SQLiteDelegateFunction.Step(System.Object[],System.Int32,System.Object@)">
  9868. <summary>
  9869. This virtual method is part of the implementation for aggregate
  9870. functions. See the <see cref="M:System.Data.SQLite.SQLiteFunction.Step(System.Object[],System.Int32,System.Object@)" /> method
  9871. for more details.
  9872. </summary>
  9873. <param name="args">
  9874. The arguments for the aggregate function.
  9875. </param>
  9876. <param name="stepNumber">
  9877. The step number (one based). This is incrememted each time the
  9878. <see cref="M:System.Data.SQLite.SQLiteDelegateFunction.Step(System.Object[],System.Int32,System.Object@)" /> method is called.
  9879. </param>
  9880. <param name="contextData">
  9881. A placeholder for implementers to store contextual data pertaining
  9882. to the current context.
  9883. </param>
  9884. </member>
  9885. <member name="M:System.Data.SQLite.SQLiteDelegateFunction.Final(System.Object)">
  9886. <summary>
  9887. This virtual method is part of the implementation for aggregate
  9888. functions. See the <see cref="M:System.Data.SQLite.SQLiteFunction.Final(System.Object)" /> method
  9889. for more details.
  9890. </summary>
  9891. <param name="contextData">
  9892. A placeholder for implementers to store contextual data pertaining
  9893. to the current context.
  9894. </param>
  9895. <returns>
  9896. The result of the aggregate function.
  9897. </returns>
  9898. </member>
  9899. <member name="M:System.Data.SQLite.SQLiteDelegateFunction.Compare(System.String,System.String)">
  9900. <summary>
  9901. This virtual method is part of the implementation for collating
  9902. sequences. See the <see cref="M:System.Data.SQLite.SQLiteFunction.Compare(System.String,System.String)" /> method
  9903. for more details.
  9904. </summary>
  9905. <param name="param1">
  9906. The first string to compare.
  9907. </param>
  9908. <param name="param2">
  9909. The second strnig to compare.
  9910. </param>
  9911. <returns>
  9912. A positive integer if the <paramref name="param1" /> parameter is
  9913. greater than the <paramref name="param2" /> parameter, a negative
  9914. integer if the <paramref name="param1" /> parameter is less than
  9915. the <paramref name="param2" /> parameter, or zero if they are
  9916. equal.
  9917. </returns>
  9918. </member>
  9919. <member name="T:System.Data.SQLite.SQLiteFunctionEx">
  9920. <summary>
  9921. Extends SQLiteFunction and allows an inherited class to obtain the collating sequence associated with a function call.
  9922. </summary>
  9923. <remarks>
  9924. User-defined functions can call the GetCollationSequence() method in this class and use it to compare strings and char arrays.
  9925. </remarks>
  9926. </member>
  9927. <member name="M:System.Data.SQLite.SQLiteFunctionEx.GetCollationSequence">
  9928. <summary>
  9929. Obtains the collating sequence in effect for the given function.
  9930. </summary>
  9931. <returns></returns>
  9932. </member>
  9933. <member name="M:System.Data.SQLite.SQLiteFunctionEx.Dispose(System.Boolean)">
  9934. <summary>
  9935. Cleans up resources (native and managed) associated with the current instance.
  9936. </summary>
  9937. <param name="disposing">
  9938. Zero when being disposed via garbage collection; otherwise, non-zero.
  9939. </param>
  9940. </member>
  9941. <member name="T:System.Data.SQLite.FunctionType">
  9942. <summary>
  9943. The type of user-defined function to declare
  9944. </summary>
  9945. </member>
  9946. <member name="F:System.Data.SQLite.FunctionType.Scalar">
  9947. <summary>
  9948. Scalar functions are designed to be called and return a result immediately. Examples include ABS(), Upper(), Lower(), etc.
  9949. </summary>
  9950. </member>
  9951. <member name="F:System.Data.SQLite.FunctionType.Aggregate">
  9952. <summary>
  9953. Aggregate functions are designed to accumulate data until the end of a call and then return a result gleaned from the accumulated data.
  9954. Examples include SUM(), COUNT(), AVG(), etc.
  9955. </summary>
  9956. </member>
  9957. <member name="F:System.Data.SQLite.FunctionType.Collation">
  9958. <summary>
  9959. 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
  9960. sorted using a straight case-insensitive comparison function. Custom collating sequences can be used to alter the behavior of text sorting
  9961. in a user-defined manner.
  9962. </summary>
  9963. </member>
  9964. <member name="T:System.Data.SQLite.SQLiteCallback">
  9965. <summary>
  9966. An internal callback delegate declaration.
  9967. </summary>
  9968. <param name="context">Raw native context pointer for the user function.</param>
  9969. <param name="argc">Total number of arguments to the user function.</param>
  9970. <param name="argv">Raw native pointer to the array of raw native argument pointers.</param>
  9971. </member>
  9972. <member name="T:System.Data.SQLite.SQLiteFinalCallback">
  9973. <summary>
  9974. An internal final callback delegate declaration.
  9975. </summary>
  9976. <param name="context">Raw context pointer for the user function</param>
  9977. </member>
  9978. <member name="T:System.Data.SQLite.SQLiteCollation">
  9979. <summary>
  9980. Internal callback delegate for implementing collating sequences
  9981. </summary>
  9982. <param name="puser">Not used</param>
  9983. <param name="len1">Length of the string pv1</param>
  9984. <param name="pv1">Pointer to the first string to compare</param>
  9985. <param name="len2">Length of the string pv2</param>
  9986. <param name="pv2">Pointer to the second string to compare</param>
  9987. <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
  9988. than the second.</returns>
  9989. </member>
  9990. <member name="T:System.Data.SQLite.CollationTypeEnum">
  9991. <summary>
  9992. The type of collating sequence
  9993. </summary>
  9994. </member>
  9995. <member name="F:System.Data.SQLite.CollationTypeEnum.Binary">
  9996. <summary>
  9997. The built-in BINARY collating sequence
  9998. </summary>
  9999. </member>
  10000. <member name="F:System.Data.SQLite.CollationTypeEnum.NoCase">
  10001. <summary>
  10002. The built-in NOCASE collating sequence
  10003. </summary>
  10004. </member>
  10005. <member name="F:System.Data.SQLite.CollationTypeEnum.Reverse">
  10006. <summary>
  10007. The built-in REVERSE collating sequence
  10008. </summary>
  10009. </member>
  10010. <member name="F:System.Data.SQLite.CollationTypeEnum.Custom">
  10011. <summary>
  10012. A custom user-defined collating sequence
  10013. </summary>
  10014. </member>
  10015. <member name="T:System.Data.SQLite.CollationEncodingEnum">
  10016. <summary>
  10017. The encoding type the collation sequence uses
  10018. </summary>
  10019. </member>
  10020. <member name="F:System.Data.SQLite.CollationEncodingEnum.UTF8">
  10021. <summary>
  10022. The collation sequence is UTF8
  10023. </summary>
  10024. </member>
  10025. <member name="F:System.Data.SQLite.CollationEncodingEnum.UTF16LE">
  10026. <summary>
  10027. The collation sequence is UTF16 little-endian
  10028. </summary>
  10029. </member>
  10030. <member name="F:System.Data.SQLite.CollationEncodingEnum.UTF16BE">
  10031. <summary>
  10032. The collation sequence is UTF16 big-endian
  10033. </summary>
  10034. </member>
  10035. <member name="T:System.Data.SQLite.CollationSequence">
  10036. <summary>
  10037. A struct describing the collating sequence a function is executing in
  10038. </summary>
  10039. </member>
  10040. <member name="F:System.Data.SQLite.CollationSequence.Name">
  10041. <summary>
  10042. The name of the collating sequence
  10043. </summary>
  10044. </member>
  10045. <member name="F:System.Data.SQLite.CollationSequence.Type">
  10046. <summary>
  10047. The type of collating sequence
  10048. </summary>
  10049. </member>
  10050. <member name="F:System.Data.SQLite.CollationSequence.Encoding">
  10051. <summary>
  10052. The text encoding of the collation sequence
  10053. </summary>
  10054. </member>
  10055. <member name="F:System.Data.SQLite.CollationSequence._func">
  10056. <summary>
  10057. Context of the function that requested the collating sequence
  10058. </summary>
  10059. </member>
  10060. <member name="M:System.Data.SQLite.CollationSequence.Compare(System.String,System.String)">
  10061. <summary>
  10062. Calls the base collating sequence to compare two strings
  10063. </summary>
  10064. <param name="s1">The first string to compare</param>
  10065. <param name="s2">The second string to compare</param>
  10066. <returns>-1 if s1 is less than s2, 0 if s1 is equal to s2, and 1 if s1 is greater than s2</returns>
  10067. </member>
  10068. <member name="M:System.Data.SQLite.CollationSequence.Compare(System.Char[],System.Char[])">
  10069. <summary>
  10070. Calls the base collating sequence to compare two character arrays
  10071. </summary>
  10072. <param name="c1">The first array to compare</param>
  10073. <param name="c2">The second array to compare</param>
  10074. <returns>-1 if c1 is less than c2, 0 if c1 is equal to c2, and 1 if c1 is greater than c2</returns>
  10075. </member>
  10076. <member name="T:System.Data.SQLite.SQLiteFunctionAttribute">
  10077. <summary>
  10078. A simple custom attribute to enable us to easily find user-defined functions in
  10079. the loaded assemblies and initialize them in SQLite as connections are made.
  10080. </summary>
  10081. </member>
  10082. <member name="M:System.Data.SQLite.SQLiteFunctionAttribute.#ctor">
  10083. <summary>
  10084. Default constructor, initializes the internal variables for the function.
  10085. </summary>
  10086. </member>
  10087. <member name="M:System.Data.SQLite.SQLiteFunctionAttribute.#ctor(System.String,System.Int32,System.Data.SQLite.FunctionType)">
  10088. <summary>
  10089. Constructs an instance of this class. This sets the initial
  10090. <see cref="P:System.Data.SQLite.SQLiteFunctionAttribute.InstanceType" />, <see cref="P:System.Data.SQLite.SQLiteFunctionAttribute.Callback1" />, and
  10091. <see cref="P:System.Data.SQLite.SQLiteFunctionAttribute.Callback2" /> properties to null.
  10092. </summary>
  10093. <param name="name">
  10094. The name of the function, as seen by the SQLite core library.
  10095. </param>
  10096. <param name="argumentCount">
  10097. The number of arguments that the function will accept.
  10098. </param>
  10099. <param name="functionType">
  10100. The type of function being declared. This will either be Scalar,
  10101. Aggregate, or Collation.
  10102. </param>
  10103. </member>
  10104. <member name="P:System.Data.SQLite.SQLiteFunctionAttribute.Name">
  10105. <summary>
  10106. The function's name as it will be used in SQLite command text.
  10107. </summary>
  10108. </member>
  10109. <member name="P:System.Data.SQLite.SQLiteFunctionAttribute.Arguments">
  10110. <summary>
  10111. The number of arguments this function expects. -1 if the number of arguments is variable.
  10112. </summary>
  10113. </member>
  10114. <member name="P:System.Data.SQLite.SQLiteFunctionAttribute.FuncType">
  10115. <summary>
  10116. The type of function this implementation will be.
  10117. </summary>
  10118. </member>
  10119. <member name="P:System.Data.SQLite.SQLiteFunctionAttribute.InstanceType">
  10120. <summary>
  10121. The <see cref="T:System.Type" /> object instance that describes the class
  10122. containing the implementation for the associated function. The value of
  10123. this property will not be used if either the <see cref="P:System.Data.SQLite.SQLiteFunctionAttribute.Callback1" /> or
  10124. <see cref="P:System.Data.SQLite.SQLiteFunctionAttribute.Callback2" /> property values are set to non-null.
  10125. </summary>
  10126. </member>
  10127. <member name="P:System.Data.SQLite.SQLiteFunctionAttribute.Callback1">
  10128. <summary>
  10129. The <see cref="T:System.Delegate" /> that refers to the implementation for the
  10130. associated function. If this property value is set to non-null, it will
  10131. be used instead of the <see cref="P:System.Data.SQLite.SQLiteFunctionAttribute.InstanceType" /> property value.
  10132. </summary>
  10133. </member>
  10134. <member name="P:System.Data.SQLite.SQLiteFunctionAttribute.Callback2">
  10135. <summary>
  10136. The <see cref="T:System.Delegate" /> that refers to the implementation for the
  10137. associated function. If this property value is set to non-null, it will
  10138. be used instead of the <see cref="P:System.Data.SQLite.SQLiteFunctionAttribute.InstanceType" /> property value.
  10139. </summary>
  10140. </member>
  10141. <member name="T:System.Data.SQLite.SQLiteKeyReader">
  10142. <summary>
  10143. This class provides key info for a given SQLite statement.
  10144. <remarks>
  10145. Providing key information for a given statement is non-trivial :(
  10146. </remarks>
  10147. </summary>
  10148. </member>
  10149. <member name="T:System.Data.SQLite.SQLiteKeyReader.KeyInfo">
  10150. <summary>
  10151. Used to support CommandBehavior.KeyInfo
  10152. </summary>
  10153. </member>
  10154. <member name="T:System.Data.SQLite.SQLiteKeyReader.RowIdInfo">
  10155. <summary>
  10156. Used to keep track of the per-table RowId column metadata.
  10157. </summary>
  10158. </member>
  10159. <member name="T:System.Data.SQLite.SQLiteKeyReader.KeyQuery">
  10160. <summary>
  10161. A single sub-query for a given table/database.
  10162. </summary>
  10163. </member>
  10164. <member name="M:System.Data.SQLite.SQLiteKeyReader.#ctor(System.Data.SQLite.SQLiteConnection,System.Data.SQLite.SQLiteDataReader,System.Data.SQLite.SQLiteStatement)">
  10165. <summary>
  10166. This function does all the nasty work at determining what keys need to be returned for
  10167. a given statement.
  10168. </summary>
  10169. <param name="cnn"></param>
  10170. <param name="reader"></param>
  10171. <param name="stmt"></param>
  10172. </member>
  10173. <member name="P:System.Data.SQLite.SQLiteKeyReader.Count">
  10174. <summary>
  10175. How many additional columns of keyinfo we're holding
  10176. </summary>
  10177. </member>
  10178. <member name="M:System.Data.SQLite.SQLiteKeyReader.Sync">
  10179. <summary>
  10180. Make sure all the subqueries are open and ready and sync'd with the current rowid
  10181. of the table they're supporting
  10182. </summary>
  10183. </member>
  10184. <member name="M:System.Data.SQLite.SQLiteKeyReader.Reset">
  10185. <summary>
  10186. Release any readers on any subqueries
  10187. </summary>
  10188. </member>
  10189. <member name="M:System.Data.SQLite.SQLiteKeyReader.AppendSchemaTable(System.Data.DataTable)">
  10190. <summary>
  10191. Append all the columns we've added to the original query to the schema
  10192. </summary>
  10193. <param name="tbl"></param>
  10194. </member>
  10195. <member name="T:System.Data.SQLite.LogEventArgs">
  10196. <summary>
  10197. Event data for logging event handlers.
  10198. </summary>
  10199. </member>
  10200. <member name="F:System.Data.SQLite.LogEventArgs.ErrorCode">
  10201. <summary>
  10202. The error code. The type of this object value should be
  10203. <see cref="T:System.Int32" /> or <see cref="T:System.Data.SQLite.SQLiteErrorCode" />.
  10204. </summary>
  10205. </member>
  10206. <member name="F:System.Data.SQLite.LogEventArgs.Message">
  10207. <summary>
  10208. SQL statement text as the statement first begins executing
  10209. </summary>
  10210. </member>
  10211. <member name="F:System.Data.SQLite.LogEventArgs.Data">
  10212. <summary>
  10213. Extra data associated with this event, if any.
  10214. </summary>
  10215. </member>
  10216. <member name="M:System.Data.SQLite.LogEventArgs.#ctor(System.IntPtr,System.Object,System.String,System.Object)">
  10217. <summary>
  10218. Constructs the object.
  10219. </summary>
  10220. <param name="pUserData">Should be null.</param>
  10221. <param name="errorCode">
  10222. The error code. The type of this object value should be
  10223. <see cref="T:System.Int32" /> or <see cref="T:System.Data.SQLite.SQLiteErrorCode" />.
  10224. </param>
  10225. <param name="message">The error message, if any.</param>
  10226. <param name="data">The extra data, if any.</param>
  10227. </member>
  10228. <member name="T:System.Data.SQLite.SQLiteLogEventHandler">
  10229. <summary>
  10230. Raised when a log event occurs.
  10231. </summary>
  10232. <param name="sender">The current connection</param>
  10233. <param name="e">Event arguments of the trace</param>
  10234. </member>
  10235. <member name="T:System.Data.SQLite.SQLiteLog">
  10236. <summary>
  10237. Manages the SQLite custom logging functionality and the associated
  10238. callback for the whole process.
  10239. </summary>
  10240. </member>
  10241. <member name="F:System.Data.SQLite.SQLiteLog.syncRoot">
  10242. <summary>
  10243. Object used to synchronize access to the static instance data
  10244. for this class.
  10245. </summary>
  10246. </member>
  10247. <member name="F:System.Data.SQLite.SQLiteLog._domainUnload">
  10248. <summary>
  10249. Member variable to store the AppDomain.DomainUnload event handler.
  10250. </summary>
  10251. </member>
  10252. <member name="E:System.Data.SQLite.SQLiteLog._handlers">
  10253. <summary>
  10254. Member variable to store the application log handler to call.
  10255. </summary>
  10256. </member>
  10257. <member name="F:System.Data.SQLite.SQLiteLog._defaultHandler">
  10258. <summary>
  10259. The default log event handler.
  10260. </summary>
  10261. </member>
  10262. <member name="F:System.Data.SQLite.SQLiteLog._callback">
  10263. <summary>
  10264. The log callback passed to native SQLite engine. This must live
  10265. as long as the SQLite library has a pointer to it.
  10266. </summary>
  10267. </member>
  10268. <member name="F:System.Data.SQLite.SQLiteLog._sql">
  10269. <summary>
  10270. The base SQLite object to interop with.
  10271. </summary>
  10272. </member>
  10273. <member name="F:System.Data.SQLite.SQLiteLog._initializeCallCount">
  10274. <summary>
  10275. The number of times that the <see cref="M:System.Data.SQLite.SQLiteLog.Initialize(System.String)" />
  10276. has been called when the logging subystem was actually eligible
  10277. to be initialized (i.e. without the "No_SQLiteLog" environment
  10278. variable being set).
  10279. </summary>
  10280. </member>
  10281. <member name="F:System.Data.SQLite.SQLiteLog._attemptedInitialize">
  10282. <summary>
  10283. This will be non-zero if an attempt was already made to initialize
  10284. the (managed) logging subsystem.
  10285. </summary>
  10286. </member>
  10287. <member name="F:System.Data.SQLite.SQLiteLog._enabled">
  10288. <summary>
  10289. This will be non-zero if logging is currently enabled.
  10290. </summary>
  10291. </member>
  10292. <member name="M:System.Data.SQLite.SQLiteLog.Initialize">
  10293. <summary>
  10294. Initializes the SQLite logging facilities.
  10295. </summary>
  10296. </member>
  10297. <member name="M:System.Data.SQLite.SQLiteLog.Initialize(System.String)">
  10298. <summary>
  10299. Initializes the SQLite logging facilities.
  10300. </summary>
  10301. <param name="className">
  10302. The name of the managed class that called this method. This
  10303. parameter may be null.
  10304. </param>
  10305. </member>
  10306. <member name="M:System.Data.SQLite.SQLiteLog.DomainUnload(System.Object,System.EventArgs)">
  10307. <summary>
  10308. Handles the AppDomain being unloaded.
  10309. </summary>
  10310. <param name="sender">Should be null.</param>
  10311. <param name="e">The data associated with this event.</param>
  10312. </member>
  10313. <member name="E:System.Data.SQLite.SQLiteLog.Log">
  10314. <summary>
  10315. This event is raised whenever SQLite raises a logging event.
  10316. Note that this should be set as one of the first things in the
  10317. application.
  10318. </summary>
  10319. </member>
  10320. <member name="P:System.Data.SQLite.SQLiteLog.Enabled">
  10321. <summary>
  10322. If this property is true, logging is enabled; otherwise, logging is
  10323. disabled. When logging is disabled, no logging events will fire.
  10324. </summary>
  10325. </member>
  10326. <member name="M:System.Data.SQLite.SQLiteLog.LogMessage(System.String)">
  10327. <summary>
  10328. Log a message to all the registered log event handlers without going
  10329. through the SQLite library.
  10330. </summary>
  10331. <param name="message">The message to be logged.</param>
  10332. </member>
  10333. <member name="M:System.Data.SQLite.SQLiteLog.LogMessage(System.Data.SQLite.SQLiteErrorCode,System.String)">
  10334. <summary>
  10335. Log a message to all the registered log event handlers without going
  10336. through the SQLite library.
  10337. </summary>
  10338. <param name="errorCode">The SQLite error code.</param>
  10339. <param name="message">The message to be logged.</param>
  10340. </member>
  10341. <member name="M:System.Data.SQLite.SQLiteLog.LogMessage(System.Int32,System.String)">
  10342. <summary>
  10343. Log a message to all the registered log event handlers without going
  10344. through the SQLite library.
  10345. </summary>
  10346. <param name="errorCode">The integer error code.</param>
  10347. <param name="message">The message to be logged.</param>
  10348. </member>
  10349. <member name="M:System.Data.SQLite.SQLiteLog.LogMessage(System.Object,System.String)">
  10350. <summary>
  10351. Log a message to all the registered log event handlers without going
  10352. through the SQLite library.
  10353. </summary>
  10354. <param name="errorCode">
  10355. The error code. The type of this object value should be
  10356. System.Int32 or SQLiteErrorCode.
  10357. </param>
  10358. <param name="message">The message to be logged.</param>
  10359. </member>
  10360. <member name="M:System.Data.SQLite.SQLiteLog.InitializeDefaultHandler">
  10361. <summary>
  10362. Creates and initializes the default log event handler.
  10363. </summary>
  10364. </member>
  10365. <member name="M:System.Data.SQLite.SQLiteLog.AddDefaultHandler">
  10366. <summary>
  10367. Adds the default log event handler to the list of handlers.
  10368. </summary>
  10369. </member>
  10370. <member name="M:System.Data.SQLite.SQLiteLog.RemoveDefaultHandler">
  10371. <summary>
  10372. Removes the default log event handler from the list of handlers.
  10373. </summary>
  10374. </member>
  10375. <member name="M:System.Data.SQLite.SQLiteLog.LogCallback(System.IntPtr,System.Int32,System.IntPtr)">
  10376. <summary>
  10377. Internal proxy function that calls any registered application log
  10378. event handlers.
  10379. WARNING: This method is used more-or-less directly by native code,
  10380. do not modify its type signature.
  10381. </summary>
  10382. <param name="pUserData">
  10383. The extra data associated with this message, if any.
  10384. </param>
  10385. <param name="errorCode">
  10386. The error code associated with this message.
  10387. </param>
  10388. <param name="pMessage">
  10389. The message string to be logged.
  10390. </param>
  10391. </member>
  10392. <member name="M:System.Data.SQLite.SQLiteLog.LogEventHandler(System.Object,System.Data.SQLite.LogEventArgs)">
  10393. <summary>
  10394. Default logger. Currently, uses the Trace class (i.e. sends events
  10395. to the current trace listeners, if any).
  10396. </summary>
  10397. <param name="sender">Should be null.</param>
  10398. <param name="e">The data associated with this event.</param>
  10399. </member>
  10400. <member name="T:System.Data.SQLite.SQLiteMetaDataCollectionNames">
  10401. <summary>
  10402. MetaDataCollections specific to SQLite
  10403. </summary>
  10404. </member>
  10405. <member name="F:System.Data.SQLite.SQLiteMetaDataCollectionNames.Catalogs">
  10406. <summary>
  10407. Returns a list of databases attached to the connection
  10408. </summary>
  10409. </member>
  10410. <member name="F:System.Data.SQLite.SQLiteMetaDataCollectionNames.Columns">
  10411. <summary>
  10412. Returns column information for the specified table
  10413. </summary>
  10414. </member>
  10415. <member name="F:System.Data.SQLite.SQLiteMetaDataCollectionNames.Indexes">
  10416. <summary>
  10417. Returns index information for the optionally-specified table
  10418. </summary>
  10419. </member>
  10420. <member name="F:System.Data.SQLite.SQLiteMetaDataCollectionNames.IndexColumns">
  10421. <summary>
  10422. Returns base columns for the given index
  10423. </summary>
  10424. </member>
  10425. <member name="F:System.Data.SQLite.SQLiteMetaDataCollectionNames.Tables">
  10426. <summary>
  10427. Returns the tables in the given catalog
  10428. </summary>
  10429. </member>
  10430. <member name="F:System.Data.SQLite.SQLiteMetaDataCollectionNames.Views">
  10431. <summary>
  10432. Returns user-defined views in the given catalog
  10433. </summary>
  10434. </member>
  10435. <member name="F:System.Data.SQLite.SQLiteMetaDataCollectionNames.ViewColumns">
  10436. <summary>
  10437. Returns underlying column information on the given view
  10438. </summary>
  10439. </member>
  10440. <member name="F:System.Data.SQLite.SQLiteMetaDataCollectionNames.ForeignKeys">
  10441. <summary>
  10442. Returns foreign key information for the given catalog
  10443. </summary>
  10444. </member>
  10445. <member name="F:System.Data.SQLite.SQLiteMetaDataCollectionNames.Triggers">
  10446. <summary>
  10447. Returns the triggers on the database
  10448. </summary>
  10449. </member>
  10450. <member name="T:System.Data.SQLite.SQLiteParameter">
  10451. <summary>
  10452. SQLite implementation of DbParameter.
  10453. </summary>
  10454. </member>
  10455. <member name="F:System.Data.SQLite.SQLiteParameter.UnknownDbType">
  10456. <summary>
  10457. This value represents an "unknown" <see cref="P:System.Data.SQLite.SQLiteParameter.DbType" />.
  10458. </summary>
  10459. </member>
  10460. <member name="F:System.Data.SQLite.SQLiteParameter._command">
  10461. <summary>
  10462. The command associated with this parameter.
  10463. </summary>
  10464. </member>
  10465. <member name="F:System.Data.SQLite.SQLiteParameter._dbType">
  10466. <summary>
  10467. The data type of the parameter
  10468. </summary>
  10469. </member>
  10470. <member name="F:System.Data.SQLite.SQLiteParameter._rowVersion">
  10471. <summary>
  10472. The version information for mapping the parameter
  10473. </summary>
  10474. </member>
  10475. <member name="F:System.Data.SQLite.SQLiteParameter._objValue">
  10476. <summary>
  10477. The value of the data in the parameter
  10478. </summary>
  10479. </member>
  10480. <member name="F:System.Data.SQLite.SQLiteParameter._sourceColumn">
  10481. <summary>
  10482. The source column for the parameter
  10483. </summary>
  10484. </member>
  10485. <member name="F:System.Data.SQLite.SQLiteParameter._parameterName">
  10486. <summary>
  10487. The column name
  10488. </summary>
  10489. </member>
  10490. <member name="F:System.Data.SQLite.SQLiteParameter._dataSize">
  10491. <summary>
  10492. The data size, unused by SQLite
  10493. </summary>
  10494. </member>
  10495. <member name="F:System.Data.SQLite.SQLiteParameter._typeName">
  10496. <summary>
  10497. The database type name associated with this parameter, if any.
  10498. </summary>
  10499. </member>
  10500. <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.Data.IDbCommand)">
  10501. <summary>
  10502. Constructor used when creating for use with a specific command.
  10503. </summary>
  10504. <param name="command">
  10505. The command associated with this parameter.
  10506. </param>
  10507. </member>
  10508. <member name="M:System.Data.SQLite.SQLiteParameter.#ctor">
  10509. <summary>
  10510. Default constructor
  10511. </summary>
  10512. </member>
  10513. <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.String)">
  10514. <summary>
  10515. Constructs a named parameter given the specified parameter name
  10516. </summary>
  10517. <param name="parameterName">The parameter name</param>
  10518. </member>
  10519. <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.String,System.Object)">
  10520. <summary>
  10521. Constructs a named parameter given the specified parameter name and initial value
  10522. </summary>
  10523. <param name="parameterName">The parameter name</param>
  10524. <param name="value">The initial value of the parameter</param>
  10525. </member>
  10526. <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.String,System.Data.DbType)">
  10527. <summary>
  10528. Constructs a named parameter of the specified type
  10529. </summary>
  10530. <param name="parameterName">The parameter name</param>
  10531. <param name="dbType">The datatype of the parameter</param>
  10532. </member>
  10533. <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.String,System.Data.DbType,System.String)">
  10534. <summary>
  10535. Constructs a named parameter of the specified type and source column reference
  10536. </summary>
  10537. <param name="parameterName">The parameter name</param>
  10538. <param name="dbType">The data type</param>
  10539. <param name="sourceColumn">The source column</param>
  10540. </member>
  10541. <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.String,System.Data.DbType,System.String,System.Data.DataRowVersion)">
  10542. <summary>
  10543. Constructs a named parameter of the specified type, source column and row version
  10544. </summary>
  10545. <param name="parameterName">The parameter name</param>
  10546. <param name="dbType">The data type</param>
  10547. <param name="sourceColumn">The source column</param>
  10548. <param name="rowVersion">The row version information</param>
  10549. </member>
  10550. <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.Data.DbType)">
  10551. <summary>
  10552. Constructs an unnamed parameter of the specified data type
  10553. </summary>
  10554. <param name="dbType">The datatype of the parameter</param>
  10555. </member>
  10556. <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.Data.DbType,System.Object)">
  10557. <summary>
  10558. Constructs an unnamed parameter of the specified data type and sets the initial value
  10559. </summary>
  10560. <param name="dbType">The datatype of the parameter</param>
  10561. <param name="value">The initial value of the parameter</param>
  10562. </member>
  10563. <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.Data.DbType,System.String)">
  10564. <summary>
  10565. Constructs an unnamed parameter of the specified data type and source column
  10566. </summary>
  10567. <param name="dbType">The datatype of the parameter</param>
  10568. <param name="sourceColumn">The source column</param>
  10569. </member>
  10570. <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.Data.DbType,System.String,System.Data.DataRowVersion)">
  10571. <summary>
  10572. Constructs an unnamed parameter of the specified data type, source column and row version
  10573. </summary>
  10574. <param name="dbType">The data type</param>
  10575. <param name="sourceColumn">The source column</param>
  10576. <param name="rowVersion">The row version information</param>
  10577. </member>
  10578. <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.String,System.Data.DbType,System.Int32)">
  10579. <summary>
  10580. Constructs a named parameter of the specified type and size
  10581. </summary>
  10582. <param name="parameterName">The parameter name</param>
  10583. <param name="parameterType">The data type</param>
  10584. <param name="parameterSize">The size of the parameter</param>
  10585. </member>
  10586. <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.String,System.Data.DbType,System.Int32,System.String)">
  10587. <summary>
  10588. Constructs a named parameter of the specified type, size and source column
  10589. </summary>
  10590. <param name="parameterName">The name of the parameter</param>
  10591. <param name="parameterType">The data type</param>
  10592. <param name="parameterSize">The size of the parameter</param>
  10593. <param name="sourceColumn">The source column</param>
  10594. </member>
  10595. <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.String,System.Data.DbType,System.Int32,System.String,System.Data.DataRowVersion)">
  10596. <summary>
  10597. Constructs a named parameter of the specified type, size, source column and row version
  10598. </summary>
  10599. <param name="parameterName">The name of the parameter</param>
  10600. <param name="parameterType">The data type</param>
  10601. <param name="parameterSize">The size of the parameter</param>
  10602. <param name="sourceColumn">The source column</param>
  10603. <param name="rowVersion">The row version information</param>
  10604. </member>
  10605. <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)">
  10606. <summary>
  10607. Constructs a named parameter of the specified type, size, source column and row version
  10608. </summary>
  10609. <param name="parameterName">The name of the parameter</param>
  10610. <param name="parameterType">The data type</param>
  10611. <param name="parameterSize">The size of the parameter</param>
  10612. <param name="direction">Only input parameters are supported in SQLite</param>
  10613. <param name="isNullable">Ignored</param>
  10614. <param name="precision">Ignored</param>
  10615. <param name="scale">Ignored</param>
  10616. <param name="sourceColumn">The source column</param>
  10617. <param name="rowVersion">The row version information</param>
  10618. <param name="value">The initial value to assign the parameter</param>
  10619. </member>
  10620. <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)">
  10621. <summary>
  10622. Constructs a named parameter, yet another flavor
  10623. </summary>
  10624. <param name="parameterName">The name of the parameter</param>
  10625. <param name="parameterType">The data type</param>
  10626. <param name="parameterSize">The size of the parameter</param>
  10627. <param name="direction">Only input parameters are supported in SQLite</param>
  10628. <param name="precision">Ignored</param>
  10629. <param name="scale">Ignored</param>
  10630. <param name="sourceColumn">The source column</param>
  10631. <param name="rowVersion">The row version information</param>
  10632. <param name="sourceColumnNullMapping">Whether or not this parameter is for comparing NULL's</param>
  10633. <param name="value">The intial value to assign the parameter</param>
  10634. </member>
  10635. <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.Data.DbType,System.Int32)">
  10636. <summary>
  10637. Constructs an unnamed parameter of the specified type and size
  10638. </summary>
  10639. <param name="parameterType">The data type</param>
  10640. <param name="parameterSize">The size of the parameter</param>
  10641. </member>
  10642. <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.Data.DbType,System.Int32,System.String)">
  10643. <summary>
  10644. Constructs an unnamed parameter of the specified type, size, and source column
  10645. </summary>
  10646. <param name="parameterType">The data type</param>
  10647. <param name="parameterSize">The size of the parameter</param>
  10648. <param name="sourceColumn">The source column</param>
  10649. </member>
  10650. <member name="M:System.Data.SQLite.SQLiteParameter.#ctor(System.Data.DbType,System.Int32,System.String,System.Data.DataRowVersion)">
  10651. <summary>
  10652. Constructs an unnamed parameter of the specified type, size, source column and row version
  10653. </summary>
  10654. <param name="parameterType">The data type</param>
  10655. <param name="parameterSize">The size of the parameter</param>
  10656. <param name="sourceColumn">The source column</param>
  10657. <param name="rowVersion">The row version information</param>
  10658. </member>
  10659. <member name="P:System.Data.SQLite.SQLiteParameter.Command">
  10660. <summary>
  10661. The command associated with this parameter.
  10662. </summary>
  10663. </member>
  10664. <member name="P:System.Data.SQLite.SQLiteParameter.IsNullable">
  10665. <summary>
  10666. Whether or not the parameter can contain a null value
  10667. </summary>
  10668. </member>
  10669. <member name="P:System.Data.SQLite.SQLiteParameter.DbType">
  10670. <summary>
  10671. Returns the datatype of the parameter
  10672. </summary>
  10673. </member>
  10674. <member name="P:System.Data.SQLite.SQLiteParameter.Direction">
  10675. <summary>
  10676. Supports only input parameters
  10677. </summary>
  10678. </member>
  10679. <member name="P:System.Data.SQLite.SQLiteParameter.ParameterName">
  10680. <summary>
  10681. Returns the parameter name
  10682. </summary>
  10683. </member>
  10684. <member name="M:System.Data.SQLite.SQLiteParameter.ResetDbType">
  10685. <summary>
  10686. Resets the DbType of the parameter so it can be inferred from the value
  10687. </summary>
  10688. </member>
  10689. <member name="P:System.Data.SQLite.SQLiteParameter.Size">
  10690. <summary>
  10691. Returns the size of the parameter
  10692. </summary>
  10693. </member>
  10694. <member name="P:System.Data.SQLite.SQLiteParameter.SourceColumn">
  10695. <summary>
  10696. Gets/sets the source column
  10697. </summary>
  10698. </member>
  10699. <member name="P:System.Data.SQLite.SQLiteParameter.SourceColumnNullMapping">
  10700. <summary>
  10701. Used by DbCommandBuilder to determine the mapping for nullable fields
  10702. </summary>
  10703. </member>
  10704. <member name="P:System.Data.SQLite.SQLiteParameter.SourceVersion">
  10705. <summary>
  10706. Gets and sets the row version
  10707. </summary>
  10708. </member>
  10709. <member name="P:System.Data.SQLite.SQLiteParameter.Value">
  10710. <summary>
  10711. Gets and sets the parameter value. If no datatype was specified, the datatype will assume the type from the value given.
  10712. </summary>
  10713. </member>
  10714. <member name="P:System.Data.SQLite.SQLiteParameter.TypeName">
  10715. <summary>
  10716. The database type name associated with this parameter, if any.
  10717. </summary>
  10718. </member>
  10719. <member name="M:System.Data.SQLite.SQLiteParameter.Clone">
  10720. <summary>
  10721. Clones a parameter
  10722. </summary>
  10723. <returns>A new, unassociated SQLiteParameter</returns>
  10724. </member>
  10725. <member name="T:System.Data.SQLite.SQLiteParameterCollection">
  10726. <summary>
  10727. SQLite implementation of DbParameterCollection.
  10728. </summary>
  10729. </member>
  10730. <member name="F:System.Data.SQLite.SQLiteParameterCollection._command">
  10731. <summary>
  10732. The underlying command to which this collection belongs
  10733. </summary>
  10734. </member>
  10735. <member name="F:System.Data.SQLite.SQLiteParameterCollection._parameterList">
  10736. <summary>
  10737. The internal array of parameters in this collection
  10738. </summary>
  10739. </member>
  10740. <member name="F:System.Data.SQLite.SQLiteParameterCollection._unboundFlag">
  10741. <summary>
  10742. Determines whether or not all parameters have been bound to their statement(s)
  10743. </summary>
  10744. </member>
  10745. <member name="M:System.Data.SQLite.SQLiteParameterCollection.#ctor(System.Data.SQLite.SQLiteCommand)">
  10746. <summary>
  10747. Initializes the collection
  10748. </summary>
  10749. <param name="cmd">The command to which the collection belongs</param>
  10750. </member>
  10751. <member name="P:System.Data.SQLite.SQLiteParameterCollection.IsSynchronized">
  10752. <summary>
  10753. Returns false
  10754. </summary>
  10755. </member>
  10756. <member name="P:System.Data.SQLite.SQLiteParameterCollection.IsFixedSize">
  10757. <summary>
  10758. Returns false
  10759. </summary>
  10760. </member>
  10761. <member name="P:System.Data.SQLite.SQLiteParameterCollection.IsReadOnly">
  10762. <summary>
  10763. Returns false
  10764. </summary>
  10765. </member>
  10766. <member name="P:System.Data.SQLite.SQLiteParameterCollection.SyncRoot">
  10767. <summary>
  10768. Returns null
  10769. </summary>
  10770. </member>
  10771. <member name="M:System.Data.SQLite.SQLiteParameterCollection.GetEnumerator">
  10772. <summary>
  10773. Retrieves an enumerator for the collection
  10774. </summary>
  10775. <returns>An enumerator for the underlying array</returns>
  10776. </member>
  10777. <member name="M:System.Data.SQLite.SQLiteParameterCollection.Add(System.String,System.Data.DbType,System.Int32,System.String)">
  10778. <summary>
  10779. Adds a parameter to the collection
  10780. </summary>
  10781. <param name="parameterName">The parameter name</param>
  10782. <param name="parameterType">The data type</param>
  10783. <param name="parameterSize">The size of the value</param>
  10784. <param name="sourceColumn">The source column</param>
  10785. <returns>A SQLiteParameter object</returns>
  10786. </member>
  10787. <member name="M:System.Data.SQLite.SQLiteParameterCollection.Add(System.String,System.Data.DbType,System.Int32)">
  10788. <summary>
  10789. Adds a parameter to the collection
  10790. </summary>
  10791. <param name="parameterName">The parameter name</param>
  10792. <param name="parameterType">The data type</param>
  10793. <param name="parameterSize">The size of the value</param>
  10794. <returns>A SQLiteParameter object</returns>
  10795. </member>
  10796. <member name="M:System.Data.SQLite.SQLiteParameterCollection.Add(System.String,System.Data.DbType)">
  10797. <summary>
  10798. Adds a parameter to the collection
  10799. </summary>
  10800. <param name="parameterName">The parameter name</param>
  10801. <param name="parameterType">The data type</param>
  10802. <returns>A SQLiteParameter object</returns>
  10803. </member>
  10804. <member name="M:System.Data.SQLite.SQLiteParameterCollection.Add(System.Data.SQLite.SQLiteParameter)">
  10805. <summary>
  10806. Adds a parameter to the collection
  10807. </summary>
  10808. <param name="parameter">The parameter to add</param>
  10809. <returns>A zero-based index of where the parameter is located in the array</returns>
  10810. </member>
  10811. <member name="M:System.Data.SQLite.SQLiteParameterCollection.Add(System.Object)">
  10812. <summary>
  10813. Adds a parameter to the collection
  10814. </summary>
  10815. <param name="value">The parameter to add</param>
  10816. <returns>A zero-based index of where the parameter is located in the array</returns>
  10817. </member>
  10818. <member name="M:System.Data.SQLite.SQLiteParameterCollection.AddWithValue(System.String,System.Object)">
  10819. <summary>
  10820. Adds a named/unnamed parameter and its value to the parameter collection.
  10821. </summary>
  10822. <param name="parameterName">Name of the parameter, or null to indicate an unnamed parameter</param>
  10823. <param name="value">The initial value of the parameter</param>
  10824. <returns>Returns the SQLiteParameter object created during the call.</returns>
  10825. </member>
  10826. <member name="M:System.Data.SQLite.SQLiteParameterCollection.AddRange(System.Data.SQLite.SQLiteParameter[])">
  10827. <summary>
  10828. Adds an array of parameters to the collection
  10829. </summary>
  10830. <param name="values">The array of parameters to add</param>
  10831. </member>
  10832. <member name="M:System.Data.SQLite.SQLiteParameterCollection.AddRange(System.Array)">
  10833. <summary>
  10834. Adds an array of parameters to the collection
  10835. </summary>
  10836. <param name="values">The array of parameters to add</param>
  10837. </member>
  10838. <member name="M:System.Data.SQLite.SQLiteParameterCollection.Clear">
  10839. <summary>
  10840. Clears the array and resets the collection
  10841. </summary>
  10842. </member>
  10843. <member name="M:System.Data.SQLite.SQLiteParameterCollection.Contains(System.String)">
  10844. <summary>
  10845. Determines if the named parameter exists in the collection
  10846. </summary>
  10847. <param name="parameterName">The name of the parameter to check</param>
  10848. <returns>True if the parameter is in the collection</returns>
  10849. </member>
  10850. <member name="M:System.Data.SQLite.SQLiteParameterCollection.Contains(System.Object)">
  10851. <summary>
  10852. Determines if the parameter exists in the collection
  10853. </summary>
  10854. <param name="value">The SQLiteParameter to check</param>
  10855. <returns>True if the parameter is in the collection</returns>
  10856. </member>
  10857. <member name="M:System.Data.SQLite.SQLiteParameterCollection.CopyTo(System.Array,System.Int32)">
  10858. <summary>
  10859. Not implemented
  10860. </summary>
  10861. <param name="array"></param>
  10862. <param name="index"></param>
  10863. </member>
  10864. <member name="P:System.Data.SQLite.SQLiteParameterCollection.Count">
  10865. <summary>
  10866. Returns a count of parameters in the collection
  10867. </summary>
  10868. </member>
  10869. <member name="P:System.Data.SQLite.SQLiteParameterCollection.Item(System.String)">
  10870. <summary>
  10871. Overloaded to specialize the return value of the default indexer
  10872. </summary>
  10873. <param name="parameterName">Name of the parameter to get/set</param>
  10874. <returns>The specified named SQLite parameter</returns>
  10875. </member>
  10876. <member name="P:System.Data.SQLite.SQLiteParameterCollection.Item(System.Int32)">
  10877. <summary>
  10878. Overloaded to specialize the return value of the default indexer
  10879. </summary>
  10880. <param name="index">The index of the parameter to get/set</param>
  10881. <returns>The specified SQLite parameter</returns>
  10882. </member>
  10883. <member name="M:System.Data.SQLite.SQLiteParameterCollection.GetParameter(System.String)">
  10884. <summary>
  10885. Retrieve a parameter by name from the collection
  10886. </summary>
  10887. <param name="parameterName">The name of the parameter to fetch</param>
  10888. <returns>A DbParameter object</returns>
  10889. </member>
  10890. <member name="M:System.Data.SQLite.SQLiteParameterCollection.GetParameter(System.Int32)">
  10891. <summary>
  10892. Retrieves a parameter by its index in the collection
  10893. </summary>
  10894. <param name="index">The index of the parameter to retrieve</param>
  10895. <returns>A DbParameter object</returns>
  10896. </member>
  10897. <member name="M:System.Data.SQLite.SQLiteParameterCollection.IndexOf(System.String)">
  10898. <summary>
  10899. Returns the index of a parameter given its name
  10900. </summary>
  10901. <param name="parameterName">The name of the parameter to find</param>
  10902. <returns>-1 if not found, otherwise a zero-based index of the parameter</returns>
  10903. </member>
  10904. <member name="M:System.Data.SQLite.SQLiteParameterCollection.IndexOf(System.Object)">
  10905. <summary>
  10906. Returns the index of a parameter
  10907. </summary>
  10908. <param name="value">The parameter to find</param>
  10909. <returns>-1 if not found, otherwise a zero-based index of the parameter</returns>
  10910. </member>
  10911. <member name="M:System.Data.SQLite.SQLiteParameterCollection.Insert(System.Int32,System.Object)">
  10912. <summary>
  10913. Inserts a parameter into the array at the specified location
  10914. </summary>
  10915. <param name="index">The zero-based index to insert the parameter at</param>
  10916. <param name="value">The parameter to insert</param>
  10917. </member>
  10918. <member name="M:System.Data.SQLite.SQLiteParameterCollection.Remove(System.Object)">
  10919. <summary>
  10920. Removes a parameter from the collection
  10921. </summary>
  10922. <param name="value">The parameter to remove</param>
  10923. </member>
  10924. <member name="M:System.Data.SQLite.SQLiteParameterCollection.RemoveAt(System.String)">
  10925. <summary>
  10926. Removes a parameter from the collection given its name
  10927. </summary>
  10928. <param name="parameterName">The name of the parameter to remove</param>
  10929. </member>
  10930. <member name="M:System.Data.SQLite.SQLiteParameterCollection.RemoveAt(System.Int32)">
  10931. <summary>
  10932. Removes a parameter from the collection given its index
  10933. </summary>
  10934. <param name="index">The zero-based parameter index to remove</param>
  10935. </member>
  10936. <member name="M:System.Data.SQLite.SQLiteParameterCollection.SetParameter(System.String,System.Data.Common.DbParameter)">
  10937. <summary>
  10938. Re-assign the named parameter to a new parameter object
  10939. </summary>
  10940. <param name="parameterName">The name of the parameter to replace</param>
  10941. <param name="value">The new parameter</param>
  10942. </member>
  10943. <member name="M:System.Data.SQLite.SQLiteParameterCollection.SetParameter(System.Int32,System.Data.Common.DbParameter)">
  10944. <summary>
  10945. Re-assign a parameter at the specified index
  10946. </summary>
  10947. <param name="index">The zero-based index of the parameter to replace</param>
  10948. <param name="value">The new parameter</param>
  10949. </member>
  10950. <member name="M:System.Data.SQLite.SQLiteParameterCollection.Unbind">
  10951. <summary>
  10952. Un-binds all parameters from their statements
  10953. </summary>
  10954. </member>
  10955. <member name="M:System.Data.SQLite.SQLiteParameterCollection.MapParameters(System.Data.SQLite.SQLiteStatement)">
  10956. <summary>
  10957. This function attempts to map all parameters in the collection to all statements in a Command.
  10958. Since named parameters may span multiple statements, this function makes sure all statements are bound
  10959. to the same named parameter. Unnamed parameters are bound in sequence.
  10960. </summary>
  10961. </member>
  10962. <member name="T:System.Data.SQLite.SQLiteStatement">
  10963. <summary>
  10964. Represents a single SQL statement in SQLite.
  10965. </summary>
  10966. </member>
  10967. <member name="F:System.Data.SQLite.SQLiteStatement._sql">
  10968. <summary>
  10969. The underlying SQLite object this statement is bound to
  10970. </summary>
  10971. </member>
  10972. <member name="F:System.Data.SQLite.SQLiteStatement._sqlStatement">
  10973. <summary>
  10974. The command text of this SQL statement
  10975. </summary>
  10976. </member>
  10977. <member name="F:System.Data.SQLite.SQLiteStatement._sqlite_stmt">
  10978. <summary>
  10979. The actual statement pointer
  10980. </summary>
  10981. </member>
  10982. <member name="F:System.Data.SQLite.SQLiteStatement._unnamedParameters">
  10983. <summary>
  10984. An index from which unnamed parameters begin
  10985. </summary>
  10986. </member>
  10987. <member name="F:System.Data.SQLite.SQLiteStatement._paramNames">
  10988. <summary>
  10989. Names of the parameters as SQLite understands them to be
  10990. </summary>
  10991. </member>
  10992. <member name="F:System.Data.SQLite.SQLiteStatement._paramValues">
  10993. <summary>
  10994. Parameters for this statement
  10995. </summary>
  10996. </member>
  10997. <member name="F:System.Data.SQLite.SQLiteStatement._command">
  10998. <summary>
  10999. Command this statement belongs to (if any)
  11000. </summary>
  11001. </member>
  11002. <member name="F:System.Data.SQLite.SQLiteStatement._flags">
  11003. <summary>
  11004. The flags associated with the parent connection object.
  11005. </summary>
  11006. </member>
  11007. <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)">
  11008. <summary>
  11009. Initializes the statement and attempts to get all information about parameters in the statement
  11010. </summary>
  11011. <param name="sqlbase">The base SQLite object</param>
  11012. <param name="flags">The flags associated with the parent connection object</param>
  11013. <param name="stmt">The statement</param>
  11014. <param name="strCommand">The command text for this statement</param>
  11015. <param name="previous">The previous command in a multi-statement command</param>
  11016. </member>
  11017. <member name="M:System.Data.SQLite.SQLiteStatement.Dispose">
  11018. <summary>
  11019. Disposes and finalizes the statement
  11020. </summary>
  11021. </member>
  11022. <member name="M:System.Data.SQLite.SQLiteStatement.TryGetChanges(System.Int32@,System.Boolean@)">
  11023. <summary>
  11024. If the underlying database connection is open, fetches the number of changed rows
  11025. resulting from the most recent query; otherwise, does nothing.
  11026. </summary>
  11027. <param name="changes">
  11028. The number of changes when true is returned.
  11029. Undefined if false is returned.
  11030. </param>
  11031. <param name="readOnly">
  11032. The read-only flag when true is returned.
  11033. Undefined if false is returned.
  11034. </param>
  11035. <returns>Non-zero if the number of changed rows was fetched.</returns>
  11036. </member>
  11037. <member name="M:System.Data.SQLite.SQLiteStatement.MapParameter(System.String,System.Data.SQLite.SQLiteParameter)">
  11038. <summary>
  11039. Called by SQLiteParameterCollection, this function determines if the specified parameter name belongs to
  11040. this statement, and if so, keeps a reference to the parameter so it can be bound later.
  11041. </summary>
  11042. <param name="s">The parameter name to map</param>
  11043. <param name="p">The parameter to assign it</param>
  11044. </member>
  11045. <member name="M:System.Data.SQLite.SQLiteStatement.BindParameters">
  11046. <summary>
  11047. Bind all parameters, making sure the caller didn't miss any
  11048. </summary>
  11049. </member>
  11050. <member name="M:System.Data.SQLite.SQLiteStatement.GetConnection(System.Data.SQLite.SQLiteStatement)">
  11051. <summary>
  11052. This method attempts to query the database connection associated with
  11053. the statement in use. If the underlying command or connection is
  11054. unavailable, a null value will be returned.
  11055. </summary>
  11056. <returns>
  11057. The connection object -OR- null if it is unavailable.
  11058. </returns>
  11059. </member>
  11060. <member name="M:System.Data.SQLite.SQLiteStatement.InvokeBindValueCallback(System.Int32,System.Data.SQLite.SQLiteParameter,System.Boolean@)">
  11061. <summary>
  11062. Invokes the parameter binding callback configured for the database
  11063. type name associated with the specified column. If no parameter
  11064. binding callback is available for the database type name, do
  11065. nothing.
  11066. </summary>
  11067. <param name="index">
  11068. The index of the column being read.
  11069. </param>
  11070. <param name="parameter">
  11071. The <see cref="T:System.Data.SQLite.SQLiteParameter" /> instance being bound to the
  11072. command.
  11073. </param>
  11074. <param name="complete">
  11075. Non-zero if the default handling for the parameter binding call
  11076. should be skipped (i.e. the parameter should not be bound at all).
  11077. Great care should be used when setting this to non-zero.
  11078. </param>
  11079. </member>
  11080. <member name="M:System.Data.SQLite.SQLiteStatement.BindParameter(System.Int32,System.Data.SQLite.SQLiteParameter)">
  11081. <summary>
  11082. Perform the bind operation for an individual parameter
  11083. </summary>
  11084. <param name="index">The index of the parameter to bind</param>
  11085. <param name="param">The parameter we're binding</param>
  11086. </member>
  11087. <member name="T:System.Data.SQLite.SQLiteTransaction">
  11088. <summary>
  11089. SQLite implementation of DbTransaction that does not support nested transactions.
  11090. </summary>
  11091. </member>
  11092. <member name="M:System.Data.SQLite.SQLiteTransaction.#ctor(System.Data.SQLite.SQLiteConnection,System.Boolean)">
  11093. <summary>
  11094. Constructs the transaction object, binding it to the supplied connection
  11095. </summary>
  11096. <param name="connection">The connection to open a transaction on</param>
  11097. <param name="deferredLock">TRUE to defer the writelock, or FALSE to lock immediately</param>
  11098. </member>
  11099. <member name="M:System.Data.SQLite.SQLiteTransaction.Dispose(System.Boolean)">
  11100. <summary>
  11101. Disposes the transaction. If it is currently active, any changes are rolled back.
  11102. </summary>
  11103. </member>
  11104. <member name="M:System.Data.SQLite.SQLiteTransaction.Commit">
  11105. <summary>
  11106. Commits the current transaction.
  11107. </summary>
  11108. </member>
  11109. <member name="M:System.Data.SQLite.SQLiteTransaction.Begin(System.Boolean)">
  11110. <summary>
  11111. Attempts to start a transaction. An exception will be thrown if the transaction cannot
  11112. be started for any reason.
  11113. </summary>
  11114. <param name="deferredLock">TRUE to defer the writelock, or FALSE to lock immediately</param>
  11115. </member>
  11116. <member name="M:System.Data.SQLite.SQLiteTransaction.IssueRollback(System.Boolean)">
  11117. <summary>
  11118. Issue a ROLLBACK command against the database connection,
  11119. optionally re-throwing any caught exception.
  11120. </summary>
  11121. <param name="throwError">
  11122. Non-zero to re-throw caught exceptions.
  11123. </param>
  11124. </member>
  11125. <member name="T:System.Data.SQLite.SQLiteTransaction2">
  11126. <summary>
  11127. SQLite implementation of DbTransaction that does support nested transactions.
  11128. </summary>
  11129. </member>
  11130. <member name="F:System.Data.SQLite.SQLiteTransaction2._beginLevel">
  11131. <summary>
  11132. The original transaction level for the associated connection
  11133. when this transaction was created (i.e. begun).
  11134. </summary>
  11135. </member>
  11136. <member name="F:System.Data.SQLite.SQLiteTransaction2._savePointName">
  11137. <summary>
  11138. The SAVEPOINT name for this transaction, if any. This will
  11139. only be non-null if this transaction is a nested one.
  11140. </summary>
  11141. </member>
  11142. <member name="M:System.Data.SQLite.SQLiteTransaction2.#ctor(System.Data.SQLite.SQLiteConnection,System.Boolean)">
  11143. <summary>
  11144. Constructs the transaction object, binding it to the supplied connection
  11145. </summary>
  11146. <param name="connection">The connection to open a transaction on</param>
  11147. <param name="deferredLock">TRUE to defer the writelock, or FALSE to lock immediately</param>
  11148. </member>
  11149. <member name="M:System.Data.SQLite.SQLiteTransaction2.Dispose(System.Boolean)">
  11150. <summary>
  11151. Disposes the transaction. If it is currently active, any changes are rolled back.
  11152. </summary>
  11153. </member>
  11154. <member name="M:System.Data.SQLite.SQLiteTransaction2.Commit">
  11155. <summary>
  11156. Commits the current transaction.
  11157. </summary>
  11158. </member>
  11159. <member name="M:System.Data.SQLite.SQLiteTransaction2.Begin(System.Boolean)">
  11160. <summary>
  11161. Attempts to start a transaction. An exception will be thrown if the transaction cannot
  11162. be started for any reason.
  11163. </summary>
  11164. <param name="deferredLock">TRUE to defer the writelock, or FALSE to lock immediately</param>
  11165. </member>
  11166. <member name="M:System.Data.SQLite.SQLiteTransaction2.IssueRollback(System.Boolean)">
  11167. <summary>
  11168. Issue a ROLLBACK command against the database connection,
  11169. optionally re-throwing any caught exception.
  11170. </summary>
  11171. <param name="throwError">
  11172. Non-zero to re-throw caught exceptions.
  11173. </param>
  11174. </member>
  11175. <member name="M:System.Data.SQLite.SQLiteTransaction2.GetSavePointName">
  11176. <summary>
  11177. Constructs the name of a new savepoint for this transaction. It
  11178. should only be called from the constructor of this class.
  11179. </summary>
  11180. <returns>
  11181. The name of the new savepoint -OR- null if it cannot be constructed.
  11182. </returns>
  11183. </member>
  11184. <member name="T:System.Data.SQLite.SQLiteTransactionBase">
  11185. <summary>
  11186. Base class used by to implement DbTransaction for SQLite.
  11187. </summary>
  11188. </member>
  11189. <member name="F:System.Data.SQLite.SQLiteTransactionBase._cnn">
  11190. <summary>
  11191. The connection to which this transaction is bound.
  11192. </summary>
  11193. </member>
  11194. <member name="F:System.Data.SQLite.SQLiteTransactionBase._version">
  11195. <summary>
  11196. Matches the version of the connection.
  11197. </summary>
  11198. </member>
  11199. <member name="F:System.Data.SQLite.SQLiteTransactionBase._level">
  11200. <summary>
  11201. The isolation level for this transaction.
  11202. </summary>
  11203. </member>
  11204. <member name="M:System.Data.SQLite.SQLiteTransactionBase.#ctor(System.Data.SQLite.SQLiteConnection,System.Boolean)">
  11205. <summary>
  11206. Constructs the transaction object, binding it to the supplied connection
  11207. </summary>
  11208. <param name="connection">The connection to open a transaction on</param>
  11209. <param name="deferredLock">TRUE to defer the writelock, or FALSE to lock immediately</param>
  11210. </member>
  11211. <member name="P:System.Data.SQLite.SQLiteTransactionBase.IsolationLevel">
  11212. <summary>
  11213. Gets the isolation level of the transaction. SQLite only supports Serializable transactions.
  11214. </summary>
  11215. </member>
  11216. <member name="M:System.Data.SQLite.SQLiteTransactionBase.Dispose(System.Boolean)">
  11217. <summary>
  11218. Disposes the transaction. If it is currently active, any changes are rolled back.
  11219. </summary>
  11220. </member>
  11221. <member name="P:System.Data.SQLite.SQLiteTransactionBase.Connection">
  11222. <summary>
  11223. Returns the underlying connection to which this transaction applies.
  11224. </summary>
  11225. </member>
  11226. <member name="P:System.Data.SQLite.SQLiteTransactionBase.DbConnection">
  11227. <summary>
  11228. Forwards to the local Connection property
  11229. </summary>
  11230. </member>
  11231. <member name="M:System.Data.SQLite.SQLiteTransactionBase.Rollback">
  11232. <summary>
  11233. Rolls back the active transaction.
  11234. </summary>
  11235. </member>
  11236. <member name="M:System.Data.SQLite.SQLiteTransactionBase.Begin(System.Boolean)">
  11237. <summary>
  11238. Attempts to start a transaction. An exception will be thrown if the transaction cannot
  11239. be started for any reason.
  11240. </summary>
  11241. <param name="deferredLock">TRUE to defer the writelock, or FALSE to lock immediately</param>
  11242. </member>
  11243. <member name="M:System.Data.SQLite.SQLiteTransactionBase.IssueRollback(System.Boolean)">
  11244. <summary>
  11245. Issue a ROLLBACK command against the database connection,
  11246. optionally re-throwing any caught exception.
  11247. </summary>
  11248. <param name="throwError">
  11249. Non-zero to re-throw caught exceptions.
  11250. </param>
  11251. </member>
  11252. <member name="M:System.Data.SQLite.SQLiteTransactionBase.IsValid(System.Boolean)">
  11253. <summary>
  11254. Checks the state of this transaction, optionally throwing an exception if a state
  11255. inconsistency is found.
  11256. </summary>
  11257. <param name="throwError">
  11258. Non-zero to throw an exception if a state inconsistency is found.
  11259. </param>
  11260. <returns>
  11261. Non-zero if this transaction is valid; otherwise, false.
  11262. </returns>
  11263. </member>
  11264. <member name="T:System.Data.SQLite.HelperMethods">
  11265. <summary>
  11266. This static class provides some methods that are shared between the
  11267. native library pre-loader and other classes.
  11268. </summary>
  11269. </member>
  11270. <member name="F:System.Data.SQLite.HelperMethods.staticSyncRoot">
  11271. <summary>
  11272. This lock is used to protect the static <see cref="F:System.Data.SQLite.HelperMethods.isMono" /> and
  11273. <see cref="F:System.Data.SQLite.HelperMethods.isDotNetCore" /> fields.
  11274. </summary>
  11275. </member>
  11276. <member name="F:System.Data.SQLite.HelperMethods.MonoRuntimeType">
  11277. <summary>
  11278. This type is only present when running on Mono.
  11279. </summary>
  11280. </member>
  11281. <member name="F:System.Data.SQLite.HelperMethods.DotNetCoreLibType">
  11282. <summary>
  11283. This type is only present when running on .NET Core.
  11284. </summary>
  11285. </member>
  11286. <member name="F:System.Data.SQLite.HelperMethods.isMono">
  11287. <summary>
  11288. Keeps track of whether we are running on Mono. Initially null, it is
  11289. set by the <see cref="M:System.Data.SQLite.HelperMethods.IsMono" /> method on its first call. Later, it
  11290. is returned verbatim by the <see cref="M:System.Data.SQLite.HelperMethods.IsMono" /> method.
  11291. </summary>
  11292. </member>
  11293. <member name="F:System.Data.SQLite.HelperMethods.isDotNetCore">
  11294. <summary>
  11295. Keeps track of whether we are running on .NET Core. Initially null,
  11296. it is set by the <see cref="M:System.Data.SQLite.HelperMethods.IsDotNetCore" /> method on its first
  11297. call. Later, it is returned verbatim by the
  11298. <see cref="M:System.Data.SQLite.HelperMethods.IsDotNetCore" /> method.
  11299. </summary>
  11300. </member>
  11301. <member name="F:System.Data.SQLite.HelperMethods.debuggerBreak">
  11302. <summary>
  11303. Keeps track of whether we successfully invoked the
  11304. <see cref="M:System.Diagnostics.Debugger.Break" /> method. Initially null, it is set by
  11305. the <see cref="M:System.Data.SQLite.HelperMethods.MaybeBreakIntoDebugger" /> method on its first call.
  11306. </summary>
  11307. </member>
  11308. <member name="M:System.Data.SQLite.HelperMethods.GetProcessId">
  11309. <summary>
  11310. Determines the ID of the current process. Only used for debugging.
  11311. </summary>
  11312. <returns>
  11313. The ID of the current process -OR- zero if it cannot be determined.
  11314. </returns>
  11315. </member>
  11316. <member name="M:System.Data.SQLite.HelperMethods.IsMono">
  11317. <summary>
  11318. Determines whether or not this assembly is running on Mono.
  11319. </summary>
  11320. <returns>
  11321. Non-zero if this assembly is running on Mono.
  11322. </returns>
  11323. </member>
  11324. <member name="M:System.Data.SQLite.HelperMethods.IsDotNetCore">
  11325. <summary>
  11326. Determines whether or not this assembly is running on .NET Core.
  11327. </summary>
  11328. <returns>
  11329. Non-zero if this assembly is running on .NET Core.
  11330. </returns>
  11331. </member>
  11332. <member name="M:System.Data.SQLite.HelperMethods.ResetBreakIntoDebugger">
  11333. <summary>
  11334. Resets the cached value for the "PreLoadSQLite_BreakIntoDebugger"
  11335. configuration setting.
  11336. </summary>
  11337. </member>
  11338. <member name="M:System.Data.SQLite.HelperMethods.MaybeBreakIntoDebugger">
  11339. <summary>
  11340. If the "PreLoadSQLite_BreakIntoDebugger" configuration setting is
  11341. present (e.g. via the environment), give the interactive user an
  11342. opportunity to attach a debugger to the current process; otherwise,
  11343. do nothing.
  11344. </summary>
  11345. </member>
  11346. <member name="M:System.Data.SQLite.HelperMethods.GetThreadId">
  11347. <summary>
  11348. Determines the ID of the current thread. Only used for debugging.
  11349. </summary>
  11350. <returns>
  11351. The ID of the current thread -OR- zero if it cannot be determined.
  11352. </returns>
  11353. </member>
  11354. <member name="M:System.Data.SQLite.HelperMethods.HasFlags(System.Data.SQLite.SQLiteConnectionFlags,System.Data.SQLite.SQLiteConnectionFlags)">
  11355. <summary>
  11356. Determines if the specified flags are present within the flags
  11357. associated with the parent connection object.
  11358. </summary>
  11359. <param name="flags">
  11360. The flags associated with the parent connection object.
  11361. </param>
  11362. <param name="hasFlags">
  11363. The flags to check for.
  11364. </param>
  11365. <returns>
  11366. Non-zero if the specified flag or flags were present; otherwise,
  11367. zero.
  11368. </returns>
  11369. </member>
  11370. <member name="M:System.Data.SQLite.HelperMethods.LogPrepare(System.Data.SQLite.SQLiteConnectionFlags)">
  11371. <summary>
  11372. Determines if preparing a query should be logged.
  11373. </summary>
  11374. <param name="flags">
  11375. The flags associated with the parent connection object.
  11376. </param>
  11377. <returns>
  11378. Non-zero if the query preparation should be logged; otherwise, zero.
  11379. </returns>
  11380. </member>
  11381. <member name="M:System.Data.SQLite.HelperMethods.LogPreBind(System.Data.SQLite.SQLiteConnectionFlags)">
  11382. <summary>
  11383. Determines if pre-parameter binding should be logged.
  11384. </summary>
  11385. <param name="flags">
  11386. The flags associated with the parent connection object.
  11387. </param>
  11388. <returns>
  11389. Non-zero if the pre-parameter binding should be logged; otherwise,
  11390. zero.
  11391. </returns>
  11392. </member>
  11393. <member name="M:System.Data.SQLite.HelperMethods.LogBind(System.Data.SQLite.SQLiteConnectionFlags)">
  11394. <summary>
  11395. Determines if parameter binding should be logged.
  11396. </summary>
  11397. <param name="flags">
  11398. The flags associated with the parent connection object.
  11399. </param>
  11400. <returns>
  11401. Non-zero if the parameter binding should be logged; otherwise, zero.
  11402. </returns>
  11403. </member>
  11404. <member name="M:System.Data.SQLite.HelperMethods.LogCallbackExceptions(System.Data.SQLite.SQLiteConnectionFlags)">
  11405. <summary>
  11406. Determines if an exception in a native callback should be logged.
  11407. </summary>
  11408. <param name="flags">
  11409. The flags associated with the parent connection object.
  11410. </param>
  11411. <returns>
  11412. Non-zero if the exception should be logged; otherwise, zero.
  11413. </returns>
  11414. </member>
  11415. <member name="M:System.Data.SQLite.HelperMethods.LogBackup(System.Data.SQLite.SQLiteConnectionFlags)">
  11416. <summary>
  11417. Determines if backup API errors should be logged.
  11418. </summary>
  11419. <param name="flags">
  11420. The flags associated with the parent connection object.
  11421. </param>
  11422. <returns>
  11423. Non-zero if the backup API error should be logged; otherwise, zero.
  11424. </returns>
  11425. </member>
  11426. <member name="M:System.Data.SQLite.HelperMethods.NoLogModule(System.Data.SQLite.SQLiteConnectionFlags)">
  11427. <summary>
  11428. Determines if logging for the <see cref="T:System.Data.SQLite.SQLiteModule" /> class is
  11429. disabled.
  11430. </summary>
  11431. <param name="flags">
  11432. The flags associated with the parent connection object.
  11433. </param>
  11434. <returns>
  11435. Non-zero if logging for the <see cref="T:System.Data.SQLite.SQLiteModule" /> class is
  11436. disabled; otherwise, zero.
  11437. </returns>
  11438. </member>
  11439. <member name="M:System.Data.SQLite.HelperMethods.LogModuleError(System.Data.SQLite.SQLiteConnectionFlags)">
  11440. <summary>
  11441. Determines if <see cref="T:System.Data.SQLite.SQLiteModule" /> errors should be logged.
  11442. </summary>
  11443. <param name="flags">
  11444. The flags associated with the parent connection object.
  11445. </param>
  11446. <returns>
  11447. Non-zero if the <see cref="T:System.Data.SQLite.SQLiteModule" /> error should be logged;
  11448. otherwise, zero.
  11449. </returns>
  11450. </member>
  11451. <member name="M:System.Data.SQLite.HelperMethods.LogModuleException(System.Data.SQLite.SQLiteConnectionFlags)">
  11452. <summary>
  11453. Determines if <see cref="T:System.Data.SQLite.SQLiteModule" /> exceptions should be
  11454. logged.
  11455. </summary>
  11456. <param name="flags">
  11457. The flags associated with the parent connection object.
  11458. </param>
  11459. <returns>
  11460. Non-zero if the <see cref="T:System.Data.SQLite.SQLiteModule" /> exception should be
  11461. logged; otherwise, zero.
  11462. </returns>
  11463. </member>
  11464. <member name="M:System.Data.SQLite.HelperMethods.IsWindows">
  11465. <summary>
  11466. Determines if the current process is running on one of the Windows
  11467. [sub-]platforms.
  11468. </summary>
  11469. <returns>
  11470. Non-zero when running on Windows; otherwise, zero.
  11471. </returns>
  11472. </member>
  11473. <member name="M:System.Data.SQLite.HelperMethods.StringFormat(System.IFormatProvider,System.String,System.Object[])">
  11474. <summary>
  11475. This is a wrapper around the
  11476. <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])" /> method.
  11477. On Mono, it has to call the method overload without the
  11478. <see cref="T:System.IFormatProvider" /> parameter, due to a bug in Mono.
  11479. </summary>
  11480. <param name="provider">
  11481. This is used for culture-specific formatting.
  11482. </param>
  11483. <param name="format">
  11484. The format string.
  11485. </param>
  11486. <param name="args">
  11487. An array the objects to format.
  11488. </param>
  11489. <returns>
  11490. The resulting string.
  11491. </returns>
  11492. </member>
  11493. <member name="T:System.Data.SQLite.NativeLibraryHelper">
  11494. <summary>
  11495. This static class provides a thin wrapper around the native library
  11496. loading features of the underlying platform.
  11497. </summary>
  11498. </member>
  11499. <member name="T:System.Data.SQLite.NativeLibraryHelper.LoadLibraryCallback">
  11500. <summary>
  11501. This delegate is used to wrap the concept of loading a native
  11502. library, based on a file name, and returning the loaded module
  11503. handle.
  11504. </summary>
  11505. <param name="fileName">
  11506. The file name of the native library to load.
  11507. </param>
  11508. <returns>
  11509. The native module handle upon success -OR- IntPtr.Zero on failure.
  11510. </returns>
  11511. </member>
  11512. <member name="T:System.Data.SQLite.NativeLibraryHelper.GetMachineCallback">
  11513. <summary>
  11514. This delegate is used to wrap the concept of querying the machine
  11515. name of the current process.
  11516. </summary>
  11517. <returns>
  11518. The machine name for the current process -OR- null on failure.
  11519. </returns>
  11520. </member>
  11521. <member name="M:System.Data.SQLite.NativeLibraryHelper.LoadLibraryWin32(System.String)">
  11522. <summary>
  11523. Attempts to load the specified native library file using the Win32
  11524. API.
  11525. </summary>
  11526. <param name="fileName">
  11527. The file name of the native library to load.
  11528. </param>
  11529. <returns>
  11530. The native module handle upon success -OR- IntPtr.Zero on failure.
  11531. </returns>
  11532. </member>
  11533. <member name="M:System.Data.SQLite.NativeLibraryHelper.GetMachineWin32">
  11534. <summary>
  11535. Attempts to determine the machine name of the current process using
  11536. the Win32 API.
  11537. </summary>
  11538. <returns>
  11539. The machine name for the current process -OR- null on failure.
  11540. </returns>
  11541. </member>
  11542. <member name="M:System.Data.SQLite.NativeLibraryHelper.LoadLibraryPosix(System.String)">
  11543. <summary>
  11544. Attempts to load the specified native library file using the POSIX
  11545. API.
  11546. </summary>
  11547. <param name="fileName">
  11548. The file name of the native library to load.
  11549. </param>
  11550. <returns>
  11551. The native module handle upon success -OR- IntPtr.Zero on failure.
  11552. </returns>
  11553. </member>
  11554. <member name="M:System.Data.SQLite.NativeLibraryHelper.GetMachinePosix">
  11555. <summary>
  11556. Attempts to determine the machine name of the current process using
  11557. the POSIX API.
  11558. </summary>
  11559. <returns>
  11560. The machine name for the current process -OR- null on failure.
  11561. </returns>
  11562. </member>
  11563. <member name="M:System.Data.SQLite.NativeLibraryHelper.LoadLibrary(System.String)">
  11564. <summary>
  11565. Attempts to load the specified native library file.
  11566. </summary>
  11567. <param name="fileName">
  11568. The file name of the native library to load.
  11569. </param>
  11570. <returns>
  11571. The native module handle upon success -OR- IntPtr.Zero on failure.
  11572. </returns>
  11573. </member>
  11574. <member name="M:System.Data.SQLite.NativeLibraryHelper.GetMachine">
  11575. <summary>
  11576. Attempts to determine the machine name of the current process.
  11577. </summary>
  11578. <returns>
  11579. The machine name for the current process -OR- null on failure.
  11580. </returns>
  11581. </member>
  11582. <member name="T:System.Data.SQLite.UnsafeNativeMethodsPosix">
  11583. <summary>
  11584. This class declares P/Invoke methods to call native POSIX APIs.
  11585. </summary>
  11586. </member>
  11587. <member name="T:System.Data.SQLite.UnsafeNativeMethodsPosix.utsname">
  11588. <summary>
  11589. This structure is used when running on POSIX operating systems
  11590. to store information about the current machine, including the
  11591. human readable name of the operating system as well as that of
  11592. the underlying hardware.
  11593. </summary>
  11594. </member>
  11595. <member name="T:System.Data.SQLite.UnsafeNativeMethodsPosix.utsname_interop">
  11596. <summary>
  11597. This structure is passed directly to the P/Invoke method to
  11598. obtain the information about the current machine, including
  11599. the human readable name of the operating system as well as
  11600. that of the underlying hardware.
  11601. </summary>
  11602. </member>
  11603. <member name="M:System.Data.SQLite.UnsafeNativeMethodsPosix.uname(System.Data.SQLite.UnsafeNativeMethodsPosix.utsname_interop@)">
  11604. <summary>
  11605. This is the P/Invoke method that wraps the native Unix uname
  11606. function. See the POSIX documentation for full details on what it
  11607. does.
  11608. </summary>
  11609. <param name="name">
  11610. Structure containing a preallocated byte buffer to fill with the
  11611. requested information.
  11612. </param>
  11613. <returns>
  11614. Zero for success and less than zero upon failure.
  11615. </returns>
  11616. </member>
  11617. <member name="M:System.Data.SQLite.UnsafeNativeMethodsPosix.dlopen(System.String,System.Int32)">
  11618. <summary>
  11619. This is the P/Invoke method that wraps the native Unix dlopen
  11620. function. See the POSIX documentation for full details on what it
  11621. does.
  11622. </summary>
  11623. <param name="fileName">
  11624. The name of the executable library.
  11625. </param>
  11626. <param name="mode">
  11627. This must be a combination of the individual bit flags RTLD_LAZY,
  11628. RTLD_NOW, RTLD_GLOBAL, and/or RTLD_LOCAL.
  11629. </param>
  11630. <returns>
  11631. The native module handle upon success -OR- IntPtr.Zero on failure.
  11632. </returns>
  11633. </member>
  11634. <member name="M:System.Data.SQLite.UnsafeNativeMethodsPosix.dlclose(System.IntPtr)">
  11635. <summary>
  11636. This is the P/Invoke method that wraps the native Unix dlclose
  11637. function. See the POSIX documentation for full details on what it
  11638. does.
  11639. </summary>
  11640. <param name="module">
  11641. The handle to the loaded native library.
  11642. </param>
  11643. <returns>
  11644. Zero upon success -OR- non-zero on failure.
  11645. </returns>
  11646. </member>
  11647. <member name="F:System.Data.SQLite.UnsafeNativeMethodsPosix.RTLD_LAZY">
  11648. <summary>
  11649. For use with dlopen(), bind function calls lazily.
  11650. </summary>
  11651. </member>
  11652. <member name="F:System.Data.SQLite.UnsafeNativeMethodsPosix.RTLD_NOW">
  11653. <summary>
  11654. For use with dlopen(), bind function calls immediately.
  11655. </summary>
  11656. </member>
  11657. <member name="F:System.Data.SQLite.UnsafeNativeMethodsPosix.RTLD_GLOBAL">
  11658. <summary>
  11659. For use with dlopen(), make symbols globally available.
  11660. </summary>
  11661. </member>
  11662. <member name="F:System.Data.SQLite.UnsafeNativeMethodsPosix.RTLD_LOCAL">
  11663. <summary>
  11664. For use with dlopen(), opposite of RTLD_GLOBAL, and the default.
  11665. </summary>
  11666. </member>
  11667. <member name="F:System.Data.SQLite.UnsafeNativeMethodsPosix.RTLD_DEFAULT">
  11668. <summary>
  11669. For use with dlopen(), the defaults used by this class.
  11670. </summary>
  11671. </member>
  11672. <member name="F:System.Data.SQLite.UnsafeNativeMethodsPosix.utsNameSeparators">
  11673. <summary>
  11674. These are the characters used to separate the string fields within
  11675. the raw buffer returned by the <see cref="M:System.Data.SQLite.UnsafeNativeMethodsPosix.uname(System.Data.SQLite.UnsafeNativeMethodsPosix.utsname_interop@)" /> P/Invoke method.
  11676. </summary>
  11677. </member>
  11678. <member name="M:System.Data.SQLite.UnsafeNativeMethodsPosix.GetOsVersionInfo(System.Data.SQLite.UnsafeNativeMethodsPosix.utsname@)">
  11679. <summary>
  11680. This method is a wrapper around the <see cref="M:System.Data.SQLite.UnsafeNativeMethodsPosix.uname(System.Data.SQLite.UnsafeNativeMethodsPosix.utsname_interop@)" /> P/Invoke
  11681. method that extracts and returns the human readable strings from
  11682. the raw buffer.
  11683. </summary>
  11684. <param name="utsName">
  11685. This structure, which contains strings, will be filled based on the
  11686. data placed in the raw buffer returned by the <see cref="M:System.Data.SQLite.UnsafeNativeMethodsPosix.uname(System.Data.SQLite.UnsafeNativeMethodsPosix.utsname_interop@)" />
  11687. P/Invoke method.
  11688. </param>
  11689. <returns>
  11690. Non-zero upon success; otherwise, zero.
  11691. </returns>
  11692. </member>
  11693. <member name="T:System.Data.SQLite.UnsafeNativeMethodsWin32">
  11694. <summary>
  11695. This class declares P/Invoke methods to call native Win32 APIs.
  11696. </summary>
  11697. </member>
  11698. <member name="M:System.Data.SQLite.UnsafeNativeMethodsWin32.LoadLibrary(System.String)">
  11699. <summary>
  11700. This is the P/Invoke method that wraps the native Win32 LoadLibrary
  11701. function. See the MSDN documentation for full details on what it
  11702. does.
  11703. </summary>
  11704. <param name="fileName">
  11705. The name of the executable library.
  11706. </param>
  11707. <returns>
  11708. The native module handle upon success -OR- IntPtr.Zero on failure.
  11709. </returns>
  11710. </member>
  11711. <member name="M:System.Data.SQLite.UnsafeNativeMethodsWin32.GetSystemInfo(System.Data.SQLite.UnsafeNativeMethodsWin32.SYSTEM_INFO@)">
  11712. <summary>
  11713. This is the P/Invoke method that wraps the native Win32 GetSystemInfo
  11714. function. See the MSDN documentation for full details on what it
  11715. does.
  11716. </summary>
  11717. <param name="systemInfo">
  11718. The system information structure to be filled in by the function.
  11719. </param>
  11720. </member>
  11721. <member name="T:System.Data.SQLite.UnsafeNativeMethodsWin32.ProcessorArchitecture">
  11722. <summary>
  11723. This enumeration contains the possible values for the processor
  11724. architecture field of the system information structure.
  11725. </summary>
  11726. </member>
  11727. <member name="T:System.Data.SQLite.UnsafeNativeMethodsWin32.SYSTEM_INFO">
  11728. <summary>
  11729. This structure contains information about the current computer. This
  11730. includes the processor type, page size, memory addresses, etc.
  11731. </summary>
  11732. </member>
  11733. <member name="T:System.Data.SQLite.UnsafeNativeMethods">
  11734. <summary>
  11735. This class declares P/Invoke methods to call native SQLite APIs.
  11736. </summary>
  11737. </member>
  11738. <member name="F:System.Data.SQLite.UnsafeNativeMethods.DllFileExtension">
  11739. <summary>
  11740. The file extension used for dynamic link libraries.
  11741. </summary>
  11742. </member>
  11743. <member name="F:System.Data.SQLite.UnsafeNativeMethods.ConfigFileExtension">
  11744. <summary>
  11745. The file extension used for the XML configuration file.
  11746. </summary>
  11747. </member>
  11748. <member name="F:System.Data.SQLite.UnsafeNativeMethods.XmlConfigFileName">
  11749. <summary>
  11750. This is the name of the XML configuration file specific to the
  11751. System.Data.SQLite assembly.
  11752. </summary>
  11753. </member>
  11754. <member name="F:System.Data.SQLite.UnsafeNativeMethods.XmlConfigDirectoryToken">
  11755. <summary>
  11756. This is the XML configuratrion file token that will be replaced with
  11757. the qualified path to the directory containing the XML configuration
  11758. file.
  11759. </summary>
  11760. </member>
  11761. <member name="F:System.Data.SQLite.UnsafeNativeMethods.AssemblyDirectoryToken">
  11762. <summary>
  11763. This is the environment variable token that will be replaced with
  11764. the qualified path to the directory containing this assembly.
  11765. </summary>
  11766. </member>
  11767. <member name="F:System.Data.SQLite.UnsafeNativeMethods.TargetFrameworkToken">
  11768. <summary>
  11769. This is the environment variable token that will be replaced with an
  11770. abbreviation of the target framework attribute value associated with
  11771. this assembly.
  11772. </summary>
  11773. </member>
  11774. <member name="F:System.Data.SQLite.UnsafeNativeMethods.staticSyncRoot">
  11775. <summary>
  11776. This lock is used to protect the static _SQLiteNativeModuleFileName,
  11777. _SQLiteNativeModuleHandle, and processorArchitecturePlatforms fields.
  11778. </summary>
  11779. </member>
  11780. <member name="F:System.Data.SQLite.UnsafeNativeMethods.targetFrameworkAbbreviations">
  11781. <summary>
  11782. This dictionary stores the mappings between target framework names
  11783. and their associated (NuGet) abbreviations. These mappings are only
  11784. used by the <see cref="M:System.Data.SQLite.UnsafeNativeMethods.AbbreviateTargetFramework(System.String)" /> method.
  11785. </summary>
  11786. </member>
  11787. <member name="F:System.Data.SQLite.UnsafeNativeMethods.processorArchitecturePlatforms">
  11788. <summary>
  11789. This dictionary stores the mappings between processor architecture
  11790. names and platform names. These mappings are now used for two
  11791. purposes. First, they are used to determine if the assembly code
  11792. base should be used instead of the location, based upon whether one
  11793. or more of the named sub-directories exist within the assembly code
  11794. base. Second, they are used to assist in loading the appropriate
  11795. SQLite interop assembly into the current process.
  11796. </summary>
  11797. </member>
  11798. <member name="F:System.Data.SQLite.UnsafeNativeMethods.cachedAssemblyDirectory">
  11799. <summary>
  11800. This is the cached return value from the
  11801. <see cref="M:System.Data.SQLite.UnsafeNativeMethods.GetAssemblyDirectory" /> method -OR- null if that method
  11802. has never returned a valid value.
  11803. </summary>
  11804. </member>
  11805. <member name="F:System.Data.SQLite.UnsafeNativeMethods.noAssemblyDirectory">
  11806. <summary>
  11807. When this field is non-zero, it indicates the
  11808. <see cref="M:System.Data.SQLite.UnsafeNativeMethods.GetAssemblyDirectory" /> method was not able to locate a
  11809. suitable assembly directory. The
  11810. <see cref="M:System.Data.SQLite.UnsafeNativeMethods.GetCachedAssemblyDirectory" /> method will check this
  11811. field and skips calls into the <see cref="M:System.Data.SQLite.UnsafeNativeMethods.GetAssemblyDirectory" />
  11812. method whenever it is non-zero.
  11813. </summary>
  11814. </member>
  11815. <member name="F:System.Data.SQLite.UnsafeNativeMethods.cachedXmlConfigFileName">
  11816. <summary>
  11817. This is the cached return value from the
  11818. <see cref="M:System.Data.SQLite.UnsafeNativeMethods.GetXmlConfigFileName" /> method -OR- null if that method
  11819. has never returned a valid value.
  11820. </summary>
  11821. </member>
  11822. <member name="F:System.Data.SQLite.UnsafeNativeMethods.noXmlConfigFileName">
  11823. <summary>
  11824. When this field is non-zero, it indicates the
  11825. <see cref="M:System.Data.SQLite.UnsafeNativeMethods.GetXmlConfigFileName" /> method was not able to locate a
  11826. suitable XML configuration file name. The
  11827. <see cref="M:System.Data.SQLite.UnsafeNativeMethods.GetCachedXmlConfigFileName" /> method will check this
  11828. field and skips calls into the <see cref="M:System.Data.SQLite.UnsafeNativeMethods.GetXmlConfigFileName" />
  11829. method whenever it is non-zero.
  11830. </summary>
  11831. </member>
  11832. <member name="M:System.Data.SQLite.UnsafeNativeMethods.#cctor">
  11833. <summary>
  11834. For now, this method simply calls the Initialize method.
  11835. </summary>
  11836. </member>
  11837. <member name="M:System.Data.SQLite.UnsafeNativeMethods.Initialize">
  11838. <summary>
  11839. Attempts to initialize this class by pre-loading the native SQLite
  11840. library for the processor architecture of the current process.
  11841. </summary>
  11842. </member>
  11843. <member name="M:System.Data.SQLite.UnsafeNativeMethods.MaybeCombinePath(System.String,System.String)">
  11844. <summary>
  11845. Combines two path strings.
  11846. </summary>
  11847. <param name="path1">
  11848. The first path -OR- null.
  11849. </param>
  11850. <param name="path2">
  11851. The second path -OR- null.
  11852. </param>
  11853. <returns>
  11854. The combined path string -OR- null if both of the original path
  11855. strings are null.
  11856. </returns>
  11857. </member>
  11858. <member name="M:System.Data.SQLite.UnsafeNativeMethods.ResetCachedXmlConfigFileName">
  11859. <summary>
  11860. Resets the cached XML configuration file name value, thus forcing the
  11861. next call to <see cref="M:System.Data.SQLite.UnsafeNativeMethods.GetCachedXmlConfigFileName" /> method to rely
  11862. upon the <see cref="M:System.Data.SQLite.UnsafeNativeMethods.GetXmlConfigFileName" /> method to fetch the
  11863. XML configuration file name.
  11864. </summary>
  11865. </member>
  11866. <member name="M:System.Data.SQLite.UnsafeNativeMethods.GetCachedXmlConfigFileName">
  11867. <summary>
  11868. Queries and returns the cached XML configuration file name for the
  11869. assembly containing the managed System.Data.SQLite components, if
  11870. available. If the cached XML configuration file name value is not
  11871. available, the <see cref="M:System.Data.SQLite.UnsafeNativeMethods.GetXmlConfigFileName" /> method will
  11872. be used to obtain the XML configuration file name.
  11873. </summary>
  11874. <returns>
  11875. The XML configuration file name -OR- null if it cannot be determined
  11876. or does not exist.
  11877. </returns>
  11878. </member>
  11879. <member name="M:System.Data.SQLite.UnsafeNativeMethods.GetXmlConfigFileName">
  11880. <summary>
  11881. Queries and returns the XML configuration file name for the assembly
  11882. containing the managed System.Data.SQLite components.
  11883. </summary>
  11884. <returns>
  11885. The XML configuration file name -OR- null if it cannot be determined
  11886. or does not exist.
  11887. </returns>
  11888. </member>
  11889. <member name="M:System.Data.SQLite.UnsafeNativeMethods.ReplaceXmlConfigFileTokens(System.String,System.String)">
  11890. <summary>
  11891. If necessary, replaces all supported XML configuration file tokens
  11892. with their associated values.
  11893. </summary>
  11894. <param name="fileName">
  11895. The name of the XML configuration file being read.
  11896. </param>
  11897. <param name="value">
  11898. A setting value read from the XML configuration file.
  11899. </param>
  11900. <returns>
  11901. The value of the <paramref name="value" /> will all supported XML
  11902. configuration file tokens replaced. No return value is reserved
  11903. to indicate an error. This method cannot fail.
  11904. </returns>
  11905. </member>
  11906. <member name="M:System.Data.SQLite.UnsafeNativeMethods.GetSettingValueViaXmlConfigFile(System.String,System.String,System.String,System.Boolean)">
  11907. <summary>
  11908. Queries and returns the value of the specified setting, using the
  11909. specified XML configuration file.
  11910. </summary>
  11911. <param name="fileName">
  11912. The name of the XML configuration file to read.
  11913. </param>
  11914. <param name="name">
  11915. The name of the setting.
  11916. </param>
  11917. <param name="default">
  11918. The value to be returned if the setting has not been set explicitly
  11919. or cannot be determined.
  11920. </param>
  11921. <param name="expand">
  11922. Non-zero to expand any environment variable references contained in
  11923. the setting value to be returned. This has no effect on the .NET
  11924. Compact Framework.
  11925. </param>
  11926. <returns>
  11927. The value of the setting -OR- the default value specified by
  11928. <paramref name="default" /> if it has not been set explicitly or
  11929. cannot be determined.
  11930. </returns>
  11931. </member>
  11932. <member name="M:System.Data.SQLite.UnsafeNativeMethods.GetAssemblyTargetFramework(System.Reflection.Assembly)">
  11933. <summary>
  11934. Attempts to determine the target framework attribute value that is
  11935. associated with the specified managed assembly, if applicable.
  11936. </summary>
  11937. <param name="assembly">
  11938. The managed assembly to read the target framework attribute value
  11939. from.
  11940. </param>
  11941. <returns>
  11942. The value of the target framework attribute value for the specified
  11943. managed assembly -OR- null if it cannot be determined. If this
  11944. assembly was compiled with a version of the .NET Framework prior to
  11945. version 4.0, the value returned MAY reflect that version of the .NET
  11946. Framework instead of the one associated with the specified managed
  11947. assembly.
  11948. </returns>
  11949. </member>
  11950. <member name="M:System.Data.SQLite.UnsafeNativeMethods.AbbreviateTargetFramework(System.String)">
  11951. <summary>
  11952. Accepts a long target framework attribute value and makes it into a
  11953. much shorter version, suitable for use with NuGet packages.
  11954. </summary>
  11955. <param name="targetFramework">
  11956. The long target framework attribute value to convert.
  11957. </param>
  11958. <returns>
  11959. The short target framework attribute value -OR- null if it cannot
  11960. be determined or converted.
  11961. </returns>
  11962. </member>
  11963. <member name="M:System.Data.SQLite.UnsafeNativeMethods.ReplaceEnvironmentVariableTokens(System.String)">
  11964. <summary>
  11965. If necessary, replaces all supported environment variable tokens
  11966. with their associated values.
  11967. </summary>
  11968. <param name="value">
  11969. A setting value read from an environment variable.
  11970. </param>
  11971. <returns>
  11972. The value of the <paramref name="value" /> will all supported
  11973. environment variable tokens replaced. No return value is reserved
  11974. to indicate an error. This method cannot fail.
  11975. </returns>
  11976. </member>
  11977. <member name="M:System.Data.SQLite.UnsafeNativeMethods.GetSettingValue(System.String,System.String)">
  11978. <summary>
  11979. Queries and returns the value of the specified setting, using the XML
  11980. configuration file and/or the environment variables for the current
  11981. process and/or the current system, when available.
  11982. </summary>
  11983. <param name="name">
  11984. The name of the setting.
  11985. </param>
  11986. <param name="default">
  11987. The value to be returned if the setting has not been set explicitly
  11988. or cannot be determined.
  11989. </param>
  11990. <returns>
  11991. The value of the setting -OR- the default value specified by
  11992. <paramref name="default" /> if it has not been set explicitly or
  11993. cannot be determined. By default, all references to existing
  11994. environment variables will be expanded to their corresponding values
  11995. within the value to be returned unless either the "No_Expand" or
  11996. "No_Expand_<paramref name="name" />" environment variable is set [to
  11997. anything].
  11998. </returns>
  11999. </member>
  12000. <member name="M:System.Data.SQLite.UnsafeNativeMethods.ResetCachedAssemblyDirectory">
  12001. <summary>
  12002. Resets the cached assembly directory value, thus forcing the next
  12003. call to <see cref="M:System.Data.SQLite.UnsafeNativeMethods.GetCachedAssemblyDirectory" /> method to rely
  12004. upon the <see cref="M:System.Data.SQLite.UnsafeNativeMethods.GetAssemblyDirectory" /> method to fetch the
  12005. assembly directory.
  12006. </summary>
  12007. </member>
  12008. <member name="M:System.Data.SQLite.UnsafeNativeMethods.GetCachedAssemblyDirectory">
  12009. <summary>
  12010. Queries and returns the cached directory for the assembly currently
  12011. being executed, if available. If the cached assembly directory value
  12012. is not available, the <see cref="M:System.Data.SQLite.UnsafeNativeMethods.GetAssemblyDirectory" /> method will
  12013. be used to obtain the assembly directory.
  12014. </summary>
  12015. <returns>
  12016. The directory for the assembly currently being executed -OR- null if
  12017. it cannot be determined.
  12018. </returns>
  12019. </member>
  12020. <member name="M:System.Data.SQLite.UnsafeNativeMethods.GetAssemblyDirectory">
  12021. <summary>
  12022. Queries and returns the directory for the assembly currently being
  12023. executed.
  12024. </summary>
  12025. <returns>
  12026. The directory for the assembly currently being executed -OR- null if
  12027. it cannot be determined.
  12028. </returns>
  12029. </member>
  12030. <member name="F:System.Data.SQLite.UnsafeNativeMethods.PROCESSOR_ARCHITECTURE">
  12031. <summary>
  12032. The name of the environment variable containing the processor
  12033. architecture of the current process.
  12034. </summary>
  12035. </member>
  12036. <member name="F:System.Data.SQLite.UnsafeNativeMethods._SQLiteNativeModuleFileName">
  12037. <summary>
  12038. The native module file name for the native SQLite library or null.
  12039. </summary>
  12040. </member>
  12041. <member name="F:System.Data.SQLite.UnsafeNativeMethods._SQLiteNativeModuleHandle">
  12042. <summary>
  12043. The native module handle for the native SQLite library or the value
  12044. IntPtr.Zero.
  12045. </summary>
  12046. </member>
  12047. <member name="M:System.Data.SQLite.UnsafeNativeMethods.GetNativeLibraryFileNameOnly">
  12048. <summary>
  12049. Determines the base file name (without any directory information)
  12050. for the native SQLite library to be pre-loaded by this class.
  12051. </summary>
  12052. <returns>
  12053. The base file name for the native SQLite library to be pre-loaded by
  12054. this class -OR- null if its value cannot be determined.
  12055. </returns>
  12056. </member>
  12057. <member name="M:System.Data.SQLite.UnsafeNativeMethods.SearchForDirectory(System.String@,System.String@,System.Boolean@)">
  12058. <summary>
  12059. Searches for the native SQLite library in the directory containing
  12060. the assembly currently being executed as well as the base directory
  12061. for the current application domain.
  12062. </summary>
  12063. <param name="baseDirectory">
  12064. Upon success, this parameter will be modified to refer to the base
  12065. directory containing the native SQLite library.
  12066. </param>
  12067. <param name="processorArchitecture">
  12068. Upon success, this parameter will be modified to refer to the name
  12069. of the immediate directory (i.e. the offset from the base directory)
  12070. containing the native SQLite library.
  12071. </param>
  12072. <param name="allowBaseDirectoryOnly">
  12073. Upon success, this parameter will be modified to non-zero only if
  12074. the base directory itself should be allowed for loading the native
  12075. library.
  12076. </param>
  12077. <returns>
  12078. Non-zero (success) if the native SQLite library was found; otherwise,
  12079. zero (failure).
  12080. </returns>
  12081. </member>
  12082. <member name="M:System.Data.SQLite.UnsafeNativeMethods.GetBaseDirectory">
  12083. <summary>
  12084. Queries and returns the base directory of the current application
  12085. domain.
  12086. </summary>
  12087. <returns>
  12088. The base directory for the current application domain -OR- null if it
  12089. cannot be determined.
  12090. </returns>
  12091. </member>
  12092. <member name="M:System.Data.SQLite.UnsafeNativeMethods.FixUpDllFileName(System.String)">
  12093. <summary>
  12094. Determines if the dynamic link library file name requires a suffix
  12095. and adds it if necessary.
  12096. </summary>
  12097. <param name="fileName">
  12098. The original dynamic link library file name to inspect.
  12099. </param>
  12100. <returns>
  12101. The dynamic link library file name, possibly modified to include an
  12102. extension.
  12103. </returns>
  12104. </member>
  12105. <member name="M:System.Data.SQLite.UnsafeNativeMethods.GetProcessorArchitecture">
  12106. <summary>
  12107. Queries and returns the processor architecture of the current
  12108. process.
  12109. </summary>
  12110. <returns>
  12111. The processor architecture of the current process -OR- null if it
  12112. cannot be determined.
  12113. </returns>
  12114. </member>
  12115. <member name="M:System.Data.SQLite.UnsafeNativeMethods.GetPlatformName(System.String)">
  12116. <summary>
  12117. Given the processor architecture, returns the name of the platform.
  12118. </summary>
  12119. <param name="processorArchitecture">
  12120. The processor architecture to be translated to a platform name.
  12121. </param>
  12122. <returns>
  12123. The platform name for the specified processor architecture -OR- null
  12124. if it cannot be determined.
  12125. </returns>
  12126. </member>
  12127. <member name="M:System.Data.SQLite.UnsafeNativeMethods.PreLoadSQLiteDll(System.String,System.String,System.Boolean,System.String@,System.IntPtr@)">
  12128. <summary>
  12129. Attempts to load the native SQLite library based on the specified
  12130. directory and processor architecture.
  12131. </summary>
  12132. <param name="baseDirectory">
  12133. The base directory to use, null for default (the base directory of
  12134. the current application domain). This directory should contain the
  12135. processor architecture specific sub-directories.
  12136. </param>
  12137. <param name="processorArchitecture">
  12138. The requested processor architecture, null for default (the
  12139. processor architecture of the current process). This caller should
  12140. almost always specify null for this parameter.
  12141. </param>
  12142. <param name="allowBaseDirectoryOnly">
  12143. Non-zero indicates that the native SQLite library can be loaded
  12144. from the base directory itself.
  12145. </param>
  12146. <param name="nativeModuleFileName">
  12147. The candidate native module file name to load will be stored here,
  12148. if necessary.
  12149. </param>
  12150. <param name="nativeModuleHandle">
  12151. The native module handle as returned by LoadLibrary will be stored
  12152. here, if necessary. This value will be IntPtr.Zero if the call to
  12153. LoadLibrary fails.
  12154. </param>
  12155. <returns>
  12156. Non-zero if the native module was loaded successfully; otherwise,
  12157. zero.
  12158. </returns>
  12159. </member>
  12160. <member name="T:System.Data.SQLite.SR">
  12161. <summary>
  12162. A strongly-typed resource class, for looking up localized strings, etc.
  12163. </summary>
  12164. </member>
  12165. <member name="P:System.Data.SQLite.SR.ResourceManager">
  12166. <summary>
  12167. Returns the cached ResourceManager instance used by this class.
  12168. </summary>
  12169. </member>
  12170. <member name="P:System.Data.SQLite.SR.Culture">
  12171. <summary>
  12172. Overrides the current thread's CurrentUICulture property for all
  12173. resource lookups using this strongly typed resource class.
  12174. </summary>
  12175. </member>
  12176. <member name="P:System.Data.SQLite.SR.DataTypes">
  12177. <summary>
  12178. Looks up a localized string similar to &lt;?xml version=&quot;1.0&quot; standalone=&quot;yes&quot;?&gt;
  12179. &lt;DocumentElement&gt;
  12180. &lt;DataTypes&gt;
  12181. &lt;TypeName&gt;smallint&lt;/TypeName&gt;
  12182. &lt;ProviderDbType&gt;10&lt;/ProviderDbType&gt;
  12183. &lt;ColumnSize&gt;5&lt;/ColumnSize&gt;
  12184. &lt;DataType&gt;System.Int16&lt;/DataType&gt;
  12185. &lt;CreateFormat&gt;smallint&lt;/CreateFormat&gt;
  12186. &lt;IsAutoIncrementable&gt;false&lt;/IsAutoIncrementable&gt;
  12187. &lt;IsCaseSensitive&gt;false&lt;/IsCaseSensitive&gt;
  12188. &lt;IsFixedLength&gt;true&lt;/IsFixedLength&gt;
  12189. &lt;IsFixedPrecisionScale&gt;true&lt;/IsFixedPrecisionScale&gt;
  12190. &lt;IsLong&gt;false&lt;/IsLong&gt;
  12191. &lt;IsNullable&gt;true&lt;/ [rest of string was truncated]&quot;;.
  12192. </summary>
  12193. </member>
  12194. <member name="P:System.Data.SQLite.SR.Keywords">
  12195. <summary>
  12196. 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.
  12197. </summary>
  12198. </member>
  12199. <member name="P:System.Data.SQLite.SR.MetaDataCollections">
  12200. <summary>
  12201. Looks up a localized string similar to &lt;?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot; ?&gt;
  12202. &lt;DocumentElement&gt;
  12203. &lt;MetaDataCollections&gt;
  12204. &lt;CollectionName&gt;MetaDataCollections&lt;/CollectionName&gt;
  12205. &lt;NumberOfRestrictions&gt;0&lt;/NumberOfRestrictions&gt;
  12206. &lt;NumberOfIdentifierParts&gt;0&lt;/NumberOfIdentifierParts&gt;
  12207. &lt;/MetaDataCollections&gt;
  12208. &lt;MetaDataCollections&gt;
  12209. &lt;CollectionName&gt;DataSourceInformation&lt;/CollectionName&gt;
  12210. &lt;NumberOfRestrictions&gt;0&lt;/NumberOfRestrictions&gt;
  12211. &lt;NumberOfIdentifierParts&gt;0&lt;/NumberOfIdentifierParts&gt;
  12212. &lt;/MetaDataCollections&gt;
  12213. &lt;MetaDataC [rest of string was truncated]&quot;;.
  12214. </summary>
  12215. </member>
  12216. <member name="T:System.Data.SQLite.ISQLiteNativeModule">
  12217. <summary>
  12218. This interface represents a virtual table implementation written in
  12219. native code.
  12220. </summary>
  12221. </member>
  12222. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)">
  12223. <summary>
  12224. <para><code>
  12225. int (*xCreate)(sqlite3 *db, void *pAux,
  12226. int argc, char *const*argv,
  12227. sqlite3_vtab **ppVTab,
  12228. char **pzErr);
  12229. </code></para>
  12230. <para>
  12231. The xCreate method is called to create a new instance of a virtual table
  12232. in response to a CREATE VIRTUAL TABLE statement.
  12233. If the xCreate method is the same pointer as the xConnect method, then the
  12234. virtual table is an eponymous virtual table.
  12235. If the xCreate method is omitted (if it is a NULL pointer) then the virtual
  12236. table is an eponymous-only virtual table.
  12237. </para>
  12238. <para>
  12239. The db parameter is a pointer to the SQLite database connection that
  12240. is executing the CREATE VIRTUAL TABLE statement.
  12241. The pAux argument is the copy of the client data pointer that was the
  12242. fourth argument to the sqlite3_create_module() or
  12243. sqlite3_create_module_v2() call that registered the
  12244. virtual table module.
  12245. The argv parameter is an array of argc pointers to null terminated strings.
  12246. The first string, argv[0], is the name of the module being invoked. The
  12247. module name is the name provided as the second argument to
  12248. sqlite3_create_module() and as the argument to the USING clause of the
  12249. CREATE VIRTUAL TABLE statement that is running.
  12250. 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
  12251. "temp" for TEMP database, or the name given at the end of the ATTACH
  12252. statement for attached databases. The third element of the array, argv[2],
  12253. is the name of the new virtual table, as specified following the TABLE
  12254. keyword in the CREATE VIRTUAL TABLE statement.
  12255. If present, the fourth and subsequent strings in the argv[] array report
  12256. the arguments to the module name in the CREATE VIRTUAL TABLE statement.
  12257. </para>
  12258. <para>
  12259. The job of this method is to construct the new virtual table object
  12260. (an sqlite3_vtab object) and return a pointer to it in *ppVTab.
  12261. </para>
  12262. <para>
  12263. As part of the task of creating a new sqlite3_vtab structure, this
  12264. method <u>must</u> invoke sqlite3_declare_vtab() to tell the SQLite
  12265. core about the columns and datatypes in the virtual table.
  12266. The sqlite3_declare_vtab() API has the following prototype:
  12267. </para>
  12268. <para><code>
  12269. int sqlite3_declare_vtab(sqlite3 *db, const char *zCreateTable)
  12270. </code></para>
  12271. <para>
  12272. The first argument to sqlite3_declare_vtab() must be the same
  12273. database connection pointer as the first parameter to this method.
  12274. The second argument to sqlite3_declare_vtab() must a zero-terminated
  12275. UTF-8 string that contains a well-formed CREATE TABLE statement that
  12276. defines the columns in the virtual table and their data types.
  12277. The name of the table in this CREATE TABLE statement is ignored,
  12278. as are all constraints. Only the column names and datatypes matter.
  12279. The CREATE TABLE statement string need not to be
  12280. held in persistent memory. The string can be
  12281. deallocated and/or reused as soon as the sqlite3_declare_vtab()
  12282. routine returns.
  12283. </para>
  12284. <para>
  12285. The xCreate method need not initialize the pModule, nRef, and zErrMsg
  12286. fields of the sqlite3_vtab object. The SQLite core will take care of
  12287. that chore.
  12288. </para>
  12289. <para>
  12290. The xCreate should return SQLITE_OK if it is successful in
  12291. creating the new virtual table, or SQLITE_ERROR if it is not successful.
  12292. If not successful, the sqlite3_vtab structure must not be allocated.
  12293. An error message may optionally be returned in *pzErr if unsuccessful.
  12294. Space to hold the error message string must be allocated using
  12295. an SQLite memory allocation function like
  12296. sqlite3_malloc() or sqlite3_mprintf() as the SQLite core will
  12297. attempt to free the space using sqlite3_free() after the error has
  12298. been reported up to the application.
  12299. </para>
  12300. <para>
  12301. If the xCreate method is omitted (left as a NULL pointer) then the
  12302. virtual table is an eponymous-only virtual table. New instances of
  12303. the virtual table cannot be created using CREATE VIRTUAL TABLE and the
  12304. virtual table can only be used via its module name.
  12305. Note that SQLite versions prior to 3.9.0 (2015-10-14) do not understand
  12306. eponymous-only virtual tables and will segfault if an attempt is made
  12307. to CREATE VIRTUAL TABLE on an eponymous-only virtual table because
  12308. the xCreate method was not checked for null.
  12309. </para>
  12310. <para>
  12311. If the xCreate method is the exact same pointer as the xConnect method,
  12312. that indicates that the virtual table does not need to initialize backing
  12313. store. Such a virtual table can be used as an eponymous virtual table
  12314. or as a named virtual table using CREATE VIRTUAL TABLE or both.
  12315. </para>
  12316. <para>
  12317. If a column datatype contains the special keyword "HIDDEN"
  12318. (in any combination of upper and lower case letters) then that keyword
  12319. it is omitted from the column datatype name and the column is marked
  12320. as a hidden column internally.
  12321. A hidden column differs from a normal column in three respects:
  12322. </para>
  12323. <para>
  12324. <![CDATA[<ul>]]>
  12325. <![CDATA[<li>]]> Hidden columns are not listed in the dataset returned by
  12326. "PRAGMA table_info",
  12327. <![CDATA[</li>]]><![CDATA[<li>]]> Hidden columns are not included in the expansion of a "*"
  12328. expression in the result set of a SELECT, and
  12329. <![CDATA[</li>]]><![CDATA[<li>]]> Hidden columns are not included in the implicit column-list
  12330. used by an INSERT statement that lacks an explicit column-list.
  12331. <![CDATA[</li>]]><![CDATA[</ul>]]>
  12332. </para>
  12333. <para>
  12334. For example, if the following SQL is passed to sqlite3_declare_vtab():
  12335. </para>
  12336. <para><code>
  12337. CREATE TABLE x(a HIDDEN VARCHAR(12), b INTEGER, c INTEGER Hidden);
  12338. </code></para>
  12339. <para>
  12340. Then the virtual table would be created with two hidden columns,
  12341. and with datatypes of "VARCHAR(12)" and "INTEGER".
  12342. </para>
  12343. <para>
  12344. An example use of hidden columns can be seen in the FTS3 virtual
  12345. table implementation, where every FTS virtual table
  12346. contains an FTS hidden column that is used to pass information from the
  12347. virtual table into FTS auxiliary functions and to the FTS MATCH operator.
  12348. </para>
  12349. <para>
  12350. A virtual table that contains hidden columns can be used like
  12351. a table-valued function in the FROM clause of a SELECT statement.
  12352. The arguments to the table-valued function become constraints on
  12353. the HIDDEN columns of the virtual table.
  12354. </para>
  12355. <para>
  12356. For example, the "generate_series" extension (located in the
  12357. ext/misc/series.c
  12358. file in the source tree)
  12359. implements an eponymous virtual table with the following schema:
  12360. </para>
  12361. <para><code>
  12362. CREATE TABLE generate_series(
  12363. value,
  12364. start HIDDEN,
  12365. stop HIDDEN,
  12366. step HIDDEN
  12367. );
  12368. </code></para>
  12369. <para>
  12370. The sqlite3_module.xBestIndex method in the implementation of this
  12371. table checks for equality constraints against the HIDDEN columns, and uses
  12372. those as input parameters to determine the range of integer "value" outputs
  12373. to generate. Reasonable defaults are used for any unconstrained columns.
  12374. For example, to list all integers between 5 and 50:
  12375. </para>
  12376. <para><code>
  12377. SELECT value FROM generate_series(5,50);
  12378. </code></para>
  12379. <para>
  12380. The previous query is equivalent to the following:
  12381. </para>
  12382. <para><code>
  12383. SELECT value FROM generate_series WHERE start=5 AND stop=50;
  12384. </code></para>
  12385. <para>
  12386. Arguments on the virtual table name are matched to hidden columns
  12387. in order. The number of arguments can be less than the
  12388. number of hidden columns, in which case the latter hidden columns are
  12389. unconstrained. However, an error results if there are more arguments
  12390. than there are hidden columns in the virtual table.
  12391. </para>
  12392. <para>
  12393. Beginning with SQLite version 3.14.0 (2016-08-08),
  12394. the CREATE TABLE statement that
  12395. is passed into sqlite3_declare_vtab() may contain a WITHOUT ROWID clause.
  12396. This is useful for cases where the virtual table rows
  12397. cannot easily be mapped into unique integers. A CREATE TABLE
  12398. statement that includes WITHOUT ROWID must define one or more columns as
  12399. the PRIMARY KEY. Every column of the PRIMARY KEY must individually be
  12400. NOT NULL and all columns for each row must be collectively unique.
  12401. </para>
  12402. <para>
  12403. Note that SQLite does not enforce the PRIMARY KEY for a WITHOUT ROWID
  12404. virtual table. Enforcement is the responsibility of the underlying
  12405. virtual table implementation. But SQLite does assume that the PRIMARY KEY
  12406. constraint is valid - that the identified columns really are UNIQUE and
  12407. NOT NULL - and it uses that assumption to optimize queries against the
  12408. virtual table.
  12409. </para>
  12410. <para>
  12411. The rowid column is not accessible on a
  12412. WITHOUT ROWID virtual table (of course).
  12413. </para>
  12414. <para>
  12415. The xUpdate method was originally designed around having a
  12416. ROWID as a single value. The xUpdate method has been expanded to
  12417. accommodate an arbitrary PRIMARY KEY in place of the ROWID, but the
  12418. PRIMARY KEY must still be only one column. For this reason, SQLite
  12419. will reject any WITHOUT ROWID virtual table that has more than one
  12420. PRIMARY KEY column and a non-NULL xUpdate method.
  12421. </para>
  12422. </summary>
  12423. <param name="pDb">
  12424. The native database connection handle.
  12425. </param>
  12426. <param name="pAux">
  12427. The original native pointer value that was provided to the
  12428. sqlite3_create_module(), sqlite3_create_module_v2() or
  12429. sqlite3_create_disposable_module() functions.
  12430. </param>
  12431. <param name="argc">
  12432. The number of arguments from the CREATE VIRTUAL TABLE statement.
  12433. </param>
  12434. <param name="argv">
  12435. The array of string arguments from the CREATE VIRTUAL TABLE
  12436. statement.
  12437. </param>
  12438. <param name="pVtab">
  12439. Upon success, this parameter must be modified to point to the newly
  12440. created native sqlite3_vtab derived structure.
  12441. </param>
  12442. <param name="pError">
  12443. Upon failure, this parameter must be modified to point to the error
  12444. message, with the underlying memory having been obtained from the
  12445. sqlite3_malloc() function.
  12446. </param>
  12447. <returns>
  12448. A standard SQLite return code.
  12449. </returns>
  12450. </member>
  12451. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)">
  12452. <summary>
  12453. <para><code>
  12454. int (*xConnect)(sqlite3*, void *pAux,
  12455. int argc, char *const*argv,
  12456. sqlite3_vtab **ppVTab,
  12457. char **pzErr);
  12458. </code></para>
  12459. <para>
  12460. The xConnect method is very similar to xCreate.
  12461. It has the same parameters and constructs a new sqlite3_vtab structure
  12462. just like xCreate.
  12463. And it must also call sqlite3_declare_vtab() like xCreate.
  12464. </para>
  12465. <para>
  12466. The difference is that xConnect is called to establish a new
  12467. connection to an existing virtual table whereas xCreate is called
  12468. to create a new virtual table from scratch.
  12469. </para>
  12470. <para>
  12471. The xCreate and xConnect methods are only different when the
  12472. virtual table has some kind of backing store that must be initialized
  12473. the first time the virtual table is created. The xCreate method creates
  12474. and initializes the backing store. The xConnect method just connects
  12475. to an existing backing store. When xCreate and xConnect are the same,
  12476. the table is an eponymous virtual table.
  12477. </para>
  12478. <para>
  12479. As an example, consider a virtual table implementation that
  12480. provides read-only access to existing comma-separated-value (CSV)
  12481. files on disk. There is no backing store that needs to be created
  12482. or initialized for such a virtual table (since the CSV files already
  12483. exist on disk) so the xCreate and xConnect methods will be identical
  12484. for that module.
  12485. </para>
  12486. <para>
  12487. Another example is a virtual table that implements a full-text index.
  12488. The xCreate method must create and initialize data structures to hold
  12489. the dictionary and posting lists for that index. The xConnect method,
  12490. on the other hand, only has to locate and use an existing dictionary
  12491. and posting lists that were created by a prior xCreate call.
  12492. </para>
  12493. <para>
  12494. The xConnect method must return SQLITE_OK if it is successful
  12495. in creating the new virtual table, or SQLITE_ERROR if it is not
  12496. successful. If not successful, the sqlite3_vtab structure must not be
  12497. allocated. An error message may optionally be returned in *pzErr if
  12498. unsuccessful.
  12499. Space to hold the error message string must be allocated using
  12500. an SQLite memory allocation function like
  12501. sqlite3_malloc() or sqlite3_mprintf() as the SQLite core will
  12502. attempt to free the space using sqlite3_free() after the error has
  12503. been reported up to the application.
  12504. </para>
  12505. <para>
  12506. The xConnect method is required for every virtual table implementation,
  12507. though the xCreate and xConnect pointers of the sqlite3_module object
  12508. may point to the same function if the virtual table does not need to
  12509. initialize backing store.
  12510. </para>
  12511. </summary>
  12512. <param name="pDb">
  12513. The native database connection handle.
  12514. </param>
  12515. <param name="pAux">
  12516. The original native pointer value that was provided to the
  12517. sqlite3_create_module(), sqlite3_create_module_v2() or
  12518. sqlite3_create_disposable_module() functions.
  12519. </param>
  12520. <param name="argc">
  12521. The number of arguments from the CREATE VIRTUAL TABLE statement.
  12522. </param>
  12523. <param name="argv">
  12524. The array of string arguments from the CREATE VIRTUAL TABLE
  12525. statement.
  12526. </param>
  12527. <param name="pVtab">
  12528. Upon success, this parameter must be modified to point to the newly
  12529. created native sqlite3_vtab derived structure.
  12530. </param>
  12531. <param name="pError">
  12532. Upon failure, this parameter must be modified to point to the error
  12533. message, with the underlying memory having been obtained from the
  12534. sqlite3_malloc() function.
  12535. </param>
  12536. <returns>
  12537. A standard SQLite return code.
  12538. </returns>
  12539. </member>
  12540. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xBestIndex(System.IntPtr,System.IntPtr)">
  12541. <summary>
  12542. <para>
  12543. SQLite uses the xBestIndex method of a virtual table module to determine
  12544. the best way to access the virtual table.
  12545. The xBestIndex method has a prototype like this:
  12546. </para>
  12547. <para><code>
  12548. int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info*);
  12549. </code></para>
  12550. <para>
  12551. The SQLite core communicates with the xBestIndex method by filling
  12552. in certain fields of the sqlite3_index_info structure and passing a
  12553. pointer to that structure into xBestIndex as the second parameter.
  12554. The xBestIndex method fills out other fields of this structure which
  12555. forms the reply. The sqlite3_index_info structure looks like this:
  12556. </para>
  12557. <para><code>
  12558. struct sqlite3_index_info {
  12559. /* Inputs */
  12560. const int nConstraint; /* Number of entries in aConstraint */
  12561. const struct sqlite3_index_constraint {
  12562. int iColumn; /* Column constrained. -1 for ROWID */
  12563. unsigned char op; /* Constraint operator */
  12564. unsigned char usable; /* True if this constraint is usable */
  12565. int iTermOffset; /* Used internally - xBestIndex should ignore */
  12566. } *const aConstraint; /* Table of WHERE clause constraints */
  12567. const int nOrderBy; /* Number of terms in the ORDER BY clause */
  12568. const struct sqlite3_index_orderby {
  12569. int iColumn; /* Column number */
  12570. unsigned char desc; /* True for DESC. False for ASC. */
  12571. } *const aOrderBy; /* The ORDER BY clause */
  12572. /* Outputs */
  12573. struct sqlite3_index_constraint_usage {
  12574. int argvIndex; /* if >0, constraint is part of argv to xFilter */
  12575. unsigned char omit; /* Do not code a test for this constraint */
  12576. } *const aConstraintUsage;
  12577. int idxNum; /* Number used to identify the index */
  12578. char *idxStr; /* String, possibly obtained from sqlite3_malloc */
  12579. int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */
  12580. int orderByConsumed; /* True if output is already ordered */
  12581. double estimatedCost; /* Estimated cost of using this index */
  12582. <![CDATA[<b>]]>/* Fields below are only available in SQLite 3.8.2 and later */<![CDATA[</b>]]>
  12583. sqlite3_int64 estimatedRows; /* Estimated number of rows returned */
  12584. <![CDATA[<b>]]>/* Fields below are only available in SQLite 3.9.0 and later */<![CDATA[</b>]]>
  12585. int idxFlags; /* Mask of SQLITE_INDEX_SCAN_* flags */
  12586. <![CDATA[<b>]]>/* Fields below are only available in SQLite 3.10.0 and later */<![CDATA[</b>]]>
  12587. sqlite3_uint64 colUsed; /* Input: Mask of columns used by statement */
  12588. };
  12589. </code></para>
  12590. <para>
  12591. Note the warnings on the "estimatedRows", "idxFlags", and colUsed fields.
  12592. These fields were added with SQLite versions 3.8.2, 3.9.0, and 3.10.0, respectively.
  12593. Any extension that reads or writes these fields must first check that the
  12594. version of the SQLite library in use is greater than or equal to appropriate
  12595. version - perhaps comparing the value returned from sqlite3_libversion_number()
  12596. against constants 3008002, 3009000, and/or 3010000. The result of attempting
  12597. to access these fields in an sqlite3_index_info structure created by an
  12598. older version of SQLite are undefined.
  12599. </para>
  12600. <para>
  12601. In addition, there are some defined constants:
  12602. </para>
  12603. <para><code>
  12604. #define SQLITE_INDEX_CONSTRAINT_EQ 2
  12605. #define SQLITE_INDEX_CONSTRAINT_GT 4
  12606. #define SQLITE_INDEX_CONSTRAINT_LE 8
  12607. #define SQLITE_INDEX_CONSTRAINT_LT 16
  12608. #define SQLITE_INDEX_CONSTRAINT_GE 32
  12609. #define SQLITE_INDEX_CONSTRAINT_MATCH 64
  12610. #define SQLITE_INDEX_CONSTRAINT_LIKE 65 /* 3.10.0 and later */
  12611. #define SQLITE_INDEX_CONSTRAINT_GLOB 66 /* 3.10.0 and later */
  12612. #define SQLITE_INDEX_CONSTRAINT_REGEXP 67 /* 3.10.0 and later */
  12613. #define SQLITE_INDEX_CONSTRAINT_NE 68 /* 3.21.0 and later */
  12614. #define SQLITE_INDEX_CONSTRAINT_ISNOT 69 /* 3.21.0 and later */
  12615. #define SQLITE_INDEX_CONSTRAINT_ISNOTNULL 70 /* 3.21.0 and later */
  12616. #define SQLITE_INDEX_CONSTRAINT_ISNULL 71 /* 3.21.0 and later */
  12617. #define SQLITE_INDEX_CONSTRAINT_IS 72 /* 3.21.0 and later */
  12618. #define SQLITE_INDEX_CONSTRAINT_FUNCTION 150 /* 3.25.0 and later */
  12619. #define SQLITE_INDEX_SCAN_UNIQUE 1 /* Scan visits at most 1 row */
  12620. </code></para>
  12621. <para>
  12622. The SQLite core calls the xBestIndex method when it is compiling a query
  12623. that involves a virtual table. In other words, SQLite calls this method
  12624. when it is running sqlite3_prepare() or the equivalent.
  12625. By calling this method, the
  12626. SQLite core is saying to the virtual table that it needs to access
  12627. some subset of the rows in the virtual table and it wants to know the
  12628. most efficient way to do that access. The xBestIndex method replies
  12629. with information that the SQLite core can then use to conduct an
  12630. efficient search of the virtual table.
  12631. </para>
  12632. <para>
  12633. While compiling a single SQL query, the SQLite core might call
  12634. xBestIndex multiple times with different settings in sqlite3_index_info.
  12635. The SQLite core will then select the combination that appears to
  12636. give the best performance.
  12637. </para>
  12638. <para>
  12639. Before calling this method, the SQLite core initializes an instance
  12640. of the sqlite3_index_info structure with information about the
  12641. query that it is currently trying to process. This information
  12642. derives mainly from the WHERE clause and ORDER BY or GROUP BY clauses
  12643. of the query, but also from any ON or USING clauses if the query is a
  12644. join. The information that the SQLite core provides to the xBestIndex
  12645. method is held in the part of the structure that is marked as "Inputs".
  12646. The "Outputs" section is initialized to zero.
  12647. </para>
  12648. <para>
  12649. The information in the sqlite3_index_info structure is ephemeral
  12650. and may be overwritten or deallocated as soon as the xBestIndex method
  12651. returns. If the xBestIndex method needs to remember any part of the
  12652. sqlite3_index_info structure, it should make a copy. Care must be
  12653. take to store the copy in a place where it will be deallocated, such
  12654. as in the idxStr field with needToFreeIdxStr set to 1.
  12655. </para>
  12656. <para>
  12657. Note that xBestIndex will always be called before xFilter, since
  12658. the idxNum and idxStr outputs from xBestIndex are required inputs to
  12659. xFilter. However, there is no guarantee that xFilter will be called
  12660. following a successful xBestIndex.
  12661. </para>
  12662. <para>
  12663. The xBestIndex method is required for every virtual table implementation.
  12664. </para>
  12665. <para>
  12666. The main thing that the SQLite core is trying to communicate to
  12667. the virtual table is the constraints that are available to limit
  12668. the number of rows that need to be searched. The aConstraint[] array
  12669. contains one entry for each constraint. There will be exactly
  12670. nConstraint entries in that array.
  12671. </para>
  12672. <para>
  12673. Each constraint will usually correspond to a term in the WHERE clause
  12674. or in a USING or ON clause that is of the form
  12675. </para>
  12676. <para><code>
  12677. column OP EXPR
  12678. </code></para>
  12679. <para>
  12680. Where "column" is a column in the virtual table, OP is an operator
  12681. like "=" or "&lt;", and EXPR is an arbitrary expression. So, for example,
  12682. if the WHERE clause contained a term like this:
  12683. </para>
  12684. <para><code>
  12685. a = 5
  12686. </code></para>
  12687. <para>
  12688. Then one of the constraints would be on the "a" column with
  12689. operator "=" and an expression of "5". Constraints need not have a
  12690. literal representation of the WHERE clause. The query optimizer might
  12691. make transformations to the
  12692. WHERE clause in order to extract as many constraints
  12693. as it can. So, for example, if the WHERE clause contained something
  12694. like this:
  12695. </para>
  12696. <para><code>
  12697. x BETWEEN 10 AND 100 AND 999&gt;y
  12698. </code></para>
  12699. <para>
  12700. The query optimizer might translate this into three separate constraints:
  12701. </para>
  12702. <para><code>
  12703. x &gt;= 10
  12704. x &lt;= 100
  12705. y &lt; 999
  12706. </code></para>
  12707. <para>
  12708. For each such constraint, the aConstraint[].iColumn field indicates which
  12709. column appears on the left-hand side of the constraint.
  12710. The first column of the virtual table is column 0.
  12711. The rowid of the virtual table is column -1.
  12712. The aConstraint[].op field indicates which operator is used.
  12713. The SQLITE_INDEX_CONSTRAINT_* constants map integer constants
  12714. into operator values.
  12715. Columns occur in the order they were defined by the call to
  12716. sqlite3_declare_vtab() in the xCreate or xConnect method.
  12717. Hidden columns are counted when determining the column index.
  12718. </para>
  12719. <para>
  12720. If the xFindFunction() method for the virtual table is defined, and
  12721. if xFindFunction() sometimes returns SQLITE_INDEX_CONSTRAINT_FUNCTION or
  12722. larger, then the constraints might also be of the form:
  12723. </para>
  12724. <para><code>
  12725. FUNCTION( column, EXPR)
  12726. </code></para>
  12727. <para>
  12728. In this case the aConstraint[].op value is the same as the value
  12729. returned by xFindFunction() for FUNCTION.
  12730. </para>
  12731. <para>
  12732. The aConstraint[] array contains information about all constraints
  12733. that apply to the virtual table. But some of the constraints might
  12734. not be usable because of the way tables are ordered in a join.
  12735. The xBestIndex method must therefore only consider constraints
  12736. that have an aConstraint[].usable flag which is true.
  12737. </para>
  12738. <para>
  12739. In addition to WHERE clause constraints, the SQLite core also
  12740. tells the xBestIndex method about the ORDER BY clause.
  12741. (In an aggregate query, the SQLite core might put in GROUP BY clause
  12742. information in place of the ORDER BY clause information, but this fact
  12743. should not make any difference to the xBestIndex method.)
  12744. If all terms of the ORDER BY clause are columns in the virtual table,
  12745. then nOrderBy will be the number of terms in the ORDER BY clause
  12746. and the aOrderBy[] array will identify the column for each term
  12747. in the order by clause and whether or not that column is ASC or DESC.
  12748. </para>
  12749. <para>
  12750. In SQLite version 3.10.0 (2016-01-06) and later,
  12751. the colUsed field is available
  12752. to indicate which fields of the virtual table are actually used by the
  12753. statement being prepared. If the lowest bit of colUsed is set, that
  12754. means that the first column is used. The second lowest bit corresponds
  12755. to the second column. And so forth. If the most significant bit of
  12756. colUsed is set, that means that one or more columns other than the
  12757. first 63 columns are used. If column usage information is needed by the
  12758. xFilter method, then the required bits must be encoded into either
  12759. the idxNum or idxStr output fields.
  12760. </para>
  12761. <para>
  12762. Given all of the information above, the job of the xBestIndex
  12763. method it to figure out the best way to search the virtual table.
  12764. </para>
  12765. <para>
  12766. The xBestIndex method fills the idxNum and idxStr fields with
  12767. information that communicates an indexing strategy to the xFilter
  12768. method. The information in idxNum and idxStr is arbitrary as far
  12769. as the SQLite core is concerned. The SQLite core just copies the
  12770. information through to the xFilter method. Any desired meaning can
  12771. be assigned to idxNum and idxStr as long as xBestIndex and xFilter
  12772. agree on what that meaning is.
  12773. </para>
  12774. <para>
  12775. The idxStr value may be a string obtained from an SQLite
  12776. memory allocation function such as sqlite3_mprintf().
  12777. If this is the case, then the needToFreeIdxStr flag must be set to
  12778. true so that the SQLite core will know to call sqlite3_free() on
  12779. that string when it has finished with it, and thus avoid a memory leak.
  12780. The idxStr value may also be a static constant string, in which case
  12781. the needToFreeIdxStr boolean should remain false.
  12782. </para>
  12783. <para>
  12784. If the virtual table will output rows in the order specified by
  12785. the ORDER BY clause, then the orderByConsumed flag may be set to
  12786. true. If the output is not automatically in the correct order
  12787. then orderByConsumed must be left in its default false setting.
  12788. This will indicate to the SQLite core that it will need to do a
  12789. separate sorting pass over the data after it comes out of the virtual table.
  12790. </para>
  12791. <para>
  12792. The estimatedCost field should be set to the estimated number
  12793. of disk access operations required to execute this query against
  12794. the virtual table. The SQLite core will often call xBestIndex
  12795. multiple times with different constraints, obtain multiple cost
  12796. estimates, then choose the query plan that gives the lowest estimate.
  12797. The SQLite core initializes estimatedCost to a very large value
  12798. prior to invoking xBestIndex, so if xBestIndex determines that the
  12799. current combination of parameters is undesirable, it can leave the
  12800. estimatedCost field unchanged to discourage its use.
  12801. </para>
  12802. <para>
  12803. If the current version of SQLite is 3.8.2 or greater, the estimatedRows
  12804. field may be set to an estimate of the number of rows returned by the
  12805. proposed query plan. If this value is not explicitly set, the default
  12806. estimate of 25 rows is used.
  12807. </para>
  12808. <para>
  12809. If the current version of SQLite is 3.9.0 or greater, the idxFlags field
  12810. may be set to SQLITE_INDEX_SCAN_UNIQUE to indicate that the virtual table
  12811. will return only zero or one rows given the input constraints. Additional
  12812. bits of the idxFlags field might be understood in later versions of SQLite.
  12813. </para>
  12814. <para>
  12815. The aConstraintUsage[] array contains one element for each of
  12816. the nConstraint constraints in the inputs section of the
  12817. sqlite3_index_info structure.
  12818. The aConstraintUsage[] array is used by xBestIndex to tell the
  12819. core how it is using the constraints.
  12820. </para>
  12821. <para>
  12822. The xBestIndex method may set aConstraintUsage[].argvIndex
  12823. entries to values greater than zero.
  12824. Exactly one entry should be set to 1, another to 2, another to 3,
  12825. and so forth up to as many or as few as the xBestIndex method wants.
  12826. The EXPR of the corresponding constraints will then be passed
  12827. in as the argv[] parameters to xFilter.
  12828. </para>
  12829. <para>
  12830. For example, if the aConstraint[3].argvIndex is set to 1, then
  12831. when xFilter is called, the argv[0] passed to xFilter will have
  12832. the EXPR value of the aConstraint[3] constraint.
  12833. </para>
  12834. <para>
  12835. By default, the SQLite core double checks all constraints on
  12836. each row of the virtual table that it receives. If such a check
  12837. is redundant, the xBestFilter method can suppress that double-check by
  12838. setting aConstraintUsage[].omit.
  12839. </para>
  12840. <para>
  12841. The xBestIndex method should return SQLITE_OK on success. If any
  12842. kind of fatal error occurs, an appropriate error code (ex: SQLITE_NOMEM)
  12843. should be returned instead.
  12844. </para>
  12845. <para>
  12846. If xBestIndex returns SQLITE_CONSTRAINT, that does not indicate an
  12847. error. Rather, SQLITE_CONSTRAINT indicates that the particular combination
  12848. of input parameters specified should not be used in the query plan.
  12849. The SQLITE_CONSTRAINT return is useful for table-valued functions that
  12850. have required parameters. If the aConstraint[].usable field is false
  12851. for one of the required parameter, then the xBestIndex method should
  12852. return SQLITE_CONSTRAINT.
  12853. </para>
  12854. <para>
  12855. The following example will better illustrate the use of SQLITE_CONSTRAINT
  12856. as a return value from xBestIndex:
  12857. </para>
  12858. <para><code>
  12859. SELECT * FROM realtab, tablevaluedfunc(realtab.x);
  12860. </code></para>
  12861. <para>
  12862. Assuming that the first hidden column of "tablevaluedfunc" is "param1",
  12863. the query above is semantically equivalent to this:
  12864. </para>
  12865. <para><code>
  12866. SELECT * FROM realtab, tablevaluedfunc
  12867. WHERE tablevaluedfunc.param1 = realtab.x;
  12868. </code></para>
  12869. <para>
  12870. The query planner must decide between many possible implementations
  12871. of this query, but two plans in particular are of note:
  12872. </para>
  12873. <![CDATA[<ol>]]>
  12874. <![CDATA[<li>]]>Scan all
  12875. rows of realtab and for each row, find rows in tablevaluedfunc where
  12876. param1 is equal to realtab.x
  12877. <![CDATA[</li>]]><![CDATA[<li>]]>Scan all rows of tablevalued func and for each row find rows
  12878. in realtab where x is equal to tablevaluedfunc.param1.
  12879. <![CDATA[</li>]]><![CDATA[</ol>]]>
  12880. <para>
  12881. The xBestIndex method will be invoked once for each of the potential
  12882. plans above. For plan 1, the aConstraint[].usable flag for for the
  12883. SQLITE_CONSTRAINT_EQ constraint on the param1 column will be true because
  12884. the right-hand side value for the "param1 = ?" constraint will be known,
  12885. since it is determined by the outer realtab loop.
  12886. But for plan 2, the aConstraint[].usable flag for "param1 = ?" will be false
  12887. because the right-hand side value is determined by an inner loop and is thus
  12888. an unknown quantity. Because param1 is a required input to the table-valued
  12889. functions, the xBestIndex method should return SQLITE_CONSTRAINT when presented
  12890. with plan 2, indicating that a required input is missing. This forces the
  12891. query planner to select plan 1.
  12892. </para>
  12893. </summary>
  12894. <param name="pVtab">
  12895. The native pointer to the sqlite3_vtab derived structure.
  12896. </param>
  12897. <param name="pIndex">
  12898. The native pointer to the sqlite3_index_info structure.
  12899. </param>
  12900. <returns>
  12901. A standard SQLite return code.
  12902. </returns>
  12903. </member>
  12904. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xDisconnect(System.IntPtr)">
  12905. <summary>
  12906. <para><code>
  12907. int (*xDisconnect)(sqlite3_vtab *pVTab);
  12908. </code></para>
  12909. <para>
  12910. This method releases a connection to a virtual table.
  12911. Only the sqlite3_vtab object is destroyed.
  12912. The virtual table is not destroyed and any backing store
  12913. associated with the virtual table persists.
  12914. </para>
  12915. This method undoes the work of xConnect.
  12916. <para>
  12917. This method is a destructor for a connection to the virtual table.
  12918. Contrast this method with xDestroy. The xDestroy is a destructor
  12919. for the entire virtual table.
  12920. </para>
  12921. <para>
  12922. The xDisconnect method is required for every virtual table implementation,
  12923. though it is acceptable for the xDisconnect and xDestroy methods to be
  12924. the same function if that makes sense for the particular virtual table.
  12925. </para>
  12926. </summary>
  12927. <param name="pVtab">
  12928. The native pointer to the sqlite3_vtab derived structure.
  12929. </param>
  12930. <returns>
  12931. A standard SQLite return code.
  12932. </returns>
  12933. </member>
  12934. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xDestroy(System.IntPtr)">
  12935. <summary>
  12936. <para><code>
  12937. int (*xDestroy)(sqlite3_vtab *pVTab);
  12938. </code></para>
  12939. <para>
  12940. This method releases a connection to a virtual table, just like
  12941. the xDisconnect method, and it also destroys the underlying
  12942. table implementation. This method undoes the work of xCreate.
  12943. </para>
  12944. <para>
  12945. The xDisconnect method is called whenever a database connection
  12946. that uses a virtual table is closed. The xDestroy method is only
  12947. called when a DROP TABLE statement is executed against the virtual table.
  12948. </para>
  12949. <para>
  12950. The xDestroy method is required for every virtual table implementation,
  12951. though it is acceptable for the xDisconnect and xDestroy methods to be
  12952. the same function if that makes sense for the particular virtual table.
  12953. </para>
  12954. </summary>
  12955. <param name="pVtab">
  12956. The native pointer to the sqlite3_vtab derived structure.
  12957. </param>
  12958. <returns>
  12959. A standard SQLite return code.
  12960. </returns>
  12961. </member>
  12962. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xOpen(System.IntPtr,System.IntPtr@)">
  12963. <summary>
  12964. <para><code>
  12965. int (*xOpen)(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor);
  12966. </code></para>
  12967. <para>
  12968. The xOpen method creates a new cursor used for accessing (read and/or
  12969. writing) a virtual table. A successful invocation of this method
  12970. will allocate the memory for the sqlite3_vtab_cursor (or a subclass),
  12971. initialize the new object, and make *ppCursor point to the new object.
  12972. The successful call then returns SQLITE_OK.
  12973. </para>
  12974. <para>
  12975. For every successful call to this method, the SQLite core will
  12976. later invoke the xClose method to destroy
  12977. the allocated cursor.
  12978. </para>
  12979. <para>
  12980. The xOpen method need not initialize the pVtab field of the
  12981. sqlite3_vtab_cursor structure. The SQLite core will take care
  12982. of that chore automatically.
  12983. </para>
  12984. <para>
  12985. A virtual table implementation must be able to support an arbitrary
  12986. number of simultaneously open cursors.
  12987. </para>
  12988. <para>
  12989. When initially opened, the cursor is in an undefined state.
  12990. The SQLite core will invoke the xFilter method
  12991. on the cursor prior to any attempt to position or read from the cursor.
  12992. </para>
  12993. <para>
  12994. The xOpen method is required for every virtual table implementation.
  12995. </para>
  12996. </summary>
  12997. <param name="pVtab">
  12998. The native pointer to the sqlite3_vtab derived structure.
  12999. </param>
  13000. <param name="pCursor">
  13001. Upon success, this parameter must be modified to point to the newly
  13002. created native sqlite3_vtab_cursor derived structure.
  13003. </param>
  13004. <returns>
  13005. A standard SQLite return code.
  13006. </returns>
  13007. </member>
  13008. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xClose(System.IntPtr)">
  13009. <summary>
  13010. <para><code>
  13011. int (*xClose)(sqlite3_vtab_cursor*);
  13012. </code></para>
  13013. <para>
  13014. The xClose method closes a cursor previously opened by
  13015. xOpen.
  13016. The SQLite core will always call xClose once for each cursor opened
  13017. using xOpen.
  13018. </para>
  13019. <para>
  13020. This method must release all resources allocated by the
  13021. corresponding xOpen call. The routine will not be called again even if it
  13022. returns an error. The SQLite core will not use the
  13023. sqlite3_vtab_cursor again after it has been closed.
  13024. </para>
  13025. <para>
  13026. The xClose method is required for every virtual table implementation.
  13027. </para>
  13028. </summary>
  13029. <param name="pCursor">
  13030. The native pointer to the sqlite3_vtab_cursor derived structure.
  13031. </param>
  13032. <returns>
  13033. A standard SQLite return code.
  13034. </returns>
  13035. </member>
  13036. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xFilter(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)">
  13037. <summary>
  13038. <para><code>
  13039. int (*xFilter)(sqlite3_vtab_cursor*, int idxNum, const char *idxStr,
  13040. int argc, sqlite3_value **argv);
  13041. </code></para>
  13042. <para>
  13043. This method begins a search of a virtual table.
  13044. The first argument is a cursor opened by xOpen.
  13045. The next two arguments define a particular search index previously
  13046. chosen by xBestIndex. The specific meanings of idxNum and idxStr
  13047. are unimportant as long as xFilter and xBestIndex agree on what
  13048. that meaning is.
  13049. </para>
  13050. <para>
  13051. The xBestIndex function may have requested the values of
  13052. certain expressions using the aConstraintUsage[].argvIndex values
  13053. of the sqlite3_index_info structure.
  13054. Those values are passed to xFilter using the argc and argv parameters.
  13055. </para>
  13056. <para>
  13057. If the virtual table contains one or more rows that match the
  13058. search criteria, then the cursor must be left point at the first row.
  13059. Subsequent calls to xEof must return false (zero).
  13060. If there are no rows match, then the cursor must be left in a state
  13061. that will cause the xEof to return true (non-zero).
  13062. The SQLite engine will use
  13063. the xColumn and xRowid methods to access that row content.
  13064. The xNext method will be used to advance to the next row.
  13065. </para>
  13066. <para>
  13067. This method must return SQLITE_OK if successful, or an sqlite
  13068. error code if an error occurs.
  13069. </para>
  13070. <para>
  13071. The xFilter method is required for every virtual table implementation.
  13072. </para>
  13073. </summary>
  13074. <param name="pCursor">
  13075. The native pointer to the sqlite3_vtab_cursor derived structure.
  13076. </param>
  13077. <param name="idxNum">
  13078. Number used to help identify the selected index.
  13079. </param>
  13080. <param name="idxStr">
  13081. The native pointer to the UTF-8 encoded string containing the
  13082. string used to help identify the selected index.
  13083. </param>
  13084. <param name="argc">
  13085. The number of native pointers to sqlite3_value structures specified
  13086. in <paramref name="argv" />.
  13087. </param>
  13088. <param name="argv">
  13089. An array of native pointers to sqlite3_value structures containing
  13090. filtering criteria for the selected index.
  13091. </param>
  13092. <returns>
  13093. A standard SQLite return code.
  13094. </returns>
  13095. </member>
  13096. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xNext(System.IntPtr)">
  13097. <summary>
  13098. <para><code>
  13099. int (*xNext)(sqlite3_vtab_cursor*);
  13100. </code></para>
  13101. <para>
  13102. The xNext method advances a virtual table cursor
  13103. to the next row of a result set initiated by xFilter.
  13104. If the cursor is already pointing at the last row when this
  13105. routine is called, then the cursor no longer points to valid
  13106. data and a subsequent call to the xEof method must return true (non-zero).
  13107. If the cursor is successfully advanced to another row of content, then
  13108. subsequent calls to xEof must return false (zero).
  13109. </para>
  13110. <para>
  13111. This method must return SQLITE_OK if successful, or an sqlite
  13112. error code if an error occurs.
  13113. </para>
  13114. <para>
  13115. The xNext method is required for every virtual table implementation.
  13116. </para>
  13117. </summary>
  13118. <param name="pCursor">
  13119. The native pointer to the sqlite3_vtab_cursor derived structure.
  13120. </param>
  13121. <returns>
  13122. A standard SQLite return code.
  13123. </returns>
  13124. </member>
  13125. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xEof(System.IntPtr)">
  13126. <summary>
  13127. <para><code>
  13128. int (*xEof)(sqlite3_vtab_cursor*);
  13129. </code></para>
  13130. <para>
  13131. The xEof method must return false (zero) if the specified cursor
  13132. currently points to a valid row of data, or true (non-zero) otherwise.
  13133. This method is called by the SQL engine immediately after each
  13134. xFilter and xNext invocation.
  13135. </para>
  13136. <para>
  13137. The xEof method is required for every virtual table implementation.
  13138. </para>
  13139. </summary>
  13140. <param name="pCursor">
  13141. The native pointer to the sqlite3_vtab_cursor derived structure.
  13142. </param>
  13143. <returns>
  13144. Non-zero if no more rows are available; zero otherwise.
  13145. </returns>
  13146. </member>
  13147. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xColumn(System.IntPtr,System.IntPtr,System.Int32)">
  13148. <summary>
  13149. <para><code>
  13150. int (*xColumn)(sqlite3_vtab_cursor*, sqlite3_context*, int N);
  13151. </code></para>
  13152. <para>
  13153. The SQLite core invokes this method in order to find the value for
  13154. the N-th column of the current row. N is zero-based so the first column
  13155. is numbered 0.
  13156. The xColumn method may return its result back to SQLite using one of the
  13157. following interface:
  13158. </para>
  13159. <para>
  13160. <![CDATA[<ul>]]>
  13161. <![CDATA[<li>]]> sqlite3_result_blob()
  13162. <![CDATA[</li>]]><![CDATA[<li>]]> sqlite3_result_double()
  13163. <![CDATA[</li>]]><![CDATA[<li>]]> sqlite3_result_int()
  13164. <![CDATA[</li>]]><![CDATA[<li>]]> sqlite3_result_int64()
  13165. <![CDATA[</li>]]><![CDATA[<li>]]> sqlite3_result_null()
  13166. <![CDATA[</li>]]><![CDATA[<li>]]> sqlite3_result_text()
  13167. <![CDATA[</li>]]><![CDATA[<li>]]> sqlite3_result_text16()
  13168. <![CDATA[</li>]]><![CDATA[<li>]]> sqlite3_result_text16le()
  13169. <![CDATA[</li>]]><![CDATA[<li>]]> sqlite3_result_text16be()
  13170. <![CDATA[</li>]]><![CDATA[<li>]]> sqlite3_result_zeroblob()
  13171. <![CDATA[</li>]]><![CDATA[</ul>]]>
  13172. </para>
  13173. <para>
  13174. If the xColumn method implementation calls none of the functions above,
  13175. then the value of the column defaults to an SQL NULL.
  13176. </para>
  13177. <para>
  13178. To raise an error, the xColumn method should use one of the result_text()
  13179. methods to set the error message text, then return an appropriate
  13180. error code. The xColumn method must return SQLITE_OK on success.
  13181. </para>
  13182. <para>
  13183. The xColumn method is required for every virtual table implementation.
  13184. </para>
  13185. </summary>
  13186. <param name="pCursor">
  13187. The native pointer to the sqlite3_vtab_cursor derived structure.
  13188. </param>
  13189. <param name="pContext">
  13190. The native pointer to the sqlite3_context structure to be used
  13191. for returning the specified column value to the SQLite core
  13192. library.
  13193. </param>
  13194. <param name="index">
  13195. The zero-based index corresponding to the column containing the
  13196. value to be returned.
  13197. </param>
  13198. <returns>
  13199. A standard SQLite return code.
  13200. </returns>
  13201. </member>
  13202. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xRowId(System.IntPtr,System.Int64@)">
  13203. <summary>
  13204. <para><code>
  13205. int (*xRowid)(sqlite3_vtab_cursor *pCur, sqlite_int64 *pRowid);
  13206. </code></para>
  13207. <para>
  13208. A successful invocation of this method will cause *pRowid to be
  13209. filled with the rowid of row that the
  13210. virtual table cursor pCur is currently pointing at.
  13211. This method returns SQLITE_OK on success.
  13212. It returns an appropriate error code on failure.
  13213. </para>
  13214. <para>
  13215. The xRowid method is required for every virtual table implementation.
  13216. </para>
  13217. </summary>
  13218. <param name="pCursor">
  13219. The native pointer to the sqlite3_vtab_cursor derived structure.
  13220. </param>
  13221. <param name="rowId">
  13222. Upon success, this parameter must be modified to contain the unique
  13223. integer row identifier for the current row for the specified cursor.
  13224. </param>
  13225. <returns>
  13226. A standard SQLite return code.
  13227. </returns>
  13228. </member>
  13229. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xUpdate(System.IntPtr,System.Int32,System.IntPtr,System.Int64@)">
  13230. <summary>
  13231. <para><code>
  13232. int (*xUpdate)(
  13233. sqlite3_vtab *pVTab,
  13234. int argc,
  13235. sqlite3_value **argv,
  13236. sqlite_int64 *pRowid
  13237. );
  13238. </code></para>
  13239. <para>
  13240. All changes to a virtual table are made using the xUpdate method.
  13241. This one method can be used to insert, delete, or update.
  13242. </para>
  13243. <para>
  13244. The argc parameter specifies the number of entries in the argv array.
  13245. The value of argc will be 1 for a pure delete operation or N+2 for an insert
  13246. or replace or update where N is the number of columns in the table.
  13247. In the previous sentence, N includes any hidden columns.
  13248. </para>
  13249. <para>
  13250. Every argv entry will have a non-NULL value in C but may contain the
  13251. SQL value NULL. In other words, it is always true that
  13252. <![CDATA[<tt>]]>argv[i]!=0<![CDATA[</tt>]]> for <![CDATA[<b>]]>i<![CDATA[</b>]]> between 0 and <![CDATA[<tt>]]>argc-1<![CDATA[</tt>]]>.
  13253. However, it might be the case that
  13254. <![CDATA[<tt>]]>sqlite3_value_type(argv[i])==SQLITE_NULL<![CDATA[</tt>]]>.
  13255. </para>
  13256. <para>
  13257. The argv[0] parameter is the rowid of a row in the virtual table
  13258. to be deleted. If argv[0] is an SQL NULL, then no deletion occurs.
  13259. </para>
  13260. <para>
  13261. The argv[1] parameter is the rowid of a new row to be inserted
  13262. into the virtual table. If argv[1] is an SQL NULL, then the implementation
  13263. must choose a rowid for the newly inserted row. Subsequent argv[]
  13264. entries contain values of the columns of the virtual table, in the
  13265. order that the columns were declared. The number of columns will
  13266. match the table declaration that the xConnect or xCreate method made
  13267. using the sqlite3_declare_vtab() call. All hidden columns are included.
  13268. </para>
  13269. <para>
  13270. When doing an insert without a rowid (argc>1, argv[1] is an SQL NULL),
  13271. on a virtual table that uses ROWID (but not on a WITHOUT ROWID virtual table),
  13272. the implementation must set *pRowid to the rowid of the newly inserted row;
  13273. this will become the value returned by the sqlite3_last_insert_rowid()
  13274. function. Setting this value in all the other cases is a harmless no-op;
  13275. the SQLite engine ignores the *pRowid return value if argc==1 or
  13276. argv[1] is not an SQL NULL.
  13277. </para>
  13278. <para>
  13279. Each call to xUpdate will fall into one of cases shown below.
  13280. Not that references to <![CDATA[<b>]]>argv[i]<![CDATA[</b>]]> mean the SQL value
  13281. held within the argv[i] object, not the argv[i]
  13282. object itself.
  13283. </para>
  13284. <para><code>
  13285. <![CDATA[<dl>]]>
  13286. <![CDATA[<dt>]]><![CDATA[<b>]]>argc = 1 <![CDATA[<br>]]> argv[0] &#8800; NULL<![CDATA[</b>]]>
  13287. <![CDATA[</dt>]]><![CDATA[<dd>]]>
  13288. DELETE: The single row with rowid or PRIMARY KEY equal to argv[0] is deleted.
  13289. No insert occurs.
  13290. <![CDATA[</dd>]]><![CDATA[<dt>]]><![CDATA[<b>]]>argc &gt; 1 <![CDATA[<br>]]> argv[0] = NULL<![CDATA[</b>]]>
  13291. <![CDATA[</dt>]]><![CDATA[<dd>]]>
  13292. INSERT: A new row is inserted with column values taken from
  13293. argv[2] and following. In a rowid virtual table, if argv[1] is an SQL NULL,
  13294. then a new unique rowid is generated automatically. The argv[1] will be NULL
  13295. for a WITHOUT ROWID virtual table, in which case the implementation should
  13296. take the PRIMARY KEY value from the appropriate column in argv[2] and following.
  13297. <![CDATA[</dd>]]><![CDATA[<dt>]]><![CDATA[<b>]]>argc &gt; 1 <![CDATA[<br>]]> argv[0] &#8800; NULL <![CDATA[<br>]]> argv[0] = argv[1]<![CDATA[</b>]]>
  13298. <![CDATA[</dt>]]><![CDATA[<dd>]]>
  13299. UPDATE:
  13300. The row with rowid or PRIMARY KEY argv[0] is updated with new values
  13301. in argv[2] and following parameters.
  13302. <![CDATA[</dd>]]><![CDATA[<dt>]]><![CDATA[<b>]]>argc &gt; 1 <![CDATA[<br>]]> argv[0] &#8800; NULL <![CDATA[<br>]]> argv[0] &#8800; argv[1]<![CDATA[</b>]]>
  13303. <![CDATA[</dt>]]><![CDATA[<dd>]]>
  13304. UPDATE with rowid or PRIMARY KEY change:
  13305. The row with rowid or PRIMARY KEY argv[0] is updated with
  13306. the rowid or PRIMARY KEY in argv[1]
  13307. and new values in argv[2] and following parameters. This will occur
  13308. when an SQL statement updates a rowid, as in the statement:
  13309. <para><code>
  13310. UPDATE table SET rowid=rowid+1 WHERE ...;
  13311. </code></para>
  13312. <![CDATA[</dd>]]><![CDATA[</dl>]]>
  13313. </code></para>
  13314. <para>
  13315. The xUpdate method must return SQLITE_OK if and only if it is
  13316. successful. If a failure occurs, the xUpdate must return an appropriate
  13317. error code. On a failure, the pVTab->zErrMsg element may optionally
  13318. be replaced with error message text stored in memory allocated from SQLite
  13319. using functions such as sqlite3_mprintf() or sqlite3_malloc().
  13320. </para>
  13321. <para>
  13322. If the xUpdate method violates some constraint of the virtual table
  13323. (including, but not limited to, attempting to store a value of the wrong
  13324. datatype, attempting to store a value that is too
  13325. large or too small, or attempting to change a read-only value) then the
  13326. xUpdate must fail with an appropriate error code.
  13327. </para>
  13328. <para>
  13329. If the xUpdate method is performing an UPDATE, then
  13330. sqlite3_value_nochange(X) can be used to discover which columns
  13331. of the virtual table were actually modified by the UPDATE
  13332. statement. The sqlite3_value_nochange(X) interface returns
  13333. true for columns that do not change.
  13334. On every UPDATE, SQLite will first invoke
  13335. xColumn separately for each unchanging column in the table to
  13336. obtain the value for that column. The xColumn method can
  13337. check to see if the column is unchanged at the SQL level
  13338. by invoking sqlite3_vtab_nochange(). If xColumn sees that
  13339. the column is not being modified, it should return without setting
  13340. a result using one of the sqlite3_result_xxxxx()
  13341. interfaces. Only in that case sqlite3_value_nochange() will be
  13342. true within the xUpdate method. If xColumn does
  13343. invoke one or more sqlite3_result_xxxxx()
  13344. interfaces, then SQLite understands that as a change in the value
  13345. of the column and the sqlite3_value_nochange() call for that
  13346. column within xUpdate will return false.
  13347. </para>
  13348. <para>
  13349. There might be one or more sqlite3_vtab_cursor objects open and in use
  13350. on the virtual table instance and perhaps even on the row of the virtual
  13351. table when the xUpdate method is invoked. The implementation of
  13352. xUpdate must be prepared for attempts to delete or modify rows of the table
  13353. out from other existing cursors. If the virtual table cannot accommodate
  13354. such changes, the xUpdate method must return an error code.
  13355. </para>
  13356. <para>
  13357. The xUpdate method is optional.
  13358. If the xUpdate pointer in the sqlite3_module for a virtual table
  13359. is a NULL pointer, then the virtual table is read-only.
  13360. </para>
  13361. </summary>
  13362. <param name="pVtab">
  13363. The native pointer to the sqlite3_vtab derived structure.
  13364. </param>
  13365. <param name="argc">
  13366. The number of new or modified column values contained in
  13367. <paramref name="argv" />.
  13368. </param>
  13369. <param name="argv">
  13370. The array of native pointers to sqlite3_value structures containing
  13371. the new or modified column values, if any.
  13372. </param>
  13373. <param name="rowId">
  13374. Upon success, this parameter must be modified to contain the unique
  13375. integer row identifier for the row that was inserted, if any.
  13376. </param>
  13377. <returns>
  13378. A standard SQLite return code.
  13379. </returns>
  13380. </member>
  13381. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xBegin(System.IntPtr)">
  13382. <summary>
  13383. <para><code>
  13384. int (*xBegin)(sqlite3_vtab *pVTab);
  13385. </code></para>
  13386. <para>
  13387. This method begins a transaction on a virtual table.
  13388. This is method is optional. The xBegin pointer of sqlite3_module
  13389. may be NULL.
  13390. </para>
  13391. <para>
  13392. This method is always followed by one call to either the
  13393. xCommit or xRollback method. Virtual table transactions do
  13394. not nest, so the xBegin method will not be invoked more than once
  13395. on a single virtual table
  13396. without an intervening call to either xCommit or xRollback.
  13397. Multiple calls to other methods can and likely will occur in between
  13398. the xBegin and the corresponding xCommit or xRollback.
  13399. </para>
  13400. </summary>
  13401. <param name="pVtab">
  13402. The native pointer to the sqlite3_vtab derived structure.
  13403. </param>
  13404. <returns>
  13405. A standard SQLite return code.
  13406. </returns>
  13407. </member>
  13408. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xSync(System.IntPtr)">
  13409. <summary>
  13410. <para><code>
  13411. int (*xSync)(sqlite3_vtab *pVTab);
  13412. </code></para>
  13413. <para>
  13414. This method signals the start of a two-phase commit on a virtual
  13415. table.
  13416. This is method is optional. The xSync pointer of sqlite3_module
  13417. may be NULL.
  13418. </para>
  13419. <para>
  13420. This method is only invoked after call to the xBegin method and
  13421. prior to an xCommit or xRollback. In order to implement two-phase
  13422. commit, the xSync method on all virtual tables is invoked prior to
  13423. invoking the xCommit method on any virtual table. If any of the
  13424. xSync methods fail, the entire transaction is rolled back.
  13425. </para>
  13426. </summary>
  13427. <param name="pVtab">
  13428. The native pointer to the sqlite3_vtab derived structure.
  13429. </param>
  13430. <returns>
  13431. A standard SQLite return code.
  13432. </returns>
  13433. </member>
  13434. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xCommit(System.IntPtr)">
  13435. <summary>
  13436. <para><code>
  13437. int (*xCommit)(sqlite3_vtab *pVTab);
  13438. </code></para>
  13439. <para>
  13440. This method causes a virtual table transaction to commit.
  13441. This is method is optional. The xCommit pointer of sqlite3_module
  13442. may be NULL.
  13443. </para>
  13444. <para>
  13445. A call to this method always follows a prior call to xBegin and
  13446. xSync.
  13447. </para>
  13448. </summary>
  13449. <param name="pVtab">
  13450. The native pointer to the sqlite3_vtab derived structure.
  13451. </param>
  13452. <returns>
  13453. A standard SQLite return code.
  13454. </returns>
  13455. </member>
  13456. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xRollback(System.IntPtr)">
  13457. <summary>
  13458. <para><code>
  13459. int (*xRollback)(sqlite3_vtab *pVTab);
  13460. </code></para>
  13461. <para>
  13462. This method causes a virtual table transaction to rollback.
  13463. This is method is optional. The xRollback pointer of sqlite3_module
  13464. may be NULL.
  13465. </para>
  13466. <para>
  13467. A call to this method always follows a prior call to xBegin.
  13468. </para>
  13469. </summary>
  13470. <param name="pVtab">
  13471. The native pointer to the sqlite3_vtab derived structure.
  13472. </param>
  13473. <returns>
  13474. A standard SQLite return code.
  13475. </returns>
  13476. </member>
  13477. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,System.IntPtr@)">
  13478. <summary>
  13479. <para><code>
  13480. int (*xFindFunction)(
  13481. sqlite3_vtab *pVtab,
  13482. int nArg,
  13483. const char *zName,
  13484. void (**pxFunc)(sqlite3_context*,int,sqlite3_value**),
  13485. void **ppArg
  13486. );
  13487. </code></para>
  13488. <para>
  13489. This method is called during sqlite3_prepare() to give the virtual
  13490. table implementation an opportunity to overload functions.
  13491. This method may be set to NULL in which case no overloading occurs.
  13492. </para>
  13493. <para>
  13494. When a function uses a column from a virtual table as its first
  13495. argument, this method is called to see if the virtual table would
  13496. like to overload the function. The first three parameters are inputs:
  13497. the virtual table, the number of arguments to the function, and the
  13498. name of the function. If no overloading is desired, this method
  13499. returns 0. To overload the function, this method writes the new
  13500. function implementation into *pxFunc and writes user data into *ppArg
  13501. and returns either 1 or a number between
  13502. SQLITE_INDEX_CONSTRAINT_FUNCTION and 255.
  13503. </para>
  13504. <para>
  13505. Historically, the return value from xFindFunction() was either zero
  13506. or one. Zero means that the function is not overloaded and one means that
  13507. it is overload. The ability to return values of
  13508. SQLITE_INDEX_CONSTRAINT_FUNCTION or greater was added in
  13509. version 3.25.0 (2018-09-15). If xFindFunction returns
  13510. SQLITE_INDEX_CONSTRAINT_FUNCTION or greater, than means that the function
  13511. takes two arguments and the function
  13512. can be used as a boolean in the WHERE clause of a query and that
  13513. the virtual table is able to exploit that function to speed up the query
  13514. result. When xFindFunction returns SQLITE_INDEX_CONSTRAINT_FUNCTION or
  13515. larger, the value returned becomes the sqlite3_index_info.aConstraint.op
  13516. value for one of the constraints passed into xBestIndex() and the second
  13517. argument becomes the value corresponding to that constraint that is passed
  13518. to xFilter(). This enables the
  13519. xBestIndex()/xFilter implementations to use the function to speed
  13520. its search.
  13521. </para>
  13522. <para>
  13523. The technique of having xFindFunction() return values of
  13524. SQLITE_INDEX_CONSTRAINT_FUNCTION was initially used in the implementation
  13525. of the Geopoly module. The xFindFunction() method of that module returns
  13526. SQLITE_INDEX_CONSTRAINT_FUNCTION for the geopoly_overlap() SQL function
  13527. and it returns
  13528. SQLITE_INDEX_CONSTRAINT_FUNCTION+1 for the geopoly_within() SQL function.
  13529. This permits search optimizations for queries such as:
  13530. </para>
  13531. <para><code>
  13532. SELECT * FROM geopolytab WHERE geopoly_overlap(_shape, $query_polygon);
  13533. </code></para>
  13534. <para>
  13535. Note that infix functions (LIKE, GLOB, REGEXP, and MATCH) reverse
  13536. the order of their arguments. So "like(A,B)" is equivalent to "B like A".
  13537. For the form "B like A" the B term is considered the first argument
  13538. to the function. But for "like(A,B)" the A term is considered the
  13539. first argument.
  13540. </para>
  13541. <para>
  13542. The function pointer returned by this routine must be valid for
  13543. the lifetime of the sqlite3_vtab object given in the first parameter.
  13544. </para>
  13545. </summary>
  13546. <param name="pVtab">
  13547. The native pointer to the sqlite3_vtab derived structure.
  13548. </param>
  13549. <param name="nArg">
  13550. The number of arguments to the function being sought.
  13551. </param>
  13552. <param name="zName">
  13553. The name of the function being sought.
  13554. </param>
  13555. <param name="callback">
  13556. Upon success, this parameter must be modified to contain the
  13557. delegate responsible for implementing the specified function.
  13558. </param>
  13559. <param name="pClientData">
  13560. Upon success, this parameter must be modified to contain the
  13561. native user-data pointer associated with
  13562. <paramref name="callback" />.
  13563. </param>
  13564. <returns>
  13565. Non-zero if the specified function was found; zero otherwise.
  13566. </returns>
  13567. </member>
  13568. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xRename(System.IntPtr,System.IntPtr)">
  13569. <summary>
  13570. <para><code>
  13571. int (*xRename)(sqlite3_vtab *pVtab, const char *zNew);
  13572. </code></para>
  13573. <para>
  13574. This method provides notification that the virtual table implementation
  13575. that the virtual table will be given a new name.
  13576. If this method returns SQLITE_OK then SQLite renames the table.
  13577. If this method returns an error code then the renaming is prevented.
  13578. </para>
  13579. <para>
  13580. The xRename method is optional. If omitted, then the virtual
  13581. table may not be renamed using the ALTER TABLE RENAME command.
  13582. </para>
  13583. <para>
  13584. The PRAGMA legacy_alter_table setting is enabled prior to invoking this
  13585. method, and the value for legacy_alter_table is restored after this
  13586. method finishes. This is necessary for the correct operation of virtual
  13587. tables that make use of shadow tables where the shadow tables must be
  13588. renamed to match the new virtual table name. If the legacy_alter_format is
  13589. off, then the xConnect method will be invoked for the virtual table every
  13590. time the xRename method tries to change the name of the shadow table.
  13591. </para>
  13592. </summary>
  13593. <param name="pVtab">
  13594. The native pointer to the sqlite3_vtab derived structure.
  13595. </param>
  13596. <param name="zNew">
  13597. The native pointer to the UTF-8 encoded string containing the new
  13598. name for the virtual table.
  13599. </param>
  13600. <returns>
  13601. A standard SQLite return code.
  13602. </returns>
  13603. </member>
  13604. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xSavepoint(System.IntPtr,System.Int32)">
  13605. <summary>
  13606. <para><code>
  13607. int (*xSavepoint)(sqlite3_vtab *pVtab, int);
  13608. int (*xRelease)(sqlite3_vtab *pVtab, int);
  13609. int (*xRollbackTo)(sqlite3_vtab *pVtab, int);
  13610. </code></para>
  13611. <para>
  13612. These methods provide the virtual table implementation an opportunity to
  13613. implement nested transactions. They are always optional and will only be
  13614. called in SQLite version 3.7.7 (2011-06-23) and later.
  13615. </para>
  13616. <para>
  13617. When xSavepoint(X,N) is invoked, that is a signal to the virtual table X
  13618. that it should save its current state as savepoint N.
  13619. A subsequent call
  13620. to xRollbackTo(X,R) means that the state of the virtual table should return
  13621. to what it was when xSavepoint(X,R) was last called.
  13622. The call
  13623. to xRollbackTo(X,R) will invalidate all savepoints with N>R; none of the
  13624. invalided savepoints will be rolled back or released without first
  13625. being reinitialized by a call to xSavepoint().
  13626. A call to xRelease(X,M) invalidates all savepoints where N>=M.
  13627. </para>
  13628. <para>
  13629. None of the xSavepoint(), xRelease(), or xRollbackTo() methods will ever
  13630. be called except in between calls to xBegin() and
  13631. either xCommit() or xRollback().
  13632. </para>
  13633. </summary>
  13634. <param name="pVtab">
  13635. The native pointer to the sqlite3_vtab derived structure.
  13636. </param>
  13637. <param name="iSavepoint">
  13638. This is an integer identifier under which the the current state of
  13639. the virtual table should be saved.
  13640. </param>
  13641. <returns>
  13642. A standard SQLite return code.
  13643. </returns>
  13644. </member>
  13645. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xRelease(System.IntPtr,System.Int32)">
  13646. <summary>
  13647. <para><code>
  13648. int (*xSavepoint)(sqlite3_vtab *pVtab, int);
  13649. int (*xRelease)(sqlite3_vtab *pVtab, int);
  13650. int (*xRollbackTo)(sqlite3_vtab *pVtab, int);
  13651. </code></para>
  13652. <para>
  13653. These methods provide the virtual table implementation an opportunity to
  13654. implement nested transactions. They are always optional and will only be
  13655. called in SQLite version 3.7.7 (2011-06-23) and later.
  13656. </para>
  13657. <para>
  13658. When xSavepoint(X,N) is invoked, that is a signal to the virtual table X
  13659. that it should save its current state as savepoint N.
  13660. A subsequent call
  13661. to xRollbackTo(X,R) means that the state of the virtual table should return
  13662. to what it was when xSavepoint(X,R) was last called.
  13663. The call
  13664. to xRollbackTo(X,R) will invalidate all savepoints with N>R; none of the
  13665. invalided savepoints will be rolled back or released without first
  13666. being reinitialized by a call to xSavepoint().
  13667. A call to xRelease(X,M) invalidates all savepoints where N>=M.
  13668. </para>
  13669. <para>
  13670. None of the xSavepoint(), xRelease(), or xRollbackTo() methods will ever
  13671. be called except in between calls to xBegin() and
  13672. either xCommit() or xRollback().
  13673. </para>
  13674. </summary>
  13675. <param name="pVtab">
  13676. The native pointer to the sqlite3_vtab derived structure.
  13677. </param>
  13678. <param name="iSavepoint">
  13679. This is an integer used to indicate that any saved states with an
  13680. identifier greater than or equal to this should be deleted by the
  13681. virtual table.
  13682. </param>
  13683. <returns>
  13684. A standard SQLite return code.
  13685. </returns>
  13686. </member>
  13687. <member name="M:System.Data.SQLite.ISQLiteNativeModule.xRollbackTo(System.IntPtr,System.Int32)">
  13688. <summary>
  13689. <para><code>
  13690. int (*xSavepoint)(sqlite3_vtab *pVtab, int);
  13691. int (*xRelease)(sqlite3_vtab *pVtab, int);
  13692. int (*xRollbackTo)(sqlite3_vtab *pVtab, int);
  13693. </code></para>
  13694. <para>
  13695. These methods provide the virtual table implementation an opportunity to
  13696. implement nested transactions. They are always optional and will only be
  13697. called in SQLite version 3.7.7 (2011-06-23) and later.
  13698. </para>
  13699. <para>
  13700. When xSavepoint(X,N) is invoked, that is a signal to the virtual table X
  13701. that it should save its current state as savepoint N.
  13702. A subsequent call
  13703. to xRollbackTo(X,R) means that the state of the virtual table should return
  13704. to what it was when xSavepoint(X,R) was last called.
  13705. The call
  13706. to xRollbackTo(X,R) will invalidate all savepoints with N>R; none of the
  13707. invalided savepoints will be rolled back or released without first
  13708. being reinitialized by a call to xSavepoint().
  13709. A call to xRelease(X,M) invalidates all savepoints where N>=M.
  13710. </para>
  13711. <para>
  13712. None of the xSavepoint(), xRelease(), or xRollbackTo() methods will ever
  13713. be called except in between calls to xBegin() and
  13714. either xCommit() or xRollback().
  13715. </para>
  13716. </summary>
  13717. <param name="pVtab">
  13718. The native pointer to the sqlite3_vtab derived structure.
  13719. </param>
  13720. <param name="iSavepoint">
  13721. This is an integer identifier used to specify a specific saved
  13722. state for the virtual table for it to restore itself back to, which
  13723. should also have the effect of deleting all saved states with an
  13724. integer identifier greater than this one.
  13725. </param>
  13726. <returns>
  13727. A standard SQLite return code.
  13728. </returns>
  13729. </member>
  13730. <member name="T:System.Data.SQLite.SQLiteContext">
  13731. <summary>
  13732. This class represents a context from the SQLite core library that can
  13733. be passed to the sqlite3_result_*() and associated functions.
  13734. </summary>
  13735. </member>
  13736. <member name="F:System.Data.SQLite.SQLiteContext.pContext">
  13737. <summary>
  13738. The native context handle.
  13739. </summary>
  13740. </member>
  13741. <member name="M:System.Data.SQLite.SQLiteContext.#ctor(System.IntPtr)">
  13742. <summary>
  13743. Constructs an instance of this class using the specified native
  13744. context handle.
  13745. </summary>
  13746. <param name="pContext">
  13747. The native context handle to use.
  13748. </param>
  13749. </member>
  13750. <member name="P:System.Data.SQLite.SQLiteContext.NativeHandle">
  13751. <summary>
  13752. Returns the underlying SQLite native handle associated with this
  13753. object instance.
  13754. </summary>
  13755. </member>
  13756. <member name="M:System.Data.SQLite.SQLiteContext.SetNull">
  13757. <summary>
  13758. Sets the context result to NULL.
  13759. </summary>
  13760. </member>
  13761. <member name="M:System.Data.SQLite.SQLiteContext.SetDouble(System.Double)">
  13762. <summary>
  13763. Sets the context result to the specified <see cref="T:System.Double" />
  13764. value.
  13765. </summary>
  13766. <param name="value">
  13767. The <see cref="T:System.Double" /> value to use.
  13768. </param>
  13769. </member>
  13770. <member name="M:System.Data.SQLite.SQLiteContext.SetInt(System.Int32)">
  13771. <summary>
  13772. Sets the context result to the specified <see cref="T:System.Int32" />
  13773. value.
  13774. </summary>
  13775. <param name="value">
  13776. The <see cref="T:System.Int32" /> value to use.
  13777. </param>
  13778. </member>
  13779. <member name="M:System.Data.SQLite.SQLiteContext.SetInt64(System.Int64)">
  13780. <summary>
  13781. Sets the context result to the specified <see cref="T:System.Int64" />
  13782. value.
  13783. </summary>
  13784. <param name="value">
  13785. The <see cref="T:System.Int64" /> value to use.
  13786. </param>
  13787. </member>
  13788. <member name="M:System.Data.SQLite.SQLiteContext.SetString(System.String)">
  13789. <summary>
  13790. Sets the context result to the specified <see cref="T:System.String" />
  13791. value.
  13792. </summary>
  13793. <param name="value">
  13794. The <see cref="T:System.String" /> value to use. This value will be
  13795. converted to the UTF-8 encoding prior to being used.
  13796. </param>
  13797. </member>
  13798. <member name="M:System.Data.SQLite.SQLiteContext.SetError(System.String)">
  13799. <summary>
  13800. Sets the context result to the specified <see cref="T:System.String" />
  13801. value containing an error message.
  13802. </summary>
  13803. <param name="value">
  13804. The <see cref="T:System.String" /> value containing the error message text.
  13805. This value will be converted to the UTF-8 encoding prior to being
  13806. used.
  13807. </param>
  13808. </member>
  13809. <member name="M:System.Data.SQLite.SQLiteContext.SetErrorCode(System.Data.SQLite.SQLiteErrorCode)">
  13810. <summary>
  13811. Sets the context result to the specified <see cref="T:System.Data.SQLite.SQLiteErrorCode" />
  13812. value.
  13813. </summary>
  13814. <param name="value">
  13815. The <see cref="T:System.Data.SQLite.SQLiteErrorCode" /> value to use.
  13816. </param>
  13817. </member>
  13818. <member name="M:System.Data.SQLite.SQLiteContext.SetErrorTooBig">
  13819. <summary>
  13820. Sets the context result to contain the error code SQLITE_TOOBIG.
  13821. </summary>
  13822. </member>
  13823. <member name="M:System.Data.SQLite.SQLiteContext.SetErrorNoMemory">
  13824. <summary>
  13825. Sets the context result to contain the error code SQLITE_NOMEM.
  13826. </summary>
  13827. </member>
  13828. <member name="M:System.Data.SQLite.SQLiteContext.SetBlob(System.Byte[])">
  13829. <summary>
  13830. Sets the context result to the specified <see cref="T:System.Byte" /> array
  13831. value.
  13832. </summary>
  13833. <param name="value">
  13834. The <see cref="T:System.Byte" /> array value to use.
  13835. </param>
  13836. </member>
  13837. <member name="M:System.Data.SQLite.SQLiteContext.SetZeroBlob(System.Int32)">
  13838. <summary>
  13839. Sets the context result to a BLOB of zeros of the specified size.
  13840. </summary>
  13841. <param name="value">
  13842. The number of zero bytes to use for the BLOB context result.
  13843. </param>
  13844. </member>
  13845. <member name="M:System.Data.SQLite.SQLiteContext.SetValue(System.Data.SQLite.SQLiteValue)">
  13846. <summary>
  13847. Sets the context result to the specified <see cref="T:System.Data.SQLite.SQLiteValue" />.
  13848. </summary>
  13849. <param name="value">
  13850. The <see cref="T:System.Data.SQLite.SQLiteValue" /> to use.
  13851. </param>
  13852. </member>
  13853. <member name="T:System.Data.SQLite.SQLiteValue">
  13854. <summary>
  13855. This class represents a value from the SQLite core library that can be
  13856. passed to the sqlite3_value_*() and associated functions.
  13857. </summary>
  13858. </member>
  13859. <member name="F:System.Data.SQLite.SQLiteValue.pValue">
  13860. <summary>
  13861. The native value handle.
  13862. </summary>
  13863. </member>
  13864. <member name="M:System.Data.SQLite.SQLiteValue.#ctor(System.IntPtr)">
  13865. <summary>
  13866. Constructs an instance of this class using the specified native
  13867. value handle.
  13868. </summary>
  13869. <param name="pValue">
  13870. The native value handle to use.
  13871. </param>
  13872. </member>
  13873. <member name="M:System.Data.SQLite.SQLiteValue.PreventNativeAccess">
  13874. <summary>
  13875. Invalidates the native value handle, thereby preventing further
  13876. access to it from this object instance.
  13877. </summary>
  13878. </member>
  13879. <member name="M:System.Data.SQLite.SQLiteValue.FromIntPtr(System.IntPtr)">
  13880. <summary>
  13881. Converts a native pointer to a native sqlite3_value structure into
  13882. a managed <see cref="T:System.Data.SQLite.SQLiteValue" /> object instance.
  13883. </summary>
  13884. <param name="pValue">
  13885. The native pointer to a native sqlite3_value structure to convert.
  13886. </param>
  13887. <returns>
  13888. The managed <see cref="T:System.Data.SQLite.SQLiteValue" /> object instance or null upon
  13889. failure.
  13890. </returns>
  13891. </member>
  13892. <member name="M:System.Data.SQLite.SQLiteValue.ArrayFromSizeAndIntPtr(System.Int32,System.IntPtr)">
  13893. <summary>
  13894. Converts a logical array of native pointers to native sqlite3_value
  13895. structures into a managed array of <see cref="T:System.Data.SQLite.SQLiteValue" />
  13896. object instances.
  13897. </summary>
  13898. <param name="argc">
  13899. The number of elements in the logical array of native sqlite3_value
  13900. structures.
  13901. </param>
  13902. <param name="argv">
  13903. The native pointer to the logical array of native sqlite3_value
  13904. structures to convert.
  13905. </param>
  13906. <returns>
  13907. The managed array of <see cref="T:System.Data.SQLite.SQLiteValue" /> object instances or
  13908. null upon failure.
  13909. </returns>
  13910. </member>
  13911. <member name="P:System.Data.SQLite.SQLiteValue.NativeHandle">
  13912. <summary>
  13913. Returns the underlying SQLite native handle associated with this
  13914. object instance.
  13915. </summary>
  13916. </member>
  13917. <member name="P:System.Data.SQLite.SQLiteValue.Persisted">
  13918. <summary>
  13919. Returns non-zero if the native SQLite value has been successfully
  13920. persisted as a managed value within this object instance (i.e. the
  13921. <see cref="P:System.Data.SQLite.SQLiteValue.Value" /> property may then be read successfully).
  13922. </summary>
  13923. </member>
  13924. <member name="P:System.Data.SQLite.SQLiteValue.Value">
  13925. <summary>
  13926. If the managed value for this object instance is available (i.e. it
  13927. has been previously persisted via the <see cref="M:System.Data.SQLite.SQLiteValue.Persist" />) method,
  13928. that value is returned; otherwise, an exception is thrown. The
  13929. returned value may be null.
  13930. </summary>
  13931. </member>
  13932. <member name="M:System.Data.SQLite.SQLiteValue.GetTypeAffinity">
  13933. <summary>
  13934. Gets and returns the type affinity associated with this value.
  13935. </summary>
  13936. <returns>
  13937. The type affinity associated with this value.
  13938. </returns>
  13939. </member>
  13940. <member name="M:System.Data.SQLite.SQLiteValue.GetBytes">
  13941. <summary>
  13942. Gets and returns the number of bytes associated with this value, if
  13943. it refers to a UTF-8 encoded string.
  13944. </summary>
  13945. <returns>
  13946. The number of bytes associated with this value. The returned value
  13947. may be zero.
  13948. </returns>
  13949. </member>
  13950. <member name="M:System.Data.SQLite.SQLiteValue.GetInt">
  13951. <summary>
  13952. Gets and returns the <see cref="T:System.Int32" /> associated with this
  13953. value.
  13954. </summary>
  13955. <returns>
  13956. The <see cref="T:System.Int32" /> associated with this value.
  13957. </returns>
  13958. </member>
  13959. <member name="M:System.Data.SQLite.SQLiteValue.GetInt64">
  13960. <summary>
  13961. Gets and returns the <see cref="T:System.Int64" /> associated with
  13962. this value.
  13963. </summary>
  13964. <returns>
  13965. The <see cref="T:System.Int64" /> associated with this value.
  13966. </returns>
  13967. </member>
  13968. <member name="M:System.Data.SQLite.SQLiteValue.GetDouble">
  13969. <summary>
  13970. Gets and returns the <see cref="T:System.Double" /> associated with this
  13971. value.
  13972. </summary>
  13973. <returns>
  13974. The <see cref="T:System.Double" /> associated with this value.
  13975. </returns>
  13976. </member>
  13977. <member name="M:System.Data.SQLite.SQLiteValue.GetString">
  13978. <summary>
  13979. Gets and returns the <see cref="T:System.String" /> associated with this
  13980. value.
  13981. </summary>
  13982. <returns>
  13983. The <see cref="T:System.String" /> associated with this value. The value is
  13984. converted from the UTF-8 encoding prior to being returned.
  13985. </returns>
  13986. </member>
  13987. <member name="M:System.Data.SQLite.SQLiteValue.GetBlob">
  13988. <summary>
  13989. Gets and returns the <see cref="T:System.Byte" /> array associated with this
  13990. value.
  13991. </summary>
  13992. <returns>
  13993. The <see cref="T:System.Byte" /> array associated with this value.
  13994. </returns>
  13995. </member>
  13996. <member name="M:System.Data.SQLite.SQLiteValue.GetObject">
  13997. <summary>
  13998. Gets and returns an <see cref="T:System.Object" /> instance associated with
  13999. this value.
  14000. </summary>
  14001. <returns>
  14002. The <see cref="T:System.Object" /> associated with this value. If the type
  14003. affinity of the object is unknown or cannot be determined, a null
  14004. value will be returned.
  14005. </returns>
  14006. </member>
  14007. <member name="M:System.Data.SQLite.SQLiteValue.Persist">
  14008. <summary>
  14009. Uses the native value handle to obtain and store the managed value
  14010. for this object instance, thus saving it for later use. The type
  14011. of the managed value is determined by the type affinity of the
  14012. native value. If the type affinity is not recognized by this
  14013. method, no work is done and false is returned.
  14014. </summary>
  14015. <returns>
  14016. Non-zero if the native value was persisted successfully.
  14017. </returns>
  14018. </member>
  14019. <member name="T:System.Data.SQLite.SQLiteIndexConstraintOp">
  14020. <summary>
  14021. These are the allowed values for the operators that are part of a
  14022. constraint term in the WHERE clause of a query that uses a virtual
  14023. table.
  14024. </summary>
  14025. </member>
  14026. <member name="F:System.Data.SQLite.SQLiteIndexConstraintOp.EqualTo">
  14027. <summary>
  14028. This value represents the equality operator.
  14029. </summary>
  14030. </member>
  14031. <member name="F:System.Data.SQLite.SQLiteIndexConstraintOp.GreaterThan">
  14032. <summary>
  14033. This value represents the greater than operator.
  14034. </summary>
  14035. </member>
  14036. <member name="F:System.Data.SQLite.SQLiteIndexConstraintOp.LessThanOrEqualTo">
  14037. <summary>
  14038. This value represents the less than or equal to operator.
  14039. </summary>
  14040. </member>
  14041. <member name="F:System.Data.SQLite.SQLiteIndexConstraintOp.LessThan">
  14042. <summary>
  14043. This value represents the less than operator.
  14044. </summary>
  14045. </member>
  14046. <member name="F:System.Data.SQLite.SQLiteIndexConstraintOp.GreaterThanOrEqualTo">
  14047. <summary>
  14048. This value represents the greater than or equal to operator.
  14049. </summary>
  14050. </member>
  14051. <member name="F:System.Data.SQLite.SQLiteIndexConstraintOp.Match">
  14052. <summary>
  14053. This value represents the MATCH operator.
  14054. </summary>
  14055. </member>
  14056. <member name="F:System.Data.SQLite.SQLiteIndexConstraintOp.Like">
  14057. <summary>
  14058. This value represents the LIKE operator.
  14059. </summary>
  14060. </member>
  14061. <member name="F:System.Data.SQLite.SQLiteIndexConstraintOp.Glob">
  14062. <summary>
  14063. This value represents the GLOB operator.
  14064. </summary>
  14065. </member>
  14066. <member name="F:System.Data.SQLite.SQLiteIndexConstraintOp.Regexp">
  14067. <summary>
  14068. This value represents the REGEXP operator.
  14069. </summary>
  14070. </member>
  14071. <member name="F:System.Data.SQLite.SQLiteIndexConstraintOp.NotEqualTo">
  14072. <summary>
  14073. This value represents the inequality operator.
  14074. </summary>
  14075. </member>
  14076. <member name="F:System.Data.SQLite.SQLiteIndexConstraintOp.IsNot">
  14077. <summary>
  14078. This value represents the IS NOT operator.
  14079. </summary>
  14080. </member>
  14081. <member name="F:System.Data.SQLite.SQLiteIndexConstraintOp.IsNotNull">
  14082. <summary>
  14083. This value represents the IS NOT NULL operator.
  14084. </summary>
  14085. </member>
  14086. <member name="F:System.Data.SQLite.SQLiteIndexConstraintOp.IsNull">
  14087. <summary>
  14088. This value represents the IS NULL operator.
  14089. </summary>
  14090. </member>
  14091. <member name="F:System.Data.SQLite.SQLiteIndexConstraintOp.Is">
  14092. <summary>
  14093. This value represents the IS operator.
  14094. </summary>
  14095. </member>
  14096. <member name="T:System.Data.SQLite.SQLiteIndexFlags">
  14097. <summary>
  14098. These are the allowed values for the index flags from the
  14099. <see cref="M:System.Data.SQLite.ISQLiteManagedModule.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)" /> method.
  14100. </summary>
  14101. </member>
  14102. <member name="F:System.Data.SQLite.SQLiteIndexFlags.None">
  14103. <summary>
  14104. No special handling. This is the default.
  14105. </summary>
  14106. </member>
  14107. <member name="F:System.Data.SQLite.SQLiteIndexFlags.ScanUnique">
  14108. <summary>
  14109. This value indicates that the scan of the index will visit at
  14110. most one row.
  14111. </summary>
  14112. </member>
  14113. <member name="T:System.Data.SQLite.SQLiteIndexConstraint">
  14114. <summary>
  14115. This class represents the native sqlite3_index_constraint structure
  14116. from the SQLite core library.
  14117. </summary>
  14118. </member>
  14119. <member name="M:System.Data.SQLite.SQLiteIndexConstraint.#ctor(System.Data.SQLite.UnsafeNativeMethods.sqlite3_index_constraint)">
  14120. <summary>
  14121. Constructs an instance of this class using the specified native
  14122. sqlite3_index_constraint structure.
  14123. </summary>
  14124. <param name="constraint">
  14125. The native sqlite3_index_constraint structure to use.
  14126. </param>
  14127. </member>
  14128. <member name="M:System.Data.SQLite.SQLiteIndexConstraint.#ctor(System.Int32,System.Data.SQLite.SQLiteIndexConstraintOp,System.Byte,System.Int32)">
  14129. <summary>
  14130. Constructs an instance of this class using the specified field
  14131. values.
  14132. </summary>
  14133. <param name="iColumn">
  14134. Column on left-hand side of constraint.
  14135. </param>
  14136. <param name="op">
  14137. Constraint operator (<see cref="T:System.Data.SQLite.SQLiteIndexConstraintOp" />).
  14138. </param>
  14139. <param name="usable">
  14140. True if this constraint is usable.
  14141. </param>
  14142. <param name="iTermOffset">
  14143. Used internally - <see cref="M:System.Data.SQLite.ISQLiteManagedModule.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)" />
  14144. should ignore.
  14145. </param>
  14146. </member>
  14147. <member name="F:System.Data.SQLite.SQLiteIndexConstraint.iColumn">
  14148. <summary>
  14149. Column on left-hand side of constraint.
  14150. </summary>
  14151. </member>
  14152. <member name="F:System.Data.SQLite.SQLiteIndexConstraint.op">
  14153. <summary>
  14154. Constraint operator (<see cref="T:System.Data.SQLite.SQLiteIndexConstraintOp" />).
  14155. </summary>
  14156. </member>
  14157. <member name="F:System.Data.SQLite.SQLiteIndexConstraint.usable">
  14158. <summary>
  14159. True if this constraint is usable.
  14160. </summary>
  14161. </member>
  14162. <member name="F:System.Data.SQLite.SQLiteIndexConstraint.iTermOffset">
  14163. <summary>
  14164. Used internally - <see cref="M:System.Data.SQLite.ISQLiteManagedModule.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)" />
  14165. should ignore.
  14166. </summary>
  14167. </member>
  14168. <member name="T:System.Data.SQLite.SQLiteIndexOrderBy">
  14169. <summary>
  14170. This class represents the native sqlite3_index_orderby structure from
  14171. the SQLite core library.
  14172. </summary>
  14173. </member>
  14174. <member name="M:System.Data.SQLite.SQLiteIndexOrderBy.#ctor(System.Data.SQLite.UnsafeNativeMethods.sqlite3_index_orderby)">
  14175. <summary>
  14176. Constructs an instance of this class using the specified native
  14177. sqlite3_index_orderby structure.
  14178. </summary>
  14179. <param name="orderBy">
  14180. The native sqlite3_index_orderby structure to use.
  14181. </param>
  14182. </member>
  14183. <member name="M:System.Data.SQLite.SQLiteIndexOrderBy.#ctor(System.Int32,System.Byte)">
  14184. <summary>
  14185. Constructs an instance of this class using the specified field
  14186. values.
  14187. </summary>
  14188. <param name="iColumn">
  14189. Column number.
  14190. </param>
  14191. <param name="desc">
  14192. True for DESC. False for ASC.
  14193. </param>
  14194. </member>
  14195. <member name="F:System.Data.SQLite.SQLiteIndexOrderBy.iColumn">
  14196. <summary>
  14197. Column number.
  14198. </summary>
  14199. </member>
  14200. <member name="F:System.Data.SQLite.SQLiteIndexOrderBy.desc">
  14201. <summary>
  14202. True for DESC. False for ASC.
  14203. </summary>
  14204. </member>
  14205. <member name="T:System.Data.SQLite.SQLiteIndexConstraintUsage">
  14206. <summary>
  14207. This class represents the native sqlite3_index_constraint_usage
  14208. structure from the SQLite core library.
  14209. </summary>
  14210. </member>
  14211. <member name="M:System.Data.SQLite.SQLiteIndexConstraintUsage.#ctor">
  14212. <summary>
  14213. Constructs a default instance of this class.
  14214. </summary>
  14215. </member>
  14216. <member name="M:System.Data.SQLite.SQLiteIndexConstraintUsage.#ctor(System.Data.SQLite.UnsafeNativeMethods.sqlite3_index_constraint_usage)">
  14217. <summary>
  14218. Constructs an instance of this class using the specified native
  14219. sqlite3_index_constraint_usage structure.
  14220. </summary>
  14221. <param name="constraintUsage">
  14222. The native sqlite3_index_constraint_usage structure to use.
  14223. </param>
  14224. </member>
  14225. <member name="M:System.Data.SQLite.SQLiteIndexConstraintUsage.#ctor(System.Int32,System.Byte)">
  14226. <summary>
  14227. Constructs an instance of this class using the specified field
  14228. values.
  14229. </summary>
  14230. <param name="argvIndex">
  14231. If greater than 0, constraint is part of argv to xFilter.
  14232. </param>
  14233. <param name="omit">
  14234. Do not code a test for this constraint.
  14235. </param>
  14236. </member>
  14237. <member name="F:System.Data.SQLite.SQLiteIndexConstraintUsage.argvIndex">
  14238. <summary>
  14239. If greater than 0, constraint is part of argv to xFilter.
  14240. </summary>
  14241. </member>
  14242. <member name="F:System.Data.SQLite.SQLiteIndexConstraintUsage.omit">
  14243. <summary>
  14244. Do not code a test for this constraint.
  14245. </summary>
  14246. </member>
  14247. <member name="T:System.Data.SQLite.SQLiteIndexInputs">
  14248. <summary>
  14249. This class represents the various inputs provided by the SQLite core
  14250. library to the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)" /> method.
  14251. </summary>
  14252. </member>
  14253. <member name="M:System.Data.SQLite.SQLiteIndexInputs.#ctor(System.Int32,System.Int32)">
  14254. <summary>
  14255. Constructs an instance of this class.
  14256. </summary>
  14257. <param name="nConstraint">
  14258. The number of <see cref="T:System.Data.SQLite.SQLiteIndexConstraint" /> instances to
  14259. pre-allocate space for.
  14260. </param>
  14261. <param name="nOrderBy">
  14262. The number of <see cref="T:System.Data.SQLite.SQLiteIndexOrderBy" /> instances to
  14263. pre-allocate space for.
  14264. </param>
  14265. </member>
  14266. <member name="P:System.Data.SQLite.SQLiteIndexInputs.Constraints">
  14267. <summary>
  14268. An array of <see cref="T:System.Data.SQLite.SQLiteIndexConstraint" /> object instances,
  14269. each containing information supplied by the SQLite core library.
  14270. </summary>
  14271. </member>
  14272. <member name="P:System.Data.SQLite.SQLiteIndexInputs.OrderBys">
  14273. <summary>
  14274. An array of <see cref="T:System.Data.SQLite.SQLiteIndexOrderBy" /> object instances,
  14275. each containing information supplied by the SQLite core library.
  14276. </summary>
  14277. </member>
  14278. <member name="T:System.Data.SQLite.SQLiteIndexOutputs">
  14279. <summary>
  14280. This class represents the various outputs provided to the SQLite core
  14281. library by the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)" /> method.
  14282. </summary>
  14283. </member>
  14284. <member name="M:System.Data.SQLite.SQLiteIndexOutputs.#ctor(System.Int32)">
  14285. <summary>
  14286. Constructs an instance of this class.
  14287. </summary>
  14288. <param name="nConstraint">
  14289. The number of <see cref="T:System.Data.SQLite.SQLiteIndexConstraintUsage" /> instances
  14290. to pre-allocate space for.
  14291. </param>
  14292. </member>
  14293. <member name="M:System.Data.SQLite.SQLiteIndexOutputs.CanUseEstimatedRows">
  14294. <summary>
  14295. Determines if the native estimatedRows field can be used, based on
  14296. the available version of the SQLite core library.
  14297. </summary>
  14298. <returns>
  14299. Non-zero if the <see cref="P:System.Data.SQLite.SQLiteIndexOutputs.EstimatedRows" /> property is supported
  14300. by the SQLite core library.
  14301. </returns>
  14302. </member>
  14303. <member name="M:System.Data.SQLite.SQLiteIndexOutputs.CanUseIndexFlags">
  14304. <summary>
  14305. Determines if the native flags field can be used, based on the
  14306. available version of the SQLite core library.
  14307. </summary>
  14308. <returns>
  14309. Non-zero if the <see cref="P:System.Data.SQLite.SQLiteIndexOutputs.IndexFlags" /> property is supported by
  14310. the SQLite core library.
  14311. </returns>
  14312. </member>
  14313. <member name="M:System.Data.SQLite.SQLiteIndexOutputs.CanUseColumnsUsed">
  14314. <summary>
  14315. Determines if the native flags field can be used, based on the
  14316. available version of the SQLite core library.
  14317. </summary>
  14318. <returns>
  14319. Non-zero if the <see cref="P:System.Data.SQLite.SQLiteIndexOutputs.ColumnsUsed" /> property is supported by
  14320. the SQLite core library.
  14321. </returns>
  14322. </member>
  14323. <member name="P:System.Data.SQLite.SQLiteIndexOutputs.ConstraintUsages">
  14324. <summary>
  14325. An array of <see cref="T:System.Data.SQLite.SQLiteIndexConstraintUsage" /> object
  14326. instances, each containing information to be supplied to the SQLite
  14327. core library.
  14328. </summary>
  14329. </member>
  14330. <member name="P:System.Data.SQLite.SQLiteIndexOutputs.IndexNumber">
  14331. <summary>
  14332. Number used to help identify the selected index. This value will
  14333. 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[])" />
  14334. method.
  14335. </summary>
  14336. </member>
  14337. <member name="P:System.Data.SQLite.SQLiteIndexOutputs.IndexString">
  14338. <summary>
  14339. String used to help identify the selected index. This value will
  14340. 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[])" />
  14341. method.
  14342. </summary>
  14343. </member>
  14344. <member name="P:System.Data.SQLite.SQLiteIndexOutputs.NeedToFreeIndexString">
  14345. <summary>
  14346. Non-zero if the index string must be freed by the SQLite core
  14347. library.
  14348. </summary>
  14349. </member>
  14350. <member name="P:System.Data.SQLite.SQLiteIndexOutputs.OrderByConsumed">
  14351. <summary>
  14352. True if output is already ordered.
  14353. </summary>
  14354. </member>
  14355. <member name="P:System.Data.SQLite.SQLiteIndexOutputs.EstimatedCost">
  14356. <summary>
  14357. Estimated cost of using this index. Using a null value here
  14358. indicates that a default estimated cost value should be used.
  14359. </summary>
  14360. </member>
  14361. <member name="P:System.Data.SQLite.SQLiteIndexOutputs.EstimatedRows">
  14362. <summary>
  14363. Estimated number of rows returned. Using a null value here
  14364. indicates that a default estimated rows value should be used.
  14365. This property has no effect if the SQLite core library is not at
  14366. least version 3.8.2.
  14367. </summary>
  14368. </member>
  14369. <member name="P:System.Data.SQLite.SQLiteIndexOutputs.IndexFlags">
  14370. <summary>
  14371. The flags that should be used with this index. Using a null value
  14372. here indicates that a default flags value should be used. This
  14373. property has no effect if the SQLite core library is not at least
  14374. version 3.9.0.
  14375. </summary>
  14376. </member>
  14377. <member name="P:System.Data.SQLite.SQLiteIndexOutputs.ColumnsUsed">
  14378. <summary>
  14379. <para>
  14380. Indicates which columns of the virtual table may be required by the
  14381. current scan. Virtual table columns are numbered from zero in the
  14382. order in which they appear within the CREATE TABLE statement passed
  14383. to sqlite3_declare_vtab(). For the first 63 columns (columns 0-62),
  14384. the corresponding bit is set within the bit mask if the column may
  14385. be required by SQLite. If the table has at least 64 columns and
  14386. any column to the right of the first 63 is required, then bit 63 of
  14387. colUsed is also set. In other words, column iCol may be required
  14388. if the expression
  14389. </para>
  14390. <para><code>
  14391. (colUsed &amp; ((sqlite3_uint64)1 &lt;&lt; (iCol&gt;=63 ? 63 : iCol)))
  14392. </code></para>
  14393. <para>
  14394. evaluates to non-zero. Using a null value here indicates that a
  14395. default flags value should be used. This property has no effect if
  14396. the SQLite core library is not at least version 3.10.0.
  14397. </para>
  14398. </summary>
  14399. </member>
  14400. <member name="T:System.Data.SQLite.SQLiteIndex">
  14401. <summary>
  14402. This class represents the various inputs and outputs used with the
  14403. <see cref="M:System.Data.SQLite.ISQLiteManagedModule.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)" /> method.
  14404. </summary>
  14405. </member>
  14406. <member name="M:System.Data.SQLite.SQLiteIndex.#ctor(System.Int32,System.Int32)">
  14407. <summary>
  14408. Constructs an instance of this class.
  14409. </summary>
  14410. <param name="nConstraint">
  14411. The number of <see cref="T:System.Data.SQLite.SQLiteIndexConstraint" /> (and
  14412. <see cref="T:System.Data.SQLite.SQLiteIndexConstraintUsage" />) instances to
  14413. pre-allocate space for.
  14414. </param>
  14415. <param name="nOrderBy">
  14416. The number of <see cref="T:System.Data.SQLite.SQLiteIndexOrderBy" /> instances to
  14417. pre-allocate space for.
  14418. </param>
  14419. </member>
  14420. <member name="M:System.Data.SQLite.SQLiteIndex.SizeOfNative(System.Int32@,System.Int32@,System.Int32@,System.Int32@)">
  14421. <summary>
  14422. Attempts to determine the structure sizes needed to create and
  14423. populate a native
  14424. <see cref="T:System.Data.SQLite.UnsafeNativeMethods.sqlite3_index_info" />
  14425. structure.
  14426. </summary>
  14427. <param name="sizeOfInfoType">
  14428. The size of the native
  14429. <see cref="T:System.Data.SQLite.UnsafeNativeMethods.sqlite3_index_info" />
  14430. structure is stored here.
  14431. </param>
  14432. <param name="sizeOfConstraintType">
  14433. The size of the native
  14434. <see cref="T:System.Data.SQLite.UnsafeNativeMethods.sqlite3_index_constraint" />
  14435. structure is stored here.
  14436. </param>
  14437. <param name="sizeOfOrderByType">
  14438. The size of the native
  14439. <see cref="T:System.Data.SQLite.UnsafeNativeMethods.sqlite3_index_orderby" />
  14440. structure is stored here.
  14441. </param>
  14442. <param name="sizeOfConstraintUsageType">
  14443. The size of the native
  14444. <see cref="T:System.Data.SQLite.UnsafeNativeMethods.sqlite3_index_constraint_usage" />
  14445. structure is stored here.
  14446. </param>
  14447. </member>
  14448. <member name="M:System.Data.SQLite.SQLiteIndex.AllocateAndInitializeNative(System.Int32,System.Int32)">
  14449. <summary>
  14450. Attempts to allocate and initialize a native
  14451. <see cref="T:System.Data.SQLite.UnsafeNativeMethods.sqlite3_index_info" />
  14452. structure.
  14453. </summary>
  14454. <param name="nConstraint">
  14455. The number of <see cref="T:System.Data.SQLite.SQLiteIndexConstraint" /> instances to
  14456. pre-allocate space for.
  14457. </param>
  14458. <param name="nOrderBy">
  14459. The number of <see cref="T:System.Data.SQLite.SQLiteIndexOrderBy" /> instances to
  14460. pre-allocate space for.
  14461. </param>
  14462. <returns>
  14463. The newly allocated native
  14464. <see cref="T:System.Data.SQLite.UnsafeNativeMethods.sqlite3_index_info" /> structure
  14465. -OR- <see cref="F:System.IntPtr.Zero" /> if it could not be fully allocated.
  14466. </returns>
  14467. </member>
  14468. <member name="M:System.Data.SQLite.SQLiteIndex.FreeNative(System.IntPtr)">
  14469. <summary>
  14470. Frees all the memory associated with a native
  14471. <see cref="T:System.Data.SQLite.UnsafeNativeMethods.sqlite3_index_info" />
  14472. structure.
  14473. </summary>
  14474. <param name="pIndex">
  14475. The native pointer to the native sqlite3_index_info structure to
  14476. free.
  14477. </param>
  14478. </member>
  14479. <member name="M:System.Data.SQLite.SQLiteIndex.FromIntPtr(System.IntPtr,System.Boolean,System.Data.SQLite.SQLiteIndex@)">
  14480. <summary>
  14481. Converts a native pointer to a native sqlite3_index_info structure
  14482. into a new <see cref="T:System.Data.SQLite.SQLiteIndex" /> object instance.
  14483. </summary>
  14484. <param name="pIndex">
  14485. The native pointer to the native sqlite3_index_info structure to
  14486. convert.
  14487. </param>
  14488. <param name="includeOutput">
  14489. Non-zero to include fields from the outputs portion of the native
  14490. structure; otherwise, the "output" fields will not be read.
  14491. </param>
  14492. <param name="index">
  14493. Upon success, this parameter will be modified to contain the newly
  14494. created <see cref="T:System.Data.SQLite.SQLiteIndex" /> object instance.
  14495. </param>
  14496. </member>
  14497. <member name="M:System.Data.SQLite.SQLiteIndex.ToIntPtr(System.Data.SQLite.SQLiteIndex,System.IntPtr,System.Boolean)">
  14498. <summary>
  14499. Populates the outputs of a pre-allocated native sqlite3_index_info
  14500. structure using an existing <see cref="T:System.Data.SQLite.SQLiteIndex" /> object
  14501. instance.
  14502. </summary>
  14503. <param name="index">
  14504. The existing <see cref="T:System.Data.SQLite.SQLiteIndex" /> object instance containing
  14505. the output data to use.
  14506. </param>
  14507. <param name="pIndex">
  14508. The native pointer to the pre-allocated native sqlite3_index_info
  14509. structure.
  14510. </param>
  14511. <param name="includeInput">
  14512. Non-zero to include fields from the inputs portion of the native
  14513. structure; otherwise, the "input" fields will not be written.
  14514. </param>
  14515. </member>
  14516. <member name="P:System.Data.SQLite.SQLiteIndex.Inputs">
  14517. <summary>
  14518. The <see cref="T:System.Data.SQLite.SQLiteIndexInputs" /> object instance containing
  14519. the inputs to the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)" />
  14520. method.
  14521. </summary>
  14522. </member>
  14523. <member name="P:System.Data.SQLite.SQLiteIndex.Outputs">
  14524. <summary>
  14525. The <see cref="T:System.Data.SQLite.SQLiteIndexOutputs" /> object instance containing
  14526. the outputs from the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)" />
  14527. method.
  14528. </summary>
  14529. </member>
  14530. <member name="T:System.Data.SQLite.SQLiteVirtualTable">
  14531. <summary>
  14532. This class represents a managed virtual table implementation. It is
  14533. not sealed and should be used as the base class for any user-defined
  14534. virtual table classes implemented in managed code.
  14535. </summary>
  14536. </member>
  14537. <member name="F:System.Data.SQLite.SQLiteVirtualTable.ModuleNameIndex">
  14538. <summary>
  14539. The index within the array of strings provided to the
  14540. <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Create(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)" /> and
  14541. <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
  14542. name of the module implementing this virtual table.
  14543. </summary>
  14544. </member>
  14545. <member name="F:System.Data.SQLite.SQLiteVirtualTable.DatabaseNameIndex">
  14546. <summary>
  14547. The index within the array of strings provided to the
  14548. <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Create(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)" /> and
  14549. <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
  14550. name of the database containing this virtual table.
  14551. </summary>
  14552. </member>
  14553. <member name="F:System.Data.SQLite.SQLiteVirtualTable.TableNameIndex">
  14554. <summary>
  14555. The index within the array of strings provided to the
  14556. <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Create(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)" /> and
  14557. <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
  14558. name of the virtual table.
  14559. </summary>
  14560. </member>
  14561. <member name="M:System.Data.SQLite.SQLiteVirtualTable.#ctor(System.String[])">
  14562. <summary>
  14563. Constructs an instance of this class.
  14564. </summary>
  14565. <param name="arguments">
  14566. The original array of strings provided to the
  14567. <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Create(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)" /> and
  14568. <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Connect(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)" /> methods.
  14569. </param>
  14570. </member>
  14571. <member name="P:System.Data.SQLite.SQLiteVirtualTable.Arguments">
  14572. <summary>
  14573. The original array of strings provided to the
  14574. <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Create(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)" /> and
  14575. <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Connect(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)" /> methods.
  14576. </summary>
  14577. </member>
  14578. <member name="P:System.Data.SQLite.SQLiteVirtualTable.ModuleName">
  14579. <summary>
  14580. The name of the module implementing this virtual table.
  14581. </summary>
  14582. </member>
  14583. <member name="P:System.Data.SQLite.SQLiteVirtualTable.DatabaseName">
  14584. <summary>
  14585. The name of the database containing this virtual table.
  14586. </summary>
  14587. </member>
  14588. <member name="P:System.Data.SQLite.SQLiteVirtualTable.TableName">
  14589. <summary>
  14590. The name of the virtual table.
  14591. </summary>
  14592. </member>
  14593. <member name="P:System.Data.SQLite.SQLiteVirtualTable.Index">
  14594. <summary>
  14595. The <see cref="T:System.Data.SQLite.SQLiteIndex" /> object instance containing all the
  14596. data for the inputs and outputs relating to the most recent index
  14597. selection.
  14598. </summary>
  14599. </member>
  14600. <member name="M:System.Data.SQLite.SQLiteVirtualTable.BestIndex(System.Data.SQLite.SQLiteIndex)">
  14601. <summary>
  14602. This method should normally be used by the
  14603. <see cref="M:System.Data.SQLite.ISQLiteManagedModule.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)" /> method in order to
  14604. perform index selection based on the constraints provided by the
  14605. SQLite core library.
  14606. </summary>
  14607. <param name="index">
  14608. The <see cref="T:System.Data.SQLite.SQLiteIndex" /> object instance containing all the
  14609. data for the inputs and outputs relating to index selection.
  14610. </param>
  14611. <returns>
  14612. Non-zero upon success.
  14613. </returns>
  14614. </member>
  14615. <member name="M:System.Data.SQLite.SQLiteVirtualTable.Rename(System.String)">
  14616. <summary>
  14617. Attempts to record the renaming of the virtual table associated
  14618. with this object instance.
  14619. </summary>
  14620. <param name="name">
  14621. The new name for the virtual table.
  14622. </param>
  14623. <returns>
  14624. Non-zero upon success.
  14625. </returns>
  14626. </member>
  14627. <member name="P:System.Data.SQLite.SQLiteVirtualTable.NativeHandle">
  14628. <summary>
  14629. Returns the underlying SQLite native handle associated with this
  14630. object instance.
  14631. </summary>
  14632. </member>
  14633. <member name="M:System.Data.SQLite.SQLiteVirtualTable.Dispose">
  14634. <summary>
  14635. Disposes of this object instance.
  14636. </summary>
  14637. </member>
  14638. <member name="M:System.Data.SQLite.SQLiteVirtualTable.CheckDisposed">
  14639. <summary>
  14640. Throws an <see cref="T:System.ObjectDisposedException" /> if this object
  14641. instance has been disposed.
  14642. </summary>
  14643. </member>
  14644. <member name="M:System.Data.SQLite.SQLiteVirtualTable.Dispose(System.Boolean)">
  14645. <summary>
  14646. Disposes of this object instance.
  14647. </summary>
  14648. <param name="disposing">
  14649. Non-zero if this method is being called from the
  14650. <see cref="M:System.Data.SQLite.SQLiteVirtualTable.Dispose" /> method. Zero if this method is being called
  14651. from the finalizer.
  14652. </param>
  14653. </member>
  14654. <member name="M:System.Data.SQLite.SQLiteVirtualTable.Finalize">
  14655. <summary>
  14656. Finalizes this object instance.
  14657. </summary>
  14658. </member>
  14659. <member name="T:System.Data.SQLite.SQLiteVirtualTableCursor">
  14660. <summary>
  14661. This class represents a managed virtual table cursor implementation.
  14662. It is not sealed and should be used as the base class for any
  14663. user-defined virtual table cursor classes implemented in managed code.
  14664. </summary>
  14665. </member>
  14666. <member name="F:System.Data.SQLite.SQLiteVirtualTableCursor.InvalidRowIndex">
  14667. <summary>
  14668. This value represents an invalid integer row sequence number.
  14669. </summary>
  14670. </member>
  14671. <member name="F:System.Data.SQLite.SQLiteVirtualTableCursor.rowIndex">
  14672. <summary>
  14673. The field holds the integer row sequence number for the current row
  14674. pointed to by this cursor object instance.
  14675. </summary>
  14676. </member>
  14677. <member name="M:System.Data.SQLite.SQLiteVirtualTableCursor.#ctor(System.Data.SQLite.SQLiteVirtualTable)">
  14678. <summary>
  14679. Constructs an instance of this class.
  14680. </summary>
  14681. <param name="table">
  14682. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object instance associated
  14683. with this object instance.
  14684. </param>
  14685. </member>
  14686. <member name="M:System.Data.SQLite.SQLiteVirtualTableCursor.#ctor">
  14687. <summary>
  14688. Constructs an instance of this class.
  14689. </summary>
  14690. </member>
  14691. <member name="P:System.Data.SQLite.SQLiteVirtualTableCursor.Table">
  14692. <summary>
  14693. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object instance associated
  14694. with this object instance.
  14695. </summary>
  14696. </member>
  14697. <member name="P:System.Data.SQLite.SQLiteVirtualTableCursor.IndexNumber">
  14698. <summary>
  14699. Number used to help identify the selected index. This value will
  14700. be set via the <see cref="M:System.Data.SQLite.SQLiteVirtualTableCursor.Filter(System.Int32,System.String,System.Data.SQLite.SQLiteValue[])" /> method.
  14701. </summary>
  14702. </member>
  14703. <member name="P:System.Data.SQLite.SQLiteVirtualTableCursor.IndexString">
  14704. <summary>
  14705. String used to help identify the selected index. This value will
  14706. be set via the <see cref="M:System.Data.SQLite.SQLiteVirtualTableCursor.Filter(System.Int32,System.String,System.Data.SQLite.SQLiteValue[])" /> method.
  14707. </summary>
  14708. </member>
  14709. <member name="P:System.Data.SQLite.SQLiteVirtualTableCursor.Values">
  14710. <summary>
  14711. The values used to filter the rows returned via this cursor object
  14712. instance. This value will be set via the <see cref="M:System.Data.SQLite.SQLiteVirtualTableCursor.Filter(System.Int32,System.String,System.Data.SQLite.SQLiteValue[])" />
  14713. method.
  14714. </summary>
  14715. </member>
  14716. <member name="M:System.Data.SQLite.SQLiteVirtualTableCursor.TryPersistValues(System.Data.SQLite.SQLiteValue[])">
  14717. <summary>
  14718. Attempts to persist the specified <see cref="T:System.Data.SQLite.SQLiteValue" /> object
  14719. instances in order to make them available after the
  14720. <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Filter(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int32,System.String,System.Data.SQLite.SQLiteValue[])" /> method returns.
  14721. </summary>
  14722. <param name="values">
  14723. The array of <see cref="T:System.Data.SQLite.SQLiteValue" /> object instances to be
  14724. persisted.
  14725. </param>
  14726. <returns>
  14727. The number of <see cref="T:System.Data.SQLite.SQLiteValue" /> object instances that were
  14728. successfully persisted.
  14729. </returns>
  14730. </member>
  14731. <member name="M:System.Data.SQLite.SQLiteVirtualTableCursor.Filter(System.Int32,System.String,System.Data.SQLite.SQLiteValue[])">
  14732. <summary>
  14733. This method should normally be used by the
  14734. <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Filter(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int32,System.String,System.Data.SQLite.SQLiteValue[])" /> method in order to
  14735. perform filtering of the result rows and/or to record the filtering
  14736. criteria provided by the SQLite core library.
  14737. </summary>
  14738. <param name="indexNumber">
  14739. Number used to help identify the selected index.
  14740. </param>
  14741. <param name="indexString">
  14742. String used to help identify the selected index.
  14743. </param>
  14744. <param name="values">
  14745. The values corresponding to each column in the selected index.
  14746. </param>
  14747. </member>
  14748. <member name="M:System.Data.SQLite.SQLiteVirtualTableCursor.GetRowIndex">
  14749. <summary>
  14750. Determines the integer row sequence number for the current row.
  14751. </summary>
  14752. <returns>
  14753. The integer row sequence number for the current row -OR- zero if
  14754. it cannot be determined.
  14755. </returns>
  14756. </member>
  14757. <member name="M:System.Data.SQLite.SQLiteVirtualTableCursor.NextRowIndex">
  14758. <summary>
  14759. Adjusts the integer row sequence number so that it refers to the
  14760. next row.
  14761. </summary>
  14762. </member>
  14763. <member name="P:System.Data.SQLite.SQLiteVirtualTableCursor.NativeHandle">
  14764. <summary>
  14765. Returns the underlying SQLite native handle associated with this
  14766. object instance.
  14767. </summary>
  14768. </member>
  14769. <member name="M:System.Data.SQLite.SQLiteVirtualTableCursor.Dispose">
  14770. <summary>
  14771. Disposes of this object instance.
  14772. </summary>
  14773. </member>
  14774. <member name="M:System.Data.SQLite.SQLiteVirtualTableCursor.CheckDisposed">
  14775. <summary>
  14776. Throws an <see cref="T:System.ObjectDisposedException" /> if this object
  14777. instance has been disposed.
  14778. </summary>
  14779. </member>
  14780. <member name="M:System.Data.SQLite.SQLiteVirtualTableCursor.Dispose(System.Boolean)">
  14781. <summary>
  14782. Disposes of this object instance.
  14783. </summary>
  14784. <param name="disposing">
  14785. Non-zero if this method is being called from the
  14786. <see cref="M:System.Data.SQLite.SQLiteVirtualTableCursor.Dispose" /> method. Zero if this method is being called
  14787. from the finalizer.
  14788. </param>
  14789. </member>
  14790. <member name="M:System.Data.SQLite.SQLiteVirtualTableCursor.Finalize">
  14791. <summary>
  14792. Finalizes this object instance.
  14793. </summary>
  14794. </member>
  14795. <member name="T:System.Data.SQLite.ISQLiteNativeHandle">
  14796. <summary>
  14797. This interface represents a native handle provided by the SQLite core
  14798. library.
  14799. </summary>
  14800. </member>
  14801. <member name="P:System.Data.SQLite.ISQLiteNativeHandle.NativeHandle">
  14802. <summary>
  14803. The native handle value.
  14804. </summary>
  14805. </member>
  14806. <member name="T:System.Data.SQLite.ISQLiteManagedModule">
  14807. <summary>
  14808. This interface represents a virtual table implementation written in
  14809. managed code.
  14810. </summary>
  14811. </member>
  14812. <member name="P:System.Data.SQLite.ISQLiteManagedModule.Declared">
  14813. <summary>
  14814. Returns non-zero if the schema for the virtual table has been
  14815. declared.
  14816. </summary>
  14817. </member>
  14818. <member name="P:System.Data.SQLite.ISQLiteManagedModule.Name">
  14819. <summary>
  14820. Returns the name of the module as it was registered with the SQLite
  14821. core library.
  14822. </summary>
  14823. </member>
  14824. <member name="M:System.Data.SQLite.ISQLiteManagedModule.Create(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)">
  14825. <summary>
  14826. This method is called in response to the
  14827. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> method.
  14828. </summary>
  14829. <param name="connection">
  14830. The <see cref="T:System.Data.SQLite.SQLiteConnection" /> object instance associated with
  14831. the virtual table.
  14832. </param>
  14833. <param name="pClientData">
  14834. The native user-data pointer associated with this module, as it was
  14835. provided to the SQLite core library when the native module instance
  14836. was created.
  14837. </param>
  14838. <param name="arguments">
  14839. The module name, database name, virtual table name, and all other
  14840. arguments passed to the CREATE VIRTUAL TABLE statement.
  14841. </param>
  14842. <param name="table">
  14843. Upon success, this parameter must be modified to contain the
  14844. <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object instance associated with
  14845. the virtual table.
  14846. </param>
  14847. <param name="error">
  14848. Upon failure, this parameter must be modified to contain an error
  14849. message.
  14850. </param>
  14851. <returns>
  14852. A standard SQLite return code.
  14853. </returns>
  14854. </member>
  14855. <member name="M:System.Data.SQLite.ISQLiteManagedModule.Connect(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)">
  14856. <summary>
  14857. This method is called in response to the
  14858. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> method.
  14859. </summary>
  14860. <param name="connection">
  14861. The <see cref="T:System.Data.SQLite.SQLiteConnection" /> object instance associated with
  14862. the virtual table.
  14863. </param>
  14864. <param name="pClientData">
  14865. The native user-data pointer associated with this module, as it was
  14866. provided to the SQLite core library when the native module instance
  14867. was created.
  14868. </param>
  14869. <param name="arguments">
  14870. The module name, database name, virtual table name, and all other
  14871. arguments passed to the CREATE VIRTUAL TABLE statement.
  14872. </param>
  14873. <param name="table">
  14874. Upon success, this parameter must be modified to contain the
  14875. <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object instance associated with
  14876. the virtual table.
  14877. </param>
  14878. <param name="error">
  14879. Upon failure, this parameter must be modified to contain an error
  14880. message.
  14881. </param>
  14882. <returns>
  14883. A standard SQLite return code.
  14884. </returns>
  14885. </member>
  14886. <member name="M:System.Data.SQLite.ISQLiteManagedModule.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)">
  14887. <summary>
  14888. This method is called in response to the
  14889. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xBestIndex(System.IntPtr,System.IntPtr)" /> method.
  14890. </summary>
  14891. <param name="table">
  14892. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object instance associated
  14893. with this virtual table.
  14894. </param>
  14895. <param name="index">
  14896. The <see cref="T:System.Data.SQLite.SQLiteIndex" /> object instance containing all the
  14897. data for the inputs and outputs relating to index selection.
  14898. </param>
  14899. <returns>
  14900. A standard SQLite return code.
  14901. </returns>
  14902. </member>
  14903. <member name="M:System.Data.SQLite.ISQLiteManagedModule.Disconnect(System.Data.SQLite.SQLiteVirtualTable)">
  14904. <summary>
  14905. This method is called in response to the
  14906. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDisconnect(System.IntPtr)" /> method.
  14907. </summary>
  14908. <param name="table">
  14909. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object instance associated
  14910. with this virtual table.
  14911. </param>
  14912. <returns>
  14913. A standard SQLite return code.
  14914. </returns>
  14915. </member>
  14916. <member name="M:System.Data.SQLite.ISQLiteManagedModule.Destroy(System.Data.SQLite.SQLiteVirtualTable)">
  14917. <summary>
  14918. This method is called in response to the
  14919. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDestroy(System.IntPtr)" /> method.
  14920. </summary>
  14921. <param name="table">
  14922. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object instance associated
  14923. with this virtual table.
  14924. </param>
  14925. <returns>
  14926. A standard SQLite return code.
  14927. </returns>
  14928. </member>
  14929. <member name="M:System.Data.SQLite.ISQLiteManagedModule.Open(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteVirtualTableCursor@)">
  14930. <summary>
  14931. This method is called in response to the
  14932. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xOpen(System.IntPtr,System.IntPtr@)" /> method.
  14933. </summary>
  14934. <param name="table">
  14935. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object instance associated
  14936. with this virtual table.
  14937. </param>
  14938. <param name="cursor">
  14939. Upon success, this parameter must be modified to contain the
  14940. <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor" /> object instance associated
  14941. with the newly opened virtual table cursor.
  14942. </param>
  14943. <returns>
  14944. A standard SQLite return code.
  14945. </returns>
  14946. </member>
  14947. <member name="M:System.Data.SQLite.ISQLiteManagedModule.Close(System.Data.SQLite.SQLiteVirtualTableCursor)">
  14948. <summary>
  14949. This method is called in response to the
  14950. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xClose(System.IntPtr)" /> method.
  14951. </summary>
  14952. <param name="cursor">
  14953. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor" /> object instance
  14954. associated with the previously opened virtual table cursor to be
  14955. used.
  14956. </param>
  14957. <returns>
  14958. A standard SQLite return code.
  14959. </returns>
  14960. </member>
  14961. <member name="M:System.Data.SQLite.ISQLiteManagedModule.Filter(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int32,System.String,System.Data.SQLite.SQLiteValue[])">
  14962. <summary>
  14963. This method is called in response to the
  14964. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFilter(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)" /> method.
  14965. </summary>
  14966. <param name="cursor">
  14967. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor" /> object instance
  14968. associated with the previously opened virtual table cursor to be
  14969. used.
  14970. </param>
  14971. <param name="indexNumber">
  14972. Number used to help identify the selected index.
  14973. </param>
  14974. <param name="indexString">
  14975. String used to help identify the selected index.
  14976. </param>
  14977. <param name="values">
  14978. The values corresponding to each column in the selected index.
  14979. </param>
  14980. <returns>
  14981. A standard SQLite return code.
  14982. </returns>
  14983. </member>
  14984. <member name="M:System.Data.SQLite.ISQLiteManagedModule.Next(System.Data.SQLite.SQLiteVirtualTableCursor)">
  14985. <summary>
  14986. This method is called in response to the
  14987. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xNext(System.IntPtr)" /> method.
  14988. </summary>
  14989. <param name="cursor">
  14990. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor" /> object instance
  14991. associated with the previously opened virtual table cursor to be
  14992. used.
  14993. </param>
  14994. <returns>
  14995. A standard SQLite return code.
  14996. </returns>
  14997. </member>
  14998. <member name="M:System.Data.SQLite.ISQLiteManagedModule.Eof(System.Data.SQLite.SQLiteVirtualTableCursor)">
  14999. <summary>
  15000. This method is called in response to the
  15001. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xEof(System.IntPtr)" /> method.
  15002. </summary>
  15003. <param name="cursor">
  15004. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor" /> object instance
  15005. associated with the previously opened virtual table cursor to be
  15006. used.
  15007. </param>
  15008. <returns>
  15009. Non-zero if no more rows are available; zero otherwise.
  15010. </returns>
  15011. </member>
  15012. <member name="M:System.Data.SQLite.ISQLiteManagedModule.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)">
  15013. <summary>
  15014. This method is called in response to the
  15015. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xColumn(System.IntPtr,System.IntPtr,System.Int32)" /> method.
  15016. </summary>
  15017. <param name="cursor">
  15018. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor" /> object instance
  15019. associated with the previously opened virtual table cursor to be
  15020. used.
  15021. </param>
  15022. <param name="context">
  15023. The <see cref="T:System.Data.SQLite.SQLiteContext" /> object instance to be used for
  15024. returning the specified column value to the SQLite core library.
  15025. </param>
  15026. <param name="index">
  15027. The zero-based index corresponding to the column containing the
  15028. value to be returned.
  15029. </param>
  15030. <returns>
  15031. A standard SQLite return code.
  15032. </returns>
  15033. </member>
  15034. <member name="M:System.Data.SQLite.ISQLiteManagedModule.RowId(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int64@)">
  15035. <summary>
  15036. This method is called in response to the
  15037. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRowId(System.IntPtr,System.Int64@)" /> method.
  15038. </summary>
  15039. <param name="cursor">
  15040. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor" /> object instance
  15041. associated with the previously opened virtual table cursor to be
  15042. used.
  15043. </param>
  15044. <param name="rowId">
  15045. Upon success, this parameter must be modified to contain the unique
  15046. integer row identifier for the current row for the specified cursor.
  15047. </param>
  15048. <returns>
  15049. A standard SQLite return code.
  15050. </returns>
  15051. </member>
  15052. <member name="M:System.Data.SQLite.ISQLiteManagedModule.Update(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteValue[],System.Int64@)">
  15053. <summary>
  15054. This method is called in response to the
  15055. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xUpdate(System.IntPtr,System.Int32,System.IntPtr,System.Int64@)" /> method.
  15056. </summary>
  15057. <param name="table">
  15058. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object instance associated
  15059. with this virtual table.
  15060. </param>
  15061. <param name="values">
  15062. The array of <see cref="T:System.Data.SQLite.SQLiteValue" /> object instances containing
  15063. the new or modified column values, if any.
  15064. </param>
  15065. <param name="rowId">
  15066. Upon success, this parameter must be modified to contain the unique
  15067. integer row identifier for the row that was inserted, if any.
  15068. </param>
  15069. <returns>
  15070. A standard SQLite return code.
  15071. </returns>
  15072. </member>
  15073. <member name="M:System.Data.SQLite.ISQLiteManagedModule.Begin(System.Data.SQLite.SQLiteVirtualTable)">
  15074. <summary>
  15075. This method is called in response to the
  15076. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xBegin(System.IntPtr)" /> method.
  15077. </summary>
  15078. <param name="table">
  15079. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object instance associated
  15080. with this virtual table.
  15081. </param>
  15082. <returns>
  15083. A standard SQLite return code.
  15084. </returns>
  15085. </member>
  15086. <member name="M:System.Data.SQLite.ISQLiteManagedModule.Sync(System.Data.SQLite.SQLiteVirtualTable)">
  15087. <summary>
  15088. This method is called in response to the
  15089. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xSync(System.IntPtr)" /> method.
  15090. </summary>
  15091. <param name="table">
  15092. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object instance associated
  15093. with this virtual table.
  15094. </param>
  15095. <returns>
  15096. A standard SQLite return code.
  15097. </returns>
  15098. </member>
  15099. <member name="M:System.Data.SQLite.ISQLiteManagedModule.Commit(System.Data.SQLite.SQLiteVirtualTable)">
  15100. <summary>
  15101. This method is called in response to the
  15102. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCommit(System.IntPtr)" /> method.
  15103. </summary>
  15104. <param name="table">
  15105. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object instance associated
  15106. with this virtual table.
  15107. </param>
  15108. <returns>
  15109. A standard SQLite return code.
  15110. </returns>
  15111. </member>
  15112. <member name="M:System.Data.SQLite.ISQLiteManagedModule.Rollback(System.Data.SQLite.SQLiteVirtualTable)">
  15113. <summary>
  15114. This method is called in response to the
  15115. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRollback(System.IntPtr)" /> method.
  15116. </summary>
  15117. <param name="table">
  15118. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object instance associated
  15119. with this virtual table.
  15120. </param>
  15121. <returns>
  15122. A standard SQLite return code.
  15123. </returns>
  15124. </member>
  15125. <member name="M:System.Data.SQLite.ISQLiteManagedModule.FindFunction(System.Data.SQLite.SQLiteVirtualTable,System.Int32,System.String,System.Data.SQLite.SQLiteFunction@,System.IntPtr@)">
  15126. <summary>
  15127. This method is called in response to the
  15128. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,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="argumentCount">
  15135. The number of arguments to the function being sought.
  15136. </param>
  15137. <param name="name">
  15138. The name of the function being sought.
  15139. </param>
  15140. <param name="function">
  15141. Upon success, this parameter must be modified to contain the
  15142. <see cref="T:System.Data.SQLite.SQLiteFunction" /> object instance responsible for
  15143. implementing the specified function.
  15144. </param>
  15145. <param name="pClientData">
  15146. Upon success, this parameter must be modified to contain the
  15147. native user-data pointer associated with
  15148. <paramref name="function" />.
  15149. </param>
  15150. <returns>
  15151. Non-zero if the specified function was found; zero otherwise.
  15152. </returns>
  15153. </member>
  15154. <member name="M:System.Data.SQLite.ISQLiteManagedModule.Rename(System.Data.SQLite.SQLiteVirtualTable,System.String)">
  15155. <summary>
  15156. This method is called in response to the
  15157. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRename(System.IntPtr,System.IntPtr)" /> method.
  15158. </summary>
  15159. <param name="table">
  15160. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object instance associated
  15161. with this virtual table.
  15162. </param>
  15163. <param name="newName">
  15164. The new name for the virtual table.
  15165. </param>
  15166. <returns>
  15167. A standard SQLite return code.
  15168. </returns>
  15169. </member>
  15170. <member name="M:System.Data.SQLite.ISQLiteManagedModule.Savepoint(System.Data.SQLite.SQLiteVirtualTable,System.Int32)">
  15171. <summary>
  15172. This method is called in response to the
  15173. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xSavepoint(System.IntPtr,System.Int32)" /> method.
  15174. </summary>
  15175. <param name="table">
  15176. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object instance associated
  15177. with this virtual table.
  15178. </param>
  15179. <param name="savepoint">
  15180. This is an integer identifier under which the the current state of
  15181. the virtual table should be saved.
  15182. </param>
  15183. <returns>
  15184. A standard SQLite return code.
  15185. </returns>
  15186. </member>
  15187. <member name="M:System.Data.SQLite.ISQLiteManagedModule.Release(System.Data.SQLite.SQLiteVirtualTable,System.Int32)">
  15188. <summary>
  15189. This method is called in response to the
  15190. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRelease(System.IntPtr,System.Int32)" /> method.
  15191. </summary>
  15192. <param name="table">
  15193. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object instance associated
  15194. with this virtual table.
  15195. </param>
  15196. <param name="savepoint">
  15197. This is an integer used to indicate that any saved states with an
  15198. identifier greater than or equal to this should be deleted by the
  15199. virtual table.
  15200. </param>
  15201. <returns>
  15202. A standard SQLite return code.
  15203. </returns>
  15204. </member>
  15205. <member name="M:System.Data.SQLite.ISQLiteManagedModule.RollbackTo(System.Data.SQLite.SQLiteVirtualTable,System.Int32)">
  15206. <summary>
  15207. This method is called in response to the
  15208. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRollbackTo(System.IntPtr,System.Int32)" /> method.
  15209. </summary>
  15210. <param name="table">
  15211. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object instance associated
  15212. with this virtual table.
  15213. </param>
  15214. <param name="savepoint">
  15215. This is an integer identifier used to specify a specific saved
  15216. state for the virtual table for it to restore itself back to, which
  15217. should also have the effect of deleting all saved states with an
  15218. integer identifier greater than this one.
  15219. </param>
  15220. <returns>
  15221. A standard SQLite return code.
  15222. </returns>
  15223. </member>
  15224. <member name="T:System.Data.SQLite.SQLiteMemory">
  15225. <summary>
  15226. This class contains static methods that are used to allocate,
  15227. manipulate, and free native memory provided by the SQLite core library.
  15228. </summary>
  15229. </member>
  15230. <member name="M:System.Data.SQLite.SQLiteMemory.CanUseSize64">
  15231. <summary>
  15232. Determines if the native sqlite3_msize() API can be used, based on
  15233. the available version of the SQLite core library.
  15234. </summary>
  15235. <returns>
  15236. Non-zero if the native sqlite3_msize() API is supported by the
  15237. SQLite core library.
  15238. </returns>
  15239. </member>
  15240. <member name="M:System.Data.SQLite.SQLiteMemory.Allocate(System.Int32)">
  15241. <summary>
  15242. Allocates at least the specified number of bytes of native memory
  15243. via the SQLite core library sqlite3_malloc() function and returns
  15244. the resulting native pointer. If the TRACK_MEMORY_BYTES option
  15245. was enabled at compile-time, adjusts the number of bytes currently
  15246. allocated by this class.
  15247. </summary>
  15248. <param name="size">
  15249. The number of bytes to allocate.
  15250. </param>
  15251. <returns>
  15252. The native pointer that points to a block of memory of at least the
  15253. specified size -OR- <see cref="F:System.IntPtr.Zero" /> if the memory could
  15254. not be allocated.
  15255. </returns>
  15256. </member>
  15257. <member name="M:System.Data.SQLite.SQLiteMemory.Allocate64(System.UInt64)">
  15258. <summary>
  15259. Allocates at least the specified number of bytes of native memory
  15260. via the SQLite core library sqlite3_malloc64() function and returns
  15261. the resulting native pointer. If the TRACK_MEMORY_BYTES option
  15262. was enabled at compile-time, adjusts the number of bytes currently
  15263. allocated by this class.
  15264. </summary>
  15265. <param name="size">
  15266. The number of bytes to allocate.
  15267. </param>
  15268. <returns>
  15269. The native pointer that points to a block of memory of at least the
  15270. specified size -OR- <see cref="F:System.IntPtr.Zero" /> if the memory could
  15271. not be allocated.
  15272. </returns>
  15273. </member>
  15274. <member name="M:System.Data.SQLite.SQLiteMemory.AllocateUntracked(System.Int32)">
  15275. <summary>
  15276. Allocates at least the specified number of bytes of native memory
  15277. via the SQLite core library sqlite3_malloc() function and returns
  15278. the resulting native pointer without adjusting the number of
  15279. allocated bytes currently tracked by this class. This is useful
  15280. when dealing with blocks of memory that will be freed directly by
  15281. the SQLite core library.
  15282. </summary>
  15283. <param name="size">
  15284. The number of bytes to allocate.
  15285. </param>
  15286. <returns>
  15287. The native pointer that points to a block of memory of at least the
  15288. specified size -OR- <see cref="F:System.IntPtr.Zero" /> if the memory could
  15289. not be allocated.
  15290. </returns>
  15291. </member>
  15292. <member name="M:System.Data.SQLite.SQLiteMemory.Allocate64Untracked(System.UInt64)">
  15293. <summary>
  15294. Allocates at least the specified number of bytes of native memory
  15295. via the SQLite core library sqlite3_malloc64() function and returns
  15296. the resulting native pointer without adjusting the number of
  15297. allocated bytes currently tracked by this class. This is useful
  15298. when dealing with blocks of memory that will be freed directly by
  15299. the SQLite core library.
  15300. </summary>
  15301. <param name="size">
  15302. The number of bytes to allocate.
  15303. </param>
  15304. <returns>
  15305. The native pointer that points to a block of memory of at least the
  15306. specified size -OR- <see cref="F:System.IntPtr.Zero" /> if the memory could
  15307. not be allocated.
  15308. </returns>
  15309. </member>
  15310. <member name="M:System.Data.SQLite.SQLiteMemory.Size(System.IntPtr)">
  15311. <summary>
  15312. Gets and returns the actual size of the specified memory block
  15313. that was previously obtained from the <see cref="M:System.Data.SQLite.SQLiteMemory.Allocate(System.Int32)" />,
  15314. <see cref="M:System.Data.SQLite.SQLiteMemory.Allocate64(System.UInt64)" />, <see cref="M:System.Data.SQLite.SQLiteMemory.AllocateUntracked(System.Int32)" />, or
  15315. <see cref="M:System.Data.SQLite.SQLiteMemory.Allocate64Untracked(System.UInt64)" /> methods or directly from the
  15316. SQLite core library.
  15317. </summary>
  15318. <param name="pMemory">
  15319. The native pointer to the memory block previously obtained from
  15320. the <see cref="M:System.Data.SQLite.SQLiteMemory.Allocate(System.Int32)" />, <see cref="M:System.Data.SQLite.SQLiteMemory.Allocate64(System.UInt64)" />,
  15321. <see cref="M:System.Data.SQLite.SQLiteMemory.AllocateUntracked(System.Int32)" />, or
  15322. <see cref="M:System.Data.SQLite.SQLiteMemory.Allocate64Untracked(System.UInt64)" /> methods or directly from the
  15323. SQLite core library.
  15324. </param>
  15325. <returns>
  15326. The actual size, in bytes, of the memory block specified via the
  15327. native pointer.
  15328. </returns>
  15329. </member>
  15330. <member name="M:System.Data.SQLite.SQLiteMemory.Size64(System.IntPtr)">
  15331. <summary>
  15332. Gets and returns the actual size of the specified memory block
  15333. that was previously obtained from the <see cref="M:System.Data.SQLite.SQLiteMemory.Allocate(System.Int32)" />,
  15334. <see cref="M:System.Data.SQLite.SQLiteMemory.Allocate64(System.UInt64)" />, <see cref="M:System.Data.SQLite.SQLiteMemory.AllocateUntracked(System.Int32)" />, or
  15335. <see cref="M:System.Data.SQLite.SQLiteMemory.Allocate64Untracked(System.UInt64)" /> methods or directly from the
  15336. SQLite core library.
  15337. </summary>
  15338. <param name="pMemory">
  15339. The native pointer to the memory block previously obtained from
  15340. the <see cref="M:System.Data.SQLite.SQLiteMemory.Allocate(System.Int32)" />, <see cref="M:System.Data.SQLite.SQLiteMemory.Allocate64(System.UInt64)" />,
  15341. <see cref="M:System.Data.SQLite.SQLiteMemory.AllocateUntracked(System.Int32)" />, or
  15342. <see cref="M:System.Data.SQLite.SQLiteMemory.Allocate64Untracked(System.UInt64)" /> methods or directly from the
  15343. SQLite core library.
  15344. </param>
  15345. <returns>
  15346. The actual size, in bytes, of the memory block specified via the
  15347. native pointer.
  15348. </returns>
  15349. </member>
  15350. <member name="M:System.Data.SQLite.SQLiteMemory.Free(System.IntPtr)">
  15351. <summary>
  15352. Frees a memory block previously obtained from the
  15353. <see cref="M:System.Data.SQLite.SQLiteMemory.Allocate(System.Int32)" /> or <see cref="M:System.Data.SQLite.SQLiteMemory.Allocate64(System.UInt64)" /> methods. If
  15354. the TRACK_MEMORY_BYTES option was enabled at compile-time, adjusts
  15355. the number of bytes currently allocated by this class.
  15356. </summary>
  15357. <param name="pMemory">
  15358. The native pointer to the memory block previously obtained from the
  15359. <see cref="M:System.Data.SQLite.SQLiteMemory.Allocate(System.Int32)" /> or <see cref="M:System.Data.SQLite.SQLiteMemory.Allocate64(System.UInt64)" /> methods.
  15360. </param>
  15361. </member>
  15362. <member name="M:System.Data.SQLite.SQLiteMemory.FreeUntracked(System.IntPtr)">
  15363. <summary>
  15364. Frees a memory block previously obtained from the SQLite core
  15365. library without adjusting the number of allocated bytes currently
  15366. tracked by this class. This is useful when dealing with blocks of
  15367. memory that were not allocated using this class.
  15368. </summary>
  15369. <param name="pMemory">
  15370. The native pointer to the memory block previously obtained from the
  15371. SQLite core library.
  15372. </param>
  15373. </member>
  15374. <member name="T:System.Data.SQLite.SQLiteString">
  15375. <summary>
  15376. This class contains static methods that are used to deal with native
  15377. UTF-8 string pointers to be used with the SQLite core library.
  15378. </summary>
  15379. </member>
  15380. <member name="F:System.Data.SQLite.SQLiteString.ThirtyBits">
  15381. <summary>
  15382. This is the maximum possible length for the native UTF-8 encoded
  15383. strings used with the SQLite core library.
  15384. </summary>
  15385. </member>
  15386. <member name="F:System.Data.SQLite.SQLiteString.Utf8Encoding">
  15387. <summary>
  15388. This is the <see cref="T:System.Text.Encoding" /> object instance used to handle
  15389. conversions from/to UTF-8.
  15390. </summary>
  15391. </member>
  15392. <member name="M:System.Data.SQLite.SQLiteString.GetUtf8BytesFromString(System.String)">
  15393. <summary>
  15394. Converts the specified managed string into the UTF-8 encoding and
  15395. returns the array of bytes containing its representation in that
  15396. encoding.
  15397. </summary>
  15398. <param name="value">
  15399. The managed string to convert.
  15400. </param>
  15401. <returns>
  15402. The array of bytes containing the representation of the managed
  15403. string in the UTF-8 encoding or null upon failure.
  15404. </returns>
  15405. </member>
  15406. <member name="M:System.Data.SQLite.SQLiteString.GetStringFromUtf8Bytes(System.Byte[])">
  15407. <summary>
  15408. Converts the specified array of bytes representing a string in the
  15409. UTF-8 encoding and returns a managed string.
  15410. </summary>
  15411. <param name="bytes">
  15412. The array of bytes to convert.
  15413. </param>
  15414. <returns>
  15415. The managed string or null upon failure.
  15416. </returns>
  15417. </member>
  15418. <member name="M:System.Data.SQLite.SQLiteString.ProbeForUtf8ByteLength(System.IntPtr,System.Int32)">
  15419. <summary>
  15420. Probes a native pointer to a string in the UTF-8 encoding for its
  15421. terminating NUL character, within the specified length limit.
  15422. </summary>
  15423. <param name="pValue">
  15424. The native NUL-terminated string pointer.
  15425. </param>
  15426. <param name="limit">
  15427. The maximum length of the native string, in bytes.
  15428. </param>
  15429. <returns>
  15430. The length of the native string, in bytes -OR- zero if the length
  15431. could not be determined.
  15432. </returns>
  15433. </member>
  15434. <member name="M:System.Data.SQLite.SQLiteString.StringFromUtf8IntPtr(System.IntPtr)">
  15435. <summary>
  15436. Converts the specified native NUL-terminated UTF-8 string pointer
  15437. into a managed string.
  15438. </summary>
  15439. <param name="pValue">
  15440. The native NUL-terminated UTF-8 string pointer.
  15441. </param>
  15442. <returns>
  15443. The managed string or null upon failure.
  15444. </returns>
  15445. </member>
  15446. <member name="M:System.Data.SQLite.SQLiteString.StringFromUtf8IntPtr(System.IntPtr,System.Int32)">
  15447. <summary>
  15448. Converts the specified native UTF-8 string pointer of the specified
  15449. length into a managed string.
  15450. </summary>
  15451. <param name="pValue">
  15452. The native UTF-8 string pointer.
  15453. </param>
  15454. <param name="length">
  15455. The length of the native string, in bytes.
  15456. </param>
  15457. <returns>
  15458. The managed string or null upon failure.
  15459. </returns>
  15460. </member>
  15461. <member name="M:System.Data.SQLite.SQLiteString.Utf8IntPtrFromString(System.String)">
  15462. <summary>
  15463. Converts the specified managed string into a native NUL-terminated
  15464. UTF-8 string pointer using memory obtained from the SQLite core
  15465. library.
  15466. </summary>
  15467. <param name="value">
  15468. The managed string to convert.
  15469. </param>
  15470. <returns>
  15471. The native NUL-terminated UTF-8 string pointer or
  15472. <see cref="F:System.IntPtr.Zero" /> upon failure.
  15473. </returns>
  15474. </member>
  15475. <member name="M:System.Data.SQLite.SQLiteString.Utf8IntPtrFromString(System.String,System.Boolean)">
  15476. <summary>
  15477. Converts the specified managed string into a native NUL-terminated
  15478. UTF-8 string pointer using memory obtained from the SQLite core
  15479. library.
  15480. </summary>
  15481. <param name="value">
  15482. The managed string to convert.
  15483. </param>
  15484. <param name="tracked">
  15485. Non-zero to obtain memory from the SQLite core library without
  15486. adjusting the number of allocated bytes currently being tracked
  15487. by the <see cref="T:System.Data.SQLite.SQLiteMemory" /> class.
  15488. </param>
  15489. <returns>
  15490. The native NUL-terminated UTF-8 string pointer or
  15491. <see cref="F:System.IntPtr.Zero" /> upon failure.
  15492. </returns>
  15493. </member>
  15494. <member name="M:System.Data.SQLite.SQLiteString.Utf8IntPtrFromString(System.String,System.Int32@)">
  15495. <summary>
  15496. Converts the specified managed string into a native NUL-terminated
  15497. UTF-8 string pointer using memory obtained from the SQLite core
  15498. library.
  15499. </summary>
  15500. <param name="value">
  15501. The managed string to convert.
  15502. </param>
  15503. <param name="length">
  15504. The length of the native string, in bytes.
  15505. </param>
  15506. <returns>
  15507. The native NUL-terminated UTF-8 string pointer or
  15508. <see cref="F:System.IntPtr.Zero" /> upon failure.
  15509. </returns>
  15510. </member>
  15511. <member name="M:System.Data.SQLite.SQLiteString.Utf8IntPtrFromString(System.String,System.Boolean,System.Int32@)">
  15512. <summary>
  15513. Converts the specified managed string into a native NUL-terminated
  15514. UTF-8 string pointer using memory obtained from the SQLite core
  15515. library.
  15516. </summary>
  15517. <param name="value">
  15518. The managed string to convert.
  15519. </param>
  15520. <param name="tracked">
  15521. Non-zero to obtain memory from the SQLite core library without
  15522. adjusting the number of allocated bytes currently being tracked
  15523. by the <see cref="T:System.Data.SQLite.SQLiteMemory" /> class.
  15524. </param>
  15525. <param name="length">
  15526. The length of the native string, in bytes.
  15527. </param>
  15528. <returns>
  15529. The native NUL-terminated UTF-8 string pointer or
  15530. <see cref="F:System.IntPtr.Zero" /> upon failure.
  15531. </returns>
  15532. </member>
  15533. <member name="M:System.Data.SQLite.SQLiteString.StringArrayFromUtf8SizeAndIntPtr(System.Int32,System.IntPtr)">
  15534. <summary>
  15535. Converts a logical array of native NUL-terminated UTF-8 string
  15536. pointers into an array of managed strings.
  15537. </summary>
  15538. <param name="argc">
  15539. The number of elements in the logical array of native
  15540. NUL-terminated UTF-8 string pointers.
  15541. </param>
  15542. <param name="argv">
  15543. The native pointer to the logical array of native NUL-terminated
  15544. UTF-8 string pointers to convert.
  15545. </param>
  15546. <returns>
  15547. The array of managed strings or null upon failure.
  15548. </returns>
  15549. </member>
  15550. <member name="M:System.Data.SQLite.SQLiteString.Utf8IntPtrArrayFromStringArray(System.String[],System.Boolean)">
  15551. <summary>
  15552. Converts an array of managed strings into an array of native
  15553. NUL-terminated UTF-8 string pointers.
  15554. </summary>
  15555. <param name="values">
  15556. The array of managed strings to convert.
  15557. </param>
  15558. <param name="tracked">
  15559. Non-zero to obtain memory from the SQLite core library without
  15560. adjusting the number of allocated bytes currently being tracked
  15561. by the <see cref="T:System.Data.SQLite.SQLiteMemory" /> class.
  15562. </param>
  15563. <returns>
  15564. The array of native NUL-terminated UTF-8 string pointers or null
  15565. upon failure.
  15566. </returns>
  15567. </member>
  15568. <member name="T:System.Data.SQLite.SQLiteBytes">
  15569. <summary>
  15570. This class contains static methods that are used to deal with native
  15571. pointers to memory blocks that logically contain arrays of bytes to be
  15572. used with the SQLite core library.
  15573. </summary>
  15574. </member>
  15575. <member name="M:System.Data.SQLite.SQLiteBytes.FromIntPtr(System.IntPtr,System.Int32)">
  15576. <summary>
  15577. Converts a native pointer to a logical array of bytes of the
  15578. specified length into a managed byte array.
  15579. </summary>
  15580. <param name="pValue">
  15581. The native pointer to the logical array of bytes to convert.
  15582. </param>
  15583. <param name="length">
  15584. The length, in bytes, of the logical array of bytes to convert.
  15585. </param>
  15586. <returns>
  15587. The managed byte array or null upon failure.
  15588. </returns>
  15589. </member>
  15590. <member name="M:System.Data.SQLite.SQLiteBytes.ToIntPtr(System.Byte[])">
  15591. <summary>
  15592. Converts a managed byte array into a native pointer to a logical
  15593. array of bytes.
  15594. </summary>
  15595. <param name="value">
  15596. The managed byte array to convert.
  15597. </param>
  15598. <returns>
  15599. The native pointer to a logical byte array or null upon failure.
  15600. </returns>
  15601. </member>
  15602. <member name="M:System.Data.SQLite.SQLiteBytes.ToIntPtr(System.Byte[],System.Int32@)">
  15603. <summary>
  15604. Converts a managed byte array into a native pointer to a logical
  15605. array of bytes.
  15606. </summary>
  15607. <param name="value">
  15608. The managed byte array to convert.
  15609. </param>
  15610. <param name="length">
  15611. The length, in bytes, of the converted logical array of bytes.
  15612. </param>
  15613. <returns>
  15614. The native pointer to a logical byte array or null upon failure.
  15615. </returns>
  15616. </member>
  15617. <member name="T:System.Data.SQLite.SQLiteMarshal">
  15618. <summary>
  15619. This class contains static methods that are used to perform several
  15620. low-level data marshalling tasks between native and managed code.
  15621. </summary>
  15622. </member>
  15623. <member name="M:System.Data.SQLite.SQLiteMarshal.IntPtrForOffset(System.IntPtr,System.Int32)">
  15624. <summary>
  15625. Returns a new <see cref="T:System.IntPtr" /> object instance based on the
  15626. specified <see cref="T:System.IntPtr" /> object instance and an integer
  15627. offset.
  15628. </summary>
  15629. <param name="pointer">
  15630. The <see cref="T:System.IntPtr" /> object instance representing the base
  15631. memory location.
  15632. </param>
  15633. <param name="offset">
  15634. The integer offset from the base memory location that the new
  15635. <see cref="T:System.IntPtr" /> object instance should point to.
  15636. </param>
  15637. <returns>
  15638. The new <see cref="T:System.IntPtr" /> object instance.
  15639. </returns>
  15640. </member>
  15641. <member name="M:System.Data.SQLite.SQLiteMarshal.RoundUp(System.Int32,System.Int32)">
  15642. <summary>
  15643. Rounds up an integer size to the next multiple of the alignment.
  15644. </summary>
  15645. <param name="size">
  15646. The size, in bytes, to be rounded up.
  15647. </param>
  15648. <param name="alignment">
  15649. The required alignment for the return value.
  15650. </param>
  15651. <returns>
  15652. The size, in bytes, rounded up to the next multiple of the
  15653. alignment. This value may end up being the same as the original
  15654. size.
  15655. </returns>
  15656. </member>
  15657. <member name="M:System.Data.SQLite.SQLiteMarshal.NextOffsetOf(System.Int32,System.Int32,System.Int32)">
  15658. <summary>
  15659. Determines the offset, in bytes, of the next structure member.
  15660. </summary>
  15661. <param name="offset">
  15662. The offset, in bytes, of the current structure member.
  15663. </param>
  15664. <param name="size">
  15665. The size, in bytes, of the current structure member.
  15666. </param>
  15667. <param name="alignment">
  15668. The alignment, in bytes, of the next structure member.
  15669. </param>
  15670. <returns>
  15671. The offset, in bytes, of the next structure member.
  15672. </returns>
  15673. </member>
  15674. <member name="M:System.Data.SQLite.SQLiteMarshal.ReadInt32(System.IntPtr,System.Int32)">
  15675. <summary>
  15676. Reads a <see cref="T:System.Int32" /> value from the specified memory
  15677. location.
  15678. </summary>
  15679. <param name="pointer">
  15680. The <see cref="T:System.IntPtr" /> object instance representing the base
  15681. memory location.
  15682. </param>
  15683. <param name="offset">
  15684. The integer offset from the base memory location where the
  15685. <see cref="T:System.Int32" /> value to be read is located.
  15686. </param>
  15687. <returns>
  15688. The <see cref="T:System.Int32" /> value at the specified memory location.
  15689. </returns>
  15690. </member>
  15691. <member name="M:System.Data.SQLite.SQLiteMarshal.ReadInt64(System.IntPtr,System.Int32)">
  15692. <summary>
  15693. Reads a <see cref="T:System.Int64" /> value from the specified memory
  15694. location.
  15695. </summary>
  15696. <param name="pointer">
  15697. The <see cref="T:System.IntPtr" /> object instance representing the base
  15698. memory location.
  15699. </param>
  15700. <param name="offset">
  15701. The integer offset from the base memory location where the
  15702. <see cref="T:System.Int64" /> value to be read is located.
  15703. </param>
  15704. <returns>
  15705. The <see cref="T:System.Int64" /> value at the specified memory location.
  15706. </returns>
  15707. </member>
  15708. <member name="M:System.Data.SQLite.SQLiteMarshal.ReadDouble(System.IntPtr,System.Int32)">
  15709. <summary>
  15710. Reads a <see cref="T:System.Double" /> value from the specified memory
  15711. location.
  15712. </summary>
  15713. <param name="pointer">
  15714. The <see cref="T:System.IntPtr" /> object instance representing the base
  15715. memory location.
  15716. </param>
  15717. <param name="offset">
  15718. The integer offset from the base memory location where the
  15719. <see cref="T:System.Double" /> to be read is located.
  15720. </param>
  15721. <returns>
  15722. The <see cref="T:System.Double" /> value at the specified memory location.
  15723. </returns>
  15724. </member>
  15725. <member name="M:System.Data.SQLite.SQLiteMarshal.ReadIntPtr(System.IntPtr,System.Int32)">
  15726. <summary>
  15727. Reads an <see cref="T:System.IntPtr" /> value from the specified memory
  15728. location.
  15729. </summary>
  15730. <param name="pointer">
  15731. The <see cref="T:System.IntPtr" /> object instance representing the base
  15732. memory location.
  15733. </param>
  15734. <param name="offset">
  15735. The integer offset from the base memory location where the
  15736. <see cref="T:System.IntPtr" /> value to be read is located.
  15737. </param>
  15738. <returns>
  15739. The <see cref="T:System.IntPtr" /> value at the specified memory location.
  15740. </returns>
  15741. </member>
  15742. <member name="M:System.Data.SQLite.SQLiteMarshal.WriteInt32(System.IntPtr,System.Int32,System.Int32)">
  15743. <summary>
  15744. Writes an <see cref="T:System.Int32" /> value to the specified memory
  15745. location.
  15746. </summary>
  15747. <param name="pointer">
  15748. The <see cref="T:System.IntPtr" /> object instance representing the base
  15749. memory location.
  15750. </param>
  15751. <param name="offset">
  15752. The integer offset from the base memory location where the
  15753. <see cref="T:System.Int32" /> value to be written is located.
  15754. </param>
  15755. <param name="value">
  15756. The <see cref="T:System.Int32" /> value to write.
  15757. </param>
  15758. </member>
  15759. <member name="M:System.Data.SQLite.SQLiteMarshal.WriteInt64(System.IntPtr,System.Int32,System.Int64)">
  15760. <summary>
  15761. Writes an <see cref="T:System.Int64" /> value to the specified memory
  15762. location.
  15763. </summary>
  15764. <param name="pointer">
  15765. The <see cref="T:System.IntPtr" /> object instance representing the base
  15766. memory location.
  15767. </param>
  15768. <param name="offset">
  15769. The integer offset from the base memory location where the
  15770. <see cref="T:System.Int64" /> value to be written is located.
  15771. </param>
  15772. <param name="value">
  15773. The <see cref="T:System.Int64" /> value to write.
  15774. </param>
  15775. </member>
  15776. <member name="M:System.Data.SQLite.SQLiteMarshal.WriteDouble(System.IntPtr,System.Int32,System.Double)">
  15777. <summary>
  15778. Writes a <see cref="T:System.Double" /> value to the specified memory
  15779. location.
  15780. </summary>
  15781. <param name="pointer">
  15782. The <see cref="T:System.IntPtr" /> object instance representing the base
  15783. memory location.
  15784. </param>
  15785. <param name="offset">
  15786. The integer offset from the base memory location where the
  15787. <see cref="T:System.Double" /> value to be written is located.
  15788. </param>
  15789. <param name="value">
  15790. The <see cref="T:System.Double" /> value to write.
  15791. </param>
  15792. </member>
  15793. <member name="M:System.Data.SQLite.SQLiteMarshal.WriteIntPtr(System.IntPtr,System.Int32,System.IntPtr)">
  15794. <summary>
  15795. Writes a <see cref="T:System.IntPtr" /> value to the specified memory
  15796. location.
  15797. </summary>
  15798. <param name="pointer">
  15799. The <see cref="T:System.IntPtr" /> object instance representing the base
  15800. memory location.
  15801. </param>
  15802. <param name="offset">
  15803. The integer offset from the base memory location where the
  15804. <see cref="T:System.IntPtr" /> value to be written is located.
  15805. </param>
  15806. <param name="value">
  15807. The <see cref="T:System.IntPtr" /> value to write.
  15808. </param>
  15809. </member>
  15810. <member name="M:System.Data.SQLite.SQLiteMarshal.GetHashCode(System.Object,System.Boolean)">
  15811. <summary>
  15812. Generates a hash code value for the object.
  15813. </summary>
  15814. <param name="value">
  15815. The object instance used to calculate the hash code.
  15816. </param>
  15817. <param name="identity">
  15818. Non-zero if different object instances with the same value should
  15819. generate different hash codes, where applicable. This parameter
  15820. has no effect on the .NET Compact Framework.
  15821. </param>
  15822. <returns>
  15823. The hash code value -OR- zero if the object is null.
  15824. </returns>
  15825. </member>
  15826. <member name="T:System.Data.SQLite.SQLiteModule">
  15827. <summary>
  15828. This class represents a managed virtual table module implementation.
  15829. It is not sealed and must be used as the base class for any
  15830. user-defined virtual table module classes implemented in managed code.
  15831. </summary>
  15832. </member>
  15833. <member name="T:System.Data.SQLite.SQLiteModule.SQLiteNativeModule">
  15834. <summary>
  15835. This class implements the <see cref="T:System.Data.SQLite.ISQLiteNativeModule" />
  15836. interface by forwarding those method calls to the
  15837. <see cref="T:System.Data.SQLite.SQLiteModule" /> object instance it contains. If the
  15838. contained <see cref="T:System.Data.SQLite.SQLiteModule" /> object instance is null, all
  15839. the <see cref="T:System.Data.SQLite.ISQLiteNativeModule" /> methods simply generate an
  15840. error.
  15841. </summary>
  15842. </member>
  15843. <member name="F:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.DefaultLogErrors">
  15844. <summary>
  15845. This is the value that is always used for the "logErrors"
  15846. parameter to the various static error handling methods provided
  15847. by the <see cref="T:System.Data.SQLite.SQLiteModule" /> class.
  15848. </summary>
  15849. </member>
  15850. <member name="F:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.DefaultLogExceptions">
  15851. <summary>
  15852. This is the value that is always used for the "logExceptions"
  15853. parameter to the various static error handling methods provided
  15854. by the <see cref="T:System.Data.SQLite.SQLiteModule" /> class.
  15855. </summary>
  15856. </member>
  15857. <member name="F:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.ModuleNotAvailableErrorMessage">
  15858. <summary>
  15859. This is the error message text used when the contained
  15860. <see cref="T:System.Data.SQLite.SQLiteModule" /> object instance is not available
  15861. for any reason.
  15862. </summary>
  15863. </member>
  15864. <member name="F:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.module">
  15865. <summary>
  15866. The <see cref="T:System.Data.SQLite.SQLiteModule" /> object instance used to provide
  15867. an implementation of the <see cref="T:System.Data.SQLite.ISQLiteNativeModule" />
  15868. interface.
  15869. </summary>
  15870. </member>
  15871. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.#ctor(System.Data.SQLite.SQLiteModule)">
  15872. <summary>
  15873. Constructs an instance of this class.
  15874. </summary>
  15875. <param name="module">
  15876. The <see cref="T:System.Data.SQLite.SQLiteModule" /> object instance used to provide
  15877. an implementation of the <see cref="T:System.Data.SQLite.ISQLiteNativeModule" />
  15878. interface.
  15879. </param>
  15880. </member>
  15881. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.ModuleNotAvailableTableError(System.IntPtr)">
  15882. <summary>
  15883. Sets the table error message to one that indicates the native
  15884. module implementation is not available.
  15885. </summary>
  15886. <param name="pVtab">
  15887. The native pointer to the sqlite3_vtab derived structure.
  15888. </param>
  15889. <returns>
  15890. The value of <see cref="F:System.Data.SQLite.SQLiteErrorCode.Error" />.
  15891. </returns>
  15892. </member>
  15893. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.ModuleNotAvailableCursorError(System.IntPtr)">
  15894. <summary>
  15895. Sets the table error message to one that indicates the native
  15896. module implementation is not available.
  15897. </summary>
  15898. <param name="pCursor">
  15899. The native pointer to the sqlite3_vtab_cursor derived
  15900. structure.
  15901. </param>
  15902. <returns>
  15903. The value of <see cref="F:System.Data.SQLite.SQLiteErrorCode.Error" />.
  15904. </returns>
  15905. </member>
  15906. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)">
  15907. <summary>
  15908. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> method.
  15909. </summary>
  15910. <param name="pDb">
  15911. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> method.
  15912. </param>
  15913. <param name="pAux">
  15914. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> method.
  15915. </param>
  15916. <param name="argc">
  15917. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> method.
  15918. </param>
  15919. <param name="argv">
  15920. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> method.
  15921. </param>
  15922. <param name="pVtab">
  15923. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> method.
  15924. </param>
  15925. <param name="pError">
  15926. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> method.
  15927. </param>
  15928. <returns>
  15929. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> method.
  15930. </returns>
  15931. </member>
  15932. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)">
  15933. <summary>
  15934. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> method.
  15935. </summary>
  15936. <param name="pDb">
  15937. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> method.
  15938. </param>
  15939. <param name="pAux">
  15940. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> method.
  15941. </param>
  15942. <param name="argc">
  15943. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> method.
  15944. </param>
  15945. <param name="argv">
  15946. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> method.
  15947. </param>
  15948. <param name="pVtab">
  15949. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> method.
  15950. </param>
  15951. <param name="pError">
  15952. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> method.
  15953. </param>
  15954. <returns>
  15955. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> method.
  15956. </returns>
  15957. </member>
  15958. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xBestIndex(System.IntPtr,System.IntPtr)">
  15959. <summary>
  15960. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xBestIndex(System.IntPtr,System.IntPtr)" /> method.
  15961. </summary>
  15962. <param name="pVtab">
  15963. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xBestIndex(System.IntPtr,System.IntPtr)" /> method.
  15964. </param>
  15965. <param name="pIndex">
  15966. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xBestIndex(System.IntPtr,System.IntPtr)" /> method.
  15967. </param>
  15968. <returns>
  15969. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xBestIndex(System.IntPtr,System.IntPtr)" /> method.
  15970. </returns>
  15971. </member>
  15972. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xDisconnect(System.IntPtr)">
  15973. <summary>
  15974. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDisconnect(System.IntPtr)" /> method.
  15975. </summary>
  15976. <param name="pVtab">
  15977. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDisconnect(System.IntPtr)" /> method.
  15978. </param>
  15979. <returns>
  15980. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDisconnect(System.IntPtr)" /> method.
  15981. </returns>
  15982. </member>
  15983. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xDestroy(System.IntPtr)">
  15984. <summary>
  15985. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDestroy(System.IntPtr)" /> method.
  15986. </summary>
  15987. <param name="pVtab">
  15988. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDestroy(System.IntPtr)" /> method.
  15989. </param>
  15990. <returns>
  15991. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDestroy(System.IntPtr)" /> method.
  15992. </returns>
  15993. </member>
  15994. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xOpen(System.IntPtr,System.IntPtr@)">
  15995. <summary>
  15996. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xOpen(System.IntPtr,System.IntPtr@)" /> method.
  15997. </summary>
  15998. <param name="pVtab">
  15999. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xOpen(System.IntPtr,System.IntPtr@)" /> method.
  16000. </param>
  16001. <param name="pCursor">
  16002. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xOpen(System.IntPtr,System.IntPtr@)" /> method.
  16003. </param>
  16004. <returns>
  16005. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xOpen(System.IntPtr,System.IntPtr@)" /> method.
  16006. </returns>
  16007. </member>
  16008. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xClose(System.IntPtr)">
  16009. <summary>
  16010. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xClose(System.IntPtr)" /> method.
  16011. </summary>
  16012. <param name="pCursor">
  16013. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xClose(System.IntPtr)" /> method.
  16014. </param>
  16015. <returns>
  16016. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xClose(System.IntPtr)" /> method.
  16017. </returns>
  16018. </member>
  16019. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xFilter(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)">
  16020. <summary>
  16021. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFilter(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)" /> method.
  16022. </summary>
  16023. <param name="pCursor">
  16024. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFilter(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)" /> method.
  16025. </param>
  16026. <param name="idxNum">
  16027. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFilter(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)" /> method.
  16028. </param>
  16029. <param name="idxStr">
  16030. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFilter(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)" /> method.
  16031. </param>
  16032. <param name="argc">
  16033. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFilter(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)" /> method.
  16034. </param>
  16035. <param name="argv">
  16036. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFilter(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)" /> method.
  16037. </param>
  16038. <returns>
  16039. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFilter(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)" /> method.
  16040. </returns>
  16041. </member>
  16042. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xNext(System.IntPtr)">
  16043. <summary>
  16044. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xNext(System.IntPtr)" /> method.
  16045. </summary>
  16046. <param name="pCursor">
  16047. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xNext(System.IntPtr)" /> method.
  16048. </param>
  16049. <returns>
  16050. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xNext(System.IntPtr)" /> method.
  16051. </returns>
  16052. </member>
  16053. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xEof(System.IntPtr)">
  16054. <summary>
  16055. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xEof(System.IntPtr)" /> method.
  16056. </summary>
  16057. <param name="pCursor">
  16058. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xEof(System.IntPtr)" /> method.
  16059. </param>
  16060. <returns>
  16061. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xEof(System.IntPtr)" /> method.
  16062. </returns>
  16063. </member>
  16064. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xColumn(System.IntPtr,System.IntPtr,System.Int32)">
  16065. <summary>
  16066. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xColumn(System.IntPtr,System.IntPtr,System.Int32)" /> method.
  16067. </summary>
  16068. <param name="pCursor">
  16069. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xColumn(System.IntPtr,System.IntPtr,System.Int32)" /> method.
  16070. </param>
  16071. <param name="pContext">
  16072. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xColumn(System.IntPtr,System.IntPtr,System.Int32)" /> method.
  16073. </param>
  16074. <param name="index">
  16075. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xColumn(System.IntPtr,System.IntPtr,System.Int32)" /> method.
  16076. </param>
  16077. <returns>
  16078. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xColumn(System.IntPtr,System.IntPtr,System.Int32)" /> method.
  16079. </returns>
  16080. </member>
  16081. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xRowId(System.IntPtr,System.Int64@)">
  16082. <summary>
  16083. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRowId(System.IntPtr,System.Int64@)" /> method.
  16084. </summary>
  16085. <param name="pCursor">
  16086. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRowId(System.IntPtr,System.Int64@)" /> method.
  16087. </param>
  16088. <param name="rowId">
  16089. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRowId(System.IntPtr,System.Int64@)" /> method.
  16090. </param>
  16091. <returns>
  16092. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRowId(System.IntPtr,System.Int64@)" /> method.
  16093. </returns>
  16094. </member>
  16095. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xUpdate(System.IntPtr,System.Int32,System.IntPtr,System.Int64@)">
  16096. <summary>
  16097. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xUpdate(System.IntPtr,System.Int32,System.IntPtr,System.Int64@)" /> method.
  16098. </summary>
  16099. <param name="pVtab">
  16100. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xUpdate(System.IntPtr,System.Int32,System.IntPtr,System.Int64@)" /> method.
  16101. </param>
  16102. <param name="argc">
  16103. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xUpdate(System.IntPtr,System.Int32,System.IntPtr,System.Int64@)" /> method.
  16104. </param>
  16105. <param name="argv">
  16106. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xUpdate(System.IntPtr,System.Int32,System.IntPtr,System.Int64@)" /> method.
  16107. </param>
  16108. <param name="rowId">
  16109. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xUpdate(System.IntPtr,System.Int32,System.IntPtr,System.Int64@)" /> method.
  16110. </param>
  16111. <returns>
  16112. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xUpdate(System.IntPtr,System.Int32,System.IntPtr,System.Int64@)" /> method.
  16113. </returns>
  16114. </member>
  16115. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xBegin(System.IntPtr)">
  16116. <summary>
  16117. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xBegin(System.IntPtr)" /> method.
  16118. </summary>
  16119. <param name="pVtab">
  16120. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xBegin(System.IntPtr)" /> method.
  16121. </param>
  16122. <returns>
  16123. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xBegin(System.IntPtr)" /> method.
  16124. </returns>
  16125. </member>
  16126. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xSync(System.IntPtr)">
  16127. <summary>
  16128. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xSync(System.IntPtr)" /> method.
  16129. </summary>
  16130. <param name="pVtab">
  16131. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xSync(System.IntPtr)" /> method.
  16132. </param>
  16133. <returns>
  16134. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xSync(System.IntPtr)" /> method.
  16135. </returns>
  16136. </member>
  16137. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xCommit(System.IntPtr)">
  16138. <summary>
  16139. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCommit(System.IntPtr)" /> method.
  16140. </summary>
  16141. <param name="pVtab">
  16142. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCommit(System.IntPtr)" /> method.
  16143. </param>
  16144. <returns>
  16145. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCommit(System.IntPtr)" /> method.
  16146. </returns>
  16147. </member>
  16148. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xRollback(System.IntPtr)">
  16149. <summary>
  16150. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRollback(System.IntPtr)" /> method.
  16151. </summary>
  16152. <param name="pVtab">
  16153. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRollback(System.IntPtr)" /> method.
  16154. </param>
  16155. <returns>
  16156. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRollback(System.IntPtr)" /> method.
  16157. </returns>
  16158. </member>
  16159. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,System.IntPtr@)">
  16160. <summary>
  16161. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,System.IntPtr@)" /> method.
  16162. </summary>
  16163. <param name="pVtab">
  16164. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,System.IntPtr@)" /> method.
  16165. </param>
  16166. <param name="nArg">
  16167. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,System.IntPtr@)" /> method.
  16168. </param>
  16169. <param name="zName">
  16170. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,System.IntPtr@)" /> method.
  16171. </param>
  16172. <param name="callback">
  16173. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,System.IntPtr@)" /> method.
  16174. </param>
  16175. <param name="pClientData">
  16176. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,System.IntPtr@)" /> method.
  16177. </param>
  16178. <returns>
  16179. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,System.IntPtr@)" /> method.
  16180. </returns>
  16181. </member>
  16182. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xRename(System.IntPtr,System.IntPtr)">
  16183. <summary>
  16184. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRename(System.IntPtr,System.IntPtr)" /> method.
  16185. </summary>
  16186. <param name="pVtab">
  16187. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRename(System.IntPtr,System.IntPtr)" /> method.
  16188. </param>
  16189. <param name="zNew">
  16190. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRename(System.IntPtr,System.IntPtr)" /> method.
  16191. </param>
  16192. <returns>
  16193. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRename(System.IntPtr,System.IntPtr)" /> method.
  16194. </returns>
  16195. </member>
  16196. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xSavepoint(System.IntPtr,System.Int32)">
  16197. <summary>
  16198. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xSavepoint(System.IntPtr,System.Int32)" /> method.
  16199. </summary>
  16200. <param name="pVtab">
  16201. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xSavepoint(System.IntPtr,System.Int32)" /> method.
  16202. </param>
  16203. <param name="iSavepoint">
  16204. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xSavepoint(System.IntPtr,System.Int32)" /> method.
  16205. </param>
  16206. <returns>
  16207. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xSavepoint(System.IntPtr,System.Int32)" /> method.
  16208. </returns>
  16209. </member>
  16210. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xRelease(System.IntPtr,System.Int32)">
  16211. <summary>
  16212. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRelease(System.IntPtr,System.Int32)" /> method.
  16213. </summary>
  16214. <param name="pVtab">
  16215. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRelease(System.IntPtr,System.Int32)" /> method.
  16216. </param>
  16217. <param name="iSavepoint">
  16218. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRelease(System.IntPtr,System.Int32)" /> method.
  16219. </param>
  16220. <returns>
  16221. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRelease(System.IntPtr,System.Int32)" /> method.
  16222. </returns>
  16223. </member>
  16224. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.xRollbackTo(System.IntPtr,System.Int32)">
  16225. <summary>
  16226. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRollbackTo(System.IntPtr,System.Int32)" /> method.
  16227. </summary>
  16228. <param name="pVtab">
  16229. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRollbackTo(System.IntPtr,System.Int32)" /> method.
  16230. </param>
  16231. <param name="iSavepoint">
  16232. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRollbackTo(System.IntPtr,System.Int32)" /> method.
  16233. </param>
  16234. <returns>
  16235. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRollbackTo(System.IntPtr,System.Int32)" /> method.
  16236. </returns>
  16237. </member>
  16238. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.Dispose">
  16239. <summary>
  16240. Disposes of this object instance.
  16241. </summary>
  16242. </member>
  16243. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.CheckDisposed">
  16244. <summary>
  16245. Throws an <see cref="T:System.ObjectDisposedException" /> if this object
  16246. instance has been disposed.
  16247. </summary>
  16248. </member>
  16249. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.Dispose(System.Boolean)">
  16250. <summary>
  16251. Disposes of this object instance.
  16252. </summary>
  16253. <param name="disposing">
  16254. Non-zero if this method is being called from the
  16255. <see cref="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.Dispose" /> method. Zero if this method is being
  16256. called from the finalizer.
  16257. </param>
  16258. </member>
  16259. <member name="M:System.Data.SQLite.SQLiteModule.SQLiteNativeModule.Finalize">
  16260. <summary>
  16261. Finalizes this object instance.
  16262. </summary>
  16263. </member>
  16264. <member name="F:System.Data.SQLite.SQLiteModule.DefaultModuleVersion">
  16265. <summary>
  16266. The default version of the native sqlite3_module structure in use.
  16267. </summary>
  16268. </member>
  16269. <member name="F:System.Data.SQLite.SQLiteModule.nativeModule">
  16270. <summary>
  16271. This field is used to store the native sqlite3_module structure
  16272. associated with this object instance.
  16273. </summary>
  16274. </member>
  16275. <member name="F:System.Data.SQLite.SQLiteModule.destroyModule">
  16276. <summary>
  16277. This field is used to store the destructor delegate to be passed to
  16278. the SQLite core library via the sqlite3_create_disposable_module()
  16279. function.
  16280. </summary>
  16281. </member>
  16282. <member name="F:System.Data.SQLite.SQLiteModule.disposableModule">
  16283. <summary>
  16284. This field is used to store a pointer to the native sqlite3_module
  16285. structure returned by the sqlite3_create_disposable_module
  16286. function.
  16287. </summary>
  16288. </member>
  16289. <member name="F:System.Data.SQLite.SQLiteModule.tables">
  16290. <summary>
  16291. This field is used to store the virtual table instances associated
  16292. with this module. The native pointer to the sqlite3_vtab derived
  16293. structure is used to key into this collection.
  16294. </summary>
  16295. </member>
  16296. <member name="F:System.Data.SQLite.SQLiteModule.cursors">
  16297. <summary>
  16298. This field is used to store the virtual table cursor instances
  16299. associated with this module. The native pointer to the
  16300. sqlite3_vtab_cursor derived structure is used to key into this
  16301. collection.
  16302. </summary>
  16303. </member>
  16304. <member name="F:System.Data.SQLite.SQLiteModule.functions">
  16305. <summary>
  16306. This field is used to store the virtual table function instances
  16307. associated with this module. The case-insensitive function name
  16308. and the number of arguments (with -1 meaning "any") are used to
  16309. construct the string that is used to key into this collection.
  16310. </summary>
  16311. </member>
  16312. <member name="M:System.Data.SQLite.SQLiteModule.#ctor(System.String)">
  16313. <summary>
  16314. Constructs an instance of this class.
  16315. </summary>
  16316. <param name="name">
  16317. The name of the module. This parameter cannot be null.
  16318. </param>
  16319. </member>
  16320. <member name="M:System.Data.SQLite.SQLiteModule.CreateDisposableModule(System.IntPtr)">
  16321. <summary>
  16322. Calls the native SQLite core library in order to create a new
  16323. disposable module containing the implementation of a virtual table.
  16324. </summary>
  16325. <param name="pDb">
  16326. The native database connection pointer to use.
  16327. </param>
  16328. <returns>
  16329. Non-zero upon success.
  16330. </returns>
  16331. </member>
  16332. <member name="M:System.Data.SQLite.SQLiteModule.xDestroyModule(System.IntPtr)">
  16333. <summary>
  16334. This method is called by the SQLite core library when the native
  16335. module associated with this object instance is being destroyed due
  16336. to its parent connection being closed. It may also be called by
  16337. the "vtshim" module if/when the sqlite3_dispose_module() function
  16338. is called.
  16339. </summary>
  16340. <param name="pClientData">
  16341. The native user-data pointer associated with this module, as it was
  16342. provided to the SQLite core library when the native module instance
  16343. was created.
  16344. </param>
  16345. </member>
  16346. <member name="M:System.Data.SQLite.SQLiteModule.AllocateNativeModule">
  16347. <summary>
  16348. Creates and returns the native sqlite_module structure using the
  16349. configured (or default) <see cref="T:System.Data.SQLite.ISQLiteNativeModule" />
  16350. interface implementation.
  16351. </summary>
  16352. <returns>
  16353. The native sqlite_module structure using the configured (or
  16354. default) <see cref="T:System.Data.SQLite.ISQLiteNativeModule" /> interface
  16355. implementation.
  16356. </returns>
  16357. </member>
  16358. <member name="M:System.Data.SQLite.SQLiteModule.AllocateNativeModule(System.Data.SQLite.ISQLiteNativeModule)">
  16359. <summary>
  16360. Creates and returns the native sqlite_module structure using the
  16361. specified <see cref="T:System.Data.SQLite.ISQLiteNativeModule" /> interface
  16362. implementation.
  16363. </summary>
  16364. <param name="module">
  16365. The <see cref="T:System.Data.SQLite.ISQLiteNativeModule" /> interface implementation to
  16366. use.
  16367. </param>
  16368. <returns>
  16369. The native sqlite_module structure using the specified
  16370. <see cref="T:System.Data.SQLite.ISQLiteNativeModule" /> interface implementation.
  16371. </returns>
  16372. </member>
  16373. <member name="M:System.Data.SQLite.SQLiteModule.CopyNativeModule(System.Data.SQLite.UnsafeNativeMethods.sqlite3_module)">
  16374. <summary>
  16375. Creates a copy of the specified
  16376. <see cref="T:System.Data.SQLite.UnsafeNativeMethods.sqlite3_module" /> object instance,
  16377. using default implementations for the contained delegates when
  16378. necessary.
  16379. </summary>
  16380. <param name="module">
  16381. The <see cref="T:System.Data.SQLite.UnsafeNativeMethods.sqlite3_module" /> object
  16382. instance to copy.
  16383. </param>
  16384. <returns>
  16385. The new <see cref="T:System.Data.SQLite.UnsafeNativeMethods.sqlite3_module" /> object
  16386. instance.
  16387. </returns>
  16388. </member>
  16389. <member name="M:System.Data.SQLite.SQLiteModule.CreateOrConnect(System.Boolean,System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)">
  16390. <summary>
  16391. Calls one of the virtual table initialization methods.
  16392. </summary>
  16393. <param name="create">
  16394. 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@)" />
  16395. 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@)" />
  16396. method will be called.
  16397. </param>
  16398. <param name="pDb">
  16399. The native database connection handle.
  16400. </param>
  16401. <param name="pAux">
  16402. The original native pointer value that was provided to the
  16403. sqlite3_create_module(), sqlite3_create_module_v2() or
  16404. sqlite3_create_disposable_module() functions.
  16405. </param>
  16406. <param name="argc">
  16407. The number of arguments from the CREATE VIRTUAL TABLE statement.
  16408. </param>
  16409. <param name="argv">
  16410. The array of string arguments from the CREATE VIRTUAL TABLE
  16411. statement.
  16412. </param>
  16413. <param name="pVtab">
  16414. Upon success, this parameter must be modified to point to the newly
  16415. created native sqlite3_vtab derived structure.
  16416. </param>
  16417. <param name="pError">
  16418. Upon failure, this parameter must be modified to point to the error
  16419. message, with the underlying memory having been obtained from the
  16420. sqlite3_malloc() function.
  16421. </param>
  16422. <returns>
  16423. A standard SQLite return code.
  16424. </returns>
  16425. </member>
  16426. <member name="M:System.Data.SQLite.SQLiteModule.DestroyOrDisconnect(System.Boolean,System.IntPtr)">
  16427. <summary>
  16428. Calls one of the virtual table finalization methods.
  16429. </summary>
  16430. <param name="destroy">
  16431. Non-zero to call the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Destroy(System.Data.SQLite.SQLiteVirtualTable)" />
  16432. method; otherwise, the
  16433. <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Disconnect(System.Data.SQLite.SQLiteVirtualTable)" /> method will be
  16434. called.
  16435. </param>
  16436. <param name="pVtab">
  16437. The native pointer to the sqlite3_vtab derived structure.
  16438. </param>
  16439. <returns>
  16440. A standard SQLite return code.
  16441. </returns>
  16442. </member>
  16443. <member name="M:System.Data.SQLite.SQLiteModule.SetTableError(System.Data.SQLite.SQLiteModule,System.IntPtr,System.Boolean,System.Boolean,System.String)">
  16444. <summary>
  16445. Arranges for the specified error message to be placed into the
  16446. zErrMsg field of a sqlite3_vtab derived structure, freeing the
  16447. existing error message, if any.
  16448. </summary>
  16449. <param name="module">
  16450. The <see cref="T:System.Data.SQLite.SQLiteModule" /> object instance to be used.
  16451. </param>
  16452. <param name="pVtab">
  16453. The native pointer to the sqlite3_vtab derived structure.
  16454. </param>
  16455. <param name="logErrors">
  16456. Non-zero if this error message should also be logged using the
  16457. <see cref="T:System.Data.SQLite.SQLiteLog" /> class.
  16458. </param>
  16459. <param name="logExceptions">
  16460. Non-zero if caught exceptions should be logged using the
  16461. <see cref="T:System.Data.SQLite.SQLiteLog" /> class.
  16462. </param>
  16463. <param name="error">
  16464. The error message.
  16465. </param>
  16466. <returns>
  16467. Non-zero upon success.
  16468. </returns>
  16469. </member>
  16470. <member name="M:System.Data.SQLite.SQLiteModule.SetTableError(System.Data.SQLite.SQLiteModule,System.Data.SQLite.SQLiteVirtualTable,System.Boolean,System.Boolean,System.String)">
  16471. <summary>
  16472. Arranges for the specified error message to be placed into the
  16473. zErrMsg field of a sqlite3_vtab derived structure, freeing the
  16474. existing error message, if any.
  16475. </summary>
  16476. <param name="module">
  16477. The <see cref="T:System.Data.SQLite.SQLiteModule" /> object instance to be used.
  16478. </param>
  16479. <param name="table">
  16480. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object instance used to
  16481. lookup the native pointer to the sqlite3_vtab derived structure.
  16482. </param>
  16483. <param name="logErrors">
  16484. Non-zero if this error message should also be logged using the
  16485. <see cref="T:System.Data.SQLite.SQLiteLog" /> class.
  16486. </param>
  16487. <param name="logExceptions">
  16488. Non-zero if caught exceptions should be logged using the
  16489. <see cref="T:System.Data.SQLite.SQLiteLog" /> class.
  16490. </param>
  16491. <param name="error">
  16492. The error message.
  16493. </param>
  16494. <returns>
  16495. Non-zero upon success.
  16496. </returns>
  16497. </member>
  16498. <member name="M:System.Data.SQLite.SQLiteModule.SetCursorError(System.Data.SQLite.SQLiteModule,System.IntPtr,System.Boolean,System.Boolean,System.String)">
  16499. <summary>
  16500. Arranges for the specified error message to be placed into the
  16501. zErrMsg field of a sqlite3_vtab derived structure, freeing the
  16502. existing error message, if any.
  16503. </summary>
  16504. <param name="module">
  16505. The <see cref="T:System.Data.SQLite.SQLiteModule" /> object instance to be used.
  16506. </param>
  16507. <param name="pCursor">
  16508. The native pointer to the sqlite3_vtab_cursor derived structure
  16509. used to get the native pointer to the sqlite3_vtab derived
  16510. structure.
  16511. </param>
  16512. <param name="logErrors">
  16513. Non-zero if this error message should also be logged using the
  16514. <see cref="T:System.Data.SQLite.SQLiteLog" /> class.
  16515. </param>
  16516. <param name="logExceptions">
  16517. Non-zero if caught exceptions should be logged using the
  16518. <see cref="T:System.Data.SQLite.SQLiteLog" /> class.
  16519. </param>
  16520. <param name="error">
  16521. The error message.
  16522. </param>
  16523. <returns>
  16524. Non-zero upon success.
  16525. </returns>
  16526. </member>
  16527. <member name="M:System.Data.SQLite.SQLiteModule.SetCursorError(System.Data.SQLite.SQLiteModule,System.Data.SQLite.SQLiteVirtualTableCursor,System.Boolean,System.Boolean,System.String)">
  16528. <summary>
  16529. Arranges for the specified error message to be placed into the
  16530. zErrMsg field of a sqlite3_vtab derived structure, freeing the
  16531. existing error message, if any.
  16532. </summary>
  16533. <param name="module">
  16534. The <see cref="T:System.Data.SQLite.SQLiteModule" /> object instance to be used.
  16535. </param>
  16536. <param name="cursor">
  16537. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor" /> object instance used to
  16538. lookup the native pointer to the sqlite3_vtab derived structure.
  16539. </param>
  16540. <param name="logErrors">
  16541. Non-zero if this error message should also be logged using the
  16542. <see cref="T:System.Data.SQLite.SQLiteLog" /> class.
  16543. </param>
  16544. <param name="logExceptions">
  16545. Non-zero if caught exceptions should be logged using the
  16546. <see cref="T:System.Data.SQLite.SQLiteLog" /> class.
  16547. </param>
  16548. <param name="error">
  16549. The error message.
  16550. </param>
  16551. <returns>
  16552. Non-zero upon success.
  16553. </returns>
  16554. </member>
  16555. <member name="M:System.Data.SQLite.SQLiteModule.GetNativeModuleImpl">
  16556. <summary>
  16557. Gets and returns the <see cref="T:System.Data.SQLite.ISQLiteNativeModule" /> interface
  16558. implementation to be used when creating the native sqlite3_module
  16559. structure. Derived classes may override this method to supply an
  16560. alternate implementation for the <see cref="T:System.Data.SQLite.ISQLiteNativeModule" />
  16561. interface.
  16562. </summary>
  16563. <returns>
  16564. The <see cref="T:System.Data.SQLite.ISQLiteNativeModule" /> interface implementation to
  16565. be used when populating the native sqlite3_module structure. If
  16566. the returned value is null, the private methods provided by the
  16567. <see cref="T:System.Data.SQLite.SQLiteModule" /> class and relating to the
  16568. <see cref="T:System.Data.SQLite.ISQLiteNativeModule" /> interface will be used to
  16569. create the necessary delegates.
  16570. </returns>
  16571. </member>
  16572. <member name="M:System.Data.SQLite.SQLiteModule.CreateNativeModuleImpl">
  16573. <summary>
  16574. Creates and returns the <see cref="T:System.Data.SQLite.ISQLiteNativeModule" />
  16575. interface implementation corresponding to the current
  16576. <see cref="T:System.Data.SQLite.SQLiteModule" /> object instance.
  16577. </summary>
  16578. <returns>
  16579. The <see cref="T:System.Data.SQLite.ISQLiteNativeModule" /> interface implementation
  16580. corresponding to the current <see cref="T:System.Data.SQLite.SQLiteModule" /> object
  16581. instance.
  16582. </returns>
  16583. </member>
  16584. <member name="M:System.Data.SQLite.SQLiteModule.AllocateTable">
  16585. <summary>
  16586. Allocates a native sqlite3_vtab derived structure and returns a
  16587. native pointer to it.
  16588. </summary>
  16589. <returns>
  16590. A native pointer to a native sqlite3_vtab derived structure.
  16591. </returns>
  16592. </member>
  16593. <member name="M:System.Data.SQLite.SQLiteModule.ZeroTable(System.IntPtr)">
  16594. <summary>
  16595. Zeros out the fields of a native sqlite3_vtab derived structure.
  16596. </summary>
  16597. <param name="pVtab">
  16598. The native pointer to the native sqlite3_vtab derived structure to
  16599. zero.
  16600. </param>
  16601. </member>
  16602. <member name="M:System.Data.SQLite.SQLiteModule.FreeTable(System.IntPtr)">
  16603. <summary>
  16604. Frees a native sqlite3_vtab structure using the provided native
  16605. pointer to it.
  16606. </summary>
  16607. <param name="pVtab">
  16608. A native pointer to a native sqlite3_vtab derived structure.
  16609. </param>
  16610. </member>
  16611. <member name="M:System.Data.SQLite.SQLiteModule.AllocateCursor">
  16612. <summary>
  16613. Allocates a native sqlite3_vtab_cursor derived structure and
  16614. returns a native pointer to it.
  16615. </summary>
  16616. <returns>
  16617. A native pointer to a native sqlite3_vtab_cursor derived structure.
  16618. </returns>
  16619. </member>
  16620. <member name="M:System.Data.SQLite.SQLiteModule.FreeCursor(System.IntPtr)">
  16621. <summary>
  16622. Frees a native sqlite3_vtab_cursor structure using the provided
  16623. native pointer to it.
  16624. </summary>
  16625. <param name="pCursor">
  16626. A native pointer to a native sqlite3_vtab_cursor derived structure.
  16627. </param>
  16628. </member>
  16629. <member name="M:System.Data.SQLite.SQLiteModule.TableFromCursor(System.Data.SQLite.SQLiteModule,System.IntPtr)">
  16630. <summary>
  16631. Reads and returns the native pointer to the sqlite3_vtab derived
  16632. structure based on the native pointer to the sqlite3_vtab_cursor
  16633. derived structure.
  16634. </summary>
  16635. <param name="module">
  16636. The <see cref="T:System.Data.SQLite.SQLiteModule" /> object instance to be used.
  16637. </param>
  16638. <param name="pCursor">
  16639. The native pointer to the sqlite3_vtab_cursor derived structure
  16640. from which to read the native pointer to the sqlite3_vtab derived
  16641. structure.
  16642. </param>
  16643. <returns>
  16644. The native pointer to the sqlite3_vtab derived structure -OR-
  16645. <see cref="F:System.IntPtr.Zero" /> if it cannot be determined.
  16646. </returns>
  16647. </member>
  16648. <member name="M:System.Data.SQLite.SQLiteModule.TableFromCursor(System.IntPtr)">
  16649. <summary>
  16650. Reads and returns the native pointer to the sqlite3_vtab derived
  16651. structure based on the native pointer to the sqlite3_vtab_cursor
  16652. derived structure.
  16653. </summary>
  16654. <param name="pCursor">
  16655. The native pointer to the sqlite3_vtab_cursor derived structure
  16656. from which to read the native pointer to the sqlite3_vtab derived
  16657. structure.
  16658. </param>
  16659. <returns>
  16660. The native pointer to the sqlite3_vtab derived structure -OR-
  16661. <see cref="F:System.IntPtr.Zero" /> if it cannot be determined.
  16662. </returns>
  16663. </member>
  16664. <member name="M:System.Data.SQLite.SQLiteModule.TableFromIntPtr(System.IntPtr)">
  16665. <summary>
  16666. Looks up and returns the <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object
  16667. instance based on the native pointer to the sqlite3_vtab derived
  16668. structure.
  16669. </summary>
  16670. <param name="pVtab">
  16671. The native pointer to the sqlite3_vtab derived structure.
  16672. </param>
  16673. <returns>
  16674. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object instance or null if
  16675. the corresponding one cannot be found.
  16676. </returns>
  16677. </member>
  16678. <member name="M:System.Data.SQLite.SQLiteModule.TableToIntPtr(System.Data.SQLite.SQLiteVirtualTable)">
  16679. <summary>
  16680. Allocates and returns a native pointer to a sqlite3_vtab derived
  16681. structure and creates an association between it and the specified
  16682. <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object instance.
  16683. </summary>
  16684. <param name="table">
  16685. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object instance to be used
  16686. when creating the association.
  16687. </param>
  16688. <returns>
  16689. The native pointer to a sqlite3_vtab derived structure or
  16690. <see cref="F:System.IntPtr.Zero" /> if the method fails for any reason.
  16691. </returns>
  16692. </member>
  16693. <member name="M:System.Data.SQLite.SQLiteModule.CursorFromIntPtr(System.IntPtr,System.IntPtr)">
  16694. <summary>
  16695. Looks up and returns the <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor" />
  16696. object instance based on the native pointer to the
  16697. sqlite3_vtab_cursor derived structure.
  16698. </summary>
  16699. <param name="pVtab">
  16700. The native pointer to the sqlite3_vtab derived structure.
  16701. </param>
  16702. <param name="pCursor">
  16703. The native pointer to the sqlite3_vtab_cursor derived structure.
  16704. </param>
  16705. <returns>
  16706. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor" /> object instance or null
  16707. if the corresponding one cannot be found.
  16708. </returns>
  16709. </member>
  16710. <member name="M:System.Data.SQLite.SQLiteModule.CursorToIntPtr(System.Data.SQLite.SQLiteVirtualTableCursor)">
  16711. <summary>
  16712. Allocates and returns a native pointer to a sqlite3_vtab_cursor
  16713. derived structure and creates an association between it and the
  16714. specified <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor" /> object instance.
  16715. </summary>
  16716. <param name="cursor">
  16717. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor" /> object instance to be
  16718. used when creating the association.
  16719. </param>
  16720. <returns>
  16721. The native pointer to a sqlite3_vtab_cursor derived structure or
  16722. <see cref="F:System.IntPtr.Zero" /> if the method fails for any reason.
  16723. </returns>
  16724. </member>
  16725. <member name="M:System.Data.SQLite.SQLiteModule.GetFunctionKey(System.Int32,System.String,System.Data.SQLite.SQLiteFunction)">
  16726. <summary>
  16727. Deterimines the key that should be used to identify and store the
  16728. <see cref="T:System.Data.SQLite.SQLiteFunction" /> object instance for the virtual table
  16729. (i.e. to be returned via the
  16730. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,System.IntPtr@)" /> method).
  16731. </summary>
  16732. <param name="argumentCount">
  16733. The number of arguments to the virtual table function.
  16734. </param>
  16735. <param name="name">
  16736. The name of the virtual table function.
  16737. </param>
  16738. <param name="function">
  16739. The <see cref="T:System.Data.SQLite.SQLiteFunction" /> object instance associated with
  16740. this virtual table function.
  16741. </param>
  16742. <returns>
  16743. The string that should be used to identify and store the virtual
  16744. table function instance. This method cannot return null. If null
  16745. is returned from this method, the behavior is undefined.
  16746. </returns>
  16747. </member>
  16748. <member name="M:System.Data.SQLite.SQLiteModule.DeclareTable(System.Data.SQLite.SQLiteConnection,System.String,System.String@)">
  16749. <summary>
  16750. Attempts to declare the schema for the virtual table using the
  16751. specified database connection.
  16752. </summary>
  16753. <param name="connection">
  16754. The <see cref="T:System.Data.SQLite.SQLiteConnection" /> object instance to use when
  16755. declaring the schema of the virtual table. This parameter may not
  16756. be null.
  16757. </param>
  16758. <param name="sql">
  16759. The string containing the CREATE TABLE statement that completely
  16760. describes the schema for the virtual table. This parameter may not
  16761. be null.
  16762. </param>
  16763. <param name="error">
  16764. Upon failure, this parameter must be modified to contain an error
  16765. message.
  16766. </param>
  16767. <returns>
  16768. A standard SQLite return code.
  16769. </returns>
  16770. </member>
  16771. <member name="M:System.Data.SQLite.SQLiteModule.DeclareFunction(System.Data.SQLite.SQLiteConnection,System.Int32,System.String,System.String@)">
  16772. <summary>
  16773. Calls the native SQLite core library in order to declare a virtual
  16774. table function in response to a call into the
  16775. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" />
  16776. or <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> virtual table
  16777. methods.
  16778. </summary>
  16779. <param name="connection">
  16780. The <see cref="T:System.Data.SQLite.SQLiteConnection" /> object instance to use when
  16781. declaring the schema of the virtual table.
  16782. </param>
  16783. <param name="argumentCount">
  16784. The number of arguments to the function being declared.
  16785. </param>
  16786. <param name="name">
  16787. The name of the function being declared.
  16788. </param>
  16789. <param name="error">
  16790. Upon success, the contents of this parameter are undefined. Upon
  16791. failure, it should contain an appropriate error message.
  16792. </param>
  16793. <returns>
  16794. A standard SQLite return code.
  16795. </returns>
  16796. </member>
  16797. <member name="P:System.Data.SQLite.SQLiteModule.LogErrorsNoThrow">
  16798. <summary>
  16799. Returns or sets a boolean value indicating whether virtual table
  16800. errors should be logged using the <see cref="T:System.Data.SQLite.SQLiteLog" /> class.
  16801. </summary>
  16802. </member>
  16803. <member name="P:System.Data.SQLite.SQLiteModule.LogExceptionsNoThrow">
  16804. <summary>
  16805. Returns or sets a boolean value indicating whether exceptions
  16806. caught in the
  16807. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDisconnect(System.IntPtr)" /> method,
  16808. the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDestroy(System.IntPtr)" /> method,
  16809. the <see cref="M:System.Data.SQLite.SQLiteModule.SetTableError(System.IntPtr,System.String)" /> method,
  16810. the <see cref="M:System.Data.SQLite.SQLiteModule.SetTableError(System.Data.SQLite.SQLiteVirtualTable,System.String)" /> method,
  16811. and the <see cref="M:System.Data.SQLite.SQLiteModule.Dispose" /> method should be logged using the
  16812. <see cref="T:System.Data.SQLite.SQLiteLog" /> class.
  16813. </summary>
  16814. </member>
  16815. <member name="M:System.Data.SQLite.SQLiteModule.SetTableError(System.IntPtr,System.String)">
  16816. <summary>
  16817. Arranges for the specified error message to be placed into the
  16818. zErrMsg field of a sqlite3_vtab derived structure, freeing the
  16819. existing error message, if any.
  16820. </summary>
  16821. <param name="pVtab">
  16822. The native pointer to the sqlite3_vtab derived structure.
  16823. </param>
  16824. <param name="error">
  16825. The error message.
  16826. </param>
  16827. <returns>
  16828. Non-zero upon success.
  16829. </returns>
  16830. </member>
  16831. <member name="M:System.Data.SQLite.SQLiteModule.SetTableError(System.Data.SQLite.SQLiteVirtualTable,System.String)">
  16832. <summary>
  16833. Arranges for the specified error message to be placed into the
  16834. zErrMsg field of a sqlite3_vtab derived structure, freeing the
  16835. existing error message, if any.
  16836. </summary>
  16837. <param name="table">
  16838. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object instance used to
  16839. lookup the native pointer to the sqlite3_vtab derived structure.
  16840. </param>
  16841. <param name="error">
  16842. The error message.
  16843. </param>
  16844. <returns>
  16845. Non-zero upon success.
  16846. </returns>
  16847. </member>
  16848. <member name="M:System.Data.SQLite.SQLiteModule.SetCursorError(System.Data.SQLite.SQLiteVirtualTableCursor,System.String)">
  16849. <summary>
  16850. Arranges for the specified error message to be placed into the
  16851. zErrMsg field of a sqlite3_vtab derived structure, freeing the
  16852. existing error message, if any.
  16853. </summary>
  16854. <param name="cursor">
  16855. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor" /> object instance used to
  16856. lookup the native pointer to the sqlite3_vtab derived structure.
  16857. </param>
  16858. <param name="error">
  16859. The error message.
  16860. </param>
  16861. <returns>
  16862. Non-zero upon success.
  16863. </returns>
  16864. </member>
  16865. <member name="M:System.Data.SQLite.SQLiteModule.SetEstimatedCost(System.Data.SQLite.SQLiteIndex,System.Nullable{System.Double})">
  16866. <summary>
  16867. Modifies the specified <see cref="T:System.Data.SQLite.SQLiteIndex" /> object instance
  16868. to contain the specified estimated cost.
  16869. </summary>
  16870. <param name="index">
  16871. The <see cref="T:System.Data.SQLite.SQLiteIndex" /> object instance to modify.
  16872. </param>
  16873. <param name="estimatedCost">
  16874. The estimated cost value to use. Using a null value means that the
  16875. default value provided by the SQLite core library should be used.
  16876. </param>
  16877. <returns>
  16878. Non-zero upon success.
  16879. </returns>
  16880. </member>
  16881. <member name="M:System.Data.SQLite.SQLiteModule.SetEstimatedCost(System.Data.SQLite.SQLiteIndex)">
  16882. <summary>
  16883. Modifies the specified <see cref="T:System.Data.SQLite.SQLiteIndex" /> object instance
  16884. to contain the default estimated cost.
  16885. </summary>
  16886. <param name="index">
  16887. The <see cref="T:System.Data.SQLite.SQLiteIndex" /> object instance to modify.
  16888. </param>
  16889. <returns>
  16890. Non-zero upon success.
  16891. </returns>
  16892. </member>
  16893. <member name="M:System.Data.SQLite.SQLiteModule.SetEstimatedRows(System.Data.SQLite.SQLiteIndex,System.Nullable{System.Int64})">
  16894. <summary>
  16895. Modifies the specified <see cref="T:System.Data.SQLite.SQLiteIndex" /> object instance
  16896. to contain the specified estimated rows.
  16897. </summary>
  16898. <param name="index">
  16899. The <see cref="T:System.Data.SQLite.SQLiteIndex" /> object instance to modify.
  16900. </param>
  16901. <param name="estimatedRows">
  16902. The estimated rows value to use. Using a null value means that the
  16903. default value provided by the SQLite core library should be used.
  16904. </param>
  16905. <returns>
  16906. Non-zero upon success.
  16907. </returns>
  16908. </member>
  16909. <member name="M:System.Data.SQLite.SQLiteModule.SetEstimatedRows(System.Data.SQLite.SQLiteIndex)">
  16910. <summary>
  16911. Modifies the specified <see cref="T:System.Data.SQLite.SQLiteIndex" /> object instance
  16912. to contain the default estimated rows.
  16913. </summary>
  16914. <param name="index">
  16915. The <see cref="T:System.Data.SQLite.SQLiteIndex" /> object instance to modify.
  16916. </param>
  16917. <returns>
  16918. Non-zero upon success.
  16919. </returns>
  16920. </member>
  16921. <member name="M:System.Data.SQLite.SQLiteModule.SetIndexFlags(System.Data.SQLite.SQLiteIndex,System.Nullable{System.Data.SQLite.SQLiteIndexFlags})">
  16922. <summary>
  16923. Modifies the specified <see cref="T:System.Data.SQLite.SQLiteIndex" /> object instance
  16924. to contain the specified flags.
  16925. </summary>
  16926. <param name="index">
  16927. The <see cref="T:System.Data.SQLite.SQLiteIndex" /> object instance to modify.
  16928. </param>
  16929. <param name="indexFlags">
  16930. The index flags value to use. Using a null value means that the
  16931. default value provided by the SQLite core library should be used.
  16932. </param>
  16933. <returns>
  16934. Non-zero upon success.
  16935. </returns>
  16936. </member>
  16937. <member name="M:System.Data.SQLite.SQLiteModule.SetIndexFlags(System.Data.SQLite.SQLiteIndex)">
  16938. <summary>
  16939. Modifies the specified <see cref="T:System.Data.SQLite.SQLiteIndex" /> object instance
  16940. to contain the default index flags.
  16941. </summary>
  16942. <param name="index">
  16943. The <see cref="T:System.Data.SQLite.SQLiteIndex" /> object instance to modify.
  16944. </param>
  16945. <returns>
  16946. Non-zero upon success.
  16947. </returns>
  16948. </member>
  16949. <member name="P:System.Data.SQLite.SQLiteModule.LogErrors">
  16950. <summary>
  16951. Returns or sets a boolean value indicating whether virtual table
  16952. errors should be logged using the <see cref="T:System.Data.SQLite.SQLiteLog" /> class.
  16953. </summary>
  16954. </member>
  16955. <member name="P:System.Data.SQLite.SQLiteModule.LogExceptions">
  16956. <summary>
  16957. Returns or sets a boolean value indicating whether exceptions
  16958. caught in the
  16959. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDisconnect(System.IntPtr)" /> method,
  16960. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDestroy(System.IntPtr)" /> method, and the
  16961. <see cref="M:System.Data.SQLite.SQLiteModule.Dispose" /> method should be logged using the
  16962. <see cref="T:System.Data.SQLite.SQLiteLog" /> class.
  16963. </summary>
  16964. </member>
  16965. <member name="M:System.Data.SQLite.SQLiteModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)">
  16966. <summary>
  16967. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> method.
  16968. </summary>
  16969. <param name="pDb">
  16970. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> method.
  16971. </param>
  16972. <param name="pAux">
  16973. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> method.
  16974. </param>
  16975. <param name="argc">
  16976. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> method.
  16977. </param>
  16978. <param name="argv">
  16979. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> method.
  16980. </param>
  16981. <param name="pVtab">
  16982. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> method.
  16983. </param>
  16984. <param name="pError">
  16985. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> method.
  16986. </param>
  16987. <returns>
  16988. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> method.
  16989. </returns>
  16990. </member>
  16991. <member name="M:System.Data.SQLite.SQLiteModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)">
  16992. <summary>
  16993. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> method.
  16994. </summary>
  16995. <param name="pDb">
  16996. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> method.
  16997. </param>
  16998. <param name="pAux">
  16999. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> method.
  17000. </param>
  17001. <param name="argc">
  17002. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> method.
  17003. </param>
  17004. <param name="argv">
  17005. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> method.
  17006. </param>
  17007. <param name="pVtab">
  17008. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> method.
  17009. </param>
  17010. <param name="pError">
  17011. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> method.
  17012. </param>
  17013. <returns>
  17014. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> method.
  17015. </returns>
  17016. </member>
  17017. <member name="M:System.Data.SQLite.SQLiteModule.xBestIndex(System.IntPtr,System.IntPtr)">
  17018. <summary>
  17019. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xBestIndex(System.IntPtr,System.IntPtr)" /> method.
  17020. </summary>
  17021. <param name="pVtab">
  17022. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xBestIndex(System.IntPtr,System.IntPtr)" /> method.
  17023. </param>
  17024. <param name="pIndex">
  17025. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xBestIndex(System.IntPtr,System.IntPtr)" /> method.
  17026. </param>
  17027. <returns>
  17028. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xBestIndex(System.IntPtr,System.IntPtr)" /> method.
  17029. </returns>
  17030. </member>
  17031. <member name="M:System.Data.SQLite.SQLiteModule.xDisconnect(System.IntPtr)">
  17032. <summary>
  17033. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDisconnect(System.IntPtr)" /> method.
  17034. </summary>
  17035. <param name="pVtab">
  17036. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDisconnect(System.IntPtr)" /> method.
  17037. </param>
  17038. <returns>
  17039. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDisconnect(System.IntPtr)" /> method.
  17040. </returns>
  17041. </member>
  17042. <member name="M:System.Data.SQLite.SQLiteModule.xDestroy(System.IntPtr)">
  17043. <summary>
  17044. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDestroy(System.IntPtr)" /> method.
  17045. </summary>
  17046. <param name="pVtab">
  17047. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDestroy(System.IntPtr)" /> method.
  17048. </param>
  17049. <returns>
  17050. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDestroy(System.IntPtr)" /> method.
  17051. </returns>
  17052. </member>
  17053. <member name="M:System.Data.SQLite.SQLiteModule.xOpen(System.IntPtr,System.IntPtr@)">
  17054. <summary>
  17055. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xOpen(System.IntPtr,System.IntPtr@)" /> method.
  17056. </summary>
  17057. <param name="pVtab">
  17058. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xOpen(System.IntPtr,System.IntPtr@)" /> method.
  17059. </param>
  17060. <param name="pCursor">
  17061. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xOpen(System.IntPtr,System.IntPtr@)" /> method.
  17062. </param>
  17063. <returns>
  17064. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xOpen(System.IntPtr,System.IntPtr@)" /> method.
  17065. </returns>
  17066. </member>
  17067. <member name="M:System.Data.SQLite.SQLiteModule.xClose(System.IntPtr)">
  17068. <summary>
  17069. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xClose(System.IntPtr)" /> method.
  17070. </summary>
  17071. <param name="pCursor">
  17072. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xClose(System.IntPtr)" /> method.
  17073. </param>
  17074. <returns>
  17075. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xClose(System.IntPtr)" /> method.
  17076. </returns>
  17077. </member>
  17078. <member name="M:System.Data.SQLite.SQLiteModule.xFilter(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)">
  17079. <summary>
  17080. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFilter(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)" /> method.
  17081. </summary>
  17082. <param name="pCursor">
  17083. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFilter(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)" /> method.
  17084. </param>
  17085. <param name="idxNum">
  17086. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFilter(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)" /> method.
  17087. </param>
  17088. <param name="idxStr">
  17089. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFilter(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)" /> method.
  17090. </param>
  17091. <param name="argc">
  17092. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFilter(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)" /> method.
  17093. </param>
  17094. <param name="argv">
  17095. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFilter(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)" /> method.
  17096. </param>
  17097. <returns>
  17098. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFilter(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)" /> method.
  17099. </returns>
  17100. </member>
  17101. <member name="M:System.Data.SQLite.SQLiteModule.xNext(System.IntPtr)">
  17102. <summary>
  17103. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xNext(System.IntPtr)" /> method.
  17104. </summary>
  17105. <param name="pCursor">
  17106. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xNext(System.IntPtr)" /> method.
  17107. </param>
  17108. <returns>
  17109. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xNext(System.IntPtr)" /> method.
  17110. </returns>
  17111. </member>
  17112. <member name="M:System.Data.SQLite.SQLiteModule.xEof(System.IntPtr)">
  17113. <summary>
  17114. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xEof(System.IntPtr)" /> method.
  17115. </summary>
  17116. <param name="pCursor">
  17117. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xEof(System.IntPtr)" /> method.
  17118. </param>
  17119. <returns>
  17120. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xEof(System.IntPtr)" /> method.
  17121. </returns>
  17122. </member>
  17123. <member name="M:System.Data.SQLite.SQLiteModule.xColumn(System.IntPtr,System.IntPtr,System.Int32)">
  17124. <summary>
  17125. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xColumn(System.IntPtr,System.IntPtr,System.Int32)" /> method.
  17126. </summary>
  17127. <param name="pCursor">
  17128. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xColumn(System.IntPtr,System.IntPtr,System.Int32)" /> method.
  17129. </param>
  17130. <param name="pContext">
  17131. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xColumn(System.IntPtr,System.IntPtr,System.Int32)" /> method.
  17132. </param>
  17133. <param name="index">
  17134. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xColumn(System.IntPtr,System.IntPtr,System.Int32)" /> method.
  17135. </param>
  17136. <returns>
  17137. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xColumn(System.IntPtr,System.IntPtr,System.Int32)" /> method.
  17138. </returns>
  17139. </member>
  17140. <member name="M:System.Data.SQLite.SQLiteModule.xRowId(System.IntPtr,System.Int64@)">
  17141. <summary>
  17142. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRowId(System.IntPtr,System.Int64@)" /> method.
  17143. </summary>
  17144. <param name="pCursor">
  17145. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRowId(System.IntPtr,System.Int64@)" /> method.
  17146. </param>
  17147. <param name="rowId">
  17148. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRowId(System.IntPtr,System.Int64@)" /> method.
  17149. </param>
  17150. <returns>
  17151. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRowId(System.IntPtr,System.Int64@)" /> method.
  17152. </returns>
  17153. </member>
  17154. <member name="M:System.Data.SQLite.SQLiteModule.xUpdate(System.IntPtr,System.Int32,System.IntPtr,System.Int64@)">
  17155. <summary>
  17156. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xUpdate(System.IntPtr,System.Int32,System.IntPtr,System.Int64@)" /> method.
  17157. </summary>
  17158. <param name="pVtab">
  17159. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xUpdate(System.IntPtr,System.Int32,System.IntPtr,System.Int64@)" /> method.
  17160. </param>
  17161. <param name="argc">
  17162. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xUpdate(System.IntPtr,System.Int32,System.IntPtr,System.Int64@)" /> method.
  17163. </param>
  17164. <param name="argv">
  17165. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xUpdate(System.IntPtr,System.Int32,System.IntPtr,System.Int64@)" /> method.
  17166. </param>
  17167. <param name="rowId">
  17168. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xUpdate(System.IntPtr,System.Int32,System.IntPtr,System.Int64@)" /> method.
  17169. </param>
  17170. <returns>
  17171. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xUpdate(System.IntPtr,System.Int32,System.IntPtr,System.Int64@)" /> method.
  17172. </returns>
  17173. </member>
  17174. <member name="M:System.Data.SQLite.SQLiteModule.xBegin(System.IntPtr)">
  17175. <summary>
  17176. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xBegin(System.IntPtr)" /> method.
  17177. </summary>
  17178. <param name="pVtab">
  17179. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xBegin(System.IntPtr)" /> method.
  17180. </param>
  17181. <returns>
  17182. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xBegin(System.IntPtr)" /> method.
  17183. </returns>
  17184. </member>
  17185. <member name="M:System.Data.SQLite.SQLiteModule.xSync(System.IntPtr)">
  17186. <summary>
  17187. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xSync(System.IntPtr)" /> method.
  17188. </summary>
  17189. <param name="pVtab">
  17190. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xSync(System.IntPtr)" /> method.
  17191. </param>
  17192. <returns>
  17193. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xSync(System.IntPtr)" /> method.
  17194. </returns>
  17195. </member>
  17196. <member name="M:System.Data.SQLite.SQLiteModule.xCommit(System.IntPtr)">
  17197. <summary>
  17198. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCommit(System.IntPtr)" /> method.
  17199. </summary>
  17200. <param name="pVtab">
  17201. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCommit(System.IntPtr)" /> method.
  17202. </param>
  17203. <returns>
  17204. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCommit(System.IntPtr)" /> method.
  17205. </returns>
  17206. </member>
  17207. <member name="M:System.Data.SQLite.SQLiteModule.xRollback(System.IntPtr)">
  17208. <summary>
  17209. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRollback(System.IntPtr)" /> method.
  17210. </summary>
  17211. <param name="pVtab">
  17212. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRollback(System.IntPtr)" /> method.
  17213. </param>
  17214. <returns>
  17215. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRollback(System.IntPtr)" /> method.
  17216. </returns>
  17217. </member>
  17218. <member name="M:System.Data.SQLite.SQLiteModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,System.IntPtr@)">
  17219. <summary>
  17220. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,System.IntPtr@)" /> method.
  17221. </summary>
  17222. <param name="pVtab">
  17223. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,System.IntPtr@)" /> method.
  17224. </param>
  17225. <param name="nArg">
  17226. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,System.IntPtr@)" /> method.
  17227. </param>
  17228. <param name="zName">
  17229. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,System.IntPtr@)" /> method.
  17230. </param>
  17231. <param name="callback">
  17232. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,System.IntPtr@)" /> method.
  17233. </param>
  17234. <param name="pClientData">
  17235. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,System.IntPtr@)" /> method.
  17236. </param>
  17237. <returns>
  17238. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,System.IntPtr@)" /> method.
  17239. </returns>
  17240. </member>
  17241. <member name="M:System.Data.SQLite.SQLiteModule.xRename(System.IntPtr,System.IntPtr)">
  17242. <summary>
  17243. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRename(System.IntPtr,System.IntPtr)" /> method.
  17244. </summary>
  17245. <param name="pVtab">
  17246. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRename(System.IntPtr,System.IntPtr)" /> method.
  17247. </param>
  17248. <param name="zNew">
  17249. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRename(System.IntPtr,System.IntPtr)" /> method.
  17250. </param>
  17251. <returns>
  17252. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRename(System.IntPtr,System.IntPtr)" /> method.
  17253. </returns>
  17254. </member>
  17255. <member name="M:System.Data.SQLite.SQLiteModule.xSavepoint(System.IntPtr,System.Int32)">
  17256. <summary>
  17257. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xSavepoint(System.IntPtr,System.Int32)" /> method.
  17258. </summary>
  17259. <param name="pVtab">
  17260. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xSavepoint(System.IntPtr,System.Int32)" /> method.
  17261. </param>
  17262. <param name="iSavepoint">
  17263. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xSavepoint(System.IntPtr,System.Int32)" /> method.
  17264. </param>
  17265. <returns>
  17266. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xSavepoint(System.IntPtr,System.Int32)" /> method.
  17267. </returns>
  17268. </member>
  17269. <member name="M:System.Data.SQLite.SQLiteModule.xRelease(System.IntPtr,System.Int32)">
  17270. <summary>
  17271. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRelease(System.IntPtr,System.Int32)" /> method.
  17272. </summary>
  17273. <param name="pVtab">
  17274. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRelease(System.IntPtr,System.Int32)" /> method.
  17275. </param>
  17276. <param name="iSavepoint">
  17277. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRelease(System.IntPtr,System.Int32)" /> method.
  17278. </param>
  17279. <returns>
  17280. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRelease(System.IntPtr,System.Int32)" /> method.
  17281. </returns>
  17282. </member>
  17283. <member name="M:System.Data.SQLite.SQLiteModule.xRollbackTo(System.IntPtr,System.Int32)">
  17284. <summary>
  17285. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRollbackTo(System.IntPtr,System.Int32)" /> method.
  17286. </summary>
  17287. <param name="pVtab">
  17288. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRollbackTo(System.IntPtr,System.Int32)" /> method.
  17289. </param>
  17290. <param name="iSavepoint">
  17291. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRollbackTo(System.IntPtr,System.Int32)" /> method.
  17292. </param>
  17293. <returns>
  17294. See the <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRollbackTo(System.IntPtr,System.Int32)" /> method.
  17295. </returns>
  17296. </member>
  17297. <member name="P:System.Data.SQLite.SQLiteModule.Declared">
  17298. <summary>
  17299. Returns non-zero if the schema for the virtual table has been
  17300. declared.
  17301. </summary>
  17302. </member>
  17303. <member name="P:System.Data.SQLite.SQLiteModule.Name">
  17304. <summary>
  17305. Returns the name of the module as it was registered with the SQLite
  17306. core library.
  17307. </summary>
  17308. </member>
  17309. <member name="M:System.Data.SQLite.SQLiteModule.Create(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)">
  17310. <summary>
  17311. This method is called in response to the
  17312. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCreate(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> method.
  17313. </summary>
  17314. <param name="connection">
  17315. The <see cref="T:System.Data.SQLite.SQLiteConnection" /> object instance associated with
  17316. the virtual table.
  17317. </param>
  17318. <param name="pClientData">
  17319. The native user-data pointer associated with this module, as it was
  17320. provided to the SQLite core library when the native module instance
  17321. was created.
  17322. </param>
  17323. <param name="arguments">
  17324. The module name, database name, virtual table name, and all other
  17325. arguments passed to the CREATE VIRTUAL TABLE statement.
  17326. </param>
  17327. <param name="table">
  17328. Upon success, this parameter must be modified to contain the
  17329. <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object instance associated with
  17330. the virtual table.
  17331. </param>
  17332. <param name="error">
  17333. Upon failure, this parameter must be modified to contain an error
  17334. message.
  17335. </param>
  17336. <returns>
  17337. A standard SQLite return code.
  17338. </returns>
  17339. </member>
  17340. <member name="M:System.Data.SQLite.SQLiteModule.Connect(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)">
  17341. <summary>
  17342. This method is called in response to the
  17343. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xConnect(System.IntPtr,System.IntPtr,System.Int32,System.IntPtr,System.IntPtr@,System.IntPtr@)" /> method.
  17344. </summary>
  17345. <param name="connection">
  17346. The <see cref="T:System.Data.SQLite.SQLiteConnection" /> object instance associated with
  17347. the virtual table.
  17348. </param>
  17349. <param name="pClientData">
  17350. The native user-data pointer associated with this module, as it was
  17351. provided to the SQLite core library when the native module instance
  17352. was created.
  17353. </param>
  17354. <param name="arguments">
  17355. The module name, database name, virtual table name, and all other
  17356. arguments passed to the CREATE VIRTUAL TABLE statement.
  17357. </param>
  17358. <param name="table">
  17359. Upon success, this parameter must be modified to contain the
  17360. <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object instance associated with
  17361. the virtual table.
  17362. </param>
  17363. <param name="error">
  17364. Upon failure, this parameter must be modified to contain an error
  17365. message.
  17366. </param>
  17367. <returns>
  17368. A standard SQLite return code.
  17369. </returns>
  17370. </member>
  17371. <member name="M:System.Data.SQLite.SQLiteModule.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)">
  17372. <summary>
  17373. This method is called in response to the
  17374. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xBestIndex(System.IntPtr,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. <param name="index">
  17381. The <see cref="T:System.Data.SQLite.SQLiteIndex" /> object instance containing all the
  17382. data for the inputs and outputs relating to index selection.
  17383. </param>
  17384. <returns>
  17385. A standard SQLite return code.
  17386. </returns>
  17387. </member>
  17388. <member name="M:System.Data.SQLite.SQLiteModule.Disconnect(System.Data.SQLite.SQLiteVirtualTable)">
  17389. <summary>
  17390. This method is called in response to the
  17391. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDisconnect(System.IntPtr)" /> method.
  17392. </summary>
  17393. <param name="table">
  17394. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object instance associated
  17395. with this virtual table.
  17396. </param>
  17397. <returns>
  17398. A standard SQLite return code.
  17399. </returns>
  17400. </member>
  17401. <member name="M:System.Data.SQLite.SQLiteModule.Destroy(System.Data.SQLite.SQLiteVirtualTable)">
  17402. <summary>
  17403. This method is called in response to the
  17404. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xDestroy(System.IntPtr)" /> method.
  17405. </summary>
  17406. <param name="table">
  17407. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object instance associated
  17408. with this virtual table.
  17409. </param>
  17410. <returns>
  17411. A standard SQLite return code.
  17412. </returns>
  17413. </member>
  17414. <member name="M:System.Data.SQLite.SQLiteModule.Open(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteVirtualTableCursor@)">
  17415. <summary>
  17416. This method is called in response to the
  17417. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xOpen(System.IntPtr,System.IntPtr@)" /> method.
  17418. </summary>
  17419. <param name="table">
  17420. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object instance associated
  17421. with this virtual table.
  17422. </param>
  17423. <param name="cursor">
  17424. Upon success, this parameter must be modified to contain the
  17425. <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor" /> object instance associated
  17426. with the newly opened virtual table cursor.
  17427. </param>
  17428. <returns>
  17429. A standard SQLite return code.
  17430. </returns>
  17431. </member>
  17432. <member name="M:System.Data.SQLite.SQLiteModule.Close(System.Data.SQLite.SQLiteVirtualTableCursor)">
  17433. <summary>
  17434. This method is called in response to the
  17435. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xClose(System.IntPtr)" /> method.
  17436. </summary>
  17437. <param name="cursor">
  17438. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor" /> object instance
  17439. associated with the previously opened virtual table cursor to be
  17440. used.
  17441. </param>
  17442. <returns>
  17443. A standard SQLite return code.
  17444. </returns>
  17445. </member>
  17446. <member name="M:System.Data.SQLite.SQLiteModule.Filter(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int32,System.String,System.Data.SQLite.SQLiteValue[])">
  17447. <summary>
  17448. This method is called in response to the
  17449. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFilter(System.IntPtr,System.Int32,System.IntPtr,System.Int32,System.IntPtr)" /> method.
  17450. </summary>
  17451. <param name="cursor">
  17452. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor" /> object instance
  17453. associated with the previously opened virtual table cursor to be
  17454. used.
  17455. </param>
  17456. <param name="indexNumber">
  17457. Number used to help identify the selected index.
  17458. </param>
  17459. <param name="indexString">
  17460. String used to help identify the selected index.
  17461. </param>
  17462. <param name="values">
  17463. The values corresponding to each column in the selected index.
  17464. </param>
  17465. <returns>
  17466. A standard SQLite return code.
  17467. </returns>
  17468. </member>
  17469. <member name="M:System.Data.SQLite.SQLiteModule.Next(System.Data.SQLite.SQLiteVirtualTableCursor)">
  17470. <summary>
  17471. This method is called in response to the
  17472. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xNext(System.IntPtr)" /> method.
  17473. </summary>
  17474. <param name="cursor">
  17475. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor" /> object instance
  17476. associated with the previously opened virtual table cursor to be
  17477. used.
  17478. </param>
  17479. <returns>
  17480. A standard SQLite return code.
  17481. </returns>
  17482. </member>
  17483. <member name="M:System.Data.SQLite.SQLiteModule.Eof(System.Data.SQLite.SQLiteVirtualTableCursor)">
  17484. <summary>
  17485. This method is called in response to the
  17486. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xEof(System.IntPtr)" /> method.
  17487. </summary>
  17488. <param name="cursor">
  17489. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor" /> object instance
  17490. associated with the previously opened virtual table cursor to be
  17491. used.
  17492. </param>
  17493. <returns>
  17494. Non-zero if no more rows are available; zero otherwise.
  17495. </returns>
  17496. </member>
  17497. <member name="M:System.Data.SQLite.SQLiteModule.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)">
  17498. <summary>
  17499. This method is called in response to the
  17500. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xColumn(System.IntPtr,System.IntPtr,System.Int32)" /> method.
  17501. </summary>
  17502. <param name="cursor">
  17503. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor" /> object instance
  17504. associated with the previously opened virtual table cursor to be
  17505. used.
  17506. </param>
  17507. <param name="context">
  17508. The <see cref="T:System.Data.SQLite.SQLiteContext" /> object instance to be used for
  17509. returning the specified column value to the SQLite core library.
  17510. </param>
  17511. <param name="index">
  17512. The zero-based index corresponding to the column containing the
  17513. value to be returned.
  17514. </param>
  17515. <returns>
  17516. A standard SQLite return code.
  17517. </returns>
  17518. </member>
  17519. <member name="M:System.Data.SQLite.SQLiteModule.RowId(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int64@)">
  17520. <summary>
  17521. This method is called in response to the
  17522. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRowId(System.IntPtr,System.Int64@)" /> method.
  17523. </summary>
  17524. <param name="cursor">
  17525. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor" /> object instance
  17526. associated with the previously opened virtual table cursor to be
  17527. used.
  17528. </param>
  17529. <param name="rowId">
  17530. Upon success, this parameter must be modified to contain the unique
  17531. integer row identifier for the current row for the specified cursor.
  17532. </param>
  17533. <returns>
  17534. A standard SQLite return code.
  17535. </returns>
  17536. </member>
  17537. <member name="M:System.Data.SQLite.SQLiteModule.Update(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteValue[],System.Int64@)">
  17538. <summary>
  17539. This method is called in response to the
  17540. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xUpdate(System.IntPtr,System.Int32,System.IntPtr,System.Int64@)" /> method.
  17541. </summary>
  17542. <param name="table">
  17543. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object instance associated
  17544. with this virtual table.
  17545. </param>
  17546. <param name="values">
  17547. The array of <see cref="T:System.Data.SQLite.SQLiteValue" /> object instances containing
  17548. the new or modified column values, if any.
  17549. </param>
  17550. <param name="rowId">
  17551. Upon success, this parameter must be modified to contain the unique
  17552. integer row identifier for the row that was inserted, if any.
  17553. </param>
  17554. <returns>
  17555. A standard SQLite return code.
  17556. </returns>
  17557. </member>
  17558. <member name="M:System.Data.SQLite.SQLiteModule.Begin(System.Data.SQLite.SQLiteVirtualTable)">
  17559. <summary>
  17560. This method is called in response to the
  17561. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xBegin(System.IntPtr)" /> method.
  17562. </summary>
  17563. <param name="table">
  17564. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object instance associated
  17565. with this virtual table.
  17566. </param>
  17567. <returns>
  17568. A standard SQLite return code.
  17569. </returns>
  17570. </member>
  17571. <member name="M:System.Data.SQLite.SQLiteModule.Sync(System.Data.SQLite.SQLiteVirtualTable)">
  17572. <summary>
  17573. This method is called in response to the
  17574. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xSync(System.IntPtr)" /> method.
  17575. </summary>
  17576. <param name="table">
  17577. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object instance associated
  17578. with this virtual table.
  17579. </param>
  17580. <returns>
  17581. A standard SQLite return code.
  17582. </returns>
  17583. </member>
  17584. <member name="M:System.Data.SQLite.SQLiteModule.Commit(System.Data.SQLite.SQLiteVirtualTable)">
  17585. <summary>
  17586. This method is called in response to the
  17587. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xCommit(System.IntPtr)" /> method.
  17588. </summary>
  17589. <param name="table">
  17590. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object instance associated
  17591. with this virtual table.
  17592. </param>
  17593. <returns>
  17594. A standard SQLite return code.
  17595. </returns>
  17596. </member>
  17597. <member name="M:System.Data.SQLite.SQLiteModule.Rollback(System.Data.SQLite.SQLiteVirtualTable)">
  17598. <summary>
  17599. This method is called in response to the
  17600. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRollback(System.IntPtr)" /> method.
  17601. </summary>
  17602. <param name="table">
  17603. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object instance associated
  17604. with this virtual table.
  17605. </param>
  17606. <returns>
  17607. A standard SQLite return code.
  17608. </returns>
  17609. </member>
  17610. <member name="M:System.Data.SQLite.SQLiteModule.FindFunction(System.Data.SQLite.SQLiteVirtualTable,System.Int32,System.String,System.Data.SQLite.SQLiteFunction@,System.IntPtr@)">
  17611. <summary>
  17612. This method is called in response to the
  17613. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xFindFunction(System.IntPtr,System.Int32,System.IntPtr,System.Data.SQLite.SQLiteCallback@,System.IntPtr@)" /> method.
  17614. </summary>
  17615. <param name="table">
  17616. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object instance associated
  17617. with this virtual table.
  17618. </param>
  17619. <param name="argumentCount">
  17620. The number of arguments to the function being sought.
  17621. </param>
  17622. <param name="name">
  17623. The name of the function being sought.
  17624. </param>
  17625. <param name="function">
  17626. Upon success, this parameter must be modified to contain the
  17627. <see cref="T:System.Data.SQLite.SQLiteFunction" /> object instance responsible for
  17628. implementing the specified function.
  17629. </param>
  17630. <param name="pClientData">
  17631. Upon success, this parameter must be modified to contain the
  17632. native user-data pointer associated with
  17633. <paramref name="function" />.
  17634. </param>
  17635. <returns>
  17636. Non-zero if the specified function was found; zero otherwise.
  17637. </returns>
  17638. </member>
  17639. <member name="M:System.Data.SQLite.SQLiteModule.Rename(System.Data.SQLite.SQLiteVirtualTable,System.String)">
  17640. <summary>
  17641. This method is called in response to the
  17642. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRename(System.IntPtr,System.IntPtr)" /> method.
  17643. </summary>
  17644. <param name="table">
  17645. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object instance associated
  17646. with this virtual table.
  17647. </param>
  17648. <param name="newName">
  17649. The new name for the virtual table.
  17650. </param>
  17651. <returns>
  17652. A standard SQLite return code.
  17653. </returns>
  17654. </member>
  17655. <member name="M:System.Data.SQLite.SQLiteModule.Savepoint(System.Data.SQLite.SQLiteVirtualTable,System.Int32)">
  17656. <summary>
  17657. This method is called in response to the
  17658. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xSavepoint(System.IntPtr,System.Int32)" /> method.
  17659. </summary>
  17660. <param name="table">
  17661. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object instance associated
  17662. with this virtual table.
  17663. </param>
  17664. <param name="savepoint">
  17665. This is an integer identifier under which the the current state of
  17666. the virtual table should be saved.
  17667. </param>
  17668. <returns>
  17669. A standard SQLite return code.
  17670. </returns>
  17671. </member>
  17672. <member name="M:System.Data.SQLite.SQLiteModule.Release(System.Data.SQLite.SQLiteVirtualTable,System.Int32)">
  17673. <summary>
  17674. This method is called in response to the
  17675. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRelease(System.IntPtr,System.Int32)" /> method.
  17676. </summary>
  17677. <param name="table">
  17678. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object instance associated
  17679. with this virtual table.
  17680. </param>
  17681. <param name="savepoint">
  17682. This is an integer used to indicate that any saved states with an
  17683. identifier greater than or equal to this should be deleted by the
  17684. virtual table.
  17685. </param>
  17686. <returns>
  17687. A standard SQLite return code.
  17688. </returns>
  17689. </member>
  17690. <member name="M:System.Data.SQLite.SQLiteModule.RollbackTo(System.Data.SQLite.SQLiteVirtualTable,System.Int32)">
  17691. <summary>
  17692. This method is called in response to the
  17693. <see cref="M:System.Data.SQLite.ISQLiteNativeModule.xRollbackTo(System.IntPtr,System.Int32)" /> method.
  17694. </summary>
  17695. <param name="table">
  17696. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object instance associated
  17697. with this virtual table.
  17698. </param>
  17699. <param name="savepoint">
  17700. This is an integer identifier used to specify a specific saved
  17701. state for the virtual table for it to restore itself back to, which
  17702. should also have the effect of deleting all saved states with an
  17703. integer identifier greater than this one.
  17704. </param>
  17705. <returns>
  17706. A standard SQLite return code.
  17707. </returns>
  17708. </member>
  17709. <member name="M:System.Data.SQLite.SQLiteModule.Dispose">
  17710. <summary>
  17711. Disposes of this object instance.
  17712. </summary>
  17713. </member>
  17714. <member name="M:System.Data.SQLite.SQLiteModule.CheckDisposed">
  17715. <summary>
  17716. Throws an <see cref="T:System.ObjectDisposedException" /> if this object
  17717. instance has been disposed.
  17718. </summary>
  17719. </member>
  17720. <member name="M:System.Data.SQLite.SQLiteModule.Dispose(System.Boolean)">
  17721. <summary>
  17722. Disposes of this object instance.
  17723. </summary>
  17724. <param name="disposing">
  17725. Non-zero if this method is being called from the
  17726. <see cref="M:System.Data.SQLite.SQLiteModule.Dispose" /> method. Zero if this method is being
  17727. called from the finalizer.
  17728. </param>
  17729. </member>
  17730. <member name="M:System.Data.SQLite.SQLiteModule.Finalize">
  17731. <summary>
  17732. Finalizes this object instance.
  17733. </summary>
  17734. </member>
  17735. <member name="T:System.Data.SQLite.SQLiteModuleCommon">
  17736. <summary>
  17737. This class contains some virtual methods that may be useful for other
  17738. virtual table classes. It specifically does NOT implement any of the
  17739. <see cref="T:System.Data.SQLite.ISQLiteManagedModule" /> interface methods.
  17740. </summary>
  17741. </member>
  17742. <member name="F:System.Data.SQLite.SQLiteModuleCommon.declareSql">
  17743. <summary>
  17744. The CREATE TABLE statement used to declare the schema for the
  17745. virtual table.
  17746. </summary>
  17747. </member>
  17748. <member name="F:System.Data.SQLite.SQLiteModuleCommon.objectIdentity">
  17749. <summary>
  17750. Non-zero if different object instances with the same value should
  17751. generate different row identifiers, where applicable. This has no
  17752. effect on the .NET Compact Framework.
  17753. </summary>
  17754. </member>
  17755. <member name="M:System.Data.SQLite.SQLiteModuleCommon.#ctor(System.String)">
  17756. <summary>
  17757. Constructs an instance of this class.
  17758. </summary>
  17759. <param name="name">
  17760. The name of the module. This parameter cannot be null.
  17761. </param>
  17762. </member>
  17763. <member name="M:System.Data.SQLite.SQLiteModuleCommon.#ctor(System.String,System.Boolean)">
  17764. <summary>
  17765. Constructs an instance of this class.
  17766. </summary>
  17767. <param name="name">
  17768. The name of the module. This parameter cannot be null.
  17769. </param>
  17770. <param name="objectIdentity">
  17771. Non-zero if different object instances with the same value should
  17772. generate different row identifiers, where applicable. This
  17773. parameter has no effect on the .NET Compact Framework.
  17774. </param>
  17775. </member>
  17776. <member name="M:System.Data.SQLite.SQLiteModuleCommon.GetSqlForDeclareTable">
  17777. <summary>
  17778. Determines the SQL statement used to declare the virtual table.
  17779. This method should be overridden in derived classes if they require
  17780. a custom virtual table schema.
  17781. </summary>
  17782. <returns>
  17783. The SQL statement used to declare the virtual table -OR- null if it
  17784. cannot be determined.
  17785. </returns>
  17786. </member>
  17787. <member name="M:System.Data.SQLite.SQLiteModuleCommon.CursorTypeMismatchError(System.Data.SQLite.SQLiteVirtualTableCursor,System.Type)">
  17788. <summary>
  17789. Sets the table error message to one that indicates the virtual
  17790. table cursor is of the wrong type.
  17791. </summary>
  17792. <param name="cursor">
  17793. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor" /> object instance.
  17794. </param>
  17795. <param name="type">
  17796. The <see cref="T:System.Type" /> that the virtual table cursor should be.
  17797. </param>
  17798. <returns>
  17799. The value of <see cref="F:System.Data.SQLite.SQLiteErrorCode.Error" />.
  17800. </returns>
  17801. </member>
  17802. <member name="M:System.Data.SQLite.SQLiteModuleCommon.GetStringFromObject(System.Data.SQLite.SQLiteVirtualTableCursor,System.Object)">
  17803. <summary>
  17804. Determines the string to return as the column value for the object
  17805. instance value.
  17806. </summary>
  17807. <param name="cursor">
  17808. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor" /> object instance
  17809. associated with the previously opened virtual table cursor to be
  17810. used.
  17811. </param>
  17812. <param name="value">
  17813. The object instance to return a string representation for.
  17814. </param>
  17815. <returns>
  17816. The string representation of the specified object instance or null
  17817. upon failure.
  17818. </returns>
  17819. </member>
  17820. <member name="M:System.Data.SQLite.SQLiteModuleCommon.MakeRowId(System.Int32,System.Int32)">
  17821. <summary>
  17822. Constructs an <see cref="T:System.Int64" /> unique row identifier from two
  17823. <see cref="T:System.Int32" /> values. The first <see cref="T:System.Int32" /> value
  17824. must contain the row sequence number for the current row and the
  17825. second value must contain the hash code of the key column value
  17826. for the current row.
  17827. </summary>
  17828. <param name="rowIndex">
  17829. The integer row sequence number for the current row.
  17830. </param>
  17831. <param name="hashCode">
  17832. The hash code of the key column value for the current row.
  17833. </param>
  17834. <returns>
  17835. The unique row identifier or zero upon failure.
  17836. </returns>
  17837. </member>
  17838. <member name="M:System.Data.SQLite.SQLiteModuleCommon.GetRowIdFromObject(System.Data.SQLite.SQLiteVirtualTableCursor,System.Object)">
  17839. <summary>
  17840. Determines the unique row identifier for the current row.
  17841. </summary>
  17842. <param name="cursor">
  17843. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor" /> object instance
  17844. associated with the previously opened virtual table cursor to be
  17845. used.
  17846. </param>
  17847. <param name="value">
  17848. The object instance to return a unique row identifier for.
  17849. </param>
  17850. <returns>
  17851. The unique row identifier or zero upon failure.
  17852. </returns>
  17853. </member>
  17854. <member name="M:System.Data.SQLite.SQLiteModuleCommon.CheckDisposed">
  17855. <summary>
  17856. Throws an <see cref="T:System.ObjectDisposedException" /> if this object
  17857. instance has been disposed.
  17858. </summary>
  17859. </member>
  17860. <member name="M:System.Data.SQLite.SQLiteModuleCommon.Dispose(System.Boolean)">
  17861. <summary>
  17862. Disposes of this object instance.
  17863. </summary>
  17864. <param name="disposing">
  17865. Non-zero if this method is being called from the
  17866. <see cref="M:System.IDisposable.Dispose" /> method. Zero if this method is
  17867. being called from the finalizer.
  17868. </param>
  17869. </member>
  17870. <member name="T:System.Data.SQLite.SQLiteVirtualTableCursorEnumerator">
  17871. <summary>
  17872. This class represents a virtual table cursor to be used with the
  17873. <see cref="T:System.Data.SQLite.SQLiteModuleEnumerable" /> class. It is not sealed and may
  17874. be used as the base class for any user-defined virtual table cursor
  17875. class that wraps an <see cref="T:System.Collections.IEnumerator" /> object instance.
  17876. </summary>
  17877. </member>
  17878. <member name="F:System.Data.SQLite.SQLiteVirtualTableCursorEnumerator.enumerator">
  17879. <summary>
  17880. The <see cref="T:System.Collections.IEnumerator" /> instance provided when this cursor
  17881. was created.
  17882. </summary>
  17883. </member>
  17884. <member name="F:System.Data.SQLite.SQLiteVirtualTableCursorEnumerator.endOfEnumerator">
  17885. <summary>
  17886. This value will be non-zero if false has been returned from the
  17887. <see cref="M:System.Collections.IEnumerator.MoveNext" /> method.
  17888. </summary>
  17889. </member>
  17890. <member name="M:System.Data.SQLite.SQLiteVirtualTableCursorEnumerator.#ctor(System.Data.SQLite.SQLiteVirtualTable,System.Collections.IEnumerator)">
  17891. <summary>
  17892. Constructs an instance of this class.
  17893. </summary>
  17894. <param name="table">
  17895. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object instance associated
  17896. with this object instance.
  17897. </param>
  17898. <param name="enumerator">
  17899. The <see cref="T:System.Collections.IEnumerator" /> instance to expose as a virtual
  17900. table cursor.
  17901. </param>
  17902. </member>
  17903. <member name="M:System.Data.SQLite.SQLiteVirtualTableCursorEnumerator.MoveNext">
  17904. <summary>
  17905. Advances to the next row of the virtual table cursor using the
  17906. <see cref="M:System.Collections.IEnumerator.MoveNext" /> method of the
  17907. <see cref="T:System.Collections.IEnumerator" /> object instance.
  17908. </summary>
  17909. <returns>
  17910. Non-zero if the current row is valid; zero otherwise. If zero is
  17911. returned, no further rows are available.
  17912. </returns>
  17913. </member>
  17914. <member name="P:System.Data.SQLite.SQLiteVirtualTableCursorEnumerator.Current">
  17915. <summary>
  17916. Returns the value for the current row of the virtual table cursor
  17917. using the <see cref="P:System.Collections.IEnumerator.Current" /> property of the
  17918. <see cref="T:System.Collections.IEnumerator" /> object instance.
  17919. </summary>
  17920. </member>
  17921. <member name="M:System.Data.SQLite.SQLiteVirtualTableCursorEnumerator.Reset">
  17922. <summary>
  17923. Resets the virtual table cursor position, also invalidating the
  17924. current row, using the <see cref="M:System.Collections.IEnumerator.Reset" /> method of
  17925. the <see cref="T:System.Collections.IEnumerator" /> object instance.
  17926. </summary>
  17927. </member>
  17928. <member name="P:System.Data.SQLite.SQLiteVirtualTableCursorEnumerator.EndOfEnumerator">
  17929. <summary>
  17930. Returns non-zero if the end of the virtual table cursor has been
  17931. seen (i.e. no more rows are available, including the current one).
  17932. </summary>
  17933. </member>
  17934. <member name="P:System.Data.SQLite.SQLiteVirtualTableCursorEnumerator.IsOpen">
  17935. <summary>
  17936. Returns non-zero if the virtual table cursor is open.
  17937. </summary>
  17938. </member>
  17939. <member name="M:System.Data.SQLite.SQLiteVirtualTableCursorEnumerator.Close">
  17940. <summary>
  17941. Closes the virtual table cursor. This method must not throw any
  17942. exceptions.
  17943. </summary>
  17944. </member>
  17945. <member name="M:System.Data.SQLite.SQLiteVirtualTableCursorEnumerator.CheckClosed">
  17946. <summary>
  17947. Throws an <see cref="T:System.InvalidOperationException" /> if the virtual
  17948. table cursor has been closed.
  17949. </summary>
  17950. </member>
  17951. <member name="M:System.Data.SQLite.SQLiteVirtualTableCursorEnumerator.CheckDisposed">
  17952. <summary>
  17953. Throws an <see cref="T:System.ObjectDisposedException" /> if this object
  17954. instance has been disposed.
  17955. </summary>
  17956. </member>
  17957. <member name="M:System.Data.SQLite.SQLiteVirtualTableCursorEnumerator.Dispose(System.Boolean)">
  17958. <summary>
  17959. Disposes of this object instance.
  17960. </summary>
  17961. <param name="disposing">
  17962. Non-zero if this method is being called from the
  17963. <see cref="M:System.IDisposable.Dispose" /> method. Zero if this method is
  17964. being called from the finalizer.
  17965. </param>
  17966. </member>
  17967. <member name="T:System.Data.SQLite.SQLiteModuleEnumerable">
  17968. <summary>
  17969. This class implements a virtual table module that exposes an
  17970. <see cref="T:System.Collections.IEnumerable" /> object instance as a read-only virtual
  17971. table. It is not sealed and may be used as the base class for any
  17972. user-defined virtual table class that wraps an
  17973. <see cref="T:System.Collections.IEnumerable" /> object instance. The following short
  17974. example shows it being used to treat an array of strings as a table
  17975. data source:
  17976. <code>
  17977. public static class Sample
  17978. {
  17979. public static void Main()
  17980. {
  17981. using (SQLiteConnection connection = new SQLiteConnection(
  17982. "Data Source=:memory:;"))
  17983. {
  17984. connection.Open();
  17985. connection.CreateModule(new SQLiteModuleEnumerable(
  17986. "sampleModule", new string[] { "one", "two", "three" }));
  17987. using (SQLiteCommand command = connection.CreateCommand())
  17988. {
  17989. command.CommandText =
  17990. "CREATE VIRTUAL TABLE t1 USING sampleModule;";
  17991. command.ExecuteNonQuery();
  17992. }
  17993. using (SQLiteCommand command = connection.CreateCommand())
  17994. {
  17995. command.CommandText = "SELECT * FROM t1;";
  17996. using (SQLiteDataReader dataReader = command.ExecuteReader())
  17997. {
  17998. while (dataReader.Read())
  17999. Console.WriteLine(dataReader[0].ToString());
  18000. }
  18001. }
  18002. connection.Close();
  18003. }
  18004. }
  18005. }
  18006. </code>
  18007. </summary>
  18008. </member>
  18009. <member name="F:System.Data.SQLite.SQLiteModuleEnumerable.enumerable">
  18010. <summary>
  18011. The <see cref="T:System.Collections.IEnumerable" /> instance containing the backing data
  18012. for the virtual table.
  18013. </summary>
  18014. </member>
  18015. <member name="F:System.Data.SQLite.SQLiteModuleEnumerable.objectIdentity">
  18016. <summary>
  18017. Non-zero if different object instances with the same value should
  18018. generate different row identifiers, where applicable. This has no
  18019. effect on the .NET Compact Framework.
  18020. </summary>
  18021. </member>
  18022. <member name="M:System.Data.SQLite.SQLiteModuleEnumerable.#ctor(System.String,System.Collections.IEnumerable)">
  18023. <summary>
  18024. Constructs an instance of this class.
  18025. </summary>
  18026. <param name="name">
  18027. The name of the module. This parameter cannot be null.
  18028. </param>
  18029. <param name="enumerable">
  18030. The <see cref="T:System.Collections.IEnumerable" /> instance to expose as a virtual
  18031. table. This parameter cannot be null.
  18032. </param>
  18033. </member>
  18034. <member name="M:System.Data.SQLite.SQLiteModuleEnumerable.#ctor(System.String,System.Collections.IEnumerable,System.Boolean)">
  18035. <summary>
  18036. Constructs an instance of this class.
  18037. </summary>
  18038. <param name="name">
  18039. The name of the module. This parameter cannot be null.
  18040. </param>
  18041. <param name="enumerable">
  18042. The <see cref="T:System.Collections.IEnumerable" /> instance to expose as a virtual
  18043. table. This parameter cannot be null.
  18044. </param>
  18045. <param name="objectIdentity">
  18046. Non-zero if different object instances with the same value should
  18047. generate different row identifiers, where applicable. This
  18048. parameter has no effect on the .NET Compact Framework.
  18049. </param>
  18050. </member>
  18051. <member name="M:System.Data.SQLite.SQLiteModuleEnumerable.CursorEndOfEnumeratorError(System.Data.SQLite.SQLiteVirtualTableCursor)">
  18052. <summary>
  18053. Sets the table error message to one that indicates the virtual
  18054. table cursor has no current row.
  18055. </summary>
  18056. <param name="cursor">
  18057. The <see cref="T:System.Data.SQLite.SQLiteVirtualTableCursor" /> object instance.
  18058. </param>
  18059. <returns>
  18060. The value of <see cref="F:System.Data.SQLite.SQLiteErrorCode.Error" />.
  18061. </returns>
  18062. </member>
  18063. <member name="M:System.Data.SQLite.SQLiteModuleEnumerable.Create(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)">
  18064. <summary>
  18065. 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.
  18066. </summary>
  18067. <param name="connection">
  18068. 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.
  18069. </param>
  18070. <param name="pClientData">
  18071. 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.
  18072. </param>
  18073. <param name="arguments">
  18074. 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.
  18075. </param>
  18076. <param name="table">
  18077. 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.
  18078. </param>
  18079. <param name="error">
  18080. 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.
  18081. </param>
  18082. <returns>
  18083. 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.
  18084. </returns>
  18085. </member>
  18086. <member name="M:System.Data.SQLite.SQLiteModuleEnumerable.Connect(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)">
  18087. <summary>
  18088. 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.
  18089. </summary>
  18090. <param name="connection">
  18091. 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.
  18092. </param>
  18093. <param name="pClientData">
  18094. 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.
  18095. </param>
  18096. <param name="arguments">
  18097. 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.
  18098. </param>
  18099. <param name="table">
  18100. 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.
  18101. </param>
  18102. <param name="error">
  18103. 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.
  18104. </param>
  18105. <returns>
  18106. 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.
  18107. </returns>
  18108. </member>
  18109. <member name="M:System.Data.SQLite.SQLiteModuleEnumerable.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)">
  18110. <summary>
  18111. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)" /> method.
  18112. </summary>
  18113. <param name="table">
  18114. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)" /> method.
  18115. </param>
  18116. <param name="index">
  18117. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)" /> method.
  18118. </param>
  18119. <returns>
  18120. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)" /> method.
  18121. </returns>
  18122. </member>
  18123. <member name="M:System.Data.SQLite.SQLiteModuleEnumerable.Disconnect(System.Data.SQLite.SQLiteVirtualTable)">
  18124. <summary>
  18125. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Disconnect(System.Data.SQLite.SQLiteVirtualTable)" /> method.
  18126. </summary>
  18127. <param name="table">
  18128. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Disconnect(System.Data.SQLite.SQLiteVirtualTable)" /> method.
  18129. </param>
  18130. <returns>
  18131. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Disconnect(System.Data.SQLite.SQLiteVirtualTable)" /> method.
  18132. </returns>
  18133. </member>
  18134. <member name="M:System.Data.SQLite.SQLiteModuleEnumerable.Destroy(System.Data.SQLite.SQLiteVirtualTable)">
  18135. <summary>
  18136. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Destroy(System.Data.SQLite.SQLiteVirtualTable)" /> method.
  18137. </summary>
  18138. <param name="table">
  18139. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Destroy(System.Data.SQLite.SQLiteVirtualTable)" /> method.
  18140. </param>
  18141. <returns>
  18142. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Destroy(System.Data.SQLite.SQLiteVirtualTable)" /> method.
  18143. </returns>
  18144. </member>
  18145. <member name="M:System.Data.SQLite.SQLiteModuleEnumerable.Open(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteVirtualTableCursor@)">
  18146. <summary>
  18147. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Open(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteVirtualTableCursor@)" /> method.
  18148. </summary>
  18149. <param name="table">
  18150. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Open(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteVirtualTableCursor@)" /> method.
  18151. </param>
  18152. <param name="cursor">
  18153. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Open(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteVirtualTableCursor@)" /> method.
  18154. </param>
  18155. <returns>
  18156. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Open(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteVirtualTableCursor@)" /> method.
  18157. </returns>
  18158. </member>
  18159. <member name="M:System.Data.SQLite.SQLiteModuleEnumerable.Close(System.Data.SQLite.SQLiteVirtualTableCursor)">
  18160. <summary>
  18161. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Close(System.Data.SQLite.SQLiteVirtualTableCursor)" /> method.
  18162. </summary>
  18163. <param name="cursor">
  18164. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Close(System.Data.SQLite.SQLiteVirtualTableCursor)" /> method.
  18165. </param>
  18166. <returns>
  18167. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Close(System.Data.SQLite.SQLiteVirtualTableCursor)" /> method.
  18168. </returns>
  18169. </member>
  18170. <member name="M:System.Data.SQLite.SQLiteModuleEnumerable.Filter(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int32,System.String,System.Data.SQLite.SQLiteValue[])">
  18171. <summary>
  18172. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Filter(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int32,System.String,System.Data.SQLite.SQLiteValue[])" /> method.
  18173. </summary>
  18174. <param name="cursor">
  18175. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Filter(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int32,System.String,System.Data.SQLite.SQLiteValue[])" /> method.
  18176. </param>
  18177. <param name="indexNumber">
  18178. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Filter(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int32,System.String,System.Data.SQLite.SQLiteValue[])" /> method.
  18179. </param>
  18180. <param name="indexString">
  18181. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Filter(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int32,System.String,System.Data.SQLite.SQLiteValue[])" /> method.
  18182. </param>
  18183. <param name="values">
  18184. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Filter(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int32,System.String,System.Data.SQLite.SQLiteValue[])" /> method.
  18185. </param>
  18186. <returns>
  18187. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Filter(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int32,System.String,System.Data.SQLite.SQLiteValue[])" /> method.
  18188. </returns>
  18189. </member>
  18190. <member name="M:System.Data.SQLite.SQLiteModuleEnumerable.Next(System.Data.SQLite.SQLiteVirtualTableCursor)">
  18191. <summary>
  18192. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Next(System.Data.SQLite.SQLiteVirtualTableCursor)" /> method.
  18193. </summary>
  18194. <param name="cursor">
  18195. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Next(System.Data.SQLite.SQLiteVirtualTableCursor)" /> method.
  18196. </param>
  18197. <returns>
  18198. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Next(System.Data.SQLite.SQLiteVirtualTableCursor)" /> method.
  18199. </returns>
  18200. </member>
  18201. <member name="M:System.Data.SQLite.SQLiteModuleEnumerable.Eof(System.Data.SQLite.SQLiteVirtualTableCursor)">
  18202. <summary>
  18203. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Eof(System.Data.SQLite.SQLiteVirtualTableCursor)" /> method.
  18204. </summary>
  18205. <param name="cursor">
  18206. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Eof(System.Data.SQLite.SQLiteVirtualTableCursor)" /> method.
  18207. </param>
  18208. <returns>
  18209. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Eof(System.Data.SQLite.SQLiteVirtualTableCursor)" /> method.
  18210. </returns>
  18211. </member>
  18212. <member name="M:System.Data.SQLite.SQLiteModuleEnumerable.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)">
  18213. <summary>
  18214. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)" /> method.
  18215. </summary>
  18216. <param name="cursor">
  18217. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)" /> method.
  18218. </param>
  18219. <param name="context">
  18220. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)" /> method.
  18221. </param>
  18222. <param name="index">
  18223. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)" /> method.
  18224. </param>
  18225. <returns>
  18226. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)" /> method.
  18227. </returns>
  18228. </member>
  18229. <member name="M:System.Data.SQLite.SQLiteModuleEnumerable.RowId(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int64@)">
  18230. <summary>
  18231. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.RowId(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int64@)" /> method.
  18232. </summary>
  18233. <param name="cursor">
  18234. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.RowId(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int64@)" /> method.
  18235. </param>
  18236. <param name="rowId">
  18237. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.RowId(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int64@)" /> method.
  18238. </param>
  18239. <returns>
  18240. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.RowId(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int64@)" /> method.
  18241. </returns>
  18242. </member>
  18243. <member name="M:System.Data.SQLite.SQLiteModuleEnumerable.Update(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteValue[],System.Int64@)">
  18244. <summary>
  18245. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Update(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteValue[],System.Int64@)" /> method.
  18246. </summary>
  18247. <param name="table">
  18248. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Update(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteValue[],System.Int64@)" /> method.
  18249. </param>
  18250. <param name="values">
  18251. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Update(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteValue[],System.Int64@)" /> method.
  18252. </param>
  18253. <param name="rowId">
  18254. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Update(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteValue[],System.Int64@)" /> method.
  18255. </param>
  18256. <returns>
  18257. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Update(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteValue[],System.Int64@)" /> method.
  18258. </returns>
  18259. </member>
  18260. <member name="M:System.Data.SQLite.SQLiteModuleEnumerable.Rename(System.Data.SQLite.SQLiteVirtualTable,System.String)">
  18261. <summary>
  18262. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Rename(System.Data.SQLite.SQLiteVirtualTable,System.String)" /> method.
  18263. </summary>
  18264. <param name="table">
  18265. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Rename(System.Data.SQLite.SQLiteVirtualTable,System.String)" /> method.
  18266. </param>
  18267. <param name="newName">
  18268. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Rename(System.Data.SQLite.SQLiteVirtualTable,System.String)" /> method.
  18269. </param>
  18270. <returns>
  18271. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Rename(System.Data.SQLite.SQLiteVirtualTable,System.String)" /> method.
  18272. </returns>
  18273. </member>
  18274. <member name="M:System.Data.SQLite.SQLiteModuleEnumerable.CheckDisposed">
  18275. <summary>
  18276. Throws an <see cref="T:System.ObjectDisposedException" /> if this object
  18277. instance has been disposed.
  18278. </summary>
  18279. </member>
  18280. <member name="M:System.Data.SQLite.SQLiteModuleEnumerable.Dispose(System.Boolean)">
  18281. <summary>
  18282. Disposes of this object instance.
  18283. </summary>
  18284. <param name="disposing">
  18285. Non-zero if this method is being called from the
  18286. <see cref="M:System.IDisposable.Dispose" /> method. Zero if this method is
  18287. being called from the finalizer.
  18288. </param>
  18289. </member>
  18290. <member name="T:System.Data.SQLite.Generic.SQLiteVirtualTableCursorEnumerator`1">
  18291. <summary>
  18292. This class represents a virtual table cursor to be used with the
  18293. <see cref="T:System.Data.SQLite.SQLiteModuleEnumerable" /> class. It is not sealed and may
  18294. be used as the base class for any user-defined virtual table cursor
  18295. class that wraps an <see cref="T:System.Collections.Generic.IEnumerator`1" /> object instance.
  18296. </summary>
  18297. </member>
  18298. <member name="F:System.Data.SQLite.Generic.SQLiteVirtualTableCursorEnumerator`1.enumerator">
  18299. <summary>
  18300. The <see cref="T:System.Collections.Generic.IEnumerator`1" /> instance provided when this
  18301. cursor was created.
  18302. </summary>
  18303. </member>
  18304. <member name="M:System.Data.SQLite.Generic.SQLiteVirtualTableCursorEnumerator`1.#ctor(System.Data.SQLite.SQLiteVirtualTable,System.Collections.Generic.IEnumerator{`0})">
  18305. <summary>
  18306. Constructs an instance of this class.
  18307. </summary>
  18308. <param name="table">
  18309. The <see cref="T:System.Data.SQLite.SQLiteVirtualTable" /> object instance associated
  18310. with this object instance.
  18311. </param>
  18312. <param name="enumerator">
  18313. The <see cref="T:System.Collections.Generic.IEnumerator`1" /> instance to expose as a virtual
  18314. table cursor.
  18315. </param>
  18316. </member>
  18317. <member name="P:System.Data.SQLite.Generic.SQLiteVirtualTableCursorEnumerator`1.System#Collections#Generic#IEnumerator{T}#Current">
  18318. <summary>
  18319. Returns the value for the current row of the virtual table cursor
  18320. using the <see cref="P:System.Collections.Generic.IEnumerator`1.Current" /> property of the
  18321. <see cref="T:System.Collections.Generic.IEnumerator`1" /> object instance.
  18322. </summary>
  18323. </member>
  18324. <member name="M:System.Data.SQLite.Generic.SQLiteVirtualTableCursorEnumerator`1.Close">
  18325. <summary>
  18326. Closes the virtual table cursor. This method must not throw any
  18327. exceptions.
  18328. </summary>
  18329. </member>
  18330. <member name="M:System.Data.SQLite.Generic.SQLiteVirtualTableCursorEnumerator`1.CheckDisposed">
  18331. <summary>
  18332. Throws an <see cref="T:System.ObjectDisposedException" /> if this object
  18333. instance has been disposed.
  18334. </summary>
  18335. </member>
  18336. <member name="M:System.Data.SQLite.Generic.SQLiteVirtualTableCursorEnumerator`1.Dispose(System.Boolean)">
  18337. <summary>
  18338. Disposes of this object instance.
  18339. </summary>
  18340. <param name="disposing">
  18341. Non-zero if this method is being called from the
  18342. <see cref="M:System.IDisposable.Dispose" /> method. Zero if this method is
  18343. being called from the finalizer.
  18344. </param>
  18345. </member>
  18346. <member name="T:System.Data.SQLite.Generic.SQLiteModuleEnumerable`1">
  18347. <summary>
  18348. This class implements a virtual table module that exposes an
  18349. <see cref="T:System.Collections.Generic.IEnumerable`1" /> object instance as a read-only virtual
  18350. table. It is not sealed and may be used as the base class for any
  18351. user-defined virtual table class that wraps an
  18352. <see cref="T:System.Collections.Generic.IEnumerable`1" /> object instance.
  18353. </summary>
  18354. </member>
  18355. <member name="F:System.Data.SQLite.Generic.SQLiteModuleEnumerable`1.enumerable">
  18356. <summary>
  18357. The <see cref="T:System.Collections.Generic.IEnumerable`1" /> instance containing the backing
  18358. data for the virtual table.
  18359. </summary>
  18360. </member>
  18361. <member name="M:System.Data.SQLite.Generic.SQLiteModuleEnumerable`1.#ctor(System.String,System.Collections.Generic.IEnumerable{`0})">
  18362. <summary>
  18363. Constructs an instance of this class.
  18364. </summary>
  18365. <param name="name">
  18366. The name of the module. This parameter cannot be null.
  18367. </param>
  18368. <param name="enumerable">
  18369. The <see cref="T:System.Collections.Generic.IEnumerable`1" /> instance to expose as a virtual
  18370. table. This parameter cannot be null.
  18371. </param>
  18372. </member>
  18373. <member name="M:System.Data.SQLite.Generic.SQLiteModuleEnumerable`1.Open(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteVirtualTableCursor@)">
  18374. <summary>
  18375. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Open(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteVirtualTableCursor@)" /> method.
  18376. </summary>
  18377. <param name="table">
  18378. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Open(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteVirtualTableCursor@)" /> method.
  18379. </param>
  18380. <param name="cursor">
  18381. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Open(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteVirtualTableCursor@)" /> method.
  18382. </param>
  18383. <returns>
  18384. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Open(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteVirtualTableCursor@)" /> method.
  18385. </returns>
  18386. </member>
  18387. <member name="M:System.Data.SQLite.Generic.SQLiteModuleEnumerable`1.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)">
  18388. <summary>
  18389. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)" /> method.
  18390. </summary>
  18391. <param name="cursor">
  18392. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)" /> method.
  18393. </param>
  18394. <param name="context">
  18395. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)" /> method.
  18396. </param>
  18397. <param name="index">
  18398. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)" /> method.
  18399. </param>
  18400. <returns>
  18401. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)" /> method.
  18402. </returns>
  18403. </member>
  18404. <member name="M:System.Data.SQLite.Generic.SQLiteModuleEnumerable`1.CheckDisposed">
  18405. <summary>
  18406. Throws an <see cref="T:System.ObjectDisposedException" /> if this object
  18407. instance has been disposed.
  18408. </summary>
  18409. </member>
  18410. <member name="M:System.Data.SQLite.Generic.SQLiteModuleEnumerable`1.Dispose(System.Boolean)">
  18411. <summary>
  18412. Disposes of this object instance.
  18413. </summary>
  18414. <param name="disposing">
  18415. Non-zero if this method is being called from the
  18416. <see cref="M:System.IDisposable.Dispose" /> method. Zero if this method is
  18417. being called from the finalizer.
  18418. </param>
  18419. </member>
  18420. <member name="T:System.Data.SQLite.SQLiteModuleNoop">
  18421. <summary>
  18422. This class implements a virtual table module that does nothing by
  18423. providing "empty" implementations for all of the
  18424. <see cref="T:System.Data.SQLite.ISQLiteManagedModule" /> interface methods. The result
  18425. codes returned by these "empty" method implementations may be
  18426. controlled on a per-method basis by using and/or overriding the
  18427. <see cref="M:System.Data.SQLite.SQLiteModuleNoop.GetDefaultResultCode" />,
  18428. <see cref="M:System.Data.SQLite.SQLiteModuleNoop.ResultCodeToEofResult(System.Data.SQLite.SQLiteErrorCode)" />,
  18429. <see cref="M:System.Data.SQLite.SQLiteModuleNoop.ResultCodeToFindFunctionResult(System.Data.SQLite.SQLiteErrorCode)" />,
  18430. <see cref="M:System.Data.SQLite.SQLiteModuleNoop.GetMethodResultCode(System.String)" />, and
  18431. <see cref="M:System.Data.SQLite.SQLiteModuleNoop.SetMethodResultCode(System.String,System.Data.SQLite.SQLiteErrorCode)" /> methods from within derived classes.
  18432. </summary>
  18433. </member>
  18434. <member name="F:System.Data.SQLite.SQLiteModuleNoop.resultCodes">
  18435. <summary>
  18436. This field is used to store the <see cref="T:System.Data.SQLite.SQLiteErrorCode" />
  18437. values to return, on a per-method basis, for all methods that are
  18438. part of the <see cref="T:System.Data.SQLite.ISQLiteManagedModule" /> interface.
  18439. </summary>
  18440. </member>
  18441. <member name="M:System.Data.SQLite.SQLiteModuleNoop.#ctor(System.String)">
  18442. <summary>
  18443. Constructs an instance of this class.
  18444. </summary>
  18445. <param name="name">
  18446. The name of the module. This parameter cannot be null.
  18447. </param>
  18448. </member>
  18449. <member name="M:System.Data.SQLite.SQLiteModuleNoop.GetDefaultResultCode">
  18450. <summary>
  18451. Determines the default <see cref="T:System.Data.SQLite.SQLiteErrorCode" /> value to be
  18452. returned by methods of the <see cref="T:System.Data.SQLite.ISQLiteManagedModule" />
  18453. interface that lack an overridden implementation in all classes
  18454. derived from the <see cref="T:System.Data.SQLite.SQLiteModuleNoop" /> class.
  18455. </summary>
  18456. <returns>
  18457. The <see cref="T:System.Data.SQLite.SQLiteErrorCode" /> value that should be returned
  18458. by all <see cref="T:System.Data.SQLite.ISQLiteManagedModule" /> interface methods unless
  18459. a more specific result code has been set for that interface method.
  18460. </returns>
  18461. </member>
  18462. <member name="M:System.Data.SQLite.SQLiteModuleNoop.ResultCodeToEofResult(System.Data.SQLite.SQLiteErrorCode)">
  18463. <summary>
  18464. Converts a <see cref="T:System.Data.SQLite.SQLiteErrorCode" /> value into a boolean
  18465. return value for use with the
  18466. <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Eof(System.Data.SQLite.SQLiteVirtualTableCursor)" /> method.
  18467. </summary>
  18468. <param name="resultCode">
  18469. The <see cref="T:System.Data.SQLite.SQLiteErrorCode" /> value to convert.
  18470. </param>
  18471. <returns>
  18472. The <see cref="T:System.Boolean" /> value.
  18473. </returns>
  18474. </member>
  18475. <member name="M:System.Data.SQLite.SQLiteModuleNoop.ResultCodeToFindFunctionResult(System.Data.SQLite.SQLiteErrorCode)">
  18476. <summary>
  18477. Converts a <see cref="T:System.Data.SQLite.SQLiteErrorCode" /> value into a boolean
  18478. return value for use with the
  18479. <see cref="M:System.Data.SQLite.ISQLiteManagedModule.FindFunction(System.Data.SQLite.SQLiteVirtualTable,System.Int32,System.String,System.Data.SQLite.SQLiteFunction@,System.IntPtr@)" /> method.
  18480. </summary>
  18481. <param name="resultCode">
  18482. The <see cref="T:System.Data.SQLite.SQLiteErrorCode" /> value to convert.
  18483. </param>
  18484. <returns>
  18485. The <see cref="T:System.Boolean" /> value.
  18486. </returns>
  18487. </member>
  18488. <member name="M:System.Data.SQLite.SQLiteModuleNoop.GetMethodResultCode(System.String)">
  18489. <summary>
  18490. Determines the <see cref="T:System.Data.SQLite.SQLiteErrorCode" /> value that should be
  18491. returned by the specified <see cref="T:System.Data.SQLite.ISQLiteManagedModule" />
  18492. interface method if it lack an overridden implementation. If no
  18493. specific <see cref="T:System.Data.SQLite.SQLiteErrorCode" /> value is available (or set)
  18494. for the specified method, the <see cref="T:System.Data.SQLite.SQLiteErrorCode" /> value
  18495. returned by the <see cref="M:System.Data.SQLite.SQLiteModuleNoop.GetDefaultResultCode" /> method will be
  18496. returned instead.
  18497. </summary>
  18498. <param name="methodName">
  18499. The name of the method. Currently, this method must be part of
  18500. the <see cref="T:System.Data.SQLite.ISQLiteManagedModule" /> interface.
  18501. </param>
  18502. <returns>
  18503. The <see cref="T:System.Data.SQLite.SQLiteErrorCode" /> value that should be returned
  18504. by the <see cref="T:System.Data.SQLite.ISQLiteManagedModule" /> interface method.
  18505. </returns>
  18506. </member>
  18507. <member name="M:System.Data.SQLite.SQLiteModuleNoop.SetMethodResultCode(System.String,System.Data.SQLite.SQLiteErrorCode)">
  18508. <summary>
  18509. Sets the <see cref="T:System.Data.SQLite.SQLiteErrorCode" /> value that should be
  18510. returned by the specified <see cref="T:System.Data.SQLite.ISQLiteManagedModule" />
  18511. interface method if it lack an overridden implementation.
  18512. </summary>
  18513. <param name="methodName">
  18514. The name of the method. Currently, this method must be part of
  18515. the <see cref="T:System.Data.SQLite.ISQLiteManagedModule" /> interface.
  18516. </param>
  18517. <param name="resultCode">
  18518. The <see cref="T:System.Data.SQLite.SQLiteErrorCode" /> value that should be returned
  18519. by the <see cref="T:System.Data.SQLite.ISQLiteManagedModule" /> interface method.
  18520. </param>
  18521. <returns>
  18522. Non-zero upon success.
  18523. </returns>
  18524. </member>
  18525. <member name="M:System.Data.SQLite.SQLiteModuleNoop.Create(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)">
  18526. <summary>
  18527. 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.
  18528. </summary>
  18529. <param name="connection">
  18530. 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.
  18531. </param>
  18532. <param name="pClientData">
  18533. 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.
  18534. </param>
  18535. <param name="arguments">
  18536. 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.
  18537. </param>
  18538. <param name="table">
  18539. 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.
  18540. </param>
  18541. <param name="error">
  18542. 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.
  18543. </param>
  18544. <returns>
  18545. 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.
  18546. </returns>
  18547. </member>
  18548. <member name="M:System.Data.SQLite.SQLiteModuleNoop.Connect(System.Data.SQLite.SQLiteConnection,System.IntPtr,System.String[],System.Data.SQLite.SQLiteVirtualTable@,System.String@)">
  18549. <summary>
  18550. 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.
  18551. </summary>
  18552. <param name="connection">
  18553. 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.
  18554. </param>
  18555. <param name="pClientData">
  18556. 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.
  18557. </param>
  18558. <param name="arguments">
  18559. 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.
  18560. </param>
  18561. <param name="table">
  18562. 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.
  18563. </param>
  18564. <param name="error">
  18565. 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.
  18566. </param>
  18567. <returns>
  18568. 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.
  18569. </returns>
  18570. </member>
  18571. <member name="M:System.Data.SQLite.SQLiteModuleNoop.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)">
  18572. <summary>
  18573. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)" /> method.
  18574. </summary>
  18575. <param name="table">
  18576. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)" /> method.
  18577. </param>
  18578. <param name="index">
  18579. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)" /> method.
  18580. </param>
  18581. <returns>
  18582. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.BestIndex(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteIndex)" /> method.
  18583. </returns>
  18584. </member>
  18585. <member name="M:System.Data.SQLite.SQLiteModuleNoop.Disconnect(System.Data.SQLite.SQLiteVirtualTable)">
  18586. <summary>
  18587. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Disconnect(System.Data.SQLite.SQLiteVirtualTable)" /> method.
  18588. </summary>
  18589. <param name="table">
  18590. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Disconnect(System.Data.SQLite.SQLiteVirtualTable)" /> method.
  18591. </param>
  18592. <returns>
  18593. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Disconnect(System.Data.SQLite.SQLiteVirtualTable)" /> method.
  18594. </returns>
  18595. </member>
  18596. <member name="M:System.Data.SQLite.SQLiteModuleNoop.Destroy(System.Data.SQLite.SQLiteVirtualTable)">
  18597. <summary>
  18598. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Destroy(System.Data.SQLite.SQLiteVirtualTable)" /> method.
  18599. </summary>
  18600. <param name="table">
  18601. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Destroy(System.Data.SQLite.SQLiteVirtualTable)" /> method.
  18602. </param>
  18603. <returns>
  18604. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Destroy(System.Data.SQLite.SQLiteVirtualTable)" /> method.
  18605. </returns>
  18606. </member>
  18607. <member name="M:System.Data.SQLite.SQLiteModuleNoop.Open(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteVirtualTableCursor@)">
  18608. <summary>
  18609. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Open(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteVirtualTableCursor@)" /> method.
  18610. </summary>
  18611. <param name="table">
  18612. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Open(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteVirtualTableCursor@)" /> method.
  18613. </param>
  18614. <param name="cursor">
  18615. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Open(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteVirtualTableCursor@)" /> method.
  18616. </param>
  18617. <returns>
  18618. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Open(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteVirtualTableCursor@)" /> method.
  18619. </returns>
  18620. </member>
  18621. <member name="M:System.Data.SQLite.SQLiteModuleNoop.Close(System.Data.SQLite.SQLiteVirtualTableCursor)">
  18622. <summary>
  18623. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Close(System.Data.SQLite.SQLiteVirtualTableCursor)" /> method.
  18624. </summary>
  18625. <param name="cursor">
  18626. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Close(System.Data.SQLite.SQLiteVirtualTableCursor)" /> method.
  18627. </param>
  18628. <returns>
  18629. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Close(System.Data.SQLite.SQLiteVirtualTableCursor)" /> method.
  18630. </returns>
  18631. </member>
  18632. <member name="M:System.Data.SQLite.SQLiteModuleNoop.Filter(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int32,System.String,System.Data.SQLite.SQLiteValue[])">
  18633. <summary>
  18634. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Filter(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int32,System.String,System.Data.SQLite.SQLiteValue[])" /> method.
  18635. </summary>
  18636. <param name="cursor">
  18637. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Filter(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int32,System.String,System.Data.SQLite.SQLiteValue[])" /> method.
  18638. </param>
  18639. <param name="indexNumber">
  18640. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Filter(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int32,System.String,System.Data.SQLite.SQLiteValue[])" /> method.
  18641. </param>
  18642. <param name="indexString">
  18643. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Filter(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int32,System.String,System.Data.SQLite.SQLiteValue[])" /> method.
  18644. </param>
  18645. <param name="values">
  18646. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Filter(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int32,System.String,System.Data.SQLite.SQLiteValue[])" /> method.
  18647. </param>
  18648. <returns>
  18649. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Filter(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int32,System.String,System.Data.SQLite.SQLiteValue[])" /> method.
  18650. </returns>
  18651. </member>
  18652. <member name="M:System.Data.SQLite.SQLiteModuleNoop.Next(System.Data.SQLite.SQLiteVirtualTableCursor)">
  18653. <summary>
  18654. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Next(System.Data.SQLite.SQLiteVirtualTableCursor)" /> method.
  18655. </summary>
  18656. <param name="cursor">
  18657. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Next(System.Data.SQLite.SQLiteVirtualTableCursor)" /> method.
  18658. </param>
  18659. <returns>
  18660. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Next(System.Data.SQLite.SQLiteVirtualTableCursor)" /> method.
  18661. </returns>
  18662. </member>
  18663. <member name="M:System.Data.SQLite.SQLiteModuleNoop.Eof(System.Data.SQLite.SQLiteVirtualTableCursor)">
  18664. <summary>
  18665. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Eof(System.Data.SQLite.SQLiteVirtualTableCursor)" /> method.
  18666. </summary>
  18667. <param name="cursor">
  18668. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Eof(System.Data.SQLite.SQLiteVirtualTableCursor)" /> method.
  18669. </param>
  18670. <returns>
  18671. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Eof(System.Data.SQLite.SQLiteVirtualTableCursor)" /> method.
  18672. </returns>
  18673. </member>
  18674. <member name="M:System.Data.SQLite.SQLiteModuleNoop.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)">
  18675. <summary>
  18676. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)" /> method.
  18677. </summary>
  18678. <param name="cursor">
  18679. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)" /> method.
  18680. </param>
  18681. <param name="context">
  18682. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)" /> method.
  18683. </param>
  18684. <param name="index">
  18685. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)" /> method.
  18686. </param>
  18687. <returns>
  18688. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Column(System.Data.SQLite.SQLiteVirtualTableCursor,System.Data.SQLite.SQLiteContext,System.Int32)" /> method.
  18689. </returns>
  18690. </member>
  18691. <member name="M:System.Data.SQLite.SQLiteModuleNoop.RowId(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int64@)">
  18692. <summary>
  18693. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.RowId(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int64@)" /> method.
  18694. </summary>
  18695. <param name="cursor">
  18696. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.RowId(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int64@)" /> method.
  18697. </param>
  18698. <param name="rowId">
  18699. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.RowId(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int64@)" /> method.
  18700. </param>
  18701. <returns>
  18702. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.RowId(System.Data.SQLite.SQLiteVirtualTableCursor,System.Int64@)" /> method.
  18703. </returns>
  18704. </member>
  18705. <member name="M:System.Data.SQLite.SQLiteModuleNoop.Update(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteValue[],System.Int64@)">
  18706. <summary>
  18707. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Update(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteValue[],System.Int64@)" /> method.
  18708. </summary>
  18709. <param name="table">
  18710. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Update(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteValue[],System.Int64@)" /> method.
  18711. </param>
  18712. <param name="values">
  18713. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Update(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteValue[],System.Int64@)" /> method.
  18714. </param>
  18715. <param name="rowId">
  18716. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Update(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteValue[],System.Int64@)" /> method.
  18717. </param>
  18718. <returns>
  18719. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Update(System.Data.SQLite.SQLiteVirtualTable,System.Data.SQLite.SQLiteValue[],System.Int64@)" /> method.
  18720. </returns>
  18721. </member>
  18722. <member name="M:System.Data.SQLite.SQLiteModuleNoop.Begin(System.Data.SQLite.SQLiteVirtualTable)">
  18723. <summary>
  18724. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Begin(System.Data.SQLite.SQLiteVirtualTable)" /> method.
  18725. </summary>
  18726. <param name="table">
  18727. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Begin(System.Data.SQLite.SQLiteVirtualTable)" /> method.
  18728. </param>
  18729. <returns>
  18730. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Begin(System.Data.SQLite.SQLiteVirtualTable)" /> method.
  18731. </returns>
  18732. </member>
  18733. <member name="M:System.Data.SQLite.SQLiteModuleNoop.Sync(System.Data.SQLite.SQLiteVirtualTable)">
  18734. <summary>
  18735. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Sync(System.Data.SQLite.SQLiteVirtualTable)" /> method.
  18736. </summary>
  18737. <param name="table">
  18738. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Sync(System.Data.SQLite.SQLiteVirtualTable)" /> method.
  18739. </param>
  18740. <returns>
  18741. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Sync(System.Data.SQLite.SQLiteVirtualTable)" /> method.
  18742. </returns>
  18743. </member>
  18744. <member name="M:System.Data.SQLite.SQLiteModuleNoop.Commit(System.Data.SQLite.SQLiteVirtualTable)">
  18745. <summary>
  18746. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Commit(System.Data.SQLite.SQLiteVirtualTable)" /> method.
  18747. </summary>
  18748. <param name="table">
  18749. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Commit(System.Data.SQLite.SQLiteVirtualTable)" /> method.
  18750. </param>
  18751. <returns>
  18752. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Commit(System.Data.SQLite.SQLiteVirtualTable)" /> method.
  18753. </returns>
  18754. </member>
  18755. <member name="M:System.Data.SQLite.SQLiteModuleNoop.Rollback(System.Data.SQLite.SQLiteVirtualTable)">
  18756. <summary>
  18757. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Rollback(System.Data.SQLite.SQLiteVirtualTable)" /> method.
  18758. </summary>
  18759. <param name="table">
  18760. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Rollback(System.Data.SQLite.SQLiteVirtualTable)" /> method.
  18761. </param>
  18762. <returns>
  18763. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Rollback(System.Data.SQLite.SQLiteVirtualTable)" /> method.
  18764. </returns>
  18765. </member>
  18766. <member name="M:System.Data.SQLite.SQLiteModuleNoop.FindFunction(System.Data.SQLite.SQLiteVirtualTable,System.Int32,System.String,System.Data.SQLite.SQLiteFunction@,System.IntPtr@)">
  18767. <summary>
  18768. 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.
  18769. </summary>
  18770. <param name="table">
  18771. 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.
  18772. </param>
  18773. <param name="argumentCount">
  18774. 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.
  18775. </param>
  18776. <param name="name">
  18777. 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.
  18778. </param>
  18779. <param name="function">
  18780. 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.
  18781. </param>
  18782. <param name="pClientData">
  18783. 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.
  18784. </param>
  18785. <returns>
  18786. 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.
  18787. </returns>
  18788. </member>
  18789. <member name="M:System.Data.SQLite.SQLiteModuleNoop.Rename(System.Data.SQLite.SQLiteVirtualTable,System.String)">
  18790. <summary>
  18791. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Rename(System.Data.SQLite.SQLiteVirtualTable,System.String)" /> method.
  18792. </summary>
  18793. <param name="table">
  18794. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Rename(System.Data.SQLite.SQLiteVirtualTable,System.String)" /> method.
  18795. </param>
  18796. <param name="newName">
  18797. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Rename(System.Data.SQLite.SQLiteVirtualTable,System.String)" /> method.
  18798. </param>
  18799. <returns>
  18800. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Rename(System.Data.SQLite.SQLiteVirtualTable,System.String)" /> method.
  18801. </returns>
  18802. </member>
  18803. <member name="M:System.Data.SQLite.SQLiteModuleNoop.Savepoint(System.Data.SQLite.SQLiteVirtualTable,System.Int32)">
  18804. <summary>
  18805. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Savepoint(System.Data.SQLite.SQLiteVirtualTable,System.Int32)" /> method.
  18806. </summary>
  18807. <param name="table">
  18808. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Savepoint(System.Data.SQLite.SQLiteVirtualTable,System.Int32)" /> method.
  18809. </param>
  18810. <param name="savepoint">
  18811. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Savepoint(System.Data.SQLite.SQLiteVirtualTable,System.Int32)" /> method.
  18812. </param>
  18813. <returns>
  18814. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Savepoint(System.Data.SQLite.SQLiteVirtualTable,System.Int32)" /> method.
  18815. </returns>
  18816. </member>
  18817. <member name="M:System.Data.SQLite.SQLiteModuleNoop.Release(System.Data.SQLite.SQLiteVirtualTable,System.Int32)">
  18818. <summary>
  18819. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Release(System.Data.SQLite.SQLiteVirtualTable,System.Int32)" /> method.
  18820. </summary>
  18821. <param name="table">
  18822. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Release(System.Data.SQLite.SQLiteVirtualTable,System.Int32)" /> method.
  18823. </param>
  18824. <param name="savepoint">
  18825. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Release(System.Data.SQLite.SQLiteVirtualTable,System.Int32)" /> method.
  18826. </param>
  18827. <returns>
  18828. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.Release(System.Data.SQLite.SQLiteVirtualTable,System.Int32)" /> method.
  18829. </returns>
  18830. </member>
  18831. <member name="M:System.Data.SQLite.SQLiteModuleNoop.RollbackTo(System.Data.SQLite.SQLiteVirtualTable,System.Int32)">
  18832. <summary>
  18833. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.RollbackTo(System.Data.SQLite.SQLiteVirtualTable,System.Int32)" /> method.
  18834. </summary>
  18835. <param name="table">
  18836. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.RollbackTo(System.Data.SQLite.SQLiteVirtualTable,System.Int32)" /> method.
  18837. </param>
  18838. <param name="savepoint">
  18839. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.RollbackTo(System.Data.SQLite.SQLiteVirtualTable,System.Int32)" /> method.
  18840. </param>
  18841. <returns>
  18842. See the <see cref="M:System.Data.SQLite.ISQLiteManagedModule.RollbackTo(System.Data.SQLite.SQLiteVirtualTable,System.Int32)" /> method.
  18843. </returns>
  18844. </member>
  18845. <member name="M:System.Data.SQLite.SQLiteModuleNoop.CheckDisposed">
  18846. <summary>
  18847. Throws an <see cref="T:System.ObjectDisposedException" /> if this object
  18848. instance has been disposed.
  18849. </summary>
  18850. </member>
  18851. <member name="M:System.Data.SQLite.SQLiteModuleNoop.Dispose(System.Boolean)">
  18852. <summary>
  18853. Disposes of this object instance.
  18854. </summary>
  18855. <param name="disposing">
  18856. Non-zero if this method is being called from the
  18857. <see cref="M:System.IDisposable.Dispose" /> method. Zero if this method is
  18858. being called from the finalizer.
  18859. </param>
  18860. </member>
  18861. <member name="T:System.Data.SQLite.SQLiteChangeSetConflictType">
  18862. <summary>
  18863. This enumerated type represents a type of conflict seen when apply
  18864. changes from a change set or patch set.
  18865. </summary>
  18866. </member>
  18867. <member name="F:System.Data.SQLite.SQLiteChangeSetConflictType.Data">
  18868. <summary>
  18869. This value is seen when processing a DELETE or UPDATE change if a
  18870. row with the required PRIMARY KEY fields is present in the
  18871. database, but one or more other (non primary-key) fields modified
  18872. by the update do not contain the expected "before" values.
  18873. </summary>
  18874. </member>
  18875. <member name="F:System.Data.SQLite.SQLiteChangeSetConflictType.NotFound">
  18876. <summary>
  18877. This value is seen when processing a DELETE or UPDATE change if a
  18878. row with the required PRIMARY KEY fields is not present in the
  18879. database. There is no conflicting row in this case.
  18880. The results of invoking the
  18881. <see cref="M:System.Data.SQLite.ISQLiteChangeSetMetadataItem.GetConflictValue(System.Int32)" />
  18882. method are undefined.
  18883. </summary>
  18884. </member>
  18885. <member name="F:System.Data.SQLite.SQLiteChangeSetConflictType.Conflict">
  18886. <summary>
  18887. This value is seen when processing an INSERT change if the
  18888. operation would result in duplicate primary key values.
  18889. The conflicting row in this case is the database row with the
  18890. matching primary key.
  18891. </summary>
  18892. </member>
  18893. <member name="F:System.Data.SQLite.SQLiteChangeSetConflictType.Constraint">
  18894. <summary>
  18895. If a non-foreign key constraint violation occurs while applying a
  18896. change (i.e. a UNIQUE, CHECK or NOT NULL constraint), the conflict
  18897. callback will see this value.
  18898. There is no conflicting row in this case. The results of invoking
  18899. the <see cref="M:System.Data.SQLite.ISQLiteChangeSetMetadataItem.GetConflictValue(System.Int32)" />
  18900. method are undefined.
  18901. </summary>
  18902. </member>
  18903. <member name="F:System.Data.SQLite.SQLiteChangeSetConflictType.ForeignKey">
  18904. <summary>
  18905. If foreign key handling is enabled, and applying a changes leaves
  18906. the database in a state containing foreign key violations, this
  18907. value will be seen exactly once before the changes are committed.
  18908. If the conflict handler
  18909. <see cref="F:System.Data.SQLite.SQLiteChangeSetConflictResult.Omit" />, the changes,
  18910. including those that caused the foreign key constraint violation,
  18911. are committed. Or, if it returns
  18912. <see cref="F:System.Data.SQLite.SQLiteChangeSetConflictResult.Abort" />, the changes are
  18913. rolled back.
  18914. No current or conflicting row information is provided. The only
  18915. method it is possible to call on the supplied
  18916. <see cref="T:System.Data.SQLite.ISQLiteChangeSetMetadataItem" /> object is
  18917. <see cref="P:System.Data.SQLite.ISQLiteChangeSetMetadataItem.NumberOfForeignKeyConflicts" />.
  18918. </summary>
  18919. </member>
  18920. <member name="T:System.Data.SQLite.SQLiteChangeSetConflictResult">
  18921. <summary>
  18922. This enumerated type represents the result of a user-defined conflict
  18923. resolution callback.
  18924. </summary>
  18925. </member>
  18926. <member name="F:System.Data.SQLite.SQLiteChangeSetConflictResult.Omit">
  18927. <summary>
  18928. If a conflict callback returns this value no special action is
  18929. taken. The change that caused the conflict is not applied. The
  18930. application of changes continues with the next change.
  18931. </summary>
  18932. </member>
  18933. <member name="F:System.Data.SQLite.SQLiteChangeSetConflictResult.Replace">
  18934. <summary>
  18935. This value may only be returned from a conflict callback if the
  18936. type of conflict was <see cref="F:System.Data.SQLite.SQLiteChangeSetConflictType.Data" />
  18937. or <see cref="F:System.Data.SQLite.SQLiteChangeSetConflictType.Conflict" />. If this is
  18938. not the case, any changes applied so far are rolled back and the
  18939. call to
  18940. <see cref="M:System.Data.SQLite.ISQLiteChangeSet.Apply(System.Data.SQLite.SessionConflictCallback,System.Data.SQLite.SessionTableFilterCallback,System.Object)" />
  18941. will raise a <see cref="T:System.Data.SQLite.SQLiteException" /> with an error code of
  18942. <see cref="F:System.Data.SQLite.SQLiteErrorCode.Misuse" />.
  18943. If this value is returned for a
  18944. <see cref="F:System.Data.SQLite.SQLiteChangeSetConflictType.Data" /> conflict, then the
  18945. conflicting row is either updated or deleted, depending on the type
  18946. of change.
  18947. If this value is returned for a
  18948. <see cref="F:System.Data.SQLite.SQLiteChangeSetConflictType.Conflict" /> conflict, then
  18949. the conflicting row is removed from the database and a second
  18950. attempt to apply the change is made. If this second attempt fails,
  18951. the original row is restored to the database before continuing.
  18952. </summary>
  18953. </member>
  18954. <member name="F:System.Data.SQLite.SQLiteChangeSetConflictResult.Abort">
  18955. <summary>
  18956. If this value is returned, any changes applied so far are rolled
  18957. back and the call to
  18958. <see cref="M:System.Data.SQLite.ISQLiteChangeSet.Apply(System.Data.SQLite.SessionConflictCallback,System.Data.SQLite.SessionTableFilterCallback,System.Object)" />
  18959. will raise a <see cref="T:System.Data.SQLite.SQLiteException" /> with an error code of
  18960. <see cref="F:System.Data.SQLite.SQLiteErrorCode.Abort" />.
  18961. </summary>
  18962. </member>
  18963. <member name="T:System.Data.SQLite.SQLiteChangeSetStartFlags">
  18964. <summary>
  18965. This enumerated type represents possible flags that may be passed
  18966. to the appropriate overloads of various change set creation methods.
  18967. </summary>
  18968. </member>
  18969. <member name="F:System.Data.SQLite.SQLiteChangeSetStartFlags.None">
  18970. <summary>
  18971. No special handling.
  18972. </summary>
  18973. </member>
  18974. <member name="F:System.Data.SQLite.SQLiteChangeSetStartFlags.Invert">
  18975. <summary>
  18976. Invert the change set while iterating through it.
  18977. This is equivalent to inverting a change set using
  18978. <see cref="M:System.Data.SQLite.ISQLiteChangeSet.Invert" /> before
  18979. applying it. It is an error to specify this flag
  18980. with a patch set.
  18981. </summary>
  18982. </member>
  18983. <member name="T:System.Data.SQLite.SessionTableFilterCallback">
  18984. <summary>
  18985. This callback is invoked when a determination must be made about
  18986. whether changes to a specific table should be tracked -OR- applied.
  18987. It will not be called for tables that are already attached to a
  18988. <see cref="T:System.Data.SQLite.ISQLiteSession" />.
  18989. </summary>
  18990. <param name="clientData">
  18991. The optional application-defined context data that was originally
  18992. passed to the <see cref="M:System.Data.SQLite.ISQLiteSession.SetTableFilter(System.Data.SQLite.SessionTableFilterCallback,System.Object)" /> or
  18993. <see cref="M:System.Data.SQLite.ISQLiteChangeSet.Apply(System.Data.SQLite.SessionConflictCallback,System.Data.SQLite.SessionTableFilterCallback,System.Object)" />
  18994. methods. This value may be null.
  18995. </param>
  18996. <param name="name">
  18997. The name of the table.
  18998. </param>
  18999. <returns>
  19000. Non-zero if changes to the table should be considered; otherwise,
  19001. zero. Throwing an exception from this callback will result in
  19002. undefined behavior.
  19003. </returns>
  19004. </member>
  19005. <member name="T:System.Data.SQLite.SessionConflictCallback">
  19006. <summary>
  19007. This callback is invoked when there is a conflict while apply changes
  19008. to a database.
  19009. </summary>
  19010. <param name="clientData">
  19011. The optional application-defined context data that was originally
  19012. passed to the
  19013. <see cref="M:System.Data.SQLite.ISQLiteChangeSet.Apply(System.Data.SQLite.SessionConflictCallback,System.Data.SQLite.SessionTableFilterCallback,System.Object)" />
  19014. method. This value may be null.
  19015. </param>
  19016. <param name="type">
  19017. The type of this conflict.
  19018. </param>
  19019. <param name="item">
  19020. The <see cref="T:System.Data.SQLite.ISQLiteChangeSetMetadataItem" /> object associated with
  19021. this conflict. This value may not be null; however, only properties
  19022. that are applicable to the conflict type will be available. Further
  19023. information on this is available within the descriptions of the
  19024. available <see cref="T:System.Data.SQLite.SQLiteChangeSetConflictType" /> values.
  19025. </param>
  19026. <returns>
  19027. A <see cref="T:System.Data.SQLite.SQLiteChangeSetConflictResult" /> value that indicates the
  19028. action to be taken in order to resolve the conflict. Throwing an
  19029. exception from this callback will result in undefined behavior.
  19030. </returns>
  19031. </member>
  19032. <member name="T:System.Data.SQLite.ISQLiteChangeSet">
  19033. <summary>
  19034. This interface contains methods used to manipulate a set of changes for
  19035. a database.
  19036. </summary>
  19037. </member>
  19038. <member name="M:System.Data.SQLite.ISQLiteChangeSet.Invert">
  19039. <summary>
  19040. This method "inverts" the set of changes within this instance.
  19041. Applying an inverted set of changes to a database reverses the
  19042. effects of applying the uninverted changes. Specifically:
  19043. <![CDATA[<ul>]]><![CDATA[<li>]]>
  19044. Each DELETE change is changed to an INSERT, and
  19045. <![CDATA[</li>]]><![CDATA[<li>]]>
  19046. Each INSERT change is changed to a DELETE, and
  19047. <![CDATA[</li>]]><![CDATA[<li>]]>
  19048. For each UPDATE change, the old.* and new.* values are exchanged.
  19049. <![CDATA[</li>]]><![CDATA[</ul>]]>
  19050. This method does not change the order in which changes appear
  19051. within the set of changes. It merely reverses the sense of each
  19052. individual change.
  19053. </summary>
  19054. <returns>
  19055. The new <see cref="T:System.Data.SQLite.ISQLiteChangeSet" /> instance that represents
  19056. the resulting set of changes -OR- null if it is not available.
  19057. </returns>
  19058. </member>
  19059. <member name="M:System.Data.SQLite.ISQLiteChangeSet.CombineWith(System.Data.SQLite.ISQLiteChangeSet)">
  19060. <summary>
  19061. This method combines the specified set of changes with the ones
  19062. contained in this instance.
  19063. </summary>
  19064. <param name="changeSet">
  19065. The changes to be combined with those in this instance.
  19066. </param>
  19067. <returns>
  19068. The new <see cref="T:System.Data.SQLite.ISQLiteChangeSet" /> instance that represents
  19069. the resulting set of changes -OR- null if it is not available.
  19070. </returns>
  19071. </member>
  19072. <member name="M:System.Data.SQLite.ISQLiteChangeSet.Apply(System.Data.SQLite.SessionConflictCallback,System.Object)">
  19073. <summary>
  19074. Attempts to apply the set of changes in this instance to the
  19075. associated database.
  19076. </summary>
  19077. <param name="conflictCallback">
  19078. The <see cref="T:System.Data.SQLite.SessionConflictCallback" /> delegate that will need
  19079. to handle any conflicting changes that may arise.
  19080. </param>
  19081. <param name="clientData">
  19082. The optional application-defined context data. This value may be
  19083. null.
  19084. </param>
  19085. </member>
  19086. <member name="M:System.Data.SQLite.ISQLiteChangeSet.Apply(System.Data.SQLite.SessionConflictCallback,System.Data.SQLite.SessionTableFilterCallback,System.Object)">
  19087. <summary>
  19088. Attempts to apply the set of changes in this instance to the
  19089. associated database.
  19090. </summary>
  19091. <param name="conflictCallback">
  19092. The <see cref="T:System.Data.SQLite.SessionConflictCallback" /> delegate that will need
  19093. to handle any conflicting changes that may arise.
  19094. </param>
  19095. <param name="tableFilterCallback">
  19096. The optional <see cref="T:System.Data.SQLite.SessionTableFilterCallback" /> delegate
  19097. that can be used to filter the list of tables impacted by the set
  19098. of changes.
  19099. </param>
  19100. <param name="clientData">
  19101. The optional application-defined context data. This value may be
  19102. null.
  19103. </param>
  19104. </member>
  19105. <member name="T:System.Data.SQLite.ISQLiteChangeGroup">
  19106. <summary>
  19107. This interface contains methods used to manipulate multiple sets of
  19108. changes for a database.
  19109. </summary>
  19110. </member>
  19111. <member name="M:System.Data.SQLite.ISQLiteChangeGroup.AddChangeSet(System.Byte[])">
  19112. <summary>
  19113. Attempts to add a change set (or patch set) to this change group
  19114. instance. The underlying data must be contained entirely within
  19115. the <paramref name="rawData" /> byte array.
  19116. </summary>
  19117. <param name="rawData">
  19118. The raw byte data for the specified change set (or patch set).
  19119. </param>
  19120. </member>
  19121. <member name="M:System.Data.SQLite.ISQLiteChangeGroup.AddChangeSet(System.IO.Stream)">
  19122. <summary>
  19123. Attempts to add a change set (or patch set) to this change group
  19124. instance. The underlying data will be read from the specified
  19125. <see cref="T:System.IO.Stream" />.
  19126. </summary>
  19127. <param name="stream">
  19128. The <see cref="T:System.IO.Stream" /> instance containing the raw change set
  19129. (or patch set) data to read.
  19130. </param>
  19131. </member>
  19132. <member name="M:System.Data.SQLite.ISQLiteChangeGroup.CreateChangeSet(System.Byte[]@)">
  19133. <summary>
  19134. Attempts to create and return, via <paramref name="rawData" />, the
  19135. combined set of changes represented by this change group instance.
  19136. </summary>
  19137. <param name="rawData">
  19138. Upon success, this will contain the raw byte data for all the
  19139. changes in this change group instance.
  19140. </param>
  19141. </member>
  19142. <member name="M:System.Data.SQLite.ISQLiteChangeGroup.CreateChangeSet(System.IO.Stream)">
  19143. <summary>
  19144. Attempts to create and write, via <paramref name="stream" />, the
  19145. combined set of changes represented by this change group instance.
  19146. </summary>
  19147. <param name="stream">
  19148. Upon success, the raw byte data for all the changes in this change
  19149. group instance will be written to this <see cref="T:System.IO.Stream" />.
  19150. </param>
  19151. </member>
  19152. <member name="T:System.Data.SQLite.ISQLiteChangeSetMetadataItem">
  19153. <summary>
  19154. This interface contains properties and methods used to fetch metadata
  19155. about one change within a set of changes for a database.
  19156. </summary>
  19157. </member>
  19158. <member name="P:System.Data.SQLite.ISQLiteChangeSetMetadataItem.TableName">
  19159. <summary>
  19160. The name of the table the change was made to.
  19161. </summary>
  19162. </member>
  19163. <member name="P:System.Data.SQLite.ISQLiteChangeSetMetadataItem.NumberOfColumns">
  19164. <summary>
  19165. The number of columns impacted by this change. This value can be
  19166. used to determine the highest valid column index that may be used
  19167. with the <see cref="M:System.Data.SQLite.ISQLiteChangeSetMetadataItem.GetOldValue(System.Int32)" />, <see cref="M:System.Data.SQLite.ISQLiteChangeSetMetadataItem.GetNewValue(System.Int32)" />,
  19168. and <see cref="M:System.Data.SQLite.ISQLiteChangeSetMetadataItem.GetConflictValue(System.Int32)" /> methods of this interface. It
  19169. will be this value minus one.
  19170. </summary>
  19171. </member>
  19172. <member name="P:System.Data.SQLite.ISQLiteChangeSetMetadataItem.OperationCode">
  19173. <summary>
  19174. This will contain the value
  19175. <see cref="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Insert" />,
  19176. <see cref="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Update" />, or
  19177. <see cref="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Delete" />, corresponding to
  19178. the overall type of change this item represents.
  19179. </summary>
  19180. </member>
  19181. <member name="P:System.Data.SQLite.ISQLiteChangeSetMetadataItem.Indirect">
  19182. <summary>
  19183. Non-zero if this change is considered to be indirect (i.e. as
  19184. though they were made via a trigger or foreign key action).
  19185. </summary>
  19186. </member>
  19187. <member name="P:System.Data.SQLite.ISQLiteChangeSetMetadataItem.PrimaryKeyColumns">
  19188. <summary>
  19189. This array contains a <see cref="T:System.Boolean" /> for each column in
  19190. the table associated with this change. The element will be zero
  19191. if the column is not part of the primary key; otherwise, it will
  19192. be non-zero.
  19193. </summary>
  19194. </member>
  19195. <member name="P:System.Data.SQLite.ISQLiteChangeSetMetadataItem.NumberOfForeignKeyConflicts">
  19196. <summary>
  19197. This method may only be called from within a
  19198. <see cref="T:System.Data.SQLite.SessionConflictCallback" /> delegate when the conflict
  19199. type is <see cref="F:System.Data.SQLite.SQLiteChangeSetConflictType.ForeignKey" />. It
  19200. returns the total number of known foreign key violations in the
  19201. destination database.
  19202. </summary>
  19203. </member>
  19204. <member name="M:System.Data.SQLite.ISQLiteChangeSetMetadataItem.GetOldValue(System.Int32)">
  19205. <summary>
  19206. Queries and returns the original value of a given column for this
  19207. change. This method may only be called when the
  19208. <see cref="P:System.Data.SQLite.ISQLiteChangeSetMetadataItem.OperationCode" /> has a value of
  19209. <see cref="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Update" /> or
  19210. <see cref="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Delete" />.
  19211. </summary>
  19212. <param name="columnIndex">
  19213. The index for the column. This value must be between zero and one
  19214. less than the total number of columns for this table.
  19215. </param>
  19216. <returns>
  19217. The original value of a given column for this change.
  19218. </returns>
  19219. </member>
  19220. <member name="M:System.Data.SQLite.ISQLiteChangeSetMetadataItem.GetNewValue(System.Int32)">
  19221. <summary>
  19222. Queries and returns the updated value of a given column for this
  19223. change. This method may only be called when the
  19224. <see cref="P:System.Data.SQLite.ISQLiteChangeSetMetadataItem.OperationCode" /> has a value of
  19225. <see cref="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Insert" /> or
  19226. <see cref="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Update" />.
  19227. </summary>
  19228. <param name="columnIndex">
  19229. The index for the column. This value must be between zero and one
  19230. less than the total number of columns for this table.
  19231. </param>
  19232. <returns>
  19233. The updated value of a given column for this change.
  19234. </returns>
  19235. </member>
  19236. <member name="M:System.Data.SQLite.ISQLiteChangeSetMetadataItem.GetConflictValue(System.Int32)">
  19237. <summary>
  19238. Queries and returns the conflicting value of a given column for
  19239. this change. This method may only be called from within a
  19240. <see cref="T:System.Data.SQLite.SessionConflictCallback" /> delegate when the conflict
  19241. type is <see cref="F:System.Data.SQLite.SQLiteChangeSetConflictType.Data" /> or
  19242. <see cref="F:System.Data.SQLite.SQLiteChangeSetConflictType.Conflict" />.
  19243. </summary>
  19244. <param name="columnIndex">
  19245. The index for the column. This value must be between zero and one
  19246. less than the total number of columns for this table.
  19247. </param>
  19248. <returns>
  19249. The conflicting value of a given column for this change.
  19250. </returns>
  19251. </member>
  19252. <member name="T:System.Data.SQLite.ISQLiteSession">
  19253. <summary>
  19254. This interface contains methods to query and manipulate the state of a
  19255. change tracking session for a database.
  19256. </summary>
  19257. </member>
  19258. <member name="M:System.Data.SQLite.ISQLiteSession.IsEnabled">
  19259. <summary>
  19260. Determines if this session is currently tracking changes to its
  19261. associated database.
  19262. </summary>
  19263. <returns>
  19264. Non-zero if changes to the associated database are being trakced;
  19265. otherwise, zero.
  19266. </returns>
  19267. </member>
  19268. <member name="M:System.Data.SQLite.ISQLiteSession.SetToEnabled">
  19269. <summary>
  19270. Enables tracking of changes to the associated database.
  19271. </summary>
  19272. </member>
  19273. <member name="M:System.Data.SQLite.ISQLiteSession.SetToDisabled">
  19274. <summary>
  19275. Disables tracking of changes to the associated database.
  19276. </summary>
  19277. </member>
  19278. <member name="M:System.Data.SQLite.ISQLiteSession.IsIndirect">
  19279. <summary>
  19280. Determines if this session is currently set to mark changes as
  19281. indirect (i.e. as though they were made via a trigger or foreign
  19282. key action).
  19283. </summary>
  19284. <returns>
  19285. Non-zero if changes to the associated database are being marked as
  19286. indirect; otherwise, zero.
  19287. </returns>
  19288. </member>
  19289. <member name="M:System.Data.SQLite.ISQLiteSession.SetToIndirect">
  19290. <summary>
  19291. Sets the indirect flag for this session. Subsequent changes will
  19292. be marked as indirect until this flag is changed again.
  19293. </summary>
  19294. </member>
  19295. <member name="M:System.Data.SQLite.ISQLiteSession.SetToDirect">
  19296. <summary>
  19297. Clears the indirect flag for this session. Subsequent changes will
  19298. be marked as direct until this flag is changed again.
  19299. </summary>
  19300. </member>
  19301. <member name="M:System.Data.SQLite.ISQLiteSession.IsEmpty">
  19302. <summary>
  19303. Determines if there are any tracked changes currently within the
  19304. data for this session.
  19305. </summary>
  19306. <returns>
  19307. Non-zero if there are no changes within the data for this session;
  19308. otherwise, zero.
  19309. </returns>
  19310. </member>
  19311. <member name="M:System.Data.SQLite.ISQLiteSession.AttachTable(System.String)">
  19312. <summary>
  19313. Upon success, causes changes to the specified table(s) to start
  19314. being tracked. Any tables impacted by calls to this method will
  19315. not cause the <see cref="T:System.Data.SQLite.SessionTableFilterCallback" /> callback
  19316. to be invoked.
  19317. </summary>
  19318. <param name="name">
  19319. The name of the table to be tracked -OR- null to track all
  19320. applicable tables within this database.
  19321. </param>
  19322. </member>
  19323. <member name="M:System.Data.SQLite.ISQLiteSession.SetTableFilter(System.Data.SQLite.SessionTableFilterCallback,System.Object)">
  19324. <summary>
  19325. This method is used to set the table filter for this instance.
  19326. </summary>
  19327. <param name="callback">
  19328. The table filter callback -OR- null to clear any existing table
  19329. filter callback.
  19330. </param>
  19331. <param name="clientData">
  19332. The optional application-defined context data. This value may be
  19333. null.
  19334. </param>
  19335. </member>
  19336. <member name="M:System.Data.SQLite.ISQLiteSession.CreateChangeSet(System.Byte[]@)">
  19337. <summary>
  19338. Attempts to create and return, via <paramref name="rawData" />, the
  19339. combined set of changes represented by this session instance.
  19340. </summary>
  19341. <param name="rawData">
  19342. Upon success, this will contain the raw byte data for all the
  19343. changes in this session instance.
  19344. </param>
  19345. </member>
  19346. <member name="M:System.Data.SQLite.ISQLiteSession.CreateChangeSet(System.IO.Stream)">
  19347. <summary>
  19348. Attempts to create and write, via <paramref name="stream" />, the
  19349. combined set of changes represented by this session instance.
  19350. </summary>
  19351. <param name="stream">
  19352. Upon success, the raw byte data for all the changes in this session
  19353. instance will be written to this <see cref="T:System.IO.Stream" />.
  19354. </param>
  19355. </member>
  19356. <member name="M:System.Data.SQLite.ISQLiteSession.CreatePatchSet(System.Byte[]@)">
  19357. <summary>
  19358. Attempts to create and return, via <paramref name="rawData" />, the
  19359. combined set of changes represented by this session instance as a
  19360. patch set.
  19361. </summary>
  19362. <param name="rawData">
  19363. Upon success, this will contain the raw byte data for all the
  19364. changes in this session instance.
  19365. </param>
  19366. </member>
  19367. <member name="M:System.Data.SQLite.ISQLiteSession.CreatePatchSet(System.IO.Stream)">
  19368. <summary>
  19369. Attempts to create and write, via <paramref name="stream" />, the
  19370. combined set of changes represented by this session instance as a
  19371. patch set.
  19372. </summary>
  19373. <param name="stream">
  19374. Upon success, the raw byte data for all the changes in this session
  19375. instance will be written to this <see cref="T:System.IO.Stream" />.
  19376. </param>
  19377. </member>
  19378. <member name="M:System.Data.SQLite.ISQLiteSession.LoadDifferencesFromTable(System.String,System.String)">
  19379. <summary>
  19380. This method loads the differences between two tables [with the same
  19381. name, set of columns, and primary key definition] into this session
  19382. instance.
  19383. </summary>
  19384. <param name="fromDatabaseName">
  19385. The name of the database containing the table with the original
  19386. data (i.e. it will need updating in order to be identical to the
  19387. one within the database associated with this session instance).
  19388. </param>
  19389. <param name="tableName">
  19390. The name of the table.
  19391. </param>
  19392. </member>
  19393. <member name="T:System.Data.SQLite.SQLiteSessionHelpers">
  19394. <summary>
  19395. This class contains some static helper methods for use within this
  19396. subsystem.
  19397. </summary>
  19398. </member>
  19399. <member name="M:System.Data.SQLite.SQLiteSessionHelpers.CheckRawData(System.Byte[])">
  19400. <summary>
  19401. This method checks the byte array specified by the caller to make
  19402. sure it will be usable.
  19403. </summary>
  19404. <param name="rawData">
  19405. A byte array provided by the caller into one of the public methods
  19406. for the classes that belong to this subsystem. This value cannot
  19407. be null or represent an empty array; otherwise, an appropriate
  19408. exception will be thrown.
  19409. </param>
  19410. </member>
  19411. <member name="T:System.Data.SQLite.SQLiteConnectionLock">
  19412. <summary>
  19413. This class is used to hold the native connection handle associated with
  19414. a <see cref="T:System.Data.SQLite.SQLiteConnection" /> open until this subsystem is totally
  19415. done with it. This class is for internal use by this subsystem only.
  19416. </summary>
  19417. </member>
  19418. <member name="F:System.Data.SQLite.SQLiteConnectionLock.LockNopSql">
  19419. <summary>
  19420. The SQL statement used when creating the native statement handle.
  19421. There are no special requirements for this other than counting as
  19422. an "open statement handle".
  19423. </summary>
  19424. </member>
  19425. <member name="F:System.Data.SQLite.SQLiteConnectionLock.StatementMessageFormat">
  19426. <summary>
  19427. The format of the error message used when reporting, during object
  19428. disposal, that the statement handle is still open (i.e. because
  19429. this situation is considered a fairly serious programming error).
  19430. </summary>
  19431. </member>
  19432. <member name="F:System.Data.SQLite.SQLiteConnectionLock.handle">
  19433. <summary>
  19434. The wrapped native connection handle associated with this lock.
  19435. </summary>
  19436. </member>
  19437. <member name="F:System.Data.SQLite.SQLiteConnectionLock.flags">
  19438. <summary>
  19439. The flags associated with the connection represented by the
  19440. <see cref="F:System.Data.SQLite.SQLiteConnectionLock.handle" /> value.
  19441. </summary>
  19442. </member>
  19443. <member name="F:System.Data.SQLite.SQLiteConnectionLock.statement">
  19444. <summary>
  19445. The native statement handle for this lock. The garbage collector
  19446. cannot cause this statement to be finalized; therefore, it will
  19447. serve to hold the associated native connection open until it is
  19448. freed manually using the <see cref="M:System.Data.SQLite.SQLiteConnectionLock.Unlock" /> method.
  19449. </summary>
  19450. </member>
  19451. <member name="M:System.Data.SQLite.SQLiteConnectionLock.#ctor(System.Data.SQLite.SQLiteConnectionHandle,System.Data.SQLite.SQLiteConnectionFlags,System.Boolean)">
  19452. <summary>
  19453. Constructs a new instance of this class using the specified wrapped
  19454. native connection handle and associated flags.
  19455. </summary>
  19456. <param name="handle">
  19457. The wrapped native connection handle to be associated with this
  19458. lock.
  19459. </param>
  19460. <param name="flags">
  19461. The flags associated with the connection represented by the
  19462. <paramref name="handle" /> value.
  19463. </param>
  19464. <param name="autoLock">
  19465. Non-zero if the <see cref="M:System.Data.SQLite.SQLiteConnectionLock.Lock" /> method should be called prior
  19466. to returning from this constructor.
  19467. </param>
  19468. </member>
  19469. <member name="M:System.Data.SQLite.SQLiteConnectionLock.GetHandle">
  19470. <summary>
  19471. Queries and returns the wrapped native connection handle for this
  19472. instance.
  19473. </summary>
  19474. <returns>
  19475. The wrapped native connection handle for this instance -OR- null
  19476. if it is unavailable.
  19477. </returns>
  19478. </member>
  19479. <member name="M:System.Data.SQLite.SQLiteConnectionLock.GetFlags">
  19480. <summary>
  19481. Queries and returns the flags associated with the connection for
  19482. this instance.
  19483. </summary>
  19484. <returns>
  19485. The <see cref="T:System.Data.SQLite.SQLiteConnectionFlags" /> value. There is no return
  19486. value reserved to indicate an error.
  19487. </returns>
  19488. </member>
  19489. <member name="M:System.Data.SQLite.SQLiteConnectionLock.GetIntPtr">
  19490. <summary>
  19491. Queries and returns the native connection handle for this instance.
  19492. </summary>
  19493. <returns>
  19494. The native connection handle for this instance. If this value is
  19495. unavailable or invalid an exception will be thrown.
  19496. </returns>
  19497. </member>
  19498. <member name="M:System.Data.SQLite.SQLiteConnectionLock.Lock">
  19499. <summary>
  19500. This method attempts to "lock" the associated native connection
  19501. handle by preparing a SQL statement that will not be finalized
  19502. until the <see cref="M:System.Data.SQLite.SQLiteConnectionLock.Unlock" /> method is called (i.e. and which
  19503. cannot be done by the garbage collector). If the statement is
  19504. already prepared, nothing is done. If the statement cannot be
  19505. prepared for any reason, an exception will be thrown.
  19506. </summary>
  19507. </member>
  19508. <member name="M:System.Data.SQLite.SQLiteConnectionLock.Unlock">
  19509. <summary>
  19510. This method attempts to "unlock" the associated native connection
  19511. handle by finalizing the previously prepared statement. If the
  19512. statement is already finalized, nothing is done. If the statement
  19513. cannot be finalized for any reason, an exception will be thrown.
  19514. </summary>
  19515. </member>
  19516. <member name="M:System.Data.SQLite.SQLiteConnectionLock.Dispose">
  19517. <summary>
  19518. Disposes of this object instance.
  19519. </summary>
  19520. </member>
  19521. <member name="F:System.Data.SQLite.SQLiteConnectionLock.disposed">
  19522. <summary>
  19523. Non-zero if this object instance has been disposed.
  19524. </summary>
  19525. </member>
  19526. <member name="M:System.Data.SQLite.SQLiteConnectionLock.CheckDisposed">
  19527. <summary>
  19528. Throws an exception if this object instance has been disposed.
  19529. </summary>
  19530. </member>
  19531. <member name="M:System.Data.SQLite.SQLiteConnectionLock.Dispose(System.Boolean)">
  19532. <summary>
  19533. Disposes or finalizes this object instance.
  19534. </summary>
  19535. <param name="disposing">
  19536. Non-zero if this object is being disposed; otherwise, this object
  19537. is being finalized.
  19538. </param>
  19539. </member>
  19540. <member name="M:System.Data.SQLite.SQLiteConnectionLock.Finalize">
  19541. <summary>
  19542. Finalizes this object instance.
  19543. </summary>
  19544. </member>
  19545. <member name="T:System.Data.SQLite.SQLiteChangeSetIterator">
  19546. <summary>
  19547. This class manages the native change set iterator. It is used as the
  19548. base class for the <see cref="T:System.Data.SQLite.SQLiteMemoryChangeSetIterator" /> and
  19549. <see cref="T:System.Data.SQLite.SQLiteStreamChangeSetIterator" /> classes. It knows how to
  19550. advance the native iterator handle as well as finalize it.
  19551. </summary>
  19552. </member>
  19553. <member name="F:System.Data.SQLite.SQLiteChangeSetIterator.iterator">
  19554. <summary>
  19555. The native change set (a.k.a. iterator) handle.
  19556. </summary>
  19557. </member>
  19558. <member name="F:System.Data.SQLite.SQLiteChangeSetIterator.ownHandle">
  19559. <summary>
  19560. Non-zero if this instance owns the native iterator handle in the
  19561. <see cref="F:System.Data.SQLite.SQLiteChangeSetIterator.iterator" /> field. In that case, this instance will
  19562. finalize the native iterator handle upon being disposed or
  19563. finalized.
  19564. </summary>
  19565. </member>
  19566. <member name="M:System.Data.SQLite.SQLiteChangeSetIterator.#ctor(System.IntPtr,System.Boolean)">
  19567. <summary>
  19568. Constructs a new instance of this class using the specified native
  19569. iterator handle.
  19570. </summary>
  19571. <param name="iterator">
  19572. The native iterator handle to use.
  19573. </param>
  19574. <param name="ownHandle">
  19575. Non-zero if this instance is to take ownership of the native
  19576. iterator handle specified by <paramref name="iterator" />.
  19577. </param>
  19578. </member>
  19579. <member name="M:System.Data.SQLite.SQLiteChangeSetIterator.CheckHandle">
  19580. <summary>
  19581. Throws an exception if the native iterator handle is invalid.
  19582. </summary>
  19583. </member>
  19584. <member name="M:System.Data.SQLite.SQLiteChangeSetIterator.GetIntPtr">
  19585. <summary>
  19586. Used to query the native iterator handle. This method is only used
  19587. by the <see cref="T:System.Data.SQLite.SQLiteChangeSetMetadataItem" /> class.
  19588. </summary>
  19589. <returns>
  19590. The native iterator handle -OR- <see cref="F:System.IntPtr.Zero" /> if it
  19591. is not available.
  19592. </returns>
  19593. </member>
  19594. <member name="M:System.Data.SQLite.SQLiteChangeSetIterator.Next">
  19595. <summary>
  19596. Attempts to advance the native iterator handle to its next item.
  19597. </summary>
  19598. <returns>
  19599. Non-zero if the native iterator handle was advanced and contains
  19600. more data; otherwise, zero. If the underlying native API returns
  19601. an unexpected value then an exception will be thrown.
  19602. </returns>
  19603. </member>
  19604. <member name="M:System.Data.SQLite.SQLiteChangeSetIterator.Attach(System.IntPtr)">
  19605. <summary>
  19606. Attempts to create an instance of this class that is associated
  19607. with the specified native iterator handle. Ownership of the
  19608. native iterator handle is NOT transferred to the new instance of
  19609. this class.
  19610. </summary>
  19611. <param name="iterator">
  19612. The native iterator handle to use.
  19613. </param>
  19614. <returns>
  19615. The new instance of this class. No return value is reserved to
  19616. indicate an error; however, if the native iterator handle is not
  19617. valid, any subsequent attempt to make use of it via the returned
  19618. instance of this class may throw exceptions.
  19619. </returns>
  19620. </member>
  19621. <member name="M:System.Data.SQLite.SQLiteChangeSetIterator.Dispose">
  19622. <summary>
  19623. Disposes of this object instance.
  19624. </summary>
  19625. </member>
  19626. <member name="F:System.Data.SQLite.SQLiteChangeSetIterator.disposed">
  19627. <summary>
  19628. Non-zero if this object instance has been disposed.
  19629. </summary>
  19630. </member>
  19631. <member name="M:System.Data.SQLite.SQLiteChangeSetIterator.CheckDisposed">
  19632. <summary>
  19633. Throws an exception if this object instance has been disposed.
  19634. </summary>
  19635. </member>
  19636. <member name="M:System.Data.SQLite.SQLiteChangeSetIterator.Dispose(System.Boolean)">
  19637. <summary>
  19638. Disposes or finalizes this object instance.
  19639. </summary>
  19640. <param name="disposing">
  19641. Non-zero if this object is being disposed; otherwise, this object
  19642. is being finalized.
  19643. </param>
  19644. </member>
  19645. <member name="M:System.Data.SQLite.SQLiteChangeSetIterator.Finalize">
  19646. <summary>
  19647. Finalizes this object instance.
  19648. </summary>
  19649. </member>
  19650. <member name="T:System.Data.SQLite.SQLiteMemoryChangeSetIterator">
  19651. <summary>
  19652. This class manages the native change set iterator for a set of changes
  19653. contained entirely in memory.
  19654. </summary>
  19655. </member>
  19656. <member name="F:System.Data.SQLite.SQLiteMemoryChangeSetIterator.pData">
  19657. <summary>
  19658. The native memory buffer allocated to contain the set of changes
  19659. associated with this instance. This will always be freed when this
  19660. instance is disposed or finalized.
  19661. </summary>
  19662. </member>
  19663. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSetIterator.#ctor(System.IntPtr,System.IntPtr,System.Boolean)">
  19664. <summary>
  19665. Constructs an instance of this class using the specified native
  19666. memory buffer and native iterator handle.
  19667. </summary>
  19668. <param name="pData">
  19669. The native memory buffer to use.
  19670. </param>
  19671. <param name="iterator">
  19672. The native iterator handle to use.
  19673. </param>
  19674. <param name="ownHandle">
  19675. Non-zero if this instance is to take ownership of the native
  19676. iterator handle specified by <paramref name="iterator" />.
  19677. </param>
  19678. </member>
  19679. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSetIterator.Create(System.Byte[])">
  19680. <summary>
  19681. Attempts to create an instance of this class using the specified
  19682. raw byte data.
  19683. </summary>
  19684. <param name="rawData">
  19685. The raw byte data containing the set of changes for this native
  19686. iterator.
  19687. </param>
  19688. <returns>
  19689. The new instance of this class -OR- null if it cannot be created.
  19690. </returns>
  19691. </member>
  19692. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSetIterator.Create(System.Byte[],System.Data.SQLite.SQLiteChangeSetStartFlags)">
  19693. <summary>
  19694. Attempts to create an instance of this class using the specified
  19695. raw byte data.
  19696. </summary>
  19697. <param name="rawData">
  19698. The raw byte data containing the set of changes for this native
  19699. iterator.
  19700. </param>
  19701. <param name="flags">
  19702. The flags used to create the change set iterator.
  19703. </param>
  19704. <returns>
  19705. The new instance of this class -OR- null if it cannot be created.
  19706. </returns>
  19707. </member>
  19708. <member name="F:System.Data.SQLite.SQLiteMemoryChangeSetIterator.disposed">
  19709. <summary>
  19710. Non-zero if this object instance has been disposed.
  19711. </summary>
  19712. </member>
  19713. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSetIterator.CheckDisposed">
  19714. <summary>
  19715. Throws an exception if this object instance has been disposed.
  19716. </summary>
  19717. </member>
  19718. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSetIterator.Dispose(System.Boolean)">
  19719. <summary>
  19720. Disposes or finalizes this object instance.
  19721. </summary>
  19722. <param name="disposing">
  19723. Non-zero if this object is being disposed; otherwise, this object
  19724. is being finalized.
  19725. </param>
  19726. </member>
  19727. <member name="T:System.Data.SQLite.SQLiteStreamChangeSetIterator">
  19728. <summary>
  19729. This class manages the native change set iterator for a set of changes
  19730. backed by a <see cref="T:System.IO.Stream" /> instance.
  19731. </summary>
  19732. </member>
  19733. <member name="F:System.Data.SQLite.SQLiteStreamChangeSetIterator.streamAdapter">
  19734. <summary>
  19735. The <see cref="T:System.Data.SQLite.SQLiteStreamAdapter" /> instance that is managing
  19736. the underlying <see cref="T:System.IO.Stream" /> used as the backing store for
  19737. the set of changes associated with this native change set iterator.
  19738. </summary>
  19739. </member>
  19740. <member name="M:System.Data.SQLite.SQLiteStreamChangeSetIterator.#ctor(System.Data.SQLite.SQLiteStreamAdapter,System.IntPtr,System.Boolean)">
  19741. <summary>
  19742. Constructs an instance of this class using the specified native
  19743. iterator handle and <see cref="T:System.Data.SQLite.SQLiteStreamAdapter" />.
  19744. </summary>
  19745. <param name="streamAdapter">
  19746. The <see cref="T:System.Data.SQLite.SQLiteStreamAdapter" /> instance to use.
  19747. </param>
  19748. <param name="iterator">
  19749. The native iterator handle to use.
  19750. </param>
  19751. <param name="ownHandle">
  19752. Non-zero if this instance is to take ownership of the native
  19753. iterator handle specified by <paramref name="iterator" />.
  19754. </param>
  19755. </member>
  19756. <member name="M:System.Data.SQLite.SQLiteStreamChangeSetIterator.Create(System.IO.Stream,System.Data.SQLite.SQLiteConnectionFlags)">
  19757. <summary>
  19758. Attempts to create an instance of this class using the specified
  19759. <see cref="T:System.IO.Stream" />.
  19760. </summary>
  19761. <param name="stream">
  19762. The <see cref="T:System.IO.Stream" /> where the raw byte data for the set of
  19763. changes may be read.
  19764. </param>
  19765. <param name="connectionFlags">
  19766. The flags associated with the parent connection.
  19767. </param>
  19768. <returns>
  19769. The new instance of this class -OR- null if it cannot be created.
  19770. </returns>
  19771. </member>
  19772. <member name="M:System.Data.SQLite.SQLiteStreamChangeSetIterator.Create(System.IO.Stream,System.Data.SQLite.SQLiteConnectionFlags,System.Data.SQLite.SQLiteChangeSetStartFlags)">
  19773. <summary>
  19774. Attempts to create an instance of this class using the specified
  19775. <see cref="T:System.IO.Stream" />.
  19776. </summary>
  19777. <param name="stream">
  19778. The <see cref="T:System.IO.Stream" /> where the raw byte data for the set of
  19779. changes may be read.
  19780. </param>
  19781. <param name="connectionFlags">
  19782. The flags associated with the parent connection.
  19783. </param>
  19784. <param name="startFlags">
  19785. The flags used to create the change set iterator.
  19786. </param>
  19787. <returns>
  19788. The new instance of this class -OR- null if it cannot be created.
  19789. </returns>
  19790. </member>
  19791. <member name="F:System.Data.SQLite.SQLiteStreamChangeSetIterator.disposed">
  19792. <summary>
  19793. Non-zero if this object instance has been disposed.
  19794. </summary>
  19795. </member>
  19796. <member name="M:System.Data.SQLite.SQLiteStreamChangeSetIterator.CheckDisposed">
  19797. <summary>
  19798. Throws an exception if this object instance has been disposed.
  19799. </summary>
  19800. </member>
  19801. <member name="M:System.Data.SQLite.SQLiteStreamChangeSetIterator.Dispose(System.Boolean)">
  19802. <summary>
  19803. Disposes or finalizes this object instance.
  19804. </summary>
  19805. <param name="disposing">
  19806. Non-zero if this object is being disposed; otherwise, this object
  19807. is being finalized.
  19808. </param>
  19809. </member>
  19810. <member name="T:System.Data.SQLite.SQLiteStreamAdapter">
  19811. <summary>
  19812. This class is used to act as a bridge between a <see cref="T:System.IO.Stream" />
  19813. instance and the delegates used with the native streaming API.
  19814. </summary>
  19815. </member>
  19816. <member name="F:System.Data.SQLite.SQLiteStreamAdapter.stream">
  19817. <summary>
  19818. The managed stream instance used to in order to service the native
  19819. delegates for both input and output.
  19820. </summary>
  19821. </member>
  19822. <member name="F:System.Data.SQLite.SQLiteStreamAdapter.flags">
  19823. <summary>
  19824. The flags associated with the connection.
  19825. </summary>
  19826. </member>
  19827. <member name="F:System.Data.SQLite.SQLiteStreamAdapter.xInput">
  19828. <summary>
  19829. The delegate used to provide input to the native streaming API.
  19830. It will be null -OR- point to the <see cref="M:System.Data.SQLite.SQLiteStreamAdapter.Input(System.IntPtr,System.IntPtr,System.Int32@)" /> method.
  19831. </summary>
  19832. </member>
  19833. <member name="F:System.Data.SQLite.SQLiteStreamAdapter.xOutput">
  19834. <summary>
  19835. The delegate used to provide output to the native streaming API.
  19836. It will be null -OR- point to the <see cref="M:System.Data.SQLite.SQLiteStreamAdapter.Output(System.IntPtr,System.IntPtr,System.Int32)" /> method.
  19837. </summary>
  19838. </member>
  19839. <member name="M:System.Data.SQLite.SQLiteStreamAdapter.#ctor(System.IO.Stream,System.Data.SQLite.SQLiteConnectionFlags)">
  19840. <summary>
  19841. Constructs a new instance of this class using the specified managed
  19842. stream and connection flags.
  19843. </summary>
  19844. <param name="stream">
  19845. The managed stream instance to be used in order to service the
  19846. native delegates for both input and output.
  19847. </param>
  19848. <param name="flags">
  19849. The flags associated with the parent connection.
  19850. </param>
  19851. </member>
  19852. <member name="M:System.Data.SQLite.SQLiteStreamAdapter.GetFlags">
  19853. <summary>
  19854. Queries and returns the flags associated with the connection for
  19855. this instance.
  19856. </summary>
  19857. <returns>
  19858. The <see cref="T:System.Data.SQLite.SQLiteConnectionFlags" /> value. There is no return
  19859. value reserved to indicate an error.
  19860. </returns>
  19861. </member>
  19862. <member name="M:System.Data.SQLite.SQLiteStreamAdapter.GetInputDelegate">
  19863. <summary>
  19864. Returns a delegate that wraps the <see cref="M:System.Data.SQLite.SQLiteStreamAdapter.Input(System.IntPtr,System.IntPtr,System.Int32@)" /> method,
  19865. creating it first if necessary.
  19866. </summary>
  19867. <returns>
  19868. A delegate that refers to the <see cref="M:System.Data.SQLite.SQLiteStreamAdapter.Input(System.IntPtr,System.IntPtr,System.Int32@)" /> method.
  19869. </returns>
  19870. </member>
  19871. <member name="M:System.Data.SQLite.SQLiteStreamAdapter.GetOutputDelegate">
  19872. <summary>
  19873. Returns a delegate that wraps the <see cref="M:System.Data.SQLite.SQLiteStreamAdapter.Output(System.IntPtr,System.IntPtr,System.Int32)" /> method,
  19874. creating it first if necessary.
  19875. </summary>
  19876. <returns>
  19877. A delegate that refers to the <see cref="M:System.Data.SQLite.SQLiteStreamAdapter.Output(System.IntPtr,System.IntPtr,System.Int32)" /> method.
  19878. </returns>
  19879. </member>
  19880. <member name="M:System.Data.SQLite.SQLiteStreamAdapter.Input(System.IntPtr,System.IntPtr,System.Int32@)">
  19881. <summary>
  19882. This method attempts to read <paramref name="nData" /> bytes from
  19883. the managed stream, writing them to the <paramref name="pData"/>
  19884. buffer.
  19885. </summary>
  19886. <param name="context">
  19887. Optional extra context information. Currently, this will always
  19888. have a value of <see cref="F:System.IntPtr.Zero" />.
  19889. </param>
  19890. <param name="pData">
  19891. A preallocated native buffer to receive the requested input bytes.
  19892. It must be at least <paramref name="nData" /> bytes in size.
  19893. </param>
  19894. <param name="nData">
  19895. Upon entry, the number of bytes to read. Upon exit, the number of
  19896. bytes actually read. This value may be zero upon exit.
  19897. </param>
  19898. <returns>
  19899. The value <see cref="F:System.Data.SQLite.SQLiteErrorCode.Ok" /> upon success -OR- an
  19900. appropriate error code upon failure.
  19901. </returns>
  19902. </member>
  19903. <member name="M:System.Data.SQLite.SQLiteStreamAdapter.Output(System.IntPtr,System.IntPtr,System.Int32)">
  19904. <summary>
  19905. This method attempts to write <paramref name="nData" /> bytes to
  19906. the managed stream, reading them from the <paramref name="pData"/>
  19907. buffer.
  19908. </summary>
  19909. <param name="context">
  19910. Optional extra context information. Currently, this will always
  19911. have a value of <see cref="F:System.IntPtr.Zero" />.
  19912. </param>
  19913. <param name="pData">
  19914. A preallocated native buffer containing the requested output
  19915. bytes. It must be at least <paramref name="nData" /> bytes in
  19916. size.
  19917. </param>
  19918. <param name="nData">
  19919. The number of bytes to write.
  19920. </param>
  19921. <returns>
  19922. The value <see cref="F:System.Data.SQLite.SQLiteErrorCode.Ok" /> upon success -OR- an
  19923. appropriate error code upon failure.
  19924. </returns>
  19925. </member>
  19926. <member name="M:System.Data.SQLite.SQLiteStreamAdapter.Dispose">
  19927. <summary>
  19928. Disposes of this object instance.
  19929. </summary>
  19930. </member>
  19931. <member name="F:System.Data.SQLite.SQLiteStreamAdapter.disposed">
  19932. <summary>
  19933. Non-zero if this object instance has been disposed.
  19934. </summary>
  19935. </member>
  19936. <member name="M:System.Data.SQLite.SQLiteStreamAdapter.CheckDisposed">
  19937. <summary>
  19938. Throws an exception if this object instance has been disposed.
  19939. </summary>
  19940. </member>
  19941. <member name="M:System.Data.SQLite.SQLiteStreamAdapter.Dispose(System.Boolean)">
  19942. <summary>
  19943. Disposes or finalizes this object instance.
  19944. </summary>
  19945. <param name="disposing">
  19946. Non-zero if this object is being disposed; otherwise, this object
  19947. is being finalized.
  19948. </param>
  19949. </member>
  19950. <member name="M:System.Data.SQLite.SQLiteStreamAdapter.Finalize">
  19951. <summary>
  19952. Finalizes this object instance.
  19953. </summary>
  19954. </member>
  19955. <member name="T:System.Data.SQLite.SQLiteSessionStreamManager">
  19956. <summary>
  19957. This class manages a collection of <see cref="T:System.Data.SQLite.SQLiteStreamAdapter"/>
  19958. instances. When used, it takes responsibility for creating, returning,
  19959. and disposing of its <see cref="T:System.Data.SQLite.SQLiteStreamAdapter"/> instances.
  19960. </summary>
  19961. </member>
  19962. <member name="F:System.Data.SQLite.SQLiteSessionStreamManager.streamAdapters">
  19963. <summary>
  19964. The managed collection of <see cref="T:System.Data.SQLite.SQLiteStreamAdapter" />
  19965. instances, keyed by their associated <see cref="T:System.IO.Stream" />
  19966. instance.
  19967. </summary>
  19968. </member>
  19969. <member name="F:System.Data.SQLite.SQLiteSessionStreamManager.flags">
  19970. <summary>
  19971. The flags associated with the connection.
  19972. </summary>
  19973. </member>
  19974. <member name="M:System.Data.SQLite.SQLiteSessionStreamManager.#ctor(System.Data.SQLite.SQLiteConnectionFlags)">
  19975. <summary>
  19976. Constructs a new instance of this class using the specified
  19977. connection flags.
  19978. </summary>
  19979. <param name="flags">
  19980. The flags associated with the parent connection.
  19981. </param>
  19982. </member>
  19983. <member name="M:System.Data.SQLite.SQLiteSessionStreamManager.InitializeStreamAdapters">
  19984. <summary>
  19985. Makes sure the collection of <see cref="T:System.Data.SQLite.SQLiteStreamAdapter" />
  19986. is created.
  19987. </summary>
  19988. </member>
  19989. <member name="M:System.Data.SQLite.SQLiteSessionStreamManager.DisposeStreamAdapters">
  19990. <summary>
  19991. Makes sure the collection of <see cref="T:System.Data.SQLite.SQLiteStreamAdapter" />
  19992. is disposed.
  19993. </summary>
  19994. </member>
  19995. <member name="M:System.Data.SQLite.SQLiteSessionStreamManager.GetAdapter(System.IO.Stream)">
  19996. <summary>
  19997. Attempts to return a <see cref="T:System.Data.SQLite.SQLiteStreamAdapter" /> instance
  19998. suitable for the specified <see cref="T:System.IO.Stream" />.
  19999. </summary>
  20000. <param name="stream">
  20001. The <see cref="T:System.IO.Stream" /> instance. If this value is null, a null
  20002. value will be returned.
  20003. </param>
  20004. <returns>
  20005. A <see cref="T:System.Data.SQLite.SQLiteStreamAdapter" /> instance. Typically, these
  20006. are always freshly created; however, this method is designed to
  20007. return the existing <see cref="T:System.Data.SQLite.SQLiteStreamAdapter" /> instance
  20008. associated with the specified stream, should one exist.
  20009. </returns>
  20010. </member>
  20011. <member name="M:System.Data.SQLite.SQLiteSessionStreamManager.Dispose">
  20012. <summary>
  20013. Disposes of this object instance.
  20014. </summary>
  20015. </member>
  20016. <member name="F:System.Data.SQLite.SQLiteSessionStreamManager.disposed">
  20017. <summary>
  20018. Non-zero if this object instance has been disposed.
  20019. </summary>
  20020. </member>
  20021. <member name="M:System.Data.SQLite.SQLiteSessionStreamManager.CheckDisposed">
  20022. <summary>
  20023. Throws an exception if this object instance has been disposed.
  20024. </summary>
  20025. </member>
  20026. <member name="M:System.Data.SQLite.SQLiteSessionStreamManager.Dispose(System.Boolean)">
  20027. <summary>
  20028. Disposes or finalizes this object instance.
  20029. </summary>
  20030. <param name="disposing">
  20031. Non-zero if this object is being disposed; otherwise, this object
  20032. is being finalized.
  20033. </param>
  20034. </member>
  20035. <member name="M:System.Data.SQLite.SQLiteSessionStreamManager.Finalize">
  20036. <summary>
  20037. Finalizes this object instance.
  20038. </summary>
  20039. </member>
  20040. <member name="T:System.Data.SQLite.SQLiteChangeGroup">
  20041. <summary>
  20042. This class represents a group of change sets (or patch sets).
  20043. </summary>
  20044. </member>
  20045. <member name="F:System.Data.SQLite.SQLiteChangeGroup.streamManager">
  20046. <summary>
  20047. The <see cref="T:System.Data.SQLite.SQLiteSessionStreamManager" /> instance associated
  20048. with this change group.
  20049. </summary>
  20050. </member>
  20051. <member name="F:System.Data.SQLite.SQLiteChangeGroup.flags">
  20052. <summary>
  20053. The flags associated with the connection.
  20054. </summary>
  20055. </member>
  20056. <member name="F:System.Data.SQLite.SQLiteChangeGroup.changeGroup">
  20057. <summary>
  20058. The native handle for this change group. This will be deleted when
  20059. this instance is disposed or finalized.
  20060. </summary>
  20061. </member>
  20062. <member name="M:System.Data.SQLite.SQLiteChangeGroup.#ctor(System.Data.SQLite.SQLiteConnectionFlags)">
  20063. <summary>
  20064. Constructs a new instance of this class using the specified
  20065. connection flags.
  20066. </summary>
  20067. <param name="flags">
  20068. The flags associated with the parent connection.
  20069. </param>
  20070. </member>
  20071. <member name="M:System.Data.SQLite.SQLiteChangeGroup.CheckHandle">
  20072. <summary>
  20073. Throws an exception if the native change group handle is invalid.
  20074. </summary>
  20075. </member>
  20076. <member name="M:System.Data.SQLite.SQLiteChangeGroup.InitializeHandle">
  20077. <summary>
  20078. Makes sure the native change group handle is valid, creating it if
  20079. necessary.
  20080. </summary>
  20081. </member>
  20082. <member name="M:System.Data.SQLite.SQLiteChangeGroup.InitializeStreamManager">
  20083. <summary>
  20084. Makes sure the <see cref="T:System.Data.SQLite.SQLiteSessionStreamManager" /> instance
  20085. is available, creating it if necessary.
  20086. </summary>
  20087. </member>
  20088. <member name="M:System.Data.SQLite.SQLiteChangeGroup.GetStreamAdapter(System.IO.Stream)">
  20089. <summary>
  20090. Attempts to return a <see cref="T:System.Data.SQLite.SQLiteStreamAdapter" /> instance
  20091. suitable for the specified <see cref="T:System.IO.Stream" />.
  20092. </summary>
  20093. <param name="stream">
  20094. The <see cref="T:System.IO.Stream" /> instance. If this value is null, a null
  20095. value will be returned.
  20096. </param>
  20097. <returns>
  20098. A <see cref="T:System.Data.SQLite.SQLiteStreamAdapter" /> instance. Typically, these
  20099. are always freshly created; however, this method is designed to
  20100. return the existing <see cref="T:System.Data.SQLite.SQLiteStreamAdapter" /> instance
  20101. associated with the specified stream, should one exist.
  20102. </returns>
  20103. </member>
  20104. <member name="M:System.Data.SQLite.SQLiteChangeGroup.AddChangeSet(System.Byte[])">
  20105. <summary>
  20106. Attempts to add a change set (or patch set) to this change group
  20107. instance. The underlying data must be contained entirely within
  20108. the <paramref name="rawData" /> byte array.
  20109. </summary>
  20110. <param name="rawData">
  20111. The raw byte data for the specified change set (or patch set).
  20112. </param>
  20113. </member>
  20114. <member name="M:System.Data.SQLite.SQLiteChangeGroup.AddChangeSet(System.IO.Stream)">
  20115. <summary>
  20116. Attempts to add a change set (or patch set) to this change group
  20117. instance. The underlying data will be read from the specified
  20118. <see cref="T:System.IO.Stream" />.
  20119. </summary>
  20120. <param name="stream">
  20121. The <see cref="T:System.IO.Stream" /> instance containing the raw change set
  20122. (or patch set) data to read.
  20123. </param>
  20124. </member>
  20125. <member name="M:System.Data.SQLite.SQLiteChangeGroup.CreateChangeSet(System.Byte[]@)">
  20126. <summary>
  20127. Attempts to create and return, via <paramref name="rawData" />, the
  20128. combined set of changes represented by this change group instance.
  20129. </summary>
  20130. <param name="rawData">
  20131. Upon success, this will contain the raw byte data for all the
  20132. changes in this change group instance.
  20133. </param>
  20134. </member>
  20135. <member name="M:System.Data.SQLite.SQLiteChangeGroup.CreateChangeSet(System.IO.Stream)">
  20136. <summary>
  20137. Attempts to create and write, via <paramref name="stream" />, the
  20138. combined set of changes represented by this change group instance.
  20139. </summary>
  20140. <param name="stream">
  20141. Upon success, the raw byte data for all the changes in this change
  20142. group instance will be written to this <see cref="T:System.IO.Stream" />.
  20143. </param>
  20144. </member>
  20145. <member name="M:System.Data.SQLite.SQLiteChangeGroup.Dispose">
  20146. <summary>
  20147. Disposes of this object instance.
  20148. </summary>
  20149. </member>
  20150. <member name="F:System.Data.SQLite.SQLiteChangeGroup.disposed">
  20151. <summary>
  20152. Non-zero if this object instance has been disposed.
  20153. </summary>
  20154. </member>
  20155. <member name="M:System.Data.SQLite.SQLiteChangeGroup.CheckDisposed">
  20156. <summary>
  20157. Throws an exception if this object instance has been disposed.
  20158. </summary>
  20159. </member>
  20160. <member name="M:System.Data.SQLite.SQLiteChangeGroup.Dispose(System.Boolean)">
  20161. <summary>
  20162. Disposes or finalizes this object instance.
  20163. </summary>
  20164. <param name="disposing">
  20165. Non-zero if this object is being disposed; otherwise, this object
  20166. is being finalized.
  20167. </param>
  20168. </member>
  20169. <member name="M:System.Data.SQLite.SQLiteChangeGroup.Finalize">
  20170. <summary>
  20171. Finalizes this object instance.
  20172. </summary>
  20173. </member>
  20174. <member name="T:System.Data.SQLite.SQLiteSession">
  20175. <summary>
  20176. This class represents the change tracking session associated with a
  20177. database.
  20178. </summary>
  20179. </member>
  20180. <member name="F:System.Data.SQLite.SQLiteSession.streamManager">
  20181. <summary>
  20182. The <see cref="T:System.Data.SQLite.SQLiteSessionStreamManager" /> instance associated
  20183. with this session.
  20184. </summary>
  20185. </member>
  20186. <member name="F:System.Data.SQLite.SQLiteSession.databaseName">
  20187. <summary>
  20188. The name of the database (e.g. "main") for this session.
  20189. </summary>
  20190. </member>
  20191. <member name="F:System.Data.SQLite.SQLiteSession.session">
  20192. <summary>
  20193. The native handle for this session. This will be deleted when
  20194. this instance is disposed or finalized.
  20195. </summary>
  20196. </member>
  20197. <member name="F:System.Data.SQLite.SQLiteSession.xFilter">
  20198. <summary>
  20199. The delegate used to provide table filtering to the native API.
  20200. It will be null -OR- point to the <see cref="M:System.Data.SQLite.SQLiteSession.Filter(System.IntPtr,System.IntPtr)" /> method.
  20201. </summary>
  20202. </member>
  20203. <member name="F:System.Data.SQLite.SQLiteSession.tableFilterCallback">
  20204. <summary>
  20205. The managed callback used to filter tables for this session. Set
  20206. via the <see cref="M:System.Data.SQLite.SQLiteSession.SetTableFilter(System.Data.SQLite.SessionTableFilterCallback,System.Object)" /> method.
  20207. </summary>
  20208. </member>
  20209. <member name="F:System.Data.SQLite.SQLiteSession.tableFilterClientData">
  20210. <summary>
  20211. The optional application-defined context data that was passed to
  20212. the <see cref="M:System.Data.SQLite.SQLiteSession.SetTableFilter(System.Data.SQLite.SessionTableFilterCallback,System.Object)" /> method. This value may be null.
  20213. </summary>
  20214. </member>
  20215. <member name="M:System.Data.SQLite.SQLiteSession.#ctor(System.Data.SQLite.SQLiteConnectionHandle,System.Data.SQLite.SQLiteConnectionFlags,System.String)">
  20216. <summary>
  20217. Constructs a new instance of this class using the specified wrapped
  20218. native connection handle and associated flags.
  20219. </summary>
  20220. <param name="handle">
  20221. The wrapped native connection handle to be associated with this
  20222. session.
  20223. </param>
  20224. <param name="flags">
  20225. The flags associated with the connection represented by the
  20226. <paramref name="handle" /> value.
  20227. </param>
  20228. <param name="databaseName">
  20229. The name of the database (e.g. "main") for this session.
  20230. </param>
  20231. </member>
  20232. <member name="M:System.Data.SQLite.SQLiteSession.CheckHandle">
  20233. <summary>
  20234. Throws an exception if the native session handle is invalid.
  20235. </summary>
  20236. </member>
  20237. <member name="M:System.Data.SQLite.SQLiteSession.InitializeHandle">
  20238. <summary>
  20239. Makes sure the native session handle is valid, creating it if
  20240. necessary.
  20241. </summary>
  20242. </member>
  20243. <member name="M:System.Data.SQLite.SQLiteSession.ApplyTableFilter(System.Data.SQLite.SessionTableFilterCallback,System.Object)">
  20244. <summary>
  20245. This method sets up the internal table filtering associated state
  20246. of this instance.
  20247. </summary>
  20248. <param name="callback">
  20249. The table filter callback -OR- null to clear any existing table
  20250. filter callback.
  20251. </param>
  20252. <param name="clientData">
  20253. The optional application-defined context data. This value may be
  20254. null.
  20255. </param>
  20256. <returns>
  20257. The <see cref="T:System.Data.SQLite.UnsafeNativeMethods.xSessionFilter" /> native
  20258. delegate -OR- null to clear any existing table filter.
  20259. </returns>
  20260. </member>
  20261. <member name="M:System.Data.SQLite.SQLiteSession.InitializeStreamManager">
  20262. <summary>
  20263. Makes sure the <see cref="T:System.Data.SQLite.SQLiteSessionStreamManager" /> instance
  20264. is available, creating it if necessary.
  20265. </summary>
  20266. </member>
  20267. <member name="M:System.Data.SQLite.SQLiteSession.GetStreamAdapter(System.IO.Stream)">
  20268. <summary>
  20269. Attempts to return a <see cref="T:System.Data.SQLite.SQLiteStreamAdapter" /> instance
  20270. suitable for the specified <see cref="T:System.IO.Stream" />.
  20271. </summary>
  20272. <param name="stream">
  20273. The <see cref="T:System.IO.Stream" /> instance. If this value is null, a null
  20274. value will be returned.
  20275. </param>
  20276. <returns>
  20277. A <see cref="T:System.Data.SQLite.SQLiteStreamAdapter" /> instance. Typically, these
  20278. are always freshly created; however, this method is designed to
  20279. return the existing <see cref="T:System.Data.SQLite.SQLiteStreamAdapter" /> instance
  20280. associated with the specified stream, should one exist.
  20281. </returns>
  20282. </member>
  20283. <member name="M:System.Data.SQLite.SQLiteSession.Filter(System.IntPtr,System.IntPtr)">
  20284. <summary>
  20285. This method is called when determining if a table needs to be
  20286. included in the tracked changes for the associated database.
  20287. </summary>
  20288. <param name="context">
  20289. Optional extra context information. Currently, this will always
  20290. have a value of <see cref="F:System.IntPtr.Zero" />.
  20291. </param>
  20292. <param name="pTblName">
  20293. The native pointer to the name of the table.
  20294. </param>
  20295. <returns>
  20296. Non-zero if changes to the specified table should be considered;
  20297. otherwise, zero.
  20298. </returns>
  20299. </member>
  20300. <member name="M:System.Data.SQLite.SQLiteSession.IsEnabled">
  20301. <summary>
  20302. Determines if this session is currently tracking changes to its
  20303. associated database.
  20304. </summary>
  20305. <returns>
  20306. Non-zero if changes to the associated database are being trakced;
  20307. otherwise, zero.
  20308. </returns>
  20309. </member>
  20310. <member name="M:System.Data.SQLite.SQLiteSession.SetToEnabled">
  20311. <summary>
  20312. Enables tracking of changes to the associated database.
  20313. </summary>
  20314. </member>
  20315. <member name="M:System.Data.SQLite.SQLiteSession.SetToDisabled">
  20316. <summary>
  20317. Disables tracking of changes to the associated database.
  20318. </summary>
  20319. </member>
  20320. <member name="M:System.Data.SQLite.SQLiteSession.IsIndirect">
  20321. <summary>
  20322. Determines if this session is currently set to mark changes as
  20323. indirect (i.e. as though they were made via a trigger or foreign
  20324. key action).
  20325. </summary>
  20326. <returns>
  20327. Non-zero if changes to the associated database are being marked as
  20328. indirect; otherwise, zero.
  20329. </returns>
  20330. </member>
  20331. <member name="M:System.Data.SQLite.SQLiteSession.SetToIndirect">
  20332. <summary>
  20333. Sets the indirect flag for this session. Subsequent changes will
  20334. be marked as indirect until this flag is changed again.
  20335. </summary>
  20336. </member>
  20337. <member name="M:System.Data.SQLite.SQLiteSession.SetToDirect">
  20338. <summary>
  20339. Clears the indirect flag for this session. Subsequent changes will
  20340. be marked as direct until this flag is changed again.
  20341. </summary>
  20342. </member>
  20343. <member name="M:System.Data.SQLite.SQLiteSession.IsEmpty">
  20344. <summary>
  20345. Determines if there are any tracked changes currently within the
  20346. data for this session.
  20347. </summary>
  20348. <returns>
  20349. Non-zero if there are no changes within the data for this session;
  20350. otherwise, zero.
  20351. </returns>
  20352. </member>
  20353. <member name="M:System.Data.SQLite.SQLiteSession.AttachTable(System.String)">
  20354. <summary>
  20355. Upon success, causes changes to the specified table(s) to start
  20356. being tracked. Any tables impacted by calls to this method will
  20357. not cause the <see cref="T:System.Data.SQLite.SessionTableFilterCallback" /> callback
  20358. to be invoked.
  20359. </summary>
  20360. <param name="name">
  20361. The name of the table to be tracked -OR- null to track all
  20362. applicable tables within this database.
  20363. </param>
  20364. </member>
  20365. <member name="M:System.Data.SQLite.SQLiteSession.SetTableFilter(System.Data.SQLite.SessionTableFilterCallback,System.Object)">
  20366. <summary>
  20367. This method is used to set the table filter for this instance.
  20368. </summary>
  20369. <param name="callback">
  20370. The table filter callback -OR- null to clear any existing table
  20371. filter callback.
  20372. </param>
  20373. <param name="clientData">
  20374. The optional application-defined context data. This value may be
  20375. null.
  20376. </param>
  20377. </member>
  20378. <member name="M:System.Data.SQLite.SQLiteSession.CreateChangeSet(System.Byte[]@)">
  20379. <summary>
  20380. Attempts to create and return, via <paramref name="rawData" />, the
  20381. set of changes represented by this session instance.
  20382. </summary>
  20383. <param name="rawData">
  20384. Upon success, this will contain the raw byte data for all the
  20385. changes in this session instance.
  20386. </param>
  20387. </member>
  20388. <member name="M:System.Data.SQLite.SQLiteSession.CreateChangeSet(System.IO.Stream)">
  20389. <summary>
  20390. Attempts to create and write, via <paramref name="stream" />, the
  20391. set of changes represented by this session instance.
  20392. </summary>
  20393. <param name="stream">
  20394. Upon success, the raw byte data for all the changes in this session
  20395. instance will be written to this <see cref="T:System.IO.Stream" />.
  20396. </param>
  20397. </member>
  20398. <member name="M:System.Data.SQLite.SQLiteSession.CreatePatchSet(System.Byte[]@)">
  20399. <summary>
  20400. Attempts to create and return, via <paramref name="rawData" />, the
  20401. set of changes represented by this session instance as a patch set.
  20402. </summary>
  20403. <param name="rawData">
  20404. Upon success, this will contain the raw byte data for all the
  20405. changes in this session instance.
  20406. </param>
  20407. </member>
  20408. <member name="M:System.Data.SQLite.SQLiteSession.CreatePatchSet(System.IO.Stream)">
  20409. <summary>
  20410. Attempts to create and write, via <paramref name="stream" />, the
  20411. set of changes represented by this session instance as a patch set.
  20412. </summary>
  20413. <param name="stream">
  20414. Upon success, the raw byte data for all the changes in this session
  20415. instance will be written to this <see cref="T:System.IO.Stream" />.
  20416. </param>
  20417. </member>
  20418. <member name="M:System.Data.SQLite.SQLiteSession.LoadDifferencesFromTable(System.String,System.String)">
  20419. <summary>
  20420. This method loads the differences between two tables [with the same
  20421. name, set of columns, and primary key definition] into this session
  20422. instance.
  20423. </summary>
  20424. <param name="fromDatabaseName">
  20425. The name of the database containing the table with the original
  20426. data (i.e. it will need updating in order to be identical to the
  20427. one within the database associated with this session instance).
  20428. </param>
  20429. <param name="tableName">
  20430. The name of the table.
  20431. </param>
  20432. </member>
  20433. <member name="F:System.Data.SQLite.SQLiteSession.disposed">
  20434. <summary>
  20435. Non-zero if this object instance has been disposed.
  20436. </summary>
  20437. </member>
  20438. <member name="M:System.Data.SQLite.SQLiteSession.CheckDisposed">
  20439. <summary>
  20440. Throws an exception if this object instance has been disposed.
  20441. </summary>
  20442. </member>
  20443. <member name="M:System.Data.SQLite.SQLiteSession.Dispose(System.Boolean)">
  20444. <summary>
  20445. Disposes or finalizes this object instance.
  20446. </summary>
  20447. <param name="disposing">
  20448. Non-zero if this object is being disposed; otherwise, this object
  20449. is being finalized.
  20450. </param>
  20451. </member>
  20452. <member name="T:System.Data.SQLite.SQLiteChangeSetBase">
  20453. <summary>
  20454. This class represents the abstract concept of a set of changes. It
  20455. acts as the base class for the <see cref="T:System.Data.SQLite.SQLiteMemoryChangeSet" />
  20456. and <see cref="T:System.Data.SQLite.SQLiteStreamChangeSet" /> classes. It derives from
  20457. the <see cref="T:System.Data.SQLite.SQLiteConnectionLock" /> class, which is used to hold
  20458. the underlying native connection handle open until the instances of
  20459. this class are disposed or finalized. It also provides the ability
  20460. to construct wrapped native delegates of the
  20461. <see cref="T:System.Data.SQLite.UnsafeNativeMethods.xSessionFilter" /> and
  20462. <see cref="T:System.Data.SQLite.UnsafeNativeMethods.xSessionConflict" /> types.
  20463. </summary>
  20464. </member>
  20465. <member name="M:System.Data.SQLite.SQLiteChangeSetBase.#ctor(System.Data.SQLite.SQLiteConnectionHandle,System.Data.SQLite.SQLiteConnectionFlags)">
  20466. <summary>
  20467. Constructs an instance of this class using the specified wrapped
  20468. native connection handle.
  20469. </summary>
  20470. <param name="handle">
  20471. The wrapped native connection handle to be associated with this
  20472. change set.
  20473. </param>
  20474. <param name="flags">
  20475. The flags associated with the connection represented by the
  20476. <paramref name="handle" /> value.
  20477. </param>
  20478. </member>
  20479. <member name="M:System.Data.SQLite.SQLiteChangeSetBase.CreateMetadataItem(System.IntPtr)">
  20480. <summary>
  20481. Creates and returns a concrete implementation of the
  20482. <see cref="T:System.Data.SQLite.ISQLiteChangeSetMetadataItem" /> interface.
  20483. </summary>
  20484. <param name="iterator">
  20485. The native iterator handle to use.
  20486. </param>
  20487. <returns>
  20488. An instance of the <see cref="T:System.Data.SQLite.ISQLiteChangeSetMetadataItem"/>
  20489. interface, which can be used to fetch metadata associated with
  20490. the current item in this set of changes.
  20491. </returns>
  20492. </member>
  20493. <member name="M:System.Data.SQLite.SQLiteChangeSetBase.GetDelegate(System.Data.SQLite.SessionTableFilterCallback,System.Object)">
  20494. <summary>
  20495. Attempts to create a
  20496. <see cref="T:System.Data.SQLite.UnsafeNativeMethods.xSessionFilter" /> native delegate
  20497. that invokes the specified
  20498. <see cref="T:System.Data.SQLite.SessionTableFilterCallback" /> delegate.
  20499. </summary>
  20500. <param name="tableFilterCallback">
  20501. The <see cref="T:System.Data.SQLite.SessionTableFilterCallback" /> to invoke when the
  20502. <see cref="T:System.Data.SQLite.UnsafeNativeMethods.xSessionFilter" /> native delegate
  20503. is called. If this value is null then null is returned.
  20504. </param>
  20505. <param name="clientData">
  20506. The optional application-defined context data. This value may be
  20507. null.
  20508. </param>
  20509. <returns>
  20510. The created <see cref="T:System.Data.SQLite.UnsafeNativeMethods.xSessionFilter" />
  20511. native delegate -OR- null if it cannot be created.
  20512. </returns>
  20513. </member>
  20514. <member name="M:System.Data.SQLite.SQLiteChangeSetBase.GetDelegate(System.Data.SQLite.SessionConflictCallback,System.Object)">
  20515. <summary>
  20516. Attempts to create a
  20517. <see cref="T:System.Data.SQLite.UnsafeNativeMethods.xSessionConflict" /> native delegate
  20518. that invokes the specified
  20519. <see cref="T:System.Data.SQLite.SessionConflictCallback" /> delegate.
  20520. </summary>
  20521. <param name="conflictCallback">
  20522. The <see cref="T:System.Data.SQLite.SessionConflictCallback" /> to invoke when the
  20523. <see cref="T:System.Data.SQLite.UnsafeNativeMethods.xSessionConflict" /> native delegate
  20524. is called. If this value is null then null is returned.
  20525. </param>
  20526. <param name="clientData">
  20527. The optional application-defined context data. This value may be
  20528. null.
  20529. </param>
  20530. <returns>
  20531. The created <see cref="T:System.Data.SQLite.UnsafeNativeMethods.xSessionConflict" />
  20532. native delegate -OR- null if it cannot be created.
  20533. </returns>
  20534. </member>
  20535. <member name="F:System.Data.SQLite.SQLiteChangeSetBase.disposed">
  20536. <summary>
  20537. Non-zero if this object instance has been disposed.
  20538. </summary>
  20539. </member>
  20540. <member name="M:System.Data.SQLite.SQLiteChangeSetBase.CheckDisposed">
  20541. <summary>
  20542. Throws an exception if this object instance has been disposed.
  20543. </summary>
  20544. </member>
  20545. <member name="M:System.Data.SQLite.SQLiteChangeSetBase.Dispose(System.Boolean)">
  20546. <summary>
  20547. Disposes or finalizes this object instance.
  20548. </summary>
  20549. <param name="disposing">
  20550. Non-zero if this object is being disposed; otherwise, this object
  20551. is being finalized.
  20552. </param>
  20553. </member>
  20554. <member name="T:System.Data.SQLite.SQLiteMemoryChangeSet">
  20555. <summary>
  20556. This class represents a set of changes contained entirely in memory.
  20557. </summary>
  20558. </member>
  20559. <member name="F:System.Data.SQLite.SQLiteMemoryChangeSet.rawData">
  20560. <summary>
  20561. The raw byte data for this set of changes. Since this data must
  20562. be marshalled to a native memory buffer before being used, there
  20563. must be enough memory available to store at least two times the
  20564. amount of data contained within it.
  20565. </summary>
  20566. </member>
  20567. <member name="F:System.Data.SQLite.SQLiteMemoryChangeSet.startFlags">
  20568. <summary>
  20569. The flags used to create the change set iterator.
  20570. </summary>
  20571. </member>
  20572. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSet.#ctor(System.Byte[],System.Data.SQLite.SQLiteConnectionHandle,System.Data.SQLite.SQLiteConnectionFlags)">
  20573. <summary>
  20574. Constructs an instance of this class using the specified raw byte
  20575. data and wrapped native connection handle.
  20576. </summary>
  20577. <param name="rawData">
  20578. The raw byte data for the specified change set (or patch set).
  20579. </param>
  20580. <param name="handle">
  20581. The wrapped native connection handle to be associated with this
  20582. set of changes.
  20583. </param>
  20584. <param name="connectionFlags">
  20585. The flags associated with the connection represented by the
  20586. <paramref name="handle" /> value.
  20587. </param>
  20588. </member>
  20589. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSet.#ctor(System.Byte[],System.Data.SQLite.SQLiteConnectionHandle,System.Data.SQLite.SQLiteConnectionFlags,System.Data.SQLite.SQLiteChangeSetStartFlags)">
  20590. <summary>
  20591. Constructs an instance of this class using the specified raw byte
  20592. data and wrapped native connection handle.
  20593. </summary>
  20594. <param name="rawData">
  20595. The raw byte data for the specified change set (or patch set).
  20596. </param>
  20597. <param name="handle">
  20598. The wrapped native connection handle to be associated with this
  20599. set of changes.
  20600. </param>
  20601. <param name="connectionFlags">
  20602. The flags associated with the connection represented by the
  20603. <paramref name="handle" /> value.
  20604. </param>
  20605. <param name="startFlags">
  20606. The flags used to create the change set iterator.
  20607. </param>
  20608. </member>
  20609. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSet.Invert">
  20610. <summary>
  20611. This method "inverts" the set of changes within this instance.
  20612. Applying an inverted set of changes to a database reverses the
  20613. effects of applying the uninverted changes. Specifically:
  20614. <![CDATA[<ul>]]><![CDATA[<li>]]>
  20615. Each DELETE change is changed to an INSERT, and
  20616. <![CDATA[</li>]]><![CDATA[<li>]]>
  20617. Each INSERT change is changed to a DELETE, and
  20618. <![CDATA[</li>]]><![CDATA[<li>]]>
  20619. For each UPDATE change, the old.* and new.* values are exchanged.
  20620. <![CDATA[</li>]]><![CDATA[</ul>]]>
  20621. This method does not change the order in which changes appear
  20622. within the set of changes. It merely reverses the sense of each
  20623. individual change.
  20624. </summary>
  20625. <returns>
  20626. The new <see cref="T:System.Data.SQLite.ISQLiteChangeSet" /> instance that represents
  20627. the resulting set of changes.
  20628. </returns>
  20629. </member>
  20630. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSet.CombineWith(System.Data.SQLite.ISQLiteChangeSet)">
  20631. <summary>
  20632. This method combines the specified set of changes with the ones
  20633. contained in this instance.
  20634. </summary>
  20635. <param name="changeSet">
  20636. The changes to be combined with those in this instance.
  20637. </param>
  20638. <returns>
  20639. The new <see cref="T:System.Data.SQLite.ISQLiteChangeSet" /> instance that represents
  20640. the resulting set of changes.
  20641. </returns>
  20642. </member>
  20643. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSet.Apply(System.Data.SQLite.SessionConflictCallback,System.Object)">
  20644. <summary>
  20645. Attempts to apply the set of changes in this instance to the
  20646. associated database.
  20647. </summary>
  20648. <param name="conflictCallback">
  20649. The <see cref="T:System.Data.SQLite.SessionConflictCallback" /> delegate that will need
  20650. to handle any conflicting changes that may arise.
  20651. </param>
  20652. <param name="clientData">
  20653. The optional application-defined context data. This value may be
  20654. null.
  20655. </param>
  20656. </member>
  20657. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSet.Apply(System.Data.SQLite.SessionConflictCallback,System.Data.SQLite.SessionTableFilterCallback,System.Object)">
  20658. <summary>
  20659. Attempts to apply the set of changes in this instance to the
  20660. associated database.
  20661. </summary>
  20662. <param name="conflictCallback">
  20663. The <see cref="T:System.Data.SQLite.SessionConflictCallback" /> delegate that will need
  20664. to handle any conflicting changes that may arise.
  20665. </param>
  20666. <param name="tableFilterCallback">
  20667. The optional <see cref="T:System.Data.SQLite.SessionTableFilterCallback" /> delegate
  20668. that can be used to filter the list of tables impacted by the set
  20669. of changes.
  20670. </param>
  20671. <param name="clientData">
  20672. The optional application-defined context data. This value may be
  20673. null.
  20674. </param>
  20675. </member>
  20676. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSet.GetEnumerator">
  20677. <summary>
  20678. Creates an <see cref="T:System.Collections.IEnumerator" /> capable of iterating over the
  20679. items within this set of changes.
  20680. </summary>
  20681. <returns>
  20682. The new <see cref="T:System.Collections.Generic.IEnumerator`1" />
  20683. instance.
  20684. </returns>
  20685. </member>
  20686. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSet.System#Collections#IEnumerable#GetEnumerator">
  20687. <summary>
  20688. Creates an <see cref="T:System.Collections.IEnumerator" /> capable of iterating over the
  20689. items within this set of changes.
  20690. </summary>
  20691. <returns>
  20692. The new <see cref="T:System.Collections.IEnumerator" /> instance.
  20693. </returns>
  20694. </member>
  20695. <member name="F:System.Data.SQLite.SQLiteMemoryChangeSet.disposed">
  20696. <summary>
  20697. Non-zero if this object instance has been disposed.
  20698. </summary>
  20699. </member>
  20700. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSet.CheckDisposed">
  20701. <summary>
  20702. Throws an exception if this object instance has been disposed.
  20703. </summary>
  20704. </member>
  20705. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSet.Dispose(System.Boolean)">
  20706. <summary>
  20707. Disposes or finalizes this object instance.
  20708. </summary>
  20709. <param name="disposing">
  20710. Non-zero if this object is being disposed; otherwise, this object
  20711. is being finalized.
  20712. </param>
  20713. </member>
  20714. <member name="T:System.Data.SQLite.SQLiteStreamChangeSet">
  20715. <summary>
  20716. This class represents a set of changes that are backed by a
  20717. <see cref="T:System.IO.Stream" /> instance.
  20718. </summary>
  20719. </member>
  20720. <member name="F:System.Data.SQLite.SQLiteStreamChangeSet.inputStreamAdapter">
  20721. <summary>
  20722. The <see cref="T:System.Data.SQLite.SQLiteStreamAdapter" /> instance that is managing
  20723. the underlying input <see cref="T:System.IO.Stream" /> used as the backing
  20724. store for the set of changes associated with this instance.
  20725. </summary>
  20726. </member>
  20727. <member name="F:System.Data.SQLite.SQLiteStreamChangeSet.outputStreamAdapter">
  20728. <summary>
  20729. The <see cref="T:System.Data.SQLite.SQLiteStreamAdapter" /> instance that is managing
  20730. the underlying output <see cref="T:System.IO.Stream" /> used as the backing
  20731. store for the set of changes generated by the <see cref="M:System.Data.SQLite.SQLiteStreamChangeSet.Invert" />
  20732. or <see cref="M:System.Data.SQLite.SQLiteStreamChangeSet.CombineWith(System.Data.SQLite.ISQLiteChangeSet)" /> methods.
  20733. </summary>
  20734. </member>
  20735. <member name="F:System.Data.SQLite.SQLiteStreamChangeSet.inputStream">
  20736. <summary>
  20737. The <see cref="T:System.IO.Stream" /> instance used as the backing store for
  20738. the set of changes associated with this instance.
  20739. </summary>
  20740. </member>
  20741. <member name="F:System.Data.SQLite.SQLiteStreamChangeSet.outputStream">
  20742. <summary>
  20743. The <see cref="T:System.IO.Stream" /> instance used as the backing store for
  20744. the set of changes generated by the <see cref="M:System.Data.SQLite.SQLiteStreamChangeSet.Invert" /> or
  20745. <see cref="M:System.Data.SQLite.SQLiteStreamChangeSet.CombineWith(System.Data.SQLite.ISQLiteChangeSet)" /> methods.
  20746. </summary>
  20747. </member>
  20748. <member name="F:System.Data.SQLite.SQLiteStreamChangeSet.startFlags">
  20749. <summary>
  20750. The flags used to create the change set iterator.
  20751. </summary>
  20752. </member>
  20753. <member name="M:System.Data.SQLite.SQLiteStreamChangeSet.#ctor(System.IO.Stream,System.IO.Stream,System.Data.SQLite.SQLiteConnectionHandle,System.Data.SQLite.SQLiteConnectionFlags)">
  20754. <summary>
  20755. Constructs an instance of this class using the specified streams
  20756. and wrapped native connection handle.
  20757. </summary>
  20758. <param name="inputStream">
  20759. The <see cref="T:System.IO.Stream" /> where the raw byte data for the set of
  20760. changes may be read.
  20761. </param>
  20762. <param name="outputStream">
  20763. The <see cref="T:System.IO.Stream" /> where the raw byte data for resulting
  20764. sets of changes may be written.
  20765. </param>
  20766. <param name="handle">
  20767. The wrapped native connection handle to be associated with this
  20768. set of changes.
  20769. </param>
  20770. <param name="connectionFlags">
  20771. The flags associated with the connection represented by the
  20772. <paramref name="handle" /> value.
  20773. </param>
  20774. </member>
  20775. <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)">
  20776. <summary>
  20777. Constructs an instance of this class using the specified streams
  20778. and wrapped native connection handle.
  20779. </summary>
  20780. <param name="inputStream">
  20781. The <see cref="T:System.IO.Stream" /> where the raw byte data for the set of
  20782. changes may be read.
  20783. </param>
  20784. <param name="outputStream">
  20785. The <see cref="T:System.IO.Stream" /> where the raw byte data for resulting
  20786. sets of changes may be written.
  20787. </param>
  20788. <param name="handle">
  20789. The wrapped native connection handle to be associated with this
  20790. set of changes.
  20791. </param>
  20792. <param name="connectionFlags">
  20793. The flags associated with the connection represented by the
  20794. <paramref name="handle" /> value.
  20795. </param>
  20796. <param name="startFlags">
  20797. The flags used to create the change set iterator.
  20798. </param>
  20799. </member>
  20800. <member name="M:System.Data.SQLite.SQLiteStreamChangeSet.CheckInputStream">
  20801. <summary>
  20802. Throws an exception if the input stream or its associated stream
  20803. adapter are invalid.
  20804. </summary>
  20805. </member>
  20806. <member name="M:System.Data.SQLite.SQLiteStreamChangeSet.CheckOutputStream">
  20807. <summary>
  20808. Throws an exception if the output stream or its associated stream
  20809. adapter are invalid.
  20810. </summary>
  20811. </member>
  20812. <member name="M:System.Data.SQLite.SQLiteStreamChangeSet.Invert">
  20813. <summary>
  20814. This method "inverts" the set of changes within this instance.
  20815. Applying an inverted set of changes to a database reverses the
  20816. effects of applying the uninverted changes. Specifically:
  20817. <![CDATA[<ul>]]><![CDATA[<li>]]>
  20818. Each DELETE change is changed to an INSERT, and
  20819. <![CDATA[</li>]]><![CDATA[<li>]]>
  20820. Each INSERT change is changed to a DELETE, and
  20821. <![CDATA[</li>]]><![CDATA[<li>]]>
  20822. For each UPDATE change, the old.* and new.* values are exchanged.
  20823. <![CDATA[</li>]]><![CDATA[</ul>]]>
  20824. This method does not change the order in which changes appear
  20825. within the set of changes. It merely reverses the sense of each
  20826. individual change.
  20827. </summary>
  20828. <returns>
  20829. Since the resulting set of changes is written to the output stream,
  20830. this method always returns null.
  20831. </returns>
  20832. </member>
  20833. <member name="M:System.Data.SQLite.SQLiteStreamChangeSet.CombineWith(System.Data.SQLite.ISQLiteChangeSet)">
  20834. <summary>
  20835. This method combines the specified set of changes with the ones
  20836. contained in this instance.
  20837. </summary>
  20838. <param name="changeSet">
  20839. The changes to be combined with those in this instance.
  20840. </param>
  20841. <returns>
  20842. Since the resulting set of changes is written to the output stream,
  20843. this method always returns null.
  20844. </returns>
  20845. </member>
  20846. <member name="M:System.Data.SQLite.SQLiteStreamChangeSet.Apply(System.Data.SQLite.SessionConflictCallback,System.Object)">
  20847. <summary>
  20848. Attempts to apply the set of changes in this instance to the
  20849. associated database.
  20850. </summary>
  20851. <param name="conflictCallback">
  20852. The <see cref="T:System.Data.SQLite.SessionConflictCallback" /> delegate that will need
  20853. to handle any conflicting changes that may arise.
  20854. </param>
  20855. <param name="clientData">
  20856. The optional application-defined context data. This value may be
  20857. null.
  20858. </param>
  20859. </member>
  20860. <member name="M:System.Data.SQLite.SQLiteStreamChangeSet.Apply(System.Data.SQLite.SessionConflictCallback,System.Data.SQLite.SessionTableFilterCallback,System.Object)">
  20861. <summary>
  20862. Attempts to apply the set of changes in this instance to the
  20863. associated database.
  20864. </summary>
  20865. <param name="conflictCallback">
  20866. The <see cref="T:System.Data.SQLite.SessionConflictCallback" /> delegate that will need
  20867. to handle any conflicting changes that may arise.
  20868. </param>
  20869. <param name="tableFilterCallback">
  20870. The optional <see cref="T:System.Data.SQLite.SessionTableFilterCallback" /> delegate
  20871. that can be used to filter the list of tables impacted by the set
  20872. of changes.
  20873. </param>
  20874. <param name="clientData">
  20875. The optional application-defined context data. This value may be
  20876. null.
  20877. </param>
  20878. </member>
  20879. <member name="M:System.Data.SQLite.SQLiteStreamChangeSet.GetEnumerator">
  20880. <summary>
  20881. Creates an <see cref="T:System.Collections.IEnumerator" /> capable of iterating over the
  20882. items within this set of changes.
  20883. </summary>
  20884. <returns>
  20885. The new <see cref="T:System.Collections.Generic.IEnumerator`1" />
  20886. instance.
  20887. </returns>
  20888. </member>
  20889. <member name="M:System.Data.SQLite.SQLiteStreamChangeSet.System#Collections#IEnumerable#GetEnumerator">
  20890. <summary>
  20891. Creates an <see cref="T:System.Collections.IEnumerator" /> capable of iterating over the
  20892. items within this set of changes.
  20893. </summary>
  20894. <returns>
  20895. The new <see cref="T:System.Collections.IEnumerator" /> instance.
  20896. </returns>
  20897. </member>
  20898. <member name="F:System.Data.SQLite.SQLiteStreamChangeSet.disposed">
  20899. <summary>
  20900. Non-zero if this object instance has been disposed.
  20901. </summary>
  20902. </member>
  20903. <member name="M:System.Data.SQLite.SQLiteStreamChangeSet.CheckDisposed">
  20904. <summary>
  20905. Throws an exception if this object instance has been disposed.
  20906. </summary>
  20907. </member>
  20908. <member name="M:System.Data.SQLite.SQLiteStreamChangeSet.Dispose(System.Boolean)">
  20909. <summary>
  20910. Disposes or finalizes this object instance.
  20911. </summary>
  20912. <param name="disposing">
  20913. Non-zero if this object is being disposed; otherwise, this object
  20914. is being finalized.
  20915. </param>
  20916. </member>
  20917. <member name="T:System.Data.SQLite.SQLiteChangeSetEnumerator">
  20918. <summary>
  20919. This class represents an <see cref="T:System.Collections.IEnumerator" /> that is capable of
  20920. enumerating over a set of changes. It serves as the base class for the
  20921. <see cref="T:System.Data.SQLite.SQLiteMemoryChangeSetEnumerator" /> and
  20922. <see cref="T:System.Data.SQLite.SQLiteStreamChangeSetEnumerator" /> classes. It manages and
  20923. owns an instance of the <see cref="T:System.Data.SQLite.SQLiteChangeSetIterator" /> class.
  20924. </summary>
  20925. </member>
  20926. <member name="F:System.Data.SQLite.SQLiteChangeSetEnumerator.iterator">
  20927. <summary>
  20928. This managed change set iterator is managed and owned by this
  20929. class. It will be disposed when this class is disposed.
  20930. </summary>
  20931. </member>
  20932. <member name="M:System.Data.SQLite.SQLiteChangeSetEnumerator.#ctor(System.Data.SQLite.SQLiteChangeSetIterator)">
  20933. <summary>
  20934. Constructs an instance of this class using the specified managed
  20935. change set iterator.
  20936. </summary>
  20937. <param name="iterator">
  20938. The managed iterator instance to use.
  20939. </param>
  20940. </member>
  20941. <member name="M:System.Data.SQLite.SQLiteChangeSetEnumerator.CheckIterator">
  20942. <summary>
  20943. Throws an exception if the managed iterator instance is invalid.
  20944. </summary>
  20945. </member>
  20946. <member name="M:System.Data.SQLite.SQLiteChangeSetEnumerator.SetIterator(System.Data.SQLite.SQLiteChangeSetIterator)">
  20947. <summary>
  20948. Sets the managed iterator instance to a new value.
  20949. </summary>
  20950. <param name="iterator">
  20951. The new managed iterator instance to use.
  20952. </param>
  20953. </member>
  20954. <member name="M:System.Data.SQLite.SQLiteChangeSetEnumerator.CloseIterator">
  20955. <summary>
  20956. Disposes of the managed iterator instance and sets its value to
  20957. null.
  20958. </summary>
  20959. </member>
  20960. <member name="M:System.Data.SQLite.SQLiteChangeSetEnumerator.ResetIterator(System.Data.SQLite.SQLiteChangeSetIterator)">
  20961. <summary>
  20962. Disposes of the existing managed iterator instance and then sets it
  20963. to a new value.
  20964. </summary>
  20965. <param name="iterator">
  20966. The new managed iterator instance to use.
  20967. </param>
  20968. </member>
  20969. <member name="P:System.Data.SQLite.SQLiteChangeSetEnumerator.Current">
  20970. <summary>
  20971. Returns the current change within the set of changes, represented
  20972. by a <see cref="T:System.Data.SQLite.ISQLiteChangeSetMetadataItem" /> instance.
  20973. </summary>
  20974. </member>
  20975. <member name="P:System.Data.SQLite.SQLiteChangeSetEnumerator.System#Collections#IEnumerator#Current">
  20976. <summary>
  20977. Returns the current change within the set of changes, represented
  20978. by a <see cref="T:System.Data.SQLite.ISQLiteChangeSetMetadataItem" /> instance.
  20979. </summary>
  20980. </member>
  20981. <member name="M:System.Data.SQLite.SQLiteChangeSetEnumerator.MoveNext">
  20982. <summary>
  20983. Attempts to advance to the next item in the set of changes.
  20984. </summary>
  20985. <returns>
  20986. Non-zero if more items are available; otherwise, zero.
  20987. </returns>
  20988. </member>
  20989. <member name="M:System.Data.SQLite.SQLiteChangeSetEnumerator.Reset">
  20990. <summary>
  20991. Throws <see cref="T:System.NotImplementedException" /> because not all the
  20992. derived classes are able to support reset functionality.
  20993. </summary>
  20994. </member>
  20995. <member name="M:System.Data.SQLite.SQLiteChangeSetEnumerator.Dispose">
  20996. <summary>
  20997. Disposes of this object instance.
  20998. </summary>
  20999. </member>
  21000. <member name="F:System.Data.SQLite.SQLiteChangeSetEnumerator.disposed">
  21001. <summary>
  21002. Non-zero if this object instance has been disposed.
  21003. </summary>
  21004. </member>
  21005. <member name="M:System.Data.SQLite.SQLiteChangeSetEnumerator.CheckDisposed">
  21006. <summary>
  21007. Throws an exception if this object instance has been disposed.
  21008. </summary>
  21009. </member>
  21010. <member name="M:System.Data.SQLite.SQLiteChangeSetEnumerator.Dispose(System.Boolean)">
  21011. <summary>
  21012. Disposes or finalizes this object instance.
  21013. </summary>
  21014. <param name="disposing">
  21015. Non-zero if this object is being disposed; otherwise, this object
  21016. is being finalized.
  21017. </param>
  21018. </member>
  21019. <member name="M:System.Data.SQLite.SQLiteChangeSetEnumerator.Finalize">
  21020. <summary>
  21021. Finalizes this object instance.
  21022. </summary>
  21023. </member>
  21024. <member name="T:System.Data.SQLite.SQLiteMemoryChangeSetEnumerator">
  21025. <summary>
  21026. This class represents an <see cref="T:System.Collections.IEnumerator" /> that is capable of
  21027. enumerating over a set of changes contained entirely in memory.
  21028. </summary>
  21029. </member>
  21030. <member name="F:System.Data.SQLite.SQLiteMemoryChangeSetEnumerator.rawData">
  21031. <summary>
  21032. The raw byte data for this set of changes. Since this data must
  21033. be marshalled to a native memory buffer before being used, there
  21034. must be enough memory available to store at least two times the
  21035. amount of data contained within it.
  21036. </summary>
  21037. </member>
  21038. <member name="F:System.Data.SQLite.SQLiteMemoryChangeSetEnumerator.flags">
  21039. <summary>
  21040. The flags used to create the change set iterator.
  21041. </summary>
  21042. </member>
  21043. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSetEnumerator.#ctor(System.Byte[])">
  21044. <summary>
  21045. Constructs an instance of this class using the specified raw byte
  21046. data.
  21047. </summary>
  21048. <param name="rawData">
  21049. The raw byte data containing the set of changes for this
  21050. enumerator.
  21051. </param>
  21052. </member>
  21053. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSetEnumerator.#ctor(System.Byte[],System.Data.SQLite.SQLiteChangeSetStartFlags)">
  21054. <summary>
  21055. Constructs an instance of this class using the specified raw byte
  21056. data.
  21057. </summary>
  21058. <param name="rawData">
  21059. The raw byte data containing the set of changes for this
  21060. enumerator.
  21061. </param>
  21062. <param name="flags">
  21063. The flags used to create the change set iterator.
  21064. </param>
  21065. </member>
  21066. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSetEnumerator.Reset">
  21067. <summary>
  21068. Resets the enumerator to its initial position.
  21069. </summary>
  21070. </member>
  21071. <member name="F:System.Data.SQLite.SQLiteMemoryChangeSetEnumerator.disposed">
  21072. <summary>
  21073. Non-zero if this object instance has been disposed.
  21074. </summary>
  21075. </member>
  21076. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSetEnumerator.CheckDisposed">
  21077. <summary>
  21078. Throws an exception if this object instance has been disposed.
  21079. </summary>
  21080. </member>
  21081. <member name="M:System.Data.SQLite.SQLiteMemoryChangeSetEnumerator.Dispose(System.Boolean)">
  21082. <summary>
  21083. Disposes or finalizes this object instance.
  21084. </summary>
  21085. <param name="disposing">
  21086. Non-zero if this object is being disposed; otherwise, this object
  21087. is being finalized.
  21088. </param>
  21089. </member>
  21090. <member name="T:System.Data.SQLite.SQLiteStreamChangeSetEnumerator">
  21091. <summary>
  21092. This class represents an <see cref="T:System.Collections.IEnumerator" /> that is capable of
  21093. enumerating over a set of changes backed by a <see cref="T:System.IO.Stream" />
  21094. instance.
  21095. </summary>
  21096. </member>
  21097. <member name="M:System.Data.SQLite.SQLiteStreamChangeSetEnumerator.#ctor(System.IO.Stream,System.Data.SQLite.SQLiteConnectionFlags)">
  21098. <summary>
  21099. Constructs an instance of this class using the specified stream.
  21100. </summary>
  21101. <param name="stream">
  21102. The <see cref="T:System.IO.Stream" /> where the raw byte data for the set of
  21103. changes may be read.
  21104. </param>
  21105. <param name="connectionFlags">
  21106. The flags associated with the parent connection.
  21107. </param>
  21108. </member>
  21109. <member name="M:System.Data.SQLite.SQLiteStreamChangeSetEnumerator.#ctor(System.IO.Stream,System.Data.SQLite.SQLiteConnectionFlags,System.Data.SQLite.SQLiteChangeSetStartFlags)">
  21110. <summary>
  21111. Constructs an instance of this class using the specified stream.
  21112. </summary>
  21113. <param name="stream">
  21114. The <see cref="T:System.IO.Stream" /> where the raw byte data for the set of
  21115. changes may be read.
  21116. </param>
  21117. <param name="connectionFlags">
  21118. The flags associated with the parent connection.
  21119. </param>
  21120. <param name="startFlags">
  21121. The flags used to create the change set iterator.
  21122. </param>
  21123. </member>
  21124. <member name="F:System.Data.SQLite.SQLiteStreamChangeSetEnumerator.disposed">
  21125. <summary>
  21126. Non-zero if this object instance has been disposed.
  21127. </summary>
  21128. </member>
  21129. <member name="M:System.Data.SQLite.SQLiteStreamChangeSetEnumerator.CheckDisposed">
  21130. <summary>
  21131. Throws an exception if this object instance has been disposed.
  21132. </summary>
  21133. </member>
  21134. <member name="M:System.Data.SQLite.SQLiteStreamChangeSetEnumerator.Dispose(System.Boolean)">
  21135. <summary>
  21136. Disposes or finalizes this object instance.
  21137. </summary>
  21138. <param name="disposing">
  21139. Non-zero if this object is being disposed; otherwise, this object
  21140. is being finalized.
  21141. </param>
  21142. </member>
  21143. <member name="T:System.Data.SQLite.SQLiteChangeSetMetadataItem">
  21144. <summary>
  21145. This interface implements properties and methods used to fetch metadata
  21146. about one change within a set of changes for a database.
  21147. </summary>
  21148. </member>
  21149. <member name="F:System.Data.SQLite.SQLiteChangeSetMetadataItem.iterator">
  21150. <summary>
  21151. The <see cref="T:System.Data.SQLite.SQLiteChangeSetIterator" /> instance to use. This
  21152. will NOT be owned by this class and will not be disposed upon this
  21153. class being disposed or finalized.
  21154. </summary>
  21155. </member>
  21156. <member name="M:System.Data.SQLite.SQLiteChangeSetMetadataItem.#ctor(System.Data.SQLite.SQLiteChangeSetIterator)">
  21157. <summary>
  21158. Constructs an instance of this class using the specified iterator
  21159. instance.
  21160. </summary>
  21161. <param name="iterator">
  21162. The managed iterator instance to use.
  21163. </param>
  21164. </member>
  21165. <member name="M:System.Data.SQLite.SQLiteChangeSetMetadataItem.CheckIterator">
  21166. <summary>
  21167. Throws an exception if the managed iterator instance is invalid.
  21168. </summary>
  21169. </member>
  21170. <member name="M:System.Data.SQLite.SQLiteChangeSetMetadataItem.PopulateOperationMetadata">
  21171. <summary>
  21172. Populates the underlying data for the <see cref="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.TableName" />,
  21173. <see cref="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.NumberOfColumns" />, <see cref="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.OperationCode" />, and
  21174. <see cref="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.Indirect" /> properties, using the appropriate native
  21175. API.
  21176. </summary>
  21177. </member>
  21178. <member name="M:System.Data.SQLite.SQLiteChangeSetMetadataItem.PopulatePrimaryKeyColumns">
  21179. <summary>
  21180. Populates the underlying data for the
  21181. <see cref="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.PrimaryKeyColumns" /> property using the appropriate
  21182. native API.
  21183. </summary>
  21184. </member>
  21185. <member name="M:System.Data.SQLite.SQLiteChangeSetMetadataItem.PopulateNumberOfForeignKeyConflicts">
  21186. <summary>
  21187. Populates the underlying data for the
  21188. <see cref="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.NumberOfForeignKeyConflicts" /> property using the
  21189. appropriate native API.
  21190. </summary>
  21191. </member>
  21192. <member name="F:System.Data.SQLite.SQLiteChangeSetMetadataItem.tableName">
  21193. <summary>
  21194. Backing field for the <see cref="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.TableName" /> property. This value
  21195. will be null if this field has not yet been populated via the
  21196. underlying native API.
  21197. </summary>
  21198. </member>
  21199. <member name="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.TableName">
  21200. <summary>
  21201. The name of the table the change was made to.
  21202. </summary>
  21203. </member>
  21204. <member name="F:System.Data.SQLite.SQLiteChangeSetMetadataItem.numberOfColumns">
  21205. <summary>
  21206. Backing field for the <see cref="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.NumberOfColumns" /> property. This
  21207. value will be null if this field has not yet been populated via the
  21208. underlying native API.
  21209. </summary>
  21210. </member>
  21211. <member name="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.NumberOfColumns">
  21212. <summary>
  21213. The number of columns impacted by this change. This value can be
  21214. used to determine the highest valid column index that may be used
  21215. with the <see cref="M:System.Data.SQLite.SQLiteChangeSetMetadataItem.GetOldValue(System.Int32)" />, <see cref="M:System.Data.SQLite.SQLiteChangeSetMetadataItem.GetNewValue(System.Int32)" />,
  21216. and <see cref="M:System.Data.SQLite.SQLiteChangeSetMetadataItem.GetConflictValue(System.Int32)" /> methods of this interface. It
  21217. will be this value minus one.
  21218. </summary>
  21219. </member>
  21220. <member name="F:System.Data.SQLite.SQLiteChangeSetMetadataItem.operationCode">
  21221. <summary>
  21222. Backing field for the <see cref="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.OperationCode" /> property. This
  21223. value will be null if this field has not yet been populated via the
  21224. underlying native API.
  21225. </summary>
  21226. </member>
  21227. <member name="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.OperationCode">
  21228. <summary>
  21229. This will contain the value
  21230. <see cref="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Insert" />,
  21231. <see cref="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Update" />, or
  21232. <see cref="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Delete" />, corresponding to
  21233. the overall type of change this item represents.
  21234. </summary>
  21235. </member>
  21236. <member name="F:System.Data.SQLite.SQLiteChangeSetMetadataItem.indirect">
  21237. <summary>
  21238. Backing field for the <see cref="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.Indirect" /> property. This value
  21239. will be null if this field has not yet been populated via the
  21240. underlying native API.
  21241. </summary>
  21242. </member>
  21243. <member name="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.Indirect">
  21244. <summary>
  21245. Non-zero if this change is considered to be indirect (i.e. as
  21246. though they were made via a trigger or foreign key action).
  21247. </summary>
  21248. </member>
  21249. <member name="F:System.Data.SQLite.SQLiteChangeSetMetadataItem.primaryKeyColumns">
  21250. <summary>
  21251. Backing field for the <see cref="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.PrimaryKeyColumns" /> property.
  21252. This value will be null if this field has not yet been populated
  21253. via the underlying native API.
  21254. </summary>
  21255. </member>
  21256. <member name="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.PrimaryKeyColumns">
  21257. <summary>
  21258. This array contains a <see cref="T:System.Boolean" /> for each column in
  21259. the table associated with this change. The element will be zero
  21260. if the column is not part of the primary key; otherwise, it will
  21261. be non-zero.
  21262. </summary>
  21263. </member>
  21264. <member name="F:System.Data.SQLite.SQLiteChangeSetMetadataItem.numberOfForeignKeyConflicts">
  21265. <summary>
  21266. Backing field for the <see cref="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.NumberOfForeignKeyConflicts" />
  21267. property. This value will be null if this field has not yet been
  21268. populated via the underlying native API.
  21269. </summary>
  21270. </member>
  21271. <member name="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.NumberOfForeignKeyConflicts">
  21272. <summary>
  21273. This method may only be called from within a
  21274. <see cref="T:System.Data.SQLite.SessionConflictCallback" /> delegate when the conflict
  21275. type is <see cref="F:System.Data.SQLite.SQLiteChangeSetConflictType.ForeignKey" />. It
  21276. returns the total number of known foreign key violations in the
  21277. destination database.
  21278. </summary>
  21279. </member>
  21280. <member name="M:System.Data.SQLite.SQLiteChangeSetMetadataItem.GetOldValue(System.Int32)">
  21281. <summary>
  21282. Queries and returns the original value of a given column for this
  21283. change. This method may only be called when the
  21284. <see cref="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.OperationCode" /> has a value of
  21285. <see cref="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Update" /> or
  21286. <see cref="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Delete" />.
  21287. </summary>
  21288. <param name="columnIndex">
  21289. The index for the column. This value must be between zero and one
  21290. less than the total number of columns for this table.
  21291. </param>
  21292. <returns>
  21293. The original value of a given column for this change.
  21294. </returns>
  21295. </member>
  21296. <member name="M:System.Data.SQLite.SQLiteChangeSetMetadataItem.GetNewValue(System.Int32)">
  21297. <summary>
  21298. Queries and returns the updated value of a given column for this
  21299. change. This method may only be called when the
  21300. <see cref="P:System.Data.SQLite.SQLiteChangeSetMetadataItem.OperationCode" /> has a value of
  21301. <see cref="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Insert" /> or
  21302. <see cref="F:System.Data.SQLite.SQLiteAuthorizerActionCode.Update" />.
  21303. </summary>
  21304. <param name="columnIndex">
  21305. The index for the column. This value must be between zero and one
  21306. less than the total number of columns for this table.
  21307. </param>
  21308. <returns>
  21309. The updated value of a given column for this change.
  21310. </returns>
  21311. </member>
  21312. <member name="M:System.Data.SQLite.SQLiteChangeSetMetadataItem.GetConflictValue(System.Int32)">
  21313. <summary>
  21314. Queries and returns the conflicting value of a given column for
  21315. this change. This method may only be called from within a
  21316. <see cref="T:System.Data.SQLite.SessionConflictCallback" /> delegate when the conflict
  21317. type is <see cref="F:System.Data.SQLite.SQLiteChangeSetConflictType.Data" /> or
  21318. <see cref="F:System.Data.SQLite.SQLiteChangeSetConflictType.Conflict" />.
  21319. </summary>
  21320. <param name="columnIndex">
  21321. The index for the column. This value must be between zero and one
  21322. less than the total number of columns for this table.
  21323. </param>
  21324. <returns>
  21325. The conflicting value of a given column for this change.
  21326. </returns>
  21327. </member>
  21328. <member name="M:System.Data.SQLite.SQLiteChangeSetMetadataItem.Dispose">
  21329. <summary>
  21330. Disposes of this object instance.
  21331. </summary>
  21332. </member>
  21333. <member name="F:System.Data.SQLite.SQLiteChangeSetMetadataItem.disposed">
  21334. <summary>
  21335. Non-zero if this object instance has been disposed.
  21336. </summary>
  21337. </member>
  21338. <member name="M:System.Data.SQLite.SQLiteChangeSetMetadataItem.CheckDisposed">
  21339. <summary>
  21340. Throws an exception if this object instance has been disposed.
  21341. </summary>
  21342. </member>
  21343. <member name="M:System.Data.SQLite.SQLiteChangeSetMetadataItem.Dispose(System.Boolean)">
  21344. <summary>
  21345. Disposes or finalizes this object instance.
  21346. </summary>
  21347. <param name="disposing">
  21348. Non-zero if this object is being disposed; otherwise, this object
  21349. is being finalized.
  21350. </param>
  21351. </member>
  21352. <member name="M:System.Data.SQLite.SQLiteChangeSetMetadataItem.Finalize">
  21353. <summary>
  21354. Finalizes this object instance.
  21355. </summary>
  21356. </member>
  21357. </members>
  21358. </doc>