OALIoCtlHalGetDeviceInfo (Windows Embedded CE 6.0)

1/5/2010

This function implements the IOCTL_HAL_GET_DEVICE_INFO handler. OALIoCtlHalGetDeviceInfo provides information about the system parameters information (SPI) codes supported by the SystemParametersInfo function.

Syntax

BOOL OALIoCtlHalGetDeviceInfo(
  UINT32 dwIoControlCode,
  VOID* lpInBuf,
  UINT32 nInBufSize,
  VOID* lpOutBuf,
  UINT32 nOutBufSize,
  UINT32* lpBytesReturned
);

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_GETBOOTMENAME	Returns the device BOOTME name (i.e. "CEPC53902"). This is synonymous with using PlatformID in IOCTL_HAL_GET_DEVICEID.
  SPI_GETGUIDPATTERN	Returns platform-specific GUID pattern.
  SPI_GETOEMINFO	Returns a string containing the model number and manufacturer name. This information distinguishes the device from others of the same type.
  SPI_GETPLATFORMMANUFACTURER	Returns a human readable, not-null text string for the platform manufacturer (OEM) name. The string must be at least one character in length.
  SPI_GETPLATFORMNAME	Returns a human readable, not-null text string for the platform (product) release name (i.e. "CEPC"). The string must be at least one character in length. Synonymous with using PresetID in IOCTL_HAL_GET_DEVICEID.
  SPI_GETPLATFORMTYPE	Returns a string specifying the type of Windows Embedded CE device. This string allows applications to determine the device type.
  SPI_GETPLATFORMVERSION	Assigns a version number to an OEM OS design when used in conjunction with the SPI_GETPLATFORMTYPE IOCTL. For more information, see Implementation of the SPI_GETPLATFORMVERSION IOCTL. Returns {{CE_MAJOR_VER, CE_MINOR_VER}}, regardless of platform.
  SPI_GETPROJECTNAME	Returns a project description string (i.e. "CEBase").
  SPI_GETUUID	Returns hardware-unique bytes for the platform. The expected return size is the size of a GUID: 16 bytes.

• 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 Value

TRUE indicates success.

FALSE indicates failure.

Requirements

See Also

Reference

IOCTL Functions
IOCTL_HAL_SET_DEVICE_INFO
OEMIoControl

Concepts

Providing System Information

Other Resources

SetLastError
SystemParametersInfo