Xantech CRM-WIC, Reference Manual

Page: 56 / 99

56
Serial_Read ( Port )
Returns the contents of the serial read buffer for the specified serial port.
Syntax
HRESULT Serial_Read(
[in] long Port,
[out, retval] BSTR* Read
);
Parameters
Port [in] Port number for the serial port. Valid values are 1 and 2.
Read [out, retval] URL encoded string read from the specified port.
Remarks
The string returned by this method is in URL encoded format. Once the data is read from the buffer, the contents of the
serial read buffer are cleared.
Serial_ClearReadBuffer ( Port )
Clears the contents of the read buffer for the specified port.
Syntax
HRESULT Serial_ClearReadBuffer(
[in] long Port,
[out, retval] VARIANT_BOOL* Success
);
Parameters
Port [in] Port number for the serial port. Valid values are 1 and 2.
Success [out, retval] TRUE if the buffer was cleared, FALSE if buffer failed to clear.
Remarks
If you wish to read a specific response to a sent command, then make a call to this function just prior to calling Serial_Send.
Serial_ReadBufferCount ( Port )
Returns the number of characters in the read buffer for the specified port. The maximum number of characters stored by the
circular buffer is 4K.
Syntax
HRESULT Serial_ReadBufferCount(
[in] long Port,
[out, retval] long* Count
);
Parameters
Port [in] Port number for the serial port. Valid values are 1 and 2.
Count [out, retval] Number of characters currently in the receive buffer.