[VB] Functions supported in CIMON

Function

Script

n = GetTagVal(“Tag Name”)

Description

Reads the current value of a tag.

Example

Stores the value of ‘Tag_1’ in the parameter, ‘Tag1’.

Sub Func1()

Tag1 = GetTagVal(“Tag_1”)

End Sub

Function

Script

n = GetTagValEx(“Tag Name”, “Tag Variable”)

Description

Reads the value of tag variable from a tag.

Example

Stores the maximum value of ‘Tag_2’ in the parameter, ‘Tag2’.

Sub Func2()

Tag2 = GetTagValEx(“Tag_2”, “MAX”)

End Sub

Subroutine

Script

SetTagVal “Tag Name”, Value

Description

Writes the value to a tag.

If a string tag is used, the value must be written in “Value” format.

Example

Set the value of ‘Tag_3’ as 10.

Sub Func3()

SetTagVal “Tag_3”, 10

End Sub

Subroutine

Script

SetTagValEx “Tag Name”, “Tag Variable”, Value

Description

Writes the value of tag variable to a tag.

Example

Set the description of‘Tag_4’ as “This is a description of ‘Tag_4’.’

Sub Func4()

SetTagValEx “Tag_4”, “DESC”, “This is a description of ‘Tag_4’.

End Sub

Function

Script

n = Abs(number)

Description

Returns the absolute value of a number.

Example

Set the absolute value at ‘Math_1’ as -10.55.

Sub AbsTest()

 SetTagVal “Math_1", Abs(-10.55)

End Sub

Function

Script

n = Atn(number)

Description

Returns the arc tangent of a number.

Example

Set the arc tangent value at ‘Math_2’. [Atn(1.0) = 0.79]

Sub AtnTest()

SetTagVal “Math_2", Atn(1.00)

End Sub

Note

Pi(3.1415) radians = 1800 degrees.

1 radian = 57.2957795131 degrees.

1 degree = .0174532925 radians.

Function

Script

n = Cos(number)

Description

Returns the cosine of an angle.

Example

Set the cosine value at ‘Math_3’. [Cos(3.141592/4) = 0.71]

Sub CosTest()

 SetTagVal “Math_3", Cos(3.141592/4)

End Sub

Function

Script

n = Exp(number)

Description

Returns e raised to a power

Example

Assign ‘Math_4’ to e raised to the 1 power. [Exp(1) = 2.71828183]

Sub ExpTest()

 SetTagVal “Math_4", Exp(1)

End Sub

Function

Script

n = Int(number)

Description

Returns the integer portion of a number.

Example

Assign the integer portion from given value at the ‘Math_6’.
[Int(-1234.5224) = -1235]

Sub IntTest()

SetTagVal "Math_6", Int(-1234.5224)

End Sub

Function

Script

n = Log(number)

Description

Returns the natural logarithm of a number.

Example

Assign the log from given value at the ‘Math_7’. [Log(100) = 4.61]

Sub LogTest()

SetTagVal "Math_7", Log(100)

End Sub

Function

Script

n = Random(min, max)

Description

Returns a random number between two values.

Example

Set the random value between 1 and 10 at the ‘Math_8’ for every 2 seconds.

Sub RandomTest()

While 1

SetTagVal "Math_8", Random(1, 10)

Sleep(2000)

WEnd

End Sub

Subroutine

Script

Randomize [number]

Description

Initializes the random number generator with a new seed.

Example

Generate the initial random number as 9, then set the random value between 1 and 10 at the ‘Math_9’ for every 2 seconds.

Sub RandomizeTest()

Randomize 9

While 1

SetTagVal "Math_9", Random(1, 10)

Sleep(2000)

WEnd

End Sub

Function

Script

n = Rnd ([number])

Description

Generates a random number between 0 and 1.

Example

Set the random value between 0 and 1 at the ‘Math_10’ for every 2 seconds.

Sub RndTest()

While 1

SetTagVal "Math_10", Rnd()

Sleep(2000)

WEnd

End Sub

Function

Script

n = Sgn (number)

Description

Returns an Integer indicating whether a number is less than, greater than, or equal to 0.

Returns 1 if number is greater than 0.

Returns 0 if number is equal to 0.

Returns -1 if number is less than 0.

Example

Determine the value of ‘Math_11’ whether positive or negative and return the result.

Sub SgnTest()

SetTagVal "Math_11", Sgn(100)

End Sub

Function

Script

n = Sin(number)

Description

Returns the sine of an angle.

Example

Set the sine of an angle at the ‘Math_12’. [Sin(3.141592/4) = 0.71]

Sub SinTest()

 SetTagVal “Math_12", Sin(3.141592/4)

End Sub

Function

