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