Função SetupQueryFileLogA (setupapi.h)
[Essa função está disponível para uso nos sistemas operacionais indicados na seção Requisitos. Ele poderá ser alterado ou ficar indisponível em versões subsequentes. SetupAPI não deve mais ser usado para instalar aplicativos. Em vez disso, use o Windows Installer para desenvolver instaladores de aplicativos. SetupAPI continua a ser usado para instalar drivers de dispositivo.]
A função SetupQueryFileLog retorna informações de um log de arquivos de instalação.
Sintaxe
WINSETUPAPI BOOL SetupQueryFileLogA(
[in] HSPFILELOG FileLogHandle,
[in] PCSTR LogSectionName,
[in] PCSTR TargetFilename,
[in] SetupFileLogInfo DesiredInfo,
[in, out] PSTR DataOut,
[in] DWORD ReturnBufferSize,
[in, out] PDWORD RequiredSize
);
Parâmetros
[in] FileLogHandle
Manipule para o log de arquivos conforme retornado por SetupInitializeFileLog.
[in] LogSectionName
Ponteiro opcional para o nome da seção do arquivo de log em um formato que seja significativo para o chamador. Você deve usar uma cadeia de caracteres terminada em nulo. Necessário para logs que não são do sistema. Se nenhum LogSectionName for especificado para um log do sistema, um padrão será fornecido.
[in] TargetFilename
Nome do arquivo para o qual as informações de log são desejadas. Você deve usar uma cadeia de caracteres terminada em nulo.
[in] DesiredInfo
Indica quais informações devem ser retornadas para o buffer do DataOut . Esse parâmetro pode ser um dos seguintes valores enumerados.
Se o valor de DesiredInfo for maior que SetupFileLogOtherInfo , a função falhará e GetLastError retornará ERROR_INVALID_PARAMETER.
[in, out] DataOut
Ponteiro opcional para um buffer no qual essa função retorna as informações solicitadas para o arquivo. Você deve usar uma cadeia de caracteres terminada em nulo. A cadeia de caracteres terminada em nulo não deve exceder o tamanho do buffer de destino. Você pode chamar a função uma vez para obter o tamanho do buffer necessário, alocar a memória necessária e, em seguida, chamar a função uma segunda vez para recuperar os dados. Consulte a seção Comentários. Usando essa técnica, você pode evitar erros devido a um tamanho de buffer insuficiente. Nem todas as informações são fornecidas para cada arquivo. Um erro não será retornado se houver uma entrada vazia para o arquivo no log. Este parâmetro pode ser NULL.
[in] ReturnBufferSize
Tamanho do buffer do DataOut , em caracteres. Isso inclui o terminador nulo . Se o buffer for muito pequeno e o DataOut for especificado, os dados não serão armazenados no buffer e a função retornará zero. Se DataOut não for especificado, o parâmetro ReturnBufferSize será ignorado.
[in, out] RequiredSize
Ponteiro opcional para uma variável que recebe o tamanho necessário do DataOut, em caracteres. Esse número inclui o terminador nulo .
Retornar valor
Se a função for bem-sucedida, o valor retornado será um valor diferente de zero.
Se a função falhar, o valor retornado será zero. Para obter informações de erro estendidas, chame GetLastError.
Comentários
Se essa função for chamada com um DataOut de NULL e um ReturnBufferSize de zero, a função colocará o tamanho do buffer necessário para manter os dados especificados na variável apontada por RequiredSize. Se a função tiver êxito nisso, o valor retornado será um valor diferente de zero. Caso contrário, o valor retornado será zero e as informações de erro estendidas poderão ser obtidas chamando GetLastError.
Se o valor de DesiredInfo for maior que SetupFileLogOtherInfo , a função falhará e GetLastError retornará ERROR_INVALID_PARAMETER.
Observação
O cabeçalho setupapi.h define SetupQueryFileLog 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 Server 2003 [somente aplicativos da área de trabalho] |
| Plataforma de Destino | Windows |
| Cabeçalho | setupapi.h |
| Biblioteca | Setupapi.lib |
| DLL | Setupapi.dll |