Script

n = Sqr(number)

Description

Returns the square root of a number.

Example

Set the square root of 9 at the ‘Math_13’. [Sqr(9) = 3]

Sub SqrTest()

 SetTagVal “Math_13", Sqr(9)

End Sub

Function

Script

n = Tan(number)

Description

Returns the tangent of an angle.

Example

Set the tangent of an angle at the ‘Math_14’. [Tan(3.141592/4) = 1.00]

Sub TanTest()

 SetTagVal “Math_14", Tan(3.141592/4)

End Sub

Function

Script

n = Asc(string)
n = AscB(string)
n = AscW(string)

Description

Returns the integer containing the numeric code for the first character of string.

Example

Return the ASCII value of alphabet ‘A’.

Sub Asc_Test()

Dim nNum

nNum = Asc(“A”)

End Sub

Function

Script

n = Cbool(expression)

Description

Converts expression to True or False, returning a Boolean value.

Example

Use Cbool to determine whether a string is numeric or just text.

Sub Cbool_test()

 Dim IsNumericOrDate As Boolean

 S$ = "34224.54"

 IsNumericOrDate = Cbool(IsNumeric(S$) Or IsDate(S$))

 If IsNumericOrDate = True Then

 MsgBox S$ & " is either a valid date or number!"

 Else

 MsgBox S$ & " is not a valid date or number!"

End if

End Sub

Function

Script

n = CDate(expression)
n = CVDate(expression)

Description

Converts expression to a date, returning a Date value.

Example

Input two dates and compute the difference between them.

Sub CDate_Test()

Dim Date1 As Date

Dim Date2 As Date

Dim Diff As Date

Date1 = Cdate(#1/1/2018#)

Date2 = Cdate("01/02/2018")

Diff = DateDiff("d", Date1, Date2)

MsgBox "The date difference is " & Cint(diff) & " days."

End Sub

Function

Script

n = CDbl(expression)

Description

Converts any expression to a Double.

Example

Sub CDbl_test()

MsgBox "The double value is : " & CDbl(535.22 * 5.4 * 0.01)

End Sub

Function

Script

n = CInt(expression)

Description

Converts expression to an Integer.

Example

Sub CInt_test()

 I% = 100.55

 MsgBox "The value of CInt(I) = " & CInt(I%)

End Sub

Function

Script

n = CLng(expression)

Description

Converts expression to a Long.

Example

Sub CLng_test()

 I% = 10.55

 J% = 123.66

MsgBox "The result is" & CLng(I% * J%)

End Sub

Function

Script

n = CSng(expression)

Description

Converts expression to a Single.

Example

Sub CSng_test()

 I% = 100

 MsgBox "The single value is: " & CSng(I%)

End Sub

Function

Script

n = CStr(expression)

Description

Converts expression to a String.

Example

Sub Cstr_test()

 I% = 123.456

 MsgBox "The string value is: " & CStr(I%)

End Sub

Function

Script

n = Cvar(expression)

Description

Converts expression to a Variant.

Example

Sub Cvar_test()

 Dim V As Variant

 V = 4 & "th"

 MsgBox "You came in:" & V

 V = Cvar(4 & "th")

 MsgBox "You came in: " & V

End Sub

Function

Script

n = Chr[$] (charcode)
n = ChrB[$] (charcode)
n = ChrW[$] (charcode)

Description

Returns the character whose value is charcode.

Example

Sub Chr_test()

 Dim A%(2)

 For I = 0 To 2

 A%(I) = (65 + I)

 Next I

 MsgBox "The first three elements of the array are: "

 N=Chr$(A%(0)) & Chr$(A%(1)) & Chr$(A%(2))

End Sub

Function

Script

n = CVErr(expression)

Description

Converts expression to an error.

Example

Sub CVErr_test()

 MsgBox "The error is: " & CStr(CVErr(2046))

End Sub

Function

Script

n = Hex[$] (number)

Description

Converts a number to a hexadacimal string.

Example

Sub Hex_test()

 Do

 XS$ = InputBox$("Enter a number to convert: "," Hex Convert")

 X = Val(XS$)

 IF X <> 0 Then

 MsgBox "Dec: " & X & " Hex: " & Hex$(X)

 Else

 MsgBox "Goodbye."

 End if

 Loop While X<> 0

End Sub

Function

Script

n = IsDate(expression)

Description

Returns True if the expression can be converted to a date; returns False otherwise.

Example

Sub IsDate_test()

 Dim A As Variant

 Retry :

 A = InputBox("Enter a date "," Enter Date")

 If IsDate(A) Then

 MsgBox Format(A, "long date")

 Else

 MsgBox "Not quite, please try again!"

 Goto retry

 End if

End Sub

Function

Script

n = IsNumeric(expression)

Description

Returns 1 if expression can be converted to a number; returns 0 otherwise.

Example

Sub IsNumeric_test()

 Dim S As String

 S$ = InputBox("Input a number in the text field.","Input number")

 IF IsNumeric(S$) Then

 MsgBox "You have input a valid text."

 Else

 MsgBox "You have input a wrong text."

 End if

End Sub

Function

Script

n = Oct[$] (number)

Description

Converts a number to an octal string.

Example

Sub Oct_test()

 ST$ = "The octal values are: "

 For X = 1 To 5

 Y% = X * 10

 ST$ = ST$ & Y% & ":" & Oct6$(Y%)

 Next X

 Msgbox ST$

End Sub

Function

Script

n = Str[$] (number)

Description

Converts a number to a string.

Example

Sub Strtest()

 X# = 100.22

 MsgBox "The stirng value is :" + Str$(X#)

End Sub

Function

Script

n = Val (string)

Description

Converts a string expression to a number.

Example

Sub Val_test()

 A$ = InputBox("Enter anything containing a number", "Enter Number")

 B# = Val(A$)

 MsgBox "The value is:" & B#

End Sub

Function

Script

n = Choose(index, expression1. Expression2, …. Expression13)

Description

Returns the expression at the specified index position.

Example

Sub Choose_test()

 Dim A As Variant

 Dim C As Integer

 C% = 2

 A = Choose(C%, "Hello, world", #1/1/94#,5.5,Flase)

 MsgBox "Item" & C% & " is’" & A & "’"

End Sub

Subroutine

Script

1. Do {While | Until} condition statements Loop

1. Do

 statements

 Loop {While | Until} condition

Do

 statements

Loop

Description

Repeats a block of statements while a condition is True or until a condition is True.

Example

E.g. 1)
Sub Do_Test()

 Dim A$(100)

 I% = -1

 Do

 I% = I% + 1

 If I% = 0 Then

 A(I%) = Dir$("*")

Else

 A(I%) = Dir$

 End if

 Loop While (A(I%) <> "" And I% <= 99)

 R% = SelectBox(I% & " files found",,a)

End Sub

‘=============================

E.g. 2)
Sub Do_Test2()

 Dim A$(100)

I% = 0

A(I%) = Dir$("*")

 Do While (A(I%) <> "" And I% <= 99)

 I% = I% + 1

 A(I%) = Dir$

 Loop

 R% = SelectBox(I% & " files found",,A)

End Sub

‘=============================

E.g. 3)
Sub Do_Test3()

 Dim A$(100)

 I% = 0

