Skip to content
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
258 changes: 258 additions & 0 deletions docs/Help/Maps/table_of_contents.xml

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/Help/Topics/Command_CLEAR_SCREEN.xml
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@
</header>
<para styleclass="Normal"><snippet src="__CommandInclude" inline="false"/></para>
<para styleclass="Heading1">Purpose</para>
<para styleclass="Normal">Takes input from the keyboard and assigns it to a memory variable.</para>
<para styleclass="Normal">Clears the screen and positions the cursor in the top left corner.</para>
<para styleclass="Heading1">Syntax</para>
<para styleclass="Normal"><text style="font-family:Consolas;">CLEAR SCREEN</text></para>
<para styleclass="Heading1">Description</para>
<para styleclass="Body Text">The command CLEAR erases the screen. <br/>After execution of the CLEAR command, the cursor is positioned at 0, 0 and the functions Row() and Col() are updated. </para>
<para styleclass="Body Text">The command CLEAR SCREEN erases the screen. <br/>After execution of the command, the cursor is positioned at 0, 0 and the functions Row() and Col() are updated. The command is translated by the preprocessor to a call to <link displaytype="text" defaultstyle="true" type="topiclink" href="html\M_XSharp_RT_Functions_Cls.htm" domain="XSharpRef.chm">Cls()</link> followed by a call to <link displaytype="text" defaultstyle="true" type="topiclink" href="html\M_XSharp_RT_Functions_SetPos.htm" domain="XSharpRef.chm">SetPos()</link>(0,0).</para>
<para styleclass="Heading1">Examples</para>
<para styleclass="Normal">This example uses ACCEPT to get keyboard input from the user:</para>
<para styleclass="Normal">This example clears the screen after setting the colors:</para>
<para styleclass="Code Example"><text style="font-weight:bold; font-style:normal; text-decoration:none; color:#ff0000;">FUNCTION</text><text style="font-weight:normal; font-style:normal; text-decoration:none; color:#000000;"> Start </text><text style="font-weight:bold; font-style:normal; text-decoration:none; color:#ff0000;">AS</text><text style="font-weight:normal; font-style:normal; text-decoration:none; color:#000000;">&#32;</text><text style="font-weight:bold; font-style:normal; text-decoration:none; color:#ff0000;">VOID</text><br/><text style="font-weight:bold; font-style:normal; text-decoration:none; color:#ff0000;">SET</text><text style="font-weight:normal; font-style:normal; text-decoration:none; color:#000000;">&#32;</text><text style="font-weight:bold; font-style:normal; text-decoration:none; color:#ff0000;">COLOR</text><text style="font-weight:normal; font-style:normal; text-decoration:none; color:#000000;">&#32;</text><text style="font-weight:bold; font-style:normal; text-decoration:none; color:#ff0000;">TO</text><text style="font-weight:normal; font-style:normal; text-decoration:none; color:#000000;"> gr+/B &#160;</text><text style="font-weight:bold; font-style:italic; text-decoration:none; color:#339966;">// Yellow on Blue</text><br/><text style="font-weight:bold; font-style:normal; text-decoration:none; color:#ff0000;">CLEAR</text><text style="font-weight:normal; font-style:normal; text-decoration:none; color:#000000;">&#32;</text><text style="font-weight:bold; font-style:normal; text-decoration:none; color:#ff0000;">SCREEN</text><br/><text style="font-weight:normal; font-style:normal; text-decoration:none; color:#000000;">? &quot;Hello world&quot;</text></para>
<para styleclass="Normal"><snippet src="__IncludeLibRT" inline="false"/></para>
</body>
Expand Down
1 change: 1 addition & 0 deletions docs/Help/Topics/Command_SET_ALTERNATE.xml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
<para styleclass="Heading1">Syntax</para>
<para styleclass="Normal"><text style="font-family:Consolas;">SET ALTERNATE TO [&lt;cFileName&gt; [ADDITIVE] ] </text></para>
<para styleclass="Normal"><text style="font-family:Consolas;">SET ALTERNATE ON | OFF | &lt;lToggle</text>&gt; </para>
<para styleclass="Normal"><text style="font-family:Consolas;">CLOSE ALTERNATE</text></para>
<para styleclass="Normal"></para>
<para styleclass="Heading1">Arguments</para>
<para styleclass="List">&lt;cFileName&gt;<tab />Specifies the name of the ASCII file where screen output is recorded. The name must contain the drive and path. The file name can be specified either as a literal file name or as a character expression in parentheses. When the file name is specified without a file extension, the extension &quot;.TXT&quot; is used by default. <br/></para>
Expand Down
1 change: 1 addition & 0 deletions docs/Help/Topics/Command_SET_TEXTMERGE.xml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
<para styleclass="" style="text-align:left; text-indent:0px; margin-top:0px; margin-right:0px; margin-bottom:0px; margin-left:0px; line-height:1.00; background-color:transparent; white-space:normal; page-break-inside:auto; page-break-after:auto; border:none; tabstops:64px left,128px left,192px left,256px left,320px left,384px left,448px left,511px left,575px left ;"><text styleclass="" style="font-family:Consolas; font-size:11pt; color:#000000;">SET TEXTMERGE [ON | OFF] [TO [FileName] MEMVAR VarName [ADDITIVE]]</text></para>
<para styleclass="" style="text-align:left; text-indent:0px; margin-top:0px; margin-right:0px; margin-bottom:0px; margin-left:0px; line-height:1.00; background-color:transparent; white-space:normal; page-break-inside:auto; page-break-after:auto; border:none; tabstops:64px left,128px left,192px left,256px left,320px left,384px left,448px left,511px left,575px left ;"><text styleclass="" style="font-family:Consolas; font-size:11pt; color:#000000;"> &#160; [WINDOW WindowName] [SHOW | NOSHOW]</text></para>
<para styleclass="" style="text-align:left; text-indent:0px; margin-top:0px; margin-right:0px; margin-bottom:0px; margin-left:0px; line-height:1.00; background-color:transparent; white-space:normal; page-break-inside:auto; page-break-after:auto; border:none; tabstops:none;"></para>
<para styleclass="Normal">The X# preprocessor currently supports only SET TEXTMERGE ON | OFF | &amp;. The TO, MEMVAR, ADDITIVE, WINDOW and SHOW | NOSHOW clauses shown above are not supported yet. To change the delimiters see <link displaytype="text" defaultstyle="true" type="topiclink" href="command_SET_TEXTMERGE_DELIMITERS">SET TEXTMERGE DELIMITERS</link>. To capture the output of a text block, see <link displaytype="text" defaultstyle="true" type="topiclink" href="command_TEXT">TEXT</link>.</para>
<para styleclass="Heading1">Arguments</para>
<para styleclass="List">ON <tab />Specifies that any fields, variables, array elements, functions, or expressions surrounded by the text-merge delimiters be evaluated and output when placed after \ or \\, or between TEXT and ENDTEXT.</para>
<para styleclass="List"></para>
Expand Down
6 changes: 6 additions & 0 deletions docs/Help/Topics/SCAN-Command.xml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@
<para styleclass="Heading1"><text styleclass="Body Text">SCAN automatically advances the record pointer to the next record that meets the specified conditions and executes the block of commands.</text></para>
<para styleclass="Body Text">You can place comments after ENDSCAN on the same line. The comments are ignored during program compilation and execution.</para>
<para styleclass="Body Text"></para>
<para styleclass="Body Text">The preprocessor translates SCAN to a call to DbLocate() followed by a DO WHILE Found() loop. ENDSCAN is translated to a call to DbContinue() followed by ENDDO. The scan therefore follows the same rules as the <link displaytype="text" defaultstyle="true" type="topiclink" href="command_LOCATE">LOCATE</link> and <link displaytype="text" defaultstyle="true" type="topiclink" href="command_CONTINUE">CONTINUE</link> commands. END SCAN is a synonym for ENDSCAN.</para>
<para styleclass="Body Text"></para>
<para styleclass="Body Text">SCAN ... ENDSCAN ensures that, upon reaching ENDSCAN, Visual FoxPro reselects the table that was current when the SCAN ... ENDSCAN loop began.</para>
<para styleclass="Body Text"></para>
<para styleclass="Heading1">Example</para>
Expand All @@ -48,5 +50,9 @@
<para styleclass="Body Text"><link displaytype="text" defaultstyle="true" type="topiclink" href="command_FOR">FOR Statement</link></para>
<para styleclass="Body Text"><link displaytype="text" defaultstyle="true" type="topiclink" href="command_FOREACH">FOREACH </link><link displaytype="text" defaultstyle="true" type="topiclink" href="command_DO_CASE">Statement</link></para>
<para styleclass="Body Text"><link displaytype="text" defaultstyle="true" type="topiclink" href="command_SWITCH">SWITCH Statement</link></para>
<para styleclass="Body Text"><link displaytype="text" defaultstyle="true" type="topiclink" href="command_LOCATE">LOCATE Command</link></para>
<para styleclass="Body Text"><link displaytype="text" defaultstyle="true" type="topiclink" href="command_CONTINUE">CONTINUE Command</link></para>
<para styleclass="Body Text"><link displaytype="text" defaultstyle="true" type="topiclink" href="html\M_XSharp_RT_Functions_DbLocate.htm" domain="XSharpRef.chm">DbLocate()</link></para>
<para styleclass="Body Text"><link displaytype="text" defaultstyle="true" type="topiclink" href="html\M_XSharp_RT_Functions_DbContinue.htm" domain="XSharpRef.chm">DbContinue()</link></para>
</body>
</topic>
29 changes: 29 additions & 0 deletions docs/Help/Topics/command_ADD_TABLE.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="../helpproject.xsl" ?>
<topic template="Default" modified="2026-11-17T12:00:00.000+01:00" lasteditedby="Copilot" version="2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../helpproject.xsd">
<title>ADD TABLE Command</title>
<keywords>
<keyword>Commands</keyword>
<keyword>Databases</keyword>
<keyword>ADD TABLE command</keyword>
</keywords>
<body>
<header>
<para styleclass="Heading1">ADD TABLE Command</para>
</header>
<para styleclass="Normal"><snippet src="__FoxProOnly" inline="false"/></para>
<para styleclass="Normal"><snippet src="__CommandInclude" inline="false"/></para>
<para styleclass="Heading1">Purpose</para>
<para styleclass="Normal">Adds a free table to the current database.</para>
<para styleclass="Heading1">Syntax</para>
<para styleclass="Code with box">ADD TABLE &lt;TableName&gt; [NAME &lt;LongTableName&gt;]</para>
<para styleclass="Heading1">Arguments</para>
<para styleclass="List">&lt;TableName&gt;<tab />The name of the free table (.DBF file) to add to the database. The .DBF extension is added when it is omitted. The file must exist and may not belong to another database.</para>
<para styleclass="List">NAME &lt;LongTableName&gt;<tab />A long name (up to 128 characters) for the table in the database. When this clause is omitted, the file name without extension is used.</para>
<para styleclass="Heading1">Remarks</para>
<para styleclass="Normal">The database must have been opened with <link displaytype="text" defaultstyle="true" type="topiclink" href="command_OPEN_DATABASE">OPEN DATABASE</link> and must be the current database (see <link displaytype="text" defaultstyle="true" type="topiclink" href="command_SET_DATABASE">SET DATABASE TO</link>).</para>
<para styleclass="Body Text"><snippet src="__IncludeLibVFP" inline="false"/></para>
<para styleclass="Heading1">See Also</para>
<para styleclass="Normal"><link displaytype="text" defaultstyle="true" type="topiclink" href="command_REMOVE_TABLE">REMOVE TABLE</link>, <link displaytype="text" defaultstyle="true" type="topiclink" href="command_RENAME_TABLE">RENAME TABLE</link>, <link displaytype="text" defaultstyle="true" type="topiclink" href="command_CREATE_TABLE">CREATE TABLE</link></para>
</body>
</topic>
31 changes: 31 additions & 0 deletions docs/Help/Topics/command_ALTER_TABLE.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="../helpproject.xsl" ?>
<topic template="Default" modified="2026-11-17T12:00:00.000+01:00" lasteditedby="Copilot" version="2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../helpproject.xsd">
<title>ALTER TABLE Command</title>
<keywords>
<keyword>Commands</keyword>
<keyword>SQL</keyword>
<keyword>ALTER TABLE command</keyword>
</keywords>
<body>
<header>
<para styleclass="Heading1">ALTER TABLE Command</para>
</header>
<para styleclass="Normal"><snippet src="__FoxProOnly" inline="false"/></para>
<para styleclass="Normal"><snippet src="__CommandInclude" inline="false"/></para>
<para styleclass="Heading1">Purpose</para>
<para styleclass="Normal">Changes the structure of an existing table.</para>
<para styleclass="Heading1">Syntax</para>
<para styleclass="Code with box">ALTER TABLE &lt;TableName&gt; ADD [COLUMN] &lt;FieldName&gt; &lt;FieldType&gt; [(&lt;nWidth&gt; [, &lt;nPrecision&gt;])] [NULL | NOT NULL]<br/>ALTER TABLE &lt;TableName&gt; ALTER [COLUMN] &lt;FieldName&gt; &lt;FieldType&gt; [(&lt;nWidth&gt; [, &lt;nPrecision&gt;])] [NULL | NOT NULL]<br/>ALTER TABLE &lt;TableName&gt; DROP [COLUMN] &lt;FieldName&gt;</para>
<para styleclass="Heading1">Arguments</para>
<para styleclass="List">ADD [COLUMN]<tab />Adds a new field to the table.</para>
<para styleclass="List">ALTER [COLUMN]<tab />Changes the type, size or NULL setting of an existing field.</para>
<para styleclass="List">DROP [COLUMN]<tab />Removes a field from the table.</para>
<para styleclass="Heading1">Remarks</para>
<para styleclass="Normal">The table is rebuilt. The old table is kept as a backup file with the extension .BAK (and .TBK for the memo file) until the new table has been created successfully. Field types and clauses are the same as for <link displaytype="text" defaultstyle="true" type="topiclink" href="command_CREATE_TABLE">CREATE TABLE</link>.</para>
<para styleclass="Normal"><text styleclass="Body Text" style="font-weight:bold; color:#ff0000;">NOT SUPPORTED AT THIS MOMENT</text>: The variations of the command that change table properties or constraints (such as primary and foreign keys, rules and triggers) are accepted by the preprocessor but are ignored.</para>
<para styleclass="Body Text"><snippet src="__IncludeLibVFP" inline="false"/></para>
<para styleclass="Heading1">See Also</para>
<para styleclass="Normal"><link displaytype="text" defaultstyle="true" type="topiclink" href="command_CREATE_TABLE">CREATE TABLE</link></para>
</body>
</topic>
33 changes: 33 additions & 0 deletions docs/Help/Topics/command_ASSERT.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="../helpproject.xsl" ?>
<topic template="Default" modified="2026-11-17T12:00:00.000+01:00" lasteditedby="Copilot" version="2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../helpproject.xsd">
<title>ASSERT Command</title>
<keywords>
<keyword>Commands</keyword>
<keyword>Debugging</keyword>
<keyword>ASSERT command</keyword>
</keywords>
<body>
<header>
<para styleclass="Heading1">ASSERT Command</para>
</header>
<para styleclass="Normal"><snippet src="__FoxProOnly" inline="false"/></para>
<para styleclass="Normal"><snippet src="__CommandInclude" inline="false"/></para>
<para styleclass="Heading1">Purpose</para>
<para styleclass="Normal">Displays a message box when the specified expression evaluates to FALSE.</para>
<para styleclass="Heading1">Syntax</para>
<para styleclass="Code with box">ASSERT &lt;lExpression&gt; [MESSAGE &lt;cMessageText&gt;]</para>
<para styleclass="Heading1">Arguments</para>
<para styleclass="List">&lt;lExpression&gt;<tab />The expression that is evaluated. Nothing happens when the expression returns TRUE.</para>
<para styleclass="List">MESSAGE &lt;cMessageText&gt;<tab />The text that is displayed in the message box. When this clause is omitted, the text of the expression is displayed.</para>
<para styleclass="Heading1">Remarks</para>
<para styleclass="Normal">ASSERT only does something when <link displaytype="text" defaultstyle="true" type="topiclink" href="command_SET_ASSERTS">SET ASSERTS</link> is ON. When the assertion fails, a dialog is shown with the options Debug, Cancel, Ignore and Ignore All. Ignore All suppresses all following failed assertions.</para>
<para styleclass="Normal">When the compiler define NOASSERT is declared, the ASSERT commands are removed from the code by the preprocessor.</para>
<para styleclass="Heading1">Examples</para>
<para styleclass="Code Example">SET ASSERTS ON<br/>
ASSERT nCount &gt; 0 MESSAGE "The count must be positive"</para>
<para styleclass="Body Text"><snippet src="__IncludeLibVFP" inline="false"/></para>
<para styleclass="Heading1">See Also</para>
<para styleclass="Normal"><link displaytype="text" defaultstyle="true" type="topiclink" href="command_SET_ASSERTS">SET ASSERTS</link></para>
</body>
</topic>
49 changes: 49 additions & 0 deletions docs/Help/Topics/command_CAST_AS.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="../helpproject.xsl" ?>
<topic template="Default" modified="2026-11-17T12:00:00.000+01:00" lasteditedby="Copilot" version="2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../helpproject.xsd">
<title>CAST AS Command</title>
<keywords>
<keyword>Commands</keyword>
<keyword>Conversion</keyword>
<keyword>CAST command</keyword>
</keywords>
<body>
<header>
<para styleclass="Heading1">CAST ... AS</para>
</header>
<para styleclass="Normal"><snippet src="__FoxProOnly" inline="false"/></para>
<para styleclass="Normal"><snippet src="__CommandInclude" inline="false"/></para>
<para styleclass="Heading1">Purpose</para>
<para styleclass="Normal">Converts an expression to the specified data type. CAST is not a statement, but an expression that can be used wherever a value is expected.</para>
<para styleclass="Heading1">Syntax</para>
<para styleclass="Code with box">CAST ( &lt;eExpression&gt; AS &lt;Type&gt; [(&lt;nWidth&gt; [, &lt;nPrecision&gt;])] [NULL | NOT NULL] )<br/>CAST ( &lt;eExpression&gt; AS ( &lt;cTypeExpression&gt; ) [NULL | NOT NULL] )</para>
<para styleclass="Heading1">Arguments</para>
<para styleclass="List">&lt;eExpression&gt;<tab />The expression to convert.</para>
<para styleclass="List">&lt;Type&gt;<tab />The target type, as a single letter or as a name:<br/>
C, CHAR, CHARACTER: Character (padded with spaces to the width)<br/>
V, VARCHAR: Varchar (truncated to the width, but not padded)<br/>
N, NUM, NUMERIC and F, FLOAT: Numeric and Float<br/>
I, INT, INTEGER: Integer<br/>
B, DOUBLE: Double<br/>
Y, CURRENCY: Currency<br/>
D, DATE: Date<br/>
T, DATETIME: DateTime<br/>
L, LOGICAL: Logical (a string that starts with T or Y gives TRUE, a number gives TRUE when it is not zero)<br/>
M, MEMO: Memo<br/>
G, GENERAL: General<br/>
W, BLOB: Blob<br/>
Q, VARBINARY: Varbinary (truncated to the width)<br/>
The type is not case sensitive. A runtime error is generated when the expression cannot be converted to the target type.</para>
<para styleclass="List">&lt;nWidth&gt; [, &lt;nPrecision&gt;]<tab />The width of the result for character and numeric types and the number of decimals for numeric types. For character values the default width is 1.</para>
<para styleclass="List">&lt;cTypeExpression&gt;<tab />An expression between parentheses that returns the type name, for example a variable.</para>
<para styleclass="List">NULL | NOT NULL<tab />Accepted for compatibility with the SQL syntax. The clause does not change the result.</para>
<para styleclass="Heading1">Examples</para>
<para styleclass="Code Example">? CAST(123.456 AS C(10))<br/>
? CAST("42" AS I)<br/>
cType := "N"<br/>
? CAST("3.14" AS (cType))</para>
<para styleclass="Body Text"><snippet src="__IncludeLibVFP" inline="false"/></para>
<para styleclass="Heading1">See Also</para>
<para styleclass="Normal"><link displaytype="text" defaultstyle="true" type="topiclink" href="command_CREATE_TABLE">CREATE TABLE</link></para>
</body>
</topic>
Loading
Loading