Función SetVolumeLabelA (winbase.h)

Establece la etiqueta de un volumen del sistema de archivos.

Sintaxis

BOOL SetVolumeLabelA(
  [in, optional] LPCSTR lpRootPathName,
  [in, optional] LPCSTR lpVolumeName
);

Parámetros

[in, optional] lpRootPathName

Puntero a una cadena que contiene la letra de unidad del volumen (por ejemplo, X:) o la ruta de acceso de una carpeta montada asociada al volumen (por ejemplo, Y:\MountX). La cadena debe terminar con una barra diagonal inversa final (""). Si este parámetro es NULL, se usa la raíz del directorio actual.

[in, optional] lpVolumeName

Puntero a una cadena que contiene la nueva etiqueta para el volumen. Si este parámetro es NULL, la función elimina cualquier etiqueta existente del volumen especificado y no asigna una nueva etiqueta.

Valor devuelto

Si la función se realiza correctamente, el valor devuelto es 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 longitud máxima de la etiqueta de volumen es de 32 caracteres.

Sistemas de archivos FAT: La longitud máxima de la etiqueta de volumen es de 11 caracteres.

Una etiqueta es un nombre descriptivo que un usuario asigna a un volumen para que sea más fácil de reconocer. Un volumen puede tener una etiqueta, una letra de unidad, ambas o ninguna. Para obtener más información, vea Asignar un nombre a un volumen.

En Windows 8 y Windows Server 2012, esta función es compatible con las siguientes tecnologías.

Technology Compatible
Protocolo bloque de mensajes del servidor (SMB) 3.0 No
Conmutación por error transparente (TFO) de SMB 3.0 No
SMB 3.0 con recursos compartidos de archivos de escalabilidad horizontal (SO) No
Sistema de archivos de volumen compartido de clúster (CsvFS) Yes
Sistema de archivos resistente a errores (ReFS) Yes
 

SMB no admite funciones de administración de volúmenes.

Nota

El encabezado winbase.h define SetVolumeLabel 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 neutral 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 XP [aplicaciones de escritorio | Aplicaciones para UWP]
Servidor mínimo compatible Windows Server 2003 [aplicaciones de escritorio | Aplicaciones para UWP]
Plataforma de destino Windows
Encabezado winbase.h (incluye Windows.h)
Library Kernel32.lib
Archivo DLL Kernel32.dll

Vea también

GetVolumeInformation

Funciones de administración de volúmenes