A(I%) = Dir$("*")

Do Until (A(I%) = "" Or I% = 100)

 I% = I% + 1

 A(I%) = Dir$

 Loop

 R% = SelectBox(I% & " files found",,A)

End Sub

‘=============================

E.g. 4)
Sub Do_Test4()

 Dim A$(100)

 I% = -1

 Do

 I% = I% + 1

 If I% = 0 Then

 A(I%) = Dir$("*")

 Else

A(I%) = Dir$

 End if

 Loop Until (A(I%) <> "" Or I% = 100)

R% = SelectBox(I% & " files found",,a)

End Sub

Subroutine

Script

End

Description

Terminates execution of the current script, closing all open files.

Example

Sub En_test()

 MsgBox" The next line will terminate the script"

 End

End Sub

Subroutine

Script

Exit Do

Description

Causes execution to continue on the statement following the Loop clause.

Example

Load an array with directory entries unless there are more than 10 entries; in which case, the Exit Do terminates the loop.

Const crlf = Chr$(13) + Chr$(10)

Sub ExitDo_test()

Dim A$(100)

I% = -1

 Do

 I% = I% + 1

 If I% = 0 Then

 A(I%) = Dir$("*")

 Else

 A(I%) = Dir$

 End if

 If I% >= 10 Then Exit Do

 Loop While (A(I%) <> "")

 If I% = 10 Then

 MsgBox I% & " entries processed!"

 Else

 MsgBox "Less then " & I% & "entries processed!"

 End if

End Sub

Subroutine

Script

Exit For

Description

Causes execution to exit the innermost For loop, continuing execution on the line following the Next statement.

Example

Const crlf = Chr$(13) + Chr$(10)

Sub ExitFor_test()

Dim A$(100)

I% = -1

 For I = 1 To 100

 I% = I% + 1

 If I% = 0 Then

 A(I%) = Dir$("*")

 Else

 A(I%) = Dir$

 End if

 If I% >= 10 Then Exit For

Next I

End Sub

Subroutine

Script

For counter = start To end [Step increment]

 [statements]

 [Exit For]