Función GetFileTitleA (commdlg.h)

  • Artículo

Recupera el nombre del archivo especificado.

Sintaxis

short GetFileTitleA(
  [in]  LPCSTR unnamedParam1,
  [out] LPSTR  Buf,
  [in]  WORD   cchSize
);

Parámetros

[in] unnamedParam1

Tipo: LPCTSTR

Nombre y ubicación de un archivo.

[out] Buf

Tipo: LPTSTR

Búfer que recibe el nombre del archivo.

[in] cchSize

Tipo: WORD

Longitud, en caracteres, del búfer al que apunta el parámetro lpszTitle .

Valor devuelto

Tipo: short

Si la función es correcta, el valor devuelto es cero.

Si el nombre de archivo no es válido, se desconoce el valor devuelto. Si se produce un error, el valor devuelto es un número negativo.

Si el búfer al que apunta el parámetro lpszTitle es demasiado pequeño, el valor devuelto es un entero positivo que especifica el tamaño de búfer necesario, en caracteres. El tamaño de búfer necesario incluye el carácter nulo de terminación.

Comentarios

Solo se debe llamar a GetFileTitle con nombres de archivo legales; el uso de un nombre de archivo no válido tiene un resultado indefinido.

Para obtener el tamaño del búfer necesario para el nombre de un archivo, llame a la función con lpszTitle establecido en NULL y cchSize establecido en cero. La función devuelve el tamaño necesario.

GetFileTitle devuelve la cadena que el sistema usaría para mostrar el nombre de archivo al usuario. El nombre para mostrar solo incluye una extensión si es la preferencia del usuario para mostrar los nombres de archivo. Esto significa que la cadena devuelta puede no identificar con precisión el archivo si se usa en llamadas a funciones del sistema de archivos.

Si el búfer lpszTitle es demasiado pequeño, GetFileTitle devuelve el tamaño necesario para contener el nombre para mostrar. Sin embargo, no hay ninguna relación garantizada entre el tamaño necesario y los caracteres especificados originalmente en el búfer lpszFile . Por ejemplo, no llame a GetFileTitle con lpszTitle establecido en NULL y cchSize establecido en cero y, a continuación, intente usar el valor devuelto como un índice en la cadena lpszFile . Normalmente, puede lograr resultados similares (y un rendimiento superior) con funciones de biblioteca en tiempo de ejecución de C, como strrchr, wcsrchr y _mbsrchr.

Nota

El encabezado commdlg.h define GetFileTitle 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

Requisito Value
Cliente mínimo compatible Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino Windows
Encabezado commdlg.h (incluye Windows.h)
Library Comdlg32.lib
Archivo DLL Comdlg32.dll
Conjunto de API ext-ms-win-shell-comdlg32-l1-1-1 (introducido en Windows 10, versión 10.0.14393)

Consulte también

Biblioteca de cuadros de diálogo comunes

Conceptual

GetOpenFileName

GetSaveFileName

Referencia