CPathT (clase)

Esta clase representa una ruta de acceso.

Importante

Esta clase y sus miembros no se pueden usar en las aplicaciones que se ejecutan en Windows Runtime.

Sintaxis

template <typename StringType>
class CPathT

Parámetros

StringType
La clase de cadena ATL/MFC que se va a usar para la ruta de acceso (consulte CStringT).

Miembros

Definiciones de tipos públicas

Nombre	Descripción
CPathT::PCXSTR	Tipo de cadena constante.
CPathT::PXSTR	Tipo string.
CPathT::XCHAR	Tipo de carácter.

Constructores públicos

Nombre	Descripción
CPathT::CPathT	Constructor de la ruta de acceso.

Métodos públicos

Nombre	Descripción
CPathT::AddBackslash	Llame a este método para agregar una barra diagonal inversa al final de una cadena para crear la sintaxis correcta para una ruta de acceso.
CPathT::AddExtension	Llame a este método para agregar una extensión de archivo a una ruta de acceso.
CPathT::Append	Llame a este método para anexar una cadena a la ruta de acceso actual.
CPathT::BuildRoot	Llame a este método para crear una ruta de acceso raíz a partir de un número de unidad determinado.
CPathT::Canonicalize	Llame a este método para convertir la ruta de acceso al formato canónico.
CPathT::Combine	Llame a este método para concatenar una cadena que representa un nombre de directorio y una cadena que representa un nombre de ruta de acceso de archivo en una ruta de acceso.
CPathT::CommonPrefix	Llame a este método para determinar si la ruta de acceso especificada comparte un prefijo común con la ruta de acceso actual.
CPathT::CompactPath	Llame a este método para truncar una ruta de acceso de archivo a fin de que se ajuste a un ancho de píxel determinado reemplazando los componentes de ruta de acceso por puntos suspensivos.
CPathT::CompactPathEx	Llame a este método para truncar una ruta de acceso de archivo a fin de que se ajuste a un número determinado de caracteres reemplazando los componentes de la ruta de acceso por puntos suspensivos.
CPathT::FileExists	Llame a este método para comprobar si existe el archivo en este nombre de ruta de acceso.
CPathT::FindExtension	Llame a este método para buscar la posición de la extensión de archivo dentro de la ruta de acceso.
CPathT::FindFileName	Llame a este método para buscar la posición del nombre de archivo dentro de la ruta de acceso.
CPathT::GetDriveNumber	Llame a este método para buscar la ruta de acceso de una letra de unidad dentro del intervalo de "A" a "Z" y devolver el número de unidad correspondiente.
CPathT::GetExtension	Llame a este método para obtener la extensión de archivo de la ruta de acceso.
CPathT::IsDirectory	Llame a este método para comprobar si la ruta de acceso es un directorio válido.
CPathT::IsFileSpec	Llame a este método para buscar una ruta de acceso para cualquier carácter delimitador de ruta de acceso (por ejemplo, : o \). Si no hay caracteres delimitadores de ruta de acceso presentes, la ruta de acceso se considera una ruta de acceso de especificación de archivo.
CPathT::IsPrefix	Llame a este método para determinar si una ruta de acceso contiene un prefijo válido del tipo pasado por pszPrefix.
CPathT::IsRelative	Llame a este método para determinar si la ruta de acceso es relativa.
CPathT::IsRoot	Llame a este método para determinar si la ruta de acceso es una raíz de directorio.
CPathT::IsSameRoot	Llame a este método para determinar si otra ruta de acceso tiene un componente raíz común con la ruta de acceso actual.
CPathT::IsUNC	Llame a este método para determinar si la ruta de acceso es una ruta de acceso UNC (convención de nomenclatura universal) válida para un servidor y un recurso compartido.
CPathT::IsUNCServer	Llame a este método para determinar si la ruta de acceso es una ruta de acceso UNC (convención de nomenclatura universal) válida solo para un servidor.
CPathT::IsUNCServerShare	Llame a este método para determinar si la ruta de acceso es una ruta de acceso de recurso compartido UNC (convención de nomenclatura universal) válida, \\server\share.
CPathT::MakePretty	Llame a este método para convertir una ruta de acceso a todos los caracteres en minúscula para dar a la ruta de acceso una apariencia coherente.
CPathT::MatchSpec	Llame a este método para buscar la ruta de acceso de una cadena que contenga un tipo de coincidencia de carácter comodín.
CPathT::QuoteSpaces	Llame a este método para incluir la ruta de acceso entre comillas si contiene espacios.
CPathT::RelativePathTo	Llame a este método para crear una ruta de acceso relativa de un archivo o carpeta a otro.
CPathT::RemoveArgs	Llame a este método para quitar los argumentos de la línea de comandos de la ruta de acceso.
CPathT::RemoveBackslash	Llame a este método para quitar la barra diagonal inversa final de la ruta de acceso.
CPathT::RemoveBlanks	Llame a este método para quitar todos los espacios iniciales y finales de la ruta de acceso.
CPathT::RemoveExtension	Llame a este método para quitar la extensión de archivo de la ruta de acceso, si hay una.
CPathT::RemoveFileSpec	Llame a este método para quitar el nombre de archivo final y la barra diagonal inversa de la ruta de acceso, si los tiene.
CPathT::RenameExtension	Llame a este método para reemplazar la extensión de nombre de archivo en la ruta de acceso por una nueva extensión. Si el nombre de archivo no contiene una extensión, la extensión se asociará al final de la cadena.
CPathT::SkipRoot	Llame a este método para analizar una ruta de acceso y omitir la letra de unidad o las partes de la ruta de acceso de servidor o recurso compartido de UNC.
CPathT::StripPath	Llame a este método para quitar la parte de la ruta de acceso de una ruta de acceso completa y el nombre de archivo.
CPathT::StripToRoot	Llame a este método para quitar todas las partes de la ruta de acceso, excepto la información raíz.
CPathT::UnquoteSpaces	Llame a este método para quitar las comillas del principio y el final de una ruta de acceso.

