Capture$
Capture function.
The Capture$ function captures in text mode whatever appears in the specified window.
Syntax
a$=Capture$(<window_name>,<instance>,<mode>)
Parameters
<window_name>, window name of the window to be captured, including its <instance>, instance number of the window.
<mode>, integer (constant) corresponding to three bit flags. To obtain the value of <mode>, you have to add the values of each bit set to 1.
Bit 0 (weight 1) specifies how the text is captured :
0
the text is captured as a long string without CRLF
1
each line of the text is captured and separated by CRLF
If this bit is set to 0, the two others are set to 0 (so mode=2, 4 and 6 are invalid and an error is returned at compilation).
Bit 1 (weight 2) specifies the font and its size :
0
the font is not captured
1
the font and size are captured
Bit 2 (weight 4) specifies the underlined and color of the background attributes :
0
these attributes are not captured
1
these attributes are captured
So <mode> can be :
0
the text is captured as a long string without CRLF and attributes
1
the text is captured as several lines without attributes
3
the text is captured as several lines and the font size is captured
5
the text is captured as several lines, the attributes and the color of the background are captured
7
the text is captured as several lines, the fonts and the color of the background are captured
9
special value : mode for capturing text inside an emulator using non-proportional fonts. Use this mode if you notice that the normal mode ignores some blank fields.
Return value
a$, string containing the captured text. If <window_name> or <instance> are not found, or if there is nothing to capture, an empty string is returned.
Remarks
Use the Insert/Statement menu and double click Capture$ in order to automatically generate this statement.
Capture$ tries to capture the text in the order in which this text is displayed on the screen.
Capture$ also works with multiline Editboxes, a single-line EditBox, an entire DialogBox or a static control, if you specify the name of this static in the Capture$ parameters. Use it the same way for capturing the text of icons, buttons, listboxes.
Capture$ does NOT capture the text which overflows the window.
If Capture$ returns an empty string whereas it's really text which is displayed, try this hint:
in the script, copy the desired text to the Clipboard and retrieve after the content of Clipboard - so the statements in the script would be:'Text selection
SendKeys("<Ctrl a>",NoActivate)
Pause 5 ticks
'Copy the selection to the Clipboard
SendKeys("<Ctrl c>",NoActivate)
Pause 5 ticks
'Retrieve the content of the Clipboard
a$=GetClipboard$()
See also
Example
If you capture this window :
mode 0 returns :
"First line to be capturedSecond line to be capturedThird line to be captured"
mode 1 returns :
"First line to be captured
Second line to be captured
Third line to be captured"
mode 3 returns :
|X20,Y4,Times New Roman,H15,L133|First line to be captured
|X20,Y19,Arial,H16,L62|Second
|X82,Y19,Arial,H16,L27|line
|X109,Y19,Arial,H16,L65| to be captured
|X20,Y35,Courier New,H17,L234|Third line to be captured
