CommInterface.au3 - Revision history

Therealhanuta: fix error in _CommAPI_ReceiveBinary

2014-04-08T13:30:37Z

fix error in _CommAPI_ReceiveBinary

← Older revision		Revision as of 13:30, 8 April 2014
Line 4:		Line 4:
	; Title .........: Communications Functions of Windows API		; Title .........: Communications Functions of Windows API
	; Description ...: Communications Functions of Windows API calls that have been translated to AutoIt functions.		; Description ...: Communications Functions of Windows API calls that have been translated to AutoIt functions.
	; Version Date ..: 2014-04-07		; Version Date ..: 2014-04-08
	; AutoIt Version : 3.3.8.1		; AutoIt Version : 3.3.8.1
	; Link ..........: http://msdn.microsoft.com/en-us/library/aa363194(v=vs.85).aspx		; Link ..........: http://msdn.microsoft.com/en-us/library/aa363194(v=vs.85).aspx
Line 177:		Line 177:
	$bResult &= BinaryMid(Binary(DllStructGetData($tBuffer, 1)), 1, 1)		$bResult &= BinaryMid(Binary(DllStructGetData($tBuffer, 1)), 1, 1)
	$iResLength = BinaryLen($bResult)		$iResLength = BinaryLen($bResult)
	If $iResLength = $iMaxLength ~~And $iMaxLength > 0~~ Then Return $bResult		If $iMaxLength And $iResLength = $iMaxLength Then Return $bResult
	If $bSeparator = BinaryMid($bResult, 1 + $iResLength - $iSepLength) Then Return BinaryMid($bResult, 1, $iResLength - $iSepLength)		If $iSepLength And $bSeparator = BinaryMid($bResult, 1 + $iResLength - $iSepLength) Then Return BinaryMid($bResult, 1, $iResLength - $iSepLength)
	Else		Else
	If $bResult And Not $iSepLength Then Return $bResult		If $bResult And Not $iSepLength Then Return $bResult
	If $iTimeout ~~> 0~~ And $iTimeout < TimerDiff($hTimer) Then Return SetError(-2, @ScriptLineNumber, $bResult)		If $iTimeout And $iTimeout < TimerDiff($hTimer) Then Return SetError(-2, @ScriptLineNumber, $bResult)
	EndIf		EndIf
	WEnd		WEnd

Therealhanuta at 11:18, 7 April 2014

2014-04-07T11:18:58Z

← Older revision		Revision as of 11:18, 7 April 2014
Line 167:		Line 167:
	Local $pBuffer = DllStructGetPtr($tBuffer)		Local $pBuffer = DllStructGetPtr($tBuffer)
	Local $iRead = 0		Local $iRead = 0
	Local $~~vResult~~ = Binary("")		Local $bResult = Binary("")
	Local $iResLength = 0		Local $iResLength = 0
	Local $hTimer = TimerInit()		Local $hTimer = TimerInit()
	While True		While True
	$fSuccess = _WinAPI_ReadFile($hFile, $pBuffer, 1, $iRead)		$fSuccess = _WinAPI_ReadFile($hFile, $pBuffer, 1, $iRead)
	If @error Then Return SetError(@error, @ScriptLineNumber, $~~vResult~~)		If @error Then Return SetError(@error, @ScriptLineNumber, $bResult)
	If Not $fSuccess Then Return SetError(-1, @ScriptLineNumber, $~~vResult~~)		If Not $fSuccess Then Return SetError(-1, @ScriptLineNumber, $bResult)
	If $iRead Then		If $iRead Then
	$~~vResult~~ &= BinaryMid(Binary(DllStructGetData($tBuffer, 1)), 1, 1)		$bResult &= BinaryMid(Binary(DllStructGetData($tBuffer, 1)), 1, 1)
	$iResLength = BinaryLen($~~vResult~~)		$iResLength = BinaryLen($bResult)
	If $iResLength = $iMaxLength And $iMaxLength > 0 Then Return $~~vResult~~		If $iResLength = $iMaxLength And $iMaxLength > 0 Then Return $bResult
	If $bSeparator = BinaryMid($~~vResult~~, 1 + $iResLength - $iSepLength) Then Return BinaryMid($~~vResult~~, 1, $iResLength - $iSepLength)		If $bSeparator = BinaryMid($bResult, 1 + $iResLength - $iSepLength) Then Return BinaryMid($bResult, 1, $iResLength - $iSepLength)
	Else		Else
	If $~~vResult~~ And Not $iSepLength Then Return $~~vResult~~		If $bResult And Not $iSepLength Then Return $bResult
	If $iTimeout > 0 And $iTimeout < TimerDiff($hTimer) Then Return SetError(-2, @ScriptLineNumber, $~~vResult~~)		If $iTimeout > 0 And $iTimeout < TimerDiff($hTimer) Then Return SetError(-2, @ScriptLineNumber, $bResult)
	EndIf		EndIf
	WEnd		WEnd
	~~Return $vResult~~
	EndFunc ;==>_CommAPI_ReceiveBinary		EndFunc ;==>_CommAPI_ReceiveBinary