Operadores públicos

Nombre	Descripción
CPathT::operator const StringType &	Este operador permite que el objeto se trate como una cadena.
CPathT::operator CPathT::PCXSTR	Este operador permite que el objeto se trate como una cadena.
CPathT::operator StringType &	Este operador permite que el objeto se trate como una cadena.
CPathT::operator +=	Este operador anexa una cadena a la ruta de acceso.

Miembros de datos públicos

Nombre	Descripción
CPathT::m_strPath	La ruta de acceso.

Comentarios

CPath, CPathA y CPathW son instancias de CPathT definidas de la siguiente manera:

typedef CPathT< CString > CPath;

typedef CPathT< CStringA > CPathA;

typedef CPathT< CStringW > CPathW;

Requisitos

Encabezado: atlpath.h

CPathT::AddBackslash

Llame a este método para agregar una barra diagonal inversa al final de una cadena para crear la sintaxis correcta para una ruta de acceso. Si la ruta de acceso ya tiene una barra diagonal inversa final, no se agregará ninguna.

void AddBackslash();

Comentarios

Para más información, consulte PathAddBackSlash.

CPathT::AddExtension

Llame a este método para agregar una extensión de archivo a una ruta de acceso.

BOOL AddExtension(PCXSTR pszExtension);

Parámetros

pszExtension
Extensión de archivo que se va a agregar.

Valor devuelto

Devuelve TRUE si la operación se realiza correctamente; de lo contrario, devuelve FALSE.

Comentarios

Para más información, consulte PathAddExtension.

CPathT::Append

Llame a este método para anexar una cadena a la ruta de acceso actual.

BOOL Append(PCXSTR pszMore);

Parámetros

