GetFileTitle

A função GetFileTitle retorna o nome do arquivo identificado pelo parâmetro lpszFile.

curto GetFileTitle ( LPCTSTR  lpszFile, / / ponteiro para o caminho completo e nome de arquivo para arquivoLPTSTRlpszTitle, / / ponteiro para o buffer que recebe o nome de arquivoPalavracbBuf / / comprimento do buffer);
 

Parâmetros

lpszFile

Ponteiro para o nome e o local de um arquivo.

lpszTitle

Ponteiro para um buffer no qual a função é copiar o nome do arquivo.

cbBuf

Especifica o comprimento, em caracteres, do buffer apontado pelo parâmetro lpszTitle.

Retornar valores

Se a função for bem-sucedido, o valor de retorno é zero.

Se o nome do arquivo é inválido, o valor de retorno é um número negativo.

Se a reserva apontada pelo lpszTitle parâmetro é muito pequena, o valor de retorno é um inteiro positivo que especifica o exigido tamanho do buffer, em bytes (versão ANSI) ou 16-bit caracteres (versão Unicode). O exigido tamanho do buffer inclui o caractere nulo final.

Observações

A função GetFileTitle retorna um valor de erro se o buffer apontado pelo parâmetro lpszFile contiver qualquer um dos seguintes elementos:

• Uma vazia Cadeia de caracteres
• Uma Cadeia de caracteres que contém um caractere curinga (*), abertura de colchete ([]), ou colchete de fechamento (])
• Uma Cadeia de caracteres que termina com dois-pontos (:), barra diagonal (/) ou barra invertida (\)
• Uma Cadeia de caracteres cujo comprimento excedido o comprimento do buffer
• Um caractere inválido (por exemplo, um espaço ou um caractere não imprimível)

Para obter o tamanho do buffer necessário para o nome de um arquivo, chame a função com lpszTitle definir como NULL e cbBuf definido como zero. A função retornará o tamanho necessário.

GetFileTitle retorna a Cadeia de caracteres que o sistema usa para exibir o nome do arquivo para o usuário. O nome de exibição inclui uma extensão só se for a preferência do usuário para exibir nomes de arquivos. Isso significa que a Cadeia de caracteres retornada pode não identificar com precisão o arquivo se ele for usado em chamadas para funções sistema de arquivos.

Se a reserva de lpszTitle é muito pequena, GetFileTitle retorna o tamanho necessário para manter o nome de exibição. Não há nenhuma conexão garantida entre o exigido tamanho e caracteres especificados originalmente no buffer lpszFile . Em portar aplicativos baseados no Windows de 16 bits para Win32, você precisará atualizar qualquer código que depende de tal comportamento em versões anteriores do sistema. O caso mais comum é o código que deliberadamente chama GetFileTitle com lpszTitle definir como NULL e cbBuf definido como zero e, em seguida, usa o valor de retorno como um índice em cadeia de caracteres a lpszFile . Essa técnica não é mais suportada. Você normalmente pode obter resultados semelhantes (e um desempenho superior) com funções de biblioteca de tempo de execução como strrchre wcsrchr mbsrchr.

QuickInfo

nbsp; Windows &NT: requer a versão 3.1 ou posterior.
Windows:Requer o Windows 95 ou posterior.
Windows CE:Sem suporte.
Cabeçalho:Declaradas no commdlg.h.
Biblioteca de importação:Use comdlg32.lib.
Unicode:Implementado como versões Unicode e ANSI no Windows NT.

Ver também

Visão geral de biblioteca de caixa de diálogo comum, funções de caixa de diálogo comuns, GetOpenFileName, GetSaveFileName