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