ExpandEnvironmentStrings.md

Home

Function name : ExpandEnvironmentStrings

Group: System Information - Library: kernel32

---

Expands environment-variable strings and replaces them with their defined values.

---

Code examples:

Converting path to original case
One more way to retrieve environment strings

Declaration:

DWORD ExpandEnvironmentStrings(
  LPCTSTR lpSrc, // string with envir.variables
  LPTSTR lpDst,  // string with expanded strings
  DWORD nSize    // max. characters in expanded string
);  

---

FoxPro declaration:

DECLARE INTEGER ExpandEnvironmentStrings IN kernel32;
	STRING   lpSrc,;
	STRING @ lpDst,;
	INTEGER  nSize  

---

Parameters:

lpSrc [in] Pointer to a null-terminated string that contains environment-variable strings of the form: %variableName%.

lpDst [out] Pointer to a buffer to receive a copy of the source buffer after all environment-variable name substitutions have been performed.

nSize [in] Specifies the maximum number of TCHARs that can be stored in the buffer pointed to by the lpDst parameter, including the terminating null character.

---

Return value:

If the function succeeds, the return value is the number of TCHARs stored in the destination buffer, including the terminating null character.

---

Comments:

See also GetEnvironmentStrings, GetSystemInfo.

---