Function.Communication.General

From GAB Help
Jump to: navigation, search

Available commands

Contents

Function.Communication.CALDAV.AddCookie

Syntax

Function.Communication.CALDAV.AddCookie(CookieName [String], CookieValue [String])

Arguments

CookieName

String

CookieValue

String

Examples

Remarks


Function.Communication.CALDAV.AddCustomProperty

Syntax

Function.Communication.CALDAV.AddCustomProperty(VarName [String], VarValue [String])

Arguments

VarName

String

VarValue

String

Examples

Remarks


Function.Communication.CALDAV.Config

Syntax

Function.Communication.CALDAV.Config(ConfigurationString [String], Return [string])

Arguments

ConfigurationString

String

Return

string

Examples

Remarks


Function.Communication.CALDAV.CopyCalendarEvent

Syntax

Function.Communication.CALDAV.CopyCalendarEvent(SourceResourceURI [String], DestinationResourceURI [String])

Function.Communication.CALDAV.CopyCalendarEvent(SourceResourceURI [String], DestinationResourceURI [String])

Arguments

SourceResourceURI

String

DestinationResourceURI

String

Examples

Remarks


Function.Communication.CALDAV.CreateCalendar

Syntax

Function.Communication.CALDAV.CreateCalendar (ResourceURI [String])

Arguments

ResourceURI

String

Examples

Remarks


Function.Communication.CALDAV.DeleteCalendarEvent

Syntax

Function.Communication.CALDAV.DeleteCalendarEvent(ResourceURI [String])

Arguments

ResourceURI

String

Examples

Remarks


Function.Communication.CALDAV.DoEvents

Syntax

Function.Communication.CALDAV.DoEvents()

Arguments

Examples

Remarks


Function.Communication.CALDAV.ExportICS

Syntax

Function.Communication.CALDAV.ExportICS(Return [string])

Arguments

Return

string

Examples

Remarks


Function.Communication.CALDAV.GetCalendarEvent

Syntax

Function.Communication.CALDAV.GetCalendarEvent(ResourceURI [String])

Arguments

ResourceURI

String

Examples

Remarks


Function.Communication.CALDAV.GetCalendarOptions

Syntax

Function.Communication.CALDAV.GetCalendarOptions(ResourceURI [String])

Arguments

ResourceURI

String

Examples

Remarks


Function.Communication.CALDAV.GetCalendarReport

Syntax

Function.Communication.CALDAV.GetCalendarReport(ResourceURI [String])

Arguments

ResourceURI

String

Examples

Remarks


Function.Communication.CALDAV.GetFreeBusyReport

Syntax

Function.Communication.CALDAV.GetFreeBusyReport(ResourceURI [String])

Arguments

ResourceURI

String

Examples

Remarks


Function.Communication.CALDAV.ImportICS

Syntax

Function.Communication.CALDAV.ImportICS()

Arguments

Examples

Remarks


Function.Communication.CALDAV.Interrupt

Syntax

Function.Communication.CALDAV.Interrupt()

Arguments

Examples

Remarks


Function.Communication.CALDAV.LockCalendar

Syntax

Function.Communication.CALDAV.LockCalendar(ResourceURI [String])

Arguments

ResourceURI

String

Examples

Remarks


Function.Communication.Caldav.MoveCalendarEvent

Function.Communication.CALDAV.MoveCalendarEvent

Syntax

Arguments

Examples

Remarks


Function.Communication.CALDAV.PutCalendarEvent

Syntax

Function.Communication.CALDAV.PutCalendarEvent(ResourceURI [String])

Arguments

ResourceURI

String

Examples

Remarks


Function.Communication.CALDAV.ReadProperty

Syntax

Function.Communication.CALDAV.ReadProperty (PropertyName [string], sReturn [string])

Function.Communication.CALDAV.ReadProperty (PropertyName [string], sReturn)

Arguments

PropertyName

string

sReturn

Examples

Remarks


Function.Communication.CALDAV.Reset

Syntax

Function.Communication.CALDAV.Reset()

Arguments

Examples

Remarks


Function.Communication.CALDAV.SetProperty

Syntax

Function.Communication.CALDAV.SetProperty (PropertyName [string], PropertyValue [string])

Arguments

PropertyName

string

PropertyValue

string

Examples

Remarks


Function.Communication.CALDAV.UnlockCalendar

Syntax

Function.Communication.CALDAV.UnlockCalendar(ResourceURI [String])

Arguments

ResourceURI

String

Examples

Remarks


Function.Communication.Email.ResolveMX

This command queries the client's DNS server for MX records that serve the passed email address.

Syntax

Function.Communication.Email.ResolveMX(email address, return)

Arguments

None

Example

Remarks

  • The return is a string value that contains the hostname of the top priority MX record, the IP address, and the raw return, separated with *!*s. The raw return is a double delimited string, with each server entry delimited with a colon. Within each server entry, the hostname and precedence are delimited with a comma.
  • The status of the command can be checked (after the function call) with Variable.Ambient.MXResponse.


Function.Communication.FTP.Abort

Abort Current Upload/Download.

Syntax

Function.Communication.FTP.Abort

Arguments

None


Example

Remarks

  • This method sends an ABOR command to the FTP server. It is used to interrupt file uploads/downloads.


Function.Communication.FTP.Append

Adds to the file on the server i.e. a log file. It is the same as opening a file for append. Append data from LocalFile to a RemoteFile on an FTP server.

Syntax

Function.Communication.FTP.Append

Arguments

None

Example

Remarks

  • This method causes the server-DTP to accept the data transferred via the data connection and to store the data in a file on the server site. If the file specified in the pathname exists on the server site, then the data shall be appended to that file; otherwise the file specified in the pathname shall be created on the server site. Similar to the Upload method but the local file specified by LocalFile is appended to RemoteFile on the server as opposed to replacing it as done by the Upload method. RemoteFile is either an absolute path on the server, or a path relative to RemotePath. The server will create a file with that name if it doesn't already exist (similar to Upload). If there is no FTP session in place, one is automatically created by first calling the Logon method.


Function.Communication.FTP.Command

Used to send additional commands directly to the server.

Syntax

Function.Communication.FTP.Command(Command)

Arguments

Command

as String

Example

Function.Communication.FTP.Command(“smnt”)

Remarks

  • This property can be used to send additional commands directly to the server. Check the LastReply property and/or trap the PITrail events coming from the server to get the response.


Function.Communication.FTP.DeleteFile

Remove a file specified by FileName from an FTP server.

Syntax

Function.Communication.FTP.DeleteFile(FileName)

Arguments

FileName

This is just the file name the path is set in the Set Properties function.

Example

Function.Communication.FTP.DeleteFile(“Save.txt”)

Remarks

  • This method is used to remove a file specified by FileName from an FTP server. The remote file or directory specified by FileName is deleted. FileName is either an absolute path on the server, or a path relative to RemotePath. If there is no FTP session in place, one is automatically created by first calling the Logon method.


Function.Communication.FTP.Download

Download a RemoteFile from an FTP server.

Syntax

Function.Communication.FTP.Download

Arguments

None

Example


Remarks

  • This method is used to download the remote file specified by RemoteFile to the local file specified by LocalFile, or it is retrieved through the Transfer event if the LocalFile property is "" (empty string). RemoteFile is either an absolute path on the server, or a path relative to RemotePath. If there is no FTP session in place, one is automatically created by first calling the Logon method.


Function.Communication.FTP.Interrupt

Interrupt the current method.

Syntax

Function.Communication.FTP.Interrupt

Arguments

None

Example


Remarks

  • If there is no method in progress, Interrupt simply returns, doing nothing.


Function.Communication.FTP.ListDirectory

List the current directory specified by RemotePath on an FTP server.

Syntax

Function.Communication.FTP.ListDirectory

Arguments

None

Example


Remarks

  • This method is used to list the directory (or file mask) specified in RemoteFile. RemoteFile is either an absolute path on the server, or a path relative to RemotePath. The file listing is received through the DirList event.
  • Similar to ListDirectoryLong, except only file names are returned.
  • Note that since RemoteFile acts as a file mask, to retrieve a complete directory listing RemoteFile should be set to empty string or a mask like "*". If there is no FTP session in place, one is automatically created by first calling the Logon method.