pszMore
Cadena que se va a anexar.

Valor devuelto

Devuelve TRUE si la operación se realiza correctamente; de lo contrario, devuelve FALSE.

Comentarios

Para más información, consulte PathAppend.

CPathT::BuildRoot

Llame a este método para crear una ruta de acceso raíz a partir de un número de unidad determinado.

void BuildRoot(int iDrive);

Parámetros

iDrive
El número de unidad (0 es A:, 1 es B:, etc.).

Comentarios

Para más información, consulte PathBuildRoot.

CPathT::Canonicalize

Llame a este método para convertir la ruta de acceso al formato canónico.

void Canonicalize();

Comentarios

Para más información, consulte PathCanonicalize.

CPathT::Combine

Llame a este método para concatenar una cadena que representa un nombre de directorio y una cadena que representa un nombre de ruta de acceso de archivo en una ruta de acceso.

void Combine(PCXSTR pszDir, PCXSTR  pszFile);

Parámetros

pszDir
Ruta de acceso al directorio.

pszFile
Ruta de acceso al archivo.

Comentarios

Para más información, consulte PathCombine.

CPathT::CommonPrefix

Llame a este método para determinar si la ruta de acceso especificada comparte un prefijo común con la ruta de acceso actual.

CPathT<StringType> CommonPrefix(PCXSTR pszOther);

Parámetros

pszOther
La ruta de acceso que se va a comparar con la actual.

Valor devuelto

Devuelve el prefijo común.

Comentarios

Un prefijo es uno de estos tipos: "C:\\", ".", "..", ".. \\". Para más información, consulte PathCommonPrefix.

CPathT::CompactPath

Llame a este método para truncar una ruta de acceso de archivo a fin de que se ajuste a un ancho de píxel determinado reemplazando los componentes de ruta de acceso por puntos suspensivos.

BOOL CompactPath(HDC hDC, UINT nWidth);

Parámetros

hDC
Contexto de dispositivo que se usa para las métricas de fuente.

nWidth
Ancho, en píxeles, al que se forzará el ajuste de la cadena.

Valor devuelto

Devuelve TRUE si la operación se realiza correctamente; de lo contrario, devuelve FALSE.

Comentarios

Para más información, consulte PathCompactPath.

CPathT::CompactPathEx

Llame a este método para truncar una ruta de acceso de archivo a fin de que se ajuste a un número determinado de caracteres reemplazando los componentes de la ruta de acceso por puntos suspensivos.

BOOL CompactPathEx(UINT nMaxChars, DWORD dwFlags = 0);

Parámetros

nMaxChars
Número máximo de caracteres que contendrá la nueva cadena, incluido el carácter NULL de terminación.

dwFlags
Reservado.

Valor devuelto

Devuelve TRUE si la operación se realiza correctamente; de lo contrario, devuelve FALSE.

Comentarios

Para más información, consulte PathCompactPathEx.

CPathT::CPathT

Constructor .

CPathT(PCXSTR pszPath);
CPathT(const CPathT<StringType>& path);
CPathT() throw();

Parámetros

pszPath
Puntero a una cadena de ruta de acceso.

path
Cadena de ruta de acceso.

CPathT::FileExists

Llame a este método para comprobar si existe el archivo en este nombre de ruta de acceso.

BOOL FileExists() const;

Valor devuelto

Devuelve TRUE si el archivo existe; en caso contrario, FALSE.

Comentarios

Para más información, consulte PathFileExists.

CPathT::FindExtension

Llame a este método para buscar la posición de la extensión de archivo dentro de la ruta de acceso.

int FindExtension() const;

Valor devuelto

Devuelve la posición del "." que precede la extensión. Si no se encuentra ninguna extensión, devuelve -1.

Comentarios

Para más información, consulte PathFindExtension.

CPathT::FindFileName

Llame a este método para buscar la posición del nombre de archivo dentro de la ruta de acceso.

