Compartilhar via


Classe CPathT

Essa classe representa um caminho.

Importante

Essa classe e os respectivos membros não podem ser usados em aplicativos executados no Windows Runtime.

Sintaxe

template <typename StringType>
class CPathT

Parâmetros

Tipo de cadeia de caracteres
A classe de cadeia de caracteres ATL/MFC a ser usada para o caminho (consulte CStringT).

Membros

Typedefs públicos

Nome Descrição
CPathT::PCXSTR Um tipo de cadeia de caracteres constante.
CPathT::PXSTR Um tipo de cadeia de caracteres.
CPathT::XCHAR Um tipo de caractere.

Construtores públicos

Nome Descrição
CPathT::CPathT O construtor do caminho.

Métodos públicos

Nome Descrição
CPathT::AddBackslash Chame esse método para adicionar uma barra invertida ao final de uma cadeia de caracteres para criar a sintaxe correta para um caminho.
CPathT::AddExtension Chame esse método para adicionar uma extensão de arquivo a um caminho.
CPathT::Append Chame esse método para acrescentar uma cadeia de caracteres ao caminho atual.
CPathT::BuildRoot Chame esse método para criar um caminho raiz de um determinado número de unidade.
CPathT::Canonicalize Chame esse método para converter o caminho em forma canônica.
CPathT::Combine Chame esse método para concatenar uma cadeia de caracteres representando um nome de diretório e uma cadeia de caracteres representando um nome de caminho de arquivo em um caminho.
CPathT::CommonPrefix Chame esse método para determinar se o caminho especificado compartilha um prefixo comum com o caminho atual.
CPathT::CompactPath Chame esse método para truncar um caminho de arquivo para ajustar em uma determinada largura de pixel substituindo os componentes do caminho por reticências.
CPathT::CompactPathEx Chame esse método para truncar um caminho de arquivo para ajustar em um determinado número de caracteres, substituindo os componentes do caminho por reticências.
CPathT::FileExists Chame esse método para verificar se o arquivo neste nome de caminho existe.
CPathT::FindExtension Chame esse método para localizar a posição da extensão de arquivo dentro do caminho.
CPathT::FindFileName Chame esse método para localizar a posição do nome do arquivo no caminho.
CPathT::GetDriveNumber Chame esse método para pesquisar o caminho de uma letra de unidade dentro do intervalo de 'A' a 'Z' e retornar o número da unidade correspondente.
CPathT::GetExtension Chame esse método para obter a extensão do arquivo do caminho.
CPathT::IsDirectory Chame esse método para verificar se o caminho é um diretório válido.
CPathT::IsFileSpec Chame esse método para pesquisar um caminho para caracteres de delimitação de caminho (por exemplo, : ou \). Se não houver caracteres de delimitação de caminho presentes, o caminho será considerado um caminho de especificação de arquivo.
CPathT::IsPrefix Chame esse método para determinar se um caminho contém um prefixo válido do tipo passado por pszPrefix.
CPathT::IsRelative Chame esse método para determinar se o caminho é relativo.
CPathT::IsRoot Chame esse método para determinar se o caminho é uma raiz de diretório.
CPathT::IsSameRoot Chame esse método para determinar se outro caminho tem um componente raiz comum com o caminho atual.
CPathT::IsUNC Chame esse método para determinar se o caminho é um caminho UNC (convenção de nomenclatura universal) válido para um servidor e compartilhamento.
CPathT::IsUNCServer Chame esse método para determinar se o caminho é um caminho UNC (convenção de nomenclatura universal) válido apenas para um servidor.
CPathT::IsUNCServerShare Chame esse método para determinar se o caminho é um caminho de compartilhamento UNC (convenção de nomenclatura universal) válido, \\server\share.
CPathT::MakePretty Chame esse método para converter um caminho em todos os caracteres minúsculos para dar ao caminho uma aparência consistente.
CPathT::MatchSpec Chame esse método para pesquisar o caminho de uma cadeia de caracteres contendo um tipo de correspondência curinga.
CPathT::QuoteSpaces Chame esse método para colocar o caminho entre aspas, se contiver espaços.
CPathT::RelativePathTo Chame esse método para criar um caminho relativo de um arquivo ou pasta para outro.
CPathT::RemoveArgs Chame esse método para remover os argumentos da linha de comando do caminho.
CPathT::RemoveBackslash Chame esse método para remover a barra invertida à direita do caminho.
CPathT::RemoveBlanks Chame esse método para remover todos os espaços à esquerda e à direita do caminho.
CPathT::RemoveExtension Chame esse método para remover a extensão do arquivo do caminho, se houver.
CPathT::RemoveFileSpec Chame esse método para remover o nome do arquivo à direita e a barra invertida do caminho, se houver.
CPathT::RenameExtension Chame esse método para substituir a extensão do nome do arquivo no caminho por uma nova extensão. Se o nome do arquivo não contiver uma extensão, a extensão será anexada ao final da cadeia de caracteres.
CPathT::SkipRoot Chame esse método para analisar um caminho, ignorando a letra da unidade ou as partes do caminho do compartilhamento/servidor UNC.
CPathT::StripPath Chame esse método para remover a parte do caminho de um caminho e nome de arquivo totalmente qualificado.
CPathT::StripToRoot Chame esse método para remover todas as partes do caminho, exceto as informações de raiz.
CPathT::UnquoteSpaces Chame esse método para remover as aspas do início e do fim de um caminho.