Function.Communication.FTP.ListDirectoryLong

Syntax

Function.Communication.FTP.ListDirectoryLong

Arguments

None

Example


Remarks

  • This will show the Directory Files plus file size, and file date/time.


Function.Communication.FTP.Logoff

Syntax

Function.Communication.FTP.Logoff

Arguments

None

Example

Remarks

None


Function.Communication.FTP.Logon

This Function must occur after the properties are set.

Syntax

Function.Communication.FTP.Logon

Arguments

None

Example

Remarks

None


Function.Communication.FTP.MakeDirectory

Syntax

Function.Communication.FTP.MakeDirectory(Directory Name)

Arguments

Directory Name

Path for Directory to create

Example

Function.Communication.FTP.MakeDirectory(“C:\TestDocs”)

Remarks


Function.Communication.FTP.ReadProperty

Syntax

Function.Communciation.FTP.ReadProperty(Property Name, Return Value)

Arguments

Property Name

Valid Properties are Connected, FileSize, FileTime, Idle, and LastReply

Return Value

In same order as property: Boolean, long, Date, Boolean, Date

Example

Function.Communciation.FTP.ReadProperty(Property Name, Return Value)

Remarks


Function.Communication.FTP.RemoveDirectory

Syntax

Function.Communication.FTP.RemoveDirectory(Directory Name)

Arguments

Directory Name

Fully Qualified Path for the Directory

Example

Remarks

None


Function.Communication.FTP.RenameFile

Syntax

Function.Communication.FTP.RenameFile(Target Name)

Arguments

Target Name

This is the file’s new name

Example

Function.Communication.FTP.RenameFile(“SaveFile.txt”)

Remarks

None


Function.Communication.FTP.SetProperty

Syntax

Function.Communication.FTP.SetProperty(Property Name, Value)

Arguments

Property Name

Valid Properties are Account, FirewallHost, FirewallPassword, FirewallPort, FirewallType, FirewallUser, LocalFile, Overwrite, Passive, Password, RemoteFile, RemoteHost, RemotePath, RemotePort, StartByte, Timeout, TransferMode, User

Value

Variable or value for the type of Property

Example

Function.Communication.FTP.SetProperty(“LocalFile”, “Save.txt”)

Remarks

  • This must be completed before the FTP can begin. Each property gets it’s own line in the program.


Function.Communication.FTP.StoreUnique

Stores saved file as a unique name, for example Save.txt will become Save1.txt on the next save.

Syntax

Function.Communication.FTP.StoreUnique

Arguments

None

Example

Remarks

None


Function.Communication.FTP.Upload

Uploads a file to the set destination on the host machine

Syntax

Function.Communication.FTP.Upload

Arguments

None

Example

Remarks

None


Function.Communication.FTPS.Abort

Function.Communication.FTPS.Abort

Syntax

Arguments

Examples

Remarks


Function.Communication.FTPS.Append

Function.Communication.FTPS.Append

Syntax

Arguments

Examples

Remarks


Function.Communication.FTPS.Command

Function.Communication.FTPS.Command

Syntax

Arguments

Examples

Remarks


Function.Communication.FTPS.DeleteFile

Function.Communication.FTPS.DeleteFile

Syntax

Arguments

Examples

Remarks


Function.Communication.FTPS.Download

Function.Communication.FTPS.Download

Syntax

Arguments

Examples

Remarks


Function.Communication.FTPS.Interrupt

Function.Communication.FTPS.Interrupt

Syntax

Arguments

Examples

Remarks


Function.Communication.FTPS.ListDirectory

Function.Communication.FTPS.ListDirectory

Syntax

Arguments

Examples

Remarks


Function.Communication.FTPS.ListDirectoryLONG

Function.Communication.FTPS.ListDirectoryLONG

Syntax

Arguments

Examples

Remarks


Function.Communication.FTPS.LogOff

Function.Communication.FTPS.LogOff

Syntax

Arguments

Examples

Remarks


Function.Communication.FTPS.LogOn

Function.Communication.FTPS.LogOn

Syntax

Arguments

Examples

Remarks


Function.Communication.FTPS.MakeDirectory

Function.Communication.FTPS.MakeDirectory

Syntax

Arguments

Examples

Remarks


Function.Communication.FTPS.ReadProperty

Function.Communication.FTPS.ReadProperty

Syntax

Arguments

Examples

Remarks


Function.Communication.FTPS.RemoveDirectory

Function.Communication.FTPS.RemoveDirectory

Syntax

Arguments

Examples

Remarks


Function.Communication.FTPS.RenameFile

Function.Communication.FTPS.RenameFile

Syntax

Arguments

Examples

Remarks


Function.Communication.FTPS.SetProperty

Function.Communication.FTPS.SetProperty

Syntax

Arguments

Examples

Remarks


Function.Communication.FTPS.StoreUnique

Function.Communication.FTPS.StoreUnique

Syntax

Arguments

Examples

Remarks


Function.Communication.FTPS.Upload

Function.Communication.FTPS.Upload

Syntax

Arguments

Examples

Remarks


Function.Communication.HTTP.AddCookie

Syntax

Function.Communication.HTTP.AddCookie(Name, Value)

Arguments

Name

String Value or Variable for the name of the Cookie

Value

String Value or Variable for the value of the cookie

Example

Function.Communctication.HTTP.AddCookie(“CustNo”,”GLO010”)


Remarks

None


Function.Communication.HTTP.DoEvents

Syntax

Function.Communication.HTTP.DoEvents

Arguments

None

Example

Function.Communctication.HTTP.DoEvents

Remarks

None


Function.Communication.HTTP.DownloadFile

Syntax

Function.Communication.HTTP.DownloadFile(URL, FQ filename)

Arguments

URL
FQ filename

Examples

Remarks


Function.Communication.HTTP.Get

Syntax

Function.Communication.HTTP.Get(URL)

Arguments

URL

URL String Value or Variable of the URL

Example

Function.Communctication.HTTP.Get(“www.gss-service.com”)

Remarks

None


Function.Communication.HTTP.Head

Syntax

Function.Communication.HTTP.Head(URL)

Arguments

URL

URL String Value or Variable of the URL

Example

Function.Communctication.HTTP.Head(“www.gss-service.com”)

Remarks

None


Function.Communication.HTTP.Interrupt

Syntax

Function.Communication.HTTP.Interrupt

Arguments

None

Example

Function.Communctication.HTTP.Interrupt

Remarks

None


Function.Communication.HTTP.Post

Syntax

Function.Communication.HTTP.Post(URL)

Arguments

URL

URL String Value or Variable of the URL

Example

Function.Communctication.HTTP.Post(“www.gss-service.com”)

Remarks

None


Function.Communication.HTTP.Put

Syntax

Function.Communication.HTTP.Put(URL)

Arguments

URL

URL String Value or Variable of the URL

Example

Function.Communctication.HTTP.Put(“www.gss-service.com”)

Remarks

None


Function.Communication.HTTP.ReadProperty

Syntax

Function.Communication.HTTP.ReadProperty(Name, Return)

Arguments

Name

Accepted Values are Connected, Idle, StatusLine, TransferredData, and TransferredHeaders

Return

Return Variable for the Named Arg

Example

Function.Communctication.HTTP.ReadProperty(“Idle”, Variable.Local.bRet)

Remarks

None


Function.Communication.HTTP.ResetHeaders

Syntax

Function.Communication.HTTP.ResetHeaders

Arguments

None

Example

Remarks

None


Function.Communication.HTTP.SetProperty

Syntax

Function.Communication.HTTP.SetProperty(Name, Return)

Arguments

Name

Accepted Values are Accept, AttachedFile, AuthScheme, Authorization, ContentType,FirewallHost, FirewallPassword, FirewallType, FirewallUser, FollowRedirects, From,HTTPMethod, LocalFile, OtherHeaders, Password, PostData, Pragma, ProxyAuth,ProxyPassword, ProxyPort, ProxyServer, ProxyUser, Referrer, TimeOut, URL, URLPath,URLPort, URLScheme, URLServer, USER

