Skip to content
This repository was archived by the owner on Aug 31, 2021. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions docs/dictionary/command/revExecuteSQL.lcdoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,9 @@ was opened.

SQLStatement (string):
A string in Structured Query Language. (Do not include a semicolon at
the end of the SQLStatement.) >*Note:* Some database systems, such as
Oracle, are capable of handling a multiple-line SQL statement.
the end of the SQLStatement.)
> *Note:* Some database systems, such as
> Oracle, are capable of handling a multiple-line SQL statement.

variablesList:
The variablesList consists of one or more variable names (or expressions
Expand All @@ -41,9 +42,10 @@ name may also be the name of an array element, for example

arrayName (array):
The name of a single array variable whose keys are sequential
numbers.>*Note:* The variable names or arrayName must be enclosed in
quotes; otherwise, the variable's value rather than its name is passed
to the revExecuteSQL command.
numbers.
> *Note:* The variable names or arrayName must be enclosed in
> quotes; otherwise, the variable's value rather than its name is passed
> to the revExecuteSQL command.


The result:
Expand All @@ -66,8 +68,7 @@ each of these placeholders. For example, if you have two
<variable|variables> called "valueX" and "valueY", you can use a
<SQLStatement> that includes placeholders as follows:

revExecuteSQL myID, "insert into mytable values(:1,:2,:1)", "valueX"
,"valueY"
revExecuteSQL myID, "insert into mytable values(:1,:2,:1)", "valueX","valueY"

The content of the variable valueX is substituted for the ":1" in the
SQLQuery (in both places where ":1" appears), and the content of valueY
Expand All @@ -78,17 +79,16 @@ is substituted for ":2".
> syntax error to be returned by the database because a placeholder is
> being used to represent a column name (:1).

-- Invalid, will cause SQL syntax error
revExecuteSQL myID,
"insert into mytable(:1, name, date) values (:2, :3, :2)",
"tColumnName", "tValueX", "tValueY"
-- Invalid, will cause SQL syntax error
revExecuteSQL myID,
"insert into mytable(:1, name, date) values (:2, :3, :2)", "tColumnName", "tValueX", "tValueY"

If you specify an <arrayName> rather than a list of ordinary
<variable|variables>, the <revExecuteSQL> <command> substitutes the
corresponding <element> of the <array> for each of the placeholders in
the query:

revExecuteSQL myID,"insert into mytable values(:1,:2,:1)","myArray"
revExecuteSQL myID,"insert into mytable values(:1,:2,:1)","myArray"

The content of the element myArray[1] is substituted for the ":1" in the
SQLQuery (in both places where ":1" appears), and the content of
Expand Down
10 changes: 5 additions & 5 deletions docs/dictionary/command/revInitializeVideoGrabber.lcdoc
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,8 @@ To use <VFW|Video for Windows> (on <Windows|Windows systems>), specify
"VFW".

To close the window and unload the video capture code, you should use
the <revCloseVideoGrabber> <command> when you're done with <video
capture>.
the <revCloseVideoGrabber> <command> when you're done with
<video capture>.

>*Important:* The <revInitializeVideoGrabber> <command> is part of the
> <Video library>. To ensure that the <command> works in a
Expand All @@ -87,9 +87,9 @@ revStopPreviewingVideo (command), stack window (glossary),
video capture (glossary), Windows (glossary), VFW (glossary),
Standalone Application Settings (glossary), video grabber (glossary),
standalone application (glossary), function (glossary),
command (glossary), LiveCode custom library (glossary), file (keyword),
Video library (library), properties (property), dontUseQT (property),
dontUseQTEffects (property)
command (glossary), LiveCode custom library (glossary),
QuickTime (glossary), file (keyword), Video library (library),
properties (property), dontUseQT (property), dontUseQTEffects (property)

Tags: multimedia

41 changes: 20 additions & 21 deletions docs/dictionary/command/revMail.lcdoc
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,18 @@ messageBody (string):
This text appears in the 'body' of the email message.

The result:
On return on iOS, the result is set to one of:. On return on Android,
the result is set to:. * unknown - On Android the email activity does
not return its status back to the calling activity so the result is set
to 'unknown' in all cases.
On return on iOS, the result is set to one of:
* not configured - if the user has turned off or has not setup mail
access on their device
* cancel - if the user chooses to cancel the send
* saved - if the user chose to save the message in drafts
* sent - if the user elected to send the email
* failed - if sending the email was attempted, but it failed

On return on Android, the result is set to:
* unknown - On Android the email activity does not return its status
back to the calling activity so the result is set to 'unknown' in all
cases.

Description:
Use the <revMail> <command> to create an email message from within a
Expand All @@ -54,8 +62,8 @@ Use the <revMail> <command> to create an email message from within a
When LiveCode executes the <revMail> <command>, the user's email program
is opened (if necessary) and a new email message with the specified
<parameter|parameters> is created. The user can change any of the
settings before sending the message, and the message is not sent
automatically: the user must explicitly send it (for example, by
settings before sending the message, and the message is not
sent automatically: the user must explicitly send it (for example, by
clicking a 'Mail' button in the email program).

On Mac OS systems, the mail message is opened in the application the
Expand All @@ -64,14 +72,6 @@ user has set for the 'mailto:' protocol in the Internet control panel

On iOS, <revMail> hooks into the iOS MessageUI framework.

* not configured - if the user has turned off or has not setup mail
access on their device
* cancel - if the user chooses to cancel the send
* saved - if the user chose to save the message in drafts
* sent - if the user elected to send the email
* failed - if sending the email was attempted, but it failed


>*Important:* On <Mac OS|Mac OS systems>, the <revMail> <command>
> requires that AppleScript be installed and that the GURL <Apple Event>
> be supported. GURL support is included in <Mac OS> 8.5 or later, and
Expand All @@ -86,9 +86,9 @@ For some older email programs, it may not be possible to specify a
<command> still works with such programs, but only the 'To:' header is
set.

>*Note:* When included in a <standalone application>, the <Common
> library> is implemented as a hidden <group> and made available when
> the <group> receives its first <openBackground> message. During the
>*Note:* When included in a <standalone application>, the
> <Common library> is implemented as a hidden <group> and made available
> when the <group> receives its first <openBackground> message. During the
> first part of the <application|application's> startup process, before
> this <message> is sent, the <revMail> <command> is not yet available.
> This may affect attempts to use this <command> in <startup>,
Expand All @@ -107,10 +107,9 @@ mobileComposeHtmlMail (command), parameter (glossary),
main stack (glossary), handler (glossary), message (glossary),
group (glossary), Mac OS (glossary), standalone application (glossary),
Apple Event (glossary), command (glossary), application (glossary),
file (keyword), revMail (library), Common library (library),
library (library), startup (message), openBackground (message),
preOpenStack (message), openStack (message), preOpenCard (message),
stack (object)
file (keyword), Common library (library), library (library),
startup (message), openBackground (message), preOpenStack (message),
openStack (message), preOpenCard (message), stack (object)

Tags: networking

18 changes: 8 additions & 10 deletions docs/dictionary/command/revPrintReport.lcdoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@ Type: command
Syntax: revPrintReport

Summary:
Prints a report from the <report viewer|report viewers> on the
<current card>.
Prints a report from the report viewers on the <current card>.

Introduced: 2.0

Expand All @@ -21,22 +20,21 @@ revPrintReport

Description:
Use the <revPrintReport> <command> to print a report that you have set
up in the <Report Builder>.
up in the Report Builder.

>*Note:* The <Report Builder> stack is no-longer supported but can
> still
> be used by manually launching the tool.
>*Note:* The Report Builder stack is no-longer supported but can
> still be used by manually launching the tool.

When you use the <Report Builder> to create a set of report settings,
When you use the Report Builder to create a set of report settings,
the settings are stored with the card. The <revPrintReport> <command>
uses the settings specified in the <Report Builder> for the
uses the settings specified in the Report Builder for the
<current card> to print the report. If you have never used the
<Report Builder> with the <current card> (and therefore there are no
Report Builder with the <current card> (and therefore there are no
report settings to use), the <revPrintReport> <command> causes a
<error|script error>.

The <revPrintReport> <command> is equivalent to clicking "Print Report"
in the <Report Builder>.
in the Report Builder.

>*Important:* The <revPrintReport> <command> is part of the
> <Printing library>. To ensure that the <command> works in a
Expand Down
9 changes: 5 additions & 4 deletions docs/dictionary/command/revShowPrintDialog.lcdoc
Original file line number Diff line number Diff line change
Expand Up @@ -76,10 +76,11 @@ printing options only for the currently <execute|executing> <handler>.

References: answer printer (command), revPrintText (command),
group (command), revPrintField (command), answer page setup (command),
application (glossary), standalone application (glossary),
dialog box (glossary), execute (glossary), command (glossary),
Windows (glossary), main stack (glossary), OS X (glossary),
result (glossary), Standalone Application Settings (glossary),
result (function), application (glossary),
standalone application (glossary), dialog box (glossary),
execute (glossary), command (glossary), Windows (glossary),
main stack (glossary), OS X (glossary),
Standalone Application Settings (glossary),
Mac OS (glossary), message (glossary), parameter (glossary),
handler (glossary), LiveCode custom library (glossary),
Printing library (library), startup (message), openBackground (message),
Expand Down
9 changes: 5 additions & 4 deletions docs/dictionary/function/revAppVersion.lcdoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,10 @@ The <revAppVersion> <function> is different from the <version>
<function>. The <revAppVersion> function returns the version of the
<development environment>, while the <version> <function> returns the
version of the underlying <engine>. For example, the contents of the
LiveCode menu bar, the <LiveCode custom libraries>, and the <property
inspector> depend on the <revAppVersion>, but the features of the
<LiveCode> language depend on the <engine> <version>.
LiveCode menu bar, the
<LiveCode custom library|LiveCode custom libraries>, and the
<property inspector> depend on the <revAppVersion>, but the features of
the <LiveCode> language depend on the <engine> <version>.

>*Note:* In a standalone application the <Common library> is implemented
> as a hidden <group> and made available when the <group> receives its
Expand All @@ -51,7 +52,7 @@ libURLVersion (function), buildNumber (function), LiveCode (glossary),
return (glossary), main stack (glossary), handler (glossary),
engine (glossary), development environment (glossary), group (glossary),
message (glossary), application (glossary), property inspector (glossary),
LiveCode custom libraries (glossary), string (keyword),
LiveCode custom library (glossary), string (keyword),
Common library (library), library (library), startup (message),
openBackground (message), preOpenStack (message), openStack (message),
preOpenCard (message)
Expand Down
8 changes: 4 additions & 4 deletions docs/dictionary/function/revBrowserGet.lcdoc
Original file line number Diff line number Diff line change
Expand Up @@ -101,15 +101,15 @@ Use the <revBrowserGet> function to obtain information about the browser
object specified by the <instanceId> by returning the value of one of
the browser properties.

>*Note:* The "advanced" callback messages are: <revBrowserClick>,
> <revBrowserOver> and <revBrowserOut>. These messages are only sent
>*Note:* The "advanced" callback messages are: <browserClick>,
> <browserOver> and <browserOut>. These messages are only sent
> when the "messages" property is set to true. Other callback messages
> are always sent.

>*Note:* For general information on using the browser library, see the
> notes in the <revBrowserOpen> <function> reference.

References: revBrowserSet (command), revBrowserOpen (function), function (glossary),
revBrowserOver (message), revBrowserOut (message),
revBrowserClick (message)
browserOver (message), browserOut (message),
browserClick (message)

2 changes: 0 additions & 2 deletions docs/dictionary/function/revBrowserInstances.lcdoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,6 @@ The <revBrowserInstances> function returns a comma-delimited list of
integer browser ids, or empty if no browsers are open.

Description:
none

Use the <revBrowserInstances> function to obtain a list of the ids of
all the open browser objects.

Expand Down
10 changes: 5 additions & 5 deletions docs/dictionary/function/revXMLCreateTreeWithNamespaces.lcdoc
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,10 @@ sendMessages (bool):

Returns:
The <revXMLCreateTreeWithNamespaces> <function(control structure)>
returns a tree ID which can be used to refer to the tree in other <XML
library> <command|commands> and <function(glossary)|functions>. The tree
ID is always a positive <integer>. (If the <createTree> is false, the
<function(control structure)> <return|returns> zero.) If the function
returns a tree ID which can be used to refer to the tree in other
<XML library> <command|commands> and <function(glossary)|functions>. The
tree ID is always a positive <integer>. (If the <createTree> is false,
the <function(control structure)> <return|returns> zero.) If the function
encounters an error while parsing the data, it returns an error message
beginning with "xmlerr".

Expand Down Expand Up @@ -90,7 +90,7 @@ revXMLAppend (command), function (control structure),
revXMLValidateDTD (function), revXMLTrees (function),
revXMLCreateTree (function),
revXMLCreateTreeFromFileWithNamespaces (function),
LiveCode custom library (glossary), return (glossary),
LiveCode custom library (glossary), return (glossary), string (glossary),
XML tree (glossary), Standalone Application Settings (glossary),
message (glossary), standalone application (glossary), XML (glossary),
function (glossary), command (glossary), integer (keyword),
Expand Down
11 changes: 4 additions & 7 deletions docs/dictionary/function/revXMLDataFromXPathQuery.lcdoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,10 @@ functions. The charDelimiter and lineDelimiter both default to cr. If
neither is specified then the items will be returned one per line.
For example:

J. K. Rowling

Harry Potter

Cory Doctorow

Little Brother
J. K. Rowling
Harry Potter
Cory Doctorow
Little Brother

Introduced: 6.5

Expand Down
11 changes: 4 additions & 7 deletions docs/dictionary/function/revXMLEvaluateXPath.lcdoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,10 @@ Summary:
The charDelimiter defaults to cr. If not specified then the items will
be returned one per line. For example:

J. K. Rowling

Harry Potter

Cory Doctorow

Little Brother
J. K. Rowling
Harry Potter
Cory Doctorow
Little Brother

Introduced: 6.5

Expand Down