Therealhanuta at 11:01, 7 April 2014

2014-04-07T11:01:50Z

← Older revision		Revision as of 11:01, 7 April 2014
Line 1:		Line 1:
	[[Category:Script]]<syntaxhighlight lang="autoit">		[[Category:CommAPI]][[Category:Script]]<syntaxhighlight lang="autoit">
	; #INDEX# =======================================================================================================================		; #INDEX# =======================================================================================================================
	; Name ..........: CommInterface.au3		; Name ..........: CommInterface.au3

Therealhanuta: replace _CommAPI_TransmitData with _CommAPI_TransmitBinary and _CommAPI_TransmitString

2014-04-07T10:56:38Z

replace _CommAPI_TransmitData with _CommAPI_TransmitBinary and _CommAPI_TransmitString

← Older revision		Revision as of 10:56, 7 April 2014
Line 4:		Line 4:
	; Title .........: Communications Functions of Windows API		; Title .........: Communications Functions of Windows API
	; Description ...: Communications Functions of Windows API calls that have been translated to AutoIt functions.		; Description ...: Communications Functions of Windows API calls that have been translated to AutoIt functions.
	; Version Date ..: 2014-04-04		; Version Date ..: 2014-04-07
	; AutoIt Version : 3.3.8.1		; AutoIt Version : 3.3.8.1
	; Link ..........: http://msdn.microsoft.com/en-us/library/aa363194(v=vs.85).aspx		; Link ..........: http://msdn.microsoft.com/en-us/library/aa363194(v=vs.85).aspx
Line 144:		Line 144:
	; $vSeparator - [in] A value which is used as a separator.		; $vSeparator - [in] A value which is used as a separator.
	; Is activated only by non-empty values.		; Is activated only by non-empty values.
	; Return values .: Success - Received binary data ~~(including separator)~~		; Return values .: Success - Received binary data
	; Failure - Received binary data		; Failure - Received binary data
	; @error - 1 unable to use the DLL file		; @error - 1 unable to use the DLL file
Line 178:		Line 178:
	$iResLength = BinaryLen($vResult)		$iResLength = BinaryLen($vResult)
	If $iResLength = $iMaxLength And $iMaxLength > 0 Then Return $vResult		If $iResLength = $iMaxLength And $iMaxLength > 0 Then Return $vResult
	If $bSeparator = BinaryMid($vResult, 1 + $iResLength - $iSepLength) Then Return $vResult		If $bSeparator = BinaryMid($vResult, 1 + $iResLength - $iSepLength) Then Return BinaryMid($vResult, 1, $iResLength - $iSepLength)
	Else		Else
	If $vResult And Not $iSepLength Then Return $vResult		If $vResult And Not $iSepLength Then Return $vResult
Line 199:		Line 199:
	; Is activated only by non-empty values.		; Is activated only by non-empty values.
	; $iFlag - [in] Flag for function BinaryToString().		; $iFlag - [in] Flag for function BinaryToString().
	; Return values .: Success - Received string ~~(including separator)~~		; Return values .: Success - Received string
	; Failure - Received string		; Failure - Received string
	; Received binary data in case of @error = -3		; Received binary data in case of @error = -3
Line 230:		Line 230:

	; #FUNCTION# ====================================================================================================================		; #FUNCTION# ====================================================================================================================
	; Name ..........: ~~_CommAPI_TransmitData~~		; Name ..........: _CommAPI_TransmitBinary
	; Description ...: Transmits data (TxD/TX/TD) to a specified communications device.		; Description ...: Transmits data (TxD/TX/TD) to a specified communications device.
	; Syntax ........: _CommAPI_TransmitData(Const $hFile, Const $sData)		; Syntax ........: _CommAPI_TransmitData(Const $hFile, Const $sData)
	; Parameters ....: $hFile - [in] A handle to the communications device.		; Parameters ....: $hFile - [in] A handle to the communications device.
	; $vData - [in] A ~~string~~ value to transmit.		; $vData - [in] A binary value to transmit.
	; Return values .: Success - Number of written bytes		; Return values .: Success - Number of written bytes
	; Failure - Number of written bytes		; Failure - Number of written bytes