Return

Return Variable for the Named Arg

Example

Function.Communctication.HTTP.SetProperty(“ProxyPassword”, Variable.Local.sRet)

Remarks

  • The Example will return the Proxy Password.


Function.Communication.HTTP.WebRequest

This function returns a string response generated by navigating to the passed URL. The URL may contain HTTP GET parameters, but special characters must be URL-encoded.

Syntax

Function.Communication.HTTP.WebRequest(URL [string], return [String])

Arguments

URL

string

Return

string

Examples

Program.Sub.main.Start
 v.lo.sret.declare

 f.communication.http.webrequest("http://www.delish.com/cooking/recipe-ideas/recipes/a49692/twix-bars-recipe/",v.lo.sret)
 F.Intrinsic.UI.Msgbox(V.lo.sret)
Program.Sub.Main.End 

Remarks


Function.Communication.HTTPS.AddCookie

Function.Communication.HTTPS.AddCookie

Syntax

Arguments

Examples

Remarks


Function.Communication.HTTPS.DoEvents

Function.Communication.HTTPS.DoEvents

Syntax

Arguments

Examples

Remarks


Function.Communication.HTTPS.DownloadFile

Function.Communication.HTTPS.DownloadFile

Syntax

Arguments

Examples

Remarks


Function.Communication.HTTPS.Get

Function.Communication.HTTPS.Get

Syntax

Arguments

Examples

Remarks


Function.Communication.HTTPS.Head

Function.Communication.HTTPS.Head

Syntax

Arguments

Examples

Remarks


Function.Communication.HTTPS.Interrupt

Function.Communication.HTTPS.Interrupt

Syntax

Arguments

Examples

Remarks


Function.Communication.HTTPS.Post

Function.Communication.HTTPS.Post

Syntax

Arguments

Examples

Remarks


Function.Communication.HTTPS.Put

Function.Communication.HTTPS.Put

Syntax

Arguments

Examples

Remarks


Function.Communication.HTTPS.ReadProperty

Function.Communication.HTTPS.ReadProperty

Syntax

Arguments

Examples

Remarks


Function.Communication.HTTPS.ResetHeaders

Function.Communication.HTTPS.ResetHeaders

Syntax

Arguments

Examples

Remarks


Function.Communication.HTTPS.SetProperty

Function.Communication.HTTPS.SetProperty

Syntax

Arguments

Examples

Remarks


Function.Communication.HTTPS.WedRequest

Function.Communication.HTTPS.WedRequest

Syntax

Arguments

Examples

Remarks


Function.Communication.JSON. ParseFile

Syntax

Function.Communication.JSON. ParseFile (FileName [String])

Arguments

FileName

String

Examples

Remarks


Function.Communication.JSON.AddCookie

Syntax

Function.Communication.JSON.AddCookie(CookieName [String], CookieValue [String])

Arguments

CookieName

String

CookieValue

String

Examples

Remarks


Function.Communication.JSON.Config

Syntax

Function.Communication.JSON.Config(ConfigurationString [String], Return [string])

Arguments

ConfigurationString

String

Return

string

Examples

Remarks


Function.Communication.JSON.Delete

Syntax

Function.Communication.JSON.Delete(URL [string])

Arguments

URL

string

Examples

Remarks


Function.Communication.JSON.DoEvents

Syntax

Function.Communication.JSON.DoEvents()

Arguments

Examples

Remarks


Function.Communication.JSON.Get

Syntax

Function.Communication.JSON.Get(URL [string])

Arguments

URL

string

Examples

Remarks


Function.Communication.JSON.HasXPath

Syntax

Function.Communication.JSON.HasXPath (XPath [String], Return [Boolean])

Arguments

XPath

String

Return

Boolean

Examples

Remarks


Function.Communication.JSON.Input

Syntax

Function.Communication.JSON.Input (Text [string])

Arguments

Text

string

Examples

Remarks


Function.Communication.JSON.Interrupt

Syntax

Function.Communication.JSON.Interrupt()

Arguments

Examples

Remarks


Function.Communication.JSON.ParseFile

Function.Communication.JSON.ParseFile

Syntax

Arguments

Examples

Remarks


Function.Communication.JSON.Post

Syntax

Function.Communication.JSON.Post (URl [string])

Arguments

URl

string

Examples

Remarks


Function.Communication.JSON.Put

Syntax

Function.Communication.JSON.Put (URL [string])

Arguments

URL

string

Examples

Remarks


Function.Communication.JSON.ReadProperty

Syntax

Function.Communication.JSON.ReadProperty(PropertyName [string], Return [String])

Arguments

PropertyName

string

Return

String

Examples

Remarks

  • Property names:
  1. ACCEPT
  2. AUTHORIZATION
  3. AUTHSCHEME
  4. BUILDDOM
  5. CONNECTED
  6. CONTENTTYPE
  7. COOKIES
  8. FIREWALL
  9. FIREWALLAUTODETECT
  10. FIREWALLTYPE
  11. FIREWALLHOST
  12. FIREWALLPASSWORD
  13. FIREWALLPORT
  14. FIREWALLUSER
  15. FOLLOWREDIRECTS
  16. FROM
  17. HTTPMETHOD
  18. IDLE
  19. IFMODIFIEDSINCE
  20. LOCALFILE
  21. LOCALHOST
  22. OTHERHEADERS
  23. PARSEDHEADERS
  24. PASSWORD
  25. POSTDATA
  26. POSTDATAB
  27. PROXY
  28. PROXYAUTHSCHEME
  29. PROXYAUTODETECT
  30. PROXYPASSWORD
  31. PROXYPORT
  32. PROXYSERVER
  33. PROXYUSER
  34. REFERER
  35. STATUSLINE
  36. TIMEOUT
  37. TRANSFERREDDATA
  38. TRANSFERREDDATAB
  39. TRANSFERREDDATALIMIT
  40. TRANSFERREDHEADERS
  41. URL
  42. XCHILDREN
  43. XELEMENT
  44. XERRORPATH
  45. XPARENT
  46. XPATH
  47. XSUBTREE
  48. XTEXT


Function.Communication.JSON.Reset

Syntax

Function.Communication.JSON.Reset()

Arguments

Examples

Remarks


Function.Communication.JSON.SetProperty

Syntax

Function.Communication.JSON.SetProperty (PropertyName [string], PropertyValue [string])

Arguments

PropertyName

string

PropertyValue

string

Examples

Remarks

  • Property names:
  1. ACCEPT
  2. AUTHORIZATION
  3. AUTHSCHEME
  4. BUILDDOM
  5. CONNECTED
  6. CONTENTTYPE
  7. FIREWALLAUTODETECT
  8. FIREWALLHOST
  9. FIREWALLPASSWORD
  10. FIREWALLPORT
  11. FIREWALLTYPE
  12. FIREWALLUSER
  13. FOLLOWREDIRECTS
  14. FROM
  15. HTTPMETHOD
  16. IFMODIFIEDSINCE
  17. LOCALFILE
  18. LOCALHOST
  19. OTHERHEADERS
  20. PASSWORD
  21. POSTDATA
  22. POSTDATAB
  23. PROXYAUTHSCHEME
  24. PROXYAUTODETECT
  25. PROXYPASSWORD
  26. PROXYPORT
  27. PROXYSERVER
  28. PROXYUSER
  29. REFERER
  30. TIMEOUT
  31. TRANSFERREDDATA
  32. TRANSFERREDDATAB
  33. TRANSFERREDDATALIMIT
  34. URL
  35. USER
  36. XERRORPATH
  37. XPATH


Function.Communication.Misc.DecodeToFile

This command reads an encoded source file, and decodes it to a specified filename.

Syntax

Function.Communication.Misc.DecodeToFile(mode, source file, target file)

Arguments

Mode

0. UUEncode: The most popular standard. 3 Bytes are encoded into 4 readable characters

1. Base64: Encoding format of MIME. Much like UUEncode but another subset of printable characters is used

2. QP

3. URL: Encoding of non-printable, 8-bit or unsafe characters as defined in RFC 1738

