SetupGetLineByIndexA function (setupapi.h)

Article
02/22/2024

[This function is available for use in the operating systems indicated in the Requirements section. It may be altered or unavailable in subsequent versions. SetupAPI should no longer be used for installing applications. Instead, use the Windows Installer for developing application installers. SetupAPI continues to be used for installing device drivers.]

The SetupGetLineByIndex function locates a line by its index value in the specified section in the INF file.

Syntax

WINSETUPAPI BOOL SetupGetLineByIndexA(
  [in]      HINF        InfHandle,
  [in]      PCSTR       Section,
  [in]      DWORD       Index,
  [in, out] PINFCONTEXT Context
);

Parameters

[in] InfHandle

Handle to the INF file.

[in] Section

Pointer to a null-terminated string specifying the section of the INF file to search.

[in] Index

Index of the line to be located. The total number of lines in a particular section can be found with a call to SetupGetLineCount.

[in, out] Context

Pointer to a variable that receives the context information for the found line.

Return value

If the function succeeds, the return value is a nonzero value. If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

If InfHandle references multiple INF files that have been appended together using SetupOpenAppendInfFile, this function searches across the specified section in all files referenced by the HINF to locate the indexed line.

Note

The setupapi.h header defines SetupGetLineByIndex as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	setupapi.h
Library	Setupapi.lib
DLL	Setupapi.dll
API set	ext-ms-win-setupapi-inf-l1-1-1 (introduced in Windows 10, version 10.0.14393)