environ.c File Reference

#include <k32.h>
#include <debug.h>

Include dependency graph for environ.c:

Go to the source code of this file.

Macros
#define	NDEBUG

Functions
DWORD WINAPI DECLSPEC_HOTPATCH	GetEnvironmentVariableA (IN LPCSTR lpName, IN LPSTR lpBuffer, IN DWORD nSize)
DWORD WINAPI DECLSPEC_HOTPATCH	GetEnvironmentVariableW (IN LPCWSTR lpName, IN LPWSTR lpBuffer, IN DWORD nSize)
BOOL WINAPI DECLSPEC_HOTPATCH	SetEnvironmentVariableA (IN LPCSTR lpName, IN LPCSTR lpValue)
BOOL WINAPI DECLSPEC_HOTPATCH	SetEnvironmentVariableW (IN LPCWSTR lpName, IN LPCWSTR lpValue)
LPSTR WINAPI	GetEnvironmentStringsA (VOID)
LPWSTR WINAPI	GetEnvironmentStringsW (VOID)
BOOL WINAPI	FreeEnvironmentStringsA (IN LPSTR EnvironmentStrings)
BOOL WINAPI	FreeEnvironmentStringsW (IN LPWSTR EnvironmentStrings)
DWORD WINAPI	ExpandEnvironmentStringsA (IN LPCSTR lpSrc, IN LPSTR lpDst, IN DWORD nSize)
DWORD WINAPI	ExpandEnvironmentStringsW (IN LPCWSTR lpSrc, IN LPWSTR lpDst, IN DWORD nSize)
BOOL WINAPI	SetEnvironmentStringsA (IN LPCH NewEnvironment)
BOOL WINAPI	SetEnvironmentStringsW (IN LPWCH NewEnvironment)

Macro Definition Documentation

NDEBUG

#define NDEBUG

Definition at line 17 of file environ.c.

Function Documentation

ExpandEnvironmentStringsA()

DWORD WINAPI ExpandEnvironmentStringsA	(	IN LPCSTR	lpSrc,
		IN LPSTR	lpDst,
		IN DWORD	nSize
	)

Definition at line 400 of file environ.c.

{
    ANSI_STRING Source, Dest;
    UNICODE_STRING SourceU, DestU;
    PWSTR Buffer;
    ULONG Result = 0, Length;
    USHORT UniSize;
    NTSTATUS Status;
 
    /* Check if the size is too big to fit */
    UniSize = UNICODE_STRING_MAX_CHARS - 2;
    if (nSize <= UniSize) UniSize = (USHORT)nSize;
 
    /* Clear the input buffer */
    if (lpDst) *lpDst = ANSI_NULL;
 
    /* Initialize all the strings */
    RtlInitAnsiString(&Source, lpSrc);
    RtlInitUnicodeString(&SourceU, NULL);
    RtlInitUnicodeString(&DestU, NULL);
    Status = RtlAnsiStringToUnicodeString(&SourceU, &Source, TRUE);
    if (!NT_SUCCESS(Status)) goto Quickie;
 
    /* If the string fit in, make space for a NULL char */
    if (UniSize)
    {
        UniSize--;
    }
    else
    {
        /* No input size, so no string size */
        UniSize = 0;
    }
 
    /* Allocate the value string buffer */
    Buffer = RtlAllocateHeap(RtlGetProcessHeap(), 0, UniSize * sizeof(WCHAR));
    if (!Buffer)
    {
        Status = STATUS_NO_MEMORY;
        goto Quickie;
    }
 
    /* And initialize its string */
    RtlInitEmptyUnicodeString(&DestU, Buffer, UniSize * sizeof(WCHAR));
 
    /* Query the variable */
    Length = 0;
    Status = RtlExpandEnvironmentStrings_U(NULL, &SourceU, &DestU, &Length);
 
    /* Check if we didn't have enough space */
    if (Status == STATUS_BUFFER_TOO_SMALL)
    {
        /* Fixup the length that the API returned */
        DestU.MaximumLength = (SHORT)Length;
 
        /* Free old Unicode buffer */
        RtlFreeHeap(RtlGetProcessHeap(), 0, DestU.Buffer);
 
        /* Allocate new one */
        Buffer = RtlAllocateHeap(RtlGetProcessHeap(), 0, Length);
        if (Buffer)
        {
            /* Query the variable so we can know its size */
            DestU.Buffer = Buffer;
            Status = RtlExpandEnvironmentStrings_U(NULL, &SourceU, &DestU, &Length);
            if (NT_SUCCESS(Status))
            {
                /* Get the ASCII length of the variable, add a byte for NULL */
                Result = RtlUnicodeStringToAnsiSize(&DestU) + sizeof(ANSI_NULL);
            }
        }
        else
        {
            /* Set failure status */
            Status = STATUS_NO_MEMORY;
            DestU.Buffer = NULL;
        }
    }
    else if (NT_SUCCESS(Status))
    {
        /* Check if the size is too big to fit */
        UniSize = UNICODE_STRING_MAX_BYTES - 1;
        if (nSize <= UniSize) UniSize = (USHORT)nSize;
 
        /* Check the size */
        Result = RtlUnicodeStringToAnsiSize(&DestU);
        if (Result <= UniSize)
        {
            /* Convert the string */
            RtlInitEmptyAnsiString(&Dest, lpDst, UniSize);
            Status = RtlUnicodeStringToAnsiString(&Dest, &DestU, FALSE);
 
            /* Write a NULL-char in case of failure only */
            if (!NT_SUCCESS(Status)) *lpDst = ANSI_NULL;
        }
    }
Quickie:
    /* Free the strings */
    RtlFreeUnicodeString(&SourceU);
    if (DestU.Buffer) RtlFreeHeap(RtlGetProcessHeap(), 0, DestU.Buffer);
 
    /* Check if we succeeded */
    if (!NT_SUCCESS(Status))
    {
        /* We did not, clear the result and set the error code */
        BaseSetLastNTError(Status);
        Result = 0;
    }
 
    /* Return the result */
    return Result;
}

