Função SetupGetLineTextA (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 SetupGetLineText retorna o conteúdo de uma linha em um arquivo INF em um formulário compacto. A linha a ser recuperada pode ser especificada por uma estrutura INFCONTEXT retornada de uma função SetupFindLineXXX ou passando explicitamente o identificador INF, a seção e a chave da linha desejada.

Sintaxe

WINSETUPAPI BOOL SetupGetLineTextA(
  [in]      PINFCONTEXT Context,
  [in]      HINF        InfHandle,
  [in]      PCSTR       Section,
  [in]      PCSTR       Key,
  [in, out] PSTR        ReturnBuffer,
  [in]      DWORD       ReturnBufferSize,
  [in, out] PDWORD      RequiredSize
);

Parâmetros

[in] Context

Contexto para uma linha em um arquivo INF cujo texto deve ser recuperado. Este parâmetro pode ser NULL. Se Context for NULL, InfHandle, Section e Key deverão ser especificados.

[in] InfHandle

Manipule para o arquivo INF a ser consultado. Este parâmetro pode ser NULL. Esse parâmetro será usado somente se Context for NULL. Se Context for NULL, InfHandle, Section e Key deverão ser especificados.

[in] Section

Ponteiro para uma cadeia de caracteres terminada em nulo que especifica a seção que contém o nome da chave da linha cujo texto deve ser recuperado. Este parâmetro pode ser NULL. Esse parâmetro será usado somente se Context for NULL. Se Context for NULL, InfHandle, Section e Key deverão ser especificados.

[in] Key

Ponteiro para uma cadeia de caracteres terminada em nulo que contém o nome da chave cuja cadeia de caracteres associada deve ser recuperada. Este parâmetro pode ser NULL. Esse parâmetro será usado somente se Context for NULL. Se Context for NULL, InfHandle, Section e Key deverão ser especificados.

[in, out] ReturnBuffer

Se não for NULL, ReturnBuffer apontará para um buffer no qual essa função retornará o conteúdo da linha. 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. Usando essa técnica, você pode evitar erros devido a um tamanho de buffer insuficiente. Consulte a seção Comentários. Este parâmetro pode ser NULL.

[in] ReturnBufferSize

Tamanho do buffer apontado pelo parâmetro ReturnBuffer , em caracteres. Isso inclui o terminador nulo .

[in, out] RequiredSize

Se não for NULL, apontará para uma variável na qual essa função retornará o tamanho necessário para o buffer apontado pelo parâmetro ReturnBuffer , em caracteres. Isso inclui o terminador nulo . Se ReturnBuffer for especificado e o tamanho necessário for maior que o valor especificado no parâmetro ReturnBufferSize , a função falhará e não armazenará dados no 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.

Essa função retorna o conteúdo de uma linha em um formato compacto. Todo o espaço em branco desnecessário é removido e os valores de várias linhas são convertidos em uma única cadeia de caracteres contígua. Por exemplo, esta linha:

HKLM, , PointerClass0, 1 \
; This is a comment
01, 02, 03

seria retornado como:

HKLM,,PointerClass0,1,01,02,03

Observação

O cabeçalho setupapi.h define SetupGetLineText 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
Conjunto de APIs	ext-ms-win-setupapi-inf-l1-1-0 (introduzido no Windows 8)