SaveLinkWithText
Description:
Save the Target Document of a Link with the specified Text in the specified Location.
Format:
SaveLinkWithText (integer Session ID (optional), string Text, string File Name, integer Occurence (optional))
|
Parameters: |
Integer |
Session ID (optional) |
Browser Occurrence Number.
First Browser occurrence is 1
Default value is 1 |
|
String |
Text |
Text displayed on the Link.
Wildcards ('*') are allowed |
|
String |
File Name |
Fully Qualified File Name of Save Location |
|
Integer |
Occurrence (optional) |
Link Occurrence Number.
First Link occurrence is 1
Default value is 1 |
|
Return Value: |
Boolean |
Success Ind |
Success Indicator.
TRUE – Link was clicked
FALSE – Link was not clicked |
Usage:
Use this function to save a Target Document of a Link. Text is what is displayed on the Link not the internal HTML Name. Wildcards can be specified in the Text string to match on partial displayed Text on the Link. The wildcard character is the asterisk ('*') and can be used on the beginning and/or end of the Text string. Use the optional Link Occurrence Number when more than one Link on the Document matches the Text string. Matches are not Case Sensitive. The file name must be a fully qualified file name including the file extension. If the File already exists and the SetFileOverWrite setting is FALSE, the save will fail. If the SetFileOverWrite setting is TRUE, the file will be overwritten with the new file.
Example 1:
Save the Target Document of a Link with text 'User Guide', in the default Browser Occurrence, in file: C:\Data\UserGuide.htm.
SaveLinkWithText ('User Guide', 'C:\Data\UserGuide.htm')
Example 2:
Save the Target Document of a Link with text containing 'Guide' in the second Browser Occurrence in file C:\Data\UserGuide.htm. Overwrite the file if it already exists.
SetFileOverwrite (TRUE)
SaveLinkWithText (2, '*Guide*', 'C:\Data\UserGuide.htm')