Si_close, Si_read, Si_close -4 – INFICON MDC-260 Thin Film Deposition Controller User Manual
Page 142: Si_read -4
MDC-260 DEPOSITION CONTROLLER
COMPUTER INTERFACE
11-4
SI_Close
Description:
Closes an “open” MDC-260 using the handle provided by
SI_Open and sets the handle to INVALID_HANDLE_VALUE.
Prototype:
SI_STATUS SI_Close (HANDLE& Handle)
Parameters:
1.
Handle – Handle to the MDC-260 to “close” as returned by
SI_Open (passed by reference).
Return Value:
SI_STATUS
=
SI_SUCCESS or (0x00)
SI_INVALID_HANDLE
(0x01)
SI_Read
Description:
Reads the specified number of bytes into the specified buffer and
retrieves the number of bytes read. Given valid input
parameters, this function is blocking until the specified number
of bytes become available or a timeout occurs (see
SI_SetTimeouts)
NOTE:
If timeouts are set to zero this function is not blocking
and will immediately return the current number of bytes
available in the MDC-260 driver buffer. This may be less than
the requested number of bytes (zero bytes if there is no data
available), so make sure to check the read size return values in
this scenario.
Prototype:
SI_STATUS SI_Read (HANDLE Handle, LPVOID
Buffer, DWORD NumBytesToRead, DWORD
*NumBytesReturned)
Parameters:
1.
Handle – Handle to the MDC-260 as returned by SI_Open.
2.
Buffer – Address of a character buffer to be filled with read
data.
3.
NumBytesToRead – Number of bytes to read from the
MDC-260 into the buffer.
4.
NumBytesReturned – Address of a DWORD which will
contain the number of bytes actually read into the buffer on
return.
Return Value:
SI_STATUS
=
SI_SUCCESS (0x00) or
SI_INVALID_REQUEST_LENGTH
(0xFF)
SI_INVALID_PARAMETER (0x06) or
SI_RX_QUEUE_NOT_READY (0x03) or
SI_INVALID_HANDLE (0x01) or
SI_READ_TIMED_OUT
(0x0d)