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