AutoIt Wiki - User contributions [en]

CommAPI

2014-04-08T13:31:19Z

Therealhanuta: /* Changelog */

[[Category:CommAPI]]CommAPI translates the communications functions of Windows API to AutoIt functions.

== Overview ==
=== Features ===
* No need to install DLL's
* Using Windows API calls (kernel32.dll)
* Possibility of serial communication (serial port, COM port, RS-232)
* Possibility of parallel communication (parallel port, LPT port)
* No use of global variables
* Uniform namespace _CommAPI_XXX
* Modular organization into files
* A lot of additional utility and helper functions

=== Scripts ===
* [[CommAPIConstants.au3]]
* [[CommAPI.au3]]
* [[CommAPIHelper.au3]]
* [[CommUtilities.au3]]
* [[CommInterface.au3]]
* [[CommObsolete.au3]] (only needed for backward compatibility)

=== Examples ===
[[CommAPI Examples]] shows you some examples. Mayby you could find more examples in [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/?p=1126366 forum].

== Background ==
=== History ===
* 2008-09-12 Creation of cfx.au3 [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/#entry578111 (V1.0)]
* 2011-02-18 Conversation of cfx.au3 into cfxUDF.au3 [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/page-2#entry872154 (V2.0)]
* 2011-02-28 Update V2.0 to [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/page-2#entry874547 V2.1]
* 2011-04-27 Update V2.1 to [http://www.autoit.de/index.php?page=Thread&postID=217993#post217993 V2.2] (german forum)
* 2013-07-10 Modify V2.1 to [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/page-2#entry1094288 V2.1mod]
* 2013-10-24 Creation of [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/ CommAPI.au3]

=== Changelog ===
; 2014-01-23
: Small update of method _CommAPI_CreateModeString
; 2014-02-03
: Change timeout handling (Attention: not backward compatible)
: Small update of method _CommAPI_PurgeComm
; 2014-03-07
: Rename CommAPIStructures.au3 to CommAPIConstants.au3
: Replace hex values with Constants
; 2014-03-27
: Update of call _WinAPI_CreateFile
: Updated @error handling
: New parameter MaxLen for function _CommAPI_ReceiveData
: New function _CommAPI_ReceiveLine
: Update existing examples and add new examples
; 2014-03-31
: Add constants
: Fix _CommAPI_WaitCommEvent
; 2014-04-03
: Fix reading error Chr(128) to Chr(255)
: Fix error in _CommAPI_TransmitData
; 2014-04-04
: Replace ReceiveData & ReceiveLine with ReceiveBinary & ReceiveString
; 2014-04-07
: replace _CommAPI_TransmitData with _CommAPI_TransmitBinary & _CommAPI_TransmitString
: Create CommObsolete.au3 for backward compatibility
; 2014-04-08
: Fix error in _CommAPI_ReceiveBinary

=== Roadmap ===
There is no roadmap in the moment. Feel free to implement the last five remaining API calls, enhance the scripts or to fix bugs.

=== Support ===
There is no official support. Try to get help from community in the official forum. [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/ Here you can find the main thread].

=== Resources ===
* [http://msdn.microsoft.com/en-us/library/aa363194(v=vs.85).aspx MSDN Library of communications functions]
* [http://www.hpcc.ecs.soton.ac.uk/software/Win32API.Txt WIN32API.TXT]
* [[CommAPI#History|cfxUDF.au3]]
* [http://www.autoit.de/index.php?page=Thread&postID=198669#post198669 GetCOMPorts] (german forum)
* [http://www.autoitscript.com/forum/topic/19713-problem-with-struct/#entry136466 ParseCommState]

== Functions ==
=== Implemented API functions ===
* BuildCommDCB
* BuildCommDCBAndTimeouts
* ClearCommBreak
* ClearCommError
* EscapeCommFunction
* GetCommMask
* GetCommModemStatus
* GetCommProperties
* GetCommState
* GetCommTimeouts
* PurgeComm
* SetCommBreak
* SetCommMask
* SetCommState
* SetCommTimeouts
* SetupComm
* TransmitCommChar
* WaitCommEvent

=== Unimplemented API functions ===
* CommConfigDialog
* GetCommConfig
* GetDefaultCommConfig
* SetCommConfig
* SetDefaultCommConfig

=== API helper functions ===
* ChangeCommStateElement
* ChangeCommTimeoutsElement
* GetCommStateElement
* GetCommTimeoutsElement
* IsOnCTS
* IsOnDCD
* IsOnDSR
* IsOnRI
* SetCommStateElement
* SetCommTimeoutsElement
* SetOnDTR
* SetOnRTS

=== Utility functions ===
* CommStateToString
* CommTimeoutsToString
* CreateModeString
* GetCOMPorts

=== Interface functions ===
* ClosePort
* OpenCOMPort
* OpenPort
* ReceiveBinary
* ReceiveString
* TransmitBinary
* TransmitString

CommInterface.au3

2014-04-08T13:30:37Z

Therealhanuta: fix error in _CommAPI_ReceiveBinary

CommInterface.au3

2014-04-07T11:18:58Z

Therealhanuta:

Category:CommAPI

2014-04-07T11:13:49Z

Therealhanuta:

[[CommAPI]] translates the communications functions of Windows API to AutoIt functions.

== Features ==
* No need to install DLL's
* Using Windows API calls (kernel32.dll)
* Possibility of serial communication (serial port, COM port, RS-232)
* Possibility of parallel communication (parallel port, LPT port)
* No use of global variables
* Uniform namespace _CommAPI_XXX
* Modular organization into files
* A lot of additional utility and helper functions

CommAPI

2014-04-07T11:13:26Z

Therealhanuta:

[[Category:CommAPI]]CommAPI translates the communications functions of Windows API to AutoIt functions.

== Overview ==
=== Features ===
* No need to install DLL's
* Using Windows API calls (kernel32.dll)
* Possibility of serial communication (serial port, COM port, RS-232)
* Possibility of parallel communication (parallel port, LPT port)
* No use of global variables
* Uniform namespace _CommAPI_XXX
* Modular organization into files
* A lot of additional utility and helper functions

=== Scripts ===
* [[CommAPIConstants.au3]]
* [[CommAPI.au3]]
* [[CommAPIHelper.au3]]
* [[CommUtilities.au3]]
* [[CommInterface.au3]]
* [[CommObsolete.au3]] (only needed for backward compatibility)

=== Examples ===
[[CommAPI Examples]] shows you some examples. Mayby you could find more examples in [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/?p=1126366 forum].

== Background ==
=== History ===
* 2008-09-12 Creation of cfx.au3 [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/#entry578111 (V1.0)]
* 2011-02-18 Conversation of cfx.au3 into cfxUDF.au3 [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/page-2#entry872154 (V2.0)]
* 2011-02-28 Update V2.0 to [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/page-2#entry874547 V2.1]
* 2011-04-27 Update V2.1 to [http://www.autoit.de/index.php?page=Thread&postID=217993#post217993 V2.2] (german forum)
* 2013-07-10 Modify V2.1 to [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/page-2#entry1094288 V2.1mod]
* 2013-10-24 Creation of [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/ CommAPI.au3]

=== Changelog ===
; 2014-01-23
: Small update of method _CommAPI_CreateModeString
; 2014-02-03
: Change timeout handling (Attention: not backward compatible)
: Small update of method _CommAPI_PurgeComm
; 2014-03-07
: Rename CommAPIStructures.au3 to CommAPIConstants.au3
: Replace hex values with Constants
; 2014-03-27
: Update of call _WinAPI_CreateFile
: Updated @error handling
: New parameter MaxLen for function _CommAPI_ReceiveData
: New function _CommAPI_ReceiveLine
: Update existing examples and add new examples
; 2014-03-31
: Add constants
: Fix _CommAPI_WaitCommEvent
; 2014-04-03
: Fix reading error Chr(128) to Chr(255)
: Fix error in _CommAPI_TransmitData
; 2014-04-04
: Replace ReceiveData & ReceiveLine with ReceiveBinary & ReceiveString
; 2014-04-07
: replace _CommAPI_TransmitData with _CommAPI_TransmitBinary & _CommAPI_TransmitString
: Create CommObsolete.au3 for backward compatibility

=== Roadmap ===
There is no roadmap in the moment. Feel free to implement the last five remaining API calls, enhance the scripts or to fix bugs.

=== Support ===
There is no official support. Try to get help from community in the official forum. [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/ Here you can find the main thread].

=== Resources ===
* [http://msdn.microsoft.com/en-us/library/aa363194(v=vs.85).aspx MSDN Library of communications functions]
* [http://www.hpcc.ecs.soton.ac.uk/software/Win32API.Txt WIN32API.TXT]
* [[CommAPI#History|cfxUDF.au3]]
* [http://www.autoit.de/index.php?page=Thread&postID=198669#post198669 GetCOMPorts] (german forum)
* [http://www.autoitscript.com/forum/topic/19713-problem-with-struct/#entry136466 ParseCommState]

== Functions ==
=== Implemented API functions ===
* BuildCommDCB
* BuildCommDCBAndTimeouts
* ClearCommBreak
* ClearCommError
* EscapeCommFunction
* GetCommMask
* GetCommModemStatus
* GetCommProperties
* GetCommState
* GetCommTimeouts
* PurgeComm
* SetCommBreak
* SetCommMask
* SetCommState
* SetCommTimeouts
* SetupComm
* TransmitCommChar
* WaitCommEvent

=== Unimplemented API functions ===
* CommConfigDialog
* GetCommConfig
* GetDefaultCommConfig
* SetCommConfig
* SetDefaultCommConfig

=== API helper functions ===
* ChangeCommStateElement
* ChangeCommTimeoutsElement
* GetCommStateElement
* GetCommTimeoutsElement
* IsOnCTS
* IsOnDCD
* IsOnDSR
* IsOnRI
* SetCommStateElement
* SetCommTimeoutsElement
* SetOnDTR
* SetOnRTS

=== Utility functions ===
* CommStateToString
* CommTimeoutsToString
* CreateModeString
* GetCOMPorts

=== Interface functions ===
* ClosePort
* OpenCOMPort
* OpenPort
* ReceiveBinary
* ReceiveString
* TransmitBinary
* TransmitString

Category:CommAPI

2014-04-07T11:05:44Z

Therealhanuta: Created page with "CommAPI translates the communications functions of Windows API to AutoIt functions. == Features == * No need to install DLL's * Using Windows API calls (kernel32.dll) * Possi..."

CommAPI translates the communications functions of Windows API to AutoIt functions.

== Features ==
* No need to install DLL's
* Using Windows API calls (kernel32.dll)
* Possibility of serial communication (serial port, COM port, RS-232)
* Possibility of parallel communication (parallel port, LPT port)
* No use of global variables
* Uniform namespace _CommAPI_XXX
* Modular organization into files
* A lot of additional utility and helper functions

CommAPI Examples

2014-04-07T11:02:51Z

Therealhanuta:

[[Category:CommAPI]][[Category:Samples]]
== Introduction ==
This site shows you some examples for [[CommAPI]].
You will also need the following snippet for all examples:

<syntaxhighlight lang="autoit">
#include "CommInterface.au3"
#AutoIt3Wrapper_Au3Check_Parameters=-q -d -w 1 -w 2 -w 3 -w- 4 -w 5 -w 6 -w- 7

Main()

Func Main()
Local $sResult = Example()
Switch @error
Case 0
MsgBox(64, "Result", $sResult)
Case -1
MsgBox(32, "Error", _WinAPI_GetLastErrorMessage())
Case -2
MsgBox(32, "Timeout", $sResult)
Case Else
MsgBox(32, "Error", "Error " & @error & " in line " & @extended)
EndSwitch
EndFunc
</syntaxhighlight>

== First example ==
<syntaxhighlight lang="autoit">
Func Example()
Local Const $iPort = 1
Local Const $iBaud = 9600
Local Const $iParity = 0
Local Const $iByteSize = 8
Local Const $iStopBits = 1
Local Const $sCommand = "Command" & @CRLF

Local $hFile = _CommAPI_OpenCOMPort($iPort, $iBaud, $iParity, $iByteSize, $iStopBits)
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_ClearCommError($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_PurgeComm($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_TransmitString($hFile, $sCommand)
If @error Then Return SetError(@error, @ScriptLineNumber)

Local $sResult = _CommAPI_ReceiveString($hFile, 5000)
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)

_CommAPI_ClosePort($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)

Return $sResult
EndFunc
</syntaxhighlight>

== INI file==
<syntaxhighlight lang="autoit">
Func Example()
Local Const $sFileINI = @ScriptDir & "\Example.ini"

Local $sMode = _CommAPI_CreateModeString( _
IniRead($sFileINI, "COM", "SerialPort", 1), _
IniRead($sFileINI, "COM", "BaudRate", 9600), _
IniRead($sFileINI, "COM", "Parity", 0), _
IniRead($sFileINI, "COM", "ByteSize", 8), _
IniRead($sFileINI, "COM", "StopBits", 1), _
IniRead($sFileINI, "COM", "XON", 0), _
IniRead($sFileINI, "COM", "DSR", 0), _
IniRead($sFileINI, "COM", "CTS", 1), _
IniRead($sFileINI, "COM", "DTR", 1), _
IniRead($sFileINI, "COM", "RTS", 1), _
IniRead($sFileINI, "COM", "IDSR", 0))
If @error Then Return SetError(@error, @ScriptLineNumber)

Local $hFile = _CommAPI_OpenPort($sMode)
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_ClearCommError($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_PurgeComm($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_TransmitString($hFile, IniRead($sFileINI, "COM", "Command", "Command" & @CRLF))
If @error Then Return SetError(@error, @ScriptLineNumber)

Local $sResult = _CommAPI_ReceiveString($hFile, IniRead($sFileINI, "Timeout", "IDSR", 5000))
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)

_CommAPI_ClosePort($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)

Return $sResult
EndFunc
</syntaxhighlight>

== Command Line ==
<syntaxhighlight lang="autoit">
Func Example()
If $CmdLine[0] <> 2 Then
MsgBox(32, "Syntax", @ScriptName & ' "ModeString" "Command"')
Exit
EndIf

Local $hFile = _CommAPI_OpenPort($CmdLine[1])
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_ClearCommError($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_PurgeComm($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_TransmitString($hFile, $CmdLine[2])
If @error Then Return SetError(@error, @ScriptLineNumber)

Local $sResult = _CommAPI_ReceiveString($hFile, 5000)
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)

_CommAPI_ClosePort($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)

Return $sResult
EndFunc
</syntaxhighlight>

<syntaxhighlight lang="winbatch">
@echo off
cls
chcp 1252>nul
cd /d "%~dp0"
start Example.exe "COM1: BAUD=9600 PARITY=N DATA=8 STOP=1 XON=OFF ODSR=OFF OCTS=ON DTR=ON RTS=ON IDSR=OFF" "Command"
</syntaxhighlight>

== Separator ==
<syntaxhighlight lang="autoit">
Func Example()
Local $hFile = _CommAPI_OpenCOMPort(1, 9600, 0, 8, 1)
If @error Then Return SetError(@error, @ScriptLineNumber)

Local $sResult = ""
While True
$sResult = _CommAPI_ReceiveString($hFile, 5000, 0, "<CR>")
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)
MsgBox(64, "Line", $sResult)
WEnd

_CommAPI_ClosePort($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)

Return $sResult
EndFunc
</syntaxhighlight>

== Slow Devices ==
For some slow devices the default timeout is too small of one millisecond.
<syntaxhighlight lang="autoit">
Func Example()
Local $hFile = _CommAPI_OpenCOMPort(1, 9600, 0, 8, 1)
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_ChangeCommTimeoutsElement($hFile, "ReadTotalTimeoutMultiplier", 100)
If @error Then Return SetError(@error, @ScriptLineNumber)

Local $sResult = _CommAPI_ReceiveString($hFile, 5000)
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)

_CommAPI_ClosePort($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)

Return $sResult
EndFunc
</syntaxhighlight>

CommAPI Examples

2014-04-07T11:02:41Z

Therealhanuta:

[[Category:CommAPI]][[Category:Samples]]== Introduction ==
This site shows you some examples for [[CommAPI]].
You will also need the following snippet for all examples:

<syntaxhighlight lang="autoit">
#include "CommInterface.au3"
#AutoIt3Wrapper_Au3Check_Parameters=-q -d -w 1 -w 2 -w 3 -w- 4 -w 5 -w 6 -w- 7

Main()

Func Main()
Local $sResult = Example()
Switch @error
Case 0
MsgBox(64, "Result", $sResult)
Case -1
MsgBox(32, "Error", _WinAPI_GetLastErrorMessage())
Case -2
MsgBox(32, "Timeout", $sResult)
Case Else
MsgBox(32, "Error", "Error " & @error & " in line " & @extended)
EndSwitch
EndFunc
</syntaxhighlight>

== First example ==
<syntaxhighlight lang="autoit">
Func Example()
Local Const $iPort = 1
Local Const $iBaud = 9600
Local Const $iParity = 0
Local Const $iByteSize = 8
Local Const $iStopBits = 1
Local Const $sCommand = "Command" & @CRLF

Local $hFile = _CommAPI_OpenCOMPort($iPort, $iBaud, $iParity, $iByteSize, $iStopBits)
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_ClearCommError($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_PurgeComm($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_TransmitString($hFile, $sCommand)
If @error Then Return SetError(@error, @ScriptLineNumber)

Local $sResult = _CommAPI_ReceiveString($hFile, 5000)
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)

_CommAPI_ClosePort($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)

Return $sResult
EndFunc
</syntaxhighlight>

== INI file==
<syntaxhighlight lang="autoit">
Func Example()
Local Const $sFileINI = @ScriptDir & "\Example.ini"

Local $sMode = _CommAPI_CreateModeString( _
IniRead($sFileINI, "COM", "SerialPort", 1), _
IniRead($sFileINI, "COM", "BaudRate", 9600), _
IniRead($sFileINI, "COM", "Parity", 0), _
IniRead($sFileINI, "COM", "ByteSize", 8), _
IniRead($sFileINI, "COM", "StopBits", 1), _
IniRead($sFileINI, "COM", "XON", 0), _
IniRead($sFileINI, "COM", "DSR", 0), _
IniRead($sFileINI, "COM", "CTS", 1), _
IniRead($sFileINI, "COM", "DTR", 1), _
IniRead($sFileINI, "COM", "RTS", 1), _
IniRead($sFileINI, "COM", "IDSR", 0))
If @error Then Return SetError(@error, @ScriptLineNumber)

Local $hFile = _CommAPI_OpenPort($sMode)
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_ClearCommError($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_PurgeComm($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_TransmitString($hFile, IniRead($sFileINI, "COM", "Command", "Command" & @CRLF))
If @error Then Return SetError(@error, @ScriptLineNumber)

Local $sResult = _CommAPI_ReceiveString($hFile, IniRead($sFileINI, "Timeout", "IDSR", 5000))
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)

_CommAPI_ClosePort($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)

Return $sResult
EndFunc
</syntaxhighlight>

== Command Line ==
<syntaxhighlight lang="autoit">
Func Example()
If $CmdLine[0] <> 2 Then
MsgBox(32, "Syntax", @ScriptName & ' "ModeString" "Command"')
Exit
EndIf

Local $hFile = _CommAPI_OpenPort($CmdLine[1])
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_ClearCommError($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_PurgeComm($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_TransmitString($hFile, $CmdLine[2])
If @error Then Return SetError(@error, @ScriptLineNumber)

Local $sResult = _CommAPI_ReceiveString($hFile, 5000)
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)

_CommAPI_ClosePort($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)

Return $sResult
EndFunc
</syntaxhighlight>

<syntaxhighlight lang="winbatch">
@echo off
cls
chcp 1252>nul
cd /d "%~dp0"
start Example.exe "COM1: BAUD=9600 PARITY=N DATA=8 STOP=1 XON=OFF ODSR=OFF OCTS=ON DTR=ON RTS=ON IDSR=OFF" "Command"
</syntaxhighlight>

== Separator ==
<syntaxhighlight lang="autoit">
Func Example()
Local $hFile = _CommAPI_OpenCOMPort(1, 9600, 0, 8, 1)
If @error Then Return SetError(@error, @ScriptLineNumber)

Local $sResult = ""
While True
$sResult = _CommAPI_ReceiveString($hFile, 5000, 0, "<CR>")
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)
MsgBox(64, "Line", $sResult)
WEnd

_CommAPI_ClosePort($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)

Return $sResult
EndFunc
</syntaxhighlight>

== Slow Devices ==
For some slow devices the default timeout is too small of one millisecond.
<syntaxhighlight lang="autoit">
Func Example()
Local $hFile = _CommAPI_OpenCOMPort(1, 9600, 0, 8, 1)
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_ChangeCommTimeoutsElement($hFile, "ReadTotalTimeoutMultiplier", 100)
If @error Then Return SetError(@error, @ScriptLineNumber)

Local $sResult = _CommAPI_ReceiveString($hFile, 5000)
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)

_CommAPI_ClosePort($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)

Return $sResult
EndFunc
</syntaxhighlight>

CommInterface.au3

2014-04-07T11:01:50Z

Therealhanuta:

CommUtilities.au3

2014-04-07T11:01:39Z

Therealhanuta:

CommAPIHelper.au3

2014-04-07T11:01:32Z

Therealhanuta:

CommAPI.au3

2014-04-07T11:01:24Z

Therealhanuta:

[[Category:CommAPI]][[Category:Script]]<syntaxhighlight lang="autoit">
; #INDEX# =======================================================================================================================
; Name ..........: CommAPI.au3
; Title .........: Communications Functions of Windows API
; Description ...: Communications Functions of Windows API calls that have been translated to AutoIt functions.
; Version Date ..: 2014-04-04
; AutoIt Version : 3.3.8.1
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363194(v=vs.85).aspx
; Tag(s) ........: RS-232, serial port, COM port
; Author(s) .....:
; Dll(s) ........: kernel32.dll
; Error handling : Everytime @extended is set, it is filled with @ScriptLineNumber of the error.
; ===============================================================================================================================

#include-once
#include "CommAPIConstants.au3"
#NoAutoIt3Execute
#AutoIt3Wrapper_Au3Check_Parameters=-q -d -w 1 -w 2 -w 3 -w- 4 -w 5 -w 6 -w- 7

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_BuildCommDCB
; Description ...: Fills a specified DCB structure with values specified in a device-control string.
; Syntax ........: _CommAPI_BuildCommDCB(Const $sMode, Byref $tDBC)
; Parameters ....: $sMode - [in] A device-definition string.
; $tDBC - [out] A DCB structure.
; Return values .: Success - True
; Failure - False
; @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_BuildCommDCBAndTimeouts, $tagDCB
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363143(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_BuildCommDCB(Const $sMode, ByRef $tDBC)
Local $aResult = DllCall("kernel32.dll", "bool", "BuildCommDCB", "str", $sMode, "ptr", DllStructGetPtr($tDBC))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
If Not $aResult[0] Then Return SetError(-1, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_BuildCommDCB

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_BuildCommDCBAndTimeouts
; Description ...: Translates a device-definition string into appropriate device-control block codes and places them into a device control block.
; The function can also set up time-out values for a device.
; Syntax ........: _CommAPI_BuildCommDCBAndTimeouts(Const $sMode, Byref $tDBC, Byref $tCommTimeouts)
; Parameters ....: $sMode - [in] A device-definition string.
; $tDBC - [out] A DCB structure.
; $tCommTimeouts - [out] A COMMTIMEOUTS structure.
; Return values .: Success - True
; Failure - False
; @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_BuildCommDCB, $tagDCB, $tagCOMMTIMEOUTS
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363145(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_BuildCommDCBAndTimeouts(Const $sMode, ByRef $tDBC, ByRef $tCommTimeouts)
Local $aResult = DllCall("kernel32.dll", "bool", "BuildCommDCBAndTimeouts", "str", $sMode, "ptr", DllStructGetPtr($tDBC), "ptr", DllStructGetPtr($tCommTimeouts))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
If Not $aResult[0] Then Return SetError(-1, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_BuildCommDCBAndTimeouts

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_ClearCommBreak
; Description ...: Restores character transmission for a specified communications device and places the transmission line in a nonbreak state.
; Syntax ........: _CommAPI_ClearCommBreak(Const $hFile)
; Parameters ....: $hFile - [in] A handle to the communications device.
; Return values .: Success - True
; Failure - False
; @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_ClearCommError
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363179(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_ClearCommBreak(Const $hFile)
Local $aResult = DllCall("kernel32.dll", "bool", "ClearCommBreak", "handle", $hFile)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
If Not $aResult[0] Then Return SetError(-1, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_ClearCommBreak

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_ClearCommError
; Description ...: Retrieves information about a communications error and reports the current status of a communications device.
; Syntax ........: _CommAPI_ClearCommError(Const $hFile[, $tComStat = 0])
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tComStat - [out] A COMSTAT structure in which the device's status information is returned.
; Return values .: Success - A mask indicating the type of error.
; Failure - 0
; @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_ClearCommBreak, $tagCOMSTAT
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363180(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_ClearCommError(Const $hFile, $tComStat = 0)
Local $aResult = DllCall("kernel32.dll", "bool", "ClearCommError", "handle", $hFile, "dword*", 0, "ptr", DllStructGetPtr($tComStat))
If @error Then Return SetError(@error, @ScriptLineNumber, 0)
If Not $aResult[0] Then SetError(-1, @ScriptLineNumber)
Return $aResult[2]
EndFunc ;==>_CommAPI_ClearCommError

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_EscapeCommFunction
; Description ...: Directs the specified communications device to perform an extended function.
; Syntax ........: _CommAPI_EscapeCommFunction(Const $hFile, Const $iFunction)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $iFunction - [in] The extended function to be performed.
; Return values .: Success - True
; Failure - False
; @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_SetOnDTR, _CommAPI_SetOnRTS
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363254(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_EscapeCommFunction(Const $hFile, Const $iFunction)
Local $aResult = DllCall("kernel32.dll", "bool", "EscapeCommFunction", "handle", $hFile, "dword", $iFunction)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
If Not $aResult[0] Then Return SetError(-1, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_EscapeCommFunction

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_GetCommMask
; Description ...: Retrieves the value of the event mask for a specified communications device.
; Syntax ........: _CommAPI_GetCommMask(Const $hFile)
; Parameters ....: $hFile - [in] A handle to the communications device.
; Return values .: Success - A mask of events that are currently enabled.
; Failure - 0
; @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 .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363257(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_GetCommMask(Const $hFile)
Local $aResult = DllCall("kernel32.dll", "bool", "GetCommMask", "handle", $hFile, "dword*", 0)
If @error Then Return SetError(@error, @ScriptLineNumber, 0)
If Not $aResult[0] Then SetError(-1, @ScriptLineNumber)
Return $aResult[2]
EndFunc ;==>_CommAPI_GetCommMask

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_GetCommModemStatus
; Description ...: Retrieves the modem control-register values.
; Syntax ........: _CommAPI_GetCommModemStatus(Const $hFile, Byref $pModemStatus)
; Parameters ....: $hFile - [in] A handle to the communications device.
; Return values .: Success - The current state of the modem control-register values.
; Failure - 0
; @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_IsOnCTS, _CommAPI_IsOnDSR, _CommAPI_IsOnRI, _CommAPI_IsOnDCD, _CommAPI_WaitCommEvent
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363258(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_GetCommModemStatus(Const $hFile)
Local $aResult = DllCall("kernel32.dll", "bool", "GetCommModemStatus", "handle", $hFile, "dword*", 0)
If @error Then Return SetError(@error, @ScriptLineNumber, 0)
If Not $aResult[0] Then SetError(-1, @ScriptLineNumber)
Return $aResult[2]
EndFunc ;==>_CommAPI_GetCommModemStatus

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_GetCommProperties
; Description ...: Retrieves information about the communications properties for a specified communications device.
; Syntax ........: _CommAPI_GetCommProperties(Const $hFile[, $tCOMMPROP = 0])
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tCOMMPROP - [out] A COMMPROP structure in which the communications properties information is returned.
; Return values .: Success - True
; Failure - False
; @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 .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363259(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_GetCommProperties(Const $hFile, $tCOMMPROP = 0)
Local $aResult = DllCall("kernel32.dll", "bool", "GetCommProperties", "handle", $hFile, "ptr", DllStructGetPtr($tCOMMPROP))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
If Not $aResult[0] Then Return SetError(-1, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_GetCommProperties

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_GetCommState
; Description ...: Retrieves the current control settings for a specified communications device.
; Syntax ........: _CommAPI_GetCommState(Const $hFile, $tDCB = 0)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tDCB - [out] A DCB structure that receives the control settings information.
; Return values .: Success - True
; Failure - False
; @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_SetCommState, $tagDCB
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363260(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_GetCommState(Const $hFile, $tDCB = 0)
Local $aResult = DllCall("kernel32.dll", "bool", "GetCommState", "handle", $hFile, "ptr", DllStructGetPtr($tDCB))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
If Not $aResult[0] Then Return SetError(-1, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_GetCommState

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_GetCommTimeouts
; Description ...: Retrieves the time-out parameters for all read and write operations on a specified communications device.
; Syntax ........: _CommAPI_GetCommTimeouts(Const $hFile, $tCommTimeouts = 0)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tCommTimeouts - [out] A COMMTIMEOUTS structure in which the time-out information is returned.
; Return values .: Success - True
; Failure - False
; @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_SetCommTimeouts, $tagCOMMTIMEOUTS
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363261(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_GetCommTimeouts(Const $hFile, $tCommTimeouts = 0)
Local $aResult = DllCall("kernel32.dll", "bool", "GetCommTimeouts", "handle", $hFile, "ptr", DllStructGetPtr($tCommTimeouts))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
If Not $aResult[0] Then Return SetError(-1, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_GetCommTimeouts

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_PurgeComm
; Description ...: Discards all characters from the output or input buffer of a specified communications resource.
; It can also terminate pending read or write operations on the resource.
; Syntax ........: _CommAPI_PurgeComm(Const $hFile[, $iFlags = $PURGE_ALL])
; Parameters ....: $hFile - [in] A handle to the communications device.
; $iFlags - [in] An integer value.
; Return values .: Success - True
; Failure - False
; @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 .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363428(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_PurgeComm(Const $hFile, Const $iFlags = $PURGE_ALL)
Local $aResult = DllCall("kernel32.dll", "bool", "PurgeComm", "handle", $hFile, "dword", $iFlags)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
If Not $aResult[0] Then Return SetError(-1, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_PurgeComm

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_SetCommBreak
; Description ...: Suspends character transmission for a specified communications device and places the transmission line in a break state until the ClearCommBreak function is called.
; Syntax ........: _CommAPI_SetCommBreak(Const $hFile)
; Parameters ....: $hFile - [in] A handle to the communications device.
; Return values .: Success - True
; Failure - False
; @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 .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363433(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_SetCommBreak(Const $hFile)
Local $aResult = DllCall("kernel32.dll", "bool", "SetCommBreak", "handle", $hFile)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
If Not $aResult[0] Then Return SetError(-1, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_SetCommBreak

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_SetCommMask
; Description ...: Specifies a set of events to be monitored for a communications device.
; Syntax ........: _CommAPI_SetCommMask(Const $hFile, Const $iEventMask)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $iEventMask - [in] The events to be enabled. A value of zero disables all events.
; Return values .: Success - True
; Failure - False
; @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 .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363435(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_SetCommMask(Const $hFile, Const $iEventMask)
Local $aResult = DllCall("kernel32.dll", "bool", "SetCommMask", "handle", $hFile, "dword", $iEventMask)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
If Not $aResult[0] Then Return SetError(-1, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_SetCommMask

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_SetCommState
; Description ...: Configures a communications device according to the specifications in a device-control block.
; The function reinitializes all hardware and control settings, but it does not empty output or input queues.
; Syntax ........: _CommAPI_SetCommState(Const $hFile, Const $tDCB)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tDCB - [in] A DCB structure that contains the configuration information for the specified communications device.
; Return values .: Success - True
; Failure - False
; @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_GetCommState, $tagDCB
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363436(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_SetCommState(Const $hFile, Const $tDCB)
Local $aResult = DllCall("kernel32.dll", "bool", "SetCommState", "handle", $hFile, "ptr", DllStructGetPtr($tDCB))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
If Not $aResult[0] Then Return SetError(-1, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_SetCommState

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_SetCommTimeouts
; Description ...: Sets the time-out parameters for all read and write operations on a specified communications device.
; Syntax ........: _CommAPI_SetCommTimeouts(Const $hFile, Const $tCommTimeouts)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tCommTimeouts - [in] A COMMTIMEOUTS structure that contains the new time-out values.
; Return values .: Success - True
; Failure - False
; @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_GetCommTimeouts, $tagCOMMTIMEOUTS
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363437(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_SetCommTimeouts(Const $hFile, Const $tCommTimeouts)
Local $aResult = DllCall("kernel32.dll", "bool", "SetCommTimeouts", "handle", $hFile, "ptr", DllStructGetPtr($tCommTimeouts))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
If Not $aResult[0] Then Return SetError(-1, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_SetCommTimeouts

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_SetupComm
; Description ...: Initializes the communications parameters for a specified communications device.
; Syntax ........: _CommAPI_SetupComm(Const $hFile, Const $iInQueue, Const $iOutQueue)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $iInQueue - [in] The recommended size of the device's internal input buffer, in bytes.
; $iOutQueue - [in] The recommended size of the device's internal output buffer, in bytes.
; Return values .: Success - True
; Failure - False
; @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 .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363439(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_SetupComm(Const $hFile, Const $iInQueue, Const $iOutQueue)
Local $aResult = DllCall("kernel32.dll", "bool", "SetupComm", "handle", $hFile, "dword", $iInQueue, "dword", $iOutQueue)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
If Not $aResult[0] Then Return SetError(-1, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_SetupComm

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_TransmitCommChar
; Description ...: Transmits a specified character ahead of any pending data in the output buffer of the specified communications device.
; Syntax ........: _CommAPI_TransmitCommChar(Const $hFile, Const $cChar)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $sChar - [in] The character to be transmitted.
; Return values .: Success - True
; Failure - False
; @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 .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363473(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_TransmitCommChar(Const $hFile, Const $cChar)
Local $tChar = DllStructCreate("char")
DllStructSetData($tChar, 1, $cChar)
Local $aResult = DllCall("kernel32.dll", "bool", "TransmitCommChar", "handle", $hFile, "char", $tChar)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
If Not $aResult[0] Then Return SetError(-1, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_TransmitCommChar

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_WaitCommEvent
; Description ...: Waits for an event to occur for a specified communications device.
; Syntax ........: _CommAPI_WaitCommEvent(Const $hFile [, Const $tOverlapped = 0])
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tOverlapped - [in] An OVERLAPPED structure.
; Return values .: Success - A mask indicating the type of event that occurred.
; Failure - 0
; @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_EscapeCommFunction, _CommAPI_GetCommModemStatus
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363479(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_WaitCommEvent(Const $hFile, Const $tOverlapped = 0)
Local $pOverlapped = DllStructGetPtr($tOverlapped)
If Not $pOverlapped Then $pOverlapped = DllStructGetPtr(DllStructCreate($tagOverlapped))
Local $aResult = DllCall("kernel32.dll", "bool", "WaitCommEvent", "handle", $hFile, "dword*", 0, "ptr", $pOverlapped)
If @error Then Return SetError(@error, @ScriptLineNumber, 0)
If Not $aResult[2] Then Return SetError(-1, @ScriptLineNumber, 0)
Return $aResult[2]
EndFunc ;==>_CommAPI_WaitCommEvent
</syntaxhighlight>

CommAPIConstants.au3

2014-04-07T11:01:16Z

Therealhanuta:

CommObsolete.au3

2014-04-07T11:00:29Z

Therealhanuta:

[[Category:CommAPI]][[Category:Script]]<syntaxhighlight lang="autoit">
; #INDEX# =======================================================================================================================
; Name ..........: CommObsolete.au3
; Version Date ..: 2014-04-07
; AutoIt Version : 3.3.8.1
; ===============================================================================================================================

#include-once
#include "CommInterface.au3"
#NoAutoIt3Execute
#AutoIt3Wrapper_Au3Check_Parameters=-q -d -w 1 -w 2 -w 3 -w- 4 -w 5 -w 6 -w- 7

Func _CommAPI_ReceiveData(Const $hFile, Const $iTimeout = 1, Const $iMaxLength = 0)
Local $sResult = _CommAPI_ReceiveString($hFile, $iTimeout, $iMaxLength)
If @error Then SetError(@error, @extended, $sResult)
Return $sResult
EndFunc

Func _CommAPI_ReceiveLine(Const $hFile, Const $sSeparator = @CRLF, Const $iTimeout = 1, Const $iMaxLength = 0)
Local $sResult = _CommAPI_ReceiveString($hFile, $iTimeout, $iMaxLength, $sSeparator)
If @error Then SetError(@error, @extended, $sResult)
Return $sResult
EndFunc

Func _CommAPI_TransmitData(Const $hFile, Const $vData)
Local $iWritten = _CommAPI_TransmitBinary($hFile, $vData)
If @error Then Return SetError(@error, @extended, $iWritten)
Return $iWritten
EndFunc
</syntaxhighlight>

CommObsolete.au3

2014-04-07T10:59:40Z

Therealhanuta: Create CommObsolete.au3 for backward compatibility

[[Category:Script]]<syntaxhighlight lang="autoit">
; #INDEX# =======================================================================================================================
; Name ..........: CommObsolete.au3
; Version Date ..: 2014-04-07
; AutoIt Version : 3.3.8.1
; ===============================================================================================================================

#include-once
#include "CommInterface.au3"
#NoAutoIt3Execute
#AutoIt3Wrapper_Au3Check_Parameters=-q -d -w 1 -w 2 -w 3 -w- 4 -w 5 -w 6 -w- 7

Func _CommAPI_ReceiveData(Const $hFile, Const $iTimeout = 1, Const $iMaxLength = 0)
Local $sResult = _CommAPI_ReceiveString($hFile, $iTimeout, $iMaxLength)
If @error Then SetError(@error, @extended, $sResult)
Return $sResult
EndFunc

Func _CommAPI_ReceiveLine(Const $hFile, Const $sSeparator = @CRLF, Const $iTimeout = 1, Const $iMaxLength = 0)
Local $sResult = _CommAPI_ReceiveString($hFile, $iTimeout, $iMaxLength, $sSeparator)
If @error Then SetError(@error, @extended, $sResult)
Return $sResult
EndFunc

Func _CommAPI_TransmitData(Const $hFile, Const $vData)
Local $iWritten = _CommAPI_TransmitBinary($hFile, $vData)
If @error Then Return SetError(@error, @extended, $iWritten)
Return $iWritten
EndFunc
</syntaxhighlight>

CommAPI

2014-04-07T10:58:50Z

Therealhanuta: /* Scripts */

CommAPI translates the communications functions of Windows API to AutoIt functions.

== Overview ==
=== Features ===
* No need to install DLL's
* Using Windows API calls (kernel32.dll)
* Possibility of serial communication (serial port, COM port, RS-232)
* Possibility of parallel communication (parallel port, LPT port)
* No use of global variables
* Uniform namespace _CommAPI_XXX
* Modular organization into files
* A lot of additional utility and helper functions

=== Scripts ===
* [[CommAPIConstants.au3]]
* [[CommAPI.au3]]
* [[CommAPIHelper.au3]]
* [[CommUtilities.au3]]
* [[CommInterface.au3]]
* [[CommObsolete.au3]] (only needed for backward compatibility)

=== Examples ===
[[CommAPI Examples]] shows you some examples. Mayby you could find more examples in [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/?p=1126366 forum].

== Background ==
=== History ===
* 2008-09-12 Creation of cfx.au3 [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/#entry578111 (V1.0)]
* 2011-02-18 Conversation of cfx.au3 into cfxUDF.au3 [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/page-2#entry872154 (V2.0)]
* 2011-02-28 Update V2.0to [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/page-2#entry874547 V2.1]
* 2011-04-27 Update V2.1 to [http://www.autoit.de/index.php?page=Thread&postID=217993#post217993 V2.2] (german forum)
* 2013-07-10 Modify V2.1 to [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/page-2#entry1094288 V2.1mod]
* 2013-10-24 Creation of [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/ CommAPI.au3]

=== Changelog ===
; 2014-01-23
: Small update of method _CommAPI_CreateModeString
; 2014-02-03
: Change timeout handling (Attention: not backward compatible)
: Small update of method _CommAPI_PurgeComm
; 2014-03-07
: Rename CommAPIStructures.au3 to CommAPIConstants.au3
: Replace hex values with Constants
; 2014-03-27
: Update of call _WinAPI_CreateFile
: Updated @error handling
: New parameter MaxLen for function _CommAPI_ReceiveData
: New function _CommAPI_ReceiveLine
: Update existing examples and add new examples
; 2014-03-31
: Add constants
: Fix _CommAPI_WaitCommEvent
; 2014-04-03
: Fix reading error Chr(128) to Chr(255)
: Fix error in _CommAPI_TransmitData
; 2014-04-04
: Replace ReceiveData & ReceiveLine with ReceiveBinary & ReceiveString
; 2014-04-07
: replace _CommAPI_TransmitData with _CommAPI_TransmitBinary & _CommAPI_TransmitString
: Create CommObsolete.au3 for backward compatibility

=== Roadmap ===
There is no roadmap in the moment. Feel free to implement the last five remaining API calls, enhance the scripts or to fix bugs.

=== Support ===
There is no official support. Try to get help from community in the official forum. [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/ Here you can find the main thread].

=== Resources ===
* [http://msdn.microsoft.com/en-us/library/aa363194(v=vs.85).aspx MSDN Library of communications functions]
* [http://www.hpcc.ecs.soton.ac.uk/software/Win32API.Txt WIN32API.TXT]
* cfxUDF.au3 (see section above)
* [http://www.autoit.de/index.php?page=Thread&postID=198669#post198669 GetCOMPorts] (german forum)
* [http://www.autoitscript.com/forum/topic/19713-problem-with-struct/#entry136466 ParseCommState]

== Functions ==
=== Implemented API functions ===
* BuildCommDCB
* BuildCommDCBAndTimeouts
* ClearCommBreak
* ClearCommError
* EscapeCommFunction
* GetCommMask
* GetCommModemStatus
* GetCommProperties
* GetCommState
* GetCommTimeouts
* PurgeComm
* SetCommBreak
* SetCommMask
* SetCommState
* SetCommTimeouts
* SetupComm
* TransmitCommChar
* WaitCommEvent

=== Unimplemented API functions ===
* CommConfigDialog
* GetCommConfig
* GetDefaultCommConfig
* SetCommConfig
* SetDefaultCommConfig

=== API helper functions ===
* ChangeCommStateElement
* ChangeCommTimeoutsElement
* GetCommStateElement
* GetCommTimeoutsElement
* IsOnCTS
* IsOnDCD
* IsOnDSR
* IsOnRI
* SetCommStateElement
* SetCommTimeoutsElement
* SetOnDTR
* SetOnRTS

=== Utility functions ===
* CommStateToString
* CommTimeoutsToString
* CreateModeString
* GetCOMPorts

=== Interface functions ===
* ClosePort
* OpenCOMPort
* OpenPort
* ReceiveBinary
* ReceiveString
* TransmitData

CommAPI

2014-04-07T10:58:15Z

Therealhanuta: /* Changelog */

CommAPI translates the communications functions of Windows API to AutoIt functions.

== Overview ==
=== Features ===
* No need to install DLL's
* Using Windows API calls (kernel32.dll)
* Possibility of serial communication (serial port, COM port, RS-232)
* Possibility of parallel communication (parallel port, LPT port)
* No use of global variables
* Uniform namespace _CommAPI_XXX
* Modular organization into files
* A lot of additional utility and helper functions

=== Scripts ===
* [[CommAPIConstants.au3]]
* [[CommAPI.au3]]
* [[CommAPIHelper.au3]]
* [[CommUtilities.au3]]
* [[CommInterface.au3]]

=== Examples ===
[[CommAPI Examples]] shows you some examples. Mayby you could find more examples in [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/?p=1126366 forum].

== Background ==
=== History ===
* 2008-09-12 Creation of cfx.au3 [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/#entry578111 (V1.0)]
* 2011-02-18 Conversation of cfx.au3 into cfxUDF.au3 [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/page-2#entry872154 (V2.0)]
* 2011-02-28 Update V2.0to [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/page-2#entry874547 V2.1]
* 2011-04-27 Update V2.1 to [http://www.autoit.de/index.php?page=Thread&postID=217993#post217993 V2.2] (german forum)
* 2013-07-10 Modify V2.1 to [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/page-2#entry1094288 V2.1mod]
* 2013-10-24 Creation of [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/ CommAPI.au3]

=== Changelog ===
; 2014-01-23
: Small update of method _CommAPI_CreateModeString
; 2014-02-03
: Change timeout handling (Attention: not backward compatible)
: Small update of method _CommAPI_PurgeComm
; 2014-03-07
: Rename CommAPIStructures.au3 to CommAPIConstants.au3
: Replace hex values with Constants
; 2014-03-27
: Update of call _WinAPI_CreateFile
: Updated @error handling
: New parameter MaxLen for function _CommAPI_ReceiveData
: New function _CommAPI_ReceiveLine
: Update existing examples and add new examples
; 2014-03-31
: Add constants
: Fix _CommAPI_WaitCommEvent
; 2014-04-03
: Fix reading error Chr(128) to Chr(255)
: Fix error in _CommAPI_TransmitData
; 2014-04-04
: Replace ReceiveData & ReceiveLine with ReceiveBinary & ReceiveString
; 2014-04-07
: replace _CommAPI_TransmitData with _CommAPI_TransmitBinary & _CommAPI_TransmitString
: Create CommObsolete.au3 for backward compatibility

=== Roadmap ===
There is no roadmap in the moment. Feel free to implement the last five remaining API calls, enhance the scripts or to fix bugs.

=== Support ===
There is no official support. Try to get help from community in the official forum. [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/ Here you can find the main thread].

=== Resources ===
* [http://msdn.microsoft.com/en-us/library/aa363194(v=vs.85).aspx MSDN Library of communications functions]
* [http://www.hpcc.ecs.soton.ac.uk/software/Win32API.Txt WIN32API.TXT]
* cfxUDF.au3 (see section above)
* [http://www.autoit.de/index.php?page=Thread&postID=198669#post198669 GetCOMPorts] (german forum)
* [http://www.autoitscript.com/forum/topic/19713-problem-with-struct/#entry136466 ParseCommState]

== Functions ==
=== Implemented API functions ===
* BuildCommDCB
* BuildCommDCBAndTimeouts
* ClearCommBreak
* ClearCommError
* EscapeCommFunction
* GetCommMask
* GetCommModemStatus
* GetCommProperties
* GetCommState
* GetCommTimeouts
* PurgeComm
* SetCommBreak
* SetCommMask
* SetCommState
* SetCommTimeouts
* SetupComm
* TransmitCommChar
* WaitCommEvent

=== Unimplemented API functions ===
* CommConfigDialog
* GetCommConfig
* GetDefaultCommConfig
* SetCommConfig
* SetDefaultCommConfig

=== API helper functions ===
* ChangeCommStateElement
* ChangeCommTimeoutsElement
* GetCommStateElement
* GetCommTimeoutsElement
* IsOnCTS
* IsOnDCD
* IsOnDSR
* IsOnRI
* SetCommStateElement
* SetCommTimeoutsElement
* SetOnDTR
* SetOnRTS

=== Utility functions ===
* CommStateToString
* CommTimeoutsToString
* CreateModeString
* GetCOMPorts

=== Interface functions ===
* ClosePort
* OpenCOMPort
* OpenPort
* ReceiveBinary
* ReceiveString
* TransmitData

CommInterface.au3

2014-04-07T10:56:38Z

Therealhanuta: replace _CommAPI_TransmitData with _CommAPI_TransmitBinary and _CommAPI_TransmitString

CommAPI.au3

2014-04-04T14:44:22Z

Therealhanuta: some small updates

[[Category:Script]]<syntaxhighlight lang="autoit">
; #INDEX# =======================================================================================================================
; Name ..........: CommAPI.au3
; Title .........: Communications Functions of Windows API
; Description ...: Communications Functions of Windows API calls that have been translated to AutoIt functions.
; Version Date ..: 2014-04-04
; AutoIt Version : 3.3.8.1
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363194(v=vs.85).aspx
; Tag(s) ........: RS-232, serial port, COM port
; Author(s) .....:
; Dll(s) ........: kernel32.dll
; Error handling : Everytime @extended is set, it is filled with @ScriptLineNumber of the error.
; ===============================================================================================================================

#include-once
#include "CommAPIConstants.au3"
#NoAutoIt3Execute
#AutoIt3Wrapper_Au3Check_Parameters=-q -d -w 1 -w 2 -w 3 -w- 4 -w 5 -w 6 -w- 7

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_BuildCommDCB
; Description ...: Fills a specified DCB structure with values specified in a device-control string.
; Syntax ........: _CommAPI_BuildCommDCB(Const $sMode, Byref $tDBC)
; Parameters ....: $sMode - [in] A device-definition string.
; $tDBC - [out] A DCB structure.
; Return values .: Success - True
; Failure - False
; @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_BuildCommDCBAndTimeouts, $tagDCB
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363143(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_BuildCommDCB(Const $sMode, ByRef $tDBC)
Local $aResult = DllCall("kernel32.dll", "bool", "BuildCommDCB", "str", $sMode, "ptr", DllStructGetPtr($tDBC))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
If Not $aResult[0] Then Return SetError(-1, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_BuildCommDCB

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_BuildCommDCBAndTimeouts
; Description ...: Translates a device-definition string into appropriate device-control block codes and places them into a device control block.
; The function can also set up time-out values for a device.
; Syntax ........: _CommAPI_BuildCommDCBAndTimeouts(Const $sMode, Byref $tDBC, Byref $tCommTimeouts)
; Parameters ....: $sMode - [in] A device-definition string.
; $tDBC - [out] A DCB structure.
; $tCommTimeouts - [out] A COMMTIMEOUTS structure.
; Return values .: Success - True
; Failure - False
; @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_BuildCommDCB, $tagDCB, $tagCOMMTIMEOUTS
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363145(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_BuildCommDCBAndTimeouts(Const $sMode, ByRef $tDBC, ByRef $tCommTimeouts)
Local $aResult = DllCall("kernel32.dll", "bool", "BuildCommDCBAndTimeouts", "str", $sMode, "ptr", DllStructGetPtr($tDBC), "ptr", DllStructGetPtr($tCommTimeouts))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
If Not $aResult[0] Then Return SetError(-1, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_BuildCommDCBAndTimeouts

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_ClearCommBreak
; Description ...: Restores character transmission for a specified communications device and places the transmission line in a nonbreak state.
; Syntax ........: _CommAPI_ClearCommBreak(Const $hFile)
; Parameters ....: $hFile - [in] A handle to the communications device.
; Return values .: Success - True
; Failure - False
; @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_ClearCommError
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363179(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_ClearCommBreak(Const $hFile)
Local $aResult = DllCall("kernel32.dll", "bool", "ClearCommBreak", "handle", $hFile)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
If Not $aResult[0] Then Return SetError(-1, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_ClearCommBreak

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_ClearCommError
; Description ...: Retrieves information about a communications error and reports the current status of a communications device.
; Syntax ........: _CommAPI_ClearCommError(Const $hFile[, $tComStat = 0])
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tComStat - [out] A COMSTAT structure in which the device's status information is returned.
; Return values .: Success - A mask indicating the type of error.
; Failure - 0
; @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_ClearCommBreak, $tagCOMSTAT
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363180(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_ClearCommError(Const $hFile, $tComStat = 0)
Local $aResult = DllCall("kernel32.dll", "bool", "ClearCommError", "handle", $hFile, "dword*", 0, "ptr", DllStructGetPtr($tComStat))
If @error Then Return SetError(@error, @ScriptLineNumber, 0)
If Not $aResult[0] Then SetError(-1, @ScriptLineNumber)
Return $aResult[2]
EndFunc ;==>_CommAPI_ClearCommError

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_EscapeCommFunction
; Description ...: Directs the specified communications device to perform an extended function.
; Syntax ........: _CommAPI_EscapeCommFunction(Const $hFile, Const $iFunction)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $iFunction - [in] The extended function to be performed.
; Return values .: Success - True
; Failure - False
; @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_SetOnDTR, _CommAPI_SetOnRTS
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363254(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_EscapeCommFunction(Const $hFile, Const $iFunction)
Local $aResult = DllCall("kernel32.dll", "bool", "EscapeCommFunction", "handle", $hFile, "dword", $iFunction)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
If Not $aResult[0] Then Return SetError(-1, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_EscapeCommFunction

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_GetCommMask
; Description ...: Retrieves the value of the event mask for a specified communications device.
; Syntax ........: _CommAPI_GetCommMask(Const $hFile)
; Parameters ....: $hFile - [in] A handle to the communications device.
; Return values .: Success - A mask of events that are currently enabled.
; Failure - 0
; @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 .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363257(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_GetCommMask(Const $hFile)
Local $aResult = DllCall("kernel32.dll", "bool", "GetCommMask", "handle", $hFile, "dword*", 0)
If @error Then Return SetError(@error, @ScriptLineNumber, 0)
If Not $aResult[0] Then SetError(-1, @ScriptLineNumber)
Return $aResult[2]
EndFunc ;==>_CommAPI_GetCommMask

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_GetCommModemStatus
; Description ...: Retrieves the modem control-register values.
; Syntax ........: _CommAPI_GetCommModemStatus(Const $hFile, Byref $pModemStatus)
; Parameters ....: $hFile - [in] A handle to the communications device.
; Return values .: Success - The current state of the modem control-register values.
; Failure - 0
; @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_IsOnCTS, _CommAPI_IsOnDSR, _CommAPI_IsOnRI, _CommAPI_IsOnDCD, _CommAPI_WaitCommEvent
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363258(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_GetCommModemStatus(Const $hFile)
Local $aResult = DllCall("kernel32.dll", "bool", "GetCommModemStatus", "handle", $hFile, "dword*", 0)
If @error Then Return SetError(@error, @ScriptLineNumber, 0)
If Not $aResult[0] Then SetError(-1, @ScriptLineNumber)
Return $aResult[2]
EndFunc ;==>_CommAPI_GetCommModemStatus

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_GetCommProperties
; Description ...: Retrieves information about the communications properties for a specified communications device.
; Syntax ........: _CommAPI_GetCommProperties(Const $hFile[, $tCOMMPROP = 0])
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tCOMMPROP - [out] A COMMPROP structure in which the communications properties information is returned.
; Return values .: Success - True
; Failure - False
; @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 .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363259(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_GetCommProperties(Const $hFile, $tCOMMPROP = 0)
Local $aResult = DllCall("kernel32.dll", "bool", "GetCommProperties", "handle", $hFile, "ptr", DllStructGetPtr($tCOMMPROP))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
If Not $aResult[0] Then Return SetError(-1, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_GetCommProperties

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_GetCommState
; Description ...: Retrieves the current control settings for a specified communications device.
; Syntax ........: _CommAPI_GetCommState(Const $hFile, $tDCB = 0)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tDCB - [out] A DCB structure that receives the control settings information.
; Return values .: Success - True
; Failure - False
; @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_SetCommState, $tagDCB
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363260(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_GetCommState(Const $hFile, $tDCB = 0)
Local $aResult = DllCall("kernel32.dll", "bool", "GetCommState", "handle", $hFile, "ptr", DllStructGetPtr($tDCB))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
If Not $aResult[0] Then Return SetError(-1, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_GetCommState

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_GetCommTimeouts
; Description ...: Retrieves the time-out parameters for all read and write operations on a specified communications device.
; Syntax ........: _CommAPI_GetCommTimeouts(Const $hFile, $tCommTimeouts = 0)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tCommTimeouts - [out] A COMMTIMEOUTS structure in which the time-out information is returned.
; Return values .: Success - True
; Failure - False
; @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_SetCommTimeouts, $tagCOMMTIMEOUTS
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363261(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_GetCommTimeouts(Const $hFile, $tCommTimeouts = 0)
Local $aResult = DllCall("kernel32.dll", "bool", "GetCommTimeouts", "handle", $hFile, "ptr", DllStructGetPtr($tCommTimeouts))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
If Not $aResult[0] Then Return SetError(-1, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_GetCommTimeouts

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_PurgeComm
; Description ...: Discards all characters from the output or input buffer of a specified communications resource.
; It can also terminate pending read or write operations on the resource.
; Syntax ........: _CommAPI_PurgeComm(Const $hFile[, $iFlags = $PURGE_ALL])
; Parameters ....: $hFile - [in] A handle to the communications device.
; $iFlags - [in] An integer value.
; Return values .: Success - True
; Failure - False
; @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 .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363428(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_PurgeComm(Const $hFile, Const $iFlags = $PURGE_ALL)
Local $aResult = DllCall("kernel32.dll", "bool", "PurgeComm", "handle", $hFile, "dword", $iFlags)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
If Not $aResult[0] Then Return SetError(-1, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_PurgeComm

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_SetCommBreak
; Description ...: Suspends character transmission for a specified communications device and places the transmission line in a break state until the ClearCommBreak function is called.
; Syntax ........: _CommAPI_SetCommBreak(Const $hFile)
; Parameters ....: $hFile - [in] A handle to the communications device.
; Return values .: Success - True
; Failure - False
; @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 .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363433(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_SetCommBreak(Const $hFile)
Local $aResult = DllCall("kernel32.dll", "bool", "SetCommBreak", "handle", $hFile)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
If Not $aResult[0] Then Return SetError(-1, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_SetCommBreak

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_SetCommMask
; Description ...: Specifies a set of events to be monitored for a communications device.
; Syntax ........: _CommAPI_SetCommMask(Const $hFile, Const $iEventMask)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $iEventMask - [in] The events to be enabled. A value of zero disables all events.
; Return values .: Success - True
; Failure - False
; @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 .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363435(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_SetCommMask(Const $hFile, Const $iEventMask)
Local $aResult = DllCall("kernel32.dll", "bool", "SetCommMask", "handle", $hFile, "dword", $iEventMask)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
If Not $aResult[0] Then Return SetError(-1, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_SetCommMask

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_SetCommState
; Description ...: Configures a communications device according to the specifications in a device-control block.
; The function reinitializes all hardware and control settings, but it does not empty output or input queues.
; Syntax ........: _CommAPI_SetCommState(Const $hFile, Const $tDCB)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tDCB - [in] A DCB structure that contains the configuration information for the specified communications device.
; Return values .: Success - True
; Failure - False
; @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_GetCommState, $tagDCB
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363436(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_SetCommState(Const $hFile, Const $tDCB)
Local $aResult = DllCall("kernel32.dll", "bool", "SetCommState", "handle", $hFile, "ptr", DllStructGetPtr($tDCB))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
If Not $aResult[0] Then Return SetError(-1, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_SetCommState

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_SetCommTimeouts
; Description ...: Sets the time-out parameters for all read and write operations on a specified communications device.
; Syntax ........: _CommAPI_SetCommTimeouts(Const $hFile, Const $tCommTimeouts)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tCommTimeouts - [in] A COMMTIMEOUTS structure that contains the new time-out values.
; Return values .: Success - True
; Failure - False
; @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_GetCommTimeouts, $tagCOMMTIMEOUTS
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363437(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_SetCommTimeouts(Const $hFile, Const $tCommTimeouts)
Local $aResult = DllCall("kernel32.dll", "bool", "SetCommTimeouts", "handle", $hFile, "ptr", DllStructGetPtr($tCommTimeouts))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
If Not $aResult[0] Then Return SetError(-1, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_SetCommTimeouts

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_SetupComm
; Description ...: Initializes the communications parameters for a specified communications device.
; Syntax ........: _CommAPI_SetupComm(Const $hFile, Const $iInQueue, Const $iOutQueue)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $iInQueue - [in] The recommended size of the device's internal input buffer, in bytes.
; $iOutQueue - [in] The recommended size of the device's internal output buffer, in bytes.
; Return values .: Success - True
; Failure - False
; @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 .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363439(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_SetupComm(Const $hFile, Const $iInQueue, Const $iOutQueue)
Local $aResult = DllCall("kernel32.dll", "bool", "SetupComm", "handle", $hFile, "dword", $iInQueue, "dword", $iOutQueue)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
If Not $aResult[0] Then Return SetError(-1, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_SetupComm

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_TransmitCommChar
; Description ...: Transmits a specified character ahead of any pending data in the output buffer of the specified communications device.
; Syntax ........: _CommAPI_TransmitCommChar(Const $hFile, Const $cChar)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $sChar - [in] The character to be transmitted.
; Return values .: Success - True
; Failure - False
; @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 .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363473(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_TransmitCommChar(Const $hFile, Const $cChar)
Local $tChar = DllStructCreate("char")
DllStructSetData($tChar, 1, $cChar)
Local $aResult = DllCall("kernel32.dll", "bool", "TransmitCommChar", "handle", $hFile, "char", $tChar)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
If Not $aResult[0] Then Return SetError(-1, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_TransmitCommChar

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_WaitCommEvent
; Description ...: Waits for an event to occur for a specified communications device.
; Syntax ........: _CommAPI_WaitCommEvent(Const $hFile [, Const $tOverlapped = 0])
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tOverlapped - [in] An OVERLAPPED structure.
; Return values .: Success - A mask indicating the type of event that occurred.
; Failure - 0
; @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_EscapeCommFunction, _CommAPI_GetCommModemStatus
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363479(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_WaitCommEvent(Const $hFile, Const $tOverlapped = 0)
Local $pOverlapped = DllStructGetPtr($tOverlapped)
If Not $pOverlapped Then $pOverlapped = DllStructGetPtr(DllStructCreate($tagOverlapped))
Local $aResult = DllCall("kernel32.dll", "bool", "WaitCommEvent", "handle", $hFile, "dword*", 0, "ptr", $pOverlapped)
If @error Then Return SetError(@error, @ScriptLineNumber, 0)
If Not $aResult[2] Then Return SetError(-1, @ScriptLineNumber, 0)
Return $aResult[2]
EndFunc ;==>_CommAPI_WaitCommEvent
</syntaxhighlight>

CommInterface.au3

2014-04-04T14:33:03Z

Therealhanuta:

CommAPI

2014-04-04T14:17:10Z

Therealhanuta: replace ReceiveData & ReceiveLine with ReceiveBinary & ReceiveString

CommAPI translates the communications functions of Windows API to AutoIt functions.

== Overview ==
=== Features ===
* No need to install DLL's
* Using Windows API calls (kernel32.dll)
* Possibility of serial communication (serial port, COM port, RS-232)
* Possibility of parallel communication (parallel port, LPT port)
* No use of global variables
* Uniform namespace _CommAPI_XXX
* Modular organization into files
* A lot of additional utility and helper functions

=== Scripts ===
* [[CommAPIConstants.au3]]
* [[CommAPI.au3]]
* [[CommAPIHelper.au3]]
* [[CommUtilities.au3]]
* [[CommInterface.au3]]

=== Examples ===
[[CommAPI Examples]] shows you some examples. Mayby you could find more examples in [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/?p=1126366 forum].

== Background ==
=== History ===
* 2008-09-12 Creation of cfx.au3 [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/#entry578111 (V1.0)]
* 2011-02-18 Conversation of cfx.au3 into cfxUDF.au3 [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/page-2#entry872154 (V2.0)]
* 2011-02-28 Update V2.0to [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/page-2#entry874547 V2.1]
* 2011-04-27 Update V2.1 to [http://www.autoit.de/index.php?page=Thread&postID=217993#post217993 V2.2] (german forum)
* 2013-07-10 Modify V2.1 to [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/page-2#entry1094288 V2.1mod]
* 2013-10-24 Creation of [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/ CommAPI.au3]

=== Changelog ===
; 2014-01-23
: Small update of method _CommAPI_CreateModeString
; 2014-02-03
: Change timeout handling (Attention: not backward compatible)
: Small update of method _CommAPI_PurgeComm
; 2014-03-07
: Rename CommAPIStructures.au3 to CommAPIConstants.au3
: Replace hex values with Constants
; 2014-03-27
: Update of call _WinAPI_CreateFile
: Updated @error handling
: New parameter MaxLen for function _CommAPI_ReceiveData
: New function _CommAPI_ReceiveLine
: Update existing examples and add new examples
; 2014-03-31
: Add constants
: Fix _CommAPI_WaitCommEvent
; 2014-04-03
: Fix reading error Chr(128) to Chr(255)
: Fix error in _CommAPI_TransmitData
; 2014-04-04
: Replace ReceiveData & ReceiveLine with ReceiveBinary & ReceiveString

=== Roadmap ===
There is no roadmap in the moment. Feel free to implement the last five remaining API calls, enhance the scripts or to fix bugs.

=== Support ===
There is no official support. Try to get help from community in the official forum. [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/ Here you can find the main thread].

=== Resources ===
* [http://msdn.microsoft.com/en-us/library/aa363194(v=vs.85).aspx MSDN Library of communications functions]
* [http://www.hpcc.ecs.soton.ac.uk/software/Win32API.Txt WIN32API.TXT]
* cfxUDF.au3 (see section above)
* [http://www.autoit.de/index.php?page=Thread&postID=198669#post198669 GetCOMPorts] (german forum)
* [http://www.autoitscript.com/forum/topic/19713-problem-with-struct/#entry136466 ParseCommState]

== Functions ==
=== Implemented API functions ===
* BuildCommDCB
* BuildCommDCBAndTimeouts
* ClearCommBreak
* ClearCommError
* EscapeCommFunction
* GetCommMask
* GetCommModemStatus
* GetCommProperties
* GetCommState
* GetCommTimeouts
* PurgeComm
* SetCommBreak
* SetCommMask
* SetCommState
* SetCommTimeouts
* SetupComm
* TransmitCommChar
* WaitCommEvent

=== Unimplemented API functions ===
* CommConfigDialog
* GetCommConfig
* GetDefaultCommConfig
* SetCommConfig
* SetDefaultCommConfig

=== API helper functions ===
* ChangeCommStateElement
* ChangeCommTimeoutsElement
* GetCommStateElement
* GetCommTimeoutsElement
* IsOnCTS
* IsOnDCD
* IsOnDSR
* IsOnRI
* SetCommStateElement
* SetCommTimeoutsElement
* SetOnDTR
* SetOnRTS

=== Utility functions ===
* CommStateToString
* CommTimeoutsToString
* CreateModeString
* GetCOMPorts

=== Interface functions ===
* ClosePort
* OpenCOMPort
* OpenPort
* ReceiveBinary
* ReceiveString
* TransmitData

CommInterface.au3

2014-04-04T14:15:15Z

Therealhanuta: replace ReceiveData & ReceiveLine with ReceiveBinary & ReceiveString

CommAPI Examples

2014-04-04T14:10:18Z

Therealhanuta:

[[Category:Samples]]
== Introduction ==
This site shows you some examples for [[CommAPI]].
You will also need the following snippet for all examples:

<syntaxhighlight lang="autoit">
#include "CommInterface.au3"
#AutoIt3Wrapper_Au3Check_Parameters=-q -d -w 1 -w 2 -w 3 -w- 4 -w 5 -w 6 -w- 7

Main()

Func Main()
Local $sResult = Example()
Switch @error
Case 0
MsgBox(64, "Result", $sResult)
Case -1
MsgBox(32, "Error", _WinAPI_GetLastErrorMessage())
Case -2
MsgBox(32, "Timeout", $sResult)
Case Else
MsgBox(32, "Error", "Error " & @error & " in line " & @extended)
EndSwitch
EndFunc
</syntaxhighlight>

== First example ==
<syntaxhighlight lang="autoit">
Func Example()
Local Const $iPort = 1
Local Const $iBaud = 9600
Local Const $iParity = 0
Local Const $iByteSize = 8
Local Const $iStopBits = 1
Local Const $sCommand = "Command" & @CRLF

Local $hFile = _CommAPI_OpenCOMPort($iPort, $iBaud, $iParity, $iByteSize, $iStopBits)
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_ClearCommError($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_PurgeComm($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_TransmitData($hFile, $sCommand)
If @error Then Return SetError(@error, @ScriptLineNumber)

Local $sResult = _CommAPI_ReceiveString($hFile, 5000)
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)

_CommAPI_ClosePort($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)

Return $sResult
EndFunc
</syntaxhighlight>

== INI file==
<syntaxhighlight lang="autoit">
Func Example()
Local Const $sFileINI = @ScriptDir & "\Example.ini"

Local $sMode = _CommAPI_CreateModeString( _
IniRead($sFileINI, "COM", "SerialPort", 1), _
IniRead($sFileINI, "COM", "BaudRate", 9600), _
IniRead($sFileINI, "COM", "Parity", 0), _
IniRead($sFileINI, "COM", "ByteSize", 8), _
IniRead($sFileINI, "COM", "StopBits", 1), _
IniRead($sFileINI, "COM", "XON", 0), _
IniRead($sFileINI, "COM", "DSR", 0), _
IniRead($sFileINI, "COM", "CTS", 1), _
IniRead($sFileINI, "COM", "DTR", 1), _
IniRead($sFileINI, "COM", "RTS", 1), _
IniRead($sFileINI, "COM", "IDSR", 0))
If @error Then Return SetError(@error, @ScriptLineNumber)

Local $hFile = _CommAPI_OpenPort($sMode)
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_ClearCommError($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_PurgeComm($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_TransmitData($hFile, IniRead($sFileINI, "COM", "Command", "Command" & @CRLF))
If @error Then Return SetError(@error, @ScriptLineNumber)

Local $sResult = _CommAPI_ReceiveString($hFile, IniRead($sFileINI, "Timeout", "IDSR", 5000))
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)

_CommAPI_ClosePort($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)

Return $sResult
EndFunc
</syntaxhighlight>

== Command Line ==
<syntaxhighlight lang="autoit">
Func Example()
If $CmdLine[0] <> 2 Then
MsgBox(32, "Syntax", @ScriptName & ' "ModeString" "Command"')
Exit
EndIf

Local $hFile = _CommAPI_OpenPort($CmdLine[1])
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_ClearCommError($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_PurgeComm($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_TransmitData($hFile, $CmdLine[2])
If @error Then Return SetError(@error, @ScriptLineNumber)

Local $sResult = _CommAPI_ReceiveString($hFile, 5000)
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)

_CommAPI_ClosePort($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)

Return $sResult
EndFunc
</syntaxhighlight>

<syntaxhighlight lang="winbatch">
@echo off
cls
chcp 1252>nul
cd /d "%~dp0"
start Example.exe "COM1: BAUD=9600 PARITY=N DATA=8 STOP=1 XON=OFF ODSR=OFF OCTS=ON DTR=ON RTS=ON IDSR=OFF" "Command"
</syntaxhighlight>

== Separator ==
<syntaxhighlight lang="autoit">
Func Example()
Local $hFile = _CommAPI_OpenCOMPort(1, 9600, 0, 8, 1)
If @error Then Return SetError(@error, @ScriptLineNumber)

Local $sResult = ""
While True
$sResult = _CommAPI_ReceiveString($hFile, 5000, 0, "<CR>")
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)
MsgBox(64, "Line", $sResult)
WEnd

_CommAPI_ClosePort($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)

Return $sResult
EndFunc
</syntaxhighlight>

== Slow Devices ==
For some slow devices the default timeout is too small of one millisecond.
<syntaxhighlight lang="autoit">
Func Example()
Local $hFile = _CommAPI_OpenCOMPort(1, 9600, 0, 8, 1)
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_ChangeCommTimeoutsElement($hFile, "ReadTotalTimeoutMultiplier", 100)
If @error Then Return SetError(@error, @ScriptLineNumber)

Local $sResult = _CommAPI_ReceiveString($hFile, 5000)
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)

_CommAPI_ClosePort($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)

Return $sResult
EndFunc
</syntaxhighlight>

CommAPI

2014-04-03T11:13:36Z

Therealhanuta: /* Changelog */

CommAPI translates the communications functions of Windows API to AutoIt functions.

== Overview ==
=== Features ===
* No need to install DLL's
* Using Windows API calls (kernel32.dll)
* Possibility of serial communication (serial port, COM port, RS-232)
* Possibility of parallel communication (parallel port, LPT port)
* No use of global variables
* Uniform namespace _CommAPI_XXX
* Modular organization into files
* A lot of additional utility and helper functions

=== Scripts ===
* [[CommAPIConstants.au3]]
* [[CommAPI.au3]]
* [[CommAPIHelper.au3]]
* [[CommUtilities.au3]]
* [[CommInterface.au3]]

=== Examples ===
[[CommAPI Examples]] shows you some examples. Mayby you could find more examples in [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/?p=1126366 forum].

== Background ==
=== History ===
* 2008-09-12 Creation of cfx.au3 [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/#entry578111 (V1.0)]
* 2011-02-18 Conversation of cfx.au3 into cfxUDF.au3 [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/page-2#entry872154 (V2.0)]
* 2011-02-28 Update V2.0to [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/page-2#entry874547 V2.1]
* 2011-04-27 Update V2.1 to [http://www.autoit.de/index.php?page=Thread&postID=217993#post217993 V2.2] (german forum)
* 2013-07-10 Modify V2.1 to [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/page-2#entry1094288 V2.1mod]
* 2013-10-24 Creation of [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/ CommAPI.au3]

=== Changelog ===
; 2014-01-23
: Small update of method _CommAPI_CreateModeString
; 2014-02-03
: Change timeout handling (Attention: not backward compatible)
: Small update of method _CommAPI_PurgeComm
; 2014-03-07
: Rename CommAPIStructures.au3 to CommAPIConstants.au3
: Replace hex values with Constants
; 2014-03-27
: Update of call _WinAPI_CreateFile
: Updated @error handling
: New parameter MaxLen for function _CommAPI_ReceiveData
: New function _CommAPI_ReceiveLine
: Update existing examples and add new examples
; 2014-03-31
: Add constants
: Fix _CommAPI_WaitCommEvent
; 2014-04-03
: Fix reading error Chr(128) to Chr(255)
: Fix error in _CommAPI_TransmitData

=== Roadmap ===
There is no roadmap in the moment. Feel free to implement the last five remaining API calls, enhance the scripts or to fix bugs.

=== Support ===
There is no official support. Try to get help from community in the official forum. [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/ Here you can find the main thread].

=== Resources ===
* [http://msdn.microsoft.com/en-us/library/aa363194(v=vs.85).aspx MSDN Library of communications functions]
* [http://www.hpcc.ecs.soton.ac.uk/software/Win32API.Txt WIN32API.TXT]
* cfxUDF.au3 (see section above)
* [http://www.autoit.de/index.php?page=Thread&postID=198669#post198669 GetCOMPorts] (german forum)
* [http://www.autoitscript.com/forum/topic/19713-problem-with-struct/#entry136466 ParseCommState]

== Functions ==
=== Implemented API functions ===
* BuildCommDCB
* BuildCommDCBAndTimeouts
* ClearCommBreak
* ClearCommError
* EscapeCommFunction
* GetCommMask
* GetCommModemStatus
* GetCommProperties
* GetCommState
* GetCommTimeouts
* PurgeComm
* SetCommBreak
* SetCommMask
* SetCommState
* SetCommTimeouts
* SetupComm
* TransmitCommChar
* WaitCommEvent

=== Unimplemented API functions ===
* CommConfigDialog
* GetCommConfig
* GetDefaultCommConfig
* SetCommConfig
* SetDefaultCommConfig

=== API helper functions ===
* ChangeCommStateElement
* ChangeCommTimeoutsElement
* GetCommStateElement
* GetCommTimeoutsElement
* IsOnCTS
* IsOnDCD
* IsOnDSR
* IsOnRI
* SetCommStateElement
* SetCommTimeoutsElement
* SetOnDTR
* SetOnRTS

=== Utility functions ===
* CommStateToString
* CommTimeoutsToString
* CreateModeString
* GetCOMPorts

=== Interface functions ===
* ClosePort
* OpenCOMPort
* OpenPort
* ReceiveData
* TransmitData

CommInterface.au3

2014-04-03T11:12:04Z

Therealhanuta: fix error in _CommAPI_TransmitData

CommAPI

2014-04-03T08:40:22Z

Therealhanuta: /* Changelog */

CommAPI translates the communications functions of Windows API to AutoIt functions.

== Overview ==
=== Features ===
* No need to install DLL's
* Using Windows API calls (kernel32.dll)
* Possibility of serial communication (serial port, COM port, RS-232)
* Possibility of parallel communication (parallel port, LPT port)
* No use of global variables
* Uniform namespace _CommAPI_XXX
* Modular organization into files
* A lot of additional utility and helper functions

=== Scripts ===
* [[CommAPIConstants.au3]]
* [[CommAPI.au3]]
* [[CommAPIHelper.au3]]
* [[CommUtilities.au3]]
* [[CommInterface.au3]]

=== Examples ===
[[CommAPI Examples]] shows you some examples. Mayby you could find more examples in [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/?p=1126366 forum].

== Background ==
=== History ===
* 2008-09-12 Creation of cfx.au3 [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/#entry578111 (V1.0)]
* 2011-02-18 Conversation of cfx.au3 into cfxUDF.au3 [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/page-2#entry872154 (V2.0)]
* 2011-02-28 Update V2.0to [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/page-2#entry874547 V2.1]
* 2011-04-27 Update V2.1 to [http://www.autoit.de/index.php?page=Thread&postID=217993#post217993 V2.2] (german forum)
* 2013-07-10 Modify V2.1 to [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/page-2#entry1094288 V2.1mod]
* 2013-10-24 Creation of [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/ CommAPI.au3]

=== Changelog ===
; 2014-01-23
: Small update of method _CommAPI_CreateModeString
; 2014-02-03
: Change timeout handling (Attention: not backward compatible)
: Small update of method _CommAPI_PurgeComm
; 2014-03-07
: Rename CommAPIStructures.au3 to CommAPIConstants.au3
: Replace hex values with Constants
; 2014-03-27
: Update of call _WinAPI_CreateFile
: Updated @error handling
: New parameter MaxLen for function _CommAPI_ReceiveData
: New function _CommAPI_ReceiveLine
: Update existing examples and add new examples
; 2014-03-31
: Add constants
: Fix _CommAPI_WaitCommEvent
; 2014-04-03
: Fix reading error Chr(128) to Chr(255)

=== Roadmap ===
There is no roadmap in the moment. Feel free to implement the last five remaining API calls, enhance the scripts or to fix bugs.

=== Support ===
There is no official support. Try to get help from community in the official forum. [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/ Here you can find the main thread].

=== Resources ===
* [http://msdn.microsoft.com/en-us/library/aa363194(v=vs.85).aspx MSDN Library of communications functions]
* [http://www.hpcc.ecs.soton.ac.uk/software/Win32API.Txt WIN32API.TXT]
* cfxUDF.au3 (see section above)
* [http://www.autoit.de/index.php?page=Thread&postID=198669#post198669 GetCOMPorts] (german forum)
* [http://www.autoitscript.com/forum/topic/19713-problem-with-struct/#entry136466 ParseCommState]

== Functions ==
=== Implemented API functions ===
* BuildCommDCB
* BuildCommDCBAndTimeouts
* ClearCommBreak
* ClearCommError
* EscapeCommFunction
* GetCommMask
* GetCommModemStatus
* GetCommProperties
* GetCommState
* GetCommTimeouts
* PurgeComm
* SetCommBreak
* SetCommMask
* SetCommState
* SetCommTimeouts
* SetupComm
* TransmitCommChar
* WaitCommEvent

=== Unimplemented API functions ===
* CommConfigDialog
* GetCommConfig
* GetDefaultCommConfig
* SetCommConfig
* SetDefaultCommConfig

=== API helper functions ===
* ChangeCommStateElement
* ChangeCommTimeoutsElement
* GetCommStateElement
* GetCommTimeoutsElement
* IsOnCTS
* IsOnDCD
* IsOnDSR
* IsOnRI
* SetCommStateElement
* SetCommTimeoutsElement
* SetOnDTR
* SetOnRTS

=== Utility functions ===
* CommStateToString
* CommTimeoutsToString
* CreateModeString
* GetCOMPorts

=== Interface functions ===
* ClosePort
* OpenCOMPort
* OpenPort
* ReceiveData
* TransmitData

CommInterface.au3

2014-04-03T08:39:47Z

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

CommAPI.au3

2014-03-31T09:23:46Z

Therealhanuta: small bugfix

[[Category:Script]]<syntaxhighlight lang="autoit">
; #INDEX# =======================================================================================================================
; Name ..........: CommAPI.au3
; Title .........: Communications Functions of Windows API
; Description ...: Communications Functions of Windows API calls that have been translated to AutoIt functions.
; Version Date ..: 2014-03-31
; AutoIt Version : 3.3.8.1
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363194(v=vs.85).aspx
; Tag(s) ........: RS-232, serial port, COM port
; Author(s) .....:
; Dll(s) ........: kernel32.dll
; Error handling : Everytime @extended is set, it is filled with @ScriptLineNumber of the error.
; ===============================================================================================================================

#include-once
#include "CommAPIConstants.au3"
#NoAutoIt3Execute
#AutoIt3Wrapper_Au3Check_Parameters=-q -d -w 1 -w 2 -w 3 -w- 4 -w 5 -w 6 -w- 7

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_BuildCommDCB
; Description ...: Fills a specified DCB structure with values specified in a device-control string.
; Syntax ........: _CommAPI_BuildCommDCB(Const $sMode, Byref $tDBC)
; Parameters ....: $sMode - [in] A device-definition string.
; $tDBC - [out] A DCB structure.
; Return values .: Success - True
; Failure - False
; @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_BuildCommDCBAndTimeouts, $tagDCB
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363143(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_BuildCommDCB(Const $sMode, ByRef $tDBC)
Local $aResult = DllCall("kernel32.dll", "bool", "BuildCommDCB", "str", $sMode, "ptr", DllStructGetPtr($tDBC))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
If Not $aResult[0] Then Return SetError(-1, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_BuildCommDCB

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_BuildCommDCBAndTimeouts
; Description ...: Translates a device-definition string into appropriate device-control block codes and places them into a device control block.
; The function can also set up time-out values for a device.
; Syntax ........: _CommAPI_BuildCommDCBAndTimeouts(Const $sMode, Byref $tDBC, Byref $tCommTimeouts)
; Parameters ....: $sMode - [in] A device-definition string.
; $tDBC - [out] A DCB structure.
; $tCommTimeouts - [out] A COMMTIMEOUTS structure.
; Return values .: Success - True
; Failure - False
; @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_BuildCommDCB, $tagDCB, $tagCOMMTIMEOUTS
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363145(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_BuildCommDCBAndTimeouts(Const $sMode, ByRef $tDBC, ByRef $tCommTimeouts)
Local $aResult = DllCall("kernel32.dll", "bool", "BuildCommDCBAndTimeouts", "str", $sMode, "ptr", DllStructGetPtr($tDBC), "ptr", DllStructGetPtr($tCommTimeouts))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
If Not $aResult[0] Then Return SetError(-1, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_BuildCommDCBAndTimeouts

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_ClearCommBreak
; Description ...: Restores character transmission for a specified communications device and places the transmission line in a nonbreak state.
; Syntax ........: _CommAPI_ClearCommBreak(Const $hFile)
; Parameters ....: $hFile - [in] A handle to the communications device.
; Return values .: Success - True
; Failure - False
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......: _CommAPI_ClearCommError
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363179(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_ClearCommBreak(Const $hFile)
DllCall("kernel32.dll", "bool", "ClearCommBreak", "handle", $hFile)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_ClearCommBreak

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_ClearCommError
; Description ...: Retrieves information about a communications error and reports the current status of a communications device.
; Syntax ........: _CommAPI_ClearCommError(Const $hFile[, $tComStat = 0])
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tComStat - [out] A COMSTAT structure in which the device's status information is returned.
; Return values .: Success - A mask indicating the type of error.
; Failure - 0
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......: _CommAPI_ClearCommBreak, $tagCOMSTAT
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363180(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_ClearCommError(Const $hFile, $tComStat = 0)
Local $aResult = DllCall("kernel32.dll", "bool", "ClearCommError", "handle", $hFile, "dword*", 0, "ptr", DllStructGetPtr($tComStat))
If @error Then Return SetError(@error, @ScriptLineNumber, 0)
Return $aResult[2]
EndFunc ;==>_CommAPI_ClearCommError

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_EscapeCommFunction
; Description ...: Directs the specified communications device to perform an extended function.
; Syntax ........: _CommAPI_EscapeCommFunction(Const $hFile, Const $iFunction)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $iFunction - [in] The extended function to be performed.
; Return values .: Success - True
; Failure - False
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......: _CommAPI_SetOnDTR, _CommAPI_SetOnRTS
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363254(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_EscapeCommFunction(Const $hFile, Const $iFunction)
DllCall("kernel32.dll", "bool", "EscapeCommFunction", "handle", $hFile, "dword", $iFunction)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_EscapeCommFunction

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_GetCommMask
; Description ...: Retrieves the value of the event mask for a specified communications device.
; Syntax ........: _CommAPI_GetCommMask(Const $hFile)
; Parameters ....: $hFile - [in] A handle to the communications device.
; Return values .: Success - A mask of events that are currently enabled.
; Failure - 0
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363257(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_GetCommMask(Const $hFile)
Local $aResult = DllCall("kernel32.dll", "bool", "GetCommMask", "handle", $hFile, "dword*", 0)
If @error Then Return SetError(@error, @ScriptLineNumber, 0)
Return $aResult[2]
EndFunc ;==>_CommAPI_GetCommMask

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_GetCommModemStatus
; Description ...: Retrieves the modem control-register values.
; Syntax ........: _CommAPI_GetCommModemStatus(Const $hFile, Byref $pModemStatus)
; Parameters ....: $hFile - [in] A handle to the communications device.
; Return values .: Success - The current state of the modem control-register values.
; Failure - 0
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......: _CommAPI_IsOnCTS, _CommAPI_IsOnDSR, _CommAPI_IsOnRI, _CommAPI_IsOnDCD, _CommAPI_WaitCommEvent
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363258(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_GetCommModemStatus(Const $hFile)
Local $aResult = DllCall("kernel32.dll", "bool", "GetCommModemStatus", "handle", $hFile, "dword*", 0)
If @error Then Return SetError(@error, @ScriptLineNumber, 0)
Return $aResult[2]
EndFunc ;==>_CommAPI_GetCommModemStatus

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_GetCommProperties
; Description ...: Retrieves information about the communications properties for a specified communications device.
; Syntax ........: _CommAPI_GetCommProperties(Const $hFile[, $tCOMMPROP = 0])
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tCOMMPROP - [out] A COMMPROP structure in which the communications properties information is returned.
; Return values .: Success - True
; Failure - False
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363259(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_GetCommProperties(Const $hFile, $tCOMMPROP = 0)
DllCall("kernel32.dll", "bool", "GetCommProperties", "handle", $hFile, "ptr", DllStructGetPtr($tCOMMPROP))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_GetCommProperties

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_GetCommState
; Description ...: Retrieves the current control settings for a specified communications device.
; Syntax ........: _CommAPI_GetCommState(Const $hFile, $tDCB = 0)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tDCB - [out] A DCB structure that receives the control settings information.
; Return values .: Success - True
; Failure - False
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......: _CommAPI_SetCommState, $tagDCB
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363260(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_GetCommState(Const $hFile, $tDCB = 0)
DllCall("kernel32.dll", "bool", "GetCommState", "handle", $hFile, "ptr", DllStructGetPtr($tDCB))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_GetCommState

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_GetCommTimeouts
; Description ...: Retrieves the time-out parameters for all read and write operations on a specified communications device.
; Syntax ........: _CommAPI_GetCommTimeouts(Const $hFile, $tCommTimeouts = 0)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tCommTimeouts - [out] A COMMTIMEOUTS structure in which the time-out information is returned.
; Return values .: Success - True
; Failure - False
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......: _CommAPI_SetCommTimeouts, $tagCOMMTIMEOUTS
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363261(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_GetCommTimeouts(Const $hFile, $tCommTimeouts = 0)
DllCall("kernel32.dll", "bool", "GetCommTimeouts", "handle", $hFile, "ptr", DllStructGetPtr($tCommTimeouts))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_GetCommTimeouts

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_PurgeComm
; Description ...: Discards all characters from the output or input buffer of a specified communications resource.
; It can also terminate pending read or write operations on the resource.
; Syntax ........: _CommAPI_PurgeComm(Const $hFile[, $iFlags = $PURGE_ALL])
; Parameters ....: $hFile - [in] A handle to the communications device.
; $iFlags - [in] An integer value.
; Return values .: Success - True
; Failure - False
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363428(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_PurgeComm(Const $hFile, Const $iFlags = $PURGE_ALL)
DllCall("kernel32.dll", "bool", "PurgeComm", "handle", $hFile, "dword", $iFlags)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_PurgeComm

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_SetCommBreak
; Description ...: Suspends character transmission for a specified communications device and places the transmission line in a break state until the ClearCommBreak function is called.
; Syntax ........: _CommAPI_SetCommBreak(Const $hFile)
; Parameters ....: $hFile - [in] A handle to the communications device.
; Return values .: Success - True
; Failure - False
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363433(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_SetCommBreak(Const $hFile)
DllCall("kernel32.dll", "bool", "SetCommBreak", "handle", $hFile)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_SetCommBreak

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_SetCommMask
; Description ...: Specifies a set of events to be monitored for a communications device.
; Syntax ........: _CommAPI_SetCommMask(Const $hFile, Const $iEventMask)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $iEventMask - [in] The events to be enabled. A value of zero disables all events.
; Return values .: Success - True
; Failure - False
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363435(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_SetCommMask(Const $hFile, Const $iEventMask)
DllCall("kernel32.dll", "bool", "SetCommMask", "handle", $hFile, "dword", $iEventMask)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_SetCommMask

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_SetCommState
; Description ...: Configures a communications device according to the specifications in a device-control block.
; The function reinitializes all hardware and control settings, but it does not empty output or input queues.
; Syntax ........: _CommAPI_SetCommState(Const $hFile, Const $tDCB)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tDCB - [in] A DCB structure that contains the configuration information for the specified communications device.
; Return values .: Success - True
; Failure - False
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......: _CommAPI_GetCommState, $tagDCB
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363436(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_SetCommState(Const $hFile, Const $tDCB)
DllCall("kernel32.dll", "bool", "SetCommState", "handle", $hFile, "ptr", DllStructGetPtr($tDCB))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_SetCommState

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_SetCommTimeouts
; Description ...: Sets the time-out parameters for all read and write operations on a specified communications device.
; Syntax ........: _CommAPI_SetCommTimeouts(Const $hFile, Const $tCommTimeouts)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tCommTimeouts - [in] A COMMTIMEOUTS structure that contains the new time-out values.
; Return values .: Success - True
; Failure - False
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......: _CommAPI_GetCommTimeouts, $tagCOMMTIMEOUTS
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363437(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_SetCommTimeouts(Const $hFile, Const $tCommTimeouts)
DllCall("kernel32.dll", "bool", "SetCommTimeouts", "handle", $hFile, "ptr", DllStructGetPtr($tCommTimeouts))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_SetCommTimeouts

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_SetupComm
; Description ...: Initializes the communications parameters for a specified communications device.
; Syntax ........: _CommAPI_SetupComm(Const $hFile, Const $iInQueue, Const $iOutQueue)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $iInQueue - [in] The recommended size of the device's internal input buffer, in bytes.
; $iOutQueue - [in] The recommended size of the device's internal output buffer, in bytes.
; Return values .: Success - True
; Failure - False
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363439(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_SetupComm(Const $hFile, Const $iInQueue, Const $iOutQueue)
DllCall("kernel32.dll", "bool", "SetupComm", "handle", $hFile, "dword", $iInQueue, "dword", $iOutQueue)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_SetupComm

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_TransmitCommChar
; Description ...: Transmits a specified character ahead of any pending data in the output buffer of the specified communications device.
; Syntax ........: _CommAPI_TransmitCommChar(Const $hFile, Const $cChar)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $sChar - [in] The character to be transmitted.
; Return values .: Success - True
; Failure - False
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363473(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_TransmitCommChar(Const $hFile, Const $cChar)
Local $tChar = DllStructCreate("char")
DllStructSetData($tChar, 1, $cChar)
DllCall("kernel32.dll", "bool", "TransmitCommChar", "handle", $hFile, "char", $tChar)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_TransmitCommChar

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_WaitCommEvent
; Description ...: Waits for an event to occur for a specified communications device.
; Syntax ........: _CommAPI_WaitCommEvent(Const $hFile [, Const $tOverlapped = 0])
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tOverlapped - [in] An OVERLAPPED structure.
; Return values .: Success - A mask indicating the type of event that occurred.
; Failure - 0
; @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_EscapeCommFunction, _CommAPI_GetCommModemStatus
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363479(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_WaitCommEvent(Const $hFile, Const $tOverlapped = 0)
Local $pOverlapped = DllStructGetPtr($tOverlapped)
If Not $pOverlapped Then $pOverlapped = DllStructGetPtr(DllStructCreate($tagOverlapped))
Local $aResult = DllCall("kernel32.dll", "bool", "WaitCommEvent", "handle", $hFile, "dword*", 0, "ptr", $pOverlapped)
If @error Then Return SetError(@error, @ScriptLineNumber, 0)
If Not $aResult[2] Then Return SetError(-1, @ScriptLineNumber, 0)
Return $aResult[2]
EndFunc ;==>_CommAPI_WaitCommEvent
</syntaxhighlight>

CommAPIConstants.au3

2014-03-31T09:22:34Z

Therealhanuta: fix _CommAPI_WaitCommEvent

CommAPI

2014-03-31T09:22:00Z

Therealhanuta: /* Changelog */

CommAPI translates the communications functions of Windows API to AutoIt functions.

== Overview ==
=== Features ===
* No need to install DLL's
* Using Windows API calls (kernel32.dll)
* Possibility of serial communication (serial port, COM port, RS-232)
* Possibility of parallel communication (parallel port, LPT port)
* No use of global variables
* Uniform namespace _CommAPI_XXX
* Modular organization into files
* A lot of additional utility and helper functions

=== Scripts ===
* [[CommAPIConstants.au3]]
* [[CommAPI.au3]]
* [[CommAPIHelper.au3]]
* [[CommUtilities.au3]]
* [[CommInterface.au3]]

=== Examples ===
[[CommAPI Examples]] shows you some examples. Mayby you could find more examples in [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/?p=1126366 forum].

== Background ==
=== History ===
* 2008-09-12 Creation of cfx.au3 [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/#entry578111 (V1.0)]
* 2011-02-18 Conversation of cfx.au3 into cfxUDF.au3 [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/page-2#entry872154 (V2.0)]
* 2011-02-28 Update V2.0to [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/page-2#entry874547 V2.1]
* 2011-04-27 Update V2.1 to [http://www.autoit.de/index.php?page=Thread&postID=217993#post217993 V2.2] (german forum)
* 2013-07-10 Modify V2.1 to [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/page-2#entry1094288 V2.1mod]
* 2013-10-24 Creation of [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/ CommAPI.au3]

=== Changelog ===
; 2014-01-23
: Small update of method _CommAPI_CreateModeString
; 2014-02-03
: Change timeout handling (Attention: not backward compatible)
: Small update of method _CommAPI_PurgeComm
; 2014-03-07
: Rename CommAPIStructures.au3 to CommAPIConstants.au3
: Replace hex values with Constants
; 2014-03-27
: Update of call _WinAPI_CreateFile
: Updated @error handling
: New parameter MaxLen for function _CommAPI_ReceiveData
: New function _CommAPI_ReceiveLine
: Update existing examples and add new examples
; 2014-03-31
: Add constants
: Fix _CommAPI_WaitCommEvent

=== Roadmap ===
There is no roadmap in the moment. Feel free to implement the last five remaining API calls, enhance the scripts or to fix bugs.

=== Support ===
There is no official support. Try to get help from community in the official forum. [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/ Here you can find the main thread].

=== Resources ===
* [http://msdn.microsoft.com/en-us/library/aa363194(v=vs.85).aspx MSDN Library of communications functions]
* [http://www.hpcc.ecs.soton.ac.uk/software/Win32API.Txt WIN32API.TXT]
* cfxUDF.au3 (see section above)
* [http://www.autoit.de/index.php?page=Thread&postID=198669#post198669 GetCOMPorts] (german forum)
* [http://www.autoitscript.com/forum/topic/19713-problem-with-struct/#entry136466 ParseCommState]

== Functions ==
=== Implemented API functions ===
* BuildCommDCB
* BuildCommDCBAndTimeouts
* ClearCommBreak
* ClearCommError
* EscapeCommFunction
* GetCommMask
* GetCommModemStatus
* GetCommProperties
* GetCommState
* GetCommTimeouts
* PurgeComm
* SetCommBreak
* SetCommMask
* SetCommState
* SetCommTimeouts
* SetupComm
* TransmitCommChar
* WaitCommEvent

=== Unimplemented API functions ===
* CommConfigDialog
* GetCommConfig
* GetDefaultCommConfig
* SetCommConfig
* SetDefaultCommConfig

=== API helper functions ===
* ChangeCommStateElement
* ChangeCommTimeoutsElement
* GetCommStateElement
* GetCommTimeoutsElement
* IsOnCTS
* IsOnDCD
* IsOnDSR
* IsOnRI
* SetCommStateElement
* SetCommTimeoutsElement
* SetOnDTR
* SetOnRTS

=== Utility functions ===
* CommStateToString
* CommTimeoutsToString
* CreateModeString
* GetCOMPorts

=== Interface functions ===
* ClosePort
* OpenCOMPort
* OpenPort
* ReceiveData
* TransmitData

CommAPI.au3

2014-03-31T09:21:19Z

Therealhanuta: fix _CommAPI_WaitCommEvent

[[Category:Script]]<syntaxhighlight lang="autoit">
; #INDEX# =======================================================================================================================
; Name ..........: CommAPI.au3
; Title .........: Communications Functions of Windows API
; Description ...: Communications Functions of Windows API calls that have been translated to AutoIt functions.
; Version Date ..: 2014-03-31
; AutoIt Version : 3.3.8.1
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363194(v=vs.85).aspx
; Tag(s) ........: RS-232, serial port, COM port
; Author(s) .....:
; Dll(s) ........: kernel32.dll
; Error handling : Everytime @extended is set, it is filled with @ScriptLineNumber of the error.
; ===============================================================================================================================

#include-once
#include "CommAPIConstants.au3"
#NoAutoIt3Execute
#AutoIt3Wrapper_Au3Check_Parameters=-q -d -w 1 -w 2 -w 3 -w- 4 -w 5 -w 6 -w- 7

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_BuildCommDCB
; Description ...: Fills a specified DCB structure with values specified in a device-control string.
; Syntax ........: _CommAPI_BuildCommDCB(Const $sMode, Byref $tDBC)
; Parameters ....: $sMode - [in] A device-definition string.
; $tDBC - [out] A DCB structure.
; Return values .: Success - True
; Failure - False
; @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_BuildCommDCBAndTimeouts, $tagDCB
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363143(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_BuildCommDCB(Const $sMode, ByRef $tDBC)
Local $aResult = DllCall("kernel32.dll", "bool", "BuildCommDCB", "str", $sMode, "ptr", DllStructGetPtr($tDBC))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
If Not $aResult[0] Then Return SetError(-1, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_BuildCommDCB

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_BuildCommDCBAndTimeouts
; Description ...: Translates a device-definition string into appropriate device-control block codes and places them into a device control block.
; The function can also set up time-out values for a device.
; Syntax ........: _CommAPI_BuildCommDCBAndTimeouts(Const $sMode, Byref $tDBC, Byref $tCommTimeouts)
; Parameters ....: $sMode - [in] A device-definition string.
; $tDBC - [out] A DCB structure.
; $tCommTimeouts - [out] A COMMTIMEOUTS structure.
; Return values .: Success - True
; Failure - False
; @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_BuildCommDCB, $tagDCB, $tagCOMMTIMEOUTS
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363145(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_BuildCommDCBAndTimeouts(Const $sMode, ByRef $tDBC, ByRef $tCommTimeouts)
Local $aResult = DllCall("kernel32.dll", "bool", "BuildCommDCBAndTimeouts", "str", $sMode, "ptr", DllStructGetPtr($tDBC), "ptr", DllStructGetPtr($tCommTimeouts))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
If Not $aResult[0] Then Return SetError(-1, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_BuildCommDCBAndTimeouts

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_ClearCommBreak
; Description ...: Restores character transmission for a specified communications device and places the transmission line in a nonbreak state.
; Syntax ........: _CommAPI_ClearCommBreak(Const $hFile)
; Parameters ....: $hFile - [in] A handle to the communications device.
; Return values .: Success - True
; Failure - False
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......: _CommAPI_ClearCommError
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363179(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_ClearCommBreak(Const $hFile)
DllCall("kernel32.dll", "bool", "ClearCommBreak", "handle", $hFile)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_ClearCommBreak

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_ClearCommError
; Description ...: Retrieves information about a communications error and reports the current status of a communications device.
; Syntax ........: _CommAPI_ClearCommError(Const $hFile[, $tComStat = 0])
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tComStat - [out] A COMSTAT structure in which the device's status information is returned.
; Return values .: Success - A mask indicating the type of error.
; Failure - 0
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......: _CommAPI_ClearCommBreak, $tagCOMSTAT
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363180(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_ClearCommError(Const $hFile, $tComStat = 0)
Local $aResult = DllCall("kernel32.dll", "bool", "ClearCommError", "handle", $hFile, "dword*", 0, "ptr", DllStructGetPtr($tComStat))
If @error Then Return SetError(@error, @ScriptLineNumber, 0)
Return $aResult[2]
EndFunc ;==>_CommAPI_ClearCommError

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_EscapeCommFunction
; Description ...: Directs the specified communications device to perform an extended function.
; Syntax ........: _CommAPI_EscapeCommFunction(Const $hFile, Const $iFunction)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $iFunction - [in] The extended function to be performed.
; Return values .: Success - True
; Failure - False
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......: _CommAPI_SetOnDTR, _CommAPI_SetOnRTS
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363254(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_EscapeCommFunction(Const $hFile, Const $iFunction)
DllCall("kernel32.dll", "bool", "EscapeCommFunction", "handle", $hFile, "dword", $iFunction)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_EscapeCommFunction

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_GetCommMask
; Description ...: Retrieves the value of the event mask for a specified communications device.
; Syntax ........: _CommAPI_GetCommMask(Const $hFile)
; Parameters ....: $hFile - [in] A handle to the communications device.
; Return values .: Success - A mask of events that are currently enabled.
; Failure - 0
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363257(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_GetCommMask(Const $hFile)
Local $aResult = DllCall("kernel32.dll", "bool", "GetCommMask", "handle", $hFile, "dword*", 0)
If @error Then Return SetError(@error, @ScriptLineNumber, 0)
Return $aResult[2]
EndFunc ;==>_CommAPI_GetCommMask

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_GetCommModemStatus
; Description ...: Retrieves the modem control-register values.
; Syntax ........: _CommAPI_GetCommModemStatus(Const $hFile, Byref $pModemStatus)
; Parameters ....: $hFile - [in] A handle to the communications device.
; Return values .: Success - The current state of the modem control-register values.
; Failure - 0
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......: _CommAPI_IsOnCTS, _CommAPI_IsOnDSR, _CommAPI_IsOnRI, _CommAPI_IsOnDCD, _CommAPI_WaitCommEvent
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363258(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_GetCommModemStatus(Const $hFile)
Local $aResult = DllCall("kernel32.dll", "bool", "GetCommModemStatus", "handle", $hFile, "dword*", 0)
If @error Then Return SetError(@error, @ScriptLineNumber, 0)
Return $aResult[2]
EndFunc ;==>_CommAPI_GetCommModemStatus

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_GetCommProperties
; Description ...: Retrieves information about the communications properties for a specified communications device.
; Syntax ........: _CommAPI_GetCommProperties(Const $hFile[, $tCOMMPROP = 0])
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tCOMMPROP - [out] A COMMPROP structure in which the communications properties information is returned.
; Return values .: Success - True
; Failure - False
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363259(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_GetCommProperties(Const $hFile, $tCOMMPROP = 0)
DllCall("kernel32.dll", "bool", "GetCommProperties", "handle", $hFile, "ptr", DllStructGetPtr($tCOMMPROP))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_GetCommProperties

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_GetCommState
; Description ...: Retrieves the current control settings for a specified communications device.
; Syntax ........: _CommAPI_GetCommState(Const $hFile, $tDCB = 0)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tDCB - [out] A DCB structure that receives the control settings information.
; Return values .: Success - True
; Failure - False
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......: _CommAPI_SetCommState, $tagDCB
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363260(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_GetCommState(Const $hFile, $tDCB = 0)
DllCall("kernel32.dll", "bool", "GetCommState", "handle", $hFile, "ptr", DllStructGetPtr($tDCB))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_GetCommState

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_GetCommTimeouts
; Description ...: Retrieves the time-out parameters for all read and write operations on a specified communications device.
; Syntax ........: _CommAPI_GetCommTimeouts(Const $hFile, $tCommTimeouts = 0)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tCommTimeouts - [out] A COMMTIMEOUTS structure in which the time-out information is returned.
; Return values .: Success - True
; Failure - False
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......: _CommAPI_SetCommTimeouts, $tagCOMMTIMEOUTS
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363261(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_GetCommTimeouts(Const $hFile, $tCommTimeouts = 0)
DllCall("kernel32.dll", "bool", "GetCommTimeouts", "handle", $hFile, "ptr", DllStructGetPtr($tCommTimeouts))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_GetCommTimeouts

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_PurgeComm
; Description ...: Discards all characters from the output or input buffer of a specified communications resource.
; It can also terminate pending read or write operations on the resource.
; Syntax ........: _CommAPI_PurgeComm(Const $hFile[, $iFlags = $PURGE_ALL])
; Parameters ....: $hFile - [in] A handle to the communications device.
; $iFlags - [in] An integer value.
; Return values .: Success - True
; Failure - False
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363428(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_PurgeComm(Const $hFile, Const $iFlags = $PURGE_ALL)
DllCall("kernel32.dll", "bool", "PurgeComm", "handle", $hFile, "dword", $iFlags)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_PurgeComm

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_SetCommBreak
; Description ...: Suspends character transmission for a specified communications device and places the transmission line in a break state until the ClearCommBreak function is called.
; Syntax ........: _CommAPI_SetCommBreak(Const $hFile)
; Parameters ....: $hFile - [in] A handle to the communications device.
; Return values .: Success - True
; Failure - False
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363433(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_SetCommBreak(Const $hFile)
DllCall("kernel32.dll", "bool", "SetCommBreak", "handle", $hFile)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_SetCommBreak

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_SetCommMask
; Description ...: Specifies a set of events to be monitored for a communications device.
; Syntax ........: _CommAPI_SetCommMask(Const $hFile, Const $iEventMask)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $iEventMask - [in] The events to be enabled. A value of zero disables all events.
; Return values .: Success - True
; Failure - False
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363435(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_SetCommMask(Const $hFile, Const $iEventMask)
DllCall("kernel32.dll", "bool", "SetCommMask", "handle", $hFile, "dword", $iEventMask)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_SetCommMask

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_SetCommState
; Description ...: Configures a communications device according to the specifications in a device-control block.
; The function reinitializes all hardware and control settings, but it does not empty output or input queues.
; Syntax ........: _CommAPI_SetCommState(Const $hFile, Const $tDCB)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tDCB - [in] A DCB structure that contains the configuration information for the specified communications device.
; Return values .: Success - True
; Failure - False
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......: _CommAPI_GetCommState, $tagDCB
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363436(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_SetCommState(Const $hFile, Const $tDCB)
DllCall("kernel32.dll", "bool", "SetCommState", "handle", $hFile, "ptr", DllStructGetPtr($tDCB))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_SetCommState

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_SetCommTimeouts
; Description ...: Sets the time-out parameters for all read and write operations on a specified communications device.
; Syntax ........: _CommAPI_SetCommTimeouts(Const $hFile, Const $tCommTimeouts)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tCommTimeouts - [in] A COMMTIMEOUTS structure that contains the new time-out values.
; Return values .: Success - True
; Failure - False
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......: _CommAPI_GetCommTimeouts, $tagCOMMTIMEOUTS
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363437(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_SetCommTimeouts(Const $hFile, Const $tCommTimeouts)
DllCall("kernel32.dll", "bool", "SetCommTimeouts", "handle", $hFile, "ptr", DllStructGetPtr($tCommTimeouts))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_SetCommTimeouts

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_SetupComm
; Description ...: Initializes the communications parameters for a specified communications device.
; Syntax ........: _CommAPI_SetupComm(Const $hFile, Const $iInQueue, Const $iOutQueue)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $iInQueue - [in] The recommended size of the device's internal input buffer, in bytes.
; $iOutQueue - [in] The recommended size of the device's internal output buffer, in bytes.
; Return values .: Success - True
; Failure - False
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363439(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_SetupComm(Const $hFile, Const $iInQueue, Const $iOutQueue)
DllCall("kernel32.dll", "bool", "SetupComm", "handle", $hFile, "dword", $iInQueue, "dword", $iOutQueue)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_SetupComm

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_TransmitCommChar
; Description ...: Transmits a specified character ahead of any pending data in the output buffer of the specified communications device.
; Syntax ........: _CommAPI_TransmitCommChar(Const $hFile, Const $cChar)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $sChar - [in] The character to be transmitted.
; Return values .: Success - True
; Failure - False
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363473(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_TransmitCommChar(Const $hFile, Const $cChar)
Local $tChar = DllStructCreate("char")
DllStructSetData($tChar, 1, $cChar)
DllCall("kernel32.dll", "bool", "TransmitCommChar", "handle", $hFile, "char", $tChar)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_TransmitCommChar

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_WaitCommEvent
; Description ...: Waits for an event to occur for a specified communications device.
; Syntax ........: _CommAPI_WaitCommEvent(Const $hFile [, Const $tOverlapped = 0])
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tOverlapped - [in] An OVERLAPPED structure.
; Return values .: Success - A mask indicating the type of event that occurred.
; Failure - 0
; @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_EscapeCommFunction, _CommAPI_GetCommModemStatus
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363479(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_WaitCommEvent(Const $hFile, Const $tOverlapped = 0)
Local $pOverlapped = DllStructGetPtr($tOverlapped)
If Not $pOverlapped Then $pOverlapped = DllStructGetPtr(DllStructCreate($tagOverlapped))
Local $aResult = DllCall("kernel32.dll", "bool", "WaitCommEvent", "handle", $hFile, "dword*", 0, "ptr", $pOverlapped)
If @error Then Return SetError(@error, @ScriptLineNumber, 0)
If Not $aResult Then Return SetError(-1, @ScriptLineNumber, 0)
Return $aResult[2]
EndFunc ;==>_CommAPI_WaitCommEvent
</syntaxhighlight>

CommAPI

2014-03-27T15:27:10Z

Therealhanuta: /* Changelog */

CommAPI translates the communications functions of Windows API to AutoIt functions.

== Overview ==
=== Features ===
* No need to install DLL's
* Using Windows API calls (kernel32.dll)
* Possibility of serial communication (serial port, COM port, RS-232)
* Possibility of parallel communication (parallel port, LPT port)
* No use of global variables
* Uniform namespace _CommAPI_XXX
* Modular organization into files
* A lot of additional utility and helper functions

=== Scripts ===
* [[CommAPIConstants.au3]]
* [[CommAPI.au3]]
* [[CommAPIHelper.au3]]
* [[CommUtilities.au3]]
* [[CommInterface.au3]]

=== Examples ===
[[CommAPI Examples]] shows you some examples. Mayby you could find more examples in [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/?p=1126366 forum].

== Background ==
=== History ===
* 2008-09-12 Creation of cfx.au3 [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/#entry578111 (V1.0)]
* 2011-02-18 Conversation of cfx.au3 into cfxUDF.au3 [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/page-2#entry872154 (V2.0)]
* 2011-02-28 Update V2.0to [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/page-2#entry874547 V2.1]
* 2011-04-27 Update V2.1 to [http://www.autoit.de/index.php?page=Thread&postID=217993#post217993 V2.2] (german forum)
* 2013-07-10 Modify V2.1 to [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/page-2#entry1094288 V2.1mod]
* 2013-10-24 Creation of [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/ CommAPI.au3]

=== Changelog ===
; 2014-01-23
: Small update of method _CommAPI_CreateModeString
; 2014-02-03
: Change timeout handling (Attention: not backward compatible)
: Small update of method _CommAPI_PurgeComm
; 2014-03-07
: Rename CommAPIStructures.au3 to CommAPIConstants.au3
: Replace hex values with Constants
; 2014-03-27
: Update of call _WinAPI_CreateFile
: Updated @error handling
: New parameter MaxLen for function _CommAPI_ReceiveData
: New function _CommAPI_ReceiveLine
: Update existing examples and add new examples

=== Roadmap ===
There is no roadmap in the moment. Feel free to implement the last five remaining API calls, enhance the scripts or to fix bugs.

=== Support ===
There is no official support. Try to get help from community in the official forum. [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/ Here you can find the main thread].

=== Resources ===
* [http://msdn.microsoft.com/en-us/library/aa363194(v=vs.85).aspx MSDN Library of communications functions]
* [http://www.hpcc.ecs.soton.ac.uk/software/Win32API.Txt WIN32API.TXT]
* cfxUDF.au3 (see section above)
* [http://www.autoit.de/index.php?page=Thread&postID=198669#post198669 GetCOMPorts] (german forum)
* [http://www.autoitscript.com/forum/topic/19713-problem-with-struct/#entry136466 ParseCommState]

== Functions ==
=== Implemented API functions ===
* BuildCommDCB
* BuildCommDCBAndTimeouts
* ClearCommBreak
* ClearCommError
* EscapeCommFunction
* GetCommMask
* GetCommModemStatus
* GetCommProperties
* GetCommState
* GetCommTimeouts
* PurgeComm
* SetCommBreak
* SetCommMask
* SetCommState
* SetCommTimeouts
* SetupComm
* TransmitCommChar
* WaitCommEvent

=== Unimplemented API functions ===
* CommConfigDialog
* GetCommConfig
* GetDefaultCommConfig
* SetCommConfig
* SetDefaultCommConfig

=== API helper functions ===
* ChangeCommStateElement
* ChangeCommTimeoutsElement
* GetCommStateElement
* GetCommTimeoutsElement
* IsOnCTS
* IsOnDCD
* IsOnDSR
* IsOnRI
* SetCommStateElement
* SetCommTimeoutsElement
* SetOnDTR
* SetOnRTS

=== Utility functions ===
* CommStateToString
* CommTimeoutsToString
* CreateModeString
* GetCOMPorts

=== Interface functions ===
* ClosePort
* OpenCOMPort
* OpenPort
* ReceiveData
* TransmitData

CommInterface.au3

2014-03-27T15:25:36Z

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

CommUtilities.au3

2014-03-27T15:23:58Z

Therealhanuta: updated @error handling

CommAPIHelper.au3

2014-03-27T15:22:56Z

Therealhanuta: updated @error handling

CommAPI.au3

2014-03-27T15:22:04Z

Therealhanuta: updated @error handling

[[Category:Script]]<syntaxhighlight lang="autoit">
; #INDEX# =======================================================================================================================
; Name ..........: CommAPI.au3
; Title .........: Communications Functions of Windows API
; Description ...: Communications Functions of Windows API calls that have been translated to AutoIt functions.
; Version Date ..: 2014-03-27
; AutoIt Version : 3.3.8.1
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363194(v=vs.85).aspx
; Tag(s) ........: RS-232, serial port, COM port
; Author(s) .....:
; Dll(s) ........: kernel32.dll
; Error handling : Everytime @extended is set, it is filled with @ScriptLineNumber of the error.
; ===============================================================================================================================

#include-once
#include "CommAPIConstants.au3"
#NoAutoIt3Execute
#AutoIt3Wrapper_Au3Check_Parameters=-q -d -w 1 -w 2 -w 3 -w- 4 -w 5 -w 6 -w- 7

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_BuildCommDCB
; Description ...: Fills a specified DCB structure with values specified in a device-control string.
; Syntax ........: _CommAPI_BuildCommDCB(Const $sMode, Byref $tDBC)
; Parameters ....: $sMode - [in] A device-definition string.
; $tDBC - [out] A DCB structure.
; Return values .: Success - True
; Failure - False
; @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_BuildCommDCBAndTimeouts, $tagDCB
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363143(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_BuildCommDCB(Const $sMode, ByRef $tDBC)
Local $aResult = DllCall("kernel32.dll", "bool", "BuildCommDCB", "str", $sMode, "ptr", DllStructGetPtr($tDBC))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
If Not $aResult[0] Then Return SetError(-1, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_BuildCommDCB

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_BuildCommDCBAndTimeouts
; Description ...: Translates a device-definition string into appropriate device-control block codes and places them into a device control block.
; The function can also set up time-out values for a device.
; Syntax ........: _CommAPI_BuildCommDCBAndTimeouts(Const $sMode, Byref $tDBC, Byref $tCommTimeouts)
; Parameters ....: $sMode - [in] A device-definition string.
; $tDBC - [out] A DCB structure.
; $tCommTimeouts - [out] A COMMTIMEOUTS structure.
; Return values .: Success - True
; Failure - False
; @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_BuildCommDCB, $tagDCB, $tagCOMMTIMEOUTS
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363145(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_BuildCommDCBAndTimeouts(Const $sMode, ByRef $tDBC, ByRef $tCommTimeouts)
Local $aResult = DllCall("kernel32.dll", "bool", "BuildCommDCBAndTimeouts", "str", $sMode, "ptr", DllStructGetPtr($tDBC), "ptr", DllStructGetPtr($tCommTimeouts))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
If Not $aResult[0] Then Return SetError(-1, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_BuildCommDCBAndTimeouts

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_ClearCommBreak
; Description ...: Restores character transmission for a specified communications device and places the transmission line in a nonbreak state.
; Syntax ........: _CommAPI_ClearCommBreak(Const $hFile)
; Parameters ....: $hFile - [in] A handle to the communications device.
; Return values .: Success - True
; Failure - False
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......: _CommAPI_ClearCommError
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363179(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_ClearCommBreak(Const $hFile)
DllCall("kernel32.dll", "bool", "ClearCommBreak", "handle", $hFile)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_ClearCommBreak

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_ClearCommError
; Description ...: Retrieves information about a communications error and reports the current status of a communications device.
; Syntax ........: _CommAPI_ClearCommError(Const $hFile[, $tComStat = 0])
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tComStat - [out] A COMSTAT structure in which the device's status information is returned.
; Return values .: Success - A mask indicating the type of error.
; Failure - 0
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......: _CommAPI_ClearCommBreak, $tagCOMSTAT
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363180(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_ClearCommError(Const $hFile, $tComStat = 0)
Local $aResult = DllCall("kernel32.dll", "bool", "ClearCommError", "handle", $hFile, "dword*", 0, "ptr", DllStructGetPtr($tComStat))
If @error Then Return SetError(@error, @ScriptLineNumber, 0)
Return $aResult[2]
EndFunc ;==>_CommAPI_ClearCommError

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_EscapeCommFunction
; Description ...: Directs the specified communications device to perform an extended function.
; Syntax ........: _CommAPI_EscapeCommFunction(Const $hFile, Const $iFunction)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $iFunction - [in] The extended function to be performed.
; Return values .: Success - True
; Failure - False
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......: _CommAPI_SetOnDTR, _CommAPI_SetOnRTS
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363254(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_EscapeCommFunction(Const $hFile, Const $iFunction)
DllCall("kernel32.dll", "bool", "EscapeCommFunction", "handle", $hFile, "dword", $iFunction)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_EscapeCommFunction

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_GetCommMask
; Description ...: Retrieves the value of the event mask for a specified communications device.
; Syntax ........: _CommAPI_GetCommMask(Const $hFile)
; Parameters ....: $hFile - [in] A handle to the communications device.
; Return values .: Success - A mask of events that are currently enabled.
; Failure - 0
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363257(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_GetCommMask(Const $hFile)
Local $aResult = DllCall("kernel32.dll", "bool", "GetCommMask", "handle", $hFile, "dword*", 0)
If @error Then Return SetError(@error, @ScriptLineNumber, 0)
Return $aResult[2]
EndFunc ;==>_CommAPI_GetCommMask

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_GetCommModemStatus
; Description ...: Retrieves the modem control-register values.
; Syntax ........: _CommAPI_GetCommModemStatus(Const $hFile, Byref $pModemStatus)
; Parameters ....: $hFile - [in] A handle to the communications device.
; Return values .: Success - The current state of the modem control-register values.
; Failure - 0
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......: _CommAPI_IsOnCTS, _CommAPI_IsOnDSR, _CommAPI_IsOnRI, _CommAPI_IsOnDCD, _CommAPI_WaitCommEvent
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363258(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_GetCommModemStatus(Const $hFile)
Local $aResult = DllCall("kernel32.dll", "bool", "GetCommModemStatus", "handle", $hFile, "dword*", 0)
If @error Then Return SetError(@error, @ScriptLineNumber, 0)
Return $aResult[2]
EndFunc ;==>_CommAPI_GetCommModemStatus

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_GetCommProperties
; Description ...: Retrieves information about the communications properties for a specified communications device.
; Syntax ........: _CommAPI_GetCommProperties(Const $hFile[, $tCOMMPROP = 0])
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tCOMMPROP - [out] A COMMPROP structure in which the communications properties information is returned.
; Return values .: Success - True
; Failure - False
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363259(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_GetCommProperties(Const $hFile, $tCOMMPROP = 0)
DllCall("kernel32.dll", "bool", "GetCommProperties", "handle", $hFile, "ptr", DllStructGetPtr($tCOMMPROP))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_GetCommProperties

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_GetCommState
; Description ...: Retrieves the current control settings for a specified communications device.
; Syntax ........: _CommAPI_GetCommState(Const $hFile, $tDCB = 0)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tDCB - [out] A DCB structure that receives the control settings information.
; Return values .: Success - True
; Failure - False
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......: _CommAPI_SetCommState, $tagDCB
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363260(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_GetCommState(Const $hFile, $tDCB = 0)
DllCall("kernel32.dll", "bool", "GetCommState", "handle", $hFile, "ptr", DllStructGetPtr($tDCB))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_GetCommState

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_GetCommTimeouts
; Description ...: Retrieves the time-out parameters for all read and write operations on a specified communications device.
; Syntax ........: _CommAPI_GetCommTimeouts(Const $hFile, $tCommTimeouts = 0)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tCommTimeouts - [out] A COMMTIMEOUTS structure in which the time-out information is returned.
; Return values .: Success - True
; Failure - False
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......: _CommAPI_SetCommTimeouts, $tagCOMMTIMEOUTS
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363261(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_GetCommTimeouts(Const $hFile, $tCommTimeouts = 0)
DllCall("kernel32.dll", "bool", "GetCommTimeouts", "handle", $hFile, "ptr", DllStructGetPtr($tCommTimeouts))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_GetCommTimeouts

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_PurgeComm
; Description ...: Discards all characters from the output or input buffer of a specified communications resource.
; It can also terminate pending read or write operations on the resource.
; Syntax ........: _CommAPI_PurgeComm(Const $hFile[, $iFlags = $PURGE_ALL])
; Parameters ....: $hFile - [in] A handle to the communications device.
; $iFlags - [in] An integer value.
; Return values .: Success - True
; Failure - False
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363428(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_PurgeComm(Const $hFile, Const $iFlags = $PURGE_ALL)
DllCall("kernel32.dll", "bool", "PurgeComm", "handle", $hFile, "dword", $iFlags)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_PurgeComm

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_SetCommBreak
; Description ...: Suspends character transmission for a specified communications device and places the transmission line in a break state until the ClearCommBreak function is called.
; Syntax ........: _CommAPI_SetCommBreak(Const $hFile)
; Parameters ....: $hFile - [in] A handle to the communications device.
; Return values .: Success - True
; Failure - False
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363433(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_SetCommBreak(Const $hFile)
DllCall("kernel32.dll", "bool", "SetCommBreak", "handle", $hFile)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_SetCommBreak

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_SetCommMask
; Description ...: Specifies a set of events to be monitored for a communications device.
; Syntax ........: _CommAPI_SetCommMask(Const $hFile, Const $iEventMask)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $iEventMask - [in] The events to be enabled. A value of zero disables all events.
; Return values .: Success - True
; Failure - False
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363435(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_SetCommMask(Const $hFile, Const $iEventMask)
DllCall("kernel32.dll", "bool", "SetCommMask", "handle", $hFile, "dword", $iEventMask)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_SetCommMask

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_SetCommState
; Description ...: Configures a communications device according to the specifications in a device-control block.
; The function reinitializes all hardware and control settings, but it does not empty output or input queues.
; Syntax ........: _CommAPI_SetCommState(Const $hFile, Const $tDCB)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tDCB - [in] A DCB structure that contains the configuration information for the specified communications device.
; Return values .: Success - True
; Failure - False
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......: _CommAPI_GetCommState, $tagDCB
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363436(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_SetCommState(Const $hFile, Const $tDCB)
DllCall("kernel32.dll", "bool", "SetCommState", "handle", $hFile, "ptr", DllStructGetPtr($tDCB))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_SetCommState

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_SetCommTimeouts
; Description ...: Sets the time-out parameters for all read and write operations on a specified communications device.
; Syntax ........: _CommAPI_SetCommTimeouts(Const $hFile, Const $tCommTimeouts)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tCommTimeouts - [in] A COMMTIMEOUTS structure that contains the new time-out values.
; Return values .: Success - True
; Failure - False
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......: _CommAPI_GetCommTimeouts, $tagCOMMTIMEOUTS
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363437(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_SetCommTimeouts(Const $hFile, Const $tCommTimeouts)
DllCall("kernel32.dll", "bool", "SetCommTimeouts", "handle", $hFile, "ptr", DllStructGetPtr($tCommTimeouts))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_SetCommTimeouts

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_SetupComm
; Description ...: Initializes the communications parameters for a specified communications device.
; Syntax ........: _CommAPI_SetupComm(Const $hFile, Const $iInQueue, Const $iOutQueue)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $iInQueue - [in] The recommended size of the device's internal input buffer, in bytes.
; $iOutQueue - [in] The recommended size of the device's internal output buffer, in bytes.
; Return values .: Success - True
; Failure - False
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363439(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_SetupComm(Const $hFile, Const $iInQueue, Const $iOutQueue)
DllCall("kernel32.dll", "bool", "SetupComm", "handle", $hFile, "dword", $iInQueue, "dword", $iOutQueue)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_SetupComm

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_TransmitCommChar
; Description ...: Transmits a specified character ahead of any pending data in the output buffer of the specified communications device.
; Syntax ........: _CommAPI_TransmitCommChar(Const $hFile, Const $cChar)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $sChar - [in] The character to be transmitted.
; Return values .: Success - True
; Failure - False
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363473(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_TransmitCommChar(Const $hFile, Const $cChar)
Local $tChar = DllStructCreate("char")
DllStructSetData($tChar, 1, $cChar)
DllCall("kernel32.dll", "bool", "TransmitCommChar", "handle", $hFile, "char", $tChar)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_TransmitCommChar

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_WaitCommEvent
; Description ...: Waits for an event to occur for a specified communications device.
; Syntax ........: _CommAPI_WaitCommEvent(Const $hFile [, Const $tOverlapped = 0])
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tOverlapped - [in] An OVERLAPPED structure.
; Return values .: Success - A mask indicating the type of event that occurred.
; Failure - 0
; @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
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......: _CommAPI_EscapeCommFunction, _CommAPI_GetCommModemStatus
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363479(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_WaitCommEvent(Const $hFile, Const $tOverlapped = 0)
Local $aResult = DllCall("kernel32.dll", "bool", "WaitCommEvent", "handle", $hFile, "dword*", 0, "ptr", DllStructGetPtr($tOverlapped))
If @error Then Return SetError(@error, @ScriptLineNumber, 0)
Return $aResult[2]
EndFunc ;==>_CommAPI_WaitCommEvent
</syntaxhighlight>

CommAPI Examples

2014-03-27T15:17:30Z

Therealhanuta: update existing examples and add new examples

[[Category:Samples]]
== Introduction ==
This site shows you some examples for [[CommAPI]].
You will also need the following snippet for all examples:

<syntaxhighlight lang="autoit">
#include "CommInterface.au3"
#AutoIt3Wrapper_Au3Check_Parameters=-q -d -w 1 -w 2 -w 3 -w- 4 -w 5 -w 6 -w- 7

Main()

Func Main()
Local $sResult = Example()
Switch @error
Case 0
MsgBox(64, "Result", $sResult)
Case -1
MsgBox(32, "Error", _WinAPI_GetLastErrorMessage())
Case -2
MsgBox(32, "Timeout", $sResult)
Case Else
MsgBox(32, "Error", "Error " & @error & " in line " & @extended)
EndSwitch
EndFunc
</syntaxhighlight>

== First example ==
<syntaxhighlight lang="autoit">
Func Example()
Local Const $iPort = 1
Local Const $iBaud = 9600
Local Const $iParity = 0
Local Const $iByteSize = 8
Local Const $iStopBits = 1
Local Const $sCommand = "Command" & @CRLF

Local $hFile = _CommAPI_OpenCOMPort($iPort, $iBaud, $iParity, $iByteSize, $iStopBits)
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_ClearCommError($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_PurgeComm($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_TransmitData($hFile, $sCommand)
If @error Then Return SetError(@error, @ScriptLineNumber)

Local $sResult = _CommAPI_ReceiveData($hFile, 5000)
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)

_CommAPI_ClosePort($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)

Return $sResult
EndFunc
</syntaxhighlight>

== INI file==
<syntaxhighlight lang="autoit">
Func Example()
Local Const $sFileINI = @ScriptDir & "\Example.ini"

Local $sMode = _CommAPI_CreateModeString( _
IniRead($sFileINI, "COM", "SerialPort", 1), _
IniRead($sFileINI, "COM", "BaudRate", 9600), _
IniRead($sFileINI, "COM", "Parity", 0), _
IniRead($sFileINI, "COM", "ByteSize", 8), _
IniRead($sFileINI, "COM", "StopBits", 1), _
IniRead($sFileINI, "COM", "XON", 0), _
IniRead($sFileINI, "COM", "DSR", 0), _
IniRead($sFileINI, "COM", "CTS", 1), _
IniRead($sFileINI, "COM", "DTR", 1), _
IniRead($sFileINI, "COM", "RTS", 1), _
IniRead($sFileINI, "COM", "IDSR", 0))
If @error Then Return SetError(@error, @ScriptLineNumber)

Local $hFile = _CommAPI_OpenPort($sMode)
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_ClearCommError($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_PurgeComm($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_TransmitData($hFile, IniRead($sFileINI, "COM", "Command", "Command" & @CRLF))
If @error Then Return SetError(@error, @ScriptLineNumber)

Local $sResult = _CommAPI_ReceiveData($hFile, IniRead($sFileINI, "Timeout", "IDSR", 5000))
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)

_CommAPI_ClosePort($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)

Return $sResult
EndFunc
</syntaxhighlight>

== Command Line ==
<syntaxhighlight lang="autoit">
Func Example()
If $CmdLine[0] <> 2 Then
MsgBox(32, "Syntax", @ScriptName & ' "ModeString" "Command"')
Exit
EndIf

Local $hFile = _CommAPI_OpenPort($CmdLine[1])
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_ClearCommError($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_PurgeComm($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_TransmitData($hFile, $CmdLine[2])
If @error Then Return SetError(@error, @ScriptLineNumber)

Local $sResult = _CommAPI_ReceiveData($hFile, 5000)
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)

_CommAPI_ClosePort($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)

Return $sResult
EndFunc
</syntaxhighlight>

<syntaxhighlight lang="winbatch">
@echo off
cls
chcp 1252>nul
cd /d "%~dp0"
start Example.exe "COM1: BAUD=9600 PARITY=N DATA=8 STOP=1 XON=OFF ODSR=OFF OCTS=ON DTR=ON RTS=ON IDSR=OFF" "Command"
</syntaxhighlight>

== Separator ==
<syntaxhighlight lang="autoit">
Func Example()
Local $hFile = _CommAPI_OpenCOMPort(1, 9600, 0, 8, 1)
If @error Then Return SetError(@error, @ScriptLineNumber)

Local $sResult = _CommAPI_ReceiveLine($hFile, "<CR>", 5000)
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)

_CommAPI_ClosePort($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)

Return $sResult
EndFunc
</syntaxhighlight>

== Slow Devices ==
For some slow devices the default timeout is too small of one millisecond.
<syntaxhighlight lang="autoit">
Func Example()
Local $hFile = _CommAPI_OpenCOMPort(1, 9600, 0, 8, 1)
If @error Then Return SetError(@error, @ScriptLineNumber)

_CommAPI_ChangeCommTimeoutsElement($hFile, "ReadTotalTimeoutMultiplier", 100)
If @error Then Return SetError(@error, @ScriptLineNumber)

Local $sResult = _CommAPI_ReceiveData($hFile, 5000)
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)

_CommAPI_ClosePort($hFile)
If @error Then Return SetError(@error, @ScriptLineNumber, $sResult)

Return $sResult
EndFunc
</syntaxhighlight>

CommAPI

2014-03-27T12:06:48Z

Therealhanuta: /* Changelog */

CommAPI translates the communications functions of Windows API to AutoIt functions.

== Overview ==
=== Features ===
* No need to install DLL's
* Using Windows API calls (kernel32.dll)
* Possibility of serial communication (serial port, COM port, RS-232)
* Possibility of parallel communication (parallel port, LPT port)
* No use of global variables
* Uniform namespace _CommAPI_XXX
* Modular organization into files
* A lot of additional utility and helper functions

=== Scripts ===
* [[CommAPIConstants.au3]]
* [[CommAPI.au3]]
* [[CommAPIHelper.au3]]
* [[CommUtilities.au3]]
* [[CommInterface.au3]]

=== Examples ===
[[CommAPI Examples]] shows you some examples. Mayby you could find more examples in [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/?p=1126366 forum].

== Background ==
=== History ===
* 2008-09-12 Creation of cfx.au3 [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/#entry578111 (V1.0)]
* 2011-02-18 Conversation of cfx.au3 into cfxUDF.au3 [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/page-2#entry872154 (V2.0)]
* 2011-02-28 Update V2.0to [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/page-2#entry874547 V2.1]
* 2011-04-27 Update V2.1 to [http://www.autoit.de/index.php?page=Thread&postID=217993#post217993 V2.2] (german forum)
* 2013-07-10 Modify V2.1 to [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/page-2#entry1094288 V2.1mod]
* 2013-10-24 Creation of [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/ CommAPI.au3]

=== Changelog ===
; 2014-01-23
: Small update of method _CommAPI_CreateModeString
; 2014-02-03
: Change timeout handling (Attention: not backward compatible)
: Small update of method _CommAPI_PurgeComm
; 2014-03-07
: Rename CommAPIStructures.au3 to CommAPIConstants.au3
: Replace hex values with Constants
; 2014-03-27
: Update of call _WinAPI_CreateFile

=== Roadmap ===
There is no roadmap in the moment. Feel free to implement the last five remaining API calls, enhance the scripts or to fix bugs.

=== Support ===
There is no official support. Try to get help from community in the official forum. [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/ Here you can find the main thread].

=== Resources ===
* [http://msdn.microsoft.com/en-us/library/aa363194(v=vs.85).aspx MSDN Library of communications functions]
* [http://www.hpcc.ecs.soton.ac.uk/software/Win32API.Txt WIN32API.TXT]
* cfxUDF.au3 (see section above)
* [http://www.autoit.de/index.php?page=Thread&postID=198669#post198669 GetCOMPorts] (german forum)
* [http://www.autoitscript.com/forum/topic/19713-problem-with-struct/#entry136466 ParseCommState]

== Functions ==
=== Implemented API functions ===
* BuildCommDCB
* BuildCommDCBAndTimeouts
* ClearCommBreak
* ClearCommError
* EscapeCommFunction
* GetCommMask
* GetCommModemStatus
* GetCommProperties
* GetCommState
* GetCommTimeouts
* PurgeComm
* SetCommBreak
* SetCommMask
* SetCommState
* SetCommTimeouts
* SetupComm
* TransmitCommChar
* WaitCommEvent

=== Unimplemented API functions ===
* CommConfigDialog
* GetCommConfig
* GetDefaultCommConfig
* SetCommConfig
* SetDefaultCommConfig

=== API helper functions ===
* ChangeCommStateElement
* ChangeCommTimeoutsElement
* GetCommStateElement
* GetCommTimeoutsElement
* IsOnCTS
* IsOnDCD
* IsOnDSR
* IsOnRI
* SetCommStateElement
* SetCommTimeoutsElement
* SetOnDTR
* SetOnRTS

=== Utility functions ===
* CommStateToString
* CommTimeoutsToString
* CreateModeString
* GetCOMPorts

=== Interface functions ===
* ClosePort
* OpenCOMPort
* OpenPort
* ReceiveData
* TransmitData

CommInterface.au3

2014-03-27T08:57:09Z

Therealhanuta: Update call of _WinAPI_CreateFile

CommAPIConstants.au3

2014-03-10T08:44:38Z

Therealhanuta: #INDEX#

CommAPI

2014-03-07T10:02:33Z

Therealhanuta: /* Changelog */

CommAPI translates the communications functions of Windows API to AutoIt functions.

== Overview ==
=== Features ===
* No need to install DLL's
* Using Windows API calls (kernel32.dll)
* Possibility of serial communication (serial port, COM port, RS-232)
* Possibility of parallel communication (parallel port, LPT port)
* No use of global variables
* Uniform namespace _CommAPI_XXX
* Modular organization into files
* A lot of additional utility and helper functions

=== Scripts ===
* [[CommAPIConstants.au3]]
* [[CommAPI.au3]]
* [[CommAPIHelper.au3]]
* [[CommUtilities.au3]]
* [[CommInterface.au3]]

=== Examples ===
[[CommAPI Examples]] shows you some examples. Mayby you could find more examples in [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/?p=1126366 forum].

== Background ==
=== History ===
* 2008-09-12 Creation of cfx.au3 [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/#entry578111 (V1.0)]
* 2011-02-18 Conversation of cfx.au3 into cfxUDF.au3 [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/page-2#entry872154 (V2.0)]
* 2011-02-28 Update V2.0to [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/page-2#entry874547 V2.1]
* 2011-04-27 Update V2.1 to [http://www.autoit.de/index.php?page=Thread&postID=217993#post217993 V2.2] (german forum)
* 2013-07-10 Modify V2.1 to [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/page-2#entry1094288 V2.1mod]
* 2013-10-24 Creation of [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/ CommAPI.au3]

=== Changelog ===
; 2014-01-23
: Small update of method _CommAPI_CreateModeString
; 2014-02-03
: Change timeout handling (Attention: not backward compatible)
: Small update of method _CommAPI_PurgeComm
; 2014-03-07
: Rename CommAPIStructures.au3 to CommAPIConstants.au3
: Replace hex values with Constants

=== Roadmap ===
There is no roadmap in the moment. Feel free to implement the last five remaining API calls, enhance the scripts or to fix bugs.

=== Support ===
There is no official support. Try to get help from community in the official forum. [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/ Here you can find the main thread].

=== Resources ===
* [http://msdn.microsoft.com/en-us/library/aa363194(v=vs.85).aspx MSDN Library of communications functions]
* [http://www.hpcc.ecs.soton.ac.uk/software/Win32API.Txt WIN32API.TXT]
* cfxUDF.au3 (see section above)
* [http://www.autoit.de/index.php?page=Thread&postID=198669#post198669 GetCOMPorts] (german forum)
* [http://www.autoitscript.com/forum/topic/19713-problem-with-struct/#entry136466 ParseCommState]

== Functions ==
=== Implemented API functions ===
* BuildCommDCB
* BuildCommDCBAndTimeouts
* ClearCommBreak
* ClearCommError
* EscapeCommFunction
* GetCommMask
* GetCommModemStatus
* GetCommProperties
* GetCommState
* GetCommTimeouts
* PurgeComm
* SetCommBreak
* SetCommMask
* SetCommState
* SetCommTimeouts
* SetupComm
* TransmitCommChar
* WaitCommEvent

=== Unimplemented API functions ===
* CommConfigDialog
* GetCommConfig
* GetDefaultCommConfig
* SetCommConfig
* SetDefaultCommConfig

=== API helper functions ===
* ChangeCommStateElement
* ChangeCommTimeoutsElement
* GetCommStateElement
* GetCommTimeoutsElement
* IsOnCTS
* IsOnDCD
* IsOnDSR
* IsOnRI
* SetCommStateElement
* SetCommTimeoutsElement
* SetOnDTR
* SetOnRTS

=== Utility functions ===
* CommStateToString
* CommTimeoutsToString
* CreateModeString
* GetCOMPorts

=== Interface functions ===
* ClosePort
* OpenCOMPort
* OpenPort
* ReceiveData
* TransmitData

CommInterface.au3

2014-03-07T10:01:19Z

Therealhanuta: Replace hex values with Constants

CommUtilities.au3

2014-03-07T10:00:56Z

Therealhanuta: Replace hex values with Constants

CommAPIHelper.au3

2014-03-07T10:00:34Z

Therealhanuta: Replace hex values with Constants

CommAPI.au3

2014-03-07T10:00:03Z

Therealhanuta: Replace hex values with Constants

[[Category:Script]]<syntaxhighlight lang="autoit">
; #INDEX# =======================================================================================================================
; Name ..........: CommAPI.au3
; Title .........: Communications Functions of Windows API
; Description ...: Communications Functions of Windows API calls that have been translated to AutoIt functions.
; Version Date ..: 2014-03-07
; AutoIt Version : 3.3.8.1
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363194(v=vs.85).aspx
; Tag(s) ........: RS-232, serial port, COM port
; Author(s) .....:
; Dll(s) ........: kernel32.dll
; Error handling : Everytime @extended is set, it is filled with @ScriptLineNumber of the error in CommAPI.au3.
; Everytime @extended is set, you can call _WinAPI_GetLastError or _WinAPI_GetLastErrorMessage.
; ===============================================================================================================================

#include-once
#include "CommAPIConstants.au3"
#NoAutoIt3Execute
#AutoIt3Wrapper_Au3Check_Parameters=-q -d -w 1 -w 2 -w 3 -w- 4 -w 5 -w 6 -w- 7

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_BuildCommDCB
; Description ...: Fills a specified DCB structure with values specified in a device-control string.
; Syntax ........: _CommAPI_BuildCommDCB(Const $sMode, Byref $tDBC)
; Parameters ....: $sMode - [in] A device-definition string.
; $tDBC - [out] A DCB structure.
; Return values .: Success - True
; Failure - False
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......: _CommAPI_BuildCommDCBAndTimeouts, $tagDCB
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363143(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_BuildCommDCB(Const $sMode, ByRef $tDBC)
Local $aResult = DllCall("kernel32.dll", "bool", "BuildCommDCB", "str", $sMode, "ptr", DllStructGetPtr($tDBC))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
If Not $aResult[0] Then Return SetError(6, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_BuildCommDCB

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_BuildCommDCBAndTimeouts
; Description ...: Translates a device-definition string into appropriate device-control block codes and places them into a device control block.
; The function can also set up time-out values for a device.
; Syntax ........: _CommAPI_BuildCommDCBAndTimeouts(Const $sMode, Byref $tDBC, Byref $tCommTimeouts)
; Parameters ....: $sMode - [in] A device-definition string.
; $tDBC - [out] A DCB structure.
; $tCommTimeouts - [out] A COMMTIMEOUTS structure.
; Return values .: Success - True
; Failure - False
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......: _CommAPI_BuildCommDCB, $tagDCB, $tagCOMMTIMEOUTS
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363145(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_BuildCommDCBAndTimeouts(Const $sMode, ByRef $tDBC, ByRef $tCommTimeouts)
Local $aResult = DllCall("kernel32.dll", "bool", "BuildCommDCBAndTimeouts", "str", $sMode, "ptr", DllStructGetPtr($tDBC), "ptr", DllStructGetPtr($tCommTimeouts))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
If Not $aResult[0] Then Return SetError(6, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_BuildCommDCBAndTimeouts

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_ClearCommBreak
; Description ...: Restores character transmission for a specified communications device and places the transmission line in a nonbreak state.
; Syntax ........: _CommAPI_ClearCommBreak(Const $hFile)
; Parameters ....: $hFile - [in] A handle to the communications device.
; Return values .: Success - True
; Failure - False
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......: _CommAPI_ClearCommError
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363179(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_ClearCommBreak(Const $hFile)
DllCall("kernel32.dll", "bool", "ClearCommBreak", "handle", $hFile)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_ClearCommBreak

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_ClearCommError
; Description ...: Retrieves information about a communications error and reports the current status of a communications device.
; Syntax ........: _CommAPI_ClearCommError(Const $hFile[, $tComStat = 0])
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tComStat - [out] A COMSTAT structure in which the device's status information is returned.
; Return values .: Success - A mask indicating the type of error.
; Failure - 0
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......: _CommAPI_ClearCommBreak, $tagCOMSTAT
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363180(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_ClearCommError(Const $hFile, $tComStat = 0)
Local $aResult = DllCall("kernel32.dll", "bool", "ClearCommError", "handle", $hFile, "dword*", 0, "ptr", DllStructGetPtr($tComStat))
If @error Then Return SetError(@error, @ScriptLineNumber, 0)
Return $aResult[2]
EndFunc ;==>_CommAPI_ClearCommError

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_EscapeCommFunction
; Description ...: Directs the specified communications device to perform an extended function.
; Syntax ........: _CommAPI_EscapeCommFunction(Const $hFile, Const $iFunction)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $iFunction - [in] The extended function to be performed.
; Return values .: Success - True
; Failure - False
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......: _CommAPI_SetOnDTR, _CommAPI_SetOnRTS
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363254(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_EscapeCommFunction(Const $hFile, Const $iFunction)
DllCall("kernel32.dll", "bool", "EscapeCommFunction", "handle", $hFile, "dword", $iFunction)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_EscapeCommFunction

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_GetCommMask
; Description ...: Retrieves the value of the event mask for a specified communications device.
; Syntax ........: _CommAPI_GetCommMask(Const $hFile)
; Parameters ....: $hFile - [in] A handle to the communications device.
; Return values .: Success - A mask of events that are currently enabled.
; Failure - 0
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363257(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_GetCommMask(Const $hFile)
Local $aResult = DllCall("kernel32.dll", "bool", "GetCommMask", "handle", $hFile, "dword*", 0)
If @error Then Return SetError(@error, @ScriptLineNumber, 0)
Return $aResult[2]
EndFunc ;==>_CommAPI_GetCommMask

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_GetCommModemStatus
; Description ...: Retrieves the modem control-register values.
; Syntax ........: _CommAPI_GetCommModemStatus(Const $hFile, Byref $pModemStatus)
; Parameters ....: $hFile - [in] A handle to the communications device.
; Return values .: Success - The current state of the modem control-register values.
; Failure - 0
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......: _CommAPI_IsOnCTS, _CommAPI_IsOnDSR, _CommAPI_IsOnRI, _CommAPI_IsOnDCD, _CommAPI_WaitCommEvent
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363258(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_GetCommModemStatus(Const $hFile)
Local $aResult = DllCall("kernel32.dll", "bool", "GetCommModemStatus", "handle", $hFile, "dword*", 0)
If @error Then Return SetError(@error, @ScriptLineNumber, 0)
Return $aResult[2]
EndFunc ;==>_CommAPI_GetCommModemStatus

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_GetCommProperties
; Description ...: Retrieves information about the communications properties for a specified communications device.
; Syntax ........: _CommAPI_GetCommProperties(Const $hFile[, $tCOMMPROP = 0])
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tCOMMPROP - [out] A COMMPROP structure in which the communications properties information is returned.
; Return values .: Success - True
; Failure - False
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363259(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_GetCommProperties(Const $hFile, $tCOMMPROP = 0)
DllCall("kernel32.dll", "bool", "GetCommProperties", "handle", $hFile, "ptr", DllStructGetPtr($tCOMMPROP))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_GetCommProperties

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_GetCommState
; Description ...: Retrieves the current control settings for a specified communications device.
; Syntax ........: _CommAPI_GetCommState(Const $hFile, $tDCB = 0)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tDCB - [out] A DCB structure that receives the control settings information.
; Return values .: Success - True
; Failure - False
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......: _CommAPI_SetCommState, $tagDCB
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363260(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_GetCommState(Const $hFile, $tDCB = 0)
DllCall("kernel32.dll", "bool", "GetCommState", "handle", $hFile, "ptr", DllStructGetPtr($tDCB))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_GetCommState

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_GetCommTimeouts
; Description ...: Retrieves the time-out parameters for all read and write operations on a specified communications device.
; Syntax ........: _CommAPI_GetCommTimeouts(Const $hFile, $tCommTimeouts = 0)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tCommTimeouts - [out] A COMMTIMEOUTS structure in which the time-out information is returned.
; Return values .: Success - True
; Failure - False
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......: _CommAPI_SetCommTimeouts, $tagCOMMTIMEOUTS
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363261(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_GetCommTimeouts(Const $hFile, $tCommTimeouts = 0)
DllCall("kernel32.dll", "bool", "GetCommTimeouts", "handle", $hFile, "ptr", DllStructGetPtr($tCommTimeouts))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_GetCommTimeouts

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_PurgeComm
; Description ...: Discards all characters from the output or input buffer of a specified communications resource.
; It can also terminate pending read or write operations on the resource.
; Syntax ........: _CommAPI_PurgeComm(Const $hFile[, $iFlags = $PURGE_ALL])
; Parameters ....: $hFile - [in] A handle to the communications device.
; $iFlags - [in] An integer value.
; Return values .: Success - True
; Failure - False
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363428(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_PurgeComm(Const $hFile, Const $iFlags = $PURGE_ALL)
DllCall("kernel32.dll", "bool", "PurgeComm", "handle", $hFile, "dword", $iFlags)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_PurgeComm

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_SetCommBreak
; Description ...: Suspends character transmission for a specified communications device and places the transmission line in a break state until the ClearCommBreak function is called.
; Syntax ........: _CommAPI_SetCommBreak(Const $hFile)
; Parameters ....: $hFile - [in] A handle to the communications device.
; Return values .: Success - True
; Failure - False
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363433(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_SetCommBreak(Const $hFile)
DllCall("kernel32.dll", "bool", "SetCommBreak", "handle", $hFile)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_SetCommBreak

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_SetCommMask
; Description ...: Specifies a set of events to be monitored for a communications device.
; Syntax ........: _CommAPI_SetCommMask(Const $hFile, Const $iEventMask)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $iEventMask - [in] The events to be enabled. A value of zero disables all events.
; Return values .: Success - True
; Failure - False
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363435(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_SetCommMask(Const $hFile, Const $iEventMask)
DllCall("kernel32.dll", "bool", "SetCommMask", "handle", $hFile, "dword", $iEventMask)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_SetCommMask

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_SetCommState
; Description ...: Configures a communications device according to the specifications in a device-control block.
; The function reinitializes all hardware and control settings, but it does not empty output or input queues.
; Syntax ........: _CommAPI_SetCommState(Const $hFile, Const $tDCB)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tDCB - [in] A DCB structure that contains the configuration information for the specified communications device.
; Return values .: Success - True
; Failure - False
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......: _CommAPI_GetCommState, $tagDCB
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363436(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_SetCommState(Const $hFile, Const $tDCB)
DllCall("kernel32.dll", "bool", "SetCommState", "handle", $hFile, "ptr", DllStructGetPtr($tDCB))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_SetCommState

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_SetCommTimeouts
; Description ...: Sets the time-out parameters for all read and write operations on a specified communications device.
; Syntax ........: _CommAPI_SetCommTimeouts(Const $hFile, Const $tCommTimeouts)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tCommTimeouts - [in] A COMMTIMEOUTS structure that contains the new time-out values.
; Return values .: Success - True
; Failure - False
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......: _CommAPI_GetCommTimeouts, $tagCOMMTIMEOUTS
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363437(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_SetCommTimeouts(Const $hFile, Const $tCommTimeouts)
DllCall("kernel32.dll", "bool", "SetCommTimeouts", "handle", $hFile, "ptr", DllStructGetPtr($tCommTimeouts))
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_SetCommTimeouts

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_SetupComm
; Description ...: Initializes the communications parameters for a specified communications device.
; Syntax ........: _CommAPI_SetupComm(Const $hFile, Const $iInQueue, Const $iOutQueue)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $iInQueue - [in] The recommended size of the device's internal input buffer, in bytes.
; $iOutQueue - [in] The recommended size of the device's internal output buffer, in bytes.
; Return values .: Success - True
; Failure - False
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363439(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_SetupComm(Const $hFile, Const $iInQueue, Const $iOutQueue)
DllCall("kernel32.dll", "bool", "SetupComm", "handle", $hFile, "dword", $iInQueue, "dword", $iOutQueue)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_SetupComm

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_TransmitCommChar
; Description ...: Transmits a specified character ahead of any pending data in the output buffer of the specified communications device.
; Syntax ........: _CommAPI_TransmitCommChar(Const $hFile, Const $cChar)
; Parameters ....: $hFile - [in] A handle to the communications device.
; $sChar - [in] The character to be transmitted.
; Return values .: Success - True
; Failure - False
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......:
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363473(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_TransmitCommChar(Const $hFile, Const $cChar)
Local $tChar = DllStructCreate("char")
DllStructSetData($tChar, 1, $cChar)
DllCall("kernel32.dll", "bool", "TransmitCommChar", "handle", $hFile, "char", $tChar)
If @error Then Return SetError(@error, @ScriptLineNumber, False)
Return True
EndFunc ;==>_CommAPI_TransmitCommChar

; #FUNCTION# ====================================================================================================================
; Name ..........: _CommAPI_WaitCommEvent
; Description ...: Waits for an event to occur for a specified communications device.
; Syntax ........: _CommAPI_WaitCommEvent(Const $hFile [, Const $tOverlapped = 0])
; Parameters ....: $hFile - [in] A handle to the communications device.
; $tOverlapped - [in] An OVERLAPPED structure.
; Return values .: Success - A mask indicating the type of event that occurred.
; Failure - 0
; Author ........:
; Modified ......:
; Remarks .......:
; Related .......: _CommAPI_EscapeCommFunction, _CommAPI_GetCommModemStatus
; Link ..........: http://msdn.microsoft.com/en-us/library/aa363479(v=vs.85).aspx
; Example .......: No
; ===============================================================================================================================
Func _CommAPI_WaitCommEvent(Const $hFile, Const $tOverlapped = 0)
Local $aResult = DllCall("kernel32.dll", "bool", "WaitCommEvent", "handle", $hFile, "dword*", 0, "ptr", DllStructGetPtr($tOverlapped))
If @error Then Return SetError(@error, @ScriptLineNumber, 0)
Return $aResult[2]
EndFunc ;==>_CommAPI_WaitCommEvent
</syntaxhighlight>

CommAPIConstants.au3

2014-03-07T09:59:30Z

Therealhanuta: Add Constants

CommAPIStructures.au3

2014-03-07T09:58:47Z

Therealhanuta: Redirected page to CommAPIConstants.au3

#REDIRECT [[CommAPIConstants.au3]]

CommAPI

2014-03-07T09:58:13Z

Therealhanuta: Rename CommAPIStructures.au3 to CommAPIConstants.au3

CommAPI translates the communications functions of Windows API to AutoIt functions.

== Overview ==
=== Features ===
* No need to install DLL's
* Using Windows API calls (kernel32.dll)
* Possibility of serial communication (serial port, COM port, RS-232)
* Possibility of parallel communication (parallel port, LPT port)
* No use of global variables
* Uniform namespace _CommAPI_XXX
* Modular organization into files
* A lot of additional utility and helper functions

=== Scripts ===
* [[CommAPIConstants.au3]]
* [[CommAPI.au3]]
* [[CommAPIHelper.au3]]
* [[CommUtilities.au3]]
* [[CommInterface.au3]]

=== Examples ===
[[CommAPI Examples]] shows you some examples. Mayby you could find more examples in [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/?p=1126366 forum].

== Background ==
=== History ===
* 2008-09-12 Creation of cfx.au3 [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/#entry578111 (V1.0)]
* 2011-02-18 Conversation of cfx.au3 into cfxUDF.au3 [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/page-2#entry872154 (V2.0)]
* 2011-02-28 Update V2.0to [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/page-2#entry874547 V2.1]
* 2011-04-27 Update V2.1 to [http://www.autoit.de/index.php?page=Thread&postID=217993#post217993 V2.2] (german forum)
* 2013-07-10 Modify V2.1 to [http://www.autoitscript.com/forum/topic/80344-serial-communication-using-kernel32dll/page-2#entry1094288 V2.1mod]
* 2013-10-24 Creation of [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/ CommAPI.au3]

=== Changelog ===
; 2014-01-23
: Small update of method _CommAPI_CreateModeString
; 2014-02-03
: Change timeout handling (Attention: not backward compatible)
: Small update of method _CommAPI_PurgeComm

=== Roadmap ===
There is no roadmap in the moment. Feel free to implement the last five remaining API calls, enhance the scripts or to fix bugs.

=== Support ===
There is no official support. Try to get help from community in the official forum. [http://www.autoitscript.com/forum/topic/155674-commapi-serial-and-parallel-communication-with-windows-api/ Here you can find the main thread].

=== Resources ===
* [http://msdn.microsoft.com/en-us/library/aa363194(v=vs.85).aspx MSDN Library of communications functions]
* [http://www.hpcc.ecs.soton.ac.uk/software/Win32API.Txt WIN32API.TXT]
* cfxUDF.au3 (see section above)
* [http://www.autoit.de/index.php?page=Thread&postID=198669#post198669 GetCOMPorts] (german forum)
* [http://www.autoitscript.com/forum/topic/19713-problem-with-struct/#entry136466 ParseCommState]

== Functions ==
=== Implemented API functions ===
* BuildCommDCB
* BuildCommDCBAndTimeouts
* ClearCommBreak
* ClearCommError
* EscapeCommFunction
* GetCommMask
* GetCommModemStatus
* GetCommProperties
* GetCommState
* GetCommTimeouts
* PurgeComm
* SetCommBreak
* SetCommMask
* SetCommState
* SetCommTimeouts
* SetupComm
* TransmitCommChar
* WaitCommEvent

=== Unimplemented API functions ===
* CommConfigDialog
* GetCommConfig
* GetDefaultCommConfig
* SetCommConfig
* SetDefaultCommConfig

=== API helper functions ===
* ChangeCommStateElement
* ChangeCommTimeoutsElement
* GetCommStateElement
* GetCommTimeoutsElement
* IsOnCTS
* IsOnDCD
* IsOnDSR
* IsOnRI
* SetCommStateElement
* SetCommTimeoutsElement
* SetOnDTR
* SetOnRTS

=== Utility functions ===
* CommStateToString
* CommTimeoutsToString
* CreateModeString
* GetCOMPorts

=== Interface functions ===
* ClosePort
* OpenCOMPort
* OpenPort
* ReceiveData
* TransmitData

CommAPI Examples

2014-03-07T09:56:50Z

Therealhanuta: clean using of _CommAPI_PurgeComm

[[Category:Samples]]This site shows you some examples for [[CommAPI]].

== First example ==
<syntaxhighlight lang="autoit">
#include "CommInterface.au3"

Main()

Func Main()
Local $iErrorLine = Example()
If @extended Then
MsgBox(32, "Error", _WinAPI_GetLastErrorMessage())
ElseIf @error Then
MsgBox(32, "Error", "Error in line " & $iErrorLine)
EndIf
EndFunc

Func Example()
Local Const $iPort = 1
Local Const $iBaud = 9600
Local Const $iParity = 0
Local Const $iByteSize = 8
Local Const $iStopBits = 1
Local Const $sCommand = "Command" & @CRLF

Local $hFile = _CommAPI_OpenCOMPort($iPort, $iBaud, $iParity, $iByteSize, $iStopBits)
If @error Then Return SetError(@error, @extended, @ScriptLineNumber)

_CommAPI_ClearCommError($hFile)
If @error Then Return SetError(@error, @extended, @ScriptLineNumber)

_CommAPI_PurgeComm($hFile)
If @error Then Return SetError(@error, @extended, @ScriptLineNumber)

_CommAPI_TransmitData($hFile, $sCommand)
If @error Then Return SetError(@error, @extended, @ScriptLineNumber)

Local $sResult = _CommAPI_ReceiveData($hFile, 5000)
If @error Then Return SetError(@error, @extended, @ScriptLineNumber)

_CommAPI_ClosePort($hFile)
If @error Then Return SetError(@error, @extended, @ScriptLineNumber)

MsgBox(64, "Result", $sResult)
EndFunc
</syntaxhighlight>

== INI file==
<syntaxhighlight lang="autoit">
#include "CommInterface.au3"

Main()

Func Main()
Local $iErrorLine = Example()
If @extended Then
MsgBox(32, "Error", _WinAPI_GetLastErrorMessage())
ElseIf @error Then
MsgBox(32, "Error", "Error in line " & $iErrorLine)
EndIf
EndFunc

Func Example()
Local Const $sFileINI = @ScriptDir & "\Example.ini"

Local $sMode = _CommAPI_CreateModeString( _
IniRead($sFileINI, "COM", "SerialPort", 1), _
IniRead($sFileINI, "COM", "BaudRate", 9600), _
IniRead($sFileINI, "COM", "Parity", 0), _
IniRead($sFileINI, "COM", "ByteSize", 8), _
IniRead($sFileINI, "COM", "StopBits", 1), _
IniRead($sFileINI, "COM", "XON", 0), _
IniRead($sFileINI, "COM", "DSR", 0), _
IniRead($sFileINI, "COM", "CTS", 1), _
IniRead($sFileINI, "COM", "DTR", 1), _
IniRead($sFileINI, "COM", "RTS", 1), _
IniRead($sFileINI, "COM", "IDSR", 0))
If @error Then Return SetError(@error, @extended)

Local $hFile = _CommAPI_OpenPort($sMode)
If @error Then Return SetError(@error, @extended)

_CommAPI_ClearCommError($hFile)
If @error Then Return SetError(@error, @extended, @ScriptLineNumber)

_CommAPI_PurgeComm($hFile)
If @error Then Return SetError(@error, @extended, @ScriptLineNumber)

_CommAPI_TransmitData($hFile, IniRead($sFileINI, "COM", "Command", "Command" & @CRLF))
If @error Then Return SetError(@error, @extended, @ScriptLineNumber)

Local $sResult = _CommAPI_ReceiveData($hFile, IniRead($sFileINI, "Timeout", "IDSR", 5000))
If @error Then Return SetError(@error, @extended, @ScriptLineNumber)

_CommAPI_ClosePort($hFile)
If @error Then Return SetError(@error, @extended, @ScriptLineNumber)

MsgBox(64, "Result", $sResult)
EndFunc
</syntaxhighlight>

== Command Line ==
<syntaxhighlight lang="autoit">
#include "CommInterface.au3"

Main()

Func Main()
Local $iErrorLine = Example()
If @extended Then
MsgBox(32, "Error", _WinAPI_GetLastErrorMessage())
ElseIf @error Then
MsgBox(32, "Error", "Error in line " & $iErrorLine)
EndIf
EndFunc

Func Example()
If $CmdLine[0] <> 2 Then
MsgBox(32, "Syntax", @ScriptName & ' "ModeString" "Command"')
Return
EndIf

Local $hFile = _CommAPI_OpenPort($CmdLine[1])
If @error Then Return SetError(@error, @extended)

_CommAPI_ClearCommError($hFile)
If @error Then Return SetError(@error, @extended, @ScriptLineNumber)

_CommAPI_PurgeComm($hFile)
If @error Then Return SetError(@error, @extended, @ScriptLineNumber)

_CommAPI_TransmitData($hFile, $CmdLine[2])
If @error Then Return SetError(@error, @extended, @ScriptLineNumber)

Local $sResult = _CommAPI_ReceiveData($hFile, 5000)
If @error Then Return SetError(@error, @extended, @ScriptLineNumber)

_CommAPI_ClosePort($hFile)
If @error Then Return SetError(@error, @extended, @ScriptLineNumber)

MsgBox(64, "Result", $sResult)
EndFunc
</syntaxhighlight>

<syntaxhighlight lang="winbatch">
@echo off
cls
chcp 1252>nul
cd /d "%~dp0"
start Example.exe "COM7: BAUD=9600 PARITY=N DATA=8 STOP=1 XON=OFF ODSR=OFF OCTS=ON DTR=ON RTS=ON IDSR=OFF" "Command"
</syntaxhighlight>

CommAPI Examples

2014-02-03T14:55:21Z

Therealhanuta: /* Command Line */ add windows batch file example

[[Category:Samples]]This site shows you some examples for [[CommAPI]].

== First example ==
<syntaxhighlight lang="autoit">
#include "CommInterface.au3"

Main()

Func Main()
Local $iErrorLine = Example()
If @extended Then
MsgBox(32, "Error", _WinAPI_GetLastErrorMessage())
ElseIf @error Then
MsgBox(32, "Error", "Error in line " & $iErrorLine)
EndIf
EndFunc

Func Example()
Local Const $iPort = 1
Local Const $iBaud = 9600
Local Const $iParity = 0
Local Const $iByteSize = 8
Local Const $iStopBits = 1
Local Const $sCommand = "Command" & @CRLF

Local $hFile = _CommAPI_OpenCOMPort($iPort, $iBaud, $iParity, $iByteSize, $iStopBits)
If @error Then Return SetError(@error, @extended, @ScriptLineNumber)

_CommAPI_ClearCommError($hFile)
If @error Then Return SetError(@error, @extended, @ScriptLineNumber)

_CommAPI_PurgeComm($hFile, 15)
If @error Then Return SetError(@error, @extended, @ScriptLineNumber)

_CommAPI_TransmitData($hFile, $sCommand)
If @error Then Return SetError(@error, @extended, @ScriptLineNumber)

Local $sResult = _CommAPI_ReceiveData($hFile, 5000)
If @error Then Return SetError(@error, @extended, @ScriptLineNumber)

_CommAPI_ClosePort($hFile)
If @error Then Return SetError(@error, @extended, @ScriptLineNumber)

MsgBox(64, "Result", $sResult)
EndFunc
</syntaxhighlight>

== INI file==
<syntaxhighlight lang="autoit">
#include "CommInterface.au3"

Main()

Func Main()
Local $iErrorLine = Example()
If @extended Then
MsgBox(32, "Error", _WinAPI_GetLastErrorMessage())
ElseIf @error Then
MsgBox(32, "Error", "Error in line " & $iErrorLine)
EndIf
EndFunc

Func Example()
Local Const $sFileINI = @ScriptDir & "\Example.ini"

Local $sMode = _CommAPI_CreateModeString( _
IniRead($sFileINI, "COM", "SerialPort", 1), _
IniRead($sFileINI, "COM", "BaudRate", 9600), _
IniRead($sFileINI, "COM", "Parity", 0), _
IniRead($sFileINI, "COM", "ByteSize", 8), _
IniRead($sFileINI, "COM", "StopBits", 1), _
IniRead($sFileINI, "COM", "XON", 0), _
IniRead($sFileINI, "COM", "DSR", 0), _
IniRead($sFileINI, "COM", "CTS", 1), _
IniRead($sFileINI, "COM", "DTR", 1), _
IniRead($sFileINI, "COM", "RTS", 1), _
IniRead($sFileINI, "COM", "IDSR", 0))
If @error Then Return SetError(@error, @extended)

Local $hFile = _CommAPI_OpenPort($sMode)
If @error Then Return SetError(@error, @extended)

_CommAPI_ClearCommError($hFile)
If @error Then Return SetError(@error, @extended, @ScriptLineNumber)

_CommAPI_PurgeComm($hFile, 15)
If @error Then Return SetError(@error, @extended, @ScriptLineNumber)

_CommAPI_TransmitData($hFile, IniRead($sFileINI, "COM", "Command", "Command" & @CRLF))
If @error Then Return SetError(@error, @extended, @ScriptLineNumber)

Local $sResult = _CommAPI_ReceiveData($hFile, IniRead($sFileINI, "Timeout", "IDSR", 5000))
If @error Then Return SetError(@error, @extended, @ScriptLineNumber)

_CommAPI_ClosePort($hFile)
If @error Then Return SetError(@error, @extended, @ScriptLineNumber)

MsgBox(64, "Result", $sResult)
EndFunc
</syntaxhighlight>

== Command Line ==
<syntaxhighlight lang="autoit">
#include "CommInterface.au3"

Main()

Func Main()
Local $iErrorLine = Example()
If @extended Then
MsgBox(32, "Error", _WinAPI_GetLastErrorMessage())
ElseIf @error Then
MsgBox(32, "Error", "Error in line " & $iErrorLine)
EndIf
EndFunc

Func Example()
If $CmdLine[0] <> 2 Then
MsgBox(32, "Syntax", @ScriptName & ' "ModeString" "Command"')
Return
EndIf

Local $hFile = _CommAPI_OpenPort($CmdLine[1])
If @error Then Return SetError(@error, @extended)

_CommAPI_ClearCommError($hFile)
If @error Then Return SetError(@error, @extended, @ScriptLineNumber)

_CommAPI_PurgeComm($hFile, 15)
If @error Then Return SetError(@error, @extended, @ScriptLineNumber)

_CommAPI_TransmitData($hFile, $CmdLine[2])
If @error Then Return SetError(@error, @extended, @ScriptLineNumber)

Local $sResult = _CommAPI_ReceiveData($hFile, 5000)
If @error Then Return SetError(@error, @extended, @ScriptLineNumber)

_CommAPI_ClosePort($hFile)
If @error Then Return SetError(@error, @extended, @ScriptLineNumber)

MsgBox(64, "Result", $sResult)
EndFunc
</syntaxhighlight>

<syntaxhighlight lang="winbatch">
@echo off
cls
chcp 1252>nul
cd /d "%~dp0"
start Example.exe "COM7: BAUD=9600 PARITY=N DATA=8 STOP=1 XON=OFF ODSR=OFF OCTS=ON DTR=ON RTS=ON IDSR=OFF" "Command"
</syntaxhighlight>