Share via


IOCTL_OAL_READBUSDATA (Compact 2013)

10/16/2014

This I/O control message is a subcode of IOCTL_HAL_DDK_CALL, which is used by the implementation of Ceddk.dll as ported by the OEM to their platform. It is only called in the context of Ceddk.dll. It can be customized by OEMs to meet the needs of their platforms. Send this message with OEMIoControl.

Syntax

BOOL OEMIoControl(
    DWORD dwIoControlCode,    // use IOCTL_OAL_READBUSDATA
    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_OAL_READBUSDATA for this operation.
  • lpInBuffer
    [in] Set to NULL.
  • nInBufferSize
    [in] Set to zero.
  • lpOutBuffer
    [out]. [in] Pointer to an OAL_DDK_PARAMS structure that describes the bus data being read.
  • nOutBufferSize
    [in] Set to sizeof(OAL_DDK_PARAMS).
  • lpBytesReturned
    [in] Set to NULL.

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.

This subcode reads data from bus address specified in the OAL_DDK_PARAMS parameter into a buffer, also specified in the structure. The lpBytesReturned parameter is not accessed.

The rc member of OAL_DDK_PARAMS provides status, if the KernelIoControl call succeeds.

Requirements

Header

oal_io.h

See Also

Reference

OAL I/O IOCTLs
IOCTL_OAL_WRITEBUSDATA