int FindFileName() const;

Valor devuelto

Devuelve la posición del nombre de archivo. Si no se encuentra ningún nombre de archivo, devuelve -1.

Comentarios

Para más información, consulte PathFindFileName.

CPathT::GetDriveNumber

Llame a este método para buscar la ruta de acceso de una letra de unidad dentro del intervalo de "A" a "Z" y devolver el número de unidad correspondiente.

int GetDriveNumber() const;

Valor devuelto

Devuelve el número de unidad como un entero comprendido entre 0 y 25 (que corresponde al intervalo de la "A" a la "Z") si la ruta de acceso tiene una letra de unidad; de lo contrario, -1.

Comentarios

Para más información, consulte PathGetDriveNumber.

CPathT::GetExtension

Llame a este método para obtener la extensión de archivo de la ruta de acceso.

StringType GetExtension() const;

Valor devuelto

Devuelve la extensión de archivo.

CPathT::IsDirectory

Llame a este método para comprobar si la ruta de acceso es un directorio válido.

BOOL IsDirectory() const;

Valor devuelto

Devuelve un valor distinto de cero (16) si la ruta de acceso es un directorio; de lo contrario, devuelve FALSE.

Comentarios

Para más información, consulte PathIsDirectory.

CPathT::IsFileSpec

Llame a este método para buscar una ruta de acceso para cualquier carácter delimitador de ruta de acceso (por ejemplo, : o \). Si no hay caracteres delimitadores de ruta de acceso presentes, la ruta de acceso se considera una ruta de acceso de especificación de archivo.

BOOL IsFileSpec() const;

Valor devuelto

Devuelve TRUE si no hay caracteres delimitadores de ruta de acceso dentro de la ruta de acceso o FALSE si los hay.

Comentarios

Para más información, consulte PathIsFileSpec.

CPathT::IsPrefix

Llame a este método para determinar si una ruta de acceso contiene un prefijo válido del tipo pasado por pszPrefix.

BOOL IsPrefix(PCXSTR pszPrefix) const;

Parámetros

pszPrefix
Prefijo por el que se va a buscar. Un prefijo es uno de estos tipos: "C:\\", ".", "..", ".. \\".

Valor devuelto

Devuelve TRUE si la ruta de acceso contiene el prefijo o FALSE en caso contrario.

Comentarios

Para más información, consulte PathIsPrefix.

CPathT::IsRelative

Llame a este método para determinar si la ruta de acceso es relativa.

BOOL IsRelative() const;

Valor devuelto

Devuelve TRUE si la ruta de acceso es absoluta y FALSE si es absoluta.

Comentarios

Para más información, consulte PathIsRelative.

CPathT::IsRoot

Llame a este método para determinar si la ruta de acceso es una raíz de directorio.

BOOL IsRoot() const;

Valor devuelto

Devuelve TRUE si la ruta de acceso es una raíz o FALSE en caso contrario.

Comentarios

Para más información, consulte PathIsRoot.

CPathT::IsSameRoot

Llame a este método para determinar si otra ruta de acceso tiene un componente raíz común con la ruta de acceso actual.

BOOL IsSameRoot(PCXSTR pszOther) const;

Parámetros

pszOther
La otra ruta de acceso.

Valor devuelto

Devuelve TRUE si ambas cadenas tienen el mismo componente raíz o FALSE en caso contrario.

Comentarios

Para más información, consulte PathIsSameRoot.

CPathT::IsUNC

Llame a este método para determinar si la ruta de acceso es una ruta de acceso UNC (convención de nomenclatura universal) válida para un servidor y un recurso compartido.

BOOL IsUNC() const;

Valor devuelto

Devuelve TRUE si la ruta de acceso es una ruta de acceso UNC válida o FALSE en caso contrario.

Comentarios

Para más información, consulte PathIsUNC.

CPathT::IsUNCServer

