
UDI Services
3-56
Universal Debugger Interface Specification
UDIDFEGetInput
Call
UDIDFEGetInput UDIParams((
UDIHostMemPtr
UDIIOType
UDISizeT
UDIMode
UDISizeT *
));
Buf,
IOType,
BufSize,
Mode
CountDone
/* Out */
/* In */
/* In */
/* Out */
Description
This function is provided by the DFE and called by the TIP. The TIP is only
allowed to call this function while in the process of handling a request from
the DFE.
Buf
is a set of maximum
BufSize
bytes that the TIP wants the DFE to
fill with input from the user.
Mode
indicates the mode to be used to get the
input, the default is line–buffered, echoed, with editing. Other modes are
described under the description of the
UDIStdinMode
call.
IOType
can be one
of the following:
UDIIOTypeTIPStdin
UDIIOTypeTargetStdin
In other words,
IOType
indicates the destination of the input (TIP or Target). A
DFE may want to get input from the user differently, depending on the
IOType
, for example, a windowed debugger may get TIP input and target input
from different windows. On return, the DFE sets
CountDone
to indicate how
many bytes were actually input from the user.
Using
UDIIOTypeTIPStdin
allows the TIP to get a response from the user to
let the TIP know how to proceed while handling a UDI request. It is often used
together with
UDIDFEPutOutput
(with parameter
UDIIOTypeTIPStdout
),
which presents TIP–specific information to the user.
Using
UDIIOTypeTargetStdin
allows the TIP to get input from the DFE for a
running program. This represents an alternative to returning
UDIStdInNeeded
from
UDIWait
and waiting for the DFE to call
UDIPutStdin
. For some TIPs,
this may be a simpler alternative.