Operadores públicos

Nome Descrição
CPathT::operator const StringType & Esse operador permite que o objeto seja tratado como uma cadeia de caracteres.
CPathT::operator CPathT::PCXSTR Esse operador permite que o objeto seja tratado como uma cadeia de caracteres.
CPathT::operator StringType & Esse operador permite que o objeto seja tratado como uma cadeia de caracteres.
CPathT::operator += Esse operador acrescenta uma cadeia de caracteres ao caminho.

Membros de Dados Públicos

Nome Descrição
CPathT::m_strPath O caminho.

Comentários

CPath, CPathA e CPathW são instanciações deCPathT definidas da seguinte forma:

typedef CPathT< CString > CPath;

typedef CPathT< CStringA > CPathA;

typedef CPathT< CStringW > CPathW;

Requisitos

Cabeçalho: atlpath.h

CPathT::AddBackslash

Chame esse método para adicionar uma barra invertida ao final de uma cadeia de caracteres para criar a sintaxe correta para um caminho. Se o caminho já tiver uma barra invertida à direita, nenhuma barra invertida será adicionada.

void AddBackslash();

Comentários

Para obter mais informações, consulte PathAddBackSlash.

CPathT::AddExtension

Chame esse método para adicionar uma extensão de arquivo a um caminho.

BOOL AddExtension(PCXSTR pszExtension);

Parâmetros

pszExtension
A extensão de arquivo a ser adicionada.

Valor de retorno

Retorna TRUE em caso de êxito. FALSE, em caso de falha.

Comentários

Para obter mais informações, consulte PathAddExtension.

CPathT::Append

Chame esse método para acrescentar uma cadeia de caracteres ao caminho atual.

BOOL Append(PCXSTR pszMore);

Parâmetros

pszMore
A cadeia de caracteres a ser acrescentada.

Valor de retorno

Retorna TRUE em caso de êxito. FALSE, em caso de falha.

Comentários

Para obter mais informações, consulte PathAppend.

CPathT::BuildRoot

Chame esse método para criar um caminho raiz de um determinado número de unidade.

void BuildRoot(int iDrive);

Parâmetros

iDrive
O número da unidade (0 é A:, 1 é B:, e assim por diante).

Comentários

Para obter mais informações, consulte PathBuildRoot.

CPathT::Canonicalize

Chame esse método para converter o caminho em forma canônica.

void Canonicalize();

Comentários

Para obter mais informações, consulte PathCanonicalize.

CPathT::Combine

Chame esse método para concatenar uma cadeia de caracteres representando um nome de diretório e uma cadeia de caracteres representando um nome de caminho de arquivo em um caminho.

void Combine(PCXSTR pszDir, PCXSTR  pszFile);

Parâmetros

pszDir
O caminho do diretório.

pszFile
O caminho do arquivo.

Comentários

Para obter mais informações, consulte PathCombine.

CPathT::CommonPrefix

Chame esse método para determinar se o caminho especificado compartilha um prefixo comum com o caminho atual.

CPathT<StringType> CommonPrefix(PCXSTR pszOther);

Parâmetros

pszOther
O caminho para comparar com o atual.

Valor de retorno

Retorna o prefixo comum.

Comentários

Um prefixo é um destes tipos: "C:\\", ".", "..", "..\\". Para obter mais informações, consulte PathCommonPrefix.

CPathT::CompactPath

