ExpandEnvironmentStringsW(3w)

ExpandEnvironmentStringsW3w

Usage

DWORD ExpandEnvironmentStringsW
(
LPCWSTR src,
LPWSTR dst,
DWORD len
)

Overview

Replaces references to environment variables of the form '%EnvVar%' by their value. If the environment variable does not exist, then the reference is left as is.

Params

src [In] The string to be expanded.

dst [Out] The buffer in which to put the expanded string.

len [In] The buffer size, in characters.

Returns

The number of characters copied into the buffer. If the buffer is too small, then the required buffer size, in characters including the trailing ' ', is returned. If the function fails for some other reason, then it returns 0.

Implementation

Declared in "winbase.h".

Implemented in "dlls/kernel32/environ.c".

Debug channel "environ".

Releases

4 releases since Debian 2.1 (Slink); the text changed 3 times.

  1. 2.1
  2. 5.0
  3. 6.0
  4. 7

From libwine-dev 1.4.1-4 in Debian 7 (Wheezy). Parsed by carta from the page's man source.