SetupQueryInfFileInformationW function (setupapi.h)

[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 SetupQueryInfFileInformation function returns an INF filename from an SP_INF_INFORMATION structure to a buffer.

Syntax

WINSETUPAPI BOOL SetupQueryInfFileInformationW(
  PSP_INF_INFORMATION InfInformation,
  UINT                InfIndex,
  PWSTR               ReturnBuffer,
  DWORD               ReturnBufferSize,
  PDWORD              RequiredSize
);

Parameters

InfInformation

Pointer to an SP_INF_INFORMATION structure returned from a call to the SetupGetInfInformation function.

InfIndex

Index of the constituent INF filename to retrieve. This index can be in the range [0, InfInformation.InfCount). Meaning that the values zero through, but not including, InfInformation.InfCount are valid.

ReturnBuffer

If not NULL, ReturnBuffer is a pointer to a buffer in which this function returns the full INF filename. You should use a null-terminated string. The null-terminated string should not exceed the size of the destination buffer. You can call the function once to get the required buffer size, allocate the necessary memory, and then call the function a second time to retrieve the data. See the Remarks section. Using this technique, you can avoid errors due to an insufficient buffer size. This parameter can be NULL.

ReturnBufferSize

Size of the buffer pointed to by the ReturnBuffer parameter, in characters. This includes the null terminator.

RequiredSize

If not NULL, pointer to a variable that receives the required size for the ReturnBuffer buffer, in characters. This includes the null terminator. If ReturnBuffer is specified and the actual size is larger than ReturnBufferSize, the function fails and a call to GetLastError returns ERROR_INSUFFICIENT_BUFFER.

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 this function is called with a ReturnBuffer of NULL and a ReturnBufferSize of zero, the function puts the buffer size needed to hold the specified data into the variable pointed to by RequiredSize. If the function succeeds in this, the return value is a nonzero value. Otherwise, the return value is zero and extended error information can be obtained by calling GetLastError.

Note

The setupapi.h header defines SetupQueryInfFileInformation 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

   
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

See also

Functions

Overview

SetupGetInfInformation

SetupQueryInfVersionInformation