Referenced by create_test_entries(), DoEnvironmentSubstA(), HCR_RegGetIconA(), install_from_registered_dir(), RegGetValueA(), SHQueryValueExA(), test_appsearch_reglocator(), TEST_AssocQueryStringA(), test_DoEnvironmentSubst(), test_ExpandEnvironmentStringsA(), test_get_profiles_dir(), TEST_Start(), and WsNpInitialize().

ExpandEnvironmentStringsW()

DWORD WINAPI ExpandEnvironmentStringsW	(	IN LPCWSTR	lpSrc,
		IN LPWSTR	lpDst,
		IN DWORD	nSize
	)

Definition at line 520 of file environ.c.

{
    UNICODE_STRING Source, Destination;
    NTSTATUS Status;
    USHORT UniSize;
 
    UniSize = min(nSize, UNICODE_STRING_MAX_CHARS - 2);
 
    RtlInitUnicodeString(&Source, (LPWSTR)lpSrc);
    RtlInitEmptyUnicodeString(&Destination, lpDst, UniSize * sizeof(WCHAR));
 
    Status = RtlExpandEnvironmentStrings_U(NULL,
                                           &Source,
                                           &Destination,
                                           &nSize);
    if ((NT_SUCCESS(Status)) || (Status == STATUS_BUFFER_TOO_SMALL))
    {
        return nSize / sizeof(WCHAR);
    }
 
    BaseSetLastNTError(Status);
    return 0;
}