Line 246:		Line 246:
	; Modified ......:		; Modified ......:
	; Remarks .......:		; Remarks .......:
	; Related .......: _CommAPI_ReceiveBinary~~, _CommAPI_ReceiveString~~		; Related .......: _CommAPI_TransmitString, _CommAPI_ReceiveBinary
	; Link ..........: http://msdn.microsoft.com/en-us/library/aa365747(v=vs.85).aspx		; Link ..........: http://msdn.microsoft.com/en-us/library/aa365747(v=vs.85).aspx
	; Example .......: No		; Example .......: No
	; ===============================================================================================================================		; ===============================================================================================================================
	Func ~~_CommAPI_TransmitData~~(Const $hFile, Const $vData)		Func _CommAPI_TransmitBinary(Const $hFile, Const $vData)
	Local $bData = Binary($vData)		Local $bData = Binary($vData)
	Local $iLength = BinaryLen($vData)		Local $iLength = BinaryLen($vData)
Line 260:		Line 260:
	If Not $fSuccess Then Return SetError(-1, @ScriptLineNumber, $iWritten)		If Not $fSuccess Then Return SetError(-1, @ScriptLineNumber, $iWritten)
	Return $iWritten		Return $iWritten
	EndFunc ;==>_CommAPI_TransmitData		EndFunc ;==>_CommAPI_TransmitBinary

			; #FUNCTION# ====================================================================================================================
			; Name ..........: _CommAPI_TransmitString
			; Description ...: Transmits data (TxD/TX/TD) to a specified communications device.
			; Syntax ........: _CommAPI_TransmitData(Const $hFile, Const $sData)
			; Parameters ....: $hFile - [in] A handle to the communications device.
			; $sData - [in] A string value to transmit.
			; $iFlag - [in] Flag for function StringToBinary().
			; Return values .: Success - Number of written bytes
			; Failure - Number of written bytes
			; @error - 1 unable to use the DLL file
			; 2 unknown "return type"
			; 3 "function" not found in the DLL file
			; 4 bad number of parameters
			; 5 bad parameter
			; -1 function fails (To get extended error information, call _WinAPI_GetLastError or _WinAPI_GetLastErrorMessage)
			; Author ........:
			; Modified ......:
			; Remarks .......:
			; Related .......: _CommAPI_TransmitBinary, _CommAPI_ReceiveString
			; Link ..........: http://msdn.microsoft.com/en-us/library/aa365747(v=vs.85).aspx
			; Example .......: No
			; ===============================================================================================================================
			Func _CommAPI_TransmitString(Const $hFile, Const $sData, Const $iFlag = 1)
			Local $iWritten = _CommAPI_TransmitBinary($hFile, StringToBinary($sData, $iFlag))
			If @error Then Return SetError(@error, @extended, $iWritten)
			Return $iWritten
			EndFunc
	</syntaxhighlight>		</syntaxhighlight>

Therealhanuta at 14:33, 4 April 2014

2014-04-04T14:33:03Z

← Older revision		Revision as of 14:33, 4 April 2014
Line 4:		Line 4:
	; Title .........: Communications Functions of Windows API		; Title .........: Communications Functions of Windows API
	; Description ...: Communications Functions of Windows API calls that have been translated to AutoIt functions.		; Description ...: Communications Functions of Windows API calls that have been translated to AutoIt functions.
	; Version Date ..: 2014-04-03		; Version Date ..: 2014-04-04
	; AutoIt Version : 3.3.8.1		; AutoIt Version : 3.3.8.1
	; Link ..........: http://msdn.microsoft.com/en-us/library/aa363194(v=vs.85).aspx		; Link ..........: http://msdn.microsoft.com/en-us/library/aa363194(v=vs.85).aspx

Therealhanuta: replace ReceiveData & ReceiveLine with ReceiveBinary & ReceiveString

2014-04-04T14:15:15Z

replace ReceiveData & ReceiveLine with ReceiveBinary & ReceiveString

Show changes

Therealhanuta: fix error in _CommAPI_TransmitData