Llame a este método para determinar si la ruta de acceso es una ruta de acceso UNC (convención de nomenclatura universal) válida solo para un servidor.

BOOL IsUNCServer() const;

Valor devuelto

Devuelve TRUE si la cadena es una ruta de acceso UNC válida solo para un servidor (sin nombre de recurso compartido) o FALSE en caso contrario.

Comentarios

Para más información, consulte PathIsUNCServer.

CPathT::IsUNCServerShare

Llame a este método para determinar si la ruta de acceso es una ruta de acceso de recurso compartido UNC (convención de nomenclatura universal) válida, \\ servidor\ recurso compartido.

BOOL IsUNCServerShare() const;

Valor devuelto

Devuelve TRUE si la ruta de acceso tiene el formato \\ servidor\ recurso compartido o FALSE en caso contrario.

Comentarios

Para más información, consulte PathIsUNCServerShare.

CPathT::m_strPath

La ruta de acceso.

StringType m_strPath;

Comentarios

StringType es el parámetro de plantilla para CPathT.

CPathT::MakePretty

Llame a este método para convertir una ruta de acceso a todos los caracteres en minúscula para dar a la ruta de acceso una apariencia coherente.

BOOL MakePretty();

Valor devuelto

Devuelve TRUE si la ruta de acceso se ha convertido o FALSE en caso contrario.

Comentarios

Para más información, consulte PathMakePretty.

CPathT::MatchSpec

Llame a este método para buscar la ruta de acceso de una cadena que contenga un tipo de coincidencia de carácter comodín.

BOOL MatchSpec(PCXSTR pszSpec) const;

Parámetros

pszSpec
Puntero a una cadena terminada en NULL con el tipo de archivo por el que se busca. Por ejemplo, para probar si el archivo en la ruta de acceso actual es un archivo DOC, pszSpec debe establecerse en "*.doc".

Valor devuelto

Devuelve TRUE si la cadena coincide o FALSE en caso contrario.

Comentarios

Para más información, consulte PathMatchSpec.

CPathT::operator +=

Este operador anexa una cadena a la ruta de acceso.

CPathT<StringType>& operator+=(PCXSTR pszMore);

Parámetros

pszMore
Cadena que se va a anexar.

Valor devuelto

Devuelve la ruta de acceso actualizada.

CPathT::operator const StringType &

Este operador permite que el objeto se trate como una cadena.

operator const StringType&() const throw();

Valor devuelto

Devuelve una cadena que representa la ruta de acceso actual administrada por este objeto.

CPathT::operator CPathT::PCXSTR

Este operador permite que el objeto se trate como una cadena.

operator PCXSTR() const throw();

Valor devuelto

Devuelve una cadena que representa la ruta de acceso actual administrada por este objeto.

CPathT::operator StringType &

Este operador permite que el objeto se trate como una cadena.

operator StringType&() throw();

Valor devuelto

Devuelve una cadena que representa la ruta de acceso actual administrada por este objeto.

CPathT::PCXSTR

Tipo de cadena constante.

typedef StringType::PCXSTR PCXSTR;

Comentarios

StringType es el parámetro de plantilla para CPathT.

CPathT::PXSTR

Tipo string.

typedef StringType::PXSTR PXSTR;

Comentarios

StringType es el parámetro de plantilla para CPathT.

CPathT::QuoteSpaces

Llame a este método para incluir la ruta de acceso entre comillas si contiene espacios.

void QuoteSpaces();

Comentarios

Para más información, consulte PathQuoteSpaces.

CPathT::RelativePathTo

Llame a este método para crear una ruta de acceso relativa de un archivo o carpeta a otro.

BOOL RelativePathTo(
    PCXSTR pszFrom,
    DWORD dwAttrFrom,
    PCXSTR pszTo,
    DWORD dwAttrTo);

Parámetros

pszFrom
Inicio de la ruta de acceso relativa.

