Función SetupGetLineTextA (setupapi.h)

Artículo
08/26/2023

[Esta función está disponible para su uso en los sistemas operativos indicados en la sección Requisitos. En versiones posteriores podría modificarse o no estar disponible. SetupAPI ya no debe usarse para instalar aplicaciones. En su lugar, use Windows Installer para desarrollar instaladores de aplicaciones. SetupAPI sigue utilizándose para instalar controladores de dispositivo.

La función SetupGetLineText devuelve el contenido de una línea en un archivo INF en un formato compacto. La línea que se va a recuperar se puede especificar mediante una estructura INFCONTEXT devuelta desde una función SetupFindLineXXX, o pasando explícitamente el identificador INF, la sección y la clave de la línea deseada.

Sintaxis

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 de una línea en un archivo INF cuyo texto se va a recuperar. Este parámetro puede ser NULL. Si Context es NULL, InfHandle, Section y Key deben especificarse todos.

[in] InfHandle

Identificador del archivo INF que se va a consultar. Este parámetro puede ser NULL. Este parámetro solo se usa si Context es NULL. Si Context es NULL, InfHandle, Section y Key deben especificarse todos.

[in] Section

Puntero a una cadena terminada en null que especifica la sección que contiene el nombre de clave de la línea cuyo texto se va a recuperar. Este parámetro puede ser NULL. Este parámetro solo se usa si Context es NULL. Si Context es NULL, InfHandle, Section y Key deben especificarse.

[in] Key

Puntero a una cadena terminada en null que contiene el nombre de clave cuya cadena asociada se va a recuperar. Este parámetro puede ser NULL. Este parámetro solo se usa si Context es NULL. Si Context es NULL, InfHandle, Section y Key deben especificarse.

[in, out] ReturnBuffer

Si no es NULL, ReturnBuffer apunta a un búfer en el que esta función devuelve el contenido de la línea. La cadena terminada en null no debe superar el tamaño del búfer de destino. Puede llamar a la función una vez para obtener el tamaño de búfer necesario, asignar la memoria necesaria y, a continuación, llamar a la función una segunda vez para recuperar los datos. Con esta técnica, puede evitar errores debido a un tamaño de búfer insuficiente. Consulte la sección Comentarios. Este parámetro puede ser NULL.

[in] ReturnBufferSize

Tamaño del búfer al que apunta el parámetro ReturnBuffer , en caracteres. Esto incluye el terminador null .

[in, out] RequiredSize

Si no es NULL, apunta a una variable en la que esta función devuelve el tamaño necesario para el búfer al que apunta el parámetro ReturnBuffer , en caracteres. Esto incluye el terminador null . Si se especifica ReturnBuffer y el tamaño necesario es mayor que el valor especificado en el parámetro ReturnBufferSize , se produce un error en la función y no almacena datos en el búfer.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es un valor distinto de cero.

Si la función no se realiza correctamente, el valor devuelto es cero. Para obtener información de error extendida, llame a GetLastError.

Comentarios

Si se llama a esta función con returnBuffer de NULL y returnBufferSize de cero, la función coloca el tamaño del búfer necesario para contener los datos especificados en la variable a la que apunta RequiredSize. Si la función se ejecuta correctamente, el valor devuelto es un valor distinto de cero. De lo contrario, el valor devuelto es cero y se puede obtener información de error extendida llamando a GetLastError.

Esta función devuelve el contenido de una línea en un formato compacto. Se quitan todos los espacios en blanco extraños y los valores de varias líneas se convierten en una sola cadena contigua. Por ejemplo, esta línea:

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

se devolverá como:

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

Nota

El encabezado setupapi.h define SetupGetLineText como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutro de codificación con código que no es neutral de codificación puede provocar discrepancias que dan lugar a errores de compilación o en tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows XP [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2003 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	setupapi.h
Library	Setupapi.lib
Archivo DLL	Setupapi.dll
Conjunto de API	ext-ms-win-setupapi-inf-l1-1-0 (introducido en Windows 8)