Nota
O acesso a esta página requer autorização. Pode tentar iniciar sessão ou alterar os diretórios.
O acesso a esta página requer autorização. Pode tentar alterar os diretórios.
Observação
A Active Template Library (ATL) continua a ser suportada. No entanto, já não estamos a adicionar funcionalidades nem a atualizar a documentação.
Esta classe representa um caminho.
Importante
Esta classe e os seus membros não podem ser usados em aplicações que sejam executadas no Windows Runtime.
Sintaxe
template <typename StringType>
class CPathT
Parâmetros
StringType
A classe de string ATL/MFC a usar para o caminho (ver CStringT).
Membros
Definições de Tipos Públicas
| Nome | Description |
|---|---|
| CPathT::P CXSTR | Um tipo de corda constante. |
| CPathT::P XSTR | Um tipo de corda. |
| CPathT::XCHAR | Um tipo de caractere. |
Construtores Públicos
| Nome | Description |
|---|---|
| CPathT::CPathT | O construtor do caminho. |
Métodos Públicos
| Nome | Description |
|---|---|
| CPathT::AddBackslash | Chame este método para adicionar uma barra diagonal ao final de uma cadeia e criar a sintaxe correta para um caminho. |
| CPathT::AddExtension | Chame este método para adicionar uma extensão de ficheiro a um caminho. |
| CPathT::Anexar | Chame este método para adicionar uma cadeia ao caminho atual. |
| CPathT::BuildRoot | Chame este método para criar um caminho raiz a partir de um dado número de disco. |
| CPathT::Canonicalize | Chame este método para converter o caminho para a forma canónica. |
| CPathT::Combine | Chame este método para concatenar uma cadeia que representa um nome de diretório e uma cadeia que representa um nome de caminho de ficheiro num único caminho. |
| CPathT::CommonPrefixo | Chame este método para determinar se o caminho especificado partilha um prefixo comum com o caminho atual. |
| CPathT::CompactPath | Chame este método para truncar um caminho de ficheiro para caber dentro de uma dada largura de pixel, substituindo os componentes do caminho por elipses. |
| CPathT::CompactPathEx | Chame este método para truncar um caminho de ficheiro para caber dentro de um dado número de caracteres, substituindo os componentes do caminho por elipses. |
| CPathT::FileExists | Chame este método para verificar se o ficheiro com este nome de caminho existe. |
| CPathT::FindExtension | Chame este método para encontrar a posição da extensão do ficheiro dentro do caminho. |
| CPathT::FindFileName | Chame este método para encontrar a posição do nome do ficheiro dentro do caminho. |
| CPathT::GetDriveNumber | Chame este método para procurar no caminho uma letra de unidade no intervalo de 'A' a 'Z' e devolve o número de drive correspondente. |
| CPathT::GetExtension | Chama este método para obter a extensão do ficheiro do caminho. |
| CPathT::IsDirectory | Chame este método para verificar se o caminho é um diretório válido. |
| CPathT::IsFileSpec | Chame este método para pesquisar num caminho quaisquer caracteres que delimitem caminhos (por exemplo, : ou \). Se não houver caracteres que delimitem o caminho presentes, o caminho é considerado um caminho de Especificação de Ficheiro. |
| CPathT::IsPrefixo | Chame este método para determinar se um caminho contém um prefixo válido do tipo passado por pszPrefix. |
| CPathT::ÉRelativo | Chame-se este método para determinar se o caminho é relativo. |
| CPathT::IsRoot | Chame este método para determinar se o caminho é uma raiz de diretório. |
| CPathT::IsSameRoot | Chame este método para determinar se outro caminho tem um componente raiz comum com o caminho atual. |
| CPathT::IsUNC | Chame este método para determinar se o caminho é um caminho UNC (convenção universal de nomenclatura) válido para um servidor e partilha. |
| CPathT::IsUNCServer | Chame este método para determinar se o caminho é um caminho válido UNC (convenção universal de nomenclatura) apenas para um servidor. |
| CPathT::IsUNCServerShare | Chame este método para determinar se o caminho é um caminho de partilha válido da UNC (convenção universal de nomenclatura), \\server\share. |
| CPathT::MakePretty | Chame este método para converter um caminho para todos os caracteres minúsculos, de modo a dar ao caminho uma aparência consistente. |
| CPathT::MatchSpec | Chame este método para procurar no caminho uma cadeia contendo um tipo de correspondência coringa. |
| CPathT::QuoteSpaces | Chame este método para envolver o caminho entre aspas se este contiver espaços. |
| CPathT::RelativePathTo | Chame este método para criar um caminho relativo de um ficheiro ou pasta para outro. |
| CPathT::RemoveArgs | Chame este método para remover quaisquer argumentos de linha de comandos do caminho. |
| CPathT::RemoveBackslash | Chame este método para remover a barra posterior do caminho. |
| CPathT::RemoveBlanks | Chame este método para remover todos os espaços de frente e de saída do caminho. |
| CPathT::RemoveExtension | Chame este método para remover a extensão do ficheiro do caminho, se existir. |
| CPathT::RemoveFileSpec | Chame este método para remover o nome do ficheiro final e a barra diagonal do caminho, se os tiver. |
| CPathT::RenameExtension | Chame este método para substituir a extensão do nome do ficheiro no caminho por uma nova extensão. Se o nome do ficheiro não contiver uma extensão, a extensão será anexada ao final da cadeia. |
| CPathT::SkipRoot | Chame este método para analisar um caminho, ignorando a letra da unidade ou as partes do caminho/servidor UNC. |
| CPathT::StripPath | Chame este método para remover a parte do caminho de um caminho e nome de ficheiro totalmente qualificados. |
| CPathT::StripToRoot | Chame este método para remover todas as partes do caminho, exceto a informação raiz. |
| CPathT::UnquoteSpaces | Chame este método para remover aspas do início e do fim de um caminho. |
Operadores Públicos
| Nome | Description |
|---|---|
| CPathT::operator const StringType & | Este operador permite que o objeto seja tratado como uma corda. |
| CPathT::operator CPathT::P CXSTR | Este operador permite que o objeto seja tratado como uma corda. |
| CPathT::operator StringType & | Este operador permite que o objeto seja tratado como uma corda. |
| CPathT::operator += | Este operador adiciona uma cadeia ao caminho. |
Membros de Dados Públicos
| Nome | Description |
|---|---|
| CPathT::m_strPath | O caminho. |
Observações
CPath, CPathA, e CPathW são instâncias de CPathT definidas da seguinte forma:
typedef CPathT< CString > CPath;
typedef CPathT< CStringA > CPathA;
typedef CPathT< CStringW > CPathW;
Requerimentos
Cabeçalho: atlpath.h
CPathT::AddBackslash
Chame este método para adicionar uma barra diagonal ao final de uma cadeia e criar a sintaxe correta para um caminho. Se o caminho já tiver uma barra inversa posterior, não será adicionada nenhuma barra.
void AddBackslash();
Observações
Para mais informações, consulte PathAddBackSlash.
CPathT::AddExtension
Chame este método para adicionar uma extensão de ficheiro a um caminho.
BOOL AddExtension(PCXSTR pszExtension);
Parâmetros
pszExtension
A extensão do ficheiro para adicionar.
Valor de retorno
Retorna VERDADEIRO em caso de sucesso, FALSO em caso de falha.
Observações
Para mais informações, consulte PathAddExtension.
CPathT::Anexar
Chame este método para adicionar uma cadeia ao caminho atual.
BOOL Append(PCXSTR pszMore);
Parâmetros
pszMore
O fio para anexar.
Valor de retorno
Retorna VERDADEIRO em caso de sucesso, FALSO em caso de falha.
Observações
Para mais informações, consulte PathAppend.
CPathT::BuildRoot
Chame este método para criar um caminho raiz a partir de um dado número de disco.
void BuildRoot(int iDrive);
Parâmetros
iDrive
O número da unidade (0 é A:, 1 é B:, e assim sucessivamente).
Observações
Para mais informações, consulte PathBuildRoot.
CPathT::Canonicalize
Chame este método para converter o caminho para a forma canónica.
void Canonicalize();
Observações
Para mais informações, consulte PathCanonicalize.
CPathT::Combine
Chame este método para concatenar uma cadeia que representa um nome de diretório e uma cadeia que representa um nome de caminho de ficheiro num único caminho.
void Combine(PCXSTR pszDir, PCXSTR pszFile);
Parâmetros
pszDir
O caminho do diretório.
pszFile
O caminho do arquivo.
Observações
Para mais informações, consulte PathCombine.
CPathT::CommonPrefixo
Chame este método para determinar se o caminho especificado partilha um prefixo comum com o caminho atual.
CPathT<StringType> CommonPrefix(PCXSTR pszOther);
Parâmetros
pszOther
O caminho a comparar com o atual.
Valor de retorno
Devolve o prefixo comum.
Observações
Um prefixo é um destes tipos: "C:\\", ".", "..", ".. \\". Para mais informações, veja PathCommonPrefix.
CPathT::CompactPath
Chame este método para truncar um caminho de ficheiro para caber dentro de uma dada largura de pixel, substituindo os componentes do caminho por elipses.
BOOL CompactPath(HDC hDC, UINT nWidth);
Parâmetros
hDC
O contexto do dispositivo usado para métricas de fonte.
nLargura
A largura, em pixels, onde a corda será forçada a encaixar.
Valor de retorno
Retorna VERDADEIRO em caso de sucesso, FALSO em caso de falha.
Observações
Para mais informações, consulte PathCompactPath.
CPathT::CompactPathEx
Chame este método para truncar um caminho de ficheiro para caber dentro de um dado número de caracteres, substituindo os componentes do caminho por elipses.
BOOL CompactPathEx(UINT nMaxChars, DWORD dwFlags = 0);
Parâmetros
nMaxChars
O número máximo de caracteres a conter na nova cadeia, incluindo o carácter NULL de terminação.
dwBandeiras
Reservado.
Valor de retorno
Retorna VERDADEIRO em caso de sucesso, FALSO em caso de falha.
Observações
Para mais informações, consulte PathCompactPathEx.
CPathT::CPathT
O construtor.
CPathT(PCXSTR pszPath);
CPathT(const CPathT<StringType>& path);
CPathT() throw();
Parâmetros
pszPath
O apontador para uma cadeia de caminho.
caminho
A corda do caminho.
CPathT::FileExists
Chame este método para verificar se o ficheiro com este nome de caminho existe.
BOOL FileExists() const;
Valor de retorno
Retorna TRUE se o ficheiro existir, FALSE caso contrário.
Observações
Para mais informações, consulte PathFileExists.
CPathT::FindExtension
Chame este método para encontrar a posição da extensão do ficheiro dentro do caminho.
int FindExtension() const;
Valor de retorno
Devolve a posição do "." que precede a extensão. Se não for encontrada extensão, devolve -1.
Observações
Para mais informações, veja PathFindExtension.
CPathT::FindFileName
Chame este método para encontrar a posição do nome do ficheiro dentro do caminho.
int FindFileName() const;
Valor de retorno
Devolve a posição do nome do ficheiro. Se não for encontrado nenhum nome de ficheiro, retorna -1.
Observações
Para mais informações, consulte PathFindFileName.
CPathT::GetDriveNumber
Chame este método para procurar no caminho uma letra de unidade no intervalo de 'A' a 'Z' e devolve o número de drive correspondente.
int GetDriveNumber() const;
Valor de retorno
Devolve o número da unidade como um inteiro de 0 a 25 (correspondente a 'A' a 'Z') se o caminho tiver uma letra de unidade, ou -1 caso contrário.
Observações
Para mais informações, consulte PathGetDriveNumber.
CPathT::GetExtension
Chama este método para obter a extensão do ficheiro do caminho.
StringType GetExtension() const;
Valor de retorno
Devolve a extensão do ficheiro.
CPathT::IsDirectory
Chame este método para verificar se o caminho é um diretório válido.
BOOL IsDirectory() const;
Valor de retorno
Devolve um valor diferente de zero (16) se o caminho for um diretório, FALSE caso contrário.
Observações
Para mais informações, consulte PathIsDirectory.
CPathT::IsFileSpec
Chame este método para pesquisar num caminho quaisquer caracteres que delimitem caminhos (por exemplo, : ou \). Se não houver caracteres que delimitem o caminho presentes, o caminho é considerado um caminho de Especificação de Ficheiro.
BOOL IsFileSpec() const;
Valor de retorno
Retorna TRUE se não houver caracteres delimitadores de caminho dentro do caminho, ou FALSE se existirem caracteres que delimitem caminhos.
Observações
Para mais informações, consulte PathIsFileSpec.
CPathT::IsPrefixo
Chame este 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
pszPrefixo
O prefixo para procurar. Um prefixo é um destes tipos: "C:\\", ".", "..", ".. \\".
Valor de retorno
Retorna TRUE se o caminho contiver o prefixo, ou FALSE caso contrário.
Observações
Para mais informações, consulte PathIsPrefix.
CPathT::ÉRelativo
Chame-se este método para determinar se o caminho é relativo.
BOOL IsRelative() const;
Valor de retorno
Retorna TRUE se o caminho for relativo, ou FALSE se for absoluto.
Observações
Para mais informações, consulte PathIsRelative.
CPathT::IsRoot
Chame este método para determinar se o caminho é uma raiz de diretório.
BOOL IsRoot() const;
Valor de retorno
Retorna TRUE se o caminho for uma raiz, ou FALSE caso contrário.
Observações
Para mais informações, consulte PathIsRoot.
CPathT::IsSameRoot
Chame este 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
Retorna TRUE se ambas as cadeias tiverem o mesmo componente raiz, ou FALSE caso contrário.
Observações
Para mais informações, consulte PathIsSameRoot.
CPathT::IsUNC
Chame este método para determinar se o caminho é um caminho UNC (convenção universal de nomenclatura) válido para um servidor e partilha.
BOOL IsUNC() const;
Valor de retorno
Retorna TRUE se o caminho for um caminho UNC válido, ou FALSE caso contrário.
Observações
Para mais informações, consulte PathIsUNC.
CPathT::IsUNCServer
Chame este método para determinar se o caminho é um caminho válido UNC (convenção universal de nomenclatura) apenas para um servidor.
BOOL IsUNCServer() const;
Valor de retorno
Retorna TRUE se a string for um caminho UNC válido apenas para um servidor (sem nome de partilha), ou FALSE caso contrário.
Observações
Para mais informações, consulte PathIsUNCServer.
CPathT::IsUNCServerShare
Chame este método para determinar se o caminho é um caminho de partilha UNC (convenção universal de nomenclatura) válido, \\ partilha de servidor\ .
BOOL IsUNCServerShare() const;
Valor de retorno
Retorna TRUE se o caminho estiver na forma \\ server\ share, ou FALSE caso contrário.
Observações
Para mais informações, consulte PathIsUNCServerShare.
CPathT::m_strPath
O caminho.
StringType m_strPath;
Observações
StringType é o parâmetro modelo de CPathT.
CPathT::MakePretty
Chame este método para converter um caminho para todos os caracteres minúsculos, de modo a dar ao caminho uma aparência consistente.
BOOL MakePretty();
Valor de retorno
Retorna TRUE se o caminho tiver sido convertido, ou FALSE caso contrário.
Observações
Para mais informações, consulte PathMakePretty.
CPathT::MatchSpec
Chame este método para procurar no caminho uma cadeia contendo um tipo de correspondência coringa.
BOOL MatchSpec(PCXSTR pszSpec) const;
Parâmetros
pszSpec
Apontador para uma cadeia terminada por null com o tipo de ficheiro para o qual procurar. Por exemplo, para testar se o ficheiro no caminho atual é um ficheiro DOC, o pszSpec deve ser definido como "*.doc".
Valor de retorno
Retorna TRUE se a cadeia coincidir, ou FALSE caso contrário.
Observações
Para mais informações, consulte PathMatchSpec.
CPathT::operator +=
Este operador adiciona uma cadeia ao caminho.
CPathT<StringType>& operator+=(PCXSTR pszMore);
Parâmetros
pszMore
O fio para anexar.
Valor de retorno
Devolve o caminho atualizado.
CPathT::operator const StringType &
Este operador permite que o objeto seja tratado como uma corda.
operator const StringType&() const throw();
Valor de retorno
Devolve uma cadeia que representa o caminho atual gerido por este objeto.
CPathT::operator CPathT::P CXSTR
Este operador permite que o objeto seja tratado como uma corda.
operator PCXSTR() const throw();
Valor de retorno
Devolve uma cadeia que representa o caminho atual gerido por este objeto.
CPathT::operator StringType &
Este operador permite que o objeto seja tratado como uma corda.
operator StringType&() throw();
Valor de retorno
Devolve uma cadeia que representa o caminho atual gerido por este objeto.
CPathT::P CXSTR
Um tipo de corda constante.
typedef StringType::PCXSTR PCXSTR;
Observações
StringType é o parâmetro modelo de CPathT.
CPathT::P XSTR
Um tipo de corda.
typedef StringType::PXSTR PXSTR;
Observações
StringType é o parâmetro modelo de CPathT.
CPathT::QuoteSpaces
Chame este método para envolver o caminho entre aspas se este contiver espaços.
void QuoteSpaces();
Observações
Para mais informações, consulte PathQuoteSpaces.
CPathT::RelativePathTo
Chame este método para criar um caminho relativo de um ficheiro 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 do ficheiro do pszFrom. Se este valor contiver FILE_ATTRIBUTE_DIRECTORY, pszFrom é assumido como um diretório; caso contrário, pszFrom é assumido como um ficheiro.
pszTo
O ponto final do caminho relativo.
dwAttrTo
Os atributos do ficheiro do pszTo. Se este valor contiver FILE_ATTRIBUTE_DIRECTORY, o pszTo é assumido como um diretório; caso contrário, o pszTo é assumido como um ficheiro.
Valor de retorno
Retorna VERDADEIRO em caso de sucesso, FALSO em caso de falha.
Observações
Para mais informações, consulte PathRelativePathTo.
CPathT::RemoveArgs
Chame este método para remover quaisquer argumentos de linha de comandos do caminho.
void RemoveArgs();
Observações
Para mais informações, consulte PathRemoveArgs.
CPathT::RemoveBackslash
Chame este método para remover a barra posterior do caminho.
void RemoveBackslash();
Observações
Para mais informações, consulte PathRemoveBackslash.
CPathT::RemoveBlanks
Chame este método para remover todos os espaços de frente e de saída do caminho.
void RemoveBlanks();
Observações
Para mais informações, consulte PathRemoveBlanks.
CPathT::RemoveExtension
Chame este método para remover a extensão do ficheiro do caminho, se existir.
void RemoveExtension();
Observações
Para mais informações, veja PathRemoveExtension.
CPathT::RemoveFileSpec
Chame este método para remover o nome do ficheiro final e a barra diagonal do caminho, se os tiver.
BOOL RemoveFileSpec();
Valor de retorno
Retorna VERDADEIRO em caso de sucesso, FALSO em caso de falha.
Observações
Para mais informações, consulte PathRemoveFileSpec.
CPathT::RenameExtension
Chame este método para substituir a extensão do nome do ficheiro no caminho por uma nova extensão. Se o nome do ficheiro 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 do nome do ficheiro, precedida por um carácter "."
Valor de retorno
Retorna VERDADEIRO em caso de sucesso, FALSO em caso de falha.
Observações
Para mais informações, consulte PathRenameExtension.
CPathT::SkipRoot
Chame este método para analisar um caminho, ignorando as partes da letra da unidade ou das partes do servidor/caminho de partilha UNC (convenção universal de nomenclatura).
int SkipRoot() const;
Valor de retorno
Devolve a posição do início do subcaminho que segue a raiz (letra da unidade ou servidor/partilha UNC).
Observações
Para mais informações, consulte PathSkipRoot.
CPathT::StripPath
Chame este método para remover a parte do caminho de um caminho e nome de ficheiro totalmente qualificados.
void StripPath();
Observações
Para mais informações, consulte PathStripPath.
CPathT::StripToRoot
Chame este método para remover todas as partes do caminho, exceto a informação raiz.
BOOL StripToRoot();
Valor de retorno
Retorna TRUE se foi encontrada uma letra de drive válida no caminho, ou FALSE caso contrário.
Observações
Para mais informações, consulte PathStripToRoot.
CPathT::UnquoteSpaces
Chame este método para remover aspas do início e do fim de um caminho.
void UnquoteSpaces();
Observações
Para mais informações, consulte PathUnquoteSpaces.
CPathT::XCHAR
Um tipo de caractere.
typedef StringType::XCHAR XCHAR;
Observações
StringType é o parâmetro modelo de CPathT.