GetLongPathNameA, fonction (fileapi.h)

Article
11/20/2024

Convertit le chemin spécifié en sa forme longue.

Pour effectuer cette opération en tant qu’opération transactionnelle, utilisez la fonction GetLongPathNameTransacted.

Pour plus d’informations sur les noms de fichiers et de chemins d’accès, consultez Noms de noms, chemins d’accès et noms.

Syntaxe

DWORD GetLongPathNameA(
  [in]  LPCSTR lpszShortPath,
  [out] LPSTR  lpszLongPath,
  [in]  DWORD  cchBuffer
);

Paramètres

[in] lpszShortPath

Chemin d’accès à convertir.

[out] lpszLongPath

Pointeur vers la mémoire tampon pour recevoir le chemin long.

Vous pouvez utiliser la même mémoire tampon que celle utilisée pour le paramètre lpszShortPath.

[in] cchBuffer

La taille de la mémoire tampon lpszLong Path pointe vers, dans TCHAR.

Valeur de retour

Si la fonction réussit, la valeur de retour est la longueur, dans TCHARs, de la chaîne copiée dans lpszLongPath, sans inclure le caractère null de fin.

Si le lpBuffer tampon est trop petit pour contenir le chemin d’accès, la valeur de retour est la taille, dans TCHARs, de la mémoire tampon requise pour contenir le chemin d’accès et le caractère null de fin.

Si la fonction échoue pour une autre raison, par exemple si le fichier n’existe pas, la valeur de retour est égale à zéro. Pour obtenir des informations d’erreur étendues, appelez GetLastError.

Remarques

Sur de nombreux systèmes de fichiers, un nom de fichier court contient un caractère tilde (~). Toutefois, tous les systèmes de fichiers ne suivent pas cette convention. Par conséquent, ne supposez pas que vous pouvez ignorer l’appel GetLongPathName si le chemin d’accès ne contient pas de caractère tilde (~).

Si le fichier ou le répertoire existe mais qu’un chemin d’accès long est introuvable, GetLongPathName réussit, après avoir copié la chaîne référencée par le paramètre lpszShortPath dans la mémoire tampon référencée par le paramètre lpszLongPath.

Si la valeur de retour est supérieure à la valeur spécifiée dans cchBuffer, vous pouvez appeler à nouveau la fonction avec une mémoire tampon suffisamment grande pour contenir le chemin d’accès. Pour obtenir un exemple de ce cas, consultez la section Exemple de code pour GetFullPathName.

Remarque Bien que la valeur de retour dans ce cas soit une longueur qui inclut le caractère null de fin, la valeur de retour en cas de réussite n’inclut pas le caractère null de fin dans le nombre.

Il est possible d’avoir accès à un fichier ou à un répertoire, mais pas à certains répertoires parents de ce fichier ou répertoire. Par conséquent, GetLongPathName peut échouer lorsqu’il n’est pas en mesure d’interroger le répertoire parent d’un composant de chemin d’accès pour déterminer le nom long de ce composant. Cette vérification peut être ignorée pour les composants de répertoire qui ont des extensions de fichier supérieures à 3 caractères ou des longueurs totales supérieures à 12 caractères. Pour plus d’informations, consultez la section Short et Long Names de noms de noms fichiers, chemins d’accès et espaces de noms.

Dans Windows 8 et Windows Server 2012, cette fonction est prise en charge par les technologies suivantes.

Technologie	Supporté
Protocole SMB (Server Message Block) 3.0	Oui
Basculement transparent SMB 3.0 (TFO)	Oui
SMB 3.0 avec partages de fichiers avec montée en puissance parallèle (SO)	Oui
Cluster Shared Volume File System (CsvFS)	Oui
Système de fichiers résilient (ReFS)	Oui

Exemples

Pour obtenir un exemple qui utilise GetLongPathName, consultez la section Exemple de code pour GetFullPathName.

Note

L’en-tête fileapi.h définit GetLongPathName comme 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.

Exigences

Exigence	Valeur
client minimum pris en charge	Windows XP [applications de bureau \| Applications UWP]
serveur minimum pris en charge	Windows Server 2003 [applications de bureau \| Applications UWP]
plateforme cible	Windows
d’en-tête	fileapi.h (include Windows.h)
bibliothèque	Kernel32.lib
DLL	Kernel32.dll