NtQuerySystemEnvironmentValue.c File Reference

#include "precomp.h"

Include dependency graph for NtQuerySystemEnvironmentValue.c:

Go to the source code of this file.

Classes
struct	_TEST_CASE

Macros
#define	MIN_BUFFER_LENGTH   4L
#define	MAX_BUFFER_LENGTH   2048L
#define	COUNT_OF(x)   (sizeof((x))/sizeof((x)[0]))

Typedefs
typedef struct _TEST_CASE	TEST_CASE
typedef struct _TEST_CASE *	PTEST_CASE

Functions
static void	Test_API (IN ULONG TestNumber, IN PTEST_CASE TestCase)
	START_TEST (NtQuerySystemEnvironmentValue)

Variables
static TEST_CASE	TestCases []

Macro Definition Documentation

COUNT_OF

#define COUNT_OF

(

x

)

(sizeof((x))/sizeof((x)[0]))

Definition at line 14 of file NtQuerySystemEnvironmentValue.c.

MAX_BUFFER_LENGTH

#define MAX_BUFFER_LENGTH   2048L

Definition at line 12 of file NtQuerySystemEnvironmentValue.c.

MIN_BUFFER_LENGTH

#define MIN_BUFFER_LENGTH   4L

Definition at line 11 of file NtQuerySystemEnvironmentValue.c.

Typedef Documentation

PTEST_CASE

typedef struct _TEST_CASE * PTEST_CASE

TEST_CASE

typedef struct _TEST_CASE TEST_CASE

Function Documentation

START_TEST()

START_TEST

(

NtQuerySystemEnvironmentValue

)

Definition at line 103 of file NtQuerySystemEnvironmentValue.c.

{
    ULONG i;
 
    for (i = 0 ; i < COUNT_OF(TestCases) ; ++i)
    {
        Test_API(i, &TestCases[i]);
    }
}

Test_API()

static void Test_API ( IN ULONG  TestNumber, IN PTEST_CASE  TestCase  )

static

Definition at line 49 of file NtQuerySystemEnvironmentValue.c.

{
    NTSTATUS Status = STATUS_SUCCESS;
    BOOLEAN  WasEnabled = FALSE;
    WCHAR    ValueBuffer[MAX_BUFFER_LENGTH / sizeof(WCHAR)];
    ULONG    ReturnedLength = 0;
 
    //
    // Adjust the privileges if asked for (we need to
    // have already administrator privileges to do so).
    //
    if (TestCase->AdjustPrivileges)
    {
        Status = RtlAdjustPrivilege(SE_SYSTEM_ENVIRONMENT_PRIVILEGE,
                                    TRUE,
                                    FALSE,
                                    &WasEnabled);
        ok(NT_SUCCESS(Status), "RtlAdjustPrivilege(%lu) failed : 0x%08lx\n", TestNumber, Status);
    }
 
    //
    // Get the system environment value and set the privilege back.
    //
    Status = NtQuerySystemEnvironmentValue(&TestCase->VariableName,
                                           ValueBuffer,
                                           TestCase->ValueBufferLength,
                                           &ReturnedLength);
 
    if (TestCase->AdjustPrivileges)
    {
        RtlAdjustPrivilege(SE_SYSTEM_ENVIRONMENT_PRIVILEGE,
                           WasEnabled,
                           FALSE,
                           &WasEnabled);
    }
 
    //
    // Now check the results.
    //
    ok(Status == TestCase->Result,
       "NtQuerySystemEnvironmentValue(%lu) failed : returned 0x%08lx, expected 0x%08lx\n",
       TestNumber,
       Status,
       TestCase->Result);
 
    ok( ((TestCase->MinimalExpectedReturnedLength <= ReturnedLength) && (ReturnedLength <= TestCase->MaximalExpectedReturnedLength)),
        "NtQuerySystemEnvironmentValue(%lu) failed : returned length %lu, expected between %lu and %lu\n",
        TestNumber,
        ReturnedLength,
        TestCase->MinimalExpectedReturnedLength,
        TestCase->MaximalExpectedReturnedLength);
}

Referenced by START_TEST().

Variable Documentation

TestCases

TEST_CASE TestCases[]

static

Initial value:

=
{
    
    
    
    {STATUS_PRIVILEGE_NOT_HELD, RTL_CONSTANT_STRING(L"NonExistent"),   FALSE, 0, 0, 0},
    {STATUS_PRIVILEGE_NOT_HELD, RTL_CONSTANT_STRING(L"NonExistent"),   FALSE, MIN_BUFFER_LENGTH, 0, 0},
    {STATUS_PRIVILEGE_NOT_HELD, RTL_CONSTANT_STRING(L"NonExistent"),   FALSE, MAX_BUFFER_LENGTH, 0, 0},
    {STATUS_UNSUCCESSFUL      , RTL_CONSTANT_STRING(L"NonExistent"),   TRUE , 0, 0, 0},
    {STATUS_UNSUCCESSFUL      , RTL_CONSTANT_STRING(L"NonExistent"),   TRUE , MIN_BUFFER_LENGTH, 0, 0},
    {STATUS_UNSUCCESSFUL      , RTL_CONSTANT_STRING(L"NonExistent"),   TRUE , MAX_BUFFER_LENGTH, 0, 0},
 
    
    
    
    {STATUS_PRIVILEGE_NOT_HELD, RTL_CONSTANT_STRING(L"LastKnownGood"), FALSE, 0, 0, 0},
    {STATUS_PRIVILEGE_NOT_HELD, RTL_CONSTANT_STRING(L"LastKnownGood"), FALSE, MIN_BUFFER_LENGTH, 0, 0},
    {STATUS_PRIVILEGE_NOT_HELD, RTL_CONSTANT_STRING(L"LastKnownGood"), FALSE, MAX_BUFFER_LENGTH, 0, 0},
    {STATUS_BUFFER_OVERFLOW   , RTL_CONSTANT_STRING(L"LastKnownGood"), TRUE , 0                , MIN_BUFFER_LENGTH, MAX_BUFFER_LENGTH},
    {STATUS_BUFFER_OVERFLOW   , RTL_CONSTANT_STRING(L"LastKnownGood"), TRUE , MIN_BUFFER_LENGTH, MIN_BUFFER_LENGTH, MAX_BUFFER_LENGTH},
    {STATUS_SUCCESS           , RTL_CONSTANT_STRING(L"LastKnownGood"), TRUE , MAX_BUFFER_LENGTH, MIN_BUFFER_LENGTH, MAX_BUFFER_LENGTH},
}

Definition at line 26 of file NtQuerySystemEnvironmentValue.c.

Referenced by START_TEST().