4. JIS: Japanese Industrial Standards encoding of Japanese character sets

5. YEncode: Similar to Base64, but uses 8-bit encoding to reduce the amount of data being sent and received. Designed for binaries on the Usenet or Email

6. MD5Hash: The Message Digest 5 hashing algorithm produces a 128-bit hash output

7. SHA1Hash: The Secure Hash Algorithm produces a 128-bit hash output

8. Hex: Creates a hexadecimal string representation of the decoded data

Example

Remarks

  • If the target file already exists, it will be overwritten


Function.Communication.Misc.DecodeToString

This function decodes a passed string to a returned string value.

Syntax

Function.Communication.Misc.DecodeToString(mode, string in, string return)

Arguments

Mode

0. UUEncode: The most popular standard. 3 Bytes are encoded into 4 readable characters

1. Base64: Encoding format of MIME. Much like UUEncode but another subset of printable characters is used

2. QP

3. URL: Encoding of non-printable, 8-bit or unsafe characters as defined in RFC 1738

4. JIS: Japanese Industrial Standards encoding of Japanese character sets

5. YEncode: Similar to Base64, but uses 8-bit encoding to reduce the amount of data being sent and received. Designed for binaries on the Usenet or Email

6. MD5Hash: The Message Digest 5 hashing algorithm produces a 128-bit hash output

7. SHA1Hash: The Secure Hash Algorithm produces a 128-bit hash output

8. Hex: Creates a hexadecimal string representation of the decoded data

Example

Remarks

None


Function.Communication.Misc.EncodeToFile

This command reads an source file, and encodes it to a specified filename.

Syntax

Function.Communication.Misc.EncodeToFile(mode, source file, target file)

Arguments

Mode

0. UUEncode: The most popular standard. 3 Bytes are encoded into 4 readable characters

1. Base64: Encoding format of MIME. Much like UUEncode but another subset of printable characters is used

2. QP

3. URL: Encoding of non-printable, 8-bit or unsafe characters as defined in RFC 1738

4. JIS: Japanese Industrial Standards encoding of Japanese character sets

5. YEncode: Similar to Base64, but uses 8-bit encoding to reduce the amount of data being sent and received. Designed for binaries on the Usenet or Email

6. MD5Hash: The Message Digest 5 hashing algorithm produces a 128-bit hash output

7. SHA1Hash: The Secure Hash Algorithm produces a 128-bit hash output

8. Hex: Creates a hexadecimal string representation of the decoded data

Example

Remarks

  • If the target file already exists, it will be overwritten


Function.Communication.Misc.EncodeToString

This function encodes a passed string to a returned string value.

Syntax

Function.Communication.Misc.EncodeToString(Mode, String in, String return)

Arguments

Mode

0. UUEncode: The most popular standard. 3 Bytes are encoded into 4 readable characters

1. Base64: Encoding format of MIME. Much like UUEncode but another subset of printable characters is used

2. QP

3. URL: Encoding of non-printable, 8-bit or unsafe characters as defined in RFC 1738

4. JIS: Japanese Industrial Standards encoding of Japanese character sets

5. YEncode: Similar to Base64, but uses 8-bit encoding to reduce the amount of data being sent and received. Designed for binaries on the Usenet or Email

6. MD5Hash: The Message Digest 5 hashing algorithm produces a 128-bit hash output

7. SHA1Hash: The Secure Hash Algorithm produces a 128-bit hash output

8. Hex: Creates a hexadecimal string representation of the decoded data

Example

Remarks


Function.Communication.Misc.SetCodingParameter

This function sets encoding/decoding parameters related to the Function.Communication.Misc namespace.

Syntax

Function.Communication.Misc.SetCodingParameter(parameter, value)

Arguments

parameter
value

Examples

Remarks


Function.Communication.NetWork.AuthenticateUser

Syntax

Function.Communication.Network.AuthenticateUser(UserName, Password, Domain, Return Variable)

Arguments

UserName

String

Password

String

Domain

String

Return Variable

Boolean

Example

Function.Communication.Network.AuthenticateUser(variable.local.sUser, variable.local.sPass, variable.system.UserDomain, variable.local.bRet)

Remarks

  • If you want, you can hardcode the domain, or you can use Variable.System.UserDomain.


Function.Communication.NetWork.GetAuxUserInfo

Syntax

Function.Communication.Network.GetAuxUserInfo(info,ret var) or (info, User, Return Variable)

Arguments

Info

COMMENT, FULLNAME, HOMEDIR, LGONSERVER, SCRIPTPATH, USERCOMMENT

User

String with Users name

Return Variable

String Variable returning in User Info

Example

Function.Communication.Network.GetAuxUserInfo(“COMMENT”, Variable.local.sRet)

Remarks

None


Function.Communication.NetWork.GetHostNameFromip

This function returns the hostname of a computer, given its IP address.

Syntax

Communication.Network.GetHostNameFromIP(IP address, string return)

Arguments

Examples


Remarks


Function.Communication.Network.GetHostNameFromIP

Syntax

Function.Communication.Network.GetHostNameFromIP(IP address, string return)

Arguments

IP address
string return

Examples

Remarks


Function.Communication.NetWork.GetIPFromHostName

This function returns the IP address of a computer, given its host name.

Syntax

Communication.Network.GetIPFromHostName(host name, string return)

Arguments

Examples

Remarks


Function.Communication.Network.GetIPFromHostName

This function returns the IP address of a computer, given its host name.

Syntax

Function.Communication.Network.GetIPFromHostName(host name, string return)

Arguments

host name
string return

Examples

Remarks


Function.Communication.NetWork.GetThreadUser

Syntax

Function.Communication.Network.GetThreadUser(Return Variable)

Arguments

Return Variable

String

Example

Function.Communication.Network.GetThreadUser (Variable.Local.sReturn)

Remarks

None


Function.Communication.NetWork.GetTime

This function returns current time and date of the Global Shop database server.

Syntax

Function.Communication.Network.GetTime(Source Machine, Return Variable) or

Function.Communication.Network.GetTime(date/time return)

Arguments

Source Machine - Machine Name

Return Variable

Date Variable

Example

Function.Communication.Network.GetTime(“Blah”, variable.local.dReturn)

Remarks

None


Function.Communication.NetWork.IPDAcceptData

Turns on or off the IPD's ability to accept data

Syntax

Function.Communication.Network.IPDACCEPTDATA(Index, Connection ID, Boolean)

Arguments

Index

Long (0-3)

Connection ID

Long

Boolean

True to turn on/False to turn off

Example


Remarks

None


Function.Communication.NetWork.IPDDisconnect

Closes an open IPD connection by Index and Connection ID

Syntax

Function.Communication.Network.IPDDISCONNECT(Index, Connection ID)

Arguments

Index

Long (0-3)

Connection ID

Long

Example


Remarks

None


Function.Communication.NetWork.IPDReadProperty

Reads properties off of IPD object given the index and properties

Syntax

Function.Communication.Network.IPDREADPROPERTY(Index, Connection ID, Property, Return Variant)

Arguments

Index

Long (0-3)

Connection

ID Long

Property

Valid Properties are Connected, ConnectionCount, BytesSent, Listening

Return Variant

Variant of String Data Type

Example


Remarks

None


Function.Communication.NetWork.IPDSendData

Syntax

Arguments

Example

Remarks


Function.Communication.NetWork.IPDSetEOL

Specifies how an IPD will recognize the end of a transmitted line

Syntax

Function.Communication.Network.IPDSETEOL(Index, Connection ID, EOL String)

Arguments

Index

Long (0-3)

Connection ID

Long

EOL String

String End Of Line

Example

'Denotes v.ambient.newLine as the end of a transmitted line
Function.Communication.Network.IPDSetEOL(0,10,v.ambient.newLine)

Remarks

None


Function.Communication.NetWork.IPDSetKA

Syntax

Function.Communication.Network.IPPSetKA(index, timeout)

Arguments

Example

Remarks


Function.Communication.NetWork.IPDSetLocalPort

Sets the TCP/IP port that the IPD is listening to

Syntax

Function.Communication.Network.IPDSetLocalPort(Index, Port)

Arguments

