Home
Products
Technical Help
Product Updates
Online Registration
Ordering

Baud Rate and Data Format Properties

BaudRate - Controls the data transmission rate.
Parity - Sets the parity to use.
StopBits - Sets the number of stop bits to use.
WordLength - Controls the number of data bits to use.

Buffer Status and Control Properties

BytesInReceiveBuffer - Returns the number of bytes currently in the receive buffer.
BytesInTransmitBuffer - Returns the number of bytes currently in the transmit buffer.
CommEventPending -True if a CommEvent is pending in SI_COMM's Event Queue.
EventQueueSize - Sets the size of the internal Event Queue.
InBufferSize - Controls the size of the receive buffer to allocate.
InBufferTransferSize - Sets the limit on the maximum amount of data to transfer to your program on read operations.
OutBufferSize - Controls the size of the transmit buffer to allocate.

Callback Event Properties

DeltaCTS - When set to True a CommEvent of type CTSEvt will be generated when CTS changes.
DeltaDCD - When set to True a CommEvent of type DCDEvt will be generated when DCD changes.
DeltaDSR - When set to True a CommEvent of type DSREvt will be generated when DSR changes.
DeltaRI - When set to True a CommEvent of type RIEvt will be generated when RI changes.
OnBreak - When set to True a CommEvent of type BreakEvt will be generated when a BREAK is detected.
OnFrameErr - When set to True a CommEvent of type FrameErr will be generated when a framing error occurs.
OnOverRunErr - When set to True a CommEvent of type OverRunErr will be generated on UART data over runs.
OnParityErr - When set to True a CommEvent of type ParityErr will be generated when a parity error occurs.
RxAlertCount - When set to a non zero value a CommEvent of type RxAlertEvt will be generated when the receive buffer increments to this value.
TxAlertCount - When set to a non zero value a CommEvent of type TxAlertEvt will be generated when the transmit buffer decrements to this value.
WaitCTSOff - When set to a non zero value a timed event is created. If the state of CTS goes low within the specified period a CommEvent of type WaitCTSOffEvt is generated. If the period expires a CommEvent of type WaitCTSOffTimeOut is generated.
WaitCTSOn - When set to a non zero value a timed event is created. If the state of CTS goes high within the specified period a CommEvent of type WaitCTSOnEvt is generated. If the period expires a CommEvent of type WaitCTSOnTimeOut is generated.
WaitDCDOff - When set to a non zero value a timed event is created. If the state of DCD goes low within the specified period a CommEvent of type WaitDCDOffEvt is generated. If the period expires a CommEvent of type WaitDCDOffTimeOut is generated.
WaitDCDOn - When set to a non zero value a timed event is created. If the state of DCD goes high within the specified period a CommEvent of type WaitDCDOnEvt is generated. If the period expires a CommEvent of type WaitDCDOnTimeOut is generated.
WaitDSROff - When set to a non zero value a timed event is created. If the state of DSR goes low within the specified period a CommEvent of type WaitDSROffEvt is generated. If the period expires a CommEvent of type WaitDSROffTimeOut is generated.
WaitDSROn - When set to a non zero value a timed event is created. If the state of DSR goes high within the specified period a CommEvent of type WaitDSROnEvt is generated. If the period expires a CommEvent of type WaitDSROnTimeOut is generated.
WaitRIOff - When set to a non zero value a timed event is created. If the state of RI goes low within the specified period a CommEvent of type WaitRIOffEvt is generated. If the period expires a CommEvent of type WaitRIOffTimeOut is generated.
WaitRIOn - When set to a non zero value a timed event is created. If the state of RI goes high within the specified period a CommEvent of type WaitRIOnEvt is generated. If the period expires a CommEvent of type WaitRIOnTimeOut is generated.
WaitRxChar - Setting this property to a value between 0-255 will cause SI_COMM to wait for the specified byte value to be received. When the value is received a CommEvent of type RxCharEvt is generated.
WaitTxChar - Setting this property to a value between 0-255 will cause SI_COMM to wait for the specified byte value to be transmitted. When the value is transmitted a CommEvent of type TxCharEvt is generated.

Extended Error Information

ExtErr - This property will contain additional information about the last error to occur in the ActiveX. A table of this properties values is included with the documentation.

Flow Control and File Transfer

