9f799fdc0833820ea4c8137d43e7b3c912c2e458
[platform/upstream/glib.git] / docs / reference / glib / tmpl / windows.sgml
1 <!-- ##### SECTION Title ##### -->
2 Windows Compatibility Functions
3
4 <!-- ##### SECTION Short_Description ##### -->
5 UNIX emulation on Windows.
6
7 <!-- ##### SECTION Long_Description ##### -->
8 <para>
9
10 </para>
11
12 <!-- ##### SECTION See_Also ##### -->
13 <para>
14
15 </para>
16
17 <!-- ##### MACRO MAXPATHLEN ##### -->
18 <para>
19 Provided for UNIX emulation on Windows; equivalent to UNIX 
20 macro %MAXPATHLEN, which is the maximum length of a filename
21 (including full path).
22 </para>
23
24
25
26 <!-- ##### TYPEDEF pid_t ##### -->
27 <para>
28 Provided for UNIX emulation on Windows; process ID type.
29 </para>
30
31
32 <!-- ##### MACRO pipe ##### -->
33 <para>
34 Provided for UNIX emulation on Windows; see documentation for <function>pipe()</function>
35 in any UNIX manual.
36 </para>
37
38 @phandles: 
39
40
41 <!-- ##### FUNCTION g_win32_error_message ##### -->
42 <para>
43
44 </para>
45
46 @error: 
47 @Returns: 
48
49
50 <!-- ##### FUNCTION g_win32_getlocale ##### -->
51 <para>
52
53 </para>
54
55 @Returns: 
56
57
58 <!-- ##### FUNCTION g_win32_get_package_installation_directory ##### -->
59 <para>
60
61 </para>
62
63 @package: 
64 @dll_name: 
65 @Returns: 
66
67
68 <!-- ##### FUNCTION g_win32_get_package_installation_subdirectory ##### -->
69 <para>
70
71 </para>
72
73 @package: 
74 @dll_name: 
75 @subdir: 
76 @Returns: 
77
78
79 <!-- ##### FUNCTION g_win32_get_windows_version ##### -->
80 <para>
81
82 </para>
83
84 @Returns: 
85
86
87 <!-- ##### MACRO G_WIN32_DLLMAIN_FOR_DLL_NAME ##### -->
88 <para>
89 On Windows, this macro defines a <function>DllMain()</function> function 
90 that stores the actual DLL name that the code being compiled will be 
91 included in.
92 </para>
93 <para>
94 On non-Windows platforms, expands to nothing.
95 </para>
96
97 @static: empty or "static".
98 @dll_name: the name of the (pointer to the) char array where the DLL name 
99    will be stored. If this is used, you must also include 
100    <filename>windows.h</filename>. If you need a more complex DLL entry 
101    point function, you cannot use this.
102
103
104 <!-- ##### MACRO G_WIN32_HAVE_WIDECHAR_API ##### -->
105 <para>
106 On Windows, this macro defines an expression which evaluates to %TRUE
107 if the code is running on a version of Windows where the wide
108 character versions of the Win32 API functions, and the wide chaacter
109 versions of the C library functions work. (They are always present in
110 the DLLs, but don't work on Windows 9x and Me.)
111 </para>
112 <para>
113 On non-Windows platforms, it is not defined.
114 </para>
115
116 @Since: 2.6
117
118
119 <!-- ##### MACRO G_WIN32_IS_NT_BASED ##### -->
120 <para>
121 On Windows, this macro defines an expression which evaluates to %TRUE 
122 if the code is running on an NT-based Windows operating system.
123 </para>
124 <para>
125 On non-Windows platforms, it is not defined.
126 </para>
127
128 @Since: 2.6
129
130