Checks if a variable is a keyword (for example, Default).
IsKeyword ( variable )
| variable | The variable to check. |
| Success: | $KEYWORD_DEFAULT (1) the Default keyword. $KEYWORD_NULL (2) the Null keyword. |
| Failure: | 0 if not a keyword. |
See language datatypes for a detailed description.
#include <Constants.au3>
#include <MsgBoxConstants.au3>
Example()
Func Example()
; Check if a variable is the Default keyword.
Local $vDefault = Default
If IsDefault($vDefault) Then
MsgBox($MB_SYSTEMMODAL, "", "The variable is the Default keyword")
Else
MsgBox($MB_SYSTEMMODAL, "", "The variable is not the Default keyword")
EndIf
; Check if a variable is the Null keyword.
Local $vNull = Null
If IsNull($vNull) Then
MsgBox($MB_SYSTEMMODAL, "", "The variable is the Null keyword")
Else
MsgBox($MB_SYSTEMMODAL, "", "The variable is not the Null keyword")
EndIf
; Check if a variable is the Null keyword. This will be false as $sString is a string datatype.
Local $sString = 'Default'
If IsDefault($sString) Then
MsgBox($MB_SYSTEMMODAL, "", "The variable is the Default keyword")
Else
MsgBox($MB_SYSTEMMODAL, "", "The variable is not the Default keyword")
EndIf
EndFunc ;==>Example
Func IsDefault($vKeyword)
Return IsKeyword($vKeyword) = $KEYWORD_DEFAULT
EndFunc ;==>IsDefault
Func IsNull($vKeyword)
Return IsKeyword($vKeyword) = $KEYWORD_NULL
EndFunc ;==>IsNull