#include "shelltest.h"
#include <lmserver.h>
#include <undocshell.h>
#include <strsafe.h>
#include <versionhelpers.h>

Include dependency graph for SHGetComputerDisplayNameW.cpp:

Go to the source code of this file.

Macros
#define	COMPUTER_DESCRIPTIONS_KEY L"Software\\Microsoft\\Windows\\CurrentVersion\\Explorer\\ComputerDescriptions"

Typedefs
typedef HRESULT(WINAPI *	FN_SHGetComputerDisplayNameW) (PWSTR, DWORD, PWSTR, DWORD)

typedef NET_API_STATUS(WINAPI *	FN_NetServerGetInfo) (LPWSTR, DWORD, PBYTE *)

typedef NET_API_STATUS(WINAPI *	FN_NetApiBufferFree) (PVOID)

Functions
static PCWSTR	SHELL_SkipServerSlashes (_In_ PCWSTR pszPath)

static VOID	SHELL_CacheComputerDescription (_In_ PCWSTR pszServerName, _In_ PCWSTR pszDesc)

static HRESULT	SHELL_GetCachedComputerDescription (_Out_writes_z_(cchDescMax) PWSTR pszDesc, _In_ DWORD cchDescMax, _In_ PCWSTR pszServerName)

static HRESULT	SHELL_BuildDisplayMachineName (_Out_writes_z_(cchNameMax) PWSTR pszName, _In_ DWORD cchNameMax, _In_ PCWSTR pszServerName, _In_ PCWSTR pszDescription)

static VOID	TEST_SHGetComputerDisplayNameW (VOID)

	START_TEST (SHGetComputerDisplayNameW)

Variables
static FN_SHGetComputerDisplayNameW	s_pSHGetComputerDisplayNameW = NULL

static FN_NetServerGetInfo	s_pNetServerGetInfo = NULL

static FN_NetApiBufferFree	s_pNetApiBufferFree = NULL

Macro Definition Documentation

◆ COMPUTER_DESCRIPTIONS_KEY

#define COMPUTER_DESCRIPTIONS_KEY L"Software\\Microsoft\\Windows\\CurrentVersion\\Explorer\\ComputerDescriptions"

Definition at line 22 of file SHGetComputerDisplayNameW.cpp.

Typedef Documentation

◆ FN_NetApiBufferFree

typedef NET_API_STATUS(WINAPI * FN_NetApiBufferFree) (PVOID)

Definition at line 16 of file SHGetComputerDisplayNameW.cpp.

◆ FN_NetServerGetInfo

typedef NET_API_STATUS(WINAPI * FN_NetServerGetInfo) (LPWSTR, DWORD, PBYTE *)

Definition at line 15 of file SHGetComputerDisplayNameW.cpp.

◆ FN_SHGetComputerDisplayNameW

typedef HRESULT(WINAPI * FN_SHGetComputerDisplayNameW) (PWSTR, DWORD, PWSTR, DWORD)

Definition at line 14 of file SHGetComputerDisplayNameW.cpp.

Function Documentation

◆ SHELL_BuildDisplayMachineName()

static HRESULT SHELL_BuildDisplayMachineName	(	_Out_writes_z_(cchNameMax) PWSTR	pszName,
		_In_ DWORD	cchNameMax,
		_In_ PCWSTR	pszServerName,
		_In_ PCWSTR	pszDescription
	)

static

Definition at line 61 of file SHGetComputerDisplayNameW.cpp.

{
    if (!pszDescription || !*pszDescription)
        return E_FAIL;
 
    PCWSTR pszFormat = (SHRestricted(REST_ALLOWCOMMENTTOGGLE) ? L"%2 (%1)" : L"%1 (%2)");
    PCWSTR args[] = { pszDescription , SHELL_SkipServerSlashes(pszServerName) };
    return (FormatMessageW(FORMAT_MESSAGE_ARGUMENT_ARRAY | FORMAT_MESSAGE_FROM_STRING,
                           pszFormat, 0, 0, pszName, cchNameMax, (va_list *)args) ? S_OK : E_FAIL);
}

Referenced by TEST_SHGetComputerDisplayNameW().

◆ SHELL_CacheComputerDescription()

static VOID SHELL_CacheComputerDescription	(	_In_ PCWSTR	pszServerName,
		_In_ PCWSTR	pszDesc
	)

static

Definition at line 36 of file SHGetComputerDisplayNameW.cpp.

{
    if (!pszDesc)
        return;
 
    SIZE_T cbDesc = (wcslen(pszDesc) + 1) * sizeof(WCHAR);
    SHSetValueW(HKEY_CURRENT_USER, COMPUTER_DESCRIPTIONS_KEY,
                SHELL_SkipServerSlashes(pszServerName), REG_SZ, pszDesc, (DWORD)cbDesc);
}

Referenced by TEST_SHGetComputerDisplayNameW().

◆ SHELL_GetCachedComputerDescription()

static HRESULT SHELL_GetCachedComputerDescription	(	_Out_writes_z_(cchDescMax) PWSTR	pszDesc,
		_In_ DWORD	cchDescMax,
		_In_ PCWSTR	pszServerName
	)

