GetFileTitleA, fonction (commdlg.h)

  • Article

Récupère le nom du fichier spécifié.

Syntaxe

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

Paramètres

[in] unnamedParam1

Type : LPCTSTR

Nom et emplacement d’un fichier.

[out] Buf

Type : LPTSTR

Mémoire tampon qui reçoit le nom du fichier.

[in] cchSize

Type : WORD

Longueur, en caractères, de la mémoire tampon pointée vers le paramètre lpszTitle .

Valeur retournée

Type : court

Si la fonction aboutit, la valeur de retour est égale à zéro.

Si le nom de fichier n’est pas valide, la valeur de retour est inconnue. En cas d’erreur, la valeur de retour est un nombre négatif.

Si la mémoire tampon pointée par le paramètre lpszTitle est trop petite, la valeur de retour est un entier positif qui spécifie la taille de mémoire tampon requise, en caractères. La taille de mémoire tampon requise inclut le caractère null de fin.

Remarques

GetFileTitle doit être appelé uniquement avec des noms de fichiers légaux ; l’utilisation d’un nom de fichier non défini a un résultat non défini.

Pour obtenir la taille de mémoire tampon nécessaire pour le nom d’un fichier, appelez la fonction avec lpszTitle défini sur NULL et cchSize défini sur zéro. La fonction retourne la taille requise.

GetFileTitle retourne la chaîne que le système utiliserait pour afficher le nom de fichier à l’utilisateur. Le nom d’affichage inclut une extension uniquement si c’est la préférence de l’utilisateur pour l’affichage des noms de fichiers. Cela signifie que la chaîne retournée peut ne pas identifier avec précision le fichier s’il est utilisé dans les appels aux fonctions de système de fichiers.

Si la mémoire tampon lpszTitle est trop petite, GetFileTitle retourne la taille requise pour contenir le nom d’affichage. Toutefois, il n’existe aucune relation garantie entre la taille requise et les caractères initialement spécifiés dans la mémoire tampon lpszFile . Par exemple, n’appelez pas GetFileTitle avec lpszTitle défini sur NULL et cchSize défini sur zéro, puis essayez d’utiliser la valeur de retour en tant qu’index dans la chaîne lpszFile . Vous pouvez généralement obtenir des résultats similaires (et des performances supérieures) avec des fonctions de bibliothèque d’exécution C telles que strrchr, wcsrchr et _mbsrchr.

Notes

L’en-tête commdlg.h définit GetFileTitle comme un alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge Windows 2000 Server [applications de bureau uniquement]
Plateforme cible Windows
En-tête commdlg.h (inclure Windows.h)
Bibliothèque Comdlg32.lib
DLL Comdlg32.dll
Ensemble d’API ext-ms-win-shell-comdlg32-l1-1-1 (introduit dans Windows 10, version 10.0.14393)

Voir aussi

Bibliothèque de boîtes de dialogue commune

Conceptuel

GetOpenFileName

GetSaveFileName

Référence