Changeset 50642 in vbox for trunk/include

Timestamp:

Feb 27, 2014 8:22:26 PM (11 years ago)

Author:

vboxsync

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

92536

Message:

iprt/env.h: Added RTEnvCountEx and RTEnvGetByIndexEx for enumerating the environment.

Location:

trunk/include/iprt

Files:

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

trunk/include/iprt/env.h

@@ -257 +257 @@
 RTDECL(char *) RTEnvDupEx(RTENV Env, const char *pszVar);
 
+/**
+ * Counts the variables in the environment.
+ *
+ * @returns Number of variables in the environment. UINT32_MAX on error.
+ * @param   hEnv        The environment handle.
+ *                      RTENV_DEFAULT is currently not accepted.
+ */
+RTDECL(uint32_t) RTEnvCountEx(RTENV hEnv);
+
+/**
+ * Queries an environment variable by it's index.
+ *
+ * This can be used together with RTEnvCount to enumerate the environment block.
+ *
+ * @returns IPRT status code.
+ * @retval  VERR_ENV_VAR_NOT_FOUND if the index is out of bounds, output buffers
+ *          untouched.
+ * @retval  VERR_BUFFER_OVERFLOW if one of the buffers are too small.  We'll
+ *          fill it with as much we can in RTStrCopy fashion.
+ *
+ * @param   hEnv        The environment handle.
+ *                      RTENV_DEFAULT is currently not accepted.
+ * @param   iVar        The variable index.
+ * @param   pszVar      Variable name buffer.
+ * @param   cbVar       The size of the variable name buffer.
+ * @param   pszValue    Value buffer.
+ * @param   cbValue     The size of the value buffer.
+ */
+RTDECL(uint32_t) RTEnvGetByIndexEx(RTENV hEnv, uint32_t iVar, char *pszVar, size_t cbVar, char *pszValue, size_t cbValue);
+
 #endif /* IN_RING3 */
 

trunk/include/iprt/mangling.h

@@ -495 +495 @@
 # define RTDvmVolumeCreateVfsFile                       RT_MANGLER(RTDvmVolumeCreateVfsFile)
 # define RTEnvClone                                     RT_MANGLER(RTEnvClone)
+# define RTEnvCountEx                                   RT_MANGLER(RTEnvCountEx)
 # define RTEnvCreate                                    RT_MANGLER(RTEnvCreate)
 # define RTEnvDestroy                                   RT_MANGLER(RTEnvDestroy)
@@ -505 +506 @@
 # define RTEnvGet                                       RT_MANGLER(RTEnvGet)
 # define RTEnvGetBad                                    RT_MANGLER(RTEnvGetBad)
+# define RTEnvGetByIndexEx                              RT_MANGLER(RTEnvGetByIndexEx)
 # define RTEnvGetUtf8                                   RT_MANGLER(RTEnvGetUtf8)
 # define RTEnvGetEx                                     RT_MANGLER(RTEnvGetEx)