SetupGetBinaryField
[New
- Windows NT]
The SetupGetBinaryField
function retrieves binary data from a line in an INF file section, from the
specified field to the end of the line.
BOOL SetupGetBinaryField(
|
PINFCONTEXT Context, |
// context of a
line in an INF file |
|
DWORD FieldIndex, |
// index of the
starting field |
|
BYTE * ReturnBuffer, |
// optional,
receives the fields |
|
DWORD ReturnBufferSize, |
// size of the
supplied buffer |
|
LPDWORD RequiredSize |
// optional,
buffer size needed |
|
); |
|
Parameters
Context
Supplies INF
context for the line.
FieldIndex
The 1-based
index of the starting field within the specified line from which the binary
data should be retrieved. The binary data is built from each field, starting at
this point to the end of the line. Each field corresponds to 1 byte and is in
hexadecimal notation. A FieldIndex of 0 is not valid with this function.
ReturnBuffer
This optional
parameter points to a caller-supplied buffer that receives the binary data.
ReturnBufferSize
Specifies the
size of the buffer pointed to by ReturnBuffer.
RequiredSize
This optional
parameter points to a caller-supplied variable that receives the required size
for the buffer pointed to ReturnBuffer. If the size needed is larger
than the value specified by ReturnBufferSize, the function fails and a
call to GetLastError
returns ERROR_INSUFFICIENT_BUFFER.
Return Values
If the
function succeeds, the return value is TRUE.
If the
function fails, the return value is FALSE. To get extended error information,
call GetLastError.
GetLastError returns ERROR_INVALID_DATA if a field that SetupGetBinaryField
retrieves is not a valid hexadecimal number in the range 0-FF.
Remarks
To better
understand how this function works, consider the following line from an INF
file.
X=34,FF,00,13
If SetupGetBinaryField
was called on the preceding line, the binary values 34, FF, 00, and 13
would be put into the buffer specified by ReturnBuffer.
For the
Unicode version of this function, the buffer sizes ReturnBufferSize and RequiredSize
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 TRUE. Otherwise, the return value is FALSE 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.
See Also