beautypg.com

Host api functions, Si_getnumdevices, Unctions – INFICON MDC-260 Thin Film Deposition Controller User Manual

Page 140: Si_getnumdevices -2

background image

MDC-260 DEPOSITION CONTROLLER

COMPUTER INTERFACE

11-2

11.2 HOST API FUNCTIONS
The following is a list of the host API functions:

SI_GetNumDevices()

- Returns the number of MDC-260s connected to

the host

SI_GetProductString ()

- Returns the USB descriptor for a given

MDC-260

SI_Open ()

– “Opens” an MDC-260 and returns a handle

SI_Close()

- Cancels pending IO and “closes” an MDC-260

SI_Read()

- Reads a block of data from an MDC-260

SI_Write()

- Writes a block of data to an MDC-260

SI_SetTimeouts()

- Sets read and write block timeouts

SI_GetTimeouts ()

- Gets read and write block timeouts

SI_SetBaudRate()

- Sets the specified Baud Rate

In general, communication with the MDC-260 is initiated by making a call to
SI_GetNumDevices. This call will return the number of MDC-260s currently
connected the host. This number is then used as a range when calling
SI_GetProductString to build a list of MDC-260 serial numbers or description
strings.

To access an MDC-260, it must first be “opened” by a call to SI_Open using an
index determined from the call to SI_GetNumDevices. The SI_Open function will
return a handle to the MDC-260 that is to be used in all subsequent accesses.
Data I/O is performed using the SI_Write and SI_Read functions. When I/O
operations are complete, the MDC-260 is “closed” by a call to SI_Close.

Below is a detailed look at each of the host API functions:

SI_GetNumDevices

Description:

This function returns the number of MDC-260s currently

connected to the host.

Prototype:

SI_STATUS SI_GetNumDevices (LPDWORD
NumDevices)

Parameters:

1.

NumDevices – Address of a DWORD variable that will

contain the number of MDC-260s connected on return.

Return Value:

SI_STATUS

=

SI_SUCCESS (0x00) or

SI_DEVICE_NOT_FOUND (0xFF) or

SI_INVALID_PARAMETER

(0x01)