Index

Long (0-3)

Port

Long (1-65,536)

Example

Remarks

None


Function.Communication.NetWork.IPDShutdown

Description

Syntax

Arguments

Example

Remarks


Function.Communication.Network.IPPAcceptData

Turns on or off the IPP's ability to accept data

Syntax

Function.Communication.Network.IPPAcceptData(Index, Boolean)

Arguments

Index

Long (0-15)

Boolean

True to turn on/False to turn off

Example

Remarks

None


Function.Communication.Network.IPPConnect

Syntax

Function.Communication.Network.IPPConnect(index, host, port)

Arguments

Example

Remarks


Function.Communication.Network.IPPDisconnect

Syntax

Function.Communication.Network.IPPDisconnect(index)

Arguments

Example

Remarks


Function.Communication.Network.IPPReadProperty

Syntax

Function.Communication.Network.IPPReadProperty(index, prop, ret)

Arguments

Example

Remarks

  • Property values: "ACCEPTDATA","BYTESSENT","CONNECTED","REMOTEHOST","REMOTEPORT"


Function.Communication.Network.IPPSend

Syntax

Function.Communication.Network.IPPSend(index, data)

Arguments

Example

Remarks


Function.Communication.Network.IPPSendLine

Syntax

Function.Communication.Network.IPPSendLine(index, data)

Arguments

Example

Remarks


Function.Communication.Network.IPPSetEOL

Syntax

Function.Communication.Network.IPPSetEOL(index, host, port)

Arguments

Example

Remarks


Function.Communication.Network.IPPSetFirewall

Syntax

Function.Communication.Network.IPPSetFirewall(index, host, port, type, user, password)

Arguments

Example

Remarks


Function.Communication.Network.IPPSetKA

Syntax

Function.Communication.Network.IPPSetKA(index, timeout)

Arguments

Example

Remarks


Function.Communication.Network.IPPSetTimeout

Syntax

Arguments

Example

Remarks


Function.Communication.REST.AddCookie

Syntax

Function.Communication.REST.AddCookie(CookieName [String], CookieValue [String])

Arguments

CookieName

String

CookieValue

String

Examples

Remarks


Function.Communication.REST.Attr

Syntax

Function.Communication.REST.Attr(AttrName [String])

Arguments

AttrName

String

Examples

Remarks


Function.Communication.REST.Config

Syntax

Function.Communication.REST.Config (ConfigurationString [String], Return [string])

Arguments

ConfigurationString

String

Return

string

Examples

Remarks


Function.Communication.REST.Delete

Syntax

Function.Communication.REST.Delete(URL [String])

Arguments

URL

String

Examples

Remarks


Function.Communication.REST.DoEvents

Syntax

Function.Communication.REST.DoEvents()

Arguments

Examples

Remarks


Function.Communication.REST.Get

Syntax

Function.Communication.REST.Get (URL [String])

Arguments

URL

String

Examples

Remarks


Function.Communication.REST.HasXPath

Syntax

Function.Communication.REST.HasXPath(XPath [String], Return [Boolean])

Arguments

XPath

String

Return

Boolean

Examples

Remarks


Function.Communication.REST.Interrupt

Syntax

Function.Communication.REST.Interrupt()

Arguments

Examples

Remarks


Function.Communication.REST.Post

Syntax

Function.Communication.REST.Post (URL [String])

Arguments

URL

String

Examples

Remarks


Function.Communication.REST.Put

Syntax

Function.Communication.REST.Put(URL [String])

Arguments

URL

String

Examples

Remarks


Function.Communication.REST.ReadProperty

Syntax

Function.Communication.REST.ReadProperty(PropertyName [string], Return [String])

Arguments

PropertyName

string

Return

String

Examples

Property

Available properties:

1. Accept A list of acceptable MIME types for the request.

2. Authorization The Authorization string to be sent to the server.

3. AuthScheme The authentication scheme to use when server authorization is required.

4. BuildDOM When True, an internal object model of the XML document is created.

5. Connected Shows whether the component is connected.

6. ContentType Content type for posts and puts.

7. Cookies Collection of cookies.

8. Firewall A set of properties related to firewall access: FIREWALLAUTODETECT, FIREWALLHOST, FIREWALLPASSWORD, FIREWALLPORT, FIREWALLTYPE, FIREWALLUSER.

9. FollowRedirects Determines what happens when the server issues a redirect.

10. From The email address of the HTTP agent (optional).

11. HTTPMethod The HTTP method used for the request.

12. Idle The current status of the component.

13. IfModifiedSince A date determining the maximum age of the desired document.

14. LocalFile The path to a local file for downloading. If the file exists, it is overwritten.

15. LocalHost The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

16. Namespaces A collection of namespaces in the current stack.

17. OtherHeaders Other headers as determined by the user (optional).

18. ParsedHeaders Collection of headers returned from the last request.

19. Password A password if authentication is to be used.

20. PostData The data to post with the URL if the POST method is used.

21. PostDataB

22. Proxy A set of properties related to proxy access: PROXYAUTHSCHEME, PROXYAUTODETECT, PROXYPASSWORD, PROXYPORT, PROXYSERVER, PROXYUSER.

23. Referer Referer URL/document (optional).

24. StatusLine The first line of the last server response.

25. Timeout A timeout for the component.

26. TransferredData The contents of the last response from the server.

27. TransferredDataB

28. TransferredDataLimit The maximum of bytes of data to be transferred.

29. TransferredHeaders The full set of headers as received from the server.

30. URL The URL to which information is posted.

31. User A user name if authentication is to be used.

32. Validate When True, the parser checks that the document consists of well-formed XML.

33. XAttributes A collection of attributes of the current element.

34. XChildren Collection of child elements of the current element.

35. XElement The name of the current element.

36. XErrorPath An XPath to check the server response for errors.

37. XNamespace The namespace of the current element.

38. XParent The parent of the current element.

39. XPath Provides a way to point to a specific element in the response.

40. XPrefix The prefix of the current element.

41. XSubTree A snapshot of the current element in the document.

42. XText The text of the current element.


Remarks


Function.Communication.REST.Reset

Syntax

Function.Communication.REST.Reset()

Arguments

Examples

Remarks


Function.Communication.REST.SetProperty

Syntax

Function.Communication.REST.SetProperty (PropertyName [string], PropertyValue [string])

Arguments

PropertyName

string

PropertyValue

string

Examples

Property

Available properties:

1. Accept A list of acceptable MIME types for the request.

2. Authorization The Authorization string to be sent to the server.

3. AuthScheme The authentication scheme to use when server authorization is required.

4. BuildDOM When True, an internal object model of the XML document is created.

5. Connected Shows whether the component is connected.

6. ContentType Content type for posts and puts.

7. Cookies Collection of cookies.

8. Firewall A set of properties related to firewall access: FIREWALLAUTODETECT, FIREWALLHOST, FIREWALLPASSWORD, FIREWALLPORT, FIREWALLTYPE, FIREWALLUSER.

9. FollowRedirects Determines what happens when the server issues a redirect.

10. From The email address of the HTTP agent (optional).

11. HTTPMethod The HTTP method used for the request.

12. IfModifiedSince A date determining the maximum age of the desired document.

13. LocalFile The path to a local file for downloading. If the file exists, it is overwritten.

14. LocalHost The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

15. OtherHeaders Other headers as determined by the user (optional).

16. Password A password if authentication is to be used.

17. PostData The data to post with the URL if the POST method is used.

18. PostDataB

19. Proxy A set of properties related to proxy access: PROXYAUTHSCHEME, PROXYAUTODETECT, PROXYPASSWORD, PROXYPORT, PROXYSERVER, PROXYUSER.

20. Referer Referer URL/document (optional).

21. Timeout A timeout for the component.

22. TransferredDataLimit The maximum of bytes of data to be transferred.

23. URL The URL to which information is posted.

24. User A user name if authentication is to be used.

25. Validate When True, the parser checks that the document consists of well-formed XML.

26. XErrorPath An XPath to check the server response for errors.

27. XPath Provides a way to point to a specific element in the response.


Remarks


Function.Communication.RSS.AddCookie