Referenced by _SHExpandEnvironmentStrings(), _tryLoadProvider(), AddNewTopicEx(), AddNotificationDll(), AddSfcNotification(), AddUserProfile(), AppendSystemPostfix(), BackupIniFile(), BuildCommandLine(), Control_LoadApplet(), convert_reg_value(), CClassNode::ConvertResourceDescriptorToString(), CopySystemProfile(), CreateShortcut(), CreateTempDir(), CreateUserProfileExW(), CryptAcquireContextW(), DeleteProfileW(), DoEnvironmentSubstW(), DoLoadIcons(), CShellLink::DoOpen(), DoWriteSoundEvents(), EditTypeDlg_OnChangeIcon(), EditTypeDlg_OnInitDialog(), EditTypeDlg_UpdateEntryIcon(), EnableVisualTheme(), CACListISF::Expand(), expand_environment(), ExpandEnvironmentStringsA(), ExpandEnvStrings(), FileQueryFiles(), get_object_dll_path(), GetAllUsersProfileDirectoryW(), CInstalledApplicationInfo::GetApplicationRegString(), GetDefaultUserProfileDirectoryW(), GetDesktopPath(), CQueryAssociations::GetExecutable(), GetExpandedFilePathName(), GetFileTypeIconsEx(), getIconLocationForDrive(), getIconLocationForFolder(), GetLayoutName(), GetProfilesDirectoryW(), GetProgramsPath(), GetServiceMainFunctions(), GetUserProfileDirectoryW(), RunOnceExSection::HandleValue(), HCR_RegGetIconW(), ICO_ExtractIconExW(), ImportSoundLabel(), init_envvars_map(), init_filedlg_infoW(), CLayerUIPropPage::InitFile(), InitializeProfiles(), InitializeProgramFilesDir(), CFileDefExt::InitOpensWithField(), LaunchProcess(), load_mapi_provider(), load_provider(), LoadIniFile(), LoadLogFile(), MyFileExists(), CNewMenu::NewItemByCommand(), OpenHostsFile(), PathEnvSubstIsDirectory(), PickIconDlg(), PlaySound_ExpandEnvironmentStrings(), ProcessRunKeys(), ProcessUnattendSection(), query_reg_path(), RegGetValueW(), CControlPanelEnum::RegisterRegistryCPanelApps(), RegLoadMUIStringW(), resolve_filename(), runCmd(), RunCommand(), RunDlgProc(), RunSetupThreadProc(), ScmConvertToBootPathName(), ScmReadString(), search_reg(), SetUserWallpaper(), SHGetShellStyleHInstance(), SHLoadIndirectString(), SHPropertyBag_OnIniFile(), SHPropertyBag_SHSetIniStringW(), SHQueryValueExW(), SockLoadHelperDll(), start_debugger(), START_TEST(), StartProcess(), TEST_AssocQueryStringW(), test_checklinkpath(), test_DoEnvironmentSubst(), test_ExpandEnvironmentStringsA(), test_ExpandEnvironmentStringsW(), test_iconlocation(), Test_ProtectedFiles(), TEST_Start(), TRASH_PlayEmptyRecycleBinSound(), variant_from_registry_value(), WelcomeDlgProc(), WlxActivateUserShell(), WriteIniFile(), and WshShell3_ExpandEnvironmentStrings().

FreeEnvironmentStringsA()

BOOL WINAPI FreeEnvironmentStringsA

(

IN LPSTR

EnvironmentStrings

)

Definition at line 380 of file environ.c.

{
    return RtlFreeHeap(RtlGetProcessHeap(), 0, EnvironmentStrings);
}

Referenced by BlockEnvToEnvironA(), doChild(), env_init(), and test_Environment().

FreeEnvironmentStringsW()

BOOL WINAPI FreeEnvironmentStringsW

(

IN LPWSTR

EnvironmentStrings

)

Definition at line 390 of file environ.c.

{
    return RtlFreeHeap(RtlGetProcessHeap(), 0, EnvironmentStrings);
}

Referenced by BlockEnvToEnvironW(), anonymous_namespace{get_environment_from_os.cpp}::environment_strings_traits::close(), env_init(), service_main(), SHELL_BuildEnvW(), start_debugger(), Test_ApphelpCheckRunApp(), test_child_env(), test_GetEnvironmentStringsW(), and test_SetEnvironmentStrings().

GetEnvironmentStringsA()

LPSTR WINAPI GetEnvironmentStringsA

(

VOID

)

Definition at line 294 of file environ.c.

