Função SetupGetSourceInfoA (setupapi.h)

Artigo
08/26/2023

[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 SetupGetSourceInfo recupera o caminho, o arquivo de marca ou a descrição da mídia de uma fonte listada em um arquivo INF.

Sintaxe

WINSETUPAPI BOOL SetupGetSourceInfoA(
  [in]      HINF   InfHandle,
  [in]      UINT   SourceId,
  [in]      UINT   InfoDesired,
  [in, out] PSTR   ReturnBuffer,
  [in]      DWORD  ReturnBufferSize,
  [in, out] PDWORD RequiredSize
);

Parâmetros

[in] InfHandle

Manipule para um arquivo INF aberto que contém uma seção SourceDisksNames . Se houver seções específicas da plataforma para o sistema do usuário (por exemplo, SourceDisksNames.x86), a seção específica da plataforma será usada.

[in] SourceId

Identificador de uma mídia de origem. Esse valor é usado para pesquisar por chave na seção SourceDisksNames .

[in] InfoDesired

Indica quais informações são desejadas. Apenas um valor pode ser especificado por chamada de função e eles não podem ser combinados. Os tipos de informações a seguir podem ser recuperados de uma seção SourceDisksNames .

SRCINFO_PATH

O caminho especificado para a origem. Esse não é um caminho completo, mas o caminho relativo à raiz de instalação.

SRCINFO_TAGFILE

O arquivo de marca que identifica a mídia de origem ou, se os gabinetes forem usados, o nome do arquivo de gabinete.

SRCINFO_DESCRIPTION

Uma descrição para a mídia.

[in, out] ReturnBuffer

Ponteiro opcional para um buffer para receber as informações recuperadas. Os retornos de caminho são garantidos para não terminar com . 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. Este parâmetro pode ser NULL.

[in] ReturnBufferSize

Tamanho do buffer apontado por ReturnBuffer, em caracteres. Isso inclui o terminador nulo .

[in, out] RequiredSize

Ponteiro opcional para uma variável que recebe o tamanho necessário para o buffer especificado por ReturnBuffer, em caracteres. Isso inclui o terminador nulo . Se ReturnBuffer for especificado e o tamanho real necessário for maior que o valor especificado por ReturnBufferSize, a função falhará e uma chamada para GetLastError retornará ERROR_INSUFFICIENT_BUFFER.

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 ReturnBuffer 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.

Observação

O cabeçalho setupapi.h define SetupGetSourceInfo 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