/ Check-in [08230a3a]
Login

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:Update the documentation for the sqlite3_uri_*() routines to make it clear that there argument must be a database filename passed into xOpen(). No changes to code.
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1: 08230a3a8c88f275bfc0ba72d3fea3260f24fc63
User & Date: drh 2012-01-13 15:50:02
Context
2012-01-13
16:16
Add the -uri option to the usage comment that is printed by the "sqlite3" TCL command when an unknown command-line option is supplied. check-in: 7987e285 user: drh tags: trunk
15:50
Update the documentation for the sqlite3_uri_*() routines to make it clear that there argument must be a database filename passed into xOpen(). No changes to code. check-in: 08230a3a user: drh tags: trunk
15:21
Fix backup2.test so that it passes on OpenBSD (which produces a slightly different error message in one case). check-in: 227cfe11 user: dan tags: trunk
Changes
Hide Diffs Side-by-Side Diffs Ignore Whitespace Patch

Changes to src/sqlite.h.in.

  2623   2623   /*
  2624   2624   ** CAPI3REF: Obtain Values For URI Parameters
  2625   2625   **
  2626   2626   ** These are utility routines, useful to VFS implementations, that check
  2627   2627   ** to see if a database file was a URI that contained a specific query 
  2628   2628   ** parameter, and if so obtains the value of that query parameter.
  2629   2629   **
  2630         -** If F is the filename pointer passed into the xOpen() method of a VFS
  2631         -** implementation and P is the name of the query parameter, then
         2630  +** If F is the database filename pointer passed into the xOpen() method of 
         2631  +** a VFS implementation when the flags parameter to xOpen() has one or 
         2632  +** more of the [SQLITE_OPEN_URI] or [SQLITE_OPEN_MAIN_DB] bits set and
         2633  +** P is the name of the query parameter, then
  2632   2634   ** sqlite3_uri_parameter(F,P) returns the value of the P
  2633   2635   ** parameter if it exists or a NULL pointer if P does not appear as a 
  2634   2636   ** query parameter on F.  If P is a query parameter of F
  2635   2637   ** has no explicit value, then sqlite3_uri_parameter(F,P) returns
  2636   2638   ** a pointer to an empty string.
  2637   2639   **
  2638   2640   ** The sqlite3_uri_boolean(F,P,B) routine assumes that P is a boolean
................................................................................
  2644   2646   ** The sqlite3_uri_int64(F,P,D) routine converts the value of P into a
  2645   2647   ** 64-bit signed integer and returns that integer, or D if P does not
  2646   2648   ** exist.  If the value of P is something other than an integer, then
  2647   2649   ** zero is returned.
  2648   2650   ** 
  2649   2651   ** If F is a NULL pointer, then sqlite3_uri_parameter(F,P) returns NULL and
  2650   2652   ** sqlite3_uri_boolean(F,P,B) returns B.  If F is not a NULL pointer and
  2651         -** is not a pathname pointer that SQLite passed into the xOpen VFS method,
  2652         -** then the behavior of this routine is undefined and probably undesirable.
         2653  +** is not a databaes file pathname pointer that SQLite passed into the xOpen
         2654  +** VFS method, then the behavior of this routine is undefined and probably
         2655  +** undesirable.
  2653   2656   */
  2654   2657   const char *sqlite3_uri_parameter(const char *zFilename, const char *zParam);
  2655   2658   int sqlite3_uri_boolean(const char *zFile, const char *zParam, int bDefault);
  2656   2659   sqlite3_int64 sqlite3_uri_int64(const char*, const char*, sqlite3_int64);
  2657   2660   
  2658   2661   
  2659   2662   /*