Function.Automation.General

From GAB Help
Jump to: navigation, search

Available commands

Contents

Function.Automation.Capture.Camera

Syntax

Function.Automation.Capture.Camera()

Arguments

Examples

Remarks


Function.Automation.CreditCard.AuthorizeOnly

Function.Automation.CreditCard.AuthorizeOnly

Syntax

Arguments

Examples

Remarks


Function.Automation.CreditCard.AVSOnly

Function.Automation.CreditCard.AVSOnly

Syntax

Arguments

Examples

Remarks


Function.Automation.CreditCard.Capture

Function.Automation.CreditCard.Capture

Syntax

Arguments

Examples

Remarks


Function.Automation.CreditCard.Charge

Function.Automation.CreditCard.Charge

Syntax

Arguments

Examples

Remarks


Function.Automation.CreditCard.Credit

Function.Automation.CreditCard.Credit

Syntax

Arguments

Examples

Remarks


Function.Automation.CreditCard.DeleteAllConfigs

Function.Automation.CreditCard.DeleteAllConfigs

Syntax

Arguments

Examples

Remarks


Function.Automation.CreditCard.GetConfig

Function.Automation.CreditCard.GetConfig

Syntax

Arguments

Examples

Remarks


Function.Automation.CreditCard.GetGateway

Function.Automation.CreditCard.GetGateway

Syntax

Arguments

Examples

Remarks


Function.Automation.CreditCard.Response

Function.Automation.CreditCard.Response

Syntax

Arguments

Examples

Remarks


Function.Automation.CreditCard.SaveConfigValue

Function.Automation.CreditCard.SaveConfigValue

Syntax

Arguments

Examples

Remarks


Function.Automation.CreditCard.SetAccountInfo

Function.Automation.CreditCard.SetAccountInfo

Syntax

Arguments

Examples

Remarks


Function.Automation.CreditCard.Validate

Function.Automation.CreditCard.Validate

Syntax

Arguments

Examples

Remarks


Function.Automation.CreditCard.Void

Function.Automation.CreditCard.Void

Syntax

Arguments

Examples

Remarks


Function.Automation.Epad.CaptureSignature

This function captures a signature from an ePadLink device.

Syntax

Function.Automation.ePad.CaptureSignature(FQ filename, boolean return)

Arguments

None

Example

Function.Automation.ePad.CaptureSignature("C:\Signature.jpeg",v.local.bRet)

Remarks

  • The signature is saved in JPEG format.
  • The boolean return indicates if the entry was successful (true), or cancelled (false).
  • This has been tested with the ePad Ink model.


Function.Automation.ePad.CaptureSignature