AsyncMode - When set to True instructs SI_COMM to perform all file transfer operations on their own thread.
InBufHighMark - Controls the value of the high water mark used during flow control.
InBufLowMark - Controls the value of the low water mark used during flow control.
TransferAbort - When set to True will abort the current file transfer.
XOFF - Gets or sets the value to signify “xoff” from the remote machine when using XON/XOFF handshaking.
XON - Gets or sets the value to signify “xon” from the remote machine when using XON/XOFF handshaking.
XXOFF - Gets or sets the value to be used as a “xoff” to the remote machine when using XON/XOFF handshaking.
XXON - Gets or sets the value to be used as a “xon” to the remote machine when using XON/XOFF handshaking.

Port and Hardware Properties

BaseAddress - Holds the base address of the UART on the card. This property is only used when using SI_COMM with WCSC/VxD
CardType - Sets the communication driver that SI_COMM will use.
Irq - Holds the Interrupt Request Level of communications port. This property is only used when using SI_COMM with WCSC/VxD
PortNumber - This property is used to specify what communications port to use when using SI_COMM with the standard Windows Driver
PortOpen - This property controls the state of the communications port.
Use16550 - Setting this property to True instructs SI_COMM to check for the presence of a 16550 series UART and enable FIFOS if found.

Modem Control Properties

ModemAnswerCmd - String to be sent to the modem to put it into answer mode.
ModemCarrierSpeed - Returns the carrier speed of the currently connected modem.
ModemCarrierSpeedMsg - String returned from the modem when it has detected the carrier speed.
ModemCmdStringPaceTime - Controls the delay time introduced between characters, when a command string is sent to the modem.
ModemCommandPrefix - String to be used as a command prefix to the modem.
ModemCommandSuffix - String to be used as the modems command suffix.
ModemConfigurator - Setting this design time only property to True causes SI_COMM to display the Modem Configuration screen. This screen allows you to visually edit and review all the modem related properties.
ModemConnectFailureMsg - String that represents the response code from the modem when it is unable to synchronize to another modem.
ModemConnectSpeed - Returns the connect speed of the currently connected modem.
ModemConnectSuccessMsg - String that represents the response code from the modem when a successful connection to another modem has been made.
ModemConnectTime - Controls how long to wait for the modem to successfully synchronize with another modem.
ModemEchoTime - Controls how long to wait for a character echo from the modem.
ModemErrorMsg - String that represents the response code from the modem when a command sent to the modem was in error.
ModemEscCmd - String that represents the modems escape sequence.
ModemEscStringPaceTime - Controls the delay time introduced between characters, when the modems escape sequence is sent.
ModemHangUpCmd - String to be sent to the modem when SI_COMM needs to instruct it to hang up the phone line.
ModemInitCmd - Command string to send to the modem for initialization.
ModemLineBusyMsg - String that represents the response code from the modem when the phone line is busy.
ModemNoDialToneMsg - String that represents the response code from the modem when no dial tone is detected on the line.
ModemPulseDialCmd - String to be sent to the modem to instruct it to use pulse dialing.
ModemResetCmd - String to be sent to the modem when SI_COMM needs to instruct it to reset.
ModemResetTime - Controls the pulse time to use when pulsing the DTR signal.
ModemResponseTime - Controls how long to wait for a response from the modem.
ModemSuccessMsg - String that represents the response code from the modem when a command has completed successfully.
ModemToneDialCmd - String to be sent to the modem to instruct it to use tone dialing when dialing a phone number.
ModemVerboseCmd - String to be sent to the modem to put it into verbose command mode.

RS-232 Signal Properties

Break - The Break property when set to True asserts the break signal on the serial line.
CTS - Retrieves the state of the Clear To Send signal of the communications port.
DCD - Retrieves the state of the Data Carrier Detect signal of the communications port.
DSR - Retrieves the state of the Data Set Ready signal of the communications port.
DTR - Sets the state of the Data Terminal Ready signal of the communications port.
RI - Retrieves the state of the Ring Indicator signal of the communications port.
RTS - Sets the state of the Request To Send signal of the communications port.
DTROnInit - The DTROnInit Property controls the state of the DTR signal during port initialization. You can instruct SI_COMM to raise, drop, or leave the signal unchanged.
RTSOnInit - The RtsOnInit Property controls the state of the Rts signal during port initialization. You can instruct SI_COMM to raise, drop, or leave the signal unchanged.

Timing Releated Properties 

