Função DragQueryFileA (shellapi.h)

  • Artigo

Recupera os nomes de arquivos descartados resultantes de uma operação de arrastar e soltar bem-sucedida.

Sintaxe

UINT DragQueryFileA(
  [in]  HDROP hDrop,
  [in]  UINT  iFile,
  [out] LPSTR lpszFile,
        UINT  cch
);

Parâmetros

[in] hDrop

Tipo: HDROP

Identificador da estrutura que contém os nomes de arquivo dos arquivos removidos.

[in] iFile

Tipo: UINT

Índice do arquivo a ser consultado. Se o valor desse parâmetro for 0xFFFFFFFF, DragQueryFile retornará uma contagem dos arquivos removidos. Se o valor desse parâmetro estiver entre zero e o número total de arquivos descartados, DragQueryFile copiará o nome do arquivo com o valor correspondente para o buffer apontado pelo parâmetro lpszFile .

[out] lpszFile

Tipo: LPTSTR

O endereço de um buffer que recebe o nome de arquivo de um arquivo descartado quando a função retorna. Esse nome de arquivo é uma cadeia de caracteres terminada em nulo. Se esse parâmetro for NULL, DragQueryFile retornará o tamanho necessário, em caracteres, desse buffer.

cch

Tipo: UINT

O tamanho, em caracteres, do buffer lpszFile .

Retornar valor

Tipo: UINT

Um valor diferente de zero indica uma chamada bem-sucedida.

Quando a função copia um nome de arquivo para o buffer, o valor retornado é uma contagem dos caracteres copiados, não incluindo o caractere nulo de terminação.

Se o valor do índice for 0xFFFFFFFF, o valor retornado será uma contagem dos arquivos descartados. Observe que a variável de índice retorna inalterada e, portanto, permanece 0xFFFFFFFF.

Se o valor do índice estiver entre zero e o número total de arquivos descartados e o endereço do buffer lpszFile for NULL, o valor retornado será o tamanho necessário, em caracteres, do buffer, sem incluir o caractere nulo de terminação.

Comentários

Observação

O cabeçalho shellapi.h define DragQueryFile como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows XP [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho shellapi.h
Biblioteca Shell32.lib
DLL Shell32.dll (versão 4.0 ou posterior)
Conjunto de APIs ext-ms-win-shell-shell32-l1-2-1 (introduzido no Windows 10, versão 10.0.10240)

Confira também

DragQueryPoint