{
    ULONG Length, Size;
    NTSTATUS Status;
    PWCHAR Environment, p;
    PCHAR Buffer = NULL;
 
    RtlAcquirePebLock();
    p = Environment = NtCurrentPeb()->ProcessParameters->Environment;
 
    do
    {
        p += wcslen(p) + 1;
    } while (*p);
 
    Length = p - Environment + 1;
 
    Status = RtlUnicodeToMultiByteSize(&Size, Environment, Length * sizeof(WCHAR));
    if (NT_SUCCESS(Status))
    {
        Buffer = RtlAllocateHeap(RtlGetProcessHeap(), 0, Size);
        if (Buffer)
        {
            Status = RtlUnicodeToOemN(Buffer, Size, 0, Environment, Length * sizeof(WCHAR));
            if (!NT_SUCCESS(Status))
            {
                RtlFreeHeap(RtlGetProcessHeap(), 0, Buffer);
                Buffer = NULL;
 
                BaseSetLastNTError(Status);
            }
        }
        else
        {
            BaseSetLastNTError(STATUS_NO_MEMORY);
        }
    }
    else
    {
        BaseSetLastNTError(Status);
    }
 
    RtlReleasePebLock();
    return Buffer;
}

GetEnvironmentStringsW()

LPWSTR WINAPI GetEnvironmentStringsW

(

VOID

)

Definition at line 345 of file environ.c.

{
    PWCHAR Environment, p;
    ULONG Length;
 
    RtlAcquirePebLock();
 
    p = Environment = NtCurrentPeb()->ProcessParameters->Environment;
 
    do
    {
        p += wcslen(p) + 1;
    } while (*p);
 
    Length = p - Environment + 1;
 
    p = RtlAllocateHeap(RtlGetProcessHeap(), 0, Length * sizeof(WCHAR));
    if (p)
    {
        RtlCopyMemory(p, Environment, Length * sizeof(WCHAR));
    }
    else
    {
        BaseSetLastNTError(STATUS_NO_MEMORY);
    }
 
    RtlReleasePebLock();
    return p;
}

GetEnvironmentVariableA()

DWORD WINAPI DECLSPEC_HOTPATCH GetEnvironmentVariableA	(	IN LPCSTR	lpName,
		IN LPSTR	lpBuffer,
		IN DWORD	nSize
	)

Definition at line 28 of file environ.c.