Chame esse método para truncar um caminho de arquivo para ajustar em uma determinada largura de pixel substituindo os componentes do caminho por reticências.

BOOL CompactPath(HDC hDC, UINT nWidth);

Parâmetros

hDC
O contexto do dispositivo usado para métricas de fonte.

nWidth
A largura, em pixels, na qual a cadeia de caracteres será forçada a ajustar.

Valor de retorno

Retorna TRUE em caso de êxito. FALSE, em caso de falha.

Comentários

Para obter mais informações, consulte PathCompactPath.

CPathT::CompactPathEx

Chame esse método para truncar um caminho de arquivo para ajustar em um determinado número de caracteres, substituindo os componentes do caminho por reticências.

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

Parâmetros

nMaxChars
O número máximo de caracteres contidos na nova cadeia de caracteres, incluindo o caractere nulo de término.

dwFlags
Reservado.

Valor de retorno

Retorna TRUE em caso de êxito. FALSE, em caso de falha.

Comentários

Para obter mais informações, consulte PathCompactPathEx.

CPathT::CPathT

O construtor .

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

Parâmetros

pszPath
O ponteiro para uma cadeia de caracteres de caminho.

caminho
Cadeia de caracteres de caminho.

CPathT::FileExists

Chame esse método para verificar se o arquivo neste nome de caminho existe.

BOOL FileExists() const;

Valor de retorno

Retornará TRUE se o arquivo existir, caso contrário, retornará FALSE.

Comentários

Para obter mais informações, consulte PathFileExists.

CPathT::FindExtension

Chame esse método para localizar a posição da extensão de arquivo dentro do caminho.

int FindExtension() const;

Valor de retorno

Retorna a posição do "." anterior à extensão. Se nenhuma extensão for encontrada, retornará -1.

Comentários

Para obter mais informações, consulte PathFindExtension.

CPathT::FindFileName

Chame esse método para localizar a posição do nome do arquivo no caminho.

int FindFileName() const;

Valor de retorno

Retorna a posição do nome do arquivo. Se nenhum nome de arquivo for encontrado, retornará -1.

Comentários

Para obter mais informações, consulte PathFindFileName.

CPathT::GetDriveNumber

Chame esse método para pesquisar o caminho de uma letra de unidade dentro do intervalo de 'A' a 'Z' e retornar o número da unidade correspondente.

int GetDriveNumber() const;

Valor de retorno

Retornará o número da unidade como um número inteiro de 0 a 25 (correspondendo a 'A' a 'Z'), se o caminho tiver uma letra de unidade ou, caso contrário, retornará -1.

Comentários

Para obter mais informações, consulte PathGetDriveNumber.

CPathT::GetExtension

Chame esse método para obter a extensão do arquivo do caminho.

StringType GetExtension() const;

Valor de retorno

Retorna a extensão do arquivo.

CPathT::IsDirectory

Chame esse método para verificar se o caminho é um diretório válido.

BOOL IsDirectory() const;

Valor de retorno

Retorna um valor diferente de zero (16) se o caminho for um diretório, caso contrário, retornará FALSE.

Comentários

Para obter mais informações,consulte PathIsDirectory.

CPathT::IsFileSpec

Chame esse método para pesquisar um caminho para caracteres de delimitação de caminho (por exemplo, : ou \). Se não houver caracteres de delimitação de caminho presentes, o caminho será considerado um caminho de especificação de arquivo.

BOOL IsFileSpec() const;

Valor de retorno

Retornará TRUE se não houver caracteres delimitadores de caminho dentro do caminho ou FALSE se houver caracteres delimitadores de caminho.

Comentários

Para obter mais informações, consulte PathIsFileSpec.

CPathT::IsPrefix

Chame esse método para determinar se um caminho contém um prefixo válido do tipo passado por pszPrefix.

BOOL IsPrefix(PCXSTR pszPrefix) const;

Parâmetros

pszPrefix
O prefixo pelo qual pesquisar. Um prefixo é um destes tipos: "C:\\", ".", "..", "..\\".

Valor de retorno

Retornará TRUE se o caminho contiver o prefixo ou, caso contrário, retornará FALSE.

Comentários

Para obter mais informações, consulte PathIsPrefix.

CPathT::IsRelative

Chame esse método para determinar se o caminho é relativo.

BOOL IsRelative() const;

Valor de retorno

Retornará TRUE se o caminho for relativo ou FALSE se for absoluto.

