Share via

IOCTL_HAL_GET_IP_ADDR (Compact 2013)

  • Article

10/16/2014

This I/O control message is not supported. It supports retrieval of target device Ethernet address information provided in the EDBG_ADDR structure. Send this message with OEMIoControl.

Syntax

BOOL OEMIoControl(
    DWORD dwIoControlCode,    // use IOCTL_HAL_GET_IP_ADDR
    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_IP_ADDR for this operation.

  • lpInBuffer
    [in] Pointer to the input buffer that can contain additional information associated with dwIoControlCode. If NULL, the value IPINFO_DOWNLOAD is assumed. Otherwise, this parameter should be a pointer to a DWORD, which can be one of the following values:

    • IPINFO_DEBUGMSG
    • IPINFO_KDEBUG
    • IPINFO_ESHELL
    • IPINFO_DOWNLOAD
    • Platform-specific extension
  • nInBufferSize
    [in] Set to zero if lpInBuffer is NULL; otherwise set to 4, which is the length of the lpInBufferDWORD value.

  • lpOutBuffer
    [out] Pointer to the output buffer supplied by the caller. The OAL should fill this buffer with an IP_INFO structure based on dwIoControlCode and lpInBuffer into this parameter, set lpBytesReturned to indicate the size of the IP_INFO structure, and return TRUE.

    If the size of the requested information exceeds the buffer size specified by nOutBufferSize, call SetLastError with the ERROR_INSUFFICIENT_BUFFER flag and return the value FALSE.

  • nOutBufferSize
    The caller sets this value.
  • lpBytesReturned
    [in] Number of bytes returned in lpOutBuffer.

Return Values

Returns TRUE if successful; otherwise, returns FALSE.

Requirements

Header

pkfuncs.h

See Also

Reference

Other OAL IOCTLs
OEMIoControl
EDBG_ADDR