X-Git-Url: https://git.distorted.org.uk/~mdw/sgt/putty/blobdiff_plain/65d1432e946f534ce0b3216235798ffc882b6e4d..23e4df365f332a92d97fae27212b2cf777d5b8e0:/windows/winstuff.h

diff --git a/windows/winstuff.h b/windows/winstuff.h
index 29ab0b30..5e95a9df 100644
--- a/windows/winstuff.h
+++ b/windows/winstuff.h
@@ -74,17 +74,31 @@ struct FontSpec {
 #define DF_END 0x0001
 
 /*
- * Dynamically linked functions.
- * This is somewhat circuitous to allow function-renaming macros to be
- * expanded, principally the ANSI/Unicode DoSomethingA/DoSomethingW.
+ * Dynamically linked functions. These come in two flavours:
+ *
+ *  - GET_WINDOWS_FUNCTION does not expose "name" to the preprocessor,
+ *    so will always dynamically link against exactly what is specified
+ *    in "name". If you're not sure, use this one.
+ *
+ *  - GET_WINDOWS_FUNCTION_PP allows "name" to be redirected via
+ *    preprocessor definitions like "#define foo bar"; this is principally
+ *    intended for the ANSI/Unicode DoSomething/DoSomethingA/DoSomethingW.
+ *    If your function has an argument of type "LPTSTR" or similar, this
+ *    is the variant to use.
+ *    (However, it can't always be used, as it trips over more complicated
+ *    macro trickery such as the WspiapiGetAddrInfo wrapper for getaddrinfo.)
+ *
+ * (DECL_WINDOWS_FUNCTION works with both these variants.)
  */
 #define DECL_WINDOWS_FUNCTION(linkage, rettype, name, params) \
     typedef rettype (WINAPI *t_##name) params; \
     linkage t_##name p_##name
 #define STR1(x) #x
 #define STR(x) STR1(x)
-#define GET_WINDOWS_FUNCTION(module, name) \
+#define GET_WINDOWS_FUNCTION_PP(module, name) \
     p_##name = module ? (t_##name) GetProcAddress(module, STR(name)) : NULL
+#define GET_WINDOWS_FUNCTION(module, name) \
+    p_##name = module ? (t_##name) GetProcAddress(module, #name) : NULL
 
 /*
  * Global variables. Most modules declare these `extern', but