Fonction SearchPathW (processenv.h)

Article
03/01/2024

Recherche un fichier spécifié dans un chemin d’accès spécifié.

Syntaxe

DWORD SearchPathW(
  [in, optional]  LPCWSTR lpPath,
  [in]            LPCWSTR lpFileName,
  [in, optional]  LPCWSTR lpExtension,
  [in]            DWORD   nBufferLength,
  [out]           LPWSTR  lpBuffer,
  [out, optional] LPWSTR  *lpFilePart
);

Paramètres

[in, optional] lpPath

Chemin d'accès dans lequel rechercher le fichier.

Si ce paramètre a la valeur NULL, la fonction recherche un fichier correspondant à l’aide d’un chemin de recherche système dépendant du Registre. Pour plus d'informations, consultez la section Notes.

[in] lpFileName

Nom du fichier à rechercher.

[in, optional] lpExtension

Extension à ajouter au nom du fichier lors de la recherche du fichier. Le premier caractère de l’extension de nom de fichier doit être un point (.). L’extension est ajoutée uniquement si le nom de fichier spécifié ne se termine pas par une extension.

Si une extension de nom de fichier n’est pas requise ou si le nom de fichier contient une extension, ce paramètre peut avoir la valeur NULL.

[in] nBufferLength

Taille de la mémoire tampon qui reçoit le chemin d’accès et le nom de fichier valides (y compris le caractère null de fin), dans les TCHAR.

[out] lpBuffer

Pointeur vers la mémoire tampon pour recevoir le chemin d’accès et le nom de fichier du fichier trouvé. La chaîne est une chaîne terminée par null.

[out, optional] lpFilePart

Pointeur vers la variable pour recevoir l’adresse (au sein de lpBuffer) du dernier composant du chemin d’accès et du nom de fichier valides, qui est l’adresse du caractère qui suit immédiatement la barre oblique inverse finale (\) dans le chemin.

Valeur retournée

Si la fonction réussit, la valeur retournée est la longueur, en TCHAR, de la chaîne copiée dans la mémoire tampon, sans inclure le caractère null de fin. Si la valeur de retour est supérieure à nBufferLength, la valeur retournée correspond à la taille de la mémoire tampon requise pour contenir le chemin d’accès, y compris le caractère null de fin.

Si la fonction échoue, la valeur de retour est égale à zéro. Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError.

Remarques

Si le paramètre lpPath a la valeur NULL, SearchPath recherche un fichier correspondant en fonction de la valeur actuelle de la valeur de Registre suivante :

HKEY_LOCAL_MACHINE\SYSTÈME\Currentcontrolset\Contrôle\Gestionnaire de session\SafeProcessSearchMode

Lorsque la valeur de cette REG_DWORD valeur de Registre est définie sur 1, SearchPath recherche d’abord les dossiers spécifiés dans le chemin d’accès système, puis recherche le dossier de travail actuel. Lorsque la valeur de cette valeur de Registre est définie sur 0, l’ordinateur recherche d’abord le dossier de travail actuel, puis recherche les dossiers spécifiés dans le chemin d’accès système. La valeur par défaut du système pour cette clé de Registre est 0.

Le mode de recherche utilisé par la fonction SearchPath peut également être défini par processus en appelant la fonction SetSearchPathMode .

La fonction SearchPath n’est pas recommandée comme méthode de localisation d’un fichier .dll si l’utilisation prévue de la sortie est dans un appel à la fonction LoadLibrary . Cela peut entraîner la localisation du fichier de .dll incorrect, car l’ordre de recherche de la fonction SearchPath diffère de l’ordre de recherche utilisé par la fonction LoadLibrary . Si vous devez localiser et charger un fichier .dll, utilisez la fonction LoadLibrary .

Pointe À compter de Windows 10, version 1607, pour la version unicode de cette fonction (SearchPathW), vous pouvez choisir de supprimer la limitation MAX_PATH. Pour plus d’informations, consultez la section « Limitation maximale de la longueur du chemin d’accès » de Naming Files, Paths et Namespaces .

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

Technologie	Prise en charge
Protocole Server Message Block (SMB) 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
Système de fichiers du volume partagé de cluster (CsvFS)	Oui
Système de fichiers résilient (ReFS)	Oui

Notes

L’en-tête processenv.h définit SearchPath 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 XP [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2003 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	processenv.h (inclure Windows.h)
Bibliothèque	Kernel32.lib
DLL	Kernel32.dll