static

Definition at line 49 of file SHGetComputerDisplayNameW.cpp.

{
    cchDescMax *= sizeof(WCHAR);
    DWORD error = SHGetValueW(HKEY_CURRENT_USER, COMPUTER_DESCRIPTIONS_KEY,
                              SHELL_SkipServerSlashes(pszServerName), NULL, pszDesc, &cchDescMax);
    return HRESULT_FROM_WIN32(error);
}

Referenced by TEST_SHGetComputerDisplayNameW().

◆ SHELL_SkipServerSlashes()

static PCWSTR SHELL_SkipServerSlashes ( _In_ PCWSTR pszPath )

static

Definition at line 26 of file SHGetComputerDisplayNameW.cpp.

{
    PCWSTR pch;
    for (pch = pszPath; *pch == L'\\'; ++pch)
        ;
    return pch;
}

Referenced by SHELL_BuildDisplayMachineName(), SHELL_CacheComputerDescription(), and SHELL_GetCachedComputerDescription().

◆ START_TEST()

START_TEST ( SHGetComputerDisplayNameW )

Definition at line 123 of file SHGetComputerDisplayNameW.cpp.

{
    if (IsWindowsVistaOrGreater())
    {
        skip("Tests on Vista+ will cause exception\n");
        return;
    }
 
    HINSTANCE hShell32 = GetModuleHandleW(L"shell32.dll");
    s_pSHGetComputerDisplayNameW =
        (FN_SHGetComputerDisplayNameW)GetProcAddress(hShell32, MAKEINTRESOURCEA(752));
    if (!s_pSHGetComputerDisplayNameW)
    {
        skip("SHGetComputerDisplayNameW not found\n");
        return;
    }
 
    HINSTANCE hNetApi32 = LoadLibraryW(L"netapi32.dll");
    if (!hNetApi32)
    {
        skip("netapi32.dll not found\n");
        return;
    }
 
    s_pNetServerGetInfo = (FN_NetServerGetInfo)GetProcAddress(hNetApi32, "NetServerGetInfo");
    s_pNetApiBufferFree = (FN_NetApiBufferFree)GetProcAddress(hNetApi32, "NetApiBufferFree");
    if (!s_pNetServerGetInfo || !s_pNetApiBufferFree)
    {
        skip("NetServerGetInfo or NetApiBufferFree not found\n");
        FreeLibrary(hNetApi32);
        return;
    }
 
    TEST_SHGetComputerDisplayNameW();
 
    FreeLibrary(hNetApi32);
}

◆ TEST_SHGetComputerDisplayNameW()

static VOID TEST_SHGetComputerDisplayNameW ( VOID )

static

Definition at line 77 of file SHGetComputerDisplayNameW.cpp.

{
    WCHAR szCompName[MAX_COMPUTERNAME_LENGTH + 1], szDesc[256], szDisplayName[MAX_PATH];
    WCHAR szName[MAX_PATH], szServerName[] = L"DummyServerName";
 
    DWORD cchCompName = _countof(szCompName);
    BOOL ret = GetComputerNameW(szCompName, &cchCompName);
    ok_int(ret, TRUE);
    trace("%s\n", wine_dbgstr_w(szCompName));
 
    SHELL_CacheComputerDescription(szServerName, L"DummyDescription");
 
    HRESULT hr = SHELL_GetCachedComputerDescription(szDesc, _countof(szDesc), szServerName);
    if (FAILED(hr))
        szDesc[0] = UNICODE_NULL;
    trace("%s\n", wine_dbgstr_w(szDesc));
 
    StringCchCopyW(szDisplayName, _countof(szDisplayName), L"@");
    hr = s_pSHGetComputerDisplayNameW(NULL, SHGCDN_NOCACHE, szDisplayName, _countof(szDisplayName));
    ok_hex(hr, S_OK);
    trace("%s\n", wine_dbgstr_w(szDisplayName));
    ok_wstr(szDisplayName, szCompName);
 
    StringCchCopyW(szDisplayName, _countof(szDisplayName), L"@");
    hr = s_pSHGetComputerDisplayNameW(szServerName, 0, szDisplayName, _countof(szDisplayName));
    ok_hex(hr, S_OK);
    trace("%s\n", wine_dbgstr_w(szServerName));
    ok_wstr(szServerName, L"DummyServerName");
 
    hr = SHELL_BuildDisplayMachineName(szName, _countof(szName), szServerName, szDesc);
    ok_hex(hr, S_OK);
 
    trace("%s\n", wine_dbgstr_w(szDisplayName));
    trace("%s\n", wine_dbgstr_w(szName));
    ok_wstr(szDisplayName, szName);
 
    // Delete registry value
    HKEY hKey;
    LSTATUS error = RegOpenKeyExW(HKEY_CURRENT_USER, COMPUTER_DESCRIPTIONS_KEY, 0, KEY_WRITE, &hKey);
    if (error == ERROR_SUCCESS)
    {
        RegDeleteValueW(hKey, L"DummyServerName");
        RegCloseKey(hKey);
    }
}