SetupGetStringField

The SetupGetStringField function retrieves a string from the specified field of a line in an INF file.

BOOL SetupGetStringField(
  PINFCONTEXT Context, // context of the INF file
  DWORD FieldIndex,    // index of the field to get
  PTSTR ReturnBuffer,  // optional, receives the field
  DWORD ReturnBufferSize,  // size of the provided buffer
  PDWORD RequiredSize  // optional, buffer size needed
);
 

Parameters

Context

Pointer to the context for a line in an INF file.

FieldIndex

The 1-based index of the field within the specified line from which the string should be retrieved. Use a FieldIndex of 0 to retrieve a string key, if present.

ReturnBuffer

This optional parameter points to a caller-supplied buffer to which this function returns the string.

ReturnBufferSize

The size of the buffer pointed to by ReturnBuffer.

RequiredSize

This optional parameter points to a caller-supplied variable to which SetupGetStringField returns the required size for the buffer pointed to by the ReturnBuffer parameter. If ReturnBuffer is specified and the actual size needed is larger than the value specified by ReturnBufferSize, the function fails and does not store the string in the buffer. In this case, a call to GetLastError returns ERROR_INSUFFICIENT_BUFFER.

Return Values

If the function succeeds, the return value is a non-zero value.

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

Remarks

For the Unicode version of this function, the buffer sizes ReturnBufferSize, and ReturnBufferSize are specified in number of characters. This number includes the null terminator. For the ANSI version of this function, the sizes are specified in number of bytes.

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 non-zero value. Otherwise, the return value is zero and extended error information can be obtained by calling GetLastError.

Thus, 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. Using this technique, you can avoid errors due to an insufficient buffer size.

QuickInfo

  Windows NT: Use version 4.0 and later.
  Windows: Use Windows 95 and later.
  Windows CE: Unsupported.
  Header: Declared in setupapi.h.
  Import Library: Link with setupapi.lib.

See Also

Overview, Functions, SetupGetIntField, SetupGetBinaryField, SetupGetMultiSzField