Syntax

Function.Communication.RSS.AddCookie(CookieName [String], CookieValue [String])

Arguments

CookieName

String

CookieValue

String

Examples

Remarks


Function.Communication.RSS.AddItem

Syntax

Function.Communication.RSS.AddItem(Title [String], Description [String], Link [String])

Arguments

Title

String

Description

String

Link

String

Examples

Remarks


Function.Communication.RSS.AddNamespace

Syntax

Function.Communication.RSS.AddNamespace (Prefix [String], NamespaceURI [String])

Arguments

Prefix

String

NamespaceURI

String

Examples

Remarks


Function.Communication.RSS.Config

Syntax

Function.Communication.RSS.Config(ConfigurationString [String], Return [string])

Arguments

ConfigurationString

String

Return

string

Examples

Remarks


Function.Communication.RSS.DoEvents

Syntax

Function.Communication.RSS.DoEvents()

Arguments

Examples

Remarks


Function.Communication.RSS.GetFeed

Syntax

Function.Communication.RSS.GetFeed (URL [String])

Arguments

URL

String

Examples

Remarks


Function.Communication.RSS.GetProperty

Syntax

Function.Communication.RSS.GetProperty(PropertyName [String], Return [string])

Arguments

PropertyName

String

Return

string

Examples

Remarks


Function.Communication.RSS.GetURL

Syntax

Function.Communication.RSS.GetURL (URL [String])

Arguments

URL

String

Examples

Remarks


Function.Communication.RSS.Interrupt

Syntax

Function.Communication.RSS.Interrupt()

Arguments

Examples

Remarks


Function.Communication.RSS.OPMLAttr

Syntax

Function.Communication.RSS.OPMLAttr(AttrName [String], Return [string])

Arguments

AttrName

String

Return

string

Examples

Remarks


Function.Communication.RSS.Put

Syntax

Function.Communication.RSS.Put(URL [String])

Arguments

URL

String

Examples

Remarks


Function.Communication.RSS.ReadFile

Syntax

Function.Communication.RSS.ReadFile (FileName [String])

Arguments

FileName

String

Examples

Remarks


Function.Communication.RSS.ReadOPML

Syntax

Function.Communication.RSS.ReadOPML(OPMLFile [String])

Arguments

OPMLFile

String

Examples

Remarks


Function.Communication.RSS.ReadProperty

Syntax

Function.Communication.RSS.ReadProperty(PropertyName [string], Return [String])

Arguments

PropertyName

string

Return

String

Examples

Remarks


Function.Communication.RSS.Reset

Syntax

Function.Communication.RSS.Reset()

Arguments

Examples

Remarks


Function.Communication.RSS.SetExtendedProperty

Syntax

Function.Communication.RSS.SetExtendedProperty(PropertyName [string], PropertyValue [string])

Function.Communication.RSS.SetExtendedProperty(PropertyName [string], PropertyValue [string])

Arguments

PropertyName

string

PropertyValue

string

Examples

Remarks


Function.Communication.RSS.SetProperty

Syntax

Function.Communication.RSS.SetProperty (PropertyName [string], PropertyValue [string])

Arguments

PropertyName

string

PropertyValue

string

Examples

Remarks


Function.Communication.RSS.WriteFile

Syntax

Function.Communication.RSS.WriteFile(FileName [string])

Function.Communication.RSS.WriteFile(FileName[string])

Arguments

FileName

string

Examples

Remarks


Function.Communication.Serial.DataWwaiting

Function.Communication.Serial.DataWwaiting

Syntax

Arguments

Examples

Remarks


Function.Communication.Serial.GetInput

Syntax

Arguments

Example


Remarks


Function.Communication.Serial.GetInputLen

Syntax

Function.Communication.serial.GetInputLen(Long Return)

Arguments

Long Return

Returns a long for the Get Input length

Example

Function.Communication.serial.GetInputLen(variable.local.iInput)

Remarks

None


Function.Communication.Serial.GetReturnBuffer

Function.Communication.Serial.GetReturnBuffer

Syntax

Arguments

Examples

Remarks


Function.Communication.Serial.OpenPort

Syntax

Function.Communication.serial.OpenPort(boolean)

Arguments

Boolean

Pass True if Comm port is open, false if it is closed

Example

Function.Communication.serial.OpenPort(True)

Remarks


Function.Communication.Serial.SendOutput

String Data passed through the serial port to a device on the other end, such as a scale, modem, led display screen, etc.

Syntax

Function.Communication.serial.SendOutput(string)

Arguments

String

Passes a string for Output

Example

Function.Communication.serial.SendOutput(variable.local.sOutput)

Remarks


Function.Communication.Serial.SendOutputAndReturn

Function.Communication.Serial.SendOutputAndReturn

Syntax

Arguments

Examples

Remarks


Function.Communication.Serial.SetCOMPort

Syntax

Function.Communication.Serial.SetCOMPort(long)

Arguments

Long - Passes a long for the Communication Port used

Example

Function.Communication.Serial.SetCOMPort(2)

Remarks

This is the numbered communication port used, must be between 1-4


Function.Communication.Serial.SetDTREnable

Data Terminal Ready – Enable

Syntax

Function.Communication.serial.SetDTREnable(Boolean)

Arguments

Boolean

True or False

Example

Function.Communication.serial.SetDTREnable(True)

Remarks

  • True enables DTR when serial port is open, disables port when serial port is closed
  • False (Default) always disables serial port


Function.Communication.Serial.SetEOFEnable

End Of File - Enable

Syntax

Function.Communication.serial.SetEOFEnable(boolean)

Arguments

Boolean

True or False

Example

Function.Communication.serial.SetEOFEnable(True)

Remarks

  • True sets off an event when the End of File character is found.
  • False never sets off an event whether the End of File character is found or not.


Function.Communication.Serial.SetHandshaking

Handshaking setting

Syntax

Function.Communication.serial.SetHandshakingl(long)

Arguments

Long

0 No Handshaking

1 Xon/Xoff Handshaking

2 RTS/CTS (Request to send/Clear to Send) handshaking

3 Both Request to send and Xon/Xoff handshaking

Example

Function.Communication.serial.SetHandshaking(1)

Remarks

None


Function.Communication.Serial.SetinBufferSize

Input Buffer Size

Syntax

Function.Communication.serial.SetInBufferSize(Long)

Arguments

Long

Number of bytes

Example

Function.Communication.serial.SetInBufferSize(1024)

Remarks

  • 1024 is the default amount
  • Total Size in Bytes of received buffer, this is not the number of characters


Function.Communication.Serial.SetInputLen

Number of Characters from Received Buffer

Syntax

Function.Communication.serial.SetInputLen(Long)

Arguments

Long

Number of Characters from the received buffer

Example

Function.Communication.serial.SetInputLen(0)

Remarks

  • The default value for the SetInputLen property is 0. Setting SetInputLen to 0 causes the MSComm control to read the entire contents of the receive buffer when Input is used.


Function.Communication.Serial.SetNullDiscard

Sets whether the buffer will be transferred with or without Null characters

Syntax

Function.Communication.serial.SetNullDiscard(Boolean)

Arguments

Boolean

True Null's not transferred, False Null's transferred

Example

Function.Communication.serial.SetINullDiscard(True)

Remarks

  • False is the Default


Function.Communication.Serial.SetoutBufferSize

Number of Characters from Transmit Buffer

Syntax

Function.Communication.serial.SetOutBufferSize(Long)

Arguments

Long

Number of Characters from the Transmit buffer

Example

Function.Communication.serial.SetOutBufferSize(512)

Remarks

  • SetOutBufferSize refers to the total size of the transmit buffer. The default size is 512 bytes. Do not confuse this property with the Output Buffer Count which reflects the number of bytes currently waiting in the transmit buffer.


Function.Communication.Serial.SetParameters

Sets and Returns the baud rate, parity, data bit, and stop bit parameters

Syntax

Function.Communication.serial.SetParamters(string)

Arguments

String

Delimited by comma's “BBBB, P, D,S”

Example

Function.Communication.serial.SetParamters(“9600,N,8,1”)

