IOCTL_HAL_GET_DEVICE_INFO

This IOCTL provides information about the system parameters information (SPI) codes supported by the SystemParametersInfo function. A request to retrieve the SPI codes is made by calling the OEMIoControl function with IOCTL_HAL_GET_DEVICE_INFO.

Parameters

• dwIoControlCode
  [in] Set to IOCTL_HAL_GET_DEVICE_INFO to obtain information about the SPI codes supported by SystemParametersInfo.

• lpInBuf
  [in] Pointer to a DWORD containing one of the SPI_* codes shown in the following table.

  Value	Description
  SPI_GETPLATFORMTYPE	String that specifies the type of device.
  SPI_GETOEMINFO	String that specifies OEM information. This information distinguishes this device from others of the same type.

• nInBufsize
  [in] Size, in bytes, of lpInBuf, which must be 4.

• lpOutBuf
  [out] Pointer to the output buffer supplied by the caller. Your OEM adaptation layer (OAL) implementation should place the information requested by the parameters dwIoControlCode and lpInBuf into lpOutBuf, set lpBytesReturned to indicate the size of the data in lpOutbuf, and then return TRUE*.*

  If the size of the requested information exceeds the output buffer size specified by nOutBufSize, specify the required size in lpBytesReturned. Then, call the SetLastError function with the flag ERROR_INSUFFICIENT_BUFFER and return the value FALSE. This enables the calling application to allocate sufficient buffer space before calling IOCTL_HAL_GET_DEVICE_INFO.

• nOutBufSize
  [in] Specifies the maximum number of bytes that can be returned in lpOutBuf. The caller sets this value.

• lpBytesReturned
  [in] Number of bytes returned in lpOutBuf.

Return Values

TRUE indicates success. FALSE indicates failure.

Requirements

OS Versions: Windows CE 3.0 and later.
Header: Pkfuncs.h.

See Also

IOCTL_HAL_SET_DEVICE_INFO | OEMIoControl | SetLastError | SystemParametersInfo | Providing System Information

Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.