Skip to content

Commit 22f21d1

Browse files
Danp2Danp2
authored
Fix coding of function returns (#18)
* Fix coding of function returns * Fixes
1 parent 82c9c8f commit 22f21d1

File tree

2 files changed

+65
-71
lines changed

2 files changed

+65
-71
lines changed

‎wd_core.au3

Lines changed: 48 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -207,13 +207,13 @@ Func _WD_CreateSession($sDesiredCapabilities = '{}')
207207
If @error Then
208208
Local $sMessage = Json_Get($sJSON, "[value][message]")
209209

210-
SetError(__WD_Error($sFuncName, $_WD_ERROR_Exception, $sMessage))
210+
Return SetError(__WD_Error($sFuncName, $_WD_ERROR_Exception, $sMessage), $_WD_HTTPRESULT, "")
211211
EndIf
212212
Else
213-
SetError(__WD_Error($sFuncName, $_WD_ERROR_Exception, "HTTP status = " & $_WD_HTTPRESULT), $_WD_HTTPRESULT)
213+
Return SetError(__WD_Error($sFuncName, $_WD_ERROR_Exception, "HTTP status = " & $_WD_HTTPRESULT), $_WD_HTTPRESULT, "")
214214
EndIf
215215

216-
Return $sSession
216+
Return SetError($_WD_ERROR_Success, $_WD_HTTPRESULT, $sSession)
217217
EndFunc ;==>_WD_CreateSession
218218

219219

@@ -245,11 +245,10 @@ Func _WD_DeleteSession($sSession)
245245
EndIf
246246

247247
If $iErr Then
248-
SetError(__WD_Error($sFuncName, $_WD_ERROR_Exception, "HTTP status = " & $_WD_HTTPRESULT), $_WD_HTTPRESULT)
249-
Return 0
248+
Return SetError(__WD_Error($sFuncName, $_WD_ERROR_Exception, "HTTP status = " & $_WD_HTTPRESULT), $_WD_HTTPRESULT, 0)
250249
EndIf
251250

252-
Return 1
251+
Return SetError($_WD_ERROR_Success, $_WD_HTTPRESULT, 1)
253252
EndFunc ;==>_WD_DeleteSession
254253

255254
; #FUNCTION# ====================================================================================================================
@@ -279,11 +278,10 @@ Func _WD_Status()
279278
EndIf
280279

281280
If $iErr Then
282-
SetError(__WD_Error($sFuncName, $_WD_ERROR_Exception, "HTTP status = " & $_WD_HTTPRESULT), $_WD_HTTPRESULT)
283-
Return 0
281+
Return SetError(__WD_Error($sFuncName, $_WD_ERROR_Exception, "HTTP status = " & $_WD_HTTPRESULT), $_WD_HTTPRESULT, 0)
284282
EndIf
285283

286-
Return $sResponse
284+
Return SetError($_WD_ERROR_Success, $_WD_HTTPRESULT, $sResponse)
287285
EndFunc ;==>_WD_Status
288286

289287

@@ -325,11 +323,10 @@ Func _WD_Timeouts($sSession, $sTimeouts = '')
325323
EndIf
326324

327325
If $iErr Then
328-
SetError(__WD_Error($sFuncName, $_WD_ERROR_Exception, "HTTP status = " & $_WD_HTTPRESULT), $_WD_HTTPRESULT)
329-
Return 0
326+
Return SetError(__WD_Error($sFuncName, $_WD_ERROR_Exception, "HTTP status = " & $_WD_HTTPRESULT), $_WD_HTTPRESULT, 0)
330327
EndIf
331328

332-
Return $sResponse
329+
Return SetError($_WD_ERROR_Success, $_WD_HTTPRESULT, $sResponse)
333330
EndFunc ;==>_WD_Timeouts
334331

335332

@@ -362,11 +359,10 @@ Func _WD_Navigate($sSession, $sURL)
362359
EndIf
363360

364361
If $iErr Then
365-
SetError(__WD_Error($sFuncName, $iErr, "HTTP status = " & $_WD_HTTPRESULT), $_WD_HTTPRESULT)
366-
Return 0
362+
Return SetError(__WD_Error($sFuncName, $_WD_ERROR_Exception, "HTTP status = " & $_WD_HTTPRESULT), $_WD_HTTPRESULT, 0)
367363
EndIf
368364

369-
Return 1
365+
Return SetError($_WD_ERROR_Success, $_WD_HTTPRESULT, 1)
370366
EndFunc ;==>_WD_Navigate
371367

372368

@@ -428,8 +424,7 @@ Func _WD_Action($sSession, $sCommand, $sOption = '')
428424
$iErr = @error
429425

430426
Case Else
431-
SetError(__WD_Error($sFuncName, $_WD_ERROR_InvalidDataType, "(Back|Forward|Refresh|Url|Title|Actions) $sCommand=>" & $sCommand))
432-
Return ""
427+
Return SetError(__WD_Error($sFuncName, $_WD_ERROR_InvalidDataType, "(Back|Forward|Refresh|Url|Title|Actions) $sCommand=>" & $sCommand), "")
433428

434429
EndSwitch
435430

@@ -438,10 +433,10 @@ Func _WD_Action($sSession, $sCommand, $sOption = '')
438433
EndIf
439434

440435
If $iErr Then
441-
SetError(__WD_Error($sFuncName, $_WD_ERROR_Exception, "HTTP status = " & $_WD_HTTPRESULT), $_WD_HTTPRESULT)
436+
Return SetError(__WD_Error($sFuncName, $_WD_ERROR_Exception, "HTTP status = " & $_WD_HTTPRESULT), $_WD_HTTPRESULT, "")
442437
EndIf
443438

444-
Return $sResult
439+
Return SetError($_WD_ERROR_Success, $_WD_HTTPRESULT, $sResult)
445440
EndFunc ;==>_WD_Action
446441

447442
; #FUNCTION# ====================================================================================================================
@@ -569,10 +564,10 @@ Func _WD_Window($sSession, $sCommand, $sOption = '')
569564
EndIf
570565

571566
If $iErr Then
572-
SetError(__WD_Error($sFuncName, $_WD_ERROR_Exception, "HTTP status = " & $_WD_HTTPRESULT), $_WD_HTTPRESULT)
567+
Return SetError(__WD_Error($sFuncName, $_WD_ERROR_Exception, "HTTP status = " & $_WD_HTTPRESULT), $_WD_HTTPRESULT, 0)
573568
EndIf
574569

575-
Return $sResult
570+
Return SetError($_WD_ERROR_Success, $_WD_HTTPRESULT, $sResult)
576571
EndFunc ;==>_WD_Window
577572

578573

@@ -651,10 +646,10 @@ Func _WD_FindElement($sSession, $sStrategy, $sSelector, $sStartElement = "", $lM
651646
EndIf
652647

653648
If $iErr Then
654-
SetError(__WD_Error($sFuncName, $iErr, "HTTP status = " & $_WD_HTTPRESULT), $_WD_HTTPRESULT)
649+
Return SetError(__WD_Error($sFuncName, $iErr, "HTTP status = " & $_WD_HTTPRESULT), $_WD_HTTPRESULT, "")
655650
EndIf
656651

657-
Return ($lMultiple) ? $aElements : $sResult
652+
Return SetError($_WD_ERROR_Success, $_WD_HTTPRESULT, ($lMultiple) ? $aElements : $sResult)
658653
EndFunc ;==>_WD_FindElement
659654

660655

@@ -742,10 +737,10 @@ Func _WD_ElementAction($sSession, $sElement, $sCommand, $sOption = '')
742737
EndIf
743738

744739
If $iErr Then
745-
SetError(__WD_Error($sFuncName, $_WD_ERROR_Exception, $sResponse), $_WD_HTTPRESULT)
740+
Return SetError(__WD_Error($sFuncName, $_WD_ERROR_Exception, $sResponse), $_WD_HTTPRESULT, "")
746741
EndIf
747742

748-
Return $sResult
743+
Return SetError($_WD_ERROR_Success, $_WD_HTTPRESULT, $sResult)
749744
EndFunc ;==>_WD_ElementAction
750745

751746

@@ -776,7 +771,7 @@ Func _WD_ExecuteScript($sSession, $sScript, $sArguments = "[]")
776771
ConsoleWrite($sFuncName & ': ' & $sResponse & @CRLF)
777772
EndIf
778773

779-
Return $sResponse
774+
Return SetError($_WD_ERROR_Success, $_WD_HTTPRESULT, $sResponse)
780775
EndFunc ;==>_WD_ExecuteScript
781776

782777

@@ -860,10 +855,10 @@ Func _WD_Alert($sSession, $sCommand, $sOption = '')
860855
EndIf
861856

862857
If $iErr Then
863-
SetError(__WD_Error($sFuncName, $_WD_ERROR_Exception, $sResponse), $_WD_HTTPRESULT)
858+
Return SetError(__WD_Error($sFuncName, $_WD_ERROR_Exception, $sResponse), $_WD_HTTPRESULT, "")
864859
EndIf
865860

866-
Return $sResult
861+
Return SetError($_WD_ERROR_Success, $_WD_HTTPRESULT, $sResult)
867862
EndFunc ;==>_WD_Alert
868863

869864

@@ -901,11 +896,11 @@ Func _WD_GetSource($sSession)
901896
EndIf
902897

903898
If $iErr Then
904-
SetError(__WD_Error($sFuncName, $_WD_ERROR_Exception, $sResponse), $_WD_HTTPRESULT)
899+
Return SetError(__WD_Error($sFuncName, $_WD_ERROR_Exception, $sResponse), $_WD_HTTPRESULT, "")
905900
EndIf
906901

907-
Return $sResult
908-
EndFunc ;==>_WD_GetSource
902+
Return SetError($_WD_ERROR_Success, $_WD_HTTPRESULT, $sResult)
903+
EndFunc ;==>_WD_GetSource
909904

910905
; #FUNCTION# ====================================================================================================================
911906
; Name ..........: _WD_Cookies
@@ -972,14 +967,13 @@ Func _WD_Cookies($sSession, $sCommand, $sOption = '')
972967
EndIf
973968

974969
If $iErr Then
975-
SetError(__WD_Error($sFuncName, $_WD_ERROR_Exception, $sResponse), $_WD_HTTPRESULT)
970+
Return SetError(__WD_Error($sFuncName, $_WD_ERROR_Exception, $sResponse), $_WD_HTTPRESULT, "")
976971
EndIf
977972

978-
Return $sResult
973+
Return SetError($_WD_ERROR_Success, $_WD_HTTPRESULT, $sResult)
979974
EndFunc ;==>_WD_Cookies
980975

981976

982-
983977
; #FUNCTION# ====================================================================================================================
984978
; Name ..........: _WD_Option
985979
; Description ...: Sets and get options for the web driver UDF
@@ -1010,33 +1004,29 @@ Func _WD_Option($sOption, $vValue = "")
10101004
Case "Driver"
10111005
If $vValue == "" Then Return $_WD_DRIVER
10121006
If Not IsString($vValue) Then
1013-
SetError(__WD_Error($sFuncName, $_WD_ERROR_InvalidDataType, "(string) $vValue: " & $vValue))
1014-
Return 0
1007+
Return SetError(__WD_Error($sFuncName, $_WD_ERROR_InvalidDataType, "(string) $vValue: " & $vValue), 0, 0)
10151008
EndIf
10161009
$_WD_DRIVER = $vValue
10171010
Case "DriverParams"
10181011
If $vValue == "" Then Return $_WD_DRIVER_PARAMS
10191012
If Not IsString($vValue) Then
1020-
SetError(__WD_Error($sFuncName, $_WD_ERROR_InvalidDataType, "(string) $vValue: " & $vValue))
1021-
Return 0
1013+
Return SetError(__WD_Error($sFuncName, $_WD_ERROR_InvalidDataType, "(string) $vValue: " & $vValue), 0, 0)
10221014
EndIf
10231015
$_WD_DRIVER_PARAMS = $vValue
10241016
Case "BaseURL"
10251017
If $vValue == "" Then Return $_WD_BASE_URL
10261018
If Not IsString($vValue) Then
1027-
SetError(__WD_Error($sFuncName, $_WD_ERROR_InvalidDataType, "(string) $vValue: " & $vValue))
1028-
Return 0
1019+
Return SetError(__WD_Error($sFuncName, $_WD_ERROR_InvalidDataType, "(string) $vValue: " & $vValue), 0, 0)
10291020
EndIf
10301021
$_WD_BASE_URL = $vValue
10311022
Case "Port"
10321023
If $vValue == "" Then Return $_WD_PORT
10331024
If Not IsInt($vValue) Then
1034-
SetError(__WD_Error($sFuncName, $_WD_ERROR_InvalidDataType, "(int) $vValue: " & $vValue))
1035-
Return 0
1025+
Return SetError(__WD_Error($sFuncName, $_WD_ERROR_InvalidDataType, "(int) $vValue: " & $vValue), 0, 0)
10361026
EndIf
10371027
$_WD_PORT = $vValue
10381028
Case Else
1039-
SetError(__WD_Error($sFuncName, $_WD_ERROR_InvalidDataType, "(Driver|DriverParams|BaseURL|Port) $sOption=>" & $sOption))
1029+
Return SetError(__WD_Error($sFuncName, $_WD_ERROR_InvalidDataType, "(Driver|DriverParams|BaseURL|Port) $sOption=>" & $sOption), 0, 0)
10401030
EndSwitch
10411031

10421032
Return 1
@@ -1064,8 +1054,7 @@ Func _WD_Startup()
10641054
Local Const $sFuncName = "_WD_Startup"
10651055

10661056
If $_WD_DRIVER = "" Then
1067-
SetError(__WD_Error($sFuncName, $_WD_ERROR_InvalidValue, "Location for Web Driver not set." & @CRLF))
1068-
Return 0
1057+
Return SetError(__WD_Error($sFuncName, $_WD_ERROR_InvalidValue, "Location for Web Driver not set." & @CRLF), 0, 0)
10691058
EndIf
10701059

10711060
__WD_CloseDriver()
@@ -1088,10 +1077,10 @@ Func _WD_Startup()
10881077
Local $pid = Run($sCommand, "", $_WD_DEBUG ? @SW_SHOW : @SW_HIDE)
10891078

10901079
If @error Then
1091-
SetError(__WD_Error($sFuncName, $_WD_ERROR_GeneralError, "Error launching web driver!"))
1080+
Return SetError(__WD_Error($sFuncName, $_WD_ERROR_GeneralError, "Error launching web driver!"), 0, 0)
10921081
EndIf
10931082

1094-
Return ($pid)
1083+
Return SetError($_WD_ERROR_Success, 0, $pid)
10951084
EndFunc ;==>_WD_Startup
10961085

10971086

@@ -1165,13 +1154,13 @@ Func __WD_Get($sURL)
11651154

11661155
If $iResult Then
11671156
If $_WD_HTTPRESULT = $HTTP_STATUS_REQUEST_TIMEOUT Then
1168-
SetError(__WD_Error($sFuncName, $_WD_ERROR_Timeout, $sResponseText))
1157+
Return SetError(__WD_Error($sFuncName, $_WD_ERROR_Timeout, $sResponseText), $_WD_HTTPRESULT, $sResponseText)
11691158
Else
1170-
SetError(__WD_Error($sFuncName, $iResult, $sResponseText))
1159+
Return SetError(__WD_Error($sFuncName, $iResult, $sResponseText), $_WD_HTTPRESULT, $sResponseText)
11711160
EndIf
11721161
EndIf
11731162

1174-
Return $sResponseText
1163+
Return SetError($_WD_ERROR_Success, 0, $sResponseText)
11751164
EndFunc ;==>__WD_Get
11761165

11771166

@@ -1229,10 +1218,10 @@ Func __WD_Post($sURL, $sData)
12291218
EndIf
12301219

12311220
If $iResult Then
1232-
SetError(__WD_Error($sFuncName, $iResult, $sResponseText))
1221+
Return SetError(__WD_Error($sFuncName, $iResult, $sResponseText), $_WD_HTTPRESULT, $sResponseText)
12331222
EndIf
12341223

1235-
Return $sResponseText
1224+
Return SetError($_WD_ERROR_Success, $_WD_HTTPRESULT, $sResponseText)
12361225
EndFunc ;==>__WD_Post
12371226

12381227

@@ -1288,13 +1277,13 @@ Func __WD_Delete($sURL)
12881277

12891278
If $iResult Then
12901279
If $_WD_HTTPRESULT = $HTTP_STATUS_REQUEST_TIMEOUT Then
1291-
SetError(__WD_Error($sFuncName, $_WD_ERROR_Timeout, $sResponseText))
1280+
Return SetError(__WD_Error($sFuncName, $_WD_ERROR_Timeout, $sResponseText), $_WD_HTTPRESULT, $sResponseText)
12921281
Else
1293-
SetError(__WD_Error($sFuncName, $_WD_ERROR_Exception, $sResponseText))
1282+
Return SetError(__WD_Error($sFuncName, $_WD_ERROR_Exception, $sResponseText), $_WD_HTTPRESULT, $sResponseText)
12941283
EndIf
12951284
EndIf
12961285

1297-
Return $sResponseText
1286+
Return SetError($_WD_ERROR_Success, 0, $sResponseText)
12981287
EndFunc ;==>__WD_Delete
12991288

13001289

@@ -1317,20 +1306,20 @@ Func __WD_Error($sWhere, $i_WD_ERROR, $sMessage = "")
13171306
Local $sMsg
13181307
Sleep(200)
13191308

1320-
$sMsg = $sWhere & " ==> " & $aWD_ERROR_DESC[$i_WD_ERROR] & @CRLF
1309+
$sMsg = $sWhere & " ==> " & $aWD_ERROR_DESC[$i_WD_ERROR]
13211310

13221311
If $sMessage <> "" Then
1323-
$sMsg = $sMsg & ": " & $sMessage & @CRLF
1312+
$sMsg = $sMsg & ": " & $sMessage
13241313
EndIf
13251314

1326-
ConsoleWrite($sMsg)
1315+
ConsoleWrite($sMsg & @CRLF)
13271316
If @Compiled Then
13281317
If $_WD_ERROR_MSGBOX And $i_WD_ERROR < 6 Then MsgBox(16, "WD_Core.au3 Error:", $sMsg)
13291318
DllCall("kernel32.dll", "none", "OutputDebugString", "str", $sMsg)
13301319
EndIf
13311320

13321321
Return $i_WD_ERROR
1333-
EndFunc ;==>__WD_Error
1322+
EndFunc ;==>__WD_Error
13341323

13351324

13361325
; #INTERNAL_USE_ONLY# ===========================================================================================================

0 commit comments

Comments
 (0)