IOCTL_HAL_GET_UUID (Compact 2013)

10/16/2014

This I/O control message is obsolete, starting with Windows Embedded Compact 2013. Its functionality has been integrated into IOCTL_HAL_GET_DEVICE_INFO, where using the SPI_GETUUID DWORD is synonymous with IOCTL_HAL_GET_UUID.

This I/O control message returns the universally unique identifier (UUID). The UUID is a 16-byte integer that is represented as a string and is guaranteed to be unique. Send this message with OEMIoControl.

Syntax

BOOL OEMIoControl(
    DWORD dwIoControlCode,    // use IOCTL_HAL_GET_UUID
    LPVOID lpInBuffer,        // pointer to input buffer
    DWORD nInBufferSize,      // input buffer size
    LPVOID lpOutBuffer,       // pointer to output buffer
    DWORD nOutBufferSize,     // output buffer size
    LPDWORD lpBytesReturned   // number of bytes returned
);

Parameters

• dwIoControlCode
  [in] Control code for the operation. Use IOCTL_HAL_GET_UUID for this operation.

  The OEM must implement the section of code in the OAL to handle the call to the KernelIoControl function.

• lpInBuffer
  [in] Set to NULL.

• nInBufferSize
  [in] Set to zero.

• lpOutBuffer
  [in][out] On input, set to the address of an allocated UUID structure. On output, a filled UUID structure.

• nOutBufferSize
  [in] Set to the size of the UUID structure.

• lpBytesReturned
  [in][out] On input, address of a DWORD that receives the size in bytes of the data returned. On output, set to the number of bytes written to the supplied buffer.

Return Values

Returns TRUE if successful; otherwise, returns FALSE.

Remarks

To get extended error information, call GetLastError. GetLastError may return other standard error messages as appropriate. If GetLastError returns ERROR_NOT_SUPPORTED, this I/O control is not supported on the device. If GetLastError is equal to ERROR_INSUFFICIENT_BUFFER, the buffer passed into the KernelIoControl function was not large enough. If GetLastError is equal to ERROR_INVALID_PARAMETER, the parameters to the function were invalid.

Remarks

If support is not provided for this I/O control within the OEMIoControl function or if the request fails, the return value is FALSE.

Requirements

See Also

Reference

Device Information IOCTLs
OEMIoControl