CPathT, classe
Cette classe représente un chemin d’accès.
Important
Cette classe et ses membres ne peuvent pas être utilisés dans les applications qui s’exécutent dans Windows Runtime.
Syntaxe
template <typename StringType>
class CPathT
Paramètres
StringType
Classe de chaîne ATL/MFC à utiliser pour le chemin d’accès (voir CStringT).
Membres
Typedefs publics
| Nom | Description |
|---|---|
| CPathT ::P CXSTR | Type de chaîne constante. |
| CPathT ::P XSTR | Type chaîne. |
| CPathT ::XCHAR | Type de caractère. |
Constructeurs publics
| Nom | Description |
|---|---|
| CPathT ::CPathT | Constructeur pour le chemin d’accès. |
Méthodes publiques
| Nom | Description |
|---|---|
| CPathT ::AddBackslash | Appelez cette méthode pour ajouter une barre oblique inverse à la fin d’une chaîne pour créer la syntaxe correcte pour un chemin d’accès. |
| CPathT ::AddExtension | Appelez cette méthode pour ajouter une extension de fichier à un chemin d’accès. |
| CPathT ::Append | Appelez cette méthode pour ajouter une chaîne au chemin actuel. |
| CPathT ::BuildRoot | Appelez cette méthode pour créer un chemin racine à partir d’un numéro de lecteur donné. |
| CPathT ::Canonicalize | Appelez cette méthode pour convertir le chemin d’accès en formulaire canonique. |
| CPathT ::Combine | Appelez cette méthode pour concaténer une chaîne représentant un nom de répertoire et une chaîne représentant un nom de chemin d’accès de fichier en un chemin d’accès. |
| CPathT ::CommonPrefix | Appelez cette méthode pour déterminer si le chemin spécifié partage un préfixe commun avec le chemin actuel. |
| CPathT ::CompactPath | Appelez cette méthode pour tronquer un chemin d’accès de fichier à l’intérieur d’une largeur de pixel donnée en remplaçant les composants de chemin d’accès par des points de suspension. |
| CPathT ::CompactPathEx | Appelez cette méthode pour tronquer un chemin d’accès de fichier en fonction d’un nombre donné de caractères en remplaçant les composants de chemin d’accès par des points de suspension. |
| CPathT ::FileExists | Appelez cette méthode pour vérifier si le fichier au niveau de ce nom de chemin existe. |
| CPathT ::FindExtension | Appelez cette méthode pour rechercher la position de l’extension de fichier dans le chemin d’accès. |
| CPathT ::FindFileName | Appelez cette méthode pour rechercher la position du nom de fichier dans le chemin d’accès. |
| CPathT ::GetDriveNumber | Appelez cette méthode pour rechercher le chemin d’accès d’une lettre de lecteur dans la plage de « A » à « Z » et renvoyer le numéro de lecteur correspondant. |
| CPathT ::GetExtension | Appelez cette méthode pour obtenir l’extension de fichier à partir du chemin d’accès. |
| CPathT ::IsDirectory | Appelez cette méthode pour vérifier si le chemin d’accès est un répertoire valide. |
| CPathT ::IsFileSpec | Appelez cette méthode pour rechercher un chemin d’accès pour rechercher des caractères délimitant le chemin d’accès (par exemple, : ou \). S’il n’y a pas de caractères de limitation de chemin d’accès présents, le chemin d’accès est considéré comme un chemin de spécification de fichier. |
| CPathT ::IsPrefix | Appelez cette méthode pour déterminer si un chemin contient un préfixe valide du type passé par pszPrefix. |
| CPathT ::IsRelative | Appelez cette méthode pour déterminer si le chemin d’accès est relatif. |
| CPathT ::IsRoot | Appelez cette méthode pour déterminer si le chemin d’accès est une racine de répertoire. |
| CPathT ::IsSameRoot | Appelez cette méthode pour déterminer si un autre chemin possède un composant racine commun avec le chemin actuel. |
| CPathT ::IsUNC | Appelez cette méthode pour déterminer si le chemin d’accès est un chemin UNC (convention d’affectation de noms universelle) valide pour un serveur et un partage. |
| CPathT ::IsUNCServer | Appelez cette méthode pour déterminer si le chemin d’accès est un chemin UNC valide (convention d’affectation de noms universelle) pour un serveur uniquement. |
| CPathT ::IsUNCServerShare | Appelez cette méthode pour déterminer si le chemin d’accès est un chemin d’accès de partage UNC (convention d’affectation de noms universelle) valide, \\server\share. |
| CPathT ::MakePretty | Appelez cette méthode pour convertir un chemin en caractères minuscules pour donner au chemin une apparence cohérente. |
| CPathT ::MatchSpec | Appelez cette méthode pour rechercher le chemin d’accès d’une chaîne contenant un type de correspondance générique. |
| CPathT ::QuoteSpaces | Appelez cette méthode pour placer le chemin entre guillemets s’il contient des espaces. |
| CPathT ::RelativePathTo | Appelez cette méthode pour créer un chemin relatif d’un fichier ou d’un dossier vers un autre. |
| CPathT ::RemoveArgs | Appelez cette méthode pour supprimer les arguments de ligne de commande du chemin d’accès. |
| CPathT ::RemoveBackslash | Appelez cette méthode pour supprimer la barre oblique inverse de fin du chemin. |
| CPathT ::RemoveBlanks | Appelez cette méthode pour supprimer tous les espaces de début et de fin du chemin d’accès. |
| CPathT ::RemoveExtension | Appelez cette méthode pour supprimer l’extension de fichier du chemin d’accès, s’il en existe un. |
| CPathT ::RemoveFileSpec | Appelez cette méthode pour supprimer le nom de fichier de fin et la barre oblique inverse du chemin d’accès, s’il en a. |
| CPathT ::RenameExtension | Appelez cette méthode pour remplacer l’extension de nom de fichier dans le chemin d’accès par une nouvelle extension. Si le nom de fichier ne contient pas d’extension, l’extension est attachée à la fin de la chaîne. |
| CPathT ::SkipRoot | Appelez cette méthode pour analyser un chemin d’accès, en ignorant la lettre de lecteur ou les parties de chemin d’accès du serveur/partage UNC. |
| CPathT ::StripPath | Appelez cette méthode pour supprimer la partie chemin d’accès d’un chemin complet et d’un nom de fichier. |
| CPathT ::StripToRoot | Appelez cette méthode pour supprimer toutes les parties du chemin à l’exception des informations racines. |
| CPathT ::UnquoteSpaces | Appelez cette méthode pour supprimer les guillemets du début et de la fin d’un chemin d’accès. |
Opérateurs publics
| Nom | Description |
|---|---|
| CPathT ::operator const StringType & | Cet opérateur permet à l’objet d’être traité comme une chaîne. |
| CPathT ::operator CPathT ::P CXSTR | Cet opérateur permet à l’objet d’être traité comme une chaîne. |
| CPathT ::operator StringType & | Cet opérateur permet à l’objet d’être traité comme une chaîne. |
| CPathT ::operator += | Cet opérateur ajoute une chaîne au chemin d’accès. |
Membres de données publics
| Nom | Description |
|---|---|
| CPathT ::m_strPath | Le chemin d'accès. |
Notes
CPath, CPathAet CPathW sont des instanciations définies CPathT comme suit :
typedef CPathT< CString > CPath;
typedef CPathT< CStringA > CPathA;
typedef CPathT< CStringW > CPathW;
Spécifications
En-tête : atlpath.h
CPathT ::AddBackslash
Appelez cette méthode pour ajouter une barre oblique inverse à la fin d’une chaîne pour créer la syntaxe correcte pour un chemin d’accès. Si le chemin possède déjà une barre oblique inverse de fin, aucune barre oblique inverse n’est ajoutée.
void AddBackslash();
Notes
Pour plus d’informations, consultez PathAddBackSlash.
CPathT ::AddExtension
Appelez cette méthode pour ajouter une extension de fichier à un chemin d’accès.
BOOL AddExtension(PCXSTR pszExtension);
Paramètres
pszExtension
Extension de fichier à ajouter.
Valeur de retour
Retourne TRUE en cas de réussite, FALSE en cas d’échec.
Notes
Pour plus d’informations, consultez PathAddExtension.
CPathT ::Append
Appelez cette méthode pour ajouter une chaîne au chemin actuel.
BOOL Append(PCXSTR pszMore);
Paramètres
pszMore
Chaîne à ajouter.
Valeur de retour
Retourne TRUE en cas de réussite, FALSE en cas d’échec.
Notes
Pour plus d’informations, consultez PathAppend.
CPathT ::BuildRoot
Appelez cette méthode pour créer un chemin racine à partir d’un numéro de lecteur donné.
void BuildRoot(int iDrive);
Paramètres
iDrive
Le numéro de lecteur (0 est A:, 1 est B:, et ainsi de suite).
Notes
Pour plus d’informations, consultez PathBuildRoot.
CPathT ::Canonicalize
Appelez cette méthode pour convertir le chemin d’accès en formulaire canonique.
void Canonicalize();
Notes
Pour plus d’informations, consultez PathCanonicalize.
CPathT ::Combine
Appelez cette méthode pour concaténer une chaîne représentant un nom de répertoire et une chaîne représentant un nom de chemin d’accès de fichier en un chemin d’accès.
void Combine(PCXSTR pszDir, PCXSTR pszFile);
Paramètres
pszDir
Chemin d'accès du répertoire.
pszFile
Chemin d'accès au fichier.
Notes
Pour plus d’informations, consultez PathCombine.
CPathT ::CommonPrefix
Appelez cette méthode pour déterminer si le chemin spécifié partage un préfixe commun avec le chemin actuel.
CPathT<StringType> CommonPrefix(PCXSTR pszOther);
Paramètres
pszOther
Chemin d’accès à comparer à celui actuel.
Valeur de retour
Retourne le préfixe commun.
Notes
Un préfixe est l’un des types suivants : « C :\\ », « ». », « ». ». \\". Pour plus d’informations, consultez PathCommonPrefix.
CPathT ::CompactPath
Appelez cette méthode pour tronquer un chemin d’accès de fichier à l’intérieur d’une largeur de pixel donnée en remplaçant les composants de chemin d’accès par des points de suspension.
BOOL CompactPath(HDC hDC, UINT nWidth);
Paramètres
hDC
Contexte d’appareil utilisé pour les métriques de police.
nWidth
Largeur, en pixels, dans laquelle la chaîne sera forcée de s’ajuster.
Valeur de retour
Retourne TRUE en cas de réussite, FALSE en cas d’échec.
Notes
Pour plus d’informations, consultez PathCompactPath.
CPathT ::CompactPathEx
Appelez cette méthode pour tronquer un chemin d’accès de fichier en fonction d’un nombre donné de caractères en remplaçant les composants de chemin d’accès par des points de suspension.
BOOL CompactPathEx(UINT nMaxChars, DWORD dwFlags = 0);
Paramètres
nMaxChars
Nombre maximal de caractères à contenir dans la nouvelle chaîne, y compris le caractère NULL de fin.
dwFlags
Réservé.
Valeur de retour
Retourne TRUE en cas de réussite, FALSE en cas d’échec.
Notes
Pour plus d’informations, consultez PathCompactPathEx.
CPathT ::CPathT
Constructeur .
CPathT(PCXSTR pszPath);
CPathT(const CPathT<StringType>& path);
CPathT() throw();
Paramètres
pszPath
Pointeur vers une chaîne de chemin d’accès.
path
Chaîne de chemin d’accès.
CPathT ::FileExists
Appelez cette méthode pour vérifier si le fichier au niveau de ce nom de chemin existe.
BOOL FileExists() const;
Valeur de retour
Retourne TRUE si le fichier existe, FALSE dans le cas contraire.
Notes
Pour plus d’informations, consultez PathFileExists.
CPathT ::FindExtension
Appelez cette méthode pour rechercher la position de l’extension de fichier dans le chemin d’accès.
int FindExtension() const;
Valeur de retour
Retourne la position du « ». avant l’extension. Si aucune extension n’est trouvée, retourne -1.
Notes
Pour plus d’informations, consultez PathFindExtension.
CPathT ::FindFileName
Appelez cette méthode pour rechercher la position du nom de fichier dans le chemin d’accès.
int FindFileName() const;
Valeur de retour
Retourne la position du nom du fichier. Si aucun nom de fichier n’est trouvé, retourne -1.
Notes
Pour plus d’informations, consultez PathFindFileName.
CPathT ::GetDriveNumber
Appelez cette méthode pour rechercher le chemin d’accès d’une lettre de lecteur dans la plage de « A » à « Z » et renvoyer le numéro de lecteur correspondant.
int GetDriveNumber() const;
Valeur de retour
Retourne le numéro de lecteur sous la forme d’un entier compris entre 0 et 25 (correspondant à « A » à « Z ») si le chemin d’accès a une lettre de lecteur ou -1 sinon.
Notes
Pour plus d’informations, consultez PathGetDriveNumber.
CPathT ::GetExtension
Appelez cette méthode pour obtenir l’extension de fichier à partir du chemin d’accès.
StringType GetExtension() const;
Valeur de retour
Retourne l’extension de fichier.
CPathT ::IsDirectory
Appelez cette méthode pour vérifier si le chemin d’accès est un répertoire valide.
BOOL IsDirectory() const;
Valeur de retour
Retourne une valeur différente de zéro (16) si le chemin d’accès est un répertoire, FALSE sinon.
Notes
Pour plus d’informations, consultez PathIsDirectory.
CPathT ::IsFileSpec
Appelez cette méthode pour rechercher un chemin d’accès pour rechercher des caractères délimitant le chemin d’accès (par exemple, : ou \). S’il n’y a pas de caractères de limitation de chemin d’accès présents, le chemin d’accès est considéré comme un chemin de spécification de fichier.
BOOL IsFileSpec() const;
Valeur de retour
Retourne TRUE s’il n’y a pas de caractères de limitation de chemin d’accès dans le chemin d’accès, ou FALSE s’il existe des caractères de limitation de chemin.
Notes
Pour plus d’informations, consultez PathIsFileSpec.
CPathT ::IsPrefix
Appelez cette méthode pour déterminer si un chemin contient un préfixe valide du type passé par pszPrefix.
BOOL IsPrefix(PCXSTR pszPrefix) const;
Paramètres
pszPrefix
Préfixe pour lequel effectuer une recherche. Un préfixe est l’un des types suivants : « C :\\ », « ». », « ». ». \\".
Valeur de retour
Retourne TRUE si le chemin d’accès contient le préfixe ou FALSE dans le cas contraire.
Notes
Pour plus d’informations, consultez PathIsPrefix.
CPathT ::IsRelative
Appelez cette méthode pour déterminer si le chemin d’accès est relatif.
BOOL IsRelative() const;
Valeur de retour
Retourne TRUE si le chemin d’accès est relatif ou FALSE s’il est absolu.
Notes
Pour plus d’informations, consultez PathIsRelative.
CPathT ::IsRoot
Appelez cette méthode pour déterminer si le chemin d’accès est une racine de répertoire.
BOOL IsRoot() const;
Valeur de retour
Retourne TRUE si le chemin d’accès est une racine ou FALSE dans le cas contraire.
Notes
Pour plus d’informations, consultez PathIsRoot.
CPathT ::IsSameRoot
Appelez cette méthode pour déterminer si un autre chemin possède un composant racine commun avec le chemin actuel.
BOOL IsSameRoot(PCXSTR pszOther) const;
Paramètres
pszOther
Autre chemin d’accès.
Valeur de retour
Retourne TRUE si les deux chaînes ont le même composant racine ou FALSE sinon.
Notes
Pour plus d’informations, consultez PathIsSameRoot.
CPathT ::IsUNC
Appelez cette méthode pour déterminer si le chemin d’accès est un chemin UNC (convention d’affectation de noms universelle) valide pour un serveur et un partage.
BOOL IsUNC() const;
Valeur de retour
Retourne TRUE si le chemin d’accès est un chemin UNC valide ou FALSE dans le cas contraire.
Notes
Pour plus d’informations, consultez PathIsUNC.
CPathT ::IsUNCServer
Appelez cette méthode pour déterminer si le chemin d’accès est un chemin UNC valide (convention d’affectation de noms universelle) pour un serveur uniquement.
BOOL IsUNCServer() const;
Valeur de retour
Retourne TRUE si la chaîne est un chemin UNC valide pour un serveur uniquement (aucun nom de partage) ou FALSE dans le cas contraire.
Notes
Pour plus d’informations, consultez PathIsUNCServer.
CPathT ::IsUNCServerShare
Appelez cette méthode pour déterminer si le chemin d’accès est un chemin d’accès de partage UNC (convention d’affectation de noms universelle) valide, \\ partage de serveur\ .
BOOL IsUNCServerShare() const;
Valeur de retour
Retourne TRUE si le chemin d’accès se trouve sous la forme \\ partage de serveur\ ou FALSE dans le cas contraire.
Notes
Pour plus d’informations, consultez PathIsUNCServerShare.
CPathT ::m_strPath
Le chemin d'accès.
StringType m_strPath;
Notes
StringType est le paramètre de modèle sur CPathT.
CPathT ::MakePretty
Appelez cette méthode pour convertir un chemin en caractères minuscules pour donner au chemin une apparence cohérente.
BOOL MakePretty();
Valeur de retour
Retourne TRUE si le chemin d’accès a été converti ou FALSE dans le cas contraire.
Notes
Pour plus d’informations, consultez PathMakePretty.
CPathT ::MatchSpec
Appelez cette méthode pour rechercher le chemin d’accès d’une chaîne contenant un type de correspondance générique.
BOOL MatchSpec(PCXSTR pszSpec) const;
Paramètres
pszSpec
Pointeur vers une chaîne terminée par null avec le type de fichier pour lequel effectuer une recherche. Par exemple, pour tester si le fichier au niveau du chemin d’accès actuel est un fichier DOC, pszSpec doit être défini sur « *.doc ».
Valeur de retour
Retourne TRUE si la chaîne correspond ou FALSE dans le cas contraire.
Notes
Pour plus d’informations, consultez PathMatchSpec.
CPathT ::operator +=
Cet opérateur ajoute une chaîne au chemin d’accès.
CPathT<StringType>& operator+=(PCXSTR pszMore);
Paramètres
pszMore
Chaîne à ajouter.
Valeur de retour
Retourne le chemin d’accès mis à jour.
CPathT ::operator const StringType &
Cet opérateur permet à l’objet d’être traité comme une chaîne.
operator const StringType&() const throw();
Valeur de retour
Retourne une chaîne représentant le chemin d’accès actuel géré par cet objet.
CPathT ::operator CPathT ::P CXSTR
Cet opérateur permet à l’objet d’être traité comme une chaîne.
operator PCXSTR() const throw();
Valeur de retour
Retourne une chaîne représentant le chemin d’accès actuel géré par cet objet.
CPathT ::operator StringType &
Cet opérateur permet à l’objet d’être traité comme une chaîne.
operator StringType&() throw();
Valeur de retour
Retourne une chaîne représentant le chemin d’accès actuel géré par cet objet.
CPathT ::P CXSTR
Type de chaîne constante.
typedef StringType::PCXSTR PCXSTR;
Notes
StringType est le paramètre de modèle sur CPathT.
CPathT ::P XSTR
Type chaîne.
typedef StringType::PXSTR PXSTR;
Notes
StringType est le paramètre de modèle sur CPathT.
CPathT ::QuoteSpaces
Appelez cette méthode pour placer le chemin entre guillemets s’il contient des espaces.
void QuoteSpaces();
Notes
Pour plus d’informations, consultez PathQuoteSpaces.
CPathT ::RelativePathTo
Appelez cette méthode pour créer un chemin relatif d’un fichier ou d’un dossier vers un autre.
BOOL RelativePathTo(
PCXSTR pszFrom,
DWORD dwAttrFrom,
PCXSTR pszTo,
DWORD dwAttrTo);
Paramètres
pszFrom
Début du chemin relatif.
dwAttrFrom
Attributs File de pszFrom. Si cette valeur contient FILE_ATTRIBUTE_DIRECTORY, pszFrom est supposé être un répertoire ; sinon, pszFrom est supposé être un fichier.
pszTo
Point de terminaison du chemin relatif.
dwAttrTo
Attributs File de pszTo. Si cette valeur contient FILE_ATTRIBUTE_DIRECTORY, pszTo est supposé être un répertoire ; sinon, pszTo est supposé être un fichier.
Valeur de retour
Retourne TRUE en cas de réussite, FALSE en cas d’échec.
Notes
Pour plus d’informations, consultez PathRelativePathTo.
CPathT ::RemoveArgs
Appelez cette méthode pour supprimer les arguments de ligne de commande du chemin d’accès.
void RemoveArgs();
Notes
Pour plus d’informations, consultez PathRemoveArgs.
CPathT ::RemoveBackslash
Appelez cette méthode pour supprimer la barre oblique inverse de fin du chemin.
void RemoveBackslash();
Notes
Pour plus d’informations, consultez PathRemoveBackslash.
CPathT ::RemoveBlanks
Appelez cette méthode pour supprimer tous les espaces de début et de fin du chemin d’accès.
void RemoveBlanks();
Notes
Pour plus d’informations, consultez PathRemoveBlanks.
CPathT ::RemoveExtension
Appelez cette méthode pour supprimer l’extension de fichier du chemin d’accès, s’il en existe un.
void RemoveExtension();
Notes
Pour plus d’informations, consultez PathRemoveExtension.
CPathT ::RemoveFileSpec
Appelez cette méthode pour supprimer le nom de fichier de fin et la barre oblique inverse du chemin d’accès, s’il en a.
BOOL RemoveFileSpec();
Valeur de retour
Retourne TRUE en cas de réussite, FALSE en cas d’échec.
Notes
Pour plus d’informations, consultez PathRemoveFileSpec.
CPathT ::RenameExtension
Appelez cette méthode pour remplacer l’extension de nom de fichier dans le chemin d’accès par une nouvelle extension. Si le nom de fichier ne contient pas d’extension, l’extension est attachée à la fin du chemin d’accès.
BOOL RenameExtension(PCXSTR pszExtension);
Paramètres
pszExtension
Nouvelle extension de nom de fichier, précédée d’un caractère « ».
Valeur de retour
Retourne TRUE en cas de réussite, FALSE en cas d’échec.
Notes
Pour plus d’informations, consultez PathRenameExtension.
CPathT ::SkipRoot
Appelez cette méthode pour analyser un chemin d’accès, en ignorant la lettre de lecteur ou les parties de chemin d’accès serveur/partage UNC (convention d’affectation de noms universelle).
int SkipRoot() const;
Valeur de retour
Retourne la position du début du sous-chemin qui suit la racine (lettre de lecteur ou serveur/partage UNC).
Notes
Pour plus d’informations, consultez PathSkipRoot.
CPathT ::StripPath
Appelez cette méthode pour supprimer la partie chemin d’accès d’un chemin complet et d’un nom de fichier.
void StripPath();
Notes
Pour plus d’informations, consultez PathStripPath.
CPathT ::StripToRoot
Appelez cette méthode pour supprimer toutes les parties du chemin à l’exception des informations racines.
BOOL StripToRoot();
Valeur de retour
Retourne TRUE si une lettre de lecteur valide a été trouvée dans le chemin d’accès ou FALSE dans le cas contraire.
Notes
Pour plus d’informations, consultez PathStripToRoot.
CPathT ::UnquoteSpaces
Appelez cette méthode pour supprimer les guillemets du début et de la fin d’un chemin d’accès.
void UnquoteSpaces();
Notes
Pour plus d’informations, consultez PathUnquoteSpaces.
CPathT ::XCHAR
Type de caractère.
typedef StringType::XCHAR XCHAR;
Notes
StringType est le paramètre de modèle sur CPathT.