diff --git a/docs/Help/Maps/table_of_contents.xml b/docs/Help/Maps/table_of_contents.xml index 843b6150e8..be02fc7b3b 100644 --- a/docs/Help/Maps/table_of_contents.xml +++ b/docs/Help/Maps/table_of_contents.xml @@ -923,6 +923,12 @@ Database + + ADD TABLE Command + + + ALTER TABLE Command + APPEND BLANK Command @@ -944,15 +950,30 @@ CLOSE Command + + CLOSE DATABASES Command + + + CLOSE TABLES Command + CONTINUE Command + + COPY MEMO Command + COPY STRUCTURE Command COPY STRUCTURE EXTENDED Command + + COPY STRUCTURE Command (FoxPro) + + + COPY STRUCTURE EXTENDED Command (FoxPro) + COPY TO ARRAY Command @@ -965,42 +986,90 @@ COUNT Command + + COUNT Command (FoxPro) + CREATE Command + + CREATE CONNECTION Command + + + CREATE CURSOR Command + + + CREATE DATABASE Command + CREATE FROM Command + + CREATE TABLE Command + DELETE Command + + DELETE Command (FoxPro) + + + DELETE CONNECTION Command + + + DELETE DATABASE Command + + + DELETE FROM Command + GATHER Command GO Command + + INSERT INTO Command + JOIN Command LOCATE Command + + OPEN DATABASE Command + PACK Command RECALL Command + + RECALL Command (FoxPro) + + + REMOVE TABLE Command + + + RENAME TABLE Command + REPLACE Command + + REPLACE Command (FoxPro) + SCATTER Command SELECT Command + + SET DATABASE Command + SET DELETED Command @@ -1025,6 +1094,9 @@ SORT Command + + SORT Command (FoxPro) + SUM Command @@ -1034,9 +1106,15 @@ UPDATE Command + + UPDATE SET Command + USE Command + + USE Command (FoxPro) + ZAP Command @@ -1049,6 +1127,18 @@ SET DATE Command + + SET DATE Command (FoxPro) + + + SET HOURS Command + + + SET SECONDS Command + + + SET TIME Command + SET DATE FORMAT Command @@ -1169,12 +1259,45 @@ SET ANSI Command + + SET ANSI Command (FoxPro) + + + SET ASSERTS Command + + + SET AUTOINCERROR Command + + + SET BELL Command + + + SET BLOCKSIZE Command + SET CENTURY Command + + SET COLLATE Command + + + SET COMPATIBLE Command + + + SET CONFIRM Command + + + SET CURSOR Command + + + SET DATABASE Command + SET DATE Command + + SET DATE Command (FoxPro) + SET DATE FORMAT Command @@ -1184,6 +1307,15 @@ SET DEFAULT Command + + SET DELIMITERS Command + + + SET DEVICE Command + + + SET DIRECTORY Command + SET DIGITFIXED Command @@ -1196,12 +1328,84 @@ SET EPOCH Command + + SET ESCAPE Command + SET EXACT Command SET FIXED Command + + SET FULLPATH Command + + + SET HEADINGS Command + + + SET HOURS Command + + + SET LOCK Command + + + SET MARGIN Command + + + SET MEMOWIDTH Command + + + SET MULTILOCKS Command + + + SET NEAR Command + + + SET NULL Command + + + SET OPTIMIZE Command (FoxPro) + + + SET PATH Command (FoxPro) + + + SET POINT Command + + + SET PRINTER Command + + + SET REFRESH Command + + + SET SAFETY Command + + + SET SECONDS Command + + + SET SEPARATOR Command + + + SET SPACE Command + + + SET SQLBUFFERING Command + + + SET STRICTREAD Command + + + SET TEXTMERGE DELIMITERS Command + + + SET TIME Command + + + SET VARCHARMAPPING Command + SET PATH Command @@ -1214,15 +1418,27 @@ DELETE FILE Command + + CHDIR Command + DIR Command ERASE Command + + MKDIR Command + RENAME Command + + RMDIR Command + + + SET DIRECTORY Command + SET DEFAULT Command @@ -1241,18 +1457,27 @@ INDEX Command + + INDEX Command (FoxPro) + REINDEX Command SEEK Command + + SEEK Command (FoxPro) + SET DESCENDING Command SET INDEX Command + + SET INDEX Command (FoxPro) + SET ORDER Command @@ -1265,6 +1490,9 @@ SET SCOPETOP Command + + SET NEAR Command + SET SOFTSEEK Command @@ -1274,6 +1502,15 @@ International + + SET COLLATE Command + + + SET POINT Command + + + SET SEPARATOR Command + SET COLLATION Command @@ -1343,6 +1580,9 @@ #ifndef Statement + + ASSERT Command + ASYNC .. AWAIT @@ -1442,9 +1682,18 @@ SET CONSOLE Command + + SET DEVICE Command + + + SET PRINTER Command + SET TEXTMERGE Command + + SET TEXTMERGE DELIMITERS Command + TEXT Command @@ -1457,12 +1706,21 @@ TEXT Command (FoxPro) + + WAIT CLEAR Command + + + WAIT Command (FoxPro) + WAIT Command Variable Declaration + + CAST AS Command + FIELD Statement diff --git a/docs/Help/Topics/Command_CLEAR_SCREEN.xml b/docs/Help/Topics/Command_CLEAR_SCREEN.xml index eb5fa5df2d..9ecc0fe6d0 100644 --- a/docs/Help/Topics/Command_CLEAR_SCREEN.xml +++ b/docs/Help/Topics/Command_CLEAR_SCREEN.xml @@ -13,13 +13,13 @@ Purpose - Takes input from the keyboard and assigns it to a memory variable. + Clears the screen and positions the cursor in the top left corner. Syntax CLEAR SCREEN Description - The command CLEAR erases the screen.
After execution of the CLEAR command, the cursor is positioned at 0, 0 and the functions Row() and Col() are updated.
+ The command CLEAR SCREEN erases the screen.
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 Cls() followed by a call to SetPos()(0,0).
Examples - This example uses ACCEPT to get keyboard input from the user: + This example clears the screen after setting the colors: FUNCTION Start AS VOID
SET COLOR TO gr+/B  // Yellow on Blue
CLEAR SCREEN
? "Hello world"
diff --git a/docs/Help/Topics/Command_SET_ALTERNATE.xml b/docs/Help/Topics/Command_SET_ALTERNATE.xml index 2499ee90f5..45f218d44d 100644 --- a/docs/Help/Topics/Command_SET_ALTERNATE.xml +++ b/docs/Help/Topics/Command_SET_ALTERNATE.xml @@ -17,6 +17,7 @@ Syntax SET ALTERNATE TO [<cFileName> [ADDITIVE] ] SET ALTERNATE ON | OFF | <lToggle> + CLOSE ALTERNATE Arguments <cFileName>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 ".TXT" is used by default.
diff --git a/docs/Help/Topics/Command_SET_TEXTMERGE.xml b/docs/Help/Topics/Command_SET_TEXTMERGE.xml index 36832ad8ac..19a9fd87f8 100644 --- a/docs/Help/Topics/Command_SET_TEXTMERGE.xml +++ b/docs/Help/Topics/Command_SET_TEXTMERGE.xml @@ -18,6 +18,7 @@ SET TEXTMERGE [ON | OFF] [TO [FileName] MEMVAR VarName [ADDITIVE]]   [WINDOW WindowName] [SHOW | NOSHOW] + The X# preprocessor currently supports only SET TEXTMERGE ON | OFF | &. The TO, MEMVAR, ADDITIVE, WINDOW and SHOW | NOSHOW clauses shown above are not supported yet. To change the delimiters see SET TEXTMERGE DELIMITERS. To capture the output of a text block, see TEXT. Arguments ON 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. diff --git a/docs/Help/Topics/SCAN-Command.xml b/docs/Help/Topics/SCAN-Command.xml index 63950eb5b8..f01a0a79f5 100644 --- a/docs/Help/Topics/SCAN-Command.xml +++ b/docs/Help/Topics/SCAN-Command.xml @@ -36,6 +36,8 @@ SCAN automatically advances the record pointer to the next record that meets the specified conditions and executes the block of commands. You can place comments after ENDSCAN on the same line. The comments are ignored during program compilation and execution. + 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 LOCATE and CONTINUE commands. END SCAN is a synonym for ENDSCAN. + SCAN ... ENDSCAN ensures that, upon reaching ENDSCAN, Visual FoxPro reselects the table that was current when the SCAN ... ENDSCAN loop began. Example @@ -48,5 +50,9 @@ FOR Statement FOREACH Statement SWITCH Statement + LOCATE Command + CONTINUE Command + DbLocate() + DbContinue() diff --git a/docs/Help/Topics/command_ADD_TABLE.xml b/docs/Help/Topics/command_ADD_TABLE.xml new file mode 100644 index 0000000000..dd395cf884 --- /dev/null +++ b/docs/Help/Topics/command_ADD_TABLE.xml @@ -0,0 +1,29 @@ + + + + ADD TABLE Command + + Commands + Databases + ADD TABLE command + + +
+ ADD TABLE Command +
+ + + Purpose + Adds a free table to the current database. + Syntax + ADD TABLE <TableName> [NAME <LongTableName>] + Arguments + <TableName>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. + NAME <LongTableName>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. + Remarks + The database must have been opened with OPEN DATABASE and must be the current database (see SET DATABASE TO). + + See Also + REMOVE TABLE, RENAME TABLE, CREATE TABLE + +
diff --git a/docs/Help/Topics/command_ALTER_TABLE.xml b/docs/Help/Topics/command_ALTER_TABLE.xml new file mode 100644 index 0000000000..1a57dc2538 --- /dev/null +++ b/docs/Help/Topics/command_ALTER_TABLE.xml @@ -0,0 +1,31 @@ + + + + ALTER TABLE Command + + Commands + SQL + ALTER TABLE command + + +
+ ALTER TABLE Command +
+ + + Purpose + Changes the structure of an existing table. + Syntax + ALTER TABLE <TableName> ADD [COLUMN] <FieldName> <FieldType> [(<nWidth> [, <nPrecision>])] [NULL | NOT NULL]
ALTER TABLE <TableName> ALTER [COLUMN] <FieldName> <FieldType> [(<nWidth> [, <nPrecision>])] [NULL | NOT NULL]
ALTER TABLE <TableName> DROP [COLUMN] <FieldName>
+ Arguments + ADD [COLUMN]Adds a new field to the table. + ALTER [COLUMN]Changes the type, size or NULL setting of an existing field. + DROP [COLUMN]Removes a field from the table. + Remarks + 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 CREATE TABLE. + NOT SUPPORTED AT THIS MOMENT: 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. + + See Also + CREATE TABLE + +
diff --git a/docs/Help/Topics/command_ASSERT.xml b/docs/Help/Topics/command_ASSERT.xml new file mode 100644 index 0000000000..968a3b3eff --- /dev/null +++ b/docs/Help/Topics/command_ASSERT.xml @@ -0,0 +1,33 @@ + + + + ASSERT Command + + Commands + Debugging + ASSERT command + + +
+ ASSERT Command +
+ + + Purpose + Displays a message box when the specified expression evaluates to FALSE. + Syntax + ASSERT <lExpression> [MESSAGE <cMessageText>] + Arguments + <lExpression>The expression that is evaluated. Nothing happens when the expression returns TRUE. + MESSAGE <cMessageText>The text that is displayed in the message box. When this clause is omitted, the text of the expression is displayed. + Remarks + ASSERT only does something when SET ASSERTS 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. + When the compiler define NOASSERT is declared, the ASSERT commands are removed from the code by the preprocessor. + Examples + SET ASSERTS ON
+ASSERT nCount > 0 MESSAGE "The count must be positive"
+ + See Also + SET ASSERTS + +
diff --git a/docs/Help/Topics/command_CAST_AS.xml b/docs/Help/Topics/command_CAST_AS.xml new file mode 100644 index 0000000000..22a59a4453 --- /dev/null +++ b/docs/Help/Topics/command_CAST_AS.xml @@ -0,0 +1,49 @@ + + + + CAST AS Command + + Commands + Conversion + CAST command + + +
+ CAST ... AS +
+ + + Purpose + 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. + Syntax + CAST ( <eExpression> AS <Type> [(<nWidth> [, <nPrecision>])] [NULL | NOT NULL] )
CAST ( <eExpression> AS ( <cTypeExpression> ) [NULL | NOT NULL] )
+ Arguments + <eExpression>The expression to convert. + <Type>The target type, as a single letter or as a name:
+C, CHAR, CHARACTER: Character (padded with spaces to the width)
+V, VARCHAR: Varchar (truncated to the width, but not padded)
+N, NUM, NUMERIC and F, FLOAT: Numeric and Float
+I, INT, INTEGER: Integer
+B, DOUBLE: Double
+Y, CURRENCY: Currency
+D, DATE: Date
+T, DATETIME: DateTime
+L, LOGICAL: Logical (a string that starts with T or Y gives TRUE, a number gives TRUE when it is not zero)
+M, MEMO: Memo
+G, GENERAL: General
+W, BLOB: Blob
+Q, VARBINARY: Varbinary (truncated to the width)
+The type is not case sensitive. A runtime error is generated when the expression cannot be converted to the target type.
+ <nWidth> [, <nPrecision>]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. + <cTypeExpression>An expression between parentheses that returns the type name, for example a variable. + NULL | NOT NULLAccepted for compatibility with the SQL syntax. The clause does not change the result. + Examples + ? CAST(123.456 AS C(10))
+? CAST("42" AS I)
+cType := "N"
+? CAST("3.14" AS (cType))
+ + See Also + CREATE TABLE + +
diff --git a/docs/Help/Topics/command_CHDIR.xml b/docs/Help/Topics/command_CHDIR.xml new file mode 100644 index 0000000000..aee3a2fec4 --- /dev/null +++ b/docs/Help/Topics/command_CHDIR.xml @@ -0,0 +1,29 @@ + + + + CHDIR Command + + Commands + Files and folders + CHDIR command + CD command + + +
+ CHDIR | CD Command +
+ + + Purpose + Changes the current folder. + Syntax + CHDIR | CD <FolderName> + Arguments + <FolderName>The name of the folder that must become the current folder. This may be a relative or a full path. The name may be specified with or without quotes. + Remarks + CD is a synonym for CHDIR. An error is generated when the folder does not exist. + + See Also + MKDIR, RMDIR, SET DEFAULT, CurDir() + +
diff --git a/docs/Help/Topics/command_CLOSE.xml b/docs/Help/Topics/command_CLOSE.xml index e69e581286..1d236d14ec 100644 --- a/docs/Help/Topics/command_CLOSE.xml +++ b/docs/Help/Topics/command_CLOSE.xml @@ -38,6 +38,7 @@ CLOSE with no option closes the current database and associated files. A number of other operations close files as a side effect, but it is always a good idea to explicitly close files when you are finished using them. See Also + FoxPro versions: CLOSE DATABASES, CLOSE TABLES DBCloseArea(), FClose(), SET INDEX, USE diff --git a/docs/Help/Topics/command_CLOSE_DATABASES.xml b/docs/Help/Topics/command_CLOSE_DATABASES.xml new file mode 100644 index 0000000000..60143b5d6d --- /dev/null +++ b/docs/Help/Topics/command_CLOSE_DATABASES.xml @@ -0,0 +1,29 @@ + + + + CLOSE DATABASES Command + + Commands + Databases + CLOSE DATABASES command + + +
+ CLOSE DATABASES Command +
+ + + Purpose + Closes databases and the tables that are open in the current data session. This is the FoxPro dialect version of CLOSE DATABASES. + Syntax + CLOSE DATABASES [ALL] + Arguments + ALLCloses all open databases, including the current database, and all tables, indexes and format files in all work areas of the current data session. + Remarks + Without the ALL clause the current database is closed, and there will be no current database afterwards. If there is no current database, then all free tables in the current data session are closed. + In both cases all work areas are closed and work area 1 is selected afterwards. Please note that without the ALL clause, X# closes all work areas, also the work areas with tables that do not belong to the current database. In Visual FoxPro only the tables of the current database are closed. + + See Also + CLOSE, CLOSE TABLES, OPEN DATABASE, SET DATABASE TO + +
diff --git a/docs/Help/Topics/command_CLOSE_TABLES.xml b/docs/Help/Topics/command_CLOSE_TABLES.xml new file mode 100644 index 0000000000..f5a84c4265 --- /dev/null +++ b/docs/Help/Topics/command_CLOSE_TABLES.xml @@ -0,0 +1,28 @@ + + + + CLOSE TABLES Command + + Commands + Databases + CLOSE TABLES command + + +
+ CLOSE TABLES Command +
+ + + Purpose + Closes all open tables, but leaves the open databases open. + Syntax + CLOSE TABLES [ALL] + Arguments + ALLCloses the tables of all open databases and all free tables. + Remarks + Open databases remain open. All work areas of the current data session are closed and work area 1 is selected afterwards. Please note that X# closes all work areas, also when the ALL clause is omitted. In Visual FoxPro only the tables of the current database are closed in that case. + + See Also + CLOSE, CLOSE DATABASES, USE + +
diff --git a/docs/Help/Topics/command_COPY_MEMO.xml b/docs/Help/Topics/command_COPY_MEMO.xml new file mode 100644 index 0000000000..00f3c46066 --- /dev/null +++ b/docs/Help/Topics/command_COPY_MEMO.xml @@ -0,0 +1,33 @@ + + + + COPY MEMO Command + + Commands + Memo fields + COPY MEMO command + + +
+ COPY MEMO Command +
+ + + Purpose + Copies the contents of a memo field of the current record to a file. + Syntax + COPY MEMO <MemoField> TO <FileName> [ADDITIVE] [AS <nCodePage>] + Arguments + <MemoField>The name of the memo field in the current work area. + TO <FileName>The name of the file that receives the contents of the memo field. + ADDITIVEAppends the contents to the end of the file when it already exists. Without this clause an existing file is overwritten. + AS <nCodePage>The code page of the text that is written to the file. When this clause is omitted, the text is written without conversion. + Examples + USE Customers
+COPY MEMO Notes TO CustomerNotes.txt
+COPY MEMO Notes TO AllNotes.txt ADDITIVE
+ + See Also + REPLACE (FoxPro), DbCopyMemo() + +
diff --git a/docs/Help/Topics/command_COPY_STRUCTURE_EXTENDED_FoxPro.xml b/docs/Help/Topics/command_COPY_STRUCTURE_EXTENDED_FoxPro.xml new file mode 100644 index 0000000000..3487777b5c --- /dev/null +++ b/docs/Help/Topics/command_COPY_STRUCTURE_EXTENDED_FoxPro.xml @@ -0,0 +1,29 @@ + + + + COPY STRUCTURE EXTENDED Command (FoxPro) + + Commands + Tables + COPY STRUCTURE EXTENDED command + COPY STRUCTURE EXTENDED commandFoxPro + + +
+ COPY STRUCTURE EXTENDED Command  (FoxPro) +
+ + Purpose + Creates a table that contains the structure of the current table as data: one record for each field. This is the FoxPro version of the COPY STRUCTURE EXTENDED command. + Syntax + COPY [STRUCTURE] EXTENDED TO <TableName> [DATABASE <DbName> [NAME <LongTableName>]] + Arguments + TO <TableName>The name of the new table. This table has the fields that describe a field of the original table (name, type, width, decimals and so on). + DATABASE <DbName> [NAME <LongTableName>]Adds the new table to the specified database. The NAME clause specifies the long name of the table in that database. + Remarks + The keywords STRUCTURE and EXTENDED may be used in the order shown, but the STRUCTURE keyword is optional. You can use the resulting table to create a new table with CREATE FROM. + + See Also + COPY STRUCTURE EXTENDED, COPY STRUCTURE (FoxPro), DbCopyXStructFox(), DbCopyXStruct() + +
diff --git a/docs/Help/Topics/command_COPY_STRUCTURE_FoxPro.xml b/docs/Help/Topics/command_COPY_STRUCTURE_FoxPro.xml new file mode 100644 index 0000000000..469561fb1a --- /dev/null +++ b/docs/Help/Topics/command_COPY_STRUCTURE_FoxPro.xml @@ -0,0 +1,35 @@ + + + + COPY STRUCTURE Command (FoxPro) + + Commands + Tables + COPY STRUCTURE command + COPY STRUCTURE commandFoxPro + + +
+ COPY STRUCTURE Command  (FoxPro) +
+ + Purpose + Creates a new, empty table with the same structure as the current table, using the FoxPro syntax. This is the FoxPro version of the COPY STRUCTURE command. + Syntax + COPY STRUCTURE TO <TableName>
  [FIELDS <FieldList> | FIELDS LIKE <Skeleton> | FIELDS EXCEPT <Skeleton>]
  [WITH CDX | WITH PRODUCTION]
  [DATABASE <DbName> [NAME <LongTableName>]]
