TSI Incorporated 8587A, Operation And Service Manual

Page: 75 / 85

Technical Information for Program Development Using USB Communications C-7
C o m m u n i c a t i n g w i t h t h e A t t a c h e d D e v i c e
TsiUsbTerminalTransmit
The TsiUsbTerminalTransmit() method writes data to the device.
DWORD TsiUsbTerminalTransmit(IN HANDLE hDevice,
IN LPVOID pXmitBuff,
IN DWORD xmitBuffSize,
IN WORD nTransID,
IN OUT PULONG pStatus,
IN OUT LPDWORD lpNumberOfBytesWritten,
IN WORD wEndpoint =
TSI_USB_TERMINAL_READ_EP );
Parameter Description Type
hDevice
The handle to the connected device
returned from DeviceOpen().
HANDLE
pXmitBuff
A pointer to the buffer of data being sent to
the device.
PVOID or void*
xmitBuffSize
The size in bytes of the data being
transferred to the device.
DWORD or Unsigned LONG
nTransID
The transaction ID of this read transfer. The
transaction ID is a value 0x80
– 0xff that will
allow matching a response to a request.
This is defaulted to 0x80 and only
necessary for asynchronous requests and
responses.
WORD or Unsigned short
pStatus
A pointer to the status returned from the
device. PULONG or pointer to an
unsigned long
lpNumberOfBytesWritten
A pointer to the number of bytes written to
the device. LPDWORD or pointer to an
unsigned long
wEndpoint
The index of the device endpoint to write the
command. Unless this is documented as
different use the default endpoint.
WORD
Return value:
A successful return Win32 Error Code value is Zero or
ERROR_SUCCESS.
A non-successful return Win32 Error Code value is non-zero corresponding
to any valid Win32 Error Code.
This command does have a Status return from the device. A returned
status (referenced by pStatus) of 0x0000 or USB_OK as well as a win32 is
a successful return of ERROR_SUCCESS is a successful
TsiUsbTerminalTransmit request.
A returned status (referenced by pStatus) of
USB_ERROR_BUFFER_FULL
0x0011 indicates that the device output buffer is full.