Comentários

Para obter mais informações, consulte PathIsRelative.

CPathT::IsRoot

Chame esse método para determinar se o caminho é uma raiz de diretório.

BOOL IsRoot() const;

Valor de retorno

Retornará TRUE se o caminho for uma raiz ou, caso contrário,retornará FALSE.

Comentários

Para obter mais informações, consulte PathIsRoot.

CPathT::IsSameRoot

Chame esse método para determinar se outro caminho tem um componente raiz comum com o caminho atual.

BOOL IsSameRoot(PCXSTR pszOther) const;

Parâmetros

pszOther
O outro caminho.

Valor de retorno

Retornará TRUE se ambas as cadeias de caracteres tiverem o mesmo componente raiz ou, caso contrário, retornará FALSE.

Comentários

Para obter mais informações, consulte PathIsSameRoot.

CPathT::IsUNC

Chame esse método para determinar se o caminho é um caminho UNC (convenção de nomenclatura universal) válido para um servidor e compartilhamento.

BOOL IsUNC() const;

Valor de retorno

Retornará TRUE se o caminho for um caminho UNC válido ou, caso contrário, retornará FALSE.

Comentários

Para obter mais informações, consulte PathIsUNC.

CPathT::IsUNCServer

Chame esse método para determinar se o caminho é um caminho UNC (convenção de nomenclatura universal) válido apenas para um servidor.

BOOL IsUNCServer() const;

Valor de retorno

Retornará TRUE se a cadeia de caracteres for um caminho UNC válido apenas para um servidor (sem nome do compartilhamento) ou, caso contrário, retornará FALSE.

Comentários

Para obter mais informações, consulte PathIsUNCServer.

CPathT::IsUNCServerShare

Chame esse método para determinar se o caminho é um caminho de compartilhamento UNC (convenção de nomenclatura universal) válido, \\ servidor\ compartilhamento.

BOOL IsUNCServerShare() const;

Valor de retorno

Retornará TRUE se o caminho estiver no formulário \\ servidor\ compartilhamento ou, caso contrário, retornará FALSE.

Comentários

Para obter mais informações, consulte PathIsUNCServerShare.

CPathT::m_strPath

O caminho.

StringType m_strPath;

Comentários

StringType é o parâmetro de modelo para CPathT.

CPathT::MakePretty

Chame esse método para converter um caminho em todos os caracteres minúsculos para dar ao caminho uma aparência consistente.

BOOL MakePretty();

Valor de retorno

Retornará TRUE se o caminho foi convertido ou, caso contrário, retornará FALSE.

Comentários

Para obter mais informações, consulte PathMakePretty.

CPathT::MatchSpec

Chame esse método para pesquisar o caminho de uma cadeia de caracteres contendo um tipo de correspondência curinga.

BOOL MatchSpec(PCXSTR pszSpec) const;

Parâmetros

pszSpec
Ponteiro para uma cadeia de caracteres terminada em nulo com o tipo de arquivo a ser pesquisado. Por exemplo, para testar se o arquivo no caminho atual é um arquivo DOC, pszSpec deverá ser definido como "*.doc".

Valor de retorno

Retornará TRUE se a cadeia de caracteres corresponder ou, caso contrário, retornará FALSE.

Comentários

Para obter mais informações, consulte PathMatchSpec.

CPathT::operator +=

Esse operador acrescenta uma cadeia de caracteres ao caminho.

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

Parâmetros

pszMore
A cadeia de caracteres a ser acrescentada.

Valor de retorno

Retorna o caminho atualizado.

CPathT::operator const StringType &

Esse operador permite que o objeto seja tratado como uma cadeia de caracteres.

operator const StringType&() const throw();

Valor de retorno

Retorna uma cadeia de caracteres representando o caminho atual gerenciado por esse objeto.

CPathT::operator CPathT::PCXSTR

Esse operador permite que o objeto seja tratado como uma cadeia de caracteres.

operator PCXSTR() const throw();

Valor de retorno

Retorna uma cadeia de caracteres representando o caminho atual gerenciado por esse objeto.

CPathT::operator StringType &

Esse operador permite que o objeto seja tratado como uma cadeia de caracteres.

operator StringType&() throw();

Valor de retorno

Retorna uma cadeia de caracteres representando o caminho atual gerenciado por esse objeto.

CPathT::PCXSTR

Um tipo de cadeia de caracteres constante.