{
    ANSI_STRING VarName, VarValue;
    UNICODE_STRING VarNameU, VarValueU;
    PWSTR Buffer;
    ULONG Result = 0;
    USHORT UniSize;
    NTSTATUS Status;
 
    /* Initialize all the strings */
    RtlInitAnsiString(&VarName, lpName);
    RtlInitUnicodeString(&VarNameU, NULL);
    RtlInitUnicodeString(&VarValueU, NULL);
    Status = RtlAnsiStringToUnicodeString(&VarNameU, &VarName, TRUE);
    if (!NT_SUCCESS(Status)) goto Quickie;
 
    /* Check if the size is too big to fit */
    UniSize = UNICODE_STRING_MAX_CHARS - 2;
    if (nSize <= UniSize)
    {
        /* It fits, but was there a string at all? */
        if (nSize)
        {
            /* Keep the given size, minus a NULL-char */
            UniSize = (USHORT)(nSize - 1);
        }
        else
        {
            /* No size */
            UniSize = 0;
        }
    }
    else
    {
        /* String is too big, so we need to return a NULL char as well */
        UniSize--;
    }
 
    /* Allocate the value string buffer */
    Buffer = RtlAllocateHeap(RtlGetProcessHeap(), 0, UniSize * sizeof(WCHAR));
    if (!Buffer)
    {
        Status = STATUS_NO_MEMORY;
        goto Quickie;
    }
 
    /* And initialize its string */
    RtlInitEmptyUnicodeString(&VarValueU, Buffer, UniSize * sizeof(WCHAR));
 
    /* Acquire the PEB lock since we'll be querying variables now */
    RtlAcquirePebLock();
 
    /* Query the variable */
    Status = RtlQueryEnvironmentVariable_U(NULL, &VarNameU, &VarValueU);
    if ((NT_SUCCESS(Status)) && !(nSize)) Status = STATUS_BUFFER_TOO_SMALL;
 
    /* Check if we didn't have enough space */
    if (Status == STATUS_BUFFER_TOO_SMALL)
    {
        /* Fixup the length that the API returned */
        VarValueU.MaximumLength = VarValueU.Length + sizeof(UNICODE_NULL);
 
        /* Free old Unicode buffer */
        RtlFreeHeap(RtlGetProcessHeap(), 0, VarValueU.Buffer);
 
        /* Allocate new one */
        Buffer = RtlAllocateHeap(RtlGetProcessHeap(), 0, VarValueU.MaximumLength);
        if (Buffer)
        {
            /* Query the variable so we can know its size */
            VarValueU.Buffer = Buffer;
            Status = RtlQueryEnvironmentVariable_U(NULL, &VarNameU, &VarValueU);
            if (NT_SUCCESS(Status))
            {
                /* Get the ASCII length of the variable */
                Result = RtlUnicodeStringToAnsiSize(&VarValueU);
            }
        }
        else
        {
            /* Set failure status */
            Status = STATUS_NO_MEMORY;
            VarValueU.Buffer = NULL;
        }
    }
    else if (NT_SUCCESS(Status))
    {
        /* Check if the size is too big to fit */
        UniSize = UNICODE_STRING_MAX_BYTES - 1;
        if (nSize <= UniSize) UniSize = (USHORT)nSize;
 
        /* Check the size */
        Result = RtlUnicodeStringToAnsiSize(&VarValueU);
        if (Result <= UniSize)
        {
            /* Convert the string */
            RtlInitEmptyAnsiString(&VarValue, lpBuffer, UniSize);
            Status = RtlUnicodeStringToAnsiString(&VarValue, &VarValueU, FALSE);
            if (NT_SUCCESS(Status))
            {
                /* NULL-terminate and set the final length */
                lpBuffer[VarValue.Length] = ANSI_NULL;
                Result = VarValue.Length;
            }
        }
    }
 
    /* Release the lock */
    RtlReleasePebLock();
 
Quickie:
    /* Free the strings */
    RtlFreeUnicodeString(&VarNameU);
    if (VarValueU.Buffer) RtlFreeHeap(RtlGetProcessHeap(), 0, VarValueU.Buffer);
 
    /* Check if we succeeded */
    if (!NT_SUCCESS(Status))
    {
        /* We did not, clear the result and set the error code */
        BaseSetLastNTError(Status);
        Result = 0;
    }
 
    /* Return the result */
    return Result;
}

GetEnvironmentVariableW()

DWORD WINAPI DECLSPEC_HOTPATCH GetEnvironmentVariableW	(	IN LPCWSTR	lpName,
		IN LPWSTR	lpBuffer,
		IN DWORD	nSize
	)

Definition at line 163 of file environ.c.

{
    UNICODE_STRING VarName, VarValue;
    NTSTATUS Status;
    USHORT UniSize;
 
    if (nSize <= (UNICODE_STRING_MAX_CHARS - 1))
    {
        if (nSize)
        {
            UniSize = (USHORT)nSize * sizeof(WCHAR) - sizeof(UNICODE_NULL);
        }
        else
        {
            UniSize = 0;
        }
    }
    else
    {
        UniSize = UNICODE_STRING_MAX_BYTES - sizeof(UNICODE_NULL);
    }
 
    Status = RtlInitUnicodeStringEx(&VarName, lpName);
    if (!NT_SUCCESS(Status))
    {
        BaseSetLastNTError(Status);
        return 0;
    }
 
    RtlInitEmptyUnicodeString(&VarValue, lpBuffer, UniSize);
 
    Status = RtlQueryEnvironmentVariable_U(NULL, &VarName, &VarValue);
    if (!NT_SUCCESS(Status))
    {
        if (Status == STATUS_BUFFER_TOO_SMALL)
        {
            return (VarValue.Length / sizeof(WCHAR)) + sizeof(ANSI_NULL);
        }
        BaseSetLastNTError (Status);
        return 0;
    }
 
    if (lpBuffer)
        lpBuffer[VarValue.Length / sizeof(WCHAR)] = UNICODE_NULL;
 
    return (VarValue.Length / sizeof(WCHAR));
}

SetEnvironmentStringsA()

BOOL WINAPI SetEnvironmentStringsA

(

IN LPCH

NewEnvironment

)

Definition at line 551 of file environ.c.

{
    STUB;
    return FALSE;
}