This function captures a signature from an ePadLink device (http://www.epadlink.com/).  The signature is saved in JPEG format.  The boolean return indicates if the entry was successful (true), or cancelled (false).  Note: This has been tested with the ePad Ink model.

Syntax

Function.Automation.ePad.CaptureSignature(FQ filename, boolean return)

Arguments

FQ filename
boolean return

Examples

Remarks


Function.Automation.Generic.CallMethod

Calls a method from an object.

Syntax

Function.Automation.Generic.CallMethod(Object Name, Method, Args)

Arguments

Object Name

String name of the object

Method

String name of the method

Args

Any arguments to be called

Example

None

Remarks

  • Must be used with CreateObject in order to create an object and call a method from it.
  • Used for wrapping controls not available in GAB.


Function.Automation.Generic.CallMethodReturnObject

Function.Automation.Generic.CallMethodReturnObject

Syntax

Arguments

Examples

Remarks


Function.Automation.Generic.CallMethodReturnVariable

This function calls a named method of the specified object. Arguments, if required, are passed concatenated with *!*. The return variable should match the method's return type.

Syntax

Function.Automation.Generic.CallMethodReturnVariable(object name [string], method [string], argument values [string], return [any])

or

Function.Automation.Generic.CallMethodReturnVariable(object name [string], method [string], return [any])


Arguments

Object name

string

Method

string

Argument values

string

Return

any


Example

Remark


Function.Automation.Generic.CheckPresence

Checks registered classes to determine if object is present on the client computer and returns a Boolean value.

Syntax

Function.Automation.Generic.CheckPresence(Object Type, Return Boolean)

Arguments

Object Type

Name of the object that needs to be verified of being on the computer

Return Boolean

True if it is present, False if not

Example

Function.Automation.Generic.CheckPresence(“MSWord”, variable.local.bRet)

Remarks

None


Function.Automation.Generic.CreateObject

Creates an Active X object.

Syntax

Function.Automation.Generic.CreateObject(Object Type, Object Name)

Arguments

Object Type

String object type

Object Name

String name of the object

Example

Function.Automation.Generic.CreateObject("MSWord","MyDoc")

Remarks

  • Object must be properly registered on the client machine in order to be created.
  • Any objects created with CreateObject must be destroyed with DestroyObject.


Function.Automation.Generic.DestroyObject

Destroys the object that has been created.

Syntax

Function.Automation.Generic.DestroyObject (Object Name)

Arguments

Object Name

Name of the object that needs to be verified of being on the computer

Example

Function.Automation.Generic.CreateObject(“MSWord”,”MyDoc”)
Function.Automation.Generic.DestroyObject(“MyDoc”)

Remarks

Destroys an object using the name specified in CreateObject.


Function.Automation.Generic.GetProperty

Reads the Data Type of a given property from an object.

Syntax

Function.Automation.Generic.GetProperty(Object Name, Property, String Return Variable)

Arguments

Object Name

String name of the object

Property

String name of the property

String Return

Variable of String Data Type

Example

None

Remarks

  • Must be used with CreateObject in order to create an object and read a property from it.
  • Used in the wrapping of controls not available in GAB.


Function.Automation.Generic.GetPropertyReturnObject

Function.Automation.Generic.GetPropertyReturnObject

Syntax

Arguments

Examples

Remarks


Function.Automation.Generic.LetProperty

Sets the Data Type of a property from an object.

Syntax

Function.Automation.Generic.LetProperty(Object Name, Property, Value)

Arguments

Object Name

String name of the object

Property

String name of the property

Value

String Data Type

Example

None

Remarks

  • Must be used with CreateObject in order to create an object and set a property.
  • Used in wrapping controls not available in GAB.


Function.Automation.Generic.SetProperty

Retrieves a property from a source object and sets its Data Type within a target object.

Syntax

Function.Automation.Generic.SetProperty(Object Name, Property, Value, Target Object)

Arguments

Object Name

String name of the source object

Property

String name of the source property

Value

String Data Type

Target Object

String name of the target object

Example

None

Remarks

  • Must be used with CreateObject in order to create a source object and target object and LetProperty to set a property within the source object.
  • Used in wrapping controls not available in GAB.


Function.Automation.Graphviz.AddNode

This command creates a new node and adds it to the graph.

Syntax

Function.Automation.Graphviz.AddNode(graphname [string],Nodename [string])

Argument

GraphName

Name of object

NodeName

Example

Function.Automation.Graphviz.AddNode("sampleGraph","node1")
Function.Automation.Graphviz.AddNode("sampleGraph","node1","node2","node3")

Remark


Function.Automation.Graphviz.AddRelation

Adds a Relation to a graph.If an asterisk (*) is appended to the graph name, all edges(relations) starting from this edge are set to same edge properties.However, one can set properties of an individual edge using the same function but without asterisk(*)

Syntax

Function.Automation.Graphviz.AddRelation(graphname [string],SourceNode [string],TargetNode [string], optional SourceChild [string],optional TargetChild [String],Optional Edge properties)

Argument

GraphName

Name of graph

SourceNode

Any node added to the graph from which the edge starts

TargetNode

Any node added to the graph to which the edge is directed to.

SourceChild
TargetChild
Edge properties
  • The following are the optional edge properties which are to be entered in a sequence.

AllEdges [Boolean] - Ehen set to true, all edges from this edge will have same properties as this edge

Edgedir [Edgedir] - directiion of the edge. Example - Edgedir.Forward

label [String] - Edge Label

EdgeStyle [EdgeStyle] - style of the edge. Example - Style.Dashed

Color [Color] - color of the edge Example - v.color.blue

headlabel [String] - label at the head of the edge (arrowhead)

taillabel [String] - label at the tailof the edge

LabelDistance [Double] - distance of label from the edge

FontColor[Color] - color of th eedge label

Fontname [String] - font of the edge label

FontSize [Double] - size of the edge label

Arrowhead [ArrowStyle] - style of arrowhead

ArrowTail[ArrowStyle] - style of arrow tail

ArrowSize [Double] - size of the arrow

weight [Double] - Weight of an edge. The heavier the weight, the shorter, straighter and more vertical the edge is.

Headport [Port] - Indicates where on the node the head of the edge is attached

Tailport [Port] - Indicates where on the node the tail of the edge is attached

Lhead [Nodename] (string) - Used in clusters.When set to a node, the edge head is clipped to the boundary of the cluster

Ltail [Nodename] (string) -Used in clusters.When set to a node, the edge tail is clipped to the boundary of the cluster


=Port=

n

ne

e

se

s

sw

w

nw

center

=EdgeStyle=

bold

dashed

dotted

invis

solid

none

=ArrowStyle=

box

curve

crow

dot

diamond

icurve

inv

lbox

lcrow

lcurve

ldiamond

licurve

linv

lnormal

ltee

lvee

none

normal

obox

odiamond

odot

oinv

olbox

oldiamond

olinv

olnormal

onormal

orbox

orinv

ordiamond

ornormal

rbox

rcurve

rcrow

rdiamond

ricurve

rinv

rnormal

rtee

rvee

tee

vee

=Edgedir=

forward

back

both

none

Example

Function.Automation.Graphviz.AddRelation("samplegraph","node1","node2")
Function.Automation.Graphviz.AddRelation("samplegraph*","node1","node2",,,,"same edge label")

Remark


Function.Automation.Graphviz.Create

This command creates a new graph with given graph name.

Syntax

Function.Automation.Graphviz.Create(graphname [string])

Argument

GraphName

Name of object

Example

Function.Automation.Graphviz.create("sampleGraph") 

Remark


Function.Automation.Graphviz.Delete

This command deletes a graph.

Syntax

Function.Automation.Graphviz.Delete(graphname [string])

Argument

GraphName

Name of object

Example

Function.Automation.Graphviz.Delete("sampleGraph") 

Remark


Function.Automation.Graphviz.DeleteNode

This command deletes an existing node from a graph. If a node is deleted, any edge/relation from or to that node is deleted from the graph.

Syntax

Function.Automation.Graphviz.DeleteNode(graphname [string],Nodename [string])

Argument

GraphName

Name of object

NodeName

Example

Function.Automation.Graphviz.DeleteNode("sampleGraph","node1")

Remark


Function.Automation.Graphviz.DeleteRelation

This command deletes a relation from a graph.

Syntax

Function.Automation.Graphviz.DeleteRelation(graphname [string],SourceNode [string],TargetNode [string], optional SourceChild [string],optional TargetChild [String])

Argument

Graphname
SourceNode
TargetNode
SourceChild
TargetChild

Example

Function.Automation.Graphviz.DeleteRelation("sampleGraph","node1","node2")

Remark


Function.Automation.Graphviz.NodeExists

This function returns a boolean- true if node exists and false if node does not exist.

Syntax

Function.Automation.Graphviz.NodeExists(graphname [string],Nodename [string],return variable[boolean])

Argument

GraphName

Name of object

NodeName
Return Variable

Example

Function.Automation.Graphviz.NodeExists("sampleGraph","node1",v.Local.bRet)

Remark


Function.Automation.Graphviz.OverridePath

This command overrides Graphviz installation path to given fully qualified path

Syntax

Function.Automation.Graphviz.OverridePath(FQN [string])

Argument

FQN

Fully Qualified Name

Example


Remark


Function.Automation.Graphviz.Render

This command renders a graph as an image( png/jpg) and saves it to fully qualified filename

Syntax

Function.Automation.Graphviz.Render(graphname [string],FQN [string])

Argument

GraphName

Name of object

FQN

Example

Function.Automation.Graphviz.Render("sampleGraph","C:\Users\pramidi\Desktop\Samplegraph.png")

Remark


Function.Automation.Graphviz.SetNodeProperties

This function sets properties of a node. If an asterisk (*) is appended to the graph name, all nodes starting from this node are set to same node properties.However, one can set properties of an individual node using the same function but without asterisk(*)

Syntax

Function.Automation.Graphviz.SetNodeProperties(graphname [string],Nodename [string],Optional properties)

Argument

Graphname
Nodename
Properties
  • The following are the list of optional node properties-

label [String] - label of the noode

Children ["*!*" delimited String] - children of the node only for cluster and table graph

FontName[String] - font of the node label

FontSize [Double] - fontsize of the label

FontColor[Color] - font color of the label

labeljustify [Boolean] - justification of the label

Shape [Shape] - shape of the node

Sides [Integer] - number sides of the node if shape=polygon

Nodecolor [Color] -Color used for node shapes

Style [NodeStyle] - style of the node Example style=Nodestyle.filled

Penwidth [Double] - Specifies the width of the pen, in points, used to draw lines and curves, including the boundaries of edges and Clusters

Fillcolor [Color] -color used to fill the background of a node or Cluster assuming Style=filled

Imagepath [String] - FQN of the image file

Imagescale [Imagescale] - Attribute controlling how an image fills it containing node

fixedsize [Fixedsize] - If false, the size of node is determined by smallest width and height needed to contain its label and image. If true, the node size is specified by the values of the width and height attributes only and is not expanded to contain text label.

height [Double] - Height of node

Width [Double] - width of the node

skew [Double] - Skew factor for shape=polygon. Positive values skew top of polygon to right, negative to left.

peripheries [Integer] - number of boundaries of nodes

Distortion[Double] - Distortion factor shape=polygon. Positive values cause top part to be larger than bottom; negative values do the opposite


Shape

assembly

box

box3d

circle

component

cds

cylinder

diamond

doublecircle

doubleoctagon

egg

ellipse

folder

fivepoverhang

hexagon

house

insulator

invhouse

invtrapezium

invtriagle

larrow

lpromoter

Mcircle

Mdiamond

Mrecord

Msquare

none

note

noverhang

octagon

oval

parallelogram

pentagon

plain

plaintext

point

polygon

primersite

promoter

proteasesite

proteinstab

parrow

record

rectangle

restrictionsite

ribosite

rnastab

rpromoter

septagon

signature

square

star

tab

terminator

threepoverhang

trapezium

triangle

tripleoctagon

underline

utr


NodeStyle

bold

dashed

diagonals

dotted

filled

invis

rounded

solid

none


Imagescale

yes

no

width

height

both


Fixedsize

yes

no

shape

Example

Function.Automation.Graphviz.Create("samplegraph")
Function.Automation.Graphviz.AddNode("samplegraph","node1","node2","node3","node4","node5")
Function.Automation.Graphviz.SetNodeProperties("samplegraph*","node1","same label- node1,node3")
Function.Automation.Graphviz.SetNodeProperties("samplegraph","node2","different label -node2")
Function.Automation.Graphviz.SetNodeProperties("samplegraph*","node4","different label -node4,Node5")

Remark


Function.Automation.Graphviz.SetProperties

This command sets the properties of a graph.

Syntax

Function.Automation.Graphviz.SetProperties(graphname [string],Graph Type,Optional properties)

Argument

GraphName

Name of object

GraphType
  • GraphType

FLOWCHART

CIRCLE

CLUSTER

ER

ORG

TABLE

Properties
  • The following are the list of optional graph properties to be entered in a sequence.

Label [String] - graph label Direction [Direction] - direction of the graph Exmaple - Direction.TB Labeljust [Labeljustification] - justification for labels labellocation [LabelLocation] location of graph label example Center [Boolean] - if set to true grpah is centered in the output FontName [String] - font of the graph label Fontsize [Double] - font size of the graph label Fontcolor [Color] -color of the graph label Bgcolor [Color] - background color of the graph spline [Spline] - controls how edges are represented Nodeseparation [Double] - minimum space between adjacent nodes in same rank or level Rankseparation [Double] - vertical distance between the bottom of the node inone level to top of the node in next level compound [Boolean] - cluster attribute. tf set to true edges are allowed between clusters Orientation [Orientation] - specifies the orientation of the graph corresponding to the page Width [Double] - width of the drawing Height [Double ] - height of the drawing penwidth [Double] - Specifies the width of the pen used to draw line and curves including boundaries of edges and clusters Margin [Double] - empty space left around the drawing. If the margin is a single double, both margins are set equal to the given value Rotation[Double] - Causes the final layout to be rotated counter-clockwise by the specified number of degrees


=Direction=

TB

LR

BT

RL


=Orientation=

Landscape

Potrait


=Spline=

curved

line

none

ortho

polyline

Spline


=LabelLocation=

bottom

top


=Labeljustification=

left

right

centered


Example

Function.Automation.Graphviz.NodeExists("sampleGraph","node1",v.Local.bRet)

Remark


Function.Automation.Groupware.AddLDIFentry

Syntax

Function.Automation.GroupWare.AddLDIFentry(first name, last name, full name, email address, work phone, home phone, fax, pager, mobile phone, street, city, state, postal code, country, job title, department)

Arguments

None

Example

None

Remarks

  • While all of the arguments are required, only the first three need actual values (while the rest can be passed blanks or "").
  • This command should be called repeatedly, once each for all of the desired LDIF entries, then WriteLDIF should be called.
  • LDIF is a portable address book file format. It can be imported into pretty much any modern PIM, email program (tested on Outlook and Thunderbird), contact manager, or smartphone.


Function.Automation.Groupware.CreateICalEvent

Syntax

Function.Automation.Groupware.CreateiCalEvent(Filename, Summary, Description, date/time Start, date/time End, TimeZone) or

Function.Automation.Groupware.CreateiCalEvent(Filename, Summary, Description, date/time Start, date/time End, TimeZone, Attendee(s)) or

Function.Automation.Groupware.CreateiCalEvent(Filename, Summary, Description, date/time Start, date/time End, TimeZone, Attendee(s), Priority, Status, Sequence, Class, Location, organizer, Category, Action, Trigger, Alarm Desc, Rule)

Arguments

None

Example

V.Local.sAttendees.Declare(String)

V.Local.dateStart.Declare(Date)

V.Local.dateEnd.Declare(Date)

F.Intrinsic.Date.DateTimeSerial(2008,10,3,20,30,1,V.Local.dateStart)

F.Intrinsic.Date.DateTimeSerial(2008,10,3,23,30,1,V.Local.dateEnd)

V.Local.sAttendees.Set("mailto:jdavis@gssmail.com*!*mailto:gab@gssmail.com")

f.Automation.groupware.createicalevent("C:\myevent.ics","Rock Band","Rock Band night at Davis house",V.Local.dateStart,V.Local.dateEnd,"CENTRAL",V.Local.sattendees)

f.Automation.groupware.createicalevent("C:\myeventAttend.ics","Rock Band","Rock Band night at Davis house",V.Local.dateStart,V.Local.dateEnd,"CENTRAL",V.Local.sattendees,5,"NEEDS-ACTION",0,"PUBLIC","OFFICE","mailto:jdavis@gssmail.com","PERSONAL","DISPLAY","-PT15M","Reminder","")

'valid rule might be FREQ=WEEKLY;COUNT=5;INTERVAL=1;BYDAY=WE

Remarks

  • Valid timezones are CENTRAL, MOUNTAIN, EASTERN, and PACIFIC.
  • Multiple attendees should be delimited with a *!*.
  • This command can be used in conjunction with F.Gl.Messaging.CreateEMmessage to email an iCal/vCal item.
  • This command can be used in conjunction with F.In.Task.ShellExec to populate Outlook, Lightning, Sunbird, etc. with an iCal/vCal item.


Function.Automation.Groupware.CreateiCalToDo

Syntax

Function.Automation.Groupware.CreateiCalToDo(Filename, Summary, Description, date/time Start, date/time End, TimeZone) or

Function.Automation.Groupware.CreateiCalToDo(Filename, Summary, Description, date/time Start, date/time End, TimeZone, Attendee(s)) or

Function.Automation.Groupware.CreateiCalToDo(Filename, Summary, Description, date/time Start, date/time End, TimeZone, Attendee(s), Priority, Status, Sequence, Class, Location, organizer, Category, Action, Trigger, Alarm Desc, Rule)

Arguments

None

Example

None

Remarks

  • Valid timezones are CENTRAL, MOUNTAIN, EASTERN, and PACIFIC.
  • Multiple attendees should be delimited with a *!*.
  • This command can be used in conjunction with F.Gl.Messaging.CreateEMmessage to email an iCal/vCal item.
  • This command can be used in conjunction with F.In.Task.ShellExec to populate Outlook, Lightning, Sunbird, etc. with an iCal/vCal item.


Function.Automation.Groupware.CreatevCard

Syntax

Function.Automation.Groupware.CreatevCard(Contact name, company name, contact title, work#, cell#, address line 1, address line 2, address line 3, city, state, zip, email address, filename)

Arguments

None

Example

None

Remarks

  • This command works well in conjunction with CreateEMMessage.
  • It is recommended that you specify a filename with a .VCF extension.


Function.Automation.Groupware.WriteLDIF

Syntax

Function.Automation.GroupWare.WriteLDIF(filename)

Arguments

Example

None

Remarks

  • This function writes an RFC 2849-compliant LDIF file, using information entered through the AddLDIFentry command.
  • LDIF is a portable address book file format. It can be imported into pretty much any modern PIM, email program (tested on Outlook and Thunderbird), contact manager, or smartphone.


Function.Automation.MsAccess.CheckPresence

Returns a boolean to state if MSAccess is on the machine

Syntax

Function.Automation.MSAccess.CheckPresence(Return Boolean)

Arguments

Return Boolean

True if it is present, False if not

Example

Function.Automation.MSAccess.CheckPresence(variable.local.bRet)

Remarks


Function.Automation.MsAccess.CompactDB

Compacts one database to another

Syntax

Function.Automation.MSAccess.CompactDB(Source DB Path, Target DB Path)

Arguments

Source DB Name

Fully Qualified Path to Source DataBase

Target DB Name

Fully Qualified Path to Target DataBase

Example

 None

Remarks

This function can be used to compact a database or databases.


Function.Automation.MSExcel.CheckPresence

Returns a boolean to state if MSExcel is on the machine

Syntax

Function.Automation.MSExcel.CheckPresence(Return Boolean)

Arguments

Return Boolean

True if it is present, False if not

Example

Function.Automation.MSExcel.CheckPresence(variable.local.bRet)

Remarks


Function.Automation.MSExcel.CopyCellFormat

This function copies the formatting block in the source worksheet to the specified starting position in the target worksheet. Note: This command requires that Microsoft Excel be installed

Syntax

Function.Automation.MSExcel.CopyCellFormat(source worksheet object, target worksheet object, starting column number, starting row number, ending column number, ending row number, target starting column number, target starting row number, ignore errors boolean)

Arguments

source worksheet object
target worksheet object
starting column number
starting row number
ending column number
ending row number
target starting column number
target starting row number
ignore errors boolean

Examples

Remarks


Function.Automation.MSExcel.CreateAppObject

Creates the Application Object for Excel.

Syntax

Function.Automation.MSExcel.CreateAppObject(Object Name)

Arguments

=Object Name

Name of the object user given

Example

Function.Automation.MSExcel.CreateAppObject(“MSExcel”)

Remarks

  • This must also be destroyed using DestroyAllObjects or Function.Automation.Generic.DestroyObject.


Function.Automation.MSExcel.CreateWorkbook

Creates a workbook and workbook object for Excel.

Syntax

Function.Automation.MSExcel.CreateWorkbook(App Object Name, Workbook Object Name, File Path)

Arguments

App Object Name

Name specified in CreateAppObject

Workbook Object Name

Name of the workbook the user is given

File Path

Fully Qualified path to the object

Example

Function.Automation.MSExcel.CreateAppObject("MSExcel")
Function.Automation.MSExcel.CreateWorkBook(“MSExcel”,”GuideTree”, “C:\ReferenceGuide.xls”)

Remarks


Function.Automation.MSExcel.CreateWorksheet

Creates a worksheet and worksheet object for Excel.

Syntax

Function.Automation.MSExcel.CreateWorksheet(Workbook Object Name, Worksheet Object Name, Sheet Name)

Arguments

Workbook Object Name

Name specified in CreateWorkBook

Worksheet Object Name

Name of worksheet object

Sheet Name

Name of worksheet

Example

Function.Automation.MSExcel.CreateAppObject("MSExcel")
Function.Automation.MSExcel.CreateWorkBook("MSExcel","GuideTree","C:\ReferenceGuide.xls")
Function.Automation.MSExcel.CreateWorkSheet("GuideTree","GuideSheet","Guide Sheet 1")

Remarks

  • This command requires that Microsoft Excel be installed


Function.Automation.MsExcel.DeleteAllObjects

Function.Automation.MSExcel.DeleteAllObjects

Syntax

Arguments

Examples

Remarks


Function.Automation.MSExcel.DestroyAllObjects

Destroys the application, workbook and worksheet objects that have been created in proper order. This function allows you to close all of your Excel objects with one command, eliminating the three Function.Automation.Generic.DestroyObject calls that would normally be required.

Syntax

Function.Automation.MSExcel.DestroyAllObjects(App Object Name, Workbook Object Name, Worksheet Object Name)

Arguments

App Object Name

Name specified in CreateAppObject.

Workbook Object Name

Name specified in CreateWorkBook or OpenWorkBook

Worksheet Object Name

Name specified in CreateWorkSheet or OpenWorkSheet

Example

Function.Automation.MSExcel.CreateAppObject("MSExcel")
Function.Automation.MSExcel.CreateWorkBook("MSExcel","GuideTree","C:\ReferenceGuide.xls")
Function.Automation.MSExcel.CreateWorkSheet("GuideTree","GuideSheet","Guide Sheet 1")
Function.Automation.MSExcel.DestroyAllObjects("MSExcel","GuideTree","GuideSheet")

Remarks

Must be used in the proper order.


Function.Automation.MSExcel.EnumerateWorksheets

Syntax

Function.Automation.MSExcel.EnumerateWorksheets(workbook object, string return  [string])

Arguments

workbook object
string return

string

Examples

Remarks


Function.Automation.MSExcel.FormatCell

Sets the format for a cell in a given worksheet

Syntax

Function.Automation.MSExcel.FormatCell(Worksheet object, Row, Column, Value)

Arguments

Worksheet object

Name of the Worksheet specified in OpenWorkSheet or CreateWorkSheet

Row

Row of the worksheet

Column

Column of the worksheet

Value

Numbers

"#,##0.00" - thousands separator with two fixed decimal places

"#,##0.00;[Red]-#,##0.00" - thousands separator with two fixed decimal places, negatives in red

"$#,##0.00;($#,##0.00)" - currency with two fixed decimal places, negatives in parenthesis

"General" - general formatting (default in Excel)

Dates/Times

"DD-MM-YYYY" - day-month-year

"MMMM, YYYY" - full month, year (ex: February, 2014)

"MM-DD-YYYY hh:mm:ss" - month-day-year hour:minute:second

"DD-MMM-YY" - day-abbr. month-short year (ex: 10-Feb-14)

"DD-MMM-YYYY" - day-abbr. month-year (ex: 10-Feb-2014)

Example

 None 

Remarks

This command requires that Microsoft Excel be installed.


Function.Automation.MSExcel.GetWorksheetCount

Returns the number of worksheets in the specified workbook.

Syntax

Function.Automation.MSExcel.GetWorksheetCount(WorkBook Object Name, ReturnVariable)

Arguments

WorkBook Object Name

Name of Workbook specified in OpenWorkbook

Return Variable

Long variable that returns the number of worksheets found

Example

Function.Automation.MSExcel.CreateAppObject("MSExcel")
Function.Automation.MSExcel.OpenWorkBook("MSExcel","GuideTree","C:\ReferenceGuide.xls")
Function.Automation.MSExcel.GetWorkSheetCount("GuideTree",v.local.iRet)

Remarks

  • This function requires that Microsoft Excel be installed


Function.Automation.MSExcel.NameWorksheet

Renames specified worksheet in Excel

Syntax

Function.Automation.MSExcel.NameWorkSheet(Worksheet Object Name, Sheet Name)

Arguments

Worksheet Object Name

Name specified in CreateWorksheet or OpenWorksheet

Sheet Name

New name for worksheet

Example

Function.Automation.MSExcel.CreateAppObject("MSExcel")
Function.Automation.MSExcel.CreateWorkBook("MSExcel","GuideTree","C:\ReferenceGuide.xls")
Function.Automation.MSExcel.CreateWorkSheet("GuideTree","GuideSheet","Guide Sheet 1")
Function.Automation.MSExcel.NameWorksheet("GuideSheet","Guide Sheet 2")

Remarks


Function.Automation.MSExcel.OpenWorkbook

Opens a workbook and creates a WorkBook object for Excel

Syntax

Function.Automation.MSExcel.OpenWorkbook(App Object Name, Workbook Object Name, File Path)

Arguments

App Object Name

Name specified in CreateAppObject

Workbook Object Name

Name of the workbook user given

File Path

Fully Qualified path to the object

Example

Function.Automation.MSExcel.CreateAppObject("MSExcel")
Function.Automation.MSExcel.OpenWorkBook(“MSExcel”,”GuideTree”, “C:\ReferenceGuide.xls”)

Remarks


Function.Automation.MSExcel.OpenWorksheet

Opens a worksheet and creates a worksheet object for Excel.

Syntax

Function.Automation.MSExcel.OpenWorkSheet(Workbook Object Name, Worksheet Object Name, Sheet Name)

Arguments

Workbook Object Name

Name specified in CreateWorkBook

Worksheet Object Name

Name of worksheet object

Sheet Name

Name of worksheet

Example

Function.Automation.MSExcel.CreateAppObject("MSExcel")
Function.Automation.MSExcel.OpenWorkBook("MSExcel","GuideTree","C:\ReferenceGuide.xls")
Function.Automation.MSExcel.OpenWorkSheet("GuideTree","GuideSheet","Guide Sheet 1")

Remarks


Function.Automation.MSExcel.ReadCell

Reads a cell within a worksheet of a workbook in Excel.

Syntax

Function.Automation.MSExcel.ReadCell(Worksheet Object Name, Row, Column, Return Variable)

Arguments

Worksheet Object Name

Name of the Worksheet specified in OpenWorksheet or CreateWorksheet

Row

Row of the worksheet

Column

Column of the worksheet

Return Variable

Variable for the data returned from the cell

Example

Function.Automation.MSExcel.CreateAppObject("MSExcel")
Function.Automation.MSExcel.OpenWorkBook("MSExcel","GuideTree","C:\ReferenceGuide.xls")
Function.Automation.MSExcel.OpenWorkSheet("GuideTree","GuideSheet","Guide Sheet 1")
Function.Automation.MSExcel.ReadCell(“GuideSheet”, 5, 2, variable.local.retVar)

Remarks

  • Rows and Columns start at 1,1


Function.Automation.MSExcel.ReadRow

Reads a selection of cells within a row in Excel.

Syntax

Function.Automation.MSExcel.ReadRow(Worksheet Object Name, Row, Starting Column, Ending Column, Return Variable)

Arguments

Worksheet Object Name - Name of WorkSheet specified in OpenWorksheet or CreateWorksheet

Row

Row of the worksheet

Starting Column

Starting column of the worksheet

Ending Column

Ending column of the worksheet

Return Variable

Variable for the data returned for the cells selected in row

Example

Function.Automation.MSExcel.CreateAppObject("MSExcel")
Function.Automation.MSExcel.OpenWorkBook("MSExcel","GuideTree","C:\ReferenceGuide.xls")
Function.Automation.MSExcel.OpenWorkSheet("GuideTree","GuideSheet","Guide Sheet 1")
Function.Automation.MSExcel.ReadRow(“GuideSheet”, 5, 2, 5, variable.local.retVar)


Remarks

  • Rows and Columns start at 1, 1


Function.Automation.MSExcel.ReadSpreadsheet

These functions return an entire spreadsheet in a triple-delimited string. The sheet delimiter is &^&, the row delimiter is $!$, and the column delimiter is *!*. Function.Intrinsic.String.Split can be used to break apart the returned string.

Syntax

Function.Automation.MSExcel.ReadSpreadsheet(file, return) or Function.Automation.MSExcel.ReadSpreadsheet(file, max col, max row, return)

Arguments

Example

  

Remarks

  • These commands require that Microsoft Excel be installed.


Function.Automation.MSExcel.RowCount

This gives a number representing the number of rows being used in the worksheet.

Syntax

Function.Automation.MSExcel.RowCount(Worksheet object, iRet)

Arguments

Worksheet Object

Name of the Worksheet

iRet

Long of the number of rows in the current sheet

Example

 Function.Automation.MSExcel.RowCount(“WorkSheet1”,Variable.Local.iCt) 

Remarks


Function.Automation.MSExcel.SaveWorkbook

Saves the entire workbook in Excel

Syntax

Function.Automation.MSExcel.SaveWorkbook(Workbook Object name)

Arguments

Workbook Object Name

Name of the Workbook specified in OpenWorkbook or CreateWorkbook

Example

Function.Automation.MSExcel.CreateAppObject("MSExcel")
Function.Automation.MSExcel.OpenWorkBook("MSExcel","GuideTree","C:\ReferenceGuide.xls")
Function.Automation.MSExcel.CreateWorkSheet("GuideTree","GuideSheet","Guide Sheet 1")
Function.Automation.MSExcel.SaveWorkBook(“GuideTree”) 

Remarks


Function.Automation.MSExcel.WriteCell

Writes data to a cell within a worksheet of a workbook in Excel

Syntax

Function.Automation.MSExcel.WriteCell(Worksheet Object Name, Row, Column, Value)

Arguments

Worksheet Object Name

Name of the Worksheet specified in OpenWorkSheet or CreateWorkSheet

Row

Row of the worksheet

Column

Column of the worksheet

Value or Variable

Value for the data written to the row/column

Example

Function.Automation.MSExcel.CreateAppObject("MSExcel")
Function.Automation.MSExcel.OpenWorkBook("MSExcel","GuideTree","C:\ReferenceGuide.xls")
Function.Automation.MSExcel.OpenWorkSheet("GuideTree","GuideSheet","Guide Sheet 1")
Function.Automation.MSExcel.WriteCell(“GuideSheet”, 5, 2, “This is a Test”)


Remarks

  • Rows and Columns start at 1,1


Function.Automation.MSExcel.WriteFormula

Writes a formula into a cell in Excel.

Syntax

Function.Automation.MSExcel.WriteFormula(Worksheet Object Name, Row, Column, Value)

Arguments

Worksheet Object Name

Name of Worksheet specified in OpenWorksheet or CreateWorksheet

Row

Row of the worksheet

Column

Column of the worksheet

Value

String value of formula to put in cell

Example

Function.Automation.MSExcel.CreateAppObject("MSExcel")
Function.Automation.MSExcel.OpenWorkBook("MSExcel","GuideTree","C:\ReferenceGuide.xls")
Function.Automation.MSExcel.OpenWorkSheet("GuideTree","GuideSheet","Guide Sheet 1")
Function.Automation.MSExcel.WriteFormula(“GuideSheet”, 3,3, "=Concatenate(B3,B4)")

Remarks

  • Rows and Columns start at 1, 1
  • This command requires that Microsoft Excel be installed


Function.Automation.MSExcel.WriteSpreadsheet

This command writes an entire spreadsheet from a triple-delimited string. The sheet delimiter is &^&, the row delimiter is $!$, and the column delimiter is *!*.

Syntax

Function.Automation.MSExcel.WriteSpreadSheet(File Path, Value)

Function.Automation.MSExcel.WriteSpreadSheet(File Path, Template, Value)

Arguments

File Path

Fully qualified file path

Template

Fully qualified file path to template spreadsheet

Value

Triple-delimited string value used to create spreadsheet

Example

Function.Automation.MSExcel.ReadSpreadSheet("C:\ReferenceGuide.xls", variable.local.retVar)
Function.Automation.MSExcel.WriteSpreadSheet("C:\ReferenceGuide_Backup.xls,variable.local.retVar) 

Remarks


Function.Automation.MSOutlook.AddContact

Adds a contact to MS Outlook

Syntax

Function.Automation.MSOutlook.AddContact(First Name, Last Name, Email Address, Email Display Name, Job Title, User, Category, Company Name, Customer ID, Business Address, Street, City, Zip, State, Phone, Cell)

Arguments

First Name

First name of contact

======Last Name======Last name of contact

Email Address

Email address of contact

Email Display Name

Display name of contact's email address

Job Title

Job title of contact

User

User name

Category

Category of contact

Company Name

Name of contact's company

Customer ID

Customer ID number of contact

Business Address

Business address of contact's company

Street

Street for address

City

City for address

Zip

Zip for address

State

State for address (Two character)

Phone

Phone number of contact

Cell

Cell phone number of contact

Example

Function.Automation.MSOutlook.AddContact(“Dusty”, “Alexander”, “dalexander@gssmail.com”, “Dusty Alexander”, “CEO”, “”, “”, “Global Shop Solutions”, “GLO010”, “975 Evergreen Circle”,””, “The Woodlands”, “77388”, “TX”,”281-681-1959”,””) 

Remarks

  • Not compatible with Outlook 2000.
  • MS Outlook must be installed and configured on any client that will run the program containing this function.


Function.Automation.MSOutlook.CheckPresence

Returns a boolean to state if MSOutlook is on the machine

Syntax

Function.Automation.MSOutlook.CheckPresence(Return Boolean)

Arguments

Return Boolean

1(True) if it is present, 0(False) if not

Example

Function.Automation.MSOutlook.CheckPresence(variable.local.bRet) 

Remarks

None


Function.Automation.MSOutlook.ComposeEmail

Syntax

Function.Automation.MSOutlook.ComposeEmail(recipients [string], subject [string], body [string])

Function.Automation.MSOutlook.ComposeEmail(recipients [string], subject [string], body [string], attachments [string])

Arguments

recipients

string

subject

string

body

string

attachments

string

Examples

Remarks


Function.Automation.MSOutlook.ComposeEmailHTML

Syntax

Function.Automation.MSOutlook.ComposeEmailHTML(recipients [string], subject [string], body [string])

Function.Automation.MSOutlook.ComposeEmailHTML(recipients [string], subject [string], body [string], attachments [string])

Arguments

recipients

string

subject

string

body

string

attachments

string

Examples

Remarks


Function.Automation.MSOutlook.ComposeEmailHTMLModal

Syntax

Function.Automation.MSOutlook.ComposeEmailHTMLModal(recipients [string], subject [string], body [string])

Function.Automation.MSOutlook.ComposeEmailHTMLModal(recipients [string], subject [string], body [string], attachments [string])

Arguments

recipients

string

subject

string

body

string

attachments

string

Examples

Remarks


Function.Automation.MSOutlook.ComposeEmailModal

Syntax

Function.Automation.MSOutlook.ComposeEmailModal(recipients [string], subject [string], body [string])

Function.Automation.MSOutlook.ComposeEmailModal(recipients [string], subject [string], body [string], attachments [string])

Arguments

recipients

string

subject

string

body

string

attachments

string

Examples

Remarks


Function.Automation.MSOutlook.FolderPathPicker

Pops up a dialog box displaying all the folders in MSOutlook

Syntax

Function.Automation.MSOutlook.FolderPathPicker(String Return Variable)

Arguments

String Return Variable

Return Variable

Example

Function.Automation.MSOutlook.FolderPathPicker(v.local.sRet)  

Remarks

None


Function.Automation.MSOutlook.GetContacts

This reads the Outlook address book and returns a string array, with the contact name and email address in each element, separated with a *!*

Syntax

Function.Automation.MSOutlook.GetContacts(return string Variable)

Arguments

Return Variable

String Variable for the contact list

Example

 Function.Automation.MSOutlook.GetContacts(variable.local.sContact)

Remarks

  • MS Outlook must be installed and configured for this command to work properly.


Function.Automation.MSOutlook.GetContactsExt

This function returns contact information from MS Outlook in a double delimited string. The rows are delimited with !*!, while the columns are delimited with *!*. Function.Intrinsic.String.Split should be used to split the rows into array elements, while Split can be used again on the rows to get a separate array of columns.

Syntax

Function.Automation.MSOutlook.GetContactsExt(string return) or

Function.Automation.MSOutlook.GetContactsExt(address list name, string return)

Arguments

None

Example

 

Remarks

  • The columns returned are: First name, Last name, Email address, Email display name, Job title, User field 1, User field 2, User field 3, User field 4, Categories, Company name, Customer ID, Business address, Business address Street, Business address city, Business address zip code, Business address state, Business telephone number, Mobile phone number.
  • Depending on how the contact was entered into Outlook, the entire address may come back in one of the fields, separated with Variable.Ambient.NewLine, or in the separate fields.
  • Microsoft Outlook 2003 (or higher) needs to be installed and configured on the client computer in order for this function to work.


Function.Automation.MsOutlook.GetEmailAttachments

Function.Automation.MSOutlook.GetEmailAttachments

Syntax

Arguments

Examples

Remarks


Function.Automation.MSOutlook.GetEmailBody

This function returns a specified email's body text. EntryID is usually derived from Function.Automation.MSOutlook.GetEmailListing.

Syntax

Function.Automation.MSOutlook.GetEmailBody(folder path, EntryID, string return)

Arguments

Example

 

Remarks

  • Folder path is specified as: \\account name\folder name. Subfolders to any depth can be appended to the base folder path.
  • If no email is found for an EntryID, ***NONE*** will be returned.
  • Microsoft Outlook 2003 (or higher) needs to be installed and configured on the client computer in order for this function to work.


Function.Automation.MSOutlook.GetEmailListing

This function returns a triple delimited string of an email folders' contents. Fields are delimited with *!*, recipients are delimited with &^&, and emails are delimited with *%*. Function.Intrinsic.String.Split should be used to separate the returned string on the delimiters into array elements.

Syntax

Function.Automation.MSOutlook.GetEmailListing(string return) or Function.Automation.MSOutlook.GetEmailListing(folder path, string return)

Arguments

Example

 

Remarks

  • If the syntax without a folder path is specified, a selection dialog will prompt the user to pick the appropriate account and folder.
  • Fields returned are: EntryID (this is Outlook's unique message identifier), Subject, Sent on date, Sender email address, Recipient(s)
  • Folder path is specified as: \\account name\folder name. Subfolders to any depth can be appended to the base folder path.
  • Microsoft Outlook 2003 (or higher) needs to be installed and configured on the client computer in order for this function to work.


Function.Automation.MSOutlook.GetTasks

This command returns the Tasks in Microsoft Outlook. The return is a double delimited string. !*! delimits the records, while *!* delimits the fields. Use nested Function.Intrinsic.String.Split commands to parse the result.

Syntax

Function.Automation.MSOutlook.GetTasks(string return variable)

Arguments

Example

Remarks

  • The returned fields areEntryID, Subject, Body, Importance, Ordinal, ContactNames, StartDate, DueDate, DateCompleted, LastModificationTime, PercentComplete, CreationTime, and TotalWork.
  • MS Outlook must be installed and configured for this command to work.
  • Function.Automation.MSOutlook.CheckPresence should be called (and return a True), before invoking GetTasks.


Function.Automation.MSOutlook.QueueEmail

Syntax

Function.Automation.MSOutlook.QueueEmail(recipients [string], subject [string], body [string], attachments [string])

Arguments

recipients

string

subject

string

body

string

attachments

string

Examples

Remarks


Function.Automation.MSOutlook.QueueEmailHTML

Syntax

Function.Automation.MSOutlook.QueueEmailHTML(recipients [string], subject [string], body [string], attachments [string])

Arguments

recipients

string

subject

string

body

string

attachments

string

Examples

Remarks


Function.Automation.MSOutlook.QueuePost

Syntax

Function.Automation.MSOutlook.QueuePost(Subject, Body, Status, Importance, Sensitivity)

Arguments

Subject

String for the subject

Body

String of the text for the Body

Status

Not started(0), in progress (1), complete (2), waiting(3), deferred (4)

Importance

low (0), normal (1), high (2)

Sensitivity

normal (0), personal (1), private (2), confidential (3)

Example

Function.Automation.MSOutlook.QueuePost(“Hello World”, variable.local.sBody, 1, 2, 1)

Remarks


Function.Automation.MSOutlook.QueuePostHTML

Syntax

Function.Automation.MSOutlook.QueuePostHTML(Subject, Body, Status, Importance, Sensitivity)

Arguments

Subject

String for the subject

Body

String of the text for the Body

Status

Not started(0), in progress (1), complete (2), waiting(3), deferred (4)

Importance

low (0), normal (1), high (2)

Sensitivity

normal (0), personal (1), private (2), confidential (3)

Example

Function.Automation.MSOutlook.QueuePostHTML(“Hello World”, variable.local.sBody, 1, 2, 1)

Remarks

None


Function.Automation.MSOutlook.QueueTask

Syntax

Function.Automation.MSOutlook.QueueTask(Subject, Body, Status, Importance, Sensitivity, Start date, due date, total work)

Arguments

Subject

String for the subject

Body

String of the text for the Body

Status

Not started(0), in progress (1), complete (2), waiting(3), deferred (4)

Importance

low (0), normal (1), high (2)

Sensitivity

normal (0), personal (1), private (2), confidential (3)

Start Date

Date to start task

Due Date

Date task is due

Total Work

Long

Example

Function.Automation.MSOutlook.QueueTask(“Hello World”, variable.local.sBody, 1, 2, 1, “12/25/2007”, “1/1/2008”, 5)

Remarks


Function.Automation.MSOutlook.SaveEmail

This function saves a specified email to disk. EntryID is usually derived from Function.Automation.MSOutlook.GetEmailListing.

Syntax

Function.Automation.MSOutlook.SaveEmail(folder path, EntryID, filename) or

Function.Automation.MSOutlook.SaveEmail(folder path, EntryID, filename, mode)

Arguments

Example

Remarks

  • If this function is called without a mode, the email will be saved (without attachments), as a plain-text file. If a mode of 0 is specified, the email will be saved as an MSG file. MSG files are a proprietary Microsoft Outlook format; these files can be opened if the user has Outlook on their computer (even if they do not have an account set up). MSG files contain any attachments that were sent in the original email.
  • Folder path is specified as: \\account name\folder name. Subfolders to any depth can be appended to the base folder path.
  • If no email is found for an EntryID, ***NONE*** will be returned.
  • Microsoft Outlook 2003 (or higher) needs to be installed and configured on the client computer in order for this function to work.


Function.Automation.MsOutlook.TaskAction

Function.Automation.MSOutlook.TaskAction

Syntax

Arguments

Examples

Remarks


Function.Automation.MSOutlook.TasksAction

This command allows an action to be applied to a Task in Microsoft Outlook

Syntax

Function.Automation.MSOutlook.TasksAction(EntryID, Action)

Function.Automation.MSOutlook.TasksAction(EntryID, Action, Field Name, Value)

Arguments

Action

Delete, Display, Mark Complete, Print, or Update

Example

Remarks

  • Updatable fields are: Subject, Body, Importance, ContactNames, StartDate, DueDate, DateCompleted, Complete, LastModificationTime, PercentComplete, CreationTime, and TotalWork
  • MS Outlook must be installed and configured for this command to work. Function.Automation.MSOutlook.CheckPresence should be called (and return a True), before invoking TaskAction.


Function.Automation.MSWord.CheckPresence

This command return status on the presence of a properly installed copy of MS Word.

Syntax

Function.Automation.MSWord.CheckPresence(boolean return)

Arguments

None

Example

Remarks

None


Function.Automation.MSWord.Replace

Syntax

Function.Automation.MSWord.Replace(file, find string, replace string)

Arguments

Example


Remarks

  • MS Word must be installed and configured for this command to work.


Function.Automation.Oocalc.CreateWorkbook

Creates the Open Office Workbook (OOCalc)

Syntax

Function.Automation.OOCalc.CreateWorkbook(Container Object Name, app object name, workbook object name)

Arguments

Container Object Name

Name of the container for the application

App Object Name

Name of the object on the computer

Workbook Obj Name

Name given to the workbook

Example

Function.Automation.OOCalc.CreateWorkbook(“OOContainer”,”OOApp”, “CalcWB”)

Remarks


Function.Automation.Oocalc.CreateWorksheet

Creates a worksheet within a given workbook

Syntax

Function.Automation.OOCalc.CreateWorksheet(workbook object, sheet name, sheet position)

Arguments

Example


Remarks

This command requires that OpenOffice be installed


Function.Automation.Oocalc.GetWorksheetCount

This function returns the number of worksheets in the specified workbook.

Syntax

Function.Automation.OOCalc.GetWorksheetCount(workbook object, long return)

Arguments

Example

Remarks

  • This command requires that OpenOffice Calc be installed.


Function.Automation.Oocalc.OpenWorkbook

Opens a workbook for Open Office Calc

Syntax

Function.Automation.OOCalc.OpenWorkbook(container object name, app Object Name, workbook object name)

Arguments

Container Object Name

Name of the container for the application

App Object Name

Name of the object on the computer

Workbook Obj Name

Name given to the workbook

Example

Function.Automation.OOCalcl.OpenWorkbook(“OOContainer”,”OOCalc”,”CalcWB”)

Remarks


Function.Automation.Oocalc.OpenWorksheet

Opens the Open Office Worksheet (Calc)

Syntax

Function.Automation.OOCalc.OpenWorksheet(Workbook object name, Worksheet object name, worksheet number)

Arguments

Workbook Object Name

Name of the workbook

Worksheet Obj Name

Name given to the worksheet

Worksheet number

Number of the sheet in the workbook

Example

Function.Automation.OOCalc.OpenWorkSheet(”CalcWB”, “CalcWS”,0)

Remarks


Function.Automation.Oocalc.ReadCell

Reads a cell within a worksheet of a workbook

Syntax

Function.Automation.OOCalc.ReadCell(Worksheet Object, Row, Column, Return Variable)

Arguments

Worksheet Object

Name of the Worksheet

Row

Row of the worksheet

Column

Column of the worksheet

Return Variable

Variable for the data returned for the row/column

Example

Function.Automation.OOCalc.ReadCell(“CalcWS”, 0, 0, V.Local.sValue)

Remarks

  • Rows and Columns start at 0,0


Function.Automation.OOCalc.ReadRow

Reads multiple cells within a worksheet of a workbook

Syntax

Function.Automation.OOCalc.ReadRow(Worksheet Object Name, Row, Starting Column, Ending Column, String Return Variable)

Arguments

Worksheet Object Name

String name of the worksheet object

Row

Row of the worksheet object

Starting Column

Starting column of the worksheet object

Ending Column

Ending column of the worksheet object

String Return Variable

Variable for the data returned for the row/columns

Example

Function.Automation.OOCalc.ReadRow(“WorkSheet1”, 5, 2, 5, variable.local.retVar)

Remarks

  • Rows and Columns start at 1, 1.
  • The return is a *!* delimited string. Use F.in.String.Split to parse it


Function.Automation.OOCalc.ReadSpreadsheet

These functions return an entire spreadsheet in a triple-delimited string. The sheet delimiter is &^&, the row delimiter is $!$, and the column delimiter is *!*. Function.Intrinsic.String.Split can be used to break apart the returned string.

Syntax

Function.Automation.OOCalc.ReadSpreadsheet(File, As Excel, Return) or

Function.Automation.OOCalc.ReadSpreadsheet(File, As Excel, Max Col, Max Row, return)

Arguments

As Excel

Boolean that specifies if OpenOffice Calc should save the spreadsheet as an XLS, or an ODS file.

Example


Remarks

  • These commands require that OpenOffice Calc be installed.


Function.Automation.OOCalc.RowCount

Syntax

Arguments

Example

Remarks


Function.Automation.OOCalc.SaveWorkbook

Saves the entire workbook

Syntax

Function.Automation.OOCalc.SaveWorkbook(Container Object, Workbook Object name, Filename)

Arguments

Container Object

Name of the container

Workbook Object

Name of the Workbook

Filename

FQP to the file

Example

Function.Automation.OOCalc.SaveWorkbook(“OOContainer”, “CalcWB”, “c:\test.ods”)

Remarks


Function.Automation.OOCalc.WriteCell

Writes data to a cell within a worksheet of a workbook.

Syntax

Function.Automation.OOCalc.WriteCell(Worksheet Object, Row, Column, Value or Variable)

Arguments

Worksheet Object

Name of the Worksheet

Row

Row of the worksheet

Column

Column of the worksheet

Value or Variable

Variable or Value for the data written to the row/column

Example

Function.Automation.OOCalc.WriteCell(“CalcWS”, 0, 0, “ID”)

Remarks

  • Rows and Columns start at 0,0.


Function.Automation.OOCalc.WriteSpreadsheet

These functions write an entire spreadsheet from a triple-delimited string. The sheet delimiter is &^&, the row delimiter is $!$, and the column delimiter is *!*.

Syntax

Function.Automation.OOCalc.WriteSpreadsheet(file, as Excel, data) or

Function.Automation.OOCalc.WriteSpreadsheet(file, Template, as Excel, data)

Arguments

As Excel

Boolean that specifies if OpenOffice Calc should read the spreadsheet as an XLS, or an ODS file.

Example

Remarks

  • These commands require that OpenOffice Calc be installed.
  • These commands require that Microsoft Excel be installed


Function.Automation.OOGeneral.CheckPresence

Returns a boolean to state if Open Office is on the machine.

Syntax

Function.Automation.OOGeneral.CheckPresence(Boolean Return)

Arguments

Example

Function.Automation.OOGeneral.CheckPresence(variable.local.bRet)

Remarks


Function.Automation.OOGeneral.CreateAppObject

Creates the Application Object in Open Office.

Syntax

Function.Automation.OOGeneral.CreateAppObject(Container Object Name, App Object Name)

Arguments

Container Object Name

Name of the object

App Object Name

Name of the Application

Example

Function.Automation.OOGeneral.CreateAppObject(“OOContainer”, “OOApp”)

Remarks


Function.Automation.OOGeneral.CreateContainer

Creates the Container Object in Open Office.

Syntax

Function.Automation.OOGeneral.CreateContainer(Container Object Name)

Arguments

Container Object Name

Name of the object

Example

Function.Automation.OOGeneral.CreateContainer(“OOContainer”)

Remarks


Function.Automation.OOGeneral.TerminateApp

Syntax

Function.Automation.OOGeneral.TerminateApp(App Object Name)

Arguments

App Object Name

Example

Program.Sub.Main.Start
Variable.Local.bOOAvailable.Declare(Boolean)
Variable.Local.sValue.Declare(String)
Function.Automation.OOGeneral.CheckPresence(V.Lo.bOOAvailable)
Function.Intrinsic.Control.If(V.Lo.bOOAvailable,"=",True)
Function.Automation.OOGeneral.CreateContainer("OOContainer")
Function.Automation.OOGeneral.CreateAppObject("OOContainer","OOApp")
Function.Automation.OOCalc.CreateWorkbook("OOContainer","OOApp","CalcWB")
Function.Automation.OOCalc.OpenWorksheet("CalcWB","CalcWS",0)
Function.Automation.OOCalc.WriteCell("CalcWS",0,0,"ID")
Function.Automation.OOCalc.WriteCell("CalcWS",0,1,"Value")
Function.Automation.OOCalc.WriteCell("CalcWS",1,0,"1")
Function.Automation.OOCalc.WriteCell("CalcWS",1,1,"Bronze")
Function.Automation.OOCalc.WriteCell("CalcWS",2,0,"2")
Function.Automation.OOCalc.WriteCell("CalcWS",2,1,"Aluminum")
Function.Automation.OOCalc.SaveWorkbook("OOContainer","CalcWB","c:\test.ods")
Function.Automation.OOCalc.ReadCell("CalcWS",1,1,V.Lo.sValue)
Function.Automation.Generic.DestroyObject("CalcWS")
Function.Automation.Generic.DestroyObject("CalcWB")
Function.Automation.OOGeneral.TerminateApp("OOApp")
Function.Automation.Generic.DestroyObject("OOApp")
Function.Automation.Generic.DestroyObject("OOContainer")
Function.Intrinsic.UI.MsgBox(V.Lo.sValue)
Function.Intrinsic.Control.Else
Function.Intrinsic.UI.MsgBox("OpenOffice is not installed on this machine")
Function.Intrinsic.Control.EndIf
Program.Sub.Main.End

Remarks


Function.Automation.OOWriter.Replace

Syntax

Function.Automation.OOWriter.Replace(file, find string, replace string)

Arguments

Example

Remarks

  • OpenOffice must be installed and configured for this command to work.
  • This command can be used in conjunction with the 7 parameter Function.Global.Messaging.CreateEMMessage to bulk email a mailmerged document


Function.Automation.PDF.AddText

Function.Automation.PDF.AddText

Syntax

Arguments

Examples

Remarks


Function.Automation.PDF.Close

Syntax

Function.Automation.PDF.Close(reference name [string])

Arguments

reference name

string

Examples

Remarks


Function.Automation.PDF.CreateFromImage

This method converts an image file (from sPathImage) to a PDF file (to sPathPDF).

Syntax

Function.Automation.PDF.CreateFromImage(sPathImage [string], sPathPDF [string], PreserveSize [boolean])

Arguments

PathImage

Path of the image file

PathPDF

Path for the PDF file

PreserveSize

Boolean for preserving size or not

Examples

v.Local.sImagePath.Set("X:\MultiPages.tif")

v.Local.sPDFPath.Set("X:\MultiPages.pdf")

Function.Automation.PDF.CreateFromImage(v.Local.sImagePath , v.Local.sPDFPath, false)

Remarks

  • GAB.NET has built-in encoders and decoders that support the following file types:

BMP GIF JPEG PNG TIFF

  • If the file does not have a valid image format or if GAB.NET does not support the pixel format of the file, this method throws an OutOfMemoryException exception.
  • The file remains locked until the command finishes executing.


Function.Automation.PDF.ExtractPages

Function.Automation.PDF.ExtractPages

Syntax

Arguments

Examples

Remarks


Function.Automation.PDF.GetFieldNames

Syntax

Function.Automation.PDF.GetFieldNames(reference name [string], return [string])

Arguments

reference name

string

return

string

Examples

Remarks


Function.Automation.PDF.GetFieldNamesAndValues

Syntax

Function.Automation.PDF.GetFieldNamesAndValues(reference name [string], return [string])

Arguments

reference name

string

return

string

Examples

Remarks


Function.Automation.PDF.GetPageCount

Function.Automation.PDF.GetPageCount

Syntax

Arguments

Examples

Remarks


Function.Automation.PDF.IsOpen

Syntax

Function.Automation.PDF.IsOpen(reference name [string], return [Boolean])

Arguments

reference name

string

return

Boolean

Examples

Remarks


Function.Automation.PDF.Merge

Syntax

Function.Automation.PDF.Merge(fully qualified input files [string], fully qualified output filename [string])

Arguments

fully qualified input files

string

fully qualified output filename

string

Examples

Remarks


Function.Automation.PDF.Open

Syntax

Function.Automation.PDF.Open(reference name [string], fully qualified filename [string])

Arguments

reference name

string

fully qualified filename

string

Examples

Remarks


Function.Automation.PDF.Resize

Function.Automation.PDF.Resize

Syntax

Arguments

Examples

Remarks


Function.Automation.PDF.SetFormFields

Function.Automation.PDF.SetFormFields

Syntax

Arguments

Examples

Remarks


Function.Automation.PDF.TextSearch

This function searches the key word in PDF object and returns a delimited ("*!*") string of pages that contain keyword.

Syntax

Function.Automation.PDF.TextSearch(PDF object name [string], search text [string], return [string])

Arguments

PDF object name

string

Text

String

return

String

Examples

Function.Automation.PDF.Open("myCoolPDF", "C:\myPDFTest.pdf")
Function.Automation.PDF.TextSearch("myCoolPDF", "myCoolText", V.Local.Return)
Function.Intrinsic.UI.Msgbox(V.Local.Return) 'non return
Function.Automation.PDF.Close("myCoolPDF")

Remarks

  • If no match was found, it returns "***NO RETURN***".


Function.Automation.Pervasive.Archivetable

This function creates a ZIP archive, containing the origin file of the specified table.

Syntax

Function.Automation.Pervasive.ArchiveTable(table name, archive filename)

Arguments

Example

Remarks

  • This command works on base files as well as MKDs.
  • This command requires GAB Component Install 2.0


Function.Automation.Pervasive.ArchiveTable

This function creates a ZIP archive, containing the origin file of the specified table. Note: This command works on base files as well as MKDs. Note: This command requires GAB Component Install 2.0

Syntax

Function.Automation.Pervasive.ArchiveTable(table name, archive filename)

Arguments

table name
archive filename

Examples

Remarks


Function.Automation.Pervasive.ClearRebuildLog

This function clears the Pervasive file rebuild log.

Syntax

Function.Automation.Pervasive.ClearRebuildLog

Arguments

Example

F.Intrinsic.String.Concat(V.Caller.FilesDir,"\RebuildList.txt",V.Local.sFile)
'check to see if the RebuildList.txt file exists
F.Intrinsic.File.Exists(V.Local.sFile,V.Local.bRet)
F.Intrinsic.Control.If(V.Local.bRet,=,True)
'Converts the RebuildList.txt file to string
F.Intrinsic.file.File2String(V.Local.sFile,V.Local.sString)
F.Intrinsic.String.Split(V.Local.sString,V.Ambient.NewLine,V.Local.sText)
'deletes the rbldcli.log file
F.Automation.Pervasive.ClearRebuildLog

Remarks


Function.Automation.Pervasive.DisplayRebuildLog

This function launches the Pervasive file rebuild log in Notepad.

Syntax

Function.Automation.Pervasive.DisplayRebuildLog

Arguments

Example

Remarks


Function.Automation.Pervasive.GetClientVersion

Function.Automation.Pervasive.GetClientVersion

Syntax

Arguments

Examples

Remarks


Function.Automation.Pervasive.GetFileNameFromTableName

This function returns a fully-qualified filename, given a table name.

Syntax

Function.Automation.Pervasive.GetFileNameFromTableName(table name, returned filename)

Arguments

None

Example

Program.Sub.Main.Start

v.lo.i.declare(long)

v.lo.s.declare(string)

f.au.pervasive.getfilenamefromtablename("atg_wft_lines",v.lo.s)

f.au.pervasive.clearrebuildlog

f.au.pervasive.rebuildfile(v.lo.s,v.lo.i)

f.au.pervasive.displayrebuildlog

Program.Sub.Main.end

Remarks

  • This command works on base files as well as MKDs.


Function.Automation.Pervasive.GetServerVersion

Function.Automation.Pervasive.GetServerVersion

Syntax

Arguments

Examples

Remarks


Function.Automation.Pervasive.GetTablenameFromFilename

This function returns a table name, given a data filename (no path component). Note: This command works on base files as well as MKDs.

Syntax

Function.Automation.Pervasive.GetTableNameFromFilename(filename, returned table name)

Arguments

filename
returned table name

Examples

Remarks


Function.Automation.Pervasive.RebuildFile

This function rebuilds the specified file.  If the filename is not fully-qualified, it is assumed that the file is located in the Global Shop FILES directory.  The value returned is the elapsed time required by the rebuild process, in seconds. Note: This command only works on Pervasive version 8.5, and higher. Note: Due to the size of many of the Global Shop data files, it is recommended that this command be executed on the server.

Syntax

Function.Automation.Pervasive.RebuildFile(filename, long return)

Function.Automation.Pervasive.RebuildFile(filename, switches, long return)

Arguments

filename
switches
long return

Examples

Remarks


Function.Automation.RFID.ClearTags

This will clear the queue of all tags that were read by the specified reader. Returns a Boolean that indicates if the command was successful. (See Variable.Ambient.RFIDException for error message if the command was unsuccessful.)

Syntax

Function.Automation.RFID.ClearTags(Reader ID [Long], Successful returned [Boolean])

Arguments

Reader ID

Long

Successful returned

Boolean

Examples

Remarks


Function.Automation.RFID.ConnectReader

Attempts to connect to the specified reader. Returns a Boolean that indicates if the connection attempt was successful. (See Variable.Ambient.RFIDException for error message if the command was unsuccessful.)

Syntax

Function.Automation.RFID.ConnectReader(Reader ID [Long], Successful returned [Boolean])

Arguments

Reader ID

Long

Successful returned

Boolean

Examples

Remarks


Function.Automation.RFID.CreateReaderID

Creates a reader ID for the passed connection string. Returns a unique identifier for that reader, to be used with the other Function.Automation.RFID commands.

Syntax

Function.Automation.RFID.CreateReaderID(Connection [String], Reader ID [Long])

Arguments

Connection

String

Reader ID

Long

Examples

Remarks


Function.Automation.RFID.DestroyReader

Disconnects the reader. After calling this command, this reader ID will no longer exist and cannot be used when calling other functions in the Function.Automation.RFID namespace. Returns a Boolean that indicates if the command was successful. (See Variable.Ambient.RFIDException for error message if the command was unsuccessful.)

Syntax

Function.Automation.RFID.DestroyReader(Reader ID [Long], Successful returned [Boolean])

Arguments

Reader ID

Long

Successful returned

Boolean

Examples

Remarks


Function.Automation.RFID.GetReaderParameter

Retrieve value of the specfied parameter for the specified reader. The following parameters are supported: /reader/commandTimeoutSpecifies how long the reader will continue to attempt a synchronous read/write before giving up. (Integer) /reader/antenna/portListList of every antenna for the reader. (Delimited String, delimited by *!*) /reader/antenna/connectedPortListList of every antenna connected to the reader. (Delimited String, delimited by *!*) /reader/read/asyncOffTimeThe duration, in milliseconds, for the reader to be quiet while querying, RF Off time, on the reader during background, asynchronous read operations. (Integer) /reader/read/asyncOnTimeThe duration, in milliseconds, for the reader to be actively querying, RF On time, on the reader during background, asynchronous read operations. (Integer) /reader/tagop/antennaThe antenna used for write operations. (Integer)

Syntax

Function.Automation.RFID.GetReaderParameter(Reader ID [Long], Parameter Name [String], Parameter Value returned)

Arguments

Reader ID

Long

Parameter Name

String

Parameter Value returned

Examples

Remarks


Function.Automation.RFID.GetTag

Same as Function.Automation.RFID.GetTags, but allows a specific tag to be passed. Tags will be returned in the order of when they were last read (most recent first). Returns a double delimited string of each tag and infomation obtained during the last read of the tag on that antenna. Each tag is delimited by *!*, each element for the tag is delimited by @#@. Returned elements for each tag: EPCReader IDAntennaRssi (dBm)dBm difference since last readLast Time readseconds elapsed since last readOptionally, a boolean can be passed to indicate if the tags should be cleared from the queue after this function returns the values. Passing -1 for Reader ID will return all the tags for every reader.

Syntax

Function.Automation.RFID.GetTag(Reader ID [Long], EPC [String], Tags returned [String])

Function.Automation.RFID.GetTag(Reader ID [ong], EPC [String], Clear Tags [Boolean], Tags returned [String])

Arguments

Reader ID

ong

EPC

String

Clear Tags

Boolean

Tags returned

String

Examples

Remarks


Function.Automation.RFID.GetTags

Retrieves every tag that has been read by the specified reader per antenna, in order of when they were first read. Returns a double delimited string of each tag and infomation obtained during the last read of the tag on that antenna. Each tag is delimited by *!*, each element for the tag is delimited by @#@. Returned elements for each tag: EPCReader IDAntennaRssi (dBm)dBm difference since last readLast Time readseconds elapsed since last readOptionally, a boolean can be passed to indicate if the tags should be cleared from the queue after this function returns the values. Passing -1 for Reader ID will return all the tags for every reader.

Syntax

Function.Automation.RFID.GetTags(Reader ID [Long], Clear Tags [Boolean], Tags returned [String])

Function.Automation.RFID.GetTags(Reader ID [Long], Tags returned [String])

Arguments

Reader ID

Long

Tags returned

String

Examples

Remarks


Function.Automation.RFID.ReadUserData

Reads the User Data portion of the tag. By default, the User Data will be returned as ASCII text. Optionally, a boolean can be passed to retrieve a hexadecimal representation, instead. Note: This command can only be called when the reader is not currently in asynchronous reading mode.

Syntax

Function.Automation.RFID.ReadUserData(Reader ID [Long], EPC [String], Is Hex [Boolean], User Data returned [String])

Function.Automation.RFID.ReadUserData(Reader ID [Long], EPC [String], User Data returned [String])

Arguments

Reader ID

Long

EPC

String

User Data returned

String

Examples

Remarks


Function.Automation.RFID.SetReaderParameter

Retrieve value of the specfied parameter for the specified reader.The following parameters are supported: /reader/commandTimeoutSpecifies how long the reader will continue to attempt a synchronous read/write before giving up. (Integer) /reader/read/asyncOffTimeThe duration, in milliseconds, for the reader to be quiet while querying, RF Off time, on the reader during background, asynchronous read operations. (Integer) /reader/read/asyncOnTimeThe duration, in milliseconds, for the reader to be actively querying, RF On time, on the reader during background, asynchronous read operations. (Integer) /reader/tagop/antennaThe antenna used for write operations. (Integer) Note: This command can only be called when the reader is not currently in asynchronous reading mode.

Syntax

Function.Automation.RFID.SetReaderParameter(Reader ID [Long], Parameter Name [String], Parameter Value, Successful returned [Boolean])

Arguments

Reader ID

Long

Parameter Name

String

Parameter Value
Successful returned

Boolean

Examples

Remarks


Function.Automation.RFID.StartReading

Begins asynchronous reading of tags for the specified reader. The reader will keep track of each tag read by each antenna on the reader. Returns a Boolean that indicates if the command was successful. (See Variable.Ambient.RFIDException for error message if the command was unsuccessful.)

Syntax

Function.Automation.RFID.StartReading(Reader ID [Long], Successful returned [Boolean])

Arguments

Reader ID

Long

Successful returned

Boolean

Examples

Remarks


Function.Automation.RFID.StopReading

Stops asynchronous reading of tags for the specified reader. Returns a Boolean that indicates if the command was successful. (See Variable.Ambient.RFIDException for error message if the command was unsuccessful.)

Syntax

Function.Automation.RFID.StopReading(Reader ID [Long], Successful returned [Boolean])

Arguments

Reader ID

Long

Successful returned

Boolean

Examples

Remarks


Function.Automation.RFID.WriteNewTag

Rewrites the specified tag with a new EPC. Returns a Boolean that indicates if the command was successful. (See Variable.Ambient.RFIDException for error message if the command was unsuccessful.) Note: This command can only be called when the reader is not currently in asynchronous reading mode.

Syntax

Function.Automation.RFID.WriteNewTag(Reader ID [Long], Current EPC [String], New EPC [String], Successful returned [Boolean])

Arguments

Reader ID

Long

Current EPC

String

New EPC

String

Successful returned

Boolean

Examples

Remarks


Function.Automation.RFID.WriteUserData

Writes information to the user data portion of the tag. By default, the User Data will be passed as ASCII text. Optionally, a boolean can be passed to indicate that the User Data will be passed in hexadecimal representation, instead. Note: This command can only be called when the reader is not currently in asynchronous reading mode.

Syntax

Function.Automation.RFID.WriteUserData(Reader ID [Long], EPC [String], User Data [String], Is Hex [Boolean], Successful returned [Boolean])

Function.Automation.RFID.WriteUserData(Reader ID [Long], EPC [String], User Data [String], Successful returned [Boolean])

Arguments

Reader ID

Long

EPC

String

User Data

String

Successful returned

Boolean

Examples

Remarks


Function.Automation.ZIP.CheckPresence

This command returns a true value if the XZip.dll (in Plugins) is present, and is properly registered on the client machine.

Syntax

Function.Automation.ZIP.CheckPresence(Boolean Return)

Arguments

None

Example

Remarks

None


Function.Automation.ZIP.UnZip

This command extracts files from a ZIP archive.

Syntax

Function.Automation.ZIP.UnZip(archive, target directory)

Function.Automation.ZIP.UnZip(archive, target directory, file)

Arguments

None

Example

Remarks

The archive and target directory are specified. Optionally, a file may be specified, if you do not want to extract the entire contents of the archive.


Function.Automation.ZIP.Zip

This command creates or adds files to a ZIP archive.

Syntax

Function.Automation.ZIP.ZIP(source file(s), target file)

Function.Automation.ZIP.ZIP(source file(s), target file, target path)

Arguments

None

Example

Remarks

  • Source files can be specified individually, or with wildcards (* or ?). Optionally, a target path may be specified to create multi-directory archives.


Function.Automation.ZIP.ZipContents

This command lists the contents of a specified ZIP archive, in a string return variable. The return is a double-delimited string, with a *!* delimiter between returned files, and a | delimiter between the path and filename components.

Syntax

Function.Automation.ZIP.ZIPContents(archive, string ret)

Arguments

None

Example

Remarks

The return string can be easily parsed with the Function.Instrinsic.String.Split command.


Function.Automation.ZIPPro.Abort

Syntax

Function.Automation.ZIPPro.Abort()

Arguments

Examples

Remarks


Function.Automation.ZIPPro.AppendFiles

Syntax

Function.Automation.ZIPPro.AppendFiles()

Arguments

Examples

Remarks


Function.Automation.ZIPPro.Compress

Syntax

Function.Automation.ZIPPro.Compress()

Arguments

Examples

Remarks


Function.Automation.ZIPPro.Delete

Syntax

Function.Automation.ZIPPro.Delete(filenames)

Arguments

filenames

Examples

Remarks


Function.Automation.ZIPPro.Extract

Syntax

Function.Automation.ZIPPro.Extract(filenames)

Arguments

filenames

Examples

Remarks


Function.Automation.ZIPPro.ExtractAll

Syntax

Function.Automation.ZIPPro.ExtractAll()

Arguments

Examples

Remarks


Function.Automation.ZIPPro.IncludeFiles

Syntax

Function.Automation.ZIPPro.IncludeFiles(filenames)

Arguments

filenames

Examples

Remarks


Function.Automation.ZIPPro.ReadProperty

Syntax

Function.Automation.ZIPPro.ReadProperty(requested property, file index, return value)

Arguments

requested property
file index
return value

Examples

Remarks


Function.Automation.ZIPPro.Reset

Syntax

Function.Automation.ZIPPro.Reset()

Arguments

Examples

Remarks


Function.Automation.ZIPPro.Scan

Syntax

Function.Automation.ZIPPro.Scan()

Arguments

Examples

Remarks


Function.Automation.ZIPPro.SetProperty

Syntax

Function.Automation.ZIPPro.SetProperty(property, file index, value)

Arguments

property
file index
value

Examples

Remarks


Function.Automation.ZIPPro.Update

Syntax

Function.Automation.ZIPPro.Update()

Arguments

Examples

Remarks