typedef StringType::PCXSTR PCXSTR;

Comentários

StringType é o parâmetro de modelo para CPathT.

CPathT::PXSTR

Um tipo de cadeia de caracteres.

typedef StringType::PXSTR PXSTR;

Comentários

StringType é o parâmetro de modelo para CPathT.

CPathT::QuoteSpaces

Chame esse método para colocar o caminho entre aspas, se contiver espaços.

void QuoteSpaces();

Comentários

Para obter mais informações, consulte PathQuoteSpaces.

CPathT::RelativePathTo

Chame esse método para criar um caminho relativo de um arquivo ou pasta para outro.

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

Parâmetros

pszFrom
O início do caminho relativo.

dwAttrFrom
Os atributos de arquivo do pszFrom. Se esse valor contiver FILE_ATTRIBUTE_DIRECTORY, pszFrom será considerado um diretório, caso contrário, pszFrom será considerado um arquivo.

pszTo
O ponto de extremidade do caminho relativo.

dwAttrTo
Os atributos de arquivo do pszTo. Se esse valor contiver FILE_ATTRIBUTE_DIRECTORY, pszTo será considerado um diretório, caso contrário, pszTo será considerado um arquivo.

Valor de retorno

Retorna TRUE em caso de êxito. FALSE, em caso de falha.

Comentários

Para obter mais informações, consulte PathRelativePathTo.

CPathT::RemoveArgs

Chame esse método para remover os argumentos da linha de comando do caminho.

void RemoveArgs();

Comentários

Para obter mais informações, consulte PathRemoveArgs.

CPathT::RemoveBackslash

Chame esse método para remover a barra invertida à direita do caminho.

void RemoveBackslash();

Comentários

Para obter mais informações, consulte PathRemoveBackslash.

CPathT::RemoveBlanks

Chame esse método para remover todos os espaços à esquerda e à direita do caminho.

void RemoveBlanks();

Comentários

Para obter mais informações, consulte PathRemoveBlanks.

CPathT::RemoveExtension

Chame esse método para remover a extensão do arquivo do caminho, se houver.

void RemoveExtension();

Comentários

Para obter mais informações, consulte PathRemoveExtension.

CPathT::RemoveFileSpec

Chame esse método para remover o nome do arquivo à direita e a barra invertida do caminho, se houver.

BOOL RemoveFileSpec();

Valor de retorno

Retorna TRUE em caso de êxito. FALSE, em caso de falha.

Comentários

Para obter mais informações, consulte PathRemoveFileSpec.

CPathT::RenameExtension

Chame esse método para substituir a extensão do nome do arquivo no caminho por uma nova extensão. Se o nome do arquivo não contiver uma extensão, a extensão será anexada ao final do caminho.

BOOL RenameExtension(PCXSTR pszExtension);

Parâmetros

pszExtension
A nova extensão de nome de arquivo, precedida por um caractere "." .

Valor de retorno

Retorna TRUE em caso de êxito. FALSE, em caso de falha.

Comentários

Para obter mais informações, consulte PathRenameExtension.

CPathT::SkipRoot

Chame esse método para analisar um caminho, ignorando a letra da unidade ou as partes do caminho do servidor/compartilhamento UNC (convenção de nomenclatura universal).

int SkipRoot() const;

Valor de retorno

Retorna a posição do início do subcaminho que segue a raiz (letra da unidade ou servidor/compartilhamento UNC).

Comentários

Para obter mais informações, consulte PathSkipRoot.

CPathT::StripPath

Chame esse método para remover a parte do caminho de um caminho e nome de arquivo totalmente qualificado.

void StripPath();

Comentários

Para obter mais informações, consulte PathStripPath.

CPathT::StripToRoot

Chame esse método para remover todas as partes do caminho, exceto as informações de raiz.

BOOL StripToRoot();

Valor de retorno

Retornará TRUE se uma letra da unidade válida foi encontrada no caminho ou, caso contrário, retornará FALSE.

Comentários

Para obter mais informações, consulte PathStripToRoot.

CPathT::UnquoteSpaces

Chame esse método para remover as aspas do início e do fim de um caminho.

void UnquoteSpaces();

Comentários

Para obter mais informações, consulte PathUnquoteSpaces.

CPathT::XCHAR

Um tipo de caractere.

typedef StringType::XCHAR XCHAR;

Comentários

StringType é o parâmetro de modelo para CPathT.

Confira também

Classes
Classe CStringT