xref: /netbsd-src/external/public-domain/sqlite/man/sqlite3_win32_set_directory.3 (revision d16b7486a53dcb8072b60ec6fcb4373a2d0c27b7)
1.Dd December 19, 2018
2.Dt SQLITE3_WIN32_SET_DIRECTORY 3
3.Os
4.Sh NAME
5.Nm sqlite3_win32_set_directory ,
6.Nm sqlite3_win32_set_directory8 ,
7.Nm sqlite3_win32_set_directory16
8.Nd Win32 Specific Interface
9.Sh SYNOPSIS
10.Ft int
11.Fo sqlite3_win32_set_directory
12.Fa "unsigned long type"
13.Fa "void *zValue        "
14.Fc
15.Ft int
16.Fo sqlite3_win32_set_directory8
17.Fa "unsigned long type"
18.Fa "const char *zValue"
19.Fc
20.Ft int
21.Fo sqlite3_win32_set_directory16
22.Fa "unsigned long type"
23.Fa "const void *zValue"
24.Fc
25.Sh DESCRIPTION
26These interfaces are available only on Windows.
27The sqlite3_win32_set_directory interface
28is used to set the value associated with the sqlite3_temp_directory
29or sqlite3_data_directory variable, to zValue,
30depending on the value of the type parameter.
31The zValue parameter should be NULL to cause the previous value to
32be freed via sqlite3_free; a non-NULL value will be copied
33into memory obtained from sqlite3_malloc prior to being
34used.
35The sqlite3_win32_set_directory interface
36returns SQLITE_OK to indicate success, SQLITE_ERROR
37if the type is unsupported, or SQLITE_NOMEM if memory could
38not be allocated.
39The value of the sqlite3_data_directory variable
40is intended to act as a replacement for the current directory on the
41sub-platforms of Win32 where that concept is not present, e.g.
42WinRT and UWP.
43The sqlite3_win32_set_directory8 and sqlite3_win32_set_directory16
44interfaces behave exactly the same as the sqlite3_win32_set_directory
45interface except the string parameter must be UTF-8 or UTF-16, respectively.
46.Sh SEE ALSO
47.Xr sqlite3_data_directory 3 ,
48.Xr sqlite3_malloc 3 ,
49.Xr sqlite3_temp_directory 3 ,
50.Xr sqlite3_win32_set_directory 3 ,
51.Xr SQLITE_OK 3
52