CommTicks - Specifies the time calibration for a CommTick. SI_COMM uses this measure for various timing purposes.
IOTimeOut - Controls the amount of time SI_COMM's data I/O functions wait for data to accumulate in the receive buffer, or space to free up in the transmit buffer before returning an error. This properties units are in CommTicks.
PaceTime - Controls the amount of inter character delay to introduce between transmitted characters. This properties units are measured in CommTicks.
TimerExpired - Property reflects the state of the most recent call to the method SetTimer. You can poll this variable to determine when the time period specified in the SetTimer call has expired.

Tracer Control Properties

TracerCaptureFileName - The TracerCaptureFileName property controls the name and path of the file to use when recording Tracer information to disk.
TracerEnabled - Setting this property False instructs the Tracer to stop recording.
TracerFileCapture - This property when set to True instructs the Tracer to open/create the a capture file.
TracerShowEvents - This property when set to False instructs the Tracer not to show SI_COMM Events in its trace window.
TracerShowMethods - This property when set to False instructs the Tracer not to show SI_COMM Methods in its trace window.
TracerShowProperties - This property when set to False instructs the Tracer not to show Property Gets or Sets in its trace window.
TracerVisible - The TracerVisible property determines whether the Tracer appears on screen.

SI_COMM Events

CommEvent - This event is generated when one of the predefined event properties is set to True and its corresponding event occurs. The event is passed an integer variable that describes the nature of the event. See the section Callback Event Properties above for more information on the types of events generated.
TransferInitialize Event - The TransferInitialize event is fired when a new file transfer initiates. The event is passed the name of the file that is about to begin transfer. File transfer can be aborted by setting the TransferAbort property to True.
TransferStatus Event - The TransferStatus event is fired periodically during a file transfer operation. The event is passed a wide range of statistics that reflect the state of the transfer.
TransferComplete Event - The TransferComplete event is fired upon completion of a file transfer operation.

Data Transfer Methods

GetByte - Retrieves the next byte of data waiting in the receive buffer.
GetPacket - Retrieves a packet of data into a byte array.
GetString - Retrieves waiting data into a string.
PeekByte - Method non-destructively removes the next waiting data byte.
PutByte - Queues a byte for transmission.
PutPacket - Queues a byte array for transmission.
PutString - Queues a string for transmission.
WaitFor - Method outputs a string and waits for a specific response. All data up to the last character in the response is thrown away.
WaitForPeek - Method outputs a string and waits for a specific response. All data up to the last character in the response is stored in the receive buffer.

File Transfer Methods

The following methods support XMODEM, XMODEM 1K, YMODEM, YMODEM Batch, YMODEM G, YMODEM G Batch, ZMODEM, and XMODEM(Checksum).

ReceiveFile - This method will receive a specified file (or files) from a remote machine using any of the above mention protocols.
SendFile - This method will transmit a specified file (or files) to a remote machine using any of the above mention protocols.

Modem Methods

Dial - Dials the requested telephone number using tone or pulse dialing.
ModemAnswerMode - Puts the modem into answer mode.
ModemAttention - Puts the modem into the command state.
ModemConnect - This method should be called right after a call to the Dial method. Method waits for a successful connect to another modem, or returns the appropriate error code.
ModemHangUp - Method hangs up a connected modem.
ModemInit - Method sends the value contained in the ModemInitCmd Property to the modem.

Miscellaneous Methods

Crc16 - Method computes the 16 bit CRC of a specified packet.
Crc32 - Method computes the 32 bit CRC of a specified packet.
FlushRxBuffer - Purges all data in the Receive Buffer.
FlushTxBuffer - Purges all data in the Transmit Buffer.
RetrieveNextCommEvent - Returns the next CommEvent in the Event Queue.
SendBreak - Method will assert the break state for a specified number of CommTicks.
SetBaudDivisor - Method sets the baud rate divisor on 8250 style UARTS.
SetTimer - Method initializes SI_COMM's internal timer to the number of CommTicks specified.
Sleep - Method suspends program execution for the specified number of CommTicks.

Tracer Control Methods

InvokeTracer - Method will invoke an instance of the SI_COMM Tracer executable. From within the SI_COMM Tracer you can analyze the sequence of calls your program makes into the SI_COMM ActiveX, as well as data values passed to and from the ActiveX. This can be an extremely useful debugging aid.
TerminateTracer - This method closes the instance of the SI_COMM Tracer created from a InvokeTracer call.

Send mail to webmaster@sinnovations.com with questions or comments about this web site.
Copyright 1999-2007 Software Innovations Inc.
This page last updated on 03/04/2007