Sign in to follow this  
Followers 0
Tsukihime

Good return value practice?

10 posts in this topic

#1 ·  Posted (edited)

I'm writing a function that checks whether the provided path is a directory or not.

It may already exist, I don't know I didn't look through all of the libraries available.

func isDir($file)
  If FileGetAttrib($file) == "D" Then
    return True
  EndIf
  Return False
EndFunc

This small simple function basically returns True if it's a directory and False otherwise.

I have seen the use of special variables like @error set, but I wasn't sure what are the "proper" things I should do when writing a function.

Edited by Tsukihime

Share this post


Link to post
Share on other sites



Tsukihime,

what are the "proper" things I should do when writing a function

There are no fixed rules - all you need to do is make clear whether the function was successful or not. The following is my personal interpretation of "best practice": :>

Expected return    Success    Failure

String             String     ""

Number             Number     0 or -1 depending on valid return values

Array              Array      ""

Boolean            True       False

Special            Value      0
(hWnd, Ptr)

In all failure cases I would set @error using:

Return SetError($iError, $iExtended, Failure_Return)

where $iError and $iExtended give information explaining why the function failed to help debugging. ;)

If you follow these guidelines you will always have 2 ways to tell that the function has worked or not:

- 1. The return value

- 2. @error

As I said these are personal views, but I believe them to be close to a "standard". Please take a look inside the UDFs in my sig to see how I have implemented them in my own functions. :unsure:

M23


Any of my own code posted anywhere on the forum is available for use by others without any restriction of any kind._______My UDFs:

Spoiler

ArrayMultiColSort ---- Sort arrays on multiple columns
ChooseFileFolder ---- Single and multiple selections from specified path treeview listing
Date_Time_Convert -- Easily convert date/time formats, including the language used
ExtMsgBox --------- A highly customisable replacement for MsgBox
GUIExtender -------- Extend and retract multiple sections within a GUI
GUIFrame ---------- Subdivide GUIs into many adjustable frames
GUIListViewEx ------- Insert, delete, move, drag, sort, edit and colour ListView items
GUITreeViewEx ------ Check/clear parent and child checkboxes in a TreeView
Marquee ----------- Scrolling tickertape GUIs
NoFocusLines ------- Remove the dotted focus lines from buttons, sliders, radios and checkboxes
Notify ------------- Small notifications on the edge of the display
Scrollbars ----------Automatically sized scrollbars with a single command
StringSize ---------- Automatically size controls to fit text
Toast -------------- Small GUIs which pop out of the notification area

 

Share this post


Link to post
Share on other sites

#3 ·  Posted (edited)

I have seen the use of special variables like @error set, but I wasn't sure what are the "proper" things I should do when writing a function.

I think you have to define every error... for ex.

;example