dwAttrFrom
Atributos File de pszFrom. Si este valor contiene FILE_ATTRIBUTE_DIRECTORY, se supone que pszFrom es un directorio; de lo contrario, se supone que pszFrom es un archivo.

pszTo
Punto final de la ruta de acceso relativa.

dwAttrTo
Atributos File de pszTo. Si este valor contiene FILE_ATTRIBUTE_DIRECTORY, se supone que pszTo es un directorio; de lo contrario, se supone que pszTo es un archivo.

Valor devuelto

Devuelve TRUE si la operación se realiza correctamente; de lo contrario, devuelve FALSE.

Comentarios

Para más información, consulte PathRelativePathTo.

CPathT::RemoveArgs

Llame a este método para quitar los argumentos de la línea de comandos de la ruta de acceso.

void RemoveArgs();

Comentarios

Para más información, consulte PathRemoveArgs.

CPathT::RemoveBackslash

Llame a este método para quitar la barra diagonal inversa final de la ruta de acceso.

void RemoveBackslash();

Comentarios

Para más información, consulte PathRemoveBackslash.

CPathT::RemoveBlanks

Llame a este método para quitar todos los espacios iniciales y finales de la ruta de acceso.

void RemoveBlanks();

Comentarios

Para más información, consulte PathRemoveBlanks.

CPathT::RemoveExtension

Llame a este método para quitar la extensión de archivo de la ruta de acceso, si hay una.

void RemoveExtension();

Comentarios

Para más información, consulte PathRemoveExtension.

CPathT::RemoveFileSpec

Llame a este método para quitar el nombre de archivo final y la barra diagonal inversa de la ruta de acceso, si los tiene.

BOOL RemoveFileSpec();

Valor devuelto

Devuelve TRUE si la operación se realiza correctamente; de lo contrario, devuelve FALSE.

Comentarios

Para más información, consulte PathRemoveFileSpec.

CPathT::RenameExtension

Llame a este método para reemplazar la extensión de nombre de archivo en la ruta de acceso por una nueva extensión. Si el nombre de archivo no contiene una extensión, la extensión se asociará al final de la ruta de acceso.

BOOL RenameExtension(PCXSTR pszExtension);

Parámetros

pszExtension
La nueva extensión de nombre de archivo, precedida de un carácter ".".

Valor devuelto

Devuelve TRUE si la operación se realiza correctamente; de lo contrario, devuelve FALSE.

Comentarios

Para más información, consulte PathRenameExtension.

CPathT::SkipRoot

Llame a este método para analizar una ruta de acceso y omitir la letra de unidad o las partes de la ruta de acceso de recurso compartido o servidor UNC (convención de nomenclatura universal).

int SkipRoot() const;

Valor devuelto

Devuelve la posición del principio de la subruta que sigue a la raíz (letra de unidad o servidor o recurso compartido UNC).

Comentarios

Para más información, consulte PathSkipRoot.

CPathT::StripPath

Llame a este método para quitar la parte de la ruta de acceso de una ruta de acceso completa y el nombre de archivo.

void StripPath();

Comentarios

Para más información, consulte PathStripPath.

CPathT::StripToRoot

Llame a este método para quitar todas las partes de la ruta de acceso, excepto la información raíz.

BOOL StripToRoot();

Valor devuelto

Devuelve TRUE si se encontró una letra de unidad válida en la ruta de acceso o FALSE en caso contrario.

Comentarios

Para más información, consulte PathStripToRoot.

CPathT::UnquoteSpaces

Llame a este método para quitar las comillas del principio y el final de una ruta de acceso.

void UnquoteSpaces();

Comentarios

Para más información, consulte PathUnquoteSpaces.

CPathT::XCHAR

Tipo de carácter.

typedef StringType::XCHAR XCHAR;

Comentarios

StringType es el parámetro de plantilla para CPathT.

Consulte también

Clases
CStringT (clase)