Remarks

  • If the parameter is not valid when the port is opened, the MSComm control generates error 380 (Invalid property value)
  • Another Baud rate used frequently is 19200, so the parameter would be “19200, N, 8, 1”

Baud Rates:

110

300

600

1200

2400

4800

9600

14400

19200

28800

38400

56000

57600

115200

128000

256000

Parity options are:

E Even

M Mark

N None (Default)

O Odd

S Space

Data bit Values:

4

5

6

7

8 Default

Stop bit values:

1 Default

1.5

2


Function.Communication.Serial.SetrThreshold

Sets and returns the number of characters to receive before the MSComm control sets the CommEvent property to comEvReceive and generates the OnComm event.

Syntax

Function.Communication.serial.SetRThreshold(long)

Arguments

Long

Number of characters

Example

Function.Communication.serial.SetRThreshold(1)

Remarks

  • Setting the RThreshold property to 0 (the default) disables generating the OnComm event when characters are received.
  • Setting RThreshold to 1, for example, causes the MSComm control to generate the OnComm event every time a single character is placed in the receive buffer.


Function.Communication.Serial.SetrtsEnable

Request to Send Enable

Syntax

Function.Communication.Serial.SetRTSEnable(boolean)

Arguments

Boolean

True enables RTS Line, False (Default)disables RTS Line

Example

Function.Communication.Serial.SetRTSEnable(True)

Remarks

  • When SetRTSEnable is set to True, the Request To Send line is set to high (on) when the port is opened, and low (off) when the port is closed.
  • The Request To Send line is used in RTS/CTS hardware handshaking. The SetRTSEnable property allows you to manually poll the Request To Send line if you need to determine its state.


Function.Communication.Serial.SetsThreshold

Sets and returns the minimum number of characters allowable in the transmit buffer before the MSComm control sets the CommEvent property to comEvSend and generates the OnComm event.

Syntax

Function.Communication.serial.SetSThreshold(long)

Arguments

Long

Number of characters

Example

Function.Communication.serial.SetSThreshold(1)

Remarks

  • Setting the SThreshold property to 0 (the default) disables generating the OnComm event for data transmission events. Setting the SThreshold property to 1 causes the MSComm control to generate the OnComm event when the transmit buffer is completely empty.
  • If the number of characters in the transmit buffer is less than value, the CommEvent property is set to comEvSend, and the OnComm event is generated. The comEvSend event is only fired once, when the number of characters crosses the SThreshold. For example, if SThreshold equals five, the comEvSend event occurs only when the number of characters drops from five to four in the output queue. If there are never more than SThreshold characters in the output queue, the event is never fired.


Function.Communication.SFTP.Abort

Function.Communication.SFTP.Abort

Syntax

Arguments

Examples

Remarks


Function.Communication.SFTP.Append

Function.Communication.SFTP.Append

Syntax

Arguments

Examples

Remarks


Function.Communication.SFTP.Command

Function.Communication.SFTP.Command

Syntax

Arguments

Examples

Remarks


Function.Communication.SFTP.DeleteFile

Function.Communication.SFTP.DeleteFile

Syntax

Arguments

Examples

Remarks


Function.Communication.SFTP.Download

Function.Communication.SFTP.Download

Syntax

Arguments

Examples

Remarks


Function.Communication.SFTP.Interrupt

Function.Communication.SFTP.Interrupt

Syntax

Arguments

Examples

Remarks


Function.Communication.SFTP.ListDirectory

Function.Communication.SFTP.ListDirectory

Syntax

Arguments

Examples

Remarks


Function.Communication.SFTP.ListDirectoryLong

Function.Communication.SFTP.ListDirectoryLong

Syntax

Arguments

Examples

Remarks


Function.Communication.SFTP.LogOff

Function.Communication.SFTP.LogOff

Syntax

Arguments

Examples

Remarks


Function.Communication.SFTP.LogOn

Function.Communication.SFTP.LogOn

Syntax

Arguments

Examples

Remarks


Function.Communication.SFTP.MakeDirectory

Function.Communication.SFTP.MakeDirectory

Syntax

Arguments

Examples

Remarks


Function.Communication.SFTP.ReadProperty

Function.Communication.SFTP.ReadProperty

Syntax

Arguments

Examples

Remarks


Function.Communication.SFTP.RemoveDirectory

Function.Communication.SFTP.RemoveDirectory

Syntax

Arguments

Examples

Remarks


Function.Communication.SFTP.RenameFile

Function.Communication.SFTP.RenameFile

Syntax

Arguments

Examples

Remarks


Function.Communication.SFTP.SetProperty

Function.Communication.SFTP.SetProperty

Syntax

Arguments

Examples

Remarks


Function.Communication.SFTP.StoreUnique

Function.Communication.SFTP.StoreUnique

Syntax

Arguments

Examples

Remarks


Function.Communication.SFTP.Upload

Function.Communication.SFTP.Upload

Syntax

Arguments

Examples

Remarks


Function.Communication.SOAP. Reset

This method resets the component.

Syntax

Function.Communication.SOAP. Reset ()

Arguments

Examples

Remarks


Function.Communication.SOAP. SendPacket

This method sends the packet.

Syntax

Function.Communication.SOAP. SendPacket ()

Arguments

Examples

Remarks


Function.Communication.SOAP. SendRequest

This method sends the request.

Syntax

Function.Communication.SOAP. SendRequest ()

Arguments

Examples

Remarks


Function.Communication.SOAP. Value

This method returns the value of the parameter.

Syntax

Function.Communication.SOAP. Value (ParamName [String], Return Value [String])

Arguments

ParamName

Name of parameter

Return Value

Value of parameter

Examples

Remarks


Function.Communication.SOAP.AddCookie

This method adds a cookie and the corresponding value to the outgoing request headers.

Syntax

Function.Communication.SOAP.AddCookie(CookieName [String], CookieValue [String])

Arguments

CookieName

Name of cookie

CookieValue

Value of cookie

Examples

Remarks


Function.Communication.SOAP.AddNameSpace

This method adds a namespace to the Namespaces properties.

Syntax

Function.Communication.SOAP.AddNameSpace(Prefix [String], NamespaceURI [String])

Arguments

Prefix
NamespaceURI

Examples

Remarks


Function.Communication.SOAP.AddParam

This method adds a parameter-value pair.

Syntax

Function.Communication.SOAP.AddParam (ParamName [String], ParamValue [String])

Arguments

ParamName
ParamValue

Examples

Remarks


Function.Communication.SOAP.Attr

This method returns the value of the specified attribute.

Syntax

Function.Communication.SOAP.Attr (AttrName [String], returnValue [String])

Arguments

AttrName

Name of attribute

returnValue

Value of attribute

Examples

Remarks


Function.Communication.SOAP.BuildPacket

This method builds the request packet.

Syntax

Function.Communication.SOAP.BuildPacket ()

Arguments

Examples

Remarks


Function.Communication.SOAP.Config

This method sets or retrieves a configuration setting .

Syntax

Function.Communication.SOAP.Config (ConfigurationString [String], Return Value [String])

Arguments

ConfigurationString
Return Value

Examples

Remarks


Function.Communication.SOAP.DoEvents

This method processes events from the internal message queue.

Syntax

Function.Communication.SOAP.DoEvents ()

Arguments

Examples

Remarks


Function.Communication.SOAP.EvalPacket

This method evaluates the packet in SOAPPacket .

Syntax

Function.Communication.SOAP.EvalPacket ()

Arguments

Examples

Remarks


Function.Communication.SOAP.HasXPath

This method determines whether a specific element exists in the document.

Syntax

Function.Communication.SOAP.HasXPath (XPath [String], Return [Boolean])

Arguments

XPath
Return

Examples

Remarks


Function.Communication.SOAP.Interrupt

This method interrupts the current method.

Syntax

Function.Communication.SOAP.Interrupt ()

Arguments

Examples

Remarks


Function.Communication.SOAP.ReadProperty

This method returns the value of a property.

Syntax

Function.Communication.SOAP. ReadProperty ( PropertyName [String], Return Value [String])

Arguments

PropertyName

Name of property

Return Value

Value of property to get

Examples

