Функция GetComputerNameA (winbase.h)

Статья
11/20/2024

Извлекает имя NetBIOS локального компьютера. Это имя устанавливается при запуске системы, когда система считывает ее из реестра.

GetComputerName извлекает только имя NetBIOS локального компьютера. Чтобы получить dns-имя узла, доменное имя DNS или полное DNS-имя, вызовите функцию GetComputerNameEx. Дополнительные сведения предоставляются интерфейсом IADsADSystemInfo.

Поведение этой функции может быть затронуто, если локальный компьютер является узлом в кластере. Дополнительные сведения см. в разделе ResUtilGetEnvironmentWithNetName и UseNetworkName.

Синтаксис

BOOL GetComputerNameA(
  [out]     LPSTR   lpBuffer,
  [in, out] LPDWORD nSize
);

Параметры

[out] lpBuffer

Указатель на буфер, который получает имя компьютера или имя виртуального сервера кластера. Размер буфера должен быть достаточно большим, чтобы содержать MAX_COMPUTERNAME_LENGTH + 1 символов.

[in, out] nSize

При входных данных указывает размер буфера в TCHARs. В выходных данных число TCHARs скопировано в целевой буфер, не включая завершающийся символ NULL.

Если буфер слишком мал, функция завершается ошибкой и GetLastError возвращает ERROR_BUFFER_OVERFLOW. Параметр lpnSize указывает размер требуемого буфера, включая завершающийся символ NULL.

Возвращаемое значение

Если функция выполнена успешно, возвращаемое значение является ненулевое значение.

Если функция завершается ошибкой, возвращаемое значение равно нулю. Чтобы получить расширенные сведения об ошибке, вызовите GetLastError.

Замечания

Функция getComputerName извлекает имя NetBIOS, установленное при запуске системы. Изменения имен, внесенные функциями setComputerName или SetComputerNameEx, не вступают в силу, пока пользователь не перезагрузит компьютер.

Если вызывающий объект выполняется в сеансе клиента, эта функция возвращает имя сервера. Чтобы получить имя клиента, используйте функцию WTSQuerySessionInformation.

Примеры

Пример см. в получения сведений о системе.

Заметка

Заголовок winbase.h определяет GetComputerName в качестве псевдонима, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОДа. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows 2000 Профессиональный [классические приложения \| Приложения UWP]
минимальный поддерживаемый сервер	Windows 2000 Server [классические приложения \| Приложения UWP]
целевая платформа	Виндоус
заголовка	winbase.h (включая Windows.h)
библиотеки	Kernel32.lib
DLL	Kernel32.dll