Changeset 80827 in vbox for trunk/include/iprt

Timestamp:

Sep 16, 2019 2:04:02 PM (5 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

133397

Message:

IPRT: Added RTEnvCreateEx and RTEnvCreateChangeRecordEx so flags can be specified when creating custom environments. Defined one flag RTENV_CREATE_F_ALLOW_EQUAL_FIRST_IN_VAR for accomodating windows style environment variables (used for CWD by driver letter). The flag is set by default on windows hosts, however it does not work for the default environment due to CRT limitations.

Location:

trunk/include/iprt

Files:

• env.h (modified) (2 diffs)
• mangling.h (modified) (1 diff)

trunk/include/iprt/env.h

@@ -53 +53 @@
  */
 RTDECL(int) RTEnvCreate(PRTENV pEnv);
+
+/**
+ * Creates an empty environment block.
+ *
+ * @returns IPRT status code. Typical error is VERR_NO_MEMORY.
+ *
+ * @param   phEnv       Where to store the handle of the new environment block.
+ * @param   fFlags      Zero or more RTENV_CREATE_F_XXX flags.
+ */
+RTDECL(int) RTEnvCreateEx(PRTENV phEnv, uint32_t fFlags);
+
+/** @name RTENV_CREATE_F_XXX - Flags for RTEnvCreateEx() and RTEnvCreateChangeRecordEx()
+ * @{ */
+/** Allow equal ('=') as the first character of a variable name.
+ * This is useful for compatibility with Windows' handling of CWD on drives, as
+ * these are stored on the form "=D:=D:\tmp\asdf".   It is only really useful
+ * for creating environment blocks for processes and such, since the CRT doesn't
+ * allow us to apply it directly to the process enviornment. */
+#define RTENV_CREATE_F_ALLOW_EQUAL_FIRST_IN_VAR     RT_BIT_32(0)
+/** Valid flags.   */
+#define RTENV_CREATE_F_VALID_MASK                   UINT32_C(0x00000001)
+/** @} */
 
 /**
@@ -382 +404 @@
 
 /**
+ * Extended version of RTEnvCreateChangeRecord that takes flags.
+ *
+ * @returns IPRT status code. Typical error is VERR_NO_MEMORY.
+ *
+ * @param   phEnv       Where to store the handle of the new environment block.
+ * @param   fFlags      Zero or more RTENV_CREATE_F_XXX flags.
+ */
+RTDECL(int) RTEnvCreateChangeRecordEx(PRTENV phEnv, uint32_t fFlags);
+
+/**
  * Checks if @a hEnv is an environment change record.
  *

trunk/include/iprt/mangling.h

@@ -842 +842 @@
 # define RTEnvCountEx                                   RT_MANGLER(RTEnvCountEx)
 # define RTEnvCreate                                    RT_MANGLER(RTEnvCreate)
+# define RTEnvCreateEx                                  RT_MANGLER(RTEnvCreateEx)
 # define RTEnvCreateChangeRecord                        RT_MANGLER(RTEnvCreateChangeRecord)
+# define RTEnvCreateChangeRecordEx                      RT_MANGLER(RTEnvCreateChangeRecordEx)
 # define RTEnvDestroy                                   RT_MANGLER(RTEnvDestroy)
 # define RTEnvDupEx                                     RT_MANGLER(RTEnvDupEx)