+ Arguments + TO <TableName>The name of the new table. + + WITH CDX | WITH PRODUCTIONAlso copies the tags from the production index file (CDX) of the current table to a new CDX file for the new table. + DATABASE <DbName> [NAME <LongTableName>]Adds the new table to the specified database. The NAME clause specifies the long name of the table in that database. + Remarks + The new table is created but not opened. The structure of the new table can only contain the fields that are selected with the FIELDS clause. + Examples + USE Customers
+COPY STRUCTURE TO CustomersEmpty WITH CDX
+COPY STRUCTURE TO Names FIELDS LastName, FirstName
+ + See Also + COPY STRUCTURE, COPY STRUCTURE EXTENDED (FoxPro), COPY TO (FoxPro), DbCopyStructFox() + +
diff --git a/docs/Help/Topics/command_COUNT.xml b/docs/Help/Topics/command_COUNT.xml index 3a4ce026a5..db2344479b 100644 --- a/docs/Help/Topics/command_COUNT.xml +++ b/docs/Help/Topics/command_COUNT.xml @@ -34,6 +34,7 @@ USE branch INDEX branch NEW
SEEK 100
USE sales INDEX salesbranch NEW
SEEK 100
COUNT TO Branch->Count WHILE Sales->Branch = 100
See Also + FoxPro version: COUNT (FoxPro) AVERAGE, DBEval(), SUM, TOTAL diff --git a/docs/Help/Topics/command_COUNT_FoxPro.xml b/docs/Help/Topics/command_COUNT_FoxPro.xml new file mode 100644 index 0000000000..3a48daa7c5 --- /dev/null +++ b/docs/Help/Topics/command_COUNT_FoxPro.xml @@ -0,0 +1,37 @@ + + + + COUNT Command (FoxPro) + + Commands + Records + COUNT command + COUNT commandFoxPro + + +
+ COUNT Command  (FoxPro) +
+ + Purpose + Counts the records in the current table that match the specified conditions. This is the FoxPro version of the COUNT command. + Syntax + COUNT [<Scope>] [FOR <lCondition>] [WHILE <lCondition>] [NOOPTIMIZE] [TO <Variable>] + Arguments + + + + NOOPTIMIZEDisables the optimization of the FOR clause. This clause is accepted for compatibility. + TO <Variable>The variable that receives the number of records. In FoxPro the TO clause is optional. It may be placed directly after COUNT or at the end of the command. + Remarks + The number of matching records is always stored in the variable _TALLY, also when the TO clause is omitted. This is different from the standard version of COUNT, where the TO clause is required. + Examples + USE Customers
+COUNT FOR Country = "NL" TO nDutch
+COUNT
+? _TALLY
+ + See Also + COUNT, SUM, AVERAGE, DbEval() + +
diff --git a/docs/Help/Topics/command_CREATE_CONNECTION.xml b/docs/Help/Topics/command_CREATE_CONNECTION.xml new file mode 100644 index 0000000000..13d774995b --- /dev/null +++ b/docs/Help/Topics/command_CREATE_CONNECTION.xml @@ -0,0 +1,33 @@ + + + + CREATE CONNECTION Command + + Commands + Databases + CREATE CONNECTION command + + +
+ CREATE CONNECTION Command +
+ + + Purpose + Creates a named connection and stores it in the current database. + Syntax + CREATE CONNECTION <ConnectionName>
  [DATASOURCE <DataSourceName>] [USERID <UserId>] [PASSWORD <Password>] [DATABASE <DbName>]

CREATE CONNECTION <ConnectionName> CONNSTRING <ConnectionString>
+ Arguments + <ConnectionName>The name of the connection. + DATASOURCE <DataSourceName>The name of the data source that the connection uses. + USERID <UserId>The user id that is used to log in to the data source. + PASSWORD <Password>The password that is used to log in to the data source. + DATABASE <DbName>The name of the database on the data source server. + CONNSTRING <ConnectionString>A complete connection string. It cannot be combined with the other clauses. + Remarks + The names and strings may be specified with or without quotes. The command is translated by the preprocessor to a call to the CreateConnection() method of the XSharp.RDD.Dbc class. + + See Also + DELETE CONNECTION, CREATE DATABASE + +
diff --git a/docs/Help/Topics/command_CREATE_CURSOR.xml b/docs/Help/Topics/command_CREATE_CURSOR.xml new file mode 100644 index 0000000000..beb9e99378 --- /dev/null +++ b/docs/Help/Topics/command_CREATE_CURSOR.xml @@ -0,0 +1,30 @@ + + + + CREATE CURSOR Command + + Commands + SQL + CREATE CURSOR command + + +
+ CREATE CURSOR Command +
+ + + Purpose + Creates a temporary table (cursor) and opens it in the next available work area. + Syntax + CREATE CURSOR <Alias> ( <FieldName> <FieldType> [(<nWidth> [, <nPrecision>])] [NULL | NOT NULL] [AUTOINC [NEXTVALUE <n1>] [STEP <n2>]] [, ...] )

