Función GetComputerNameA (winbase.h)

Artículo
08/27/2023

Recupera el nombre NetBIOS del equipo local. Este nombre se establece al iniciar el sistema, cuando el sistema lo lee del registro.

GetComputerName recupera solo el nombre NetBIOS del equipo local. Para recuperar el nombre de host DNS, el nombre de dominio DNS o el nombre DNS completo, llame a la función GetComputerNameEx . La interfaz IADsADSystemInfo proporciona información adicional.

El comportamiento de esta función puede verse afectado si el equipo local es un nodo de un clúster. Para obtener más información, vea ResUtilGetEnvironmentWithNetName y UseNetworkName.

Sintaxis

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

Parámetros

[out] lpBuffer

Puntero a un búfer que recibe el nombre del equipo o el nombre del servidor virtual del clúster. El tamaño del búfer debe ser lo suficientemente grande como para contener MAX_COMPUTERNAME_LENGTH + 1 caracteres.

[in, out] nSize

En la entrada, especifica el tamaño del búfer, en TCHAR. En la salida, el número de TCHAR copiados en el búfer de destino, no incluido el carácter nulo de terminación.

Si el búfer es demasiado pequeño, se produce un error en la función y GetLastError devuelve ERROR_BUFFER_OVERFLOW. El parámetro lpnSize especifica el tamaño del búfer necesario, incluido el carácter nulo de terminación.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es un valor distinto de cero.

Si la función no se realiza correctamente, el valor devuelto es cero. Para obtener información de error extendida, llame a GetLastError.

Comentarios

La función GetComputerName recupera el nombre NetBIOS establecido en el inicio del sistema. Los cambios de nombre realizados por las funciones SetComputerName o SetComputerNameEx no surten efecto hasta que el usuario reinicie el equipo.

Si el autor de la llamada se ejecuta en una sesión de cliente, esta función devuelve el nombre del servidor. Para recuperar el nombre de cliente, use la función WTSQuerySessionInformation .

Ejemplos

Para obtener un ejemplo, consulte Obtención de información del sistema.

Nota

El encabezado winbase.h define GetComputerName como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutro de codificación con código que no es neutral de codificación puede provocar discrepancias que dan lugar a errores de compilación o en tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos


Cliente mínimo compatible	Windows 2000 Professional [aplicaciones de escritorio \| Aplicaciones para UWP]
Servidor mínimo compatible	Windows 2000 Server [aplicaciones de escritorio \| Aplicaciones para UWP]
Plataforma de destino	Windows
Encabezado	winbase.h (incluya Windows.h)
Library	Kernel32.lib
Archivo DLL	Kernel32.dll