$a = isdir("c:\windows") ; case true
consolewrite("return value "&$a&" error code "&@error&@crlf)
$a = isdir("c:\windows\explorer.exe") ; case false
consolewrite("return value "&$a&" error code "&@error&@crlf)
$a = isdir("c:\windo\") ; case @error
consolewrite("return value "&$a&" error code "&@error&@crlf)

;func

func isDir($file)
    local $fattrib = FileGetAttrib($file)
    select
        case $fattrib == "D" ;is a folder
        return True
    case $fattrib = ""
        seterror(1) ; the file/folder doesn´t exists set error code 1
        return ""
    case Else
        return false ; is NOT a folder
    endselect
EndFunc

I don´t know if is the propper way to do it.... but it works

Edited by monoscout999

Share this post


Link to post
Share on other sites

monoscout999

Pretty close to what I suggested - but you need to use StringInStr to look for the "D" as you may have other attributes in the return from FileGetAttrib: :>

I would code it like this: :unsure:

;example

$fReturn = isdir("C:\Windows") ; True
ConsoleWrite("Return value " & $fReturn & " Error code " & @error & @CRLF)
$fReturn = isdir("C:\Windows\Explorer.exe") ; False and @error = 1
ConsoleWrite("Return value " & $fReturn & " Error code " & @error & @CRLF)
$fReturn = isdir("C:\Windo\") ; Does not exist and @error = 2
ConsoleWrite("Return value " & $fReturn & " Error code " & @error & @CRLF)

;func

Func isDir($sFolder)
    Local $sAttrib = FileGetAttrib($sFolder)
    Select
        Case $sAttrib = ""; the folder does not exist
            Return SetError(2, 0, False)
        Case StringInStr($sAttrib, "D") > 0 ;is a folder
            Return True
        Case StringInStr($sAttrib, "D") = 0 ;is NOT a folder
            Return SetError(1, 0, False)
    EndSelect
EndFunc   ;==>isDir

M23


Any of my own code posted anywhere on the forum is available for use by others without any restriction of any kind._______My UDFs:

Spoiler

ArrayMultiColSort ---- Sort arrays on multiple columns
ChooseFileFolder ---- Single and multiple selections from specified path treeview listing
Date_Time_Convert -- Easily convert date/time formats, including the language used
ExtMsgBox --------- A highly customisable replacement for MsgBox
GUIExtender -------- Extend and retract multiple sections within a GUI
GUIFrame ---------- Subdivide GUIs into many adjustable frames
GUIListViewEx ------- Insert, delete, move, drag, sort, edit and colour ListView items
GUITreeViewEx ------ Check/clear parent and child checkboxes in a TreeView
Marquee ----------- Scrolling tickertape GUIs
NoFocusLines ------- Remove the dotted focus lines from buttons, sliders, radios and checkboxes
Notify ------------- Small notifications on the edge of the display
Scrollbars ----------Automatically sized scrollbars with a single command
StringSize ---------- Automatically size controls to fit text
Toast -------------- Small GUIs which pop out of the notification area

 

Share this post


Link to post
Share on other sites

Of course some of this depends on how you are getting the path.

If you use the FileFindFirstFile/FileFindNextFile method then you don't need a function at all to check it; just check for @Extended

$sSearch = FileFindFirstFile("*") ;; *.* won't help you here because Windows doesn't respect the dot.
If $sSearch <> -1 Then
    While 1
        $hFile = FileFindNextFile($sSearch)
        If @Error Then ExitLoop
        If @Extended Then MsgBox(0, "Folder", $hFile & " is a Folder.")
    WEnd
EndIf

George

Question about decompiling code? Read the decompiling FAQ and don't bother posting the question in the forums.

Be sure to read and follow the forum rules. -AKA the AutoIt Reading and Comprehension Skills test.***

The PCRE (Regular Expression) ToolKit for AutoIT - (Updated Oct 20, 2011 ver:3.0.1.13) - Please update your current version before filing any bug reports. The installer now includes both 32 and 64 bit versions. No change in version number.

Visit my Blog .. currently not active but it will soon be resplendent with news and views. Also please remove any links you may have to my website. it is soon to be closed and replaced with something else.

"Old age and treachery will always overcome youth and skill!"

Share this post


Link to post
Share on other sites

monoscout999

Pretty close to what I suggested - but you need to use StringInStr to look for the "D" as you may have other attributes in the return from FileGetAttrib: ;)

I would code it like this: :unsure:

M23

you have right ... iguess not findig a dir is an error to :>

Share this post


Link to post
Share on other sites

I know it's been answered but I just couldn't resist!

Func _IsFolder($sFolder)
    If StringInStr(FileGetAttrib($sFolder), "D") Then
        Return 1
    EndIf
EndFunc   ;==>_IsFolder

_AdapterConnections()_AlwaysRun()_AppMon()_AppMonEx()_BinaryBin()_CheckMsgBox()_CmdLineRaw()_ContextMenu()_ConvertLHWebColor()/_ConvertSHWebColor()_DesktopDimensions()_DisplayPassword()_DotNet_Load()/_DotNet_Unload()_Fibonacci()_FileCompare()_FileCompareContents()_FileNameByHandle()_FilePrefix/SRE()_FindInFile()_GetBackgroundColor()/_SetBackgroundColor()_GetConrolID()_GetCtrlClass()_GetDirectoryFormat()_GetDriveMediaType()_GetFilename()/_GetFilenameExt()_GetHardwareID()_GetIP()_GetIP_Country()_GetOSLanguage()_GetSavedSource()_GetStringSize()_GetSystemPaths()_GetURLImage()_GIFImage()_GoogleWeather()_GUICtrlCreateGroup()_GUICtrlListBox_CreateArray()_GUICtrlListView_CreateArray()_GUICtrlListView_SaveCSV()_GUICtrlListView_SaveHTML()_GUICtrlListView_SaveTxt()_GUICtrlListView_SaveXML()_GUICtrlMenu_Recent()_GUICtrlMenu_SetItemImage()_GUICtrlTreeView_CreateArray()_GUIDisable()_GUIImageList_SetIconFromHandle()_GUIRegisterMsg()_GUISetIcon()_Icon_Clear()/_Icon_Set()_IdleTime()_InetGet()_InetGetGUI()_InetGetProgress()_IPDetails()_IsFileOlder()_IsGUID()_IsHex()_IsPalindrome()_IsRegKey()_IsStringRegExp()_IsSystemDrive()_IsUPX()_IsValidType()_IsWebColor()_Language()_Log()_MicrosoftInternetConnectivity()_MSDNDataType()_PathFull/GetRelative/Split()_PathSplitEx()_PrintFromArray()_ProgressSetMarquee()_ReDim()_RockPaperScissors()/_RockPaperScissorsLizardSpock()_ScrollingCredits_SelfDelete()_SelfRename()_SelfUpdate()_SendTo()_ShellAll()_ShellFile()_ShellFolder()_SingletonHWID()_SingletonPID()_Startup()_StringCompact()_StringIsValid()_StringRegExpMetaCharacters()_StringReplaceWholeWord()_StringStripChars()_Temperature()_TrialPeriod()_UKToUSDate()/_USToUKDate()_WinAPI_Create_CTL_CODE()_WinAPI_CreateGUID()_WMIDateStringToDate()/_DateToWMIDateString()Au3 script parsingAutoIt SearchAutoIt3 PortableAutoIt3WrapperToPragmaAutoItWinGetTitle()/AutoItWinSetTitle()CodingDirToHTML5FileInstallrFileReadLastChars()GeoIP databaseGUI - Only Close ButtonGUI ExamplesGUICtrlDeleteImage()GUICtrlGetBkColor()GUICtrlGetStyle()GUIEventsGUIGetBkColor()Int_Parse() & Int_TryParse()IsISBN()LockFile()Mapping CtrlIDsOOP in AutoItParseHeadersToSciTE()PasswordValidPasteBinPosts Per DayPreExpandProtect GlobalsQueue()Resource UpdateResourcesExSciTE JumpSettings INISHELLHOOKShunting-YardSignature CreatorStack()Stopwatch()StringAddLF()/StringStripLF()StringEOLToCRLF()VSCROLLWM_COPYDATAMore Examples...

Updated: 04/09/2015

Share this post


Link to post
Share on other sites

Stupid me! Why did I add the If ... EndIf Statement???! << Rhetorical question.


_AdapterConnections()_AlwaysRun()_AppMon()_AppMonEx()_BinaryBin()_CheckMsgBox()_CmdLineRaw()_ContextMenu()_ConvertLHWebColor()/_ConvertSHWebColor()_DesktopDimensions()_DisplayPassword()_DotNet_Load()/_DotNet_Unload()_Fibonacci()_FileCompare()_FileCompareContents()_FileNameByHandle()_FilePrefix/SRE()_FindInFile()_GetBackgroundColor()/_SetBackgroundColor()_GetConrolID()_GetCtrlClass()_GetDirectoryFormat()_GetDriveMediaType()_GetFilename()/_GetFilenameExt()_GetHardwareID()_GetIP()_GetIP_Country()_GetOSLanguage()_GetSavedSource()_GetStringSize()_GetSystemPaths()_GetURLImage()_GIFImage()_GoogleWeather()_GUICtrlCreateGroup()_GUICtrlListBox_CreateArray()_GUICtrlListView_CreateArray()_GUICtrlListView_SaveCSV()_GUICtrlListView_SaveHTML()_GUICtrlListView_SaveTxt()_GUICtrlListView_SaveXML()_GUICtrlMenu_Recent()_GUICtrlMenu_SetItemImage()_GUICtrlTreeView_CreateArray()_GUIDisable()_GUIImageList_SetIconFromHandle()_GUIRegisterMsg()_GUISetIcon()_Icon_Clear()/_Icon_Set()_IdleTime()_InetGet()_InetGetGUI()_InetGetProgress()_IPDetails()_IsFileOlder()_IsGUID()_IsHex()_IsPalindrome()_IsRegKey()_IsStringRegExp()_IsSystemDrive()_IsUPX()_IsValidType()_IsWebColor()_Language()_Log()_MicrosoftInternetConnectivity()_MSDNDataType()_PathFull/GetRelative/Split()_PathSplitEx()_PrintFromArray()_ProgressSetMarquee()_ReDim()_RockPaperScissors()/_RockPaperScissorsLizardSpock()_ScrollingCredits_SelfDelete()_SelfRename()_SelfUpdate()_SendTo()_ShellAll()_ShellFile()_ShellFolder()_SingletonHWID()_SingletonPID()_Startup()_StringCompact()_StringIsValid()_StringRegExpMetaCharacters()_StringReplaceWholeWord()_StringStripChars()_Temperature()_TrialPeriod()_UKToUSDate()/_USToUKDate()_WinAPI_Create_CTL_CODE()_WinAPI_CreateGUID()_WMIDateStringToDate()/_DateToWMIDateString()Au3 script parsingAutoIt SearchAutoIt3 PortableAutoIt3WrapperToPragmaAutoItWinGetTitle()/AutoItWinSetTitle()CodingDirToHTML5FileInstallrFileReadLastChars()GeoIP databaseGUI - Only Close ButtonGUI ExamplesGUICtrlDeleteImage()GUICtrlGetBkColor()GUICtrlGetStyle()GUIEventsGUIGetBkColor()Int_Parse() & Int_TryParse()IsISBN()LockFile()Mapping CtrlIDsOOP in AutoItParseHeadersToSciTE()PasswordValidPasteBinPosts Per DayPreExpandProtect GlobalsQueue()Resource UpdateResourcesExSciTE JumpSettings INISHELLHOOKShunting-YardSignature CreatorStack()Stopwatch()StringAddLF()/StringStripLF()StringEOLToCRLF()VSCROLLWM_COPYDATAMore Examples...

Updated: 04/09/2015

Share this post


Link to post
Share on other sites

jajaja I couldn't resist sorry for the spam!

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!


Register a new account

Sign in

Already have an account? Sign in here.


Sign In Now
Sign in to follow this  
Followers 0