CREATE CURSOR <Alias> FROM ARRAY <ArrayName>
+ Arguments + <Alias>The alias of the cursor. + <FieldName> <FieldType>The fields of the cursor. See CREATE TABLE for a description of the field types and the field clauses. + FROM ARRAY <ArrayName>Creates the cursor from a structure array, like the one that is returned by AFields(). + Remarks + A cursor is a normal table that is opened exclusively and that is marked as temporary. The file is removed when the cursor is closed. A cursor is never part of a database. + + See Also + CREATE TABLE, USE (FoxPro) + +
diff --git a/docs/Help/Topics/command_CREATE_DATABASE.xml b/docs/Help/Topics/command_CREATE_DATABASE.xml new file mode 100644 index 0000000000..54aa5c16d5 --- /dev/null +++ b/docs/Help/Topics/command_CREATE_DATABASE.xml @@ -0,0 +1,28 @@ + + + + CREATE DATABASE Command + + Commands + Databases + CREATE DATABASE command + + +
+ CREATE DATABASE Command +
+ + + Purpose + Creates a new database container (DBC) and opens it for exclusive use. + Syntax + CREATE DATABASE <DbName> + Arguments + <DbName>The name of the database to create. The default extension is .DBC. + Remarks + The new database becomes the current database. The command is translated by the preprocessor to a call to the Create() method of the XSharp.RDD.Dbc class. + + See Also + DELETE DATABASE, OPEN DATABASE, SET DATABASE TO + +
diff --git a/docs/Help/Topics/command_CREATE_TABLE.xml b/docs/Help/Topics/command_CREATE_TABLE.xml new file mode 100644 index 0000000000..c234569127 --- /dev/null +++ b/docs/Help/Topics/command_CREATE_TABLE.xml @@ -0,0 +1,41 @@ + + + + CREATE TABLE Command + + Commands + SQL + CREATE TABLE command + CREATE DBF command + + +
+ CREATE TABLE Command +
+ + + Purpose + Creates a table (DBF file) with the specified fields, using the SQL syntax of Visual FoxPro. CREATE DBF is a synonym for CREATE TABLE. + Syntax + CREATE TABLE | DBF <TableName> [NAME <LongTableName>] [FREE] [CODEPAGE = <nCodePage>]
  ( <FieldName> <FieldType> [(<nWidth> [, <nPrecision>])]
    [NULL | NOT NULL] [CHECK <lExpression> [ERROR <cMessage>]]
    [DEFAULT <eExpression>] [AUTOINC [NEXTVALUE <n1>] [STEP <n2>]]
    [PRIMARY KEY | UNIQUE] [NOCPTRANS]
  [, <FieldName2> ...] )

CREATE TABLE | DBF <TableName> [NAME <LongTableName>] [FREE] [CODEPAGE = <nCodePage>] FROM ARRAY <ArrayName>
+ Arguments + <TableName>The name of the table to create. The default extension is .DBF. + NAME <LongTableName>A long name for the table in the current database. + FREECreates a free table: the table is not added to the current database, even when a database is open. + CODEPAGE = <nCodePage>The code page for the new table. + <FieldName> <FieldType>The name and type of the field. Valid types include C (Character), N (Numeric), F (Float), I (Integer), B (Double), Y (Currency), D (Date), T (DateTime), L (Logical), M (Memo), G (General), W (Blob) and Q (Varbinary). The width and precision are only needed for the types that have a variable size (C, N and F). + NULL | NOT NULLAllows or disallows NULL values in the field. + CHECK, DEFAULTThe validation rule and default value of the field. These are stored in the database container and are only used when the table is part of a database. + AUTOINC [NEXTVALUE n1] [STEP n2]Makes the field an auto increment field. NEXTVALUE is the first value (default 1) and STEP is the increment (default 1). + FROM ARRAY <ArrayName>Creates the table with the structure that is described in an array. The array has the same layout as the array that is returned by AFields(). + Remarks + After the table has been created it stays open in the current work area. When a database is open, then the table is added to the database, unless the FREE clause is used. Field names are limited to 10 characters in a free table. When two field names have the same first 10 characters then the names are made unique by replacing the last character(s) with a number. + The primary key, foreign key, REFERENCES and similar clauses are parsed but they are only used when the table is part of a database container. + NOT SUPPORTED AT THIS MOMENT: Creating a table with an AS SELECT clause. + Examples + CREATE TABLE Customers (Id I AUTOINC, Name C(40) NOT NULL, Birthday D NULL, Notes M) + + See Also + ALTER TABLE, CREATE CURSOR, ADD TABLE, CREATE + +
diff --git a/docs/Help/Topics/command_DELETE_CONNECTION.xml b/docs/Help/Topics/command_DELETE_CONNECTION.xml new file mode 100644 index 0000000000..75df4c8d1c --- /dev/null +++ b/docs/Help/Topics/command_DELETE_CONNECTION.xml @@ -0,0 +1,28 @@ + + + + DELETE CONNECTION Command + + Commands + Databases + DELETE CONNECTION command + + +
+ DELETE CONNECTION Command +
+ + + Purpose + Deletes a named connection from the current database. + Syntax + DELETE CONNECTION <ConnectionName> + Arguments + <ConnectionName>The name of the connection that must be deleted. + Remarks + The command is translated by the preprocessor to a call to the DeleteConnection() method of the XSharp.RDD.Dbc class. + + See Also + CREATE CONNECTION, DELETE + +
diff --git a/docs/Help/Topics/command_DELETE_DATABASE.xml b/docs/Help/Topics/command_DELETE_DATABASE.xml new file mode 100644 index 0000000000..a1c89621a3 --- /dev/null +++ b/docs/Help/Topics/command_DELETE_DATABASE.xml @@ -0,0 +1,30 @@ + + + + DELETE DATABASE Command + + Commands + Databases + DELETE DATABASE command + + +
+ DELETE DATABASE Command +
+ + + Purpose + Deletes a database container (DBC) from disk. + Syntax + DELETE DATABASE <DbName> [DELETETABLES] [RECYCLE] + Arguments + <DbName>The name of the database to delete. + DELETETABLESAlso deletes the tables (.DBF files) that belong to the database. Without this clause the tables are not deleted and become free tables. + RECYCLEMoves the deleted files to the Recycle Bin instead of deleting them permanently. + Remarks + The command is translated by the preprocessor to a call to the Delete() method of the XSharp.RDD.Dbc class. + + See Also + CREATE DATABASE, OPEN DATABASE, REMOVE TABLE + +
diff --git a/docs/Help/Topics/command_DELETE_FROM.xml b/docs/Help/Topics/command_DELETE_FROM.xml new file mode 100644 index 0000000000..2a3b8d04e5 --- /dev/null +++ b/docs/Help/Topics/command_DELETE_FROM.xml @@ -0,0 +1,32 @@ + + + + DELETE FROM Command + + Commands + SQL + DELETE FROM command + + +
+ DELETE FROM Command +
+ + + Purpose + Marks records in a table for deletion, using the SQL syntax. This is the SQL version of DELETE (FoxPro). + Syntax + DELETE FROM <TableName> [WHERE <lCondition>] + Arguments + <TableName>The table (or alias) from which the records are deleted. + WHERE <lCondition>Only records for which the condition is true are deleted. This is translated to the FOR clause of the DELETE command. + Remarks + The SQL command always works on the whole table, so without the WHERE clause all records are deleted. This is different from the DELETE command, which only deletes the current record by default. The records are only marked for deletion. Use PACK to remove them physically. The number of records that matched the condition is stored in the _TALLY variable. + NOT SUPPORTED AT THIS MOMENT: DELETE with a JOIN or a subselect. The compiler generates an error when this is used. + + Examples + DELETE FROM Customers WHERE Country == "NL" + See Also + DELETE, DELETE (FoxPro), RECALL, PACK, INSERT INTO + +
diff --git a/docs/Help/Topics/command_DELETE_FoxPro.xml b/docs/Help/Topics/command_DELETE_FoxPro.xml new file mode 100644 index 0000000000..d59bb888f9 --- /dev/null +++ b/docs/Help/Topics/command_DELETE_FoxPro.xml @@ -0,0 +1,39 @@ + + + + DELETE Command (FoxPro) + + Commands + Records + DELETE command + DELETE commandFoxPro + + +
+ DELETE Command  (FoxPro) +
+ + Purpose + Marks records for deletion, using the rules of the FoxPro dialect. This is the FoxPro version of the DELETE command. + Syntax + DELETE [<Scope>] [FOR <lCondition>] [WHILE <lCondition>] [NOOPTIMIZE] [IN <WorkArea> | <Alias>] + Arguments + + + + NOOPTIMIZEDisables the optimization of the FOR clause. This clause is accepted for compatibility. + + Remarks + The clauses can be specified in any order. Without a scope, FOR or WHILE clause only the current record is deleted. With a FOR clause the default scope is ALL. + DELETE only marks the records for deletion. The records remain in the table until PACK is executed. Use SET DELETED to hide the deleted records and RECALL to remove the deletion mark. + After the command has completed, the variable _TALLY contains the number of records that have been marked for deletion. Records that were already marked as deleted are not counted. + Examples + USE Customers
+DELETE FOR Country = "XX"
+DELETE NEXT 5 IN Customers
+? _TALLY
+ + See Also + DELETE, DELETE FROM, RECALL (FoxPro), PACK, SET DELETED, DbDelete(), DbEval() + +
diff --git a/docs/Help/Topics/command_INDEX_FoxPro.xml b/docs/Help/Topics/command_INDEX_FoxPro.xml new file mode 100644 index 0000000000..4d7fb0048b --- /dev/null +++ b/docs/Help/Topics/command_INDEX_FoxPro.xml @@ -0,0 +1,48 @@ + + + + INDEX Command (FoxPro) + + Commands + Indexes + INDEX command + INDEX commandFoxPro + + +
+ INDEX Command  (FoxPro) +
+ + Purpose + Creates an index (a tag in a compound index file, or a stand-alone index file), using the syntax of the FoxPro dialect. This is the FoxPro version of the INDEX command. + Syntax + INDEX ON <KeyExpression> [TAG <OrderName>] [TO | OF <IndexFile>]
  [FOR <lCondition>] [WHILE <lCondition>] [<Scope>]
  [UNIQUE | CANDIDATE] [ASCENDING | DESCENDING] [COMPACT] [BINARY <n>] [COLLATE <cCollation>]
  [USECURRENT] [ADDITIVE] [CUSTOM] [NOOPTIMIZE]