2014-04-03T11:12:04Z

fix error in _CommAPI_TransmitData

Show changes

Therealhanuta: fix reading error Chr(128) to Chr(255)

2014-04-03T08:39:47Z

fix reading error Chr(128) to Chr(255)

← Older revision		Revision as of 08:39, 3 April 2014
Line 4:		Line 4:
	; Title .........: Communications Functions of Windows API		; Title .........: Communications Functions of Windows API
	; Description ...: Communications Functions of Windows API calls that have been translated to AutoIt functions.		; Description ...: Communications Functions of Windows API calls that have been translated to AutoIt functions.
	; Version Date ..: 2014-03~~-27~~		; Version Date ..: 2014-04-03
	; AutoIt Version : 3.3.8.1		; AutoIt Version : 3.3.8.1
	; Link ..........: http://msdn.microsoft.com/en-us/library/aa363194(v=vs.85).aspx		; Link ..........: http://msdn.microsoft.com/en-us/library/aa363194(v=vs.85).aspx
Line 150:		Line 150:
	; ===============================================================================================================================		; ===============================================================================================================================
	Func _CommAPI_ReceiveData(Const $hFile, Const $iTimeout = 1, Const $iMaxLen = 0)		Func _CommAPI_ReceiveData(Const $hFile, Const $iTimeout = 1, Const $iMaxLen = 0)
	Local $tBuffer = DllStructCreate("char")		Local $tBuffer = DllStructCreate("char[2]")
	Local $hTimer = TimerInit()		Local $hTimer = TimerInit()
	Local $iWritten = 0		Local $iWritten = 0
Line 195:		Line 195:
	; ===============================================================================================================================		; ===============================================================================================================================
	Func _CommAPI_ReceiveLine(Const $hFile, Const $sSeparator = @CRLF, Const $iTimeout = 1, Const $iMaxLen = 0)		Func _CommAPI_ReceiveLine(Const $hFile, Const $sSeparator = @CRLF, Const $iTimeout = 1, Const $iMaxLen = 0)
	Local $tBuffer = DllStructCreate("char")		Local $tBuffer = DllStructCreate("char[2]")
	Local $iLen = StringLen($sSeparator)		Local $iLen = StringLen($sSeparator)
	Local $hTimer = TimerInit()		Local $hTimer = TimerInit()

Therealhanuta: updated @error handling; new parameter MaxLen for function _CommAPI_ReceiveData; new function _CommAPI_ReceiveLine

2014-03-27T15:25:36Z

updated @error handling; new parameter MaxLen for function _CommAPI_ReceiveData; new function _CommAPI_ReceiveLine

Show changes

Therealhanuta: Update call of _WinAPI_CreateFile

2014-03-27T08:57:09Z

Update call of _WinAPI_CreateFile

← Older revision		Revision as of 08:57, 27 March 2014
Line 4:		Line 4:
	; Title .........: Communications Functions of Windows API		; Title .........: Communications Functions of Windows API
	; Description ...: Communications Functions of Windows API calls that have been translated to AutoIt functions.		; Description ...: Communications Functions of Windows API calls that have been translated to AutoIt functions.
	; Version Date ..: 2014-03-07		; Version Date ..: 2014-03-27
	; AutoIt Version : 3.3.8.1		; AutoIt Version : 3.3.8.1
	; Link ..........: http://msdn.microsoft.com/en-us/library/aa363194(v=vs.85).aspx		; Link ..........: http://msdn.microsoft.com/en-us/library/aa363194(v=vs.85).aspx
Line 83:		Line 83:
	Func _CommAPI_OpenPort(Const $sMode)		Func _CommAPI_OpenPort(Const $sMode)
	Local $sFileName = "\\.\" & StringLeft($sMode, StringInStr($sMode, ":") - 1)		Local $sFileName = "\\.\" & StringLeft($sMode, StringInStr($sMode, ":") - 1)
	Local $hFile = _WinAPI_CreateFile($sFileName, 2, ~~$GENERIC_ALL~~)		Local $hFile = _WinAPI_CreateFile($sFileName, 3, 6)
	If @error Then Return SetError(@error, @ScriptLineNumber, 0)		If @error Then Return SetError(@error, @ScriptLineNumber, 0)
	If $hFile <= 0 Then Return SetError(-1, @ScriptLineNumber, 0)		If $hFile <= 0 Then Return SetError(-1, @ScriptLineNumber, 0)