Função SetupGetLineTextA (setupapi.h)

Artigo
11/20/2024

[Essa função está disponível para uso nos sistemas operacionais indicados na seção Requisitos. Ele pode estar alterado ou 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. Esse parâmetro pode ser NULL. Se de Contexto estiver NULL, InfHandle, Sectione Key deverão ser especificados.

[in] InfHandle

Manipule para o arquivo INF a ser consultado. Esse parâmetro pode ser NULL. Esse parâmetro será usado somente se de Contexto estiver NULL. Se de Contexto estiver NULL, InfHandle, Sectione Key deverão ser especificados.

[in] Section

Ponteiro para um cadeia de caracteresterminada nula que especifica a seção que contém o nome da chave da linha cujo texto deve ser recuperado. Esse parâmetro pode ser NULL. Esse parâmetro será usado somente se de Contexto estiver NULL. Se de Contexto for NULL, InfHandle, Sectione Key deverão ser especificados.

[in] Key

Ponteiro para um cadeia de caracteresterminada nula que contém o nome da chave cuja cadeia de caracteres associada deve ser recuperada. Esse parâmetro pode ser NULL. Esse parâmetro será usado somente se de Contexto estiver NULL. Se de Contexto for NULL, InfHandle, Sectione Key deverão ser especificados.

[in, out] ReturnBuffer

Se não NULL, ReturnBuffer aponta para um buffer no qual essa função retorna o conteúdo da linha. A cadeia de caracteresterminada por nula 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. Esse parâmetro pode ser NULL.

[in] ReturnBufferSize

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

[in, out] RequiredSize

Se não NULL, aponta para uma variável na qual essa função retorna o tamanho necessário para o buffer apontado pelo parâmetro ReturnBuffer, em caracteres. Isso inclui o terminador de nulo . Se ReturnBuffer for especificado e o tamanho necessário for maior do que o valor especificado no parâmetro ReturnBufferSize, a função falhará e não armazenará dados no buffer.

Valor de retorno

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.

Observações

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

Nota

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 do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows XP [somente aplicativos da área de trabalho]
servidor com suporte mínimo	Windows Server 2003 [somente aplicativos da área de trabalho]
da Plataforma de Destino	Windows
cabeçalho	setupapi.h
biblioteca	Setupapi.lib
de DLL	Setupapi.dll
conjunto de API	ext-ms-win-setupapi-inf-l1-1-0 (introduzido no Windows 8)

Consulte também

Funções

Visão geral

SetupFindFirstLine

SetupFindNextLine

SetupFindNextMatchLine

SetupGetLineByIndex

Compartilhar via