+ Arguments + ON <KeyExpression>The expression that defines the index key. + TAG <OrderName>The name of the tag (order) to create. + TO | OF <IndexFile>The name of the index file. TO creates a stand-alone index file when no TAG is specified. OF creates the tag in the specified compound index file. + + + + UNIQUEOnly the first record with a particular key value is included in the index. + CANDIDATECreates a candidate index: the key values must be unique. + ASCENDING | DESCENDINGThe order of the index. The default is ascending. + COMPACTCreates a compact index file. + BINARY <n>Creates the index with binary (ordinal) comparison of the key values. + COLLATE <cCollation>The collation sequence that is used for character keys. + USECURRENTUse the current order to limit the records that are put in the new index. + ADDITIVEKeeps the other open index files open when the new index is created. + CUSTOMCreates a custom (user maintained) index. + NOOPTIMIZEDisables the optimization of the FOR clause. + Remarks + In the FoxPro dialect the order name is specified with the TAG keyword and the index file with TO or OF. The command is translated to calls to OrdCondSet() and OrdCreate(). + Examples + USE Customers EXCLUSIVE
+INDEX ON UPPER(LastName) TAG LastName
+INDEX ON Id TAG Id CANDIDATE
+INDEX ON Country + City TAG CountryCity FOR !DELETED()
+ + See Also + INDEX, SET INDEX (FoxPro), SET ORDER, REINDEX, OrdCondSet(), OrdCreate() + +
diff --git a/docs/Help/Topics/command_INSERT_INTO.xml b/docs/Help/Topics/command_INSERT_INTO.xml new file mode 100644 index 0000000000..4fc8779c2a --- /dev/null +++ b/docs/Help/Topics/command_INSERT_INTO.xml @@ -0,0 +1,37 @@ + + + + INSERT INTO Command + + Commands + SQL + INSERT INTO command + + +
+ INSERT INTO Command +
+ + + Purpose + Appends a record to a table and fills it with values from expressions, memory variables, an array or an object. + Syntax + INSERT INTO <TableName> [(<FieldName1> [, <FieldName2> ...])] VALUES (<eExpression1> [, <eExpression2> ...])
INSERT INTO <TableName> FROM MEMVAR
INSERT INTO <TableName> FROM ARRAY <ArrayName>
INSERT INTO <TableName> FROM NAME <ObjectName>
+ Arguments + <TableName>The table to which the record is added. If the table is not open in any work area, then it is opened, used for the insert and closed again. + (<FieldName1>, ...)The fields that receive a value. If the field list is omitted the values are stored in the fields in field order. + VALUES (<eExpression1>, ...)The values for the fields. The values are converted to the type of the field when possible. + FROM MEMVARTakes the values from memory variables that have the same names as the fields. Fields without a variable with the same name are not changed. + FROM ARRAY <ArrayName>Takes the values from the elements of the array, starting with the first element for the first field. + FROM NAME <ObjectName>Takes the values from properties of the object that have the same names as the fields. + Remarks + NOT SUPPORTED AT THIS MOMENT: The INSERT INTO ... SELECT variation. The compiler generates an error when it is used. + + Examples + INSERT INTO Customers (Id, Name) VALUES (1, "Smith")
+LOCAL oCustomer := TestObject{} AS OBJECT
+INSERT INTO Customers FROM NAME oCustomer
+ See Also + APPEND BLANK, GATHER, UPDATE, DELETE FROM + +
diff --git a/docs/Help/Topics/command_MKDIR.xml b/docs/Help/Topics/command_MKDIR.xml new file mode 100644 index 0000000000..8096d1e509 --- /dev/null +++ b/docs/Help/Topics/command_MKDIR.xml @@ -0,0 +1,34 @@ + + + + MKDIR Command + + Commands + Files and folders + MKDIR command + MD command + + +
+ MKDIR | MD Command +
+ + + Purpose + Creates a new folder. + Syntax + MKDIR | MD <FolderName> + Arguments + <FolderName>The name of the folder to create. This may be a relative or a full path. Missing parent folders are also created. The name may be specified with or without quotes. + Remarks + MD is a synonym for MKDIR. An error is generated when the folder cannot be created. + Examples + MKDIR C:\Temp\Test
+CHDIR C:\Temp\Test
+CD ..
+RMDIR C:\Temp\Test
+ + See Also + CHDIR, RMDIR, DIR + +
diff --git a/docs/Help/Topics/command_OPEN_DATABASE.xml b/docs/Help/Topics/command_OPEN_DATABASE.xml new file mode 100644 index 0000000000..f862249022 --- /dev/null +++ b/docs/Help/Topics/command_OPEN_DATABASE.xml @@ -0,0 +1,33 @@ + + + + OPEN DATABASE Command + + Commands + Databases + OPEN DATABASE command + + +
+ OPEN DATABASE Command +
+ + + Purpose + Opens a database container (DBC). + Syntax + OPEN DATABASE <DbName> [EXCLUSIVE | SHARED] [NOUPDATE] [VALIDATE] + Arguments + <DbName>The name of the database to open. The default extension is .DBC. + EXCLUSIVEOpens the database for exclusive use. + SHAREDOpens the database for shared use. This is the default when neither EXCLUSIVE nor SHARED is specified. + NOUPDATEOpens the database read-only: the database cannot be modified. + VALIDATEChecks that the tables and indexes that are referenced in the database are available and valid. + Remarks + Opening a database does not make it the current database. Use SET DATABASE TO to select the current database. + The command is translated by the preprocessor to a call to the Open() method of the XSharp.RDD.Dbc class. + + See Also + CLOSE DATABASES, CREATE DATABASE, DELETE DATABASE, SET DATABASE TO + +
diff --git a/docs/Help/Topics/command_RECALL_FoxPro.xml b/docs/Help/Topics/command_RECALL_FoxPro.xml new file mode 100644 index 0000000000..9100f9079e --- /dev/null +++ b/docs/Help/Topics/command_RECALL_FoxPro.xml @@ -0,0 +1,38 @@ + + + + RECALL Command (FoxPro) + + Commands + Records + RECALL command + RECALL commandFoxPro + + +
+ RECALL Command  (FoxPro) +
+ + Purpose + Removes the deletion mark from records, using the rules of the FoxPro dialect. This is the FoxPro version of the RECALL command. + Syntax + RECALL [<Scope>] [FOR <lCondition>] [WHILE <lCondition>] [NOOPTIMIZE] [IN <WorkArea> | <Alias>] + Arguments + + + + NOOPTIMIZEDisables the optimization of the FOR clause. This clause is accepted for compatibility. + + Remarks + The clauses can be specified in any order. Without a scope, FOR or WHILE clause only the current record is recalled. With a FOR clause the default scope is ALL. + RECALL also visits the deleted records when SET DELETED is ON, so records that are hidden by SET DELETED can still be recalled. + After the command has completed, the variable _TALLY contains the number of records for which the deletion mark was removed. Records that were not deleted are not counted. + Examples + USE Customers
+RECALL ALL
+RECALL FOR Country = "NL" IN Customers
+ + See Also + RECALL, DELETE (FoxPro), PACK, SET DELETED, DbRecall(), DbEval() + +
diff --git a/docs/Help/Topics/command_REMOVE_TABLE.xml b/docs/Help/Topics/command_REMOVE_TABLE.xml new file mode 100644 index 0000000000..9ad098116f --- /dev/null +++ b/docs/Help/Topics/command_REMOVE_TABLE.xml @@ -0,0 +1,30 @@ + + + + REMOVE TABLE Command + + Commands + Databases + REMOVE TABLE command + + +
+ REMOVE TABLE Command +
+ + + Purpose + Removes a table from the current database. The table becomes a free table, or is deleted from disk. + Syntax + REMOVE TABLE <TableName> [DELETE | RECYCLE] + Arguments + <TableName>The name of the table in the current database. + DELETEDeletes the table file (and its memo and index files) from disk after it has been removed from the database. + RECYCLEIntended to move the files to the Recycle Bin. At this moment the files are deleted permanently, just like with the DELETE clause. RECYCLE IS NOT FULLY SUPPORTED AT THIS MOMENT + Remarks + Without the DELETE and RECYCLE clauses the table file remains on disk as a free table. + + See Also + ADD TABLE, RENAME TABLE, DELETE DATABASE + +
diff --git a/docs/Help/Topics/command_RENAME_TABLE.xml b/docs/Help/Topics/command_RENAME_TABLE.xml new file mode 100644 index 0000000000..a077410692 --- /dev/null +++ b/docs/Help/Topics/command_RENAME_TABLE.xml @@ -0,0 +1,29 @@ + + + + RENAME TABLE Command + + Commands + Databases + RENAME TABLE command + + +
+ RENAME TABLE Command +
+ + + Purpose + Changes the name of a table in the current database. + Syntax + RENAME TABLE <OldName> TO <NewName> + Arguments + <OldName>The current (logical) name of the table in the database. + <NewName>The new (logical) name of the table. + Remarks + This command only changes the name of the table inside the database container. The physical .DBF file is not renamed. To rename a file, use RENAME. + + See Also + ADD TABLE, RENAME, REMOVE TABLE + +
diff --git a/docs/Help/Topics/command_REPLACE_FoxPro.xml b/docs/Help/Topics/command_REPLACE_FoxPro.xml new file mode 100644 index 0000000000..d6828418c9 --- /dev/null +++ b/docs/Help/Topics/command_REPLACE_FoxPro.xml @@ -0,0 +1,42 @@ + + + + REPLACE Command (FoxPro) + + Commands + Fields + REPLACE command + REPLACE commandFoxPro + + +
+ REPLACE Command  (FoxPro) +
+ + Purpose + Replaces the contents of fields with new values, using the rules of the FoxPro dialect. This is the FoxPro version of the REPLACE command. + Syntax + REPLACE <Field1> WITH <eExpression1> [ADDITIVE] [, <Field2> WITH <eExpression2> ...]
  [<Scope>] [FOR <lCondition>] [WHILE <lCondition>] [NOOPTIMIZE]
  [IN <WorkArea> | <Alias>]