Property

  • Available properties:

1. Accept: A list of acceptable MIME types for the request.

2. Authorization: The Authorization string to be sent to the server.

3. AuthScheme: The authentication scheme to use when server authorization is required.

4. Connected: Shows whether the component is connected.

5. ContentType: Content type for SOAP request data.

6. Cookies: Collection of cookies.

7. FaultString: Textual description of any faults returned by the SOAP server.

8. Firewall: A set of properties related to firewall access: FIREWALLAUTODETECT, FIREWALLHOST, FIREWALLPASSWORD, FIREWALLPORT, FIREWALLTYPE, FIREWALLUSER.

9. FollowRedirects: Determines what happens when the server issues a redirect.

10. IfModifiedSince: A date determining the maximum age of the desired document.

11. LocalFile: The path to a local file for downloading. If the file exists, it is overwritten.

12. LocalHost: The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

13. OtherHeaders: Other headers as determined by the user (optional).

14. Password: A password if authentication is to be used.

15. Proxy: A set of properties related to proxy access: PROXYAUTHSCHEME, PROXYAUTODETECT, PROXYPASSWORD, PROXYPORT, PROXYSERVER, PROXYUSER.

16. Referer: Referer URL/document (optional).

17. ReturnValue: Value returned by the SOAP Method .

18. Timeout: A timeout for the component.

19. TransferredDataLimit: The maximum of data to be transferred.

20. URL: The URL to fetch.

21. User: A user name if authentication is to be used.

22. ValueFormat: Format of data returned or set.

23. Xattributes: A collection of attributes of the current element.

24. Xchildren: The number of children of the element pointed to by XPath .

25. Xelement: The name of the element pointed to by XPath .

26. Xnamespace: The namespace of the element pointed to by XPath .

27. Xparent: The parent of the element pointed to by XPath .

28. Xpath: A path into the SOAPPacket received by the server.

29. Xprefix: The prefix of the element pointed to by XPath .

30. Xtext: The text of the element pointed to by XPath .

31. Method: The remote Method .

32. MethodURI: The URI corresponding to the SOAP Method .

33. FaultActor: Actor of any faults returned by the SOAP server.

34. FaultCode: Code of any faults returned by the SOAP server.


Remarks


Function.Communication.SOAP.SetProperty

This method sets value to a specific property.

Syntax

Function.Communication.SOAP. SetProperty (PropertyName [String], Property Value [String])

Arguments

PropertyName

Name of property

Property Value

Value of property to set

Examples

Property

  • Available properties:

1. Accept: A list of acceptable MIME types for the request.

2. Authorization: The Authorization string to be sent to the server.

3. AuthScheme: The authentication scheme to use when server authorization is required.

4. Connected: Shows whether the component is connected.

5. ContentType: Content type for SOAP request data.

6. Firewall: A set of properties related to firewall access: FIREWALLAUTODETECT, FIREWALLHOST, FIREWALLPASSWORD, FIREWALLPORT, FIREWALLTYPE, FIREWALLUSER.

7. FollowRedirects: Determines what happens when the server issues a redirect.

8. IfModifiedSince: A date determining the maximum age of the desired document.

9. LocalFile: The path to a local file for downloading. If the file exists, it is overwritten.

10. LocalHost: The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

11. OtherHeaders: Other headers as determined by the user (optional).

12. Password: A password if authentication is to be used.

13. Proxy: A set of properties related to proxy access: PROXYAUTHSCHEME, PROXYAUTODETECT, PROXYPASSWORD, PROXYPORT, PROXYSERVER, PROXYUSER.

14. Referer: Referer URL/document (optional).

16. Timeout: A timeout for the component.

17. TransferredDataLimit: The maximum of data to be transferred.

18. URL: The URL to fetch.

19. User: A user name if authentication is to be used.

20. ValueFormat: Format of data returned or set.

21. Xpath: A path into the SOAPPacket received by the server.

22. Method: The remote Method .

23. MethodURI: The URI corresponding to the SOAP Method .


Remarks


Function.Communication.WebForm.AddCookie

Syntax

Function.Intrinsic.WebForm.AddCookie(Name, Value)

Arguments

Name

String Variable/Value Name of the Cookie

Value

String Variable/Value for the Value of the Cookie

Example

Remarks


Function.Communication.WebForm.AddFormVar

Adds a variable to the form.

Syntax

Function.Intrinsic.WebForm.AddFormVar(Name, Value)

Arguments

Name

String Variable/Value Name of the Form Var

Value

String Variable/Value for the Value for Form Var

Example

Remarks


Function.Communication.WebForm.DoEvents

Syntax

Function.Intrinsic.WebForm.DoEvents

Arguments

Example

Remarks


Function.Communication.WebForm.Interrupt

Syntax

Function.Intrinsic.WebForm.Interrupt

Arguments

Example

Remarks


Function.Communication.WebForm.ReadProperty

Reads a value on the form and returns the value as a string.

Syntax

Function.Intrinsic.WebForm.ReadProperty(Property Name, Return Value)

Arguments

Property Name

String Variable/Value Name of the property

Return Value

Returned String Variable/Value for the property

Example

Remarks


Function.Communication.WebForm.Reset

Resets webform.

Syntax

Function.Intrinsic.WebForm.Reset

Arguments

None

Examples

Remarks

None


Function.Communication.WebForm.SetProperty

Sets a property on the webform.

Syntax

Function.Intrinsic.WebForm.SetProperty(Property Name, Value)

Arguments

Property Name

String Variable/Value Name of the property

Value

String Variable/Value of the property

Examples

Remarks

None


Function.Communication.WebForm.Submit

Submits the webform.

Syntax

Function.Intrinsic.WebForm.Submit or

Function.Intrinsic.WebForm.Submit(URL)

Arguments

URL

String of the URL

Example

#1
Function.Intrinsic.WebForm.Submit
#2
Function.Intrinsic.WebForm.Submit(“www.webpage_Save.asp”)

Remarks

None


Function.Communication.WebUpload.AddCookie

This adds a cookie and the corresponding value to the outgoing request headers.

Syntax

Function.Communication.WebUpload.AddCookie(CookieName [String], CookieValue [String])

Arguments

CookieName

String

CookieValue

String

Examples

Remarks


Function.Communication.WebUpload.AddFileVar

This adds a file variable and the corresponding file name.

Syntax

Function.Communication.WebUpload.AddFileVar(FileVar [String], FileName [String])

Arguments

FileVar

String

FileName

String

Examples

Remarks


Function.Communication.WebUpload.AddFormVar

This adds a form variable and the corresponding value.

Syntax

Function.Communication.WebUpload.AddFormVar(VarName [String], VarValue [String])

Arguments

VarName

String

VarValue

String

Examples

Remarks


Function.Communication.WebUpload.Config

This sets or retrieves a configuration setting.

Syntax

Function.Communication.WebUpload.Config(ConfigurationString [String])

Arguments

ConfigurationString

String

Examples

Remarks


Function.Communication.WebUpload.DoEvents

This processes events from the internal message queue.

Syntax

Function.Communication.WebUpload.DoEvents()

Arguments

Examples

Remarks


Function.Communication.WebUpload.Interrupt

This interrupts the current method.

Syntax

Function.Communication.WebUpload.Interrupt()

Arguments

Examples

Remarks


Function.Communication.WebUpload.ReadProperty

Function.Communication.WebUpload.ReadProperty

Syntax

Arguments

Examples

Remarks


Function.Communication.WebUpload.Reset

This resets the component.

Syntax

Function.Communication.WebUpload.Reset()

Arguments

Examples

Remarks


Function.Communication.WebUpload.SetProperty

Function.Communication.WebUpload.SetProperty

Syntax

Arguments

Examples

Remarks


Function.Communication.WebUpload.Upload

This posts data to the URL specified by URL.

Syntax

Function.Communication.WEBUPLOAD.Upload()

Arguments

Examples

Remarks


Function.Communication.WebUpload.UploadTo

This posts data to the URL specified by the 'URL' parameter.

Syntax

Function.Communication.WEBUPLOAD.UploadTo(URL [string])

Arguments

URL

string

Examples

Remarks