SetEnvironmentStringsW()

BOOL WINAPI SetEnvironmentStringsW

(

IN LPWCH

NewEnvironment

)

Definition at line 562 of file environ.c.

{
    STUB;
    return FALSE;
}

SetEnvironmentVariableA()

BOOL WINAPI DECLSPEC_HOTPATCH SetEnvironmentVariableA	(	IN LPCSTR	lpName,
		IN LPCSTR	lpValue
	)

Definition at line 219 of file environ.c.

{
    ANSI_STRING VarName, VarValue;
    UNICODE_STRING VarNameU, VarValueU;
    NTSTATUS Status;
 
    RtlInitAnsiString(&VarName, (LPSTR)lpName);
    Status = RtlAnsiStringToUnicodeString(&VarNameU, &VarName, TRUE);
    if (NT_SUCCESS(Status))
    {
        if (lpValue)
        {
            RtlInitAnsiString(&VarValue, (LPSTR)lpValue);
            Status = RtlAnsiStringToUnicodeString(&VarValueU, &VarValue, TRUE);
            if (NT_SUCCESS(Status))
            {
                Status = RtlSetEnvironmentVariable(NULL, &VarNameU, &VarValueU);
                RtlFreeUnicodeString(&VarValueU);
            }
        }
        else
        {
            Status = RtlSetEnvironmentVariable(NULL, &VarNameU, NULL);
        }
 
        RtlFreeUnicodeString(&VarNameU);
 
        if (NT_SUCCESS(Status)) return TRUE;
    }
 
    BaseSetLastNTError(Status);
    return FALSE;
}

Referenced by create_environ(), create_test_entries(), init_test(), process1(), silence_debug_output(), START_TEST(), Test_ApphelpCheckRunApp(), test_create_env(), test_environment_manipulation(), test_ExpandEnvironmentStringsA(), test_FileTimeToLocalFileTime(), test_fileurls(), test_formatrecord(), test_formatrecord2(), test_formatrecord_tables(), Test_GetMatchingExe(), test_GetSetEnvironmentVariableA(), test_GetSetEnvironmentVariableAW(), test_GetTempPath(), test_GetTimeZoneInformation(), test_GetVolumeInformationA(), test_Installer_RegistryValue(), test_LdrGetDllPath(), test_LoadImage_working_directory(), test_mode_generic(), test_NeedCurrentDirectoryForExePathA(), test_NeedCurrentDirectoryForExePathW(), test_PathUnExpandEnvStrings(), Test_repeatlayer(), test_RtlGetExePath(), test_RtlGetSearchPath(), test_search_path(), test_SetEnvironmentStrings(), and test_urls().

SetEnvironmentVariableW()

BOOL WINAPI DECLSPEC_HOTPATCH SetEnvironmentVariableW	(	IN LPCWSTR	lpName,
		IN LPCWSTR	lpValue
	)

Definition at line 260 of file environ.c.

{
    UNICODE_STRING VarName, VarValue;
    NTSTATUS Status;
 
    Status = RtlInitUnicodeStringEx(&VarName, lpName);
    if (NT_SUCCESS(Status))
    {
        if (lpValue)
        {
            Status = RtlInitUnicodeStringEx(&VarValue, lpValue);
            if (NT_SUCCESS(Status))
            {
                Status = RtlSetEnvironmentVariable(NULL, &VarName, &VarValue);
            }
        }
        else
        {
            Status = RtlSetEnvironmentVariable(NULL, &VarName, NULL);
        }
 
        if (NT_SUCCESS(Status)) return TRUE;
    }
 
    BaseSetLastNTError(Status);
    return FALSE;
}

Referenced by _tchdir(), _wchdir(), CreateStandardProfile(), DoEntry(), env_set(), RegenerateUserEnvironment(), set_environment(), SetEnv(), START_TEST(), test_ExpandEnvironmentStringsW(), test_GetSetEnvironmentVariableAW(), test_GetSetEnvironmentVariableW(), test_LdrGetDllPath(), test_query_object(), test_RtlGetExePath(), test_RtlGetSearchPath(), TEST_ShellExecCmdLine(), TestMain_PathResolve(), and TestShellLink().