+ Arguments + <Field> WITH <eExpression>The field that must be changed and the expression with the new value. You can specify multiple fields, separated by commas. + ADDITIVEAppends the value to the existing contents of a memo field instead of replacing it. This clause can be used with a single field. + + + + NOOPTIMIZEDisables the optimization of the FOR clause. This clause is accepted for compatibility. + + Remarks + When you do not specify a scope, FOR or WHILE clause, then REPLACE changes the current record only. With one of these clauses the default scope is ALL. The differences with the standard command are the ADDITIVE and IN clauses, and the fact that the variable _TALLY is set (see below). + After the command has completed, the variable _TALLY contains the number of records that were processed (1 for the single record form). + The records are locked automatically when needed, and unlocked after the field has been changed. + Examples + USE Customers
+GO 10
+REPLACE Name WITH "Smith", Active WITH .T.
+REPLACE ALL Country WITH "NL" FOR City = "Amsterdam" IN Customers
+REPLACE Notes WITH "Called today" ADDITIVE
+ + See Also + REPLACE, UPDATE, DbEval(), DbAutoLock(), DbAutoUnLock() + +
diff --git a/docs/Help/Topics/command_RMDIR.xml b/docs/Help/Topics/command_RMDIR.xml new file mode 100644 index 0000000000..bde9cd79f4 --- /dev/null +++ b/docs/Help/Topics/command_RMDIR.xml @@ -0,0 +1,29 @@ + + + + RMDIR Command + + Commands + Files and folders + RMDIR command + RD command + + +
+ RMDIR | RD Command +
+ + + Purpose + Removes an empty folder. + Syntax + RMDIR | RD <FolderName> + Arguments + <FolderName>The name of the folder to remove. The name may be specified with or without quotes. + Remarks + RD is a synonym for RMDIR. The folder must be empty: the command does not remove the files and sub folders inside the folder. An error is generated when the folder cannot be removed. + + See Also + MKDIR, CHDIR, DIR + +
diff --git a/docs/Help/Topics/command_SAVE.xml b/docs/Help/Topics/command_SAVE.xml index 4753c51c46..b18b3db657 100644 --- a/docs/Help/Topics/command_SAVE.xml +++ b/docs/Help/Topics/command_SAVE.xml @@ -19,7 +19,7 @@ Purpose Copy public and private memory variables visible within the current routine to a disk file. Syntax - SAVE TO <xcTargetFile> [ALL [LIKE | EXCEPT <Skeleton>] + SAVE TO <xcTargetFile> [ALL [LIKE | EXCEPT <Skeleton>]]
SAVE ALL LIKE | EXCEPT <Skeleton> TO <xcTargetFile>
Arguments <xcTargetFile>The name of the file, including an optional drive, directory, and extension. See SetDefault() and SetPath() for file searching and creation rules. The default extension is .MEM. diff --git a/docs/Help/Topics/command_SCAN.xml b/docs/Help/Topics/command_SCAN.xml new file mode 100644 index 0000000000..d46883dc50 --- /dev/null +++ b/docs/Help/Topics/command_SCAN.xml @@ -0,0 +1,38 @@ + + + + SCAN ... ENDSCAN Command + + Commands + Records + SCAN command + ENDSCAN command + + +
+ SCAN ... ENDSCAN Command +
+ + + Purpose + Moves through the records of the current table and executes a block of statements for each record that matches the specified conditions. + Syntax + SCAN [<Scope>] [FOR <lCondition>] [WHILE <lCondition>] [NOOPTIMIZE]
  <Statements>
ENDSCAN
+ Arguments + + + + NOOPTIMIZEDisables the optimization of the FOR clause. This clause is accepted for compatibility. + Remarks + SCAN locates the first record that matches the conditions and then executes the statements. At the ENDSCAN statement the next record that matches the conditions is located and the statements are executed again, until there are no more matching records. You do not have to move the record pointer in the loop, because ENDSCAN does that for you. END SCAN is a synonym for ENDSCAN. + The command is translated by the preprocessor to a DbLocate() call, followed by a DO WHILE Found() loop that ends with DbContinue(). The scan therefore follows the same rules as LOCATE and CONTINUE. Do not use LOCATE or CONTINUE for the same work area inside the loop, because that would change the state of the scan. + Examples + USE Customers
+SCAN FOR Country = "NL"
+  ? Name
+ENDSCAN
+ + See Also + LOCATE, CONTINUE, DbLocate(), DbContinue(), Found() + +
diff --git a/docs/Help/Topics/command_SEEK_FoxPro.xml b/docs/Help/Topics/command_SEEK_FoxPro.xml new file mode 100644 index 0000000000..da982676a0 --- /dev/null +++ b/docs/Help/Topics/command_SEEK_FoxPro.xml @@ -0,0 +1,37 @@ + + + + SEEK Command (FoxPro) + + Commands + Indexes + SEEK command + SEEK commandFoxPro + + +
+ SEEK Command  (FoxPro) +
+ + Purpose + Searches an indexed table for the first record whose index key matches the specified expression, optionally using a different order. This is the FoxPro version of the SEEK command. + Syntax + SEEK <eExpression> [ORDER [TAG] <OrderName> [OF <IndexFile>]] [ASCENDING | DESCENDING] [IN <WorkArea> | <Alias>] + Arguments + <eExpression>The value to search for. + ORDER [TAG] <OrderName> [OF <IndexFile>]The order that is used for the search. The order that was active before the command was executed is restored afterwards. + ASCENDING | DESCENDINGThe direction of the order that is used for the search. + + Remarks + After the command the function Found() returns TRUE when a matching record was found. When no matching record was found, then the record pointer is positioned at the end of the file (or at the next higher key when SET SOFTSEEK is ON). + Examples + USE Customers
+SEEK "Smith" ORDER TAG LastName
+IF Found()
+  ? Name
+ENDIF
+ + See Also + SEEK, SET ORDER, SET SOFTSEEK, DbSeekFox(), Found() + +
diff --git a/docs/Help/Topics/command_SET_ANSI_FoxPro.xml b/docs/Help/Topics/command_SET_ANSI_FoxPro.xml new file mode 100644 index 0000000000..b78788d5e5 --- /dev/null +++ b/docs/Help/Topics/command_SET_ANSI_FoxPro.xml @@ -0,0 +1,28 @@ + + + + SET ANSI Command (FoxPro) + + Commands + SET commands + SET ANSI command + SET ANSI commandFoxPro + + +
+ SET ANSI Command  (FoxPro) +
+ + Purpose + Determines how strings of different lengths are compared in SQL commands. This is the FoxPro version of the SET ANSI command. + Syntax + SET ANSI ON | OFF | &<cMacro> + Arguments + ON | OFFON pads the shorter string with blanks before the comparison. OFF compares the strings up to the length of the shorter string. The value may also be a macro (&) that evaluates to ON or OFF. + Remarks + In the FoxPro dialect the command changes the SQL specific setting Set.SqlAnsi. The runtime does not use this setting at this moment. The generic SET ANSI command in the other dialects changes the setting Set.Ansi, which controls the use of the ANSI or OEM character set. + + See Also + SET ANSI, SET EXACT + +
diff --git a/docs/Help/Topics/command_SET_ASSERTS.xml b/docs/Help/Topics/command_SET_ASSERTS.xml new file mode 100644 index 0000000000..1cca585fd3 --- /dev/null +++ b/docs/Help/Topics/command_SET_ASSERTS.xml @@ -0,0 +1,26 @@ + + + + SET ASSERTS Command + + Commands + SET commands + SET ASSERTS command + + +
+ SET ASSERTS Command +
+ + + Purpose + Specifies whether the ASSERT commands are executed. + Syntax + SET ASSERTS ON | OFF | &<cMacro> + Arguments + ON | OFFON evaluates the ASSERT commands and displays a message when the condition is false. OFF ignores the ASSERT commands. The value may also be a macro (&) that evaluates to ON or OFF. + + See Also + ASSERT + +
diff --git a/docs/Help/Topics/command_SET_AUTOINCERROR.xml b/docs/Help/Topics/command_SET_AUTOINCERROR.xml new file mode 100644 index 0000000000..9b0f4fcd78 --- /dev/null +++ b/docs/Help/Topics/command_SET_AUTOINCERROR.xml @@ -0,0 +1,28 @@ + + + + SET AUTOINCERROR Command + + Commands + SET commands + SET AUTOINCERROR command + + +
+ SET AUTOINCERROR Command +
+ + + Purpose + Specifies whether an error is generated when a table with an auto-increment field is indexed with a tag that has a candidate or primary key. + Syntax + SET AUTOINCERROR ON | OFF | &<cMacro> + Arguments + ON | OFFON generates the error. OFF suppresses the error. The value may also be a macro (&) that evaluates to ON or OFF. + Remarks + The setting is stored in the runtime state, but the runtime does not use it at this moment. + + See Also + CREATE TABLE, ALTER TABLE + +
diff --git a/docs/Help/Topics/command_SET_BELL.xml b/docs/Help/Topics/command_SET_BELL.xml new file mode 100644 index 0000000000..870429f3ee --- /dev/null +++ b/docs/Help/Topics/command_SET_BELL.xml @@ -0,0 +1,29 @@ + + + + SET BELL Command + + Commands + SET commands + SET BELL command + + +
+ SET BELL Command +
+ + + Purpose + Enables or disables the bell that sounds when the user fills a field in a full-screen input, or enters invalid data. + Syntax + SET BELL ON | OFF | &<cMacro>
SET BELL TO [<Options>]
+ Arguments + ON | OFFEnables or disables the bell. The value may also be a macro (&) that evaluates to ON or OFF. + TO [<Options>]In Visual FoxPro this sets the frequency and duration of the bell. The command is accepted but ignored. + Remarks + The setting is also available with the function SetBeep(). + + See Also + SET CONFIRM, SetBeep() + +
diff --git a/docs/Help/Topics/command_SET_BLOCKSIZE.xml b/docs/Help/Topics/command_SET_BLOCKSIZE.xml new file mode 100644 index 0000000000..1be8143afa --- /dev/null +++ b/docs/Help/Topics/command_SET_BLOCKSIZE.xml @@ -0,0 +1,28 @@ + + + + SET BLOCKSIZE Command + + Commands + SET commands + SET BLOCKSIZE command + + +
+ SET BLOCKSIZE Command +
+ + + Purpose + Specifies how disk space is allocated for the storage of memo fields. + Syntax + SET BLOCKSIZE TO <nBytes> + Arguments + <nBytes>The size of the memo blocks. A value between 1 and 32 is the number of 512 byte blocks. Larger values are the number of bytes. The value 0 selects blocks of 1 byte. + Remarks + The setting is used when new tables with memo fields are created. The command is equivalent to SET MEMOBLOCKSIZE. + + See Also + SET MEMOBLOCKSIZE, CREATE TABLE + +
diff --git a/docs/Help/Topics/command_SET_COLLATE.xml b/docs/Help/Topics/command_SET_COLLATE.xml new file mode 100644 index 0000000000..0f250ea9c0 --- /dev/null +++ b/docs/Help/Topics/command_SET_COLLATE.xml @@ -0,0 +1,28 @@ + + + + SET COLLATE Command + + Commands + SET commands + SET COLLATE command + + +
+ SET COLLATE Command +
+ + + Purpose + Specifies the collation sequence that is used for the indexing and sorting of character fields. + Syntax + SET COLLATE TO <cCollationSequence> + Arguments + <cCollationSequence>The name of the collation sequence, for example "MACHINE" or "GENERAL". The name may be specified with or without quotes. + Remarks + The default value is "MACHINE". The value is stored in the runtime state. The runtime does not change the collation of the indexes based on this setting at this moment. Use SET COLLATION to select the collation table that is used by the runtime. + + See Also + SET COLLATION, INDEX (FoxPro) + +
diff --git a/docs/Help/Topics/command_SET_COMPATIBLE.xml b/docs/Help/Topics/command_SET_COMPATIBLE.xml new file mode 100644 index 0000000000..1796792342 --- /dev/null +++ b/docs/Help/Topics/command_SET_COMPATIBLE.xml @@ -0,0 +1,29 @@ + + + + SET COMPATIBLE Command + + Commands + SET commands + SET COMPATIBLE command + + +
+ SET COMPATIBLE Command +
+ + + Purpose + Controls compatibility with FoxBASE+ and other xBase languages. + Syntax + SET COMPATIBLE ON | OFF | FOXPLUS | DB4 | &<cMacro> + Arguments + ON | FOXPLUSEnables the compatibility mode. + OFF | DB4Disables the compatibility mode. + Remarks + The value is stored in the runtime state and can be read and changed with the function SetCompatible(). + + See Also + SET SAFETY, SetCompatible() + +
diff --git a/docs/Help/Topics/command_SET_CONFIRM.xml b/docs/Help/Topics/command_SET_CONFIRM.xml new file mode 100644 index 0000000000..a0711a8ce6 --- /dev/null +++ b/docs/Help/Topics/command_SET_CONFIRM.xml @@ -0,0 +1,28 @@ + + + + SET CONFIRM Command + + Commands + SET commands + SET CONFIRM command + + +
+ SET CONFIRM Command +
+ + + Purpose + Specifies whether the user must press Enter to leave a field in a full-screen input when the field is filled completely. + Syntax + SET CONFIRM ON | OFF | &<cMacro> + Arguments + ON | OFFON requires that the user presses Enter to leave the field. OFF moves the cursor to the next field automatically. The value may also be a macro (&) that evaluates to ON or OFF. + Remarks + The setting is stored in the runtime state, but the runtime does not use it at this moment. + + See Also + SET BELL, SET ESCAPE, SET CURSOR + +
diff --git a/docs/Help/Topics/command_SET_CURSOR.xml b/docs/Help/Topics/command_SET_CURSOR.xml new file mode 100644 index 0000000000..bb38e84084 --- /dev/null +++ b/docs/Help/Topics/command_SET_CURSOR.xml @@ -0,0 +1,28 @@ + + + + SET CURSOR Command + + Commands + SET commands + SET CURSOR command + + +
+ SET CURSOR Command +
+ + + Purpose + Specifies whether the cursor is displayed while the program waits for input. + Syntax + SET CURSOR ON | OFF | &<cMacro> + Arguments + ON | OFFON shows the cursor, OFF hides the cursor. The value may also be a macro (&) that evaluates to ON or OFF. + Remarks + The setting is stored in the runtime state, but the runtime does not use it at this moment. + + See Also + SET CONFIRM, SET ESCAPE + +
diff --git a/docs/Help/Topics/command_SET_DATABASE.xml b/docs/Help/Topics/command_SET_DATABASE.xml new file mode 100644 index 0000000000..1abb4ff881 --- /dev/null +++ b/docs/Help/Topics/command_SET_DATABASE.xml @@ -0,0 +1,29 @@ + + + + SET DATABASE Command + + Commands + Databases + SET DATABASE command + + +
+ SET DATABASE Command +
+ + + Purpose + Specifies the current database. + Syntax + SET DATABASE TO [<DbName>] + Arguments + <DbName>The name of an open database that must become the current database. If you omit the name, then there will be no current database. + Remarks + The database must have been opened with OPEN DATABASE or created with CREATE DATABASE. Commands such as ADD TABLE, REMOVE TABLE and RENAME TABLE work on the current database. + The command is translated by the preprocessor to a call to the Select() method of the XSharp.RDD.Dbc class. + + See Also + CLOSE DATABASES, CREATE DATABASE, OPEN DATABASE + +
diff --git a/docs/Help/Topics/command_SET_DATE.xml b/docs/Help/Topics/command_SET_DATE.xml index 7782e25a82..45f8ae59d2 100644 --- a/docs/Help/Topics/command_SET_DATE.xml +++ b/docs/Help/Topics/command_SET_DATE.xml @@ -18,6 +18,8 @@ Change the setting that determines the <%APP%> date format by selecting from a list of constants with corresponding date formats. Syntax SET DATE [TO] <kCountrySetting> + Arguments + kCountrySettingOne of the following keywords:
AMERICAN or MDY (MM/DD/YY)
ANSI (YY.MM.DD)
BRITISH or DMY (DD/MM/YY)
FRENCH (DD/MM/YY)
GERMAN (DD.MM.YY)
ITALIAN or DUTCH (DD-MM-YY)
JAPANESE, TAIWAN or YMD (YY/MM/DD)
USA (MM-DD-YY)
SYSTEM or WINDOWS (the format of the Windows regional settings)
A macro (&) that evaluates to a date format string, such as DD.MM.YYYY, is passed to SetDateFormat().
Description SET DATE is functionally equivalent to SetDateCountry().   Examples @@ -26,6 +28,7 @@ SET DATE German
? Today()// Result:  15.10.19
SET DATE Ansi
? Today()// Result:  19.10.15
See Also + FoxPro version: SET DATE (FoxPro) CToD(), DToC(), DToS(), SetCentury(), SetDateCountry(), SetDateFormat(), SetEpoch(), Today() diff --git a/docs/Help/Topics/command_SET_DATE_FoxPro.xml b/docs/Help/Topics/command_SET_DATE_FoxPro.xml new file mode 100644 index 0000000000..cc03cdfda6 --- /dev/null +++ b/docs/Help/Topics/command_SET_DATE_FoxPro.xml @@ -0,0 +1,32 @@ + + + + SET DATE Command (FoxPro) + + Commands + SET commands + SET DATE command + SET DATE commandFoxPro + + +
+ SET DATE Command  (FoxPro) +
+ + Purpose + Specifies the format that is used to display dates. This is the FoxPro version of the SET DATE command, which also accepts an expression. + Syntax + SET DATE [TO] <cDateFormat>
SET DATE [TO] (<cExpression>)
SET DATE [TO] <function>(<Arguments>)
SET DATE [TO] &<cMacro>
+ Arguments + <cDateFormat>One of the following keywords: AMERICAN, ANSI, BRITISH, DMY, FRENCH, GERMAN, ITALIAN, DUTCH, JAPAN, JAPANESE, TAIWAN, MDY, USA, YMD, SHORT, SYSTEM. SHORT uses the short date format of the operating system, like SYSTEM. The keyword LONG is not supported and generates an error. + (<cExpression>)An expression between parentheses, a function call or a macro (&) that returns a string with one of the keywords above, or a date picture such as "DD.MM.YYYY". + Remarks + The command calls the function SetDateCountry() for the keywords and SetDateFormat() for the date pictures. An error is generated when the value is not a string or is not a known keyword or date picture. + Examples + SET DATE TO GERMAN
+SET DATE TO ("DD/MM/YYYY")
+ + See Also + SET DATE, SET DATE FORMAT, SET CENTURY + +
diff --git a/docs/Help/Topics/command_SET_DECIMALS.xml b/docs/Help/Topics/command_SET_DECIMALS.xml index c9fee65bd5..204d288214 100644 --- a/docs/Help/Topics/command_SET_DECIMALS.xml +++ b/docs/Help/Topics/command_SET_DECIMALS.xml @@ -20,9 +20,9 @@ Syntax SET DECIMALS TO [<nDecimals>] Arguments - nDecimals Specifies the minimum number of decimal places to display, with a default of two. The maximum number is 18 decimal places, and the minimum is zero. + nDecimals Specifies the minimum number of decimal places to display. The maximum number is 18 decimal places, and the minimum is zero. When the value is omitted, 0 is used. Description - SET DECIMALS TO with no argument is equivalent to SET DECIMALS TO 0.  SET DECIMALS is functionally equivalent to SetDecimal().   + SET DECIMALS TO without a value is equivalent to SET DECIMALS TO 0. SET DECIMALS is functionally equivalent to SetDecimal(). See Also SetDecimal(), SetDecimalSep(), SetFixed(), diff --git a/docs/Help/Topics/command_SET_DELIMITERS.xml b/docs/Help/Topics/command_SET_DELIMITERS.xml new file mode 100644 index 0000000000..2f0fcc6fd9 --- /dev/null +++ b/docs/Help/Topics/command_SET_DELIMITERS.xml @@ -0,0 +1,30 @@ + + + + SET DELIMITERS Command + + Commands + SET commands + SET DELIMITERS command + + +
+ SET DELIMITERS Command +
+ + + Purpose + Specifies whether the delimiters are displayed around the fields of a full-screen input and which characters are used as delimiters. + Syntax + SET DELIMITERS ON | OFF | &<cMacro>
SET DELIMITERS TO [<cDelimiters> | DEFAULT]
+ Arguments + ON | OFFON displays the delimiters. OFF removes them. The value may also be a macro (&) that evaluates to ON or OFF. + TO <cDelimiters>The delimiter characters. When one character is specified, it is used for the left and right side. Two characters specify the left and right delimiter. + TO DEFAULTRestores the default delimiters (a colon on both sides). SET DELIMITERS TO without arguments does the same. + Remarks + The settings are stored in the runtime state, but the runtime does not use them at this moment. + + See Also + SET TEXTMERGE DELIMITERS, SET CONFIRM + +
diff --git a/docs/Help/Topics/command_SET_DEVICE.xml b/docs/Help/Topics/command_SET_DEVICE.xml new file mode 100644 index 0000000000..d6c0a32b7c --- /dev/null +++ b/docs/Help/Topics/command_SET_DEVICE.xml @@ -0,0 +1,30 @@ + + + + SET DEVICE Command + + Commands + SET commands + SET DEVICE command + + +
+ SET DEVICE Command +
+ + + Purpose + Directs the output of the @...SAY commands to the screen, to the printer or to a file. + Syntax + SET DEVICE TO SCREEN | PRINTER | &<cMacro>
SET DEVICE TO FILE <FileName>
+ Arguments + SCREENSends the output to the screen. + PRINTERSends the output to the printer. + FILE <FileName>Sends the output to the specified file. + Remarks + The setting is stored in the runtime state under Set.Device. The runtime checks for the value FILE when it writes the output of the devices. + + See Also + SET CONSOLE, SET ALTERNATE + +
diff --git a/docs/Help/Topics/command_SET_DIGITS.xml b/docs/Help/Topics/command_SET_DIGITS.xml index 06bfa2c617..33c293eda4 100644 --- a/docs/Help/Topics/command_SET_DIGITS.xml +++ b/docs/Help/Topics/command_SET_DIGITS.xml @@ -19,6 +19,8 @@ Changes the setting that determines the number of digits that will be shown to the left of the decimal point when a number is displayed. Syntax SET DIGITS TO [<nDigits>] + Arguments + nDigitsThe number of digits. When the value is omitted, 10 is used. Description SET DIGITS is functionally equivalent to SetDigit().   diff --git a/docs/Help/Topics/command_SET_DIRECTORY.xml b/docs/Help/Topics/command_SET_DIRECTORY.xml new file mode 100644 index 0000000000..5e4df7d2de --- /dev/null +++ b/docs/Help/Topics/command_SET_DIRECTORY.xml @@ -0,0 +1,28 @@ + + + + SET DIRECTORY Command + + Commands + SET commands + SET DIRECTORY command + + +
+ SET DIRECTORY Command +
+ + + Purpose + Specifies the default folder (and drive) that is used for file operations. + Syntax + SET DIRECTORY TO [<FolderName>] + Arguments + <FolderName>The name of the folder. The name may be specified with or without quotes. When the folder name is omitted the default folder is cleared. + Remarks + SET DIRECTORY TO is a synonym of SET DEFAULT TO. + + See Also + SET DEFAULT, SET PATH, CHDIR, SetDefault() + +
diff --git a/docs/Help/Topics/command_SET_ESCAPE.xml b/docs/Help/Topics/command_SET_ESCAPE.xml new file mode 100644 index 0000000000..94826a0881 --- /dev/null +++ b/docs/Help/Topics/command_SET_ESCAPE.xml @@ -0,0 +1,28 @@ + + + + SET ESCAPE Command + + Commands + SET commands + SET ESCAPE command + + +
+ SET ESCAPE Command +
+ + + Purpose + Specifies whether the user can interrupt a running program or command with the Esc key. + Syntax + SET ESCAPE ON | OFF | &<cMacro> + Arguments + ON | OFFON allows the user to interrupt the program with the Esc key. OFF disables this. The value may also be a macro (&) that evaluates to ON or OFF. + Remarks + The setting is stored in the runtime state, but the runtime does not use it at this moment. + + See Also + SET CONFIRM, SET CURSOR + +
diff --git a/docs/Help/Topics/command_SET_FULLPATH.xml b/docs/Help/Topics/command_SET_FULLPATH.xml new file mode 100644 index 0000000000..41f42f1d89 --- /dev/null +++ b/docs/Help/Topics/command_SET_FULLPATH.xml @@ -0,0 +1,28 @@ + + + + SET FULLPATH Command + + Commands + SET commands + SET FULLPATH command + + +
+ SET FULLPATH Command +
+ + + Purpose + Specifies whether functions such as DBF() and NDX() return the full path of a file or only its name. + Syntax + SET FULLPATH ON | OFF | &<cMacro> + Arguments + ON | OFFON returns the full path and file name. OFF returns only the file name. The value may also be a macro (&) that evaluates to ON or OFF. + Remarks + The setting is stored in the runtime state, but the runtime does not use it at this moment. + + See Also + SET DEFAULT, SET PATH + +
diff --git a/docs/Help/Topics/command_SET_HEADINGS.xml b/docs/Help/Topics/command_SET_HEADINGS.xml new file mode 100644 index 0000000000..79ce39b114 --- /dev/null +++ b/docs/Help/Topics/command_SET_HEADINGS.xml @@ -0,0 +1,28 @@ + + + + SET HEADINGS Command + + Commands + SET commands + SET HEADINGS command + + +
+ SET HEADINGS Command +
+ + + Purpose + Specifies whether column headings are displayed by the commands that list data, such as LIST and DISPLAY. + Syntax + SET HEADINGS ON | OFF | &<cMacro> + Arguments + ON | OFFON displays the column headings. OFF suppresses them. The value may also be a macro (&) that evaluates to ON or OFF. + Remarks + The setting is stored in the runtime state, but the runtime does not use it at this moment. + + See Also + SET SPACE + +
diff --git a/docs/Help/Topics/command_SET_HOURS.xml b/docs/Help/Topics/command_SET_HOURS.xml new file mode 100644 index 0000000000..b9ff487f1f --- /dev/null +++ b/docs/Help/Topics/command_SET_HOURS.xml @@ -0,0 +1,28 @@ + + + + SET HOURS Command + + Commands + SET commands + SET HOURS command + + +
+ SET HOURS Command +
+ + + Purpose + Sets the 12 or 24 hour format for the display of time values. + Syntax + SET HOURS TO <nHours> + Arguments + <nHours>12 or 24. + Remarks + SET HOURS TO is equivalent to the function SetHours(). + + See Also + SET SECONDS, SET TIME, SetHours() + +
diff --git a/docs/Help/Topics/command_SET_INDEX_FoxPro.xml b/docs/Help/Topics/command_SET_INDEX_FoxPro.xml new file mode 100644 index 0000000000..81b60a535a --- /dev/null +++ b/docs/Help/Topics/command_SET_INDEX_FoxPro.xml @@ -0,0 +1,33 @@ + + + + SET INDEX Command (FoxPro) + + Commands + Indexes + SET INDEX command + SET INDEX commandFoxPro + + +
+ SET INDEX Command  (FoxPro) +
+ + Purpose + Opens one or more index files for the current table and optionally selects the controlling order. This is the FoxPro version of the SET INDEX command. + Syntax + SET INDEX TO [<IndexFile1> [, <IndexFile2> ...]]
  [ORDER [TAG <OrderName> [OF <IndexFile>]]] [ASCENDING | DESCENDING] [ADDITIVE]
+ Arguments + <IndexFile1>, ...The index files to open. If the list is omitted (SET INDEX TO without arguments), all open index files for the current table are closed. + ORDER [TAG] <OrderName> [OF <IndexFile>]Selects the controlling order after the index files have been opened. + ASCENDING | DESCENDINGChanges the direction of the controlling order. + ADDITIVEKeeps the index files that are already open open. Without this clause, the other index files are closed before the new files are opened. + Examples + USE Customers
+SET INDEX TO Customers.cdx ORDER TAG LastName DESCENDING
+SET INDEX TO Extra.cdx ADDITIVE
+ + See Also + SET INDEX, INDEX (FoxPro), SET ORDER, OrdListAdd(), OrdSetFocus() + +
diff --git a/docs/Help/Topics/command_SET_LOCK.xml b/docs/Help/Topics/command_SET_LOCK.xml new file mode 100644 index 0000000000..510517d87a --- /dev/null +++ b/docs/Help/Topics/command_SET_LOCK.xml @@ -0,0 +1,28 @@ + + + + SET LOCK Command + + Commands + SET commands + SET LOCK command + + +
+ SET LOCK Command +
+ + + Purpose + Specifies whether files are automatically locked when commands such as AVERAGE, COUNT, SUM and others access them. + Syntax + SET LOCK ON | OFF | &<cMacro> + Arguments + ON | OFFON locks the files automatically. OFF does not lock them. The value may also be a macro (&) that evaluates to ON or OFF. + Remarks + The setting is stored in the runtime state, but the runtime does not use it at this moment. + + See Also + SET MULTILOCKS, SET EXCLUSIVE + +
diff --git a/docs/Help/Topics/command_SET_MARGIN.xml b/docs/Help/Topics/command_SET_MARGIN.xml new file mode 100644 index 0000000000..50114eb242 --- /dev/null +++ b/docs/Help/Topics/command_SET_MARGIN.xml @@ -0,0 +1,25 @@ + + + + SET MARGIN Command + + Commands + SET commands + SET MARGIN command + + +
+ SET MARGIN Command +
+ + Purpose + Sets the left margin for the printed output. + Syntax + SET MARGIN TO [<nColumns>] + Arguments + <nColumns>The number of columns of the margin. When the value is omitted the margin is set to 0. + + See Also + SET PRINTER + +
diff --git a/docs/Help/Topics/command_SET_MEMOBLOCK.xml b/docs/Help/Topics/command_SET_MEMOBLOCK.xml index 071b7d6eea..8aa7039b19 100644 --- a/docs/Help/Topics/command_SET_MEMOBLOCK.xml +++ b/docs/Help/Topics/command_SET_MEMOBLOCK.xml @@ -17,7 +17,9 @@ Purpose Change the block size for memo files. Syntax - SET MEMOBLOCK TO <nSize> + SET MEMOBLOCK TO <nSize>
SET MEMOBLOCKSIZE TO [<nSize>]
+ Arguments + nSizeThe block size for memo files. SET MEMOBLOCKSIZE TO without a value sets the block size to 512. Description The initial memo file block size depends on the RDD. For most drivers that support the .DBT memo file format, it is 512 bytes. However, if you are using BLOB files (.DBV) via inheritance from the DBFBLOB driver, the default is 1. SET MEMOBLOCK is functionally equivalent to calling RDDInfo(_SET_MEMOBLOCKSIZE, <nSize>).   diff --git a/docs/Help/Topics/command_SET_MEMOWIDTH.xml b/docs/Help/Topics/command_SET_MEMOWIDTH.xml new file mode 100644 index 0000000000..41ef7f99a3 --- /dev/null +++ b/docs/Help/Topics/command_SET_MEMOWIDTH.xml @@ -0,0 +1,28 @@ + + + + SET MEMOWIDTH Command + + Commands + SET commands + SET MEMOWIDTH command + + +
+ SET MEMOWIDTH Command +
+ + + Purpose + Specifies the width of the output of memo fields. + Syntax + SET MEMOWIDTH TO [<nColumns>] + Arguments + <nColumns>The number of columns. When the value is omitted the default value 50 is used. + Remarks + The value is stored in the runtime state under Set.MemoWidth. + + See Also + SET MEMOBLOCKSIZE, SET HEADINGS + +
diff --git a/docs/Help/Topics/command_SET_MULTILOCKS.xml b/docs/Help/Topics/command_SET_MULTILOCKS.xml new file mode 100644 index 0000000000..3014807b23 --- /dev/null +++ b/docs/Help/Topics/command_SET_MULTILOCKS.xml @@ -0,0 +1,28 @@ + + + + SET MULTILOCKS Command + + Commands + SET commands + SET MULTILOCKS command + + +
+ SET MULTILOCKS Command +
+ + + Purpose + Specifies whether multiple records can be locked at the same time. + Syntax + SET MULTILOCKS ON | OFF | &<cMacro> + Arguments + ON | OFFON allows locking more than one record. OFF allows locking only one record at a time. The value may also be a macro (&) that evaluates to ON or OFF. + Remarks + The setting is stored in the runtime state, but the runtime does not use it at this moment. + + See Also + SET LOCK, SET EXCLUSIVE + +
diff --git a/docs/Help/Topics/command_SET_NEAR.xml b/docs/Help/Topics/command_SET_NEAR.xml new file mode 100644 index 0000000000..023beccd80 --- /dev/null +++ b/docs/Help/Topics/command_SET_NEAR.xml @@ -0,0 +1,28 @@ + + + + SET NEAR Command + + Commands + SET commands + SET NEAR command + + +
+ SET NEAR Command +
+ + + Purpose + Specifies where the record pointer is positioned after a failed search with SEEK or FIND. + Syntax + SET NEAR ON | OFF | &<cMacro> + Arguments + ON | OFFON positions the record pointer on the record with the closest higher key value when the search fails. OFF moves the record pointer to the end of the file. The value may also be a macro (&) that evaluates to ON or OFF. + Remarks + SET NEAR is the FoxPro name for SET SOFTSEEK. Both commands change the same runtime setting. + + See Also + SET SOFTSEEK, SEEK (FoxPro), SetSoftSeek() + +
diff --git a/docs/Help/Topics/command_SET_NULL.xml b/docs/Help/Topics/command_SET_NULL.xml new file mode 100644 index 0000000000..5f6ad96b80 --- /dev/null +++ b/docs/Help/Topics/command_SET_NULL.xml @@ -0,0 +1,29 @@ + + + + SET NULL Command + + Commands + SET commands + SET NULL command + + +
+ SET NULL Command +
+ + + Purpose + Specifies how NULL values are supported by the commands that create tables and by the commands that add records. + Syntax + SET NULL ON | OFF | &<cMacro>
SET NULL (<lExpression>)
+ Arguments + ON | OFFON allows NULL values for the fields. OFF does not allow NULL values. The value may also be a macro (&) that evaluates to ON or OFF. + (<lExpression>)A logical expression between parentheses. TRUE is the same as ON, FALSE is the same as OFF. + Remarks + The setting is stored in the runtime state, but the runtime does not use it at this moment. + + See Also + CREATE TABLE, INSERT INTO + +
diff --git a/docs/Help/Topics/command_SET_OPTIMIZE_FoxPro.xml b/docs/Help/Topics/command_SET_OPTIMIZE_FoxPro.xml new file mode 100644 index 0000000000..73abf6ba53 --- /dev/null +++ b/docs/Help/Topics/command_SET_OPTIMIZE_FoxPro.xml @@ -0,0 +1,28 @@ + + + + SET OPTIMIZE Command (FoxPro) + + Commands + SET commands + SET OPTIMIZE command + SET OPTIMIZE commandFoxPro + + +
+ SET OPTIMIZE Command  (FoxPro) +
+ + Purpose + Enables or disables Rushmore optimization. This is the FoxPro version of the SET OPTIMIZE command. + Syntax + SET OPTIMIZE ON | OFF | &<cMacro> + Arguments + ON | OFFON enables the optimization of filters and conditions with the open orders. OFF disables it. The value may also be a macro (&) that evaluates to ON or OFF. + Remarks + The command changes the same runtime setting as the generic command. The setting is only used by RDDs that support optimization. + + See Also + SET OPTIMIZE, SET FILTER + +
diff --git a/docs/Help/Topics/command_SET_PATH_FoxPro.xml b/docs/Help/Topics/command_SET_PATH_FoxPro.xml new file mode 100644 index 0000000000..b01b1e798c --- /dev/null +++ b/docs/Help/Topics/command_SET_PATH_FoxPro.xml @@ -0,0 +1,32 @@ + + + + SET PATH Command (FoxPro) + + Commands + SET commands + SET PATH command + SET PATH commandFoxPro + + +
+ SET PATH Command  (FoxPro) +
+ + Purpose + Specifies the search path for files, with the option to add folders to the existing path. This is the FoxPro version of the SET PATH command. + Syntax + SET PATH TO <PathList> ADDITIVE + Arguments + <PathList>A list of folders, separated by semi-colons or commas. This must be a string, a macro (&) or an expression between parentheses (or a function call) that returns a string. + ADDITIVEAdds the folders to the existing path, instead of replacing the path. Folders that are already in the path are not added again. + Remarks + When the path is specified as a plain name (without quotes or parentheses) then the keyword ADDITIVE is regarded as part of the path, so SET PATH TO data ADDITIVE sets the path to "DATA ADDITIVE". This is the same in Visual FoxPro. + Examples + SET PATH TO "C:\Data"
+SET PATH TO "C:\Data\Archive; C:\Data\Shared" ADDITIVE
+ + See Also + SET PATH, SET DEFAULT, SetPath() + +
diff --git a/docs/Help/Topics/command_SET_POINT.xml b/docs/Help/Topics/command_SET_POINT.xml new file mode 100644 index 0000000000..ec73b29c84 --- /dev/null +++ b/docs/Help/Topics/command_SET_POINT.xml @@ -0,0 +1,28 @@ + + + + SET POINT Command + + Commands + SET commands + SET POINT command + + +
+ SET POINT Command +
+ + + Purpose + Specifies the character that is used as decimal separator in numeric expressions. + Syntax + SET POINT TO [<cCharacter>] + Arguments + <cCharacter>The decimal separator. When the character is omitted the separator is reset to the period ("."). + Remarks + The setting is stored in the runtime state as Set.Point, which is the same setting as the one that is changed by SetDecimalSep(). + + See Also + SET SEPARATOR, SET DECIMALS, SetDecimalSep() + +
diff --git a/docs/Help/Topics/command_SET_PRINTER.xml b/docs/Help/Topics/command_SET_PRINTER.xml new file mode 100644 index 0000000000..c258796e2e --- /dev/null +++ b/docs/Help/Topics/command_SET_PRINTER.xml @@ -0,0 +1,27 @@ + + + + SET PRINTER Command + + Commands + SET commands + SET PRINTER command + + +
+ SET PRINTER Command +
+ + Purpose + Directs the output of the console commands to the printer, in addition to the screen. + Syntax + SET PRINTER ON | OFF | &<cMacro> + Arguments + ON | OFFON sends the output also to the printer. OFF stops this. The value may also be a macro (&) that evaluates to ON or OFF. + Remarks + The command only changes the Set.Printer setting of the runtime. The variant SET PRINTER TO <file> is not supported at this moment. + + See Also + SET CONSOLE, SET MARGIN + +
diff --git a/docs/Help/Topics/command_SET_REFRESH.xml b/docs/Help/Topics/command_SET_REFRESH.xml new file mode 100644 index 0000000000..b5c64c4fe5 --- /dev/null +++ b/docs/Help/Topics/command_SET_REFRESH.xml @@ -0,0 +1,27 @@ + + + + SET REFRESH Command + + Commands + SET commands + SET REFRESH command + + +
+ SET REFRESH Command +
+ + Purpose + Specifies how often (in seconds) the data in a work area is refreshed from the disk. + Syntax + SET REFRESH TO [<nSeconds>] + Arguments + <nSeconds>The number of seconds. When the value is omitted the default value 5 is used. + Remarks + The command is equivalent to the function SetRefresh(). + + See Also + SET STRICTREAD, SetRefresh() + +
diff --git a/docs/Help/Topics/command_SET_SAFETY.xml b/docs/Help/Topics/command_SET_SAFETY.xml new file mode 100644 index 0000000000..af63325165 --- /dev/null +++ b/docs/Help/Topics/command_SET_SAFETY.xml @@ -0,0 +1,28 @@ + + + + SET SAFETY Command + + Commands + SET commands + SET SAFETY command + + +
+ SET SAFETY Command +
+ + + Purpose + Specifies whether a confirmation is required before an existing file is overwritten. + Syntax + SET SAFETY ON | OFF | &<cMacro> + Arguments + ON | OFFON asks for confirmation before an existing file is overwritten. OFF overwrites the file without asking. The value may also be a macro (&) that evaluates to ON or OFF. + Remarks + The value is stored in the runtime state and can be read and changed with the function SetSafety(). + + See Also + SET COMPATIBLE, SetSafety() + +
diff --git a/docs/Help/Topics/command_SET_SECONDS.xml b/docs/Help/Topics/command_SET_SECONDS.xml new file mode 100644 index 0000000000..4387c39662 --- /dev/null +++ b/docs/Help/Topics/command_SET_SECONDS.xml @@ -0,0 +1,28 @@ + + + + SET SECONDS Command + + Commands + SET commands + SET SECONDS command + + +
+ SET SECONDS Command +
+ + + Purpose + Specifies whether the seconds are displayed in the time portion of a DateTime value. + Syntax + SET SECONDS ON | OFF | &<cMacro> + Arguments + ON | OFFON displays the seconds. OFF suppresses them. The value may also be a macro (&) that evaluates to ON or OFF. + Remarks + SET SECONDS is equivalent to the function SetSeconds(). + + See Also + SET HOURS, SET TIME, SetSeconds() + +
diff --git a/docs/Help/Topics/command_SET_SEPARATOR.xml b/docs/Help/Topics/command_SET_SEPARATOR.xml new file mode 100644 index 0000000000..4efcd3af64 --- /dev/null +++ b/docs/Help/Topics/command_SET_SEPARATOR.xml @@ -0,0 +1,28 @@ + + + + SET SEPARATOR Command + + Commands + SET commands + SET SEPARATOR command + + +
+ SET SEPARATOR Command +
+ + + Purpose + Specifies the character that is used to separate groups of digits (the thousands separator) in numeric expressions. + Syntax + SET SEPARATOR TO [<cCharacter>] + Arguments + <cCharacter>The thousands separator. When the character is omitted the separator is reset to the comma (","). + Remarks + The setting is stored in the runtime state as Set.Separator, which is the same setting as the one that is changed by SetThousandSep(). + + See Also + SET POINT, SET DECIMALS, SetThousandSep() + +
diff --git a/docs/Help/Topics/command_SET_SPACE.xml b/docs/Help/Topics/command_SET_SPACE.xml new file mode 100644 index 0000000000..b5191b13a5 --- /dev/null +++ b/docs/Help/Topics/command_SET_SPACE.xml @@ -0,0 +1,26 @@ + + + + SET SPACE Command + + Commands + SET commands + SET SPACE command + + +
+ SET SPACE Command +
+ + + Purpose + Specifies whether a space is output between the values when the ? and ?? commands print multiple expressions. + Syntax + SET SPACE ON | OFF | &<cMacro> + Arguments + ON | OFFON inserts a space between the expressions in a ? or ?? command. OFF suppresses the spaces. The value may also be a macro (&) that evaluates to ON or OFF. + + See Also + SET HEADINGS, SetSpace() + +
diff --git a/docs/Help/Topics/command_SET_SQLBUFFERING.xml b/docs/Help/Topics/command_SET_SQLBUFFERING.xml new file mode 100644 index 0000000000..efe93953da --- /dev/null +++ b/docs/Help/Topics/command_SET_SQLBUFFERING.xml @@ -0,0 +1,28 @@ + + + + SET SQLBUFFERING Command + + Commands + SET commands + SET SQLBUFFERING command + + +
+ SET SQLBUFFERING Command +
+ + + Purpose + Specifies whether the data that is returned by a remote SQL connection is buffered. + Syntax + SET SQLBUFFERING ON | OFF | &<cMacro> + Arguments + ON | OFFON enables buffering, OFF disables it. The value may also be a macro (&) that evaluates to ON or OFF. + Remarks + The setting is stored in the runtime state, but the runtime does not use it at this moment. + + See Also + SET VARCHARMAPPING, CREATE CONNECTION + +
diff --git a/docs/Help/Topics/command_SET_STRICTREAD.xml b/docs/Help/Topics/command_SET_STRICTREAD.xml new file mode 100644 index 0000000000..f52de74a26 --- /dev/null +++ b/docs/Help/Topics/command_SET_STRICTREAD.xml @@ -0,0 +1,28 @@ + + + + SET STRICTREAD Command + + Commands + SET commands + SET STRICTREAD command + SET DIRTYREAD command + + +
+ SET STRICTREAD Command +
+ + Purpose + Specifies whether the DBFCDX RDD reads its index files in strict mode (STRICTREAD ON) or allows "dirty reads" (DIRTYREAD ON), where index data is read without taking the locks that guarantee a consistent state. + Syntax + SET STRICTREAD ON | OFF | &<cMacro>
SET DIRTYREAD ON | OFF | &<cMacro>
+ Arguments + ON | OFFFor SET STRICTREAD, ON enables the strict mode. For SET DIRTYREAD the meaning is reversed: ON allows dirty reads, which is the same as SET STRICTREAD OFF. The value may also be a macro (&) that evaluates to ON or OFF. + Remarks + Both commands change the same runtime setting. SET DIRTYREAD ON is equivalent to SET STRICTREAD OFF and SET DIRTYREAD OFF is equivalent to SET STRICTREAD ON. + + See Also + SET REFRESH, SET EXCLUSIVE + +
diff --git a/docs/Help/Topics/command_SET_TEXTMERGE_DELIMITERS.xml b/docs/Help/Topics/command_SET_TEXTMERGE_DELIMITERS.xml new file mode 100644 index 0000000000..31bdc493d9 --- /dev/null +++ b/docs/Help/Topics/command_SET_TEXTMERGE_DELIMITERS.xml @@ -0,0 +1,34 @@ + + + + SET TEXTMERGE DELIMITERS Command + + Commands + SET commands + SET TEXTMERGE DELIMITERS command + + +
+ SET TEXTMERGE DELIMITERS Command +
+ + + Purpose + Specifies the delimiters that mark the expressions that are evaluated in text-merge output. + Syntax + SET TEXTMERGE DELIMITERS [TO [<cLeftDelimiter> [, <cRightDelimiter>]]] + Arguments + TO <cLeftDelimiter> [, <cRightDelimiter>]The characters that mark the start and the end of an expression. When only the left delimiter is specified, then it is also used as the right delimiter. + Remarks + The default delimiters are << and >>. The delimiters are used when SET TEXTMERGE is ON, in the \ and \\ commands and in the TEXT ... ENDTEXT command. + Examples + SET TEXTMERGE ON
+SET TEXTMERGE DELIMITERS TO "{", "}"
+TEXT
+Today is {DATE()}
+ENDTEXT
+ + See Also + SET TEXTMERGE, TEXT ... ENDTEXT, SetTextMergeDelimiters() + +
diff --git a/docs/Help/Topics/command_SET_TIME.xml b/docs/Help/Topics/command_SET_TIME.xml new file mode 100644 index 0000000000..69641a0906 --- /dev/null +++ b/docs/Help/Topics/command_SET_TIME.xml @@ -0,0 +1,28 @@ + + + + SET TIME Command + + Commands + SET commands + SET TIME command + + +
+ SET TIME Command +
+ + Purpose + Specifies the format that is used to display time values. + Syntax + SET TIME TO <cTimeFormat>
SET TIME TO SYSTEM
+ Arguments + <cTimeFormat>The time format, for example HH:MM:SS. The format may be specified with or without quotes. + SYSTEMUses the time format of the operating system. + Remarks + The command is equivalent to the function SetTimeFormat(). + + See Also + SET HOURS, SET SECONDS, SET DATE FORMAT, SetTimeFormat() + +
diff --git a/docs/Help/Topics/command_SET_VARCHARMAPPING.xml b/docs/Help/Topics/command_SET_VARCHARMAPPING.xml new file mode 100644 index 0000000000..486a73fe26 --- /dev/null +++ b/docs/Help/Topics/command_SET_VARCHARMAPPING.xml @@ -0,0 +1,28 @@ + + + + SET VARCHARMAPPING Command + + Commands + SET commands + SET VARCHARMAPPING command + + +
+ SET VARCHARMAPPING Command +
+ + + Purpose + Specifies how character data is mapped when a query result is stored in a cursor. + Syntax + SET VARCHARMAPPING ON | OFF | &<cMacro> + Arguments + ON | OFFON maps the query results to Varchar fields. OFF maps them to Character fields. The value may also be a macro (&) that evaluates to ON or OFF. + Remarks + The setting is stored in the runtime state, but the runtime does not use it at this moment. + + See Also + SET SQLBUFFERING, CREATE CURSOR + +
diff --git a/docs/Help/Topics/command_SORT_FoxPro.xml b/docs/Help/Topics/command_SORT_FoxPro.xml new file mode 100644 index 0000000000..debc99a651 --- /dev/null +++ b/docs/Help/Topics/command_SORT_FoxPro.xml @@ -0,0 +1,39 @@ + + + + SORT Command (FoxPro) + + Commands + Tables + SORT command + SORT commandFoxPro + + +
+ SORT Command  (FoxPro) +
+ + Purpose + Sorts the records of the current table and writes the result to a new table. This is the FoxPro version of the SORT command. + Syntax + SORT TO <TableName> ON <Field1> [/A | /D] [/C] [, <Field2> [/A | /D] [/C] ...]
  [ASCENDING | DESCENDING]
  [<Scope>] [FOR <lCondition>] [WHILE <lCondition>] [NOOPTIMIZE]
  [FIELDS <FieldList> | FIELDS LIKE <Skeleton> | FIELDS EXCEPT <Skeleton>]
+ Arguments + TO <TableName>The name of the table that receives the sorted records. + ON <Field1> [/A | /D] [/C], ...The fields on which the table is sorted. /A sorts ascending (default), /D sorts descending and /C ignores the case of character fields. + ASCENDING | DESCENDINGThe default direction for the fields that have no /A or /D option. + + + + + NOOPTIMIZEDisables the optimization of the FOR clause. + Remarks + The FoxPro version of the command adds the FIELDS clause with the LIKE and EXCEPT options, which limits the fields that are written to the new table. + Examples + USE Customers
+SORT TO SortedCustomers ON Country, LastName /C FOR Active
+SORT TO Names ON LastName FIELDS LastName, FirstName
+ + See Also + SORT, COPY TO (FoxPro), DbSortFox() + +
diff --git a/docs/Help/Topics/command_UPDATE_SET.xml b/docs/Help/Topics/command_UPDATE_SET.xml new file mode 100644 index 0000000000..8966ac5bd6 --- /dev/null +++ b/docs/Help/Topics/command_UPDATE_SET.xml @@ -0,0 +1,33 @@ + + + + UPDATE SET Command + + Commands + SQL + UPDATE command + + +
+ UPDATE Command +
+ + + Purpose + Updates fields in the records of a table, using the SQL syntax. + Syntax + UPDATE <TableName> SET <FieldName1> = <eExpression1> [, <FieldName2> = <eExpression2> ...] [WHERE <lCondition>] + Arguments + <TableName>The table (or alias) that must be updated. The table must be open. + SET <FieldName> = <eExpression>The fields that are updated and the new values. The expressions are evaluated for each record that matches the condition. + WHERE <lCondition>Only the records for which the condition is true are updated. Without this clause all records are updated. + Remarks + The records are locked while they are updated (when needed) and unlocked afterwards. This command is not the same as the xBase UPDATE command. + NOT SUPPORTED AT THIS MOMENT: UPDATE with a JOIN or a subselect. The compiler generates an error when this is used. + + Examples + UPDATE Customers SET Country = "NL", Active = .T. WHERE City == "Amsterdam" + See Also + REPLACE, INSERT INTO, DELETE FROM + +
diff --git a/docs/Help/Topics/command_USE.xml b/docs/Help/Topics/command_USE.xml index 55e163c493..bdd775deb6 100644 --- a/docs/Help/Topics/command_USE.xml +++ b/docs/Help/Topics/command_USE.xml @@ -74,6 +74,7 @@ cDataFile = "MyDbf"
acIndex = {"MyIndex1", "MyIndex2", "MyIndex3"}
USE (cDataFile) INDEX (acIndex[1]), ;
     (acIndex[2]), (acIndex[3])
See Also + FoxPro version: USE (FoxPro) CLOSE, DbSelect(), DbSetIndex(), DbSetOrder(), DbUseArea(), NetErr(), RddSetDefault() SELECT, SET INDEX, Used() diff --git a/docs/Help/Topics/command_USE_FoxPro.xml b/docs/Help/Topics/command_USE_FoxPro.xml new file mode 100644 index 0000000000..feb7e16237 --- /dev/null +++ b/docs/Help/Topics/command_USE_FoxPro.xml @@ -0,0 +1,43 @@ + + + + USE Command (FoxPro) + + Commands + Tables + USE command + USE commandFoxPro + + +
+ USE Command  (FoxPro) +
+ + Purpose + Opens a table and its indexes, or closes a table, using the syntax of the FoxPro dialect. This is the FoxPro version of the USE command. + Syntax + USE <TableName> [IN <WorkArea> | <Alias>]
  [ONLINE] [ADMIN] [AGAIN] [NOREQUERY [<nDataSession>]] [NODATA]
  [INDEX <IndexFile1> [, <IndexFile2> ...]]
  [ORDER [TAG] <OrderName> [OF <IndexFile>]] [ASCENDING | DESCENDING]
  [ALIAS <Alias>] [EXCLUSIVE | SHARED] [NOUPDATE] [CONNSTRING <ConnectionString>]

USE IN <WorkArea> | <Alias>
+ Arguments + <TableName>The name of the table to open. When the table is not found in the current directory the search path is used (see SET PATH). + + AGAINOpens the table again in a new work area, while it is also open in another work area. The new work area uses the same shared/exclusive and read-only mode as the work area where the table is already open. + INDEX <IndexFile1>, ...Opens the specified index files together with the table. + ORDER [TAG] <OrderName> [OF <IndexFile>]Selects the controlling order after the table has been opened. The order can be a tag name from a compound index file (CDX), or the name of an order in the index file that is specified in the OF clause. + ASCENDING | DESCENDINGChanges the direction of the controlling order. This is only done when the ORDER clause is also specified. + ALIAS <Alias>The alias for the table. When this clause is omitted, the alias is the name of the table without path and extension. When that alias is already in use by another work area then a unique alias is generated. + EXCLUSIVEOpens the table for exclusive use. By default the table is opened as set by SET EXCLUSIVE. + SHAREDOpens the table for shared use. + NOUPDATEOpens the table read-only. + ONLINE, ADMIN, NOREQUERY, NODATA, CONNSTRINGThese clauses are only relevant for remote views and are accepted for compatibility, but ignored. + Remarks + The FoxPro version of the command uses the DBFVFP RDD as the default driver, so the table can be a DBF with the FoxPro extensions (null fields, auto-increment fields, DateTime and Currency fields and so on). + USE IN <WorkArea> closes the table in the specified work area. The command USE without any clauses closes the table in the current work area, as described in USE. CLOSE IN <WorkArea> has the same effect as USE IN. + Examples + USE Customers ALIAS Cust SHARED NOUPDATE
+USE Customers AGAIN IN 0 ALIAS Cust2 ORDER TAG LastName
+USE IN Cust2
+ + See Also + USE, CLOSE, CLOSE TABLES, SELECT, DbUseAreaFox(), DbCloseArea(), DbSetIndex() + +
diff --git a/docs/Help/Topics/command_WAIT_CLEAR.xml b/docs/Help/Topics/command_WAIT_CLEAR.xml new file mode 100644 index 0000000000..54491e91db --- /dev/null +++ b/docs/Help/Topics/command_WAIT_CLEAR.xml @@ -0,0 +1,26 @@ + + + + WAIT CLEAR Command + + Commands + Terminal + WAIT CLEAR command + + +
+ WAIT CLEAR Command +
+ + + Purpose + Closes a message window that was left open by the WAIT WINDOW ... NOCLEAR command. + Syntax + WAIT CLEAR + Remarks + NOT SUPPORTED AT THIS MOMENT: The command is accepted for compatibility, but it does not do anything. + + See Also + WAIT (FoxPro), WAIT + +
diff --git a/docs/Help/Topics/command_WAIT_FoxPro.xml b/docs/Help/Topics/command_WAIT_FoxPro.xml new file mode 100644 index 0000000000..8d7da34fd2 --- /dev/null +++ b/docs/Help/Topics/command_WAIT_FoxPro.xml @@ -0,0 +1,37 @@ + + + + WAIT Command (FoxPro) + + Commands + Terminal + WAIT command + WAIT commandFoxPro + + +
+ WAIT Command  (FoxPro) +
+ + Purpose + Displays a message and pauses the program until a key is pressed or until a time-out occurs. This is the FoxPro version of the WAIT command. + Syntax + WAIT [<cMessage>] [TO <Variable>] [WINDOW [AT <nRow>, <nColumn>]] [NOWAIT] [NOCLEAR] [TIMEOUT <nSeconds>] + Arguments + <cMessage>The message to display. When this is omitted, the text "Press any key to continue..." is displayed. When the WINDOW clause is used and the message is omitted, no message is displayed. + TO <Variable>The variable that receives the key that was pressed. When no key was pressed (NOWAIT, TIMEOUT, or when the program is not interactive) the variable receives an empty string. + WINDOW [AT <nRow>, <nColumn>]Displays the message in a window instead of on the screen. When the program is a GUI program, the message is displayed in a message box. The position is only used when it is supported by the window. + NOWAITDisplays the message and continues the program immediately, without waiting for a key. + NOCLEARLeaves the message window open after the command has finished. Use WAIT CLEAR to close it. + TIMEOUT <nSeconds>The number of seconds to wait for a key before the command continues. + Remarks + The WAIT command returns an empty string and does not wait when the program does not have a console or a user interface (for example in a service). + Examples + WAIT "Continue?" TO cKey
+WAIT WINDOW "Please wait..." NOWAIT
+WAIT "Press a key within 5 seconds" TIMEOUT 5
+ + See Also + WAIT, WAIT CLEAR + +