From 64586c09cb920870f0733e0a22da88d7cc0c7a98 Mon Sep 17 00:00:00 2001 From: RobertvanderHulst <14240939+RobertvanderHulst@users.noreply.github.com> Date: Tue, 17 Nov 2026 17:15:32 +0000 Subject: [PATCH] Docs: convert HTML tables and text lists to Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- src/DocChinese/Gui.xml | 184 ++-- src/DocChinese/Report.Xml | 332 +++---- src/DocChinese/VfpRuntimeDocs.xml | 28 +- src/Docs/CoreComments.Xml | 28 +- src/Docs/Gui.xml | 143 ++- src/Docs/Rdd.xml | 56 +- src/Docs/Report.Xml | 321 ++++-- src/Docs/Sql.Xml | 75 +- src/Docs/VFPDocs.xml | 6 +- src/Docs/VfpRuntimeDocs.xml | 29 +- src/Docs/VoFunctionDocs.xml | 1510 +++++++++++++++++++++++------ src/Docs/XPPComments.Xml | 4 +- 12 files changed, 1974 insertions(+), 742 deletions(-) diff --git a/src/DocChinese/Gui.xml b/src/DocChinese/Gui.xml index 2cb94a213f..6a7f664ffc 100644 --- a/src/DocChinese/Gui.xml +++ b/src/DocChinese/Gui.xml @@ -15439,24 +15439,24 @@ 如果添加了项目,将返回列表框中的位置(值为1表示列表框中的第一个位置)。如果无法添加项目,将返回0。 - - - - - - - - - - - - - - - - - -
值位置
0在未排序的列表框中,将新项目添加到列表的末尾;如果已排序,将新项目插入由列表框确定的位置。这是默认值。
1列表框中的第一个位置。
n列表框中的第n个位置。
+ + + 值 + 位置 + + + 0 + 在未排序的列表框中,将新项目添加到列表的末尾;如果已排序,将新项目插入由列表框确定的位置。这是默认值。 + + + 1 + 列表框中的第一个位置。 + + + n + 列表框中的第n个位置。 + +
@@ -15546,24 +15546,24 @@ 要删除的项目的编号。指定下面列出的值之一 - - - - - - - - - - - - - - - - - -
值位置
0当前选择的项目。这是默认值。
1列表框中的第一个项目。
n列表框中的第n个项目。
+ + + 值 + 位置 + + + 0 + 当前选择的项目。这是默认值。 + + + 1 + 列表框中的第一个项目。 + + + n + 列表框中的第n个项目。 + +
@@ -15676,24 +15676,24 @@ 指定项目的关联值。 - - - - - - - - - - - - - - - - - -
值位置
0当前选择的项目。
1列表框中的第一个项目。
n列表框中的第n个项目。
+ + + 值 + 位置 + + + 0 + 当前选择的项目。 + + + 1 + 列表框中的第一个项目。 + + + n + 列表框中的第n个项目。 + +
@@ -24163,44 +24163,44 @@ 例如,对于菜单命令: Save &As\tF3 是 Menu_Save_As HELPWINDOW request 生成下表中列出的关键字之一, 取决于拥有焦点的窗口区域。 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeywordRegion
WindowAny area of the window not explicitly identified in this table
Window_BorderBorder
Window_CaptionTitle bar
Window_MaxBoxMaximize button
Window_MinBoxMinimize button
Window_SysMenuBoxSystem menu button
Window_UnknownAny area of the window not explicitly identified in this table
Window_WindowCanvasCanvas area
+ + + Keyword + Region + + + Window + Any area of the window not explicitly identified in this table + + + Window_Border + Border + + + Window_Caption + Title bar + + + Window_MaxBox + Maximize button + + + Window_MinBox + Minimize button + + + Window_SysMenuBox + System menu button + + + Window_Unknown + Any area of the window not explicitly identified in this table + + + Window_WindowCanvas + Canvas area + + 如果生成 Window_Unknown 关键字,HelpRequest() 的默认行为是显示 HelpDisplay 中定义的 Contents 主题(即,HelpDisplay:Show("HelpIndex"))。 diff --git a/src/DocChinese/Report.Xml b/src/DocChinese/Report.Xml index b90df31413..cc4370120a 100644 --- a/src/DocChinese/Report.Xml +++ b/src/DocChinese/Report.Xml @@ -331,172 +331,172 @@ 如果省略,默认值为 1(Letter 8 1/2 x 11 英寸)。 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
SizeMM
A3297 x 420
A4210 x 297
A4 Small210 x 297
A5148 x 210
B4250 x 354
B5182 x 257
C size sheet24
D size sheet25
E size sheet26
Envelope B4250 x 353
Envelope B5176 x 250
Envelope B6176 x 125
Envelope C5162 x 229
Envelope C3324 x 458
Envelope C4229 x 324
Envelope C6114 x 162
Envelope C65114 x 229
Envelope DL110 x 220
Envelope 110 x 23036
Envelope Monarch3.875 x 7.5 in
6 3/4 Envelope3 5/8 x 6 1/2 in
Envelope #93 7/8 x 8 7/8
Envelope #104 1/8 x 9 1/2
Envelope #114 1/2 x 10 3/8
Envelope #124 3/4 x 11
Envelope #145 x 11 1/2
Executive7 1/4 x 10 1/2 in
Folio8 1/2 x 13 in
German Std Fanfold8 1/2 x 12 in
German Legal Fanfold8 1/2 x 13 in
Legal8 1/2 x 14 in
Letter8 1/2 x 11 in
Letter Small8 1/2 x 11 in
Note8 1/2 x 11 in
Quarto215 x 275 mm
Statement5 1/2 x 8 1/2 in
Tabloid11 x 17 in
US Std Fanfold14 7/8 x 11 in
10x14 in16
11x17 in17
+ + + Size + MM + + + A3 + 297 x 420 + + + A4 + 210 x 297 + + + A4 Small + 210 x 297 + + + A5 + 148 x 210 + + + B4 + 250 x 354 + + + B5 + 182 x 257 + + + C size sheet + 24 + + + D size sheet + 25 + + + E size sheet + 26 + + + Envelope B4 + 250 x 353 + + + Envelope B5 + 176 x 250 + + + Envelope B6 + 176 x 125 + + + Envelope C5 + 162 x 229 + + + Envelope C3 + 324 x 458 + + + Envelope C4 + 229 x 324 + + + Envelope C6 + 114 x 162 + + + Envelope C65 + 114 x 229 + + + Envelope DL + 110 x 220 + + + Envelope 110 x 230 + 36 + + + Envelope Monarch + 3.875 x 7.5 in + + + 6 3/4 Envelope + 3 5/8 x 6 1/2 in + + + Envelope #9 + 3 7/8 x 8 7/8 + + + Envelope #10 + 4 1/8 x 9 1/2 + + + Envelope #11 + 4 1/2 x 10 3/8 + + + Envelope #12 + 4 3/4 x 11 + + + Envelope #14 + 5 x 11 1/2 + + + Executive + 7 1/4 x 10 1/2 in + + + Folio + 8 1/2 x 13 in + + + German Std Fanfold + 8 1/2 x 12 in + + + German Legal Fanfold + 8 1/2 x 13 in + + + Legal + 8 1/2 x 14 in + + + Letter + 8 1/2 x 11 in + + + Letter Small + 8 1/2 x 11 in + + + Note + 8 1/2 x 11 in + + + Quarto + 215 x 275 mm + + + Statement + 5 1/2 x 8 1/2 in + + + Tabloid + 11 x 17 in + + + US Std Fanfold + 14 7/8 x 11 in + + + 10x14 in + 16 + + + 11x17 in + 17 + + 在调用 Print()或 Preview()之前应设置纸张大小。 并非所有打印机都支持所有纸张大小。请查阅您的打印机文档以了解支持的纸张大小。 diff --git a/src/DocChinese/VfpRuntimeDocs.xml b/src/DocChinese/VfpRuntimeDocs.xml index 2b5a71af68..02804cbd06 100644 --- a/src/DocChinese/VfpRuntimeDocs.xml +++ b/src/DocChinese/VfpRuntimeDocs.xml @@ -1218,20 +1218,20 @@ 根据nArrayAttribute的以下值,确定ALEN( ) 返回数组中的元素、行或列的数量:
- - - - - - - - - - - - - -
0返回数组中的元素数量。省略nArrayAttribute与指定0相同。
1返回数组中的行数。
2返回数组中的列数。如果数组是一维数组,ALEN( ) 返回0(无列)。
+ + + 0 + 返回数组中的元素数量。省略nArrayAttribute与指定0相同。 + + + 1 + 返回数组中的行数。 + + + 2 + 返回数组中的列数。如果数组是一维数组,ALEN( ) 返回0(无列)。 + + 数值型 diff --git a/src/Docs/CoreComments.Xml b/src/Docs/CoreComments.Xml index 3a2474f10f..60f75676e7 100644 --- a/src/Docs/CoreComments.Xml +++ b/src/Docs/CoreComments.Xml @@ -200,20 +200,20 @@ This function returns a numeric value to indicate the order in which the strings should be sorted:
- - - - - - - - - - - - - -
-1LHS precedes RHS in the sort order.
0LHS occurs in the same position as RHS in the sort order.
1LHS follows RHS in the sort order.
+ + + -1 + LHS precedes RHS in the sort order. + + + 0 + LHS occurs in the same position as RHS in the sort order. + + + 1 + LHS follows RHS in the sort order. + +
diff --git a/src/Docs/Gui.xml b/src/Docs/Gui.xml index d393b8929c..c0df7176e0 100644 --- a/src/Docs/Gui.xml +++ b/src/Docs/Gui.xml @@ -132,10 +132,24 @@ The Create() method is called after the ActiveXControl object is instantiated. Note that the both methods are called from the ActiveX container application: they should never be called directly from your code. Inside Create(), you should: - 1. Instantiate a control or window object representing the user interface of the ActiveX control. This object should be assigned to OCXWindow. - 2. Instantiate an object representing the automation interface of the ActiveX control and assign it to AutoServer. - 3. Instantiate an object representing the event interface of the ActiveX control and assign it to Events—this step is optional. - 4. Perform other initializations tasks. + + + 1 + Instantiate a control or window object representing the user interface of the ActiveX control. This object should be assigned to OCXWindow. + + + 2 + Instantiate an object representing the automation interface of the ActiveX control and assign it to AutoServer. + + + 3 + Instantiate an object representing the event interface of the ActiveX control and assign it to Events—this step is optional. + + + 4 + Perform other initializations tasks. + + For further details, see Creating OLE Servers in X# in the "How To" section of the online help, as well as the sample applications that are accessible from the Samples tab page of the Application Gallery. @@ -2424,7 +2438,7 @@ The style of the combo box, specified as one of the Windows API constants listed below: The resource ID of the combo box. - + Constant Creates @@ -2906,15 +2920,34 @@ Controls receive events from the user and the system all of the time. Each control receives only the events that are relevant to it. For each event that is generated, two things happen: - 1. The event is converted to a particular Event object (an ExposeEvent or a MouseEvent, for example) according to the action that triggered the event. - 2. The appropriate event handler is called, and this typed Event object is passed to it. + + + 1 + The event is converted to a particular Event object (an ExposeEvent or a MouseEvent, for example) according to the action that triggered the event. + + + 2 + The appropriate event handler is called, and this typed Event object is passed to it. + + If you want to set a specific return value for the underlying window procedure, you have to change the EventReturnValue variable for the control object. If you want to handle other events (for example, timer events), you need to write your own Dispatch() method. The following guidelines should be followed when writing a customized Dispatch() method: - 1. Subclass an event type appropriate to the type of operation for which it is being used. - 2. Add an event handler function to your derived object. (This event handler should be called with the event when the event is received.) - 3. In general, the implementation of this event handler should call Default(). This keeps the same behavior as the base class, but it also allows other classes to provide useful event handlers for your new type of event, allowing you to provide a framework for other classes to use. + + + 1 + Subclass an event type appropriate to the type of operation for which it is being used. + + + 2 + Add an event handler function to your derived object. (This event handler should be called with the event when the event is received.) + + + 3 + In general, the implementation of this event handler should call Default(). This keeps the same behavior as the base class, but it also allows other classes to provide useful event handlers for your new type of event, allowing you to provide a framework for other classes to use. + + The base class Dispatch() method should be called in those cases where the received event is not handled by the customized dispatcher. For example: RETURN SUPER:Dispatch() @@ -8386,7 +8419,7 @@ The style to set. See table in the remarks section. A logical value to set the style. TRUE sets the style on, FALSE turns it off. - + Value Description @@ -8506,7 +8539,7 @@ The text alignment style, specified as one of the following constants: - + Constant Description @@ -8565,8 +8598,16 @@ Although you supply specifics for a new font, the GUI actually picks an actual font which best fits the description provided. Each window has a currently selected font. Window:TextPrint() and Window:SizeText() use this font when they are printing or sizing text. - Deselecting a Font: In Windows, the current font should be deselected before destroying the window. To do this, use Window:Font to assign the previous font, for example. However, this is only necessary if there is a font other than the default one currently selected. - Font Pitch: A font's pitch can be either variable or fixed. In variable pitch fonts, characters are proportionally spaced (for example, a variable pitch font uses more space to print an "M" than an "i"). In fixed pitch fonts, the same amount of space is used by each character, regardless of the character width. Fixed pitch fonts are most commonly used by terminals and typewriters or to display program text. + + + Deselecting a Font + In Windows, the current font should be deselected before destroying the window. To do this, use Window:Font to assign the previous font, for example. However, this is only necessary if there is a font other than the default one currently selected. + + + Font Pitch + A font's pitch can be either variable or fixed. In variable pitch fonts, characters are proportionally spaced (for example, a variable pitch font uses more space to print an "M" than an "i"). In fixed pitch fonts, the same amount of space is used by each character, regardless of the character width. Fixed pitch fonts are most commonly used by terminals and typewriters or to display program text. + + Variable pitched fonts are not always supported. This is dependent on the individual font. @@ -9168,7 +9209,7 @@ Instead, they are provided by the system to give you access to certain standard help features: - + Reserved Keyword Description @@ -9531,7 +9572,7 @@ The window to which the HotKey object will be applied. A numeric value indicating the result of applying the HotKey object to the window. The result can be one of the following values: - + Value Result @@ -11731,11 +11772,28 @@ The IRequest class retrieves the values that the client browser passed to the server during an HTTP request. The variables are internally stored by collections in the following order: - 1. QueryString - 2. Form - 3. Cookies - 4. ClientCertificate - 5. ServerVariables + + + 1 + QueryString + + + 2 + Form + + + 3 + Cookies + + + 4 + ClientCertificate + + + 5 + ServerVariables + + The IRequest class provides the following kinds of methods: Methods to retrieve these collections as arrays containing value {name, value} pairs for each collection (e.g., GetForms()). Methods to retrieve a certain value of one of these collections (e.g., GetForm("firstname")). @@ -17840,7 +17898,7 @@ If is specified, use one of the constants listed below: - + Pointer Description @@ -18727,8 +18785,16 @@ The array containing existing radio buttons or the values that should be used to create radio buttons. A two-dimensional array may be used to define the values to be returned to the program when a radio button is selected; this 'other' value is what is returned in the RadioButtonGroup:Value property, and what is stored in the database if the control is associated with a database field. If a one-dimensional array is specified, the values are returned as 1, 2, 3... Thus, the array may be specified in one of two formats: - 1. One-dimensional array containing radio button objects that are to be linked to the group - 2. Two-dimensional arrays, each element containing a RadioButton object and the corresponding value returned to the program + + + 1 + One-dimensional array containing radio button objects that are to be linked to the group + + + 2 + Two-dimensional arrays, each element containing a RadioButton object and the corresponding value returned to the program + + Note: the two dimensional array has the same structure as that returned by DBServer:GetLookupTable(). @@ -25379,15 +25445,34 @@ Windows receive events from the user and the system all of the time. Each window receives only the events that are relevant to it. For each event that is generated, two things happen: - 1. The event is converted to a particular Event object (an ExposeEvent or a MouseEvent, for example) according to the action that triggered the event. - 2. The appropriate event handler is called, and this typed Event object is passed to it. + + + 1 + The event is converted to a particular Event object (an ExposeEvent or a MouseEvent, for example) according to the action that triggered the event. + + + 2 + The appropriate event handler is called, and this typed Event object is passed to it. + + If you want to set a specific return value for the underlying window procedure, you have to change the EventReturnValue variable for the window object. If you want to handle other events (for example, timer events), you need to write your own Dispatch() method. The following guidelines should be followed when writing a customized Dispatch() method: - 1. Subclass an event type appropriate to the type of operation for which it is being used. - 2. Add an event handler function to your derived object. (This event handler should be called with the event when the event is received.) - 3. In general, the implementation of this event handler should call Default(). This keeps the same behavior as the base class, but it also + + + 1 + Subclass an event type appropriate to the type of operation for which it is being used. + + + 2 + Add an event handler function to your derived object. (This event handler should be called with the event when the event is received.) + + + 3 + In general, the implementation of this event handler should call Default(). This keeps the same behavior as the base class, but it also + + allows other classes to provide useful event handlers for your new type of event, allowing you to provide a framework for other classes to use. The base class Dispatch() method should be called in those cases where the received event is not handled by the customized dispatcher. For example: diff --git a/src/Docs/Rdd.xml b/src/Docs/Rdd.xml index a3d531e311..540b36bd1b 100644 --- a/src/Docs/Rdd.xml +++ b/src/Docs/Rdd.xml @@ -703,10 +703,24 @@ Remember to restore the scope afterwards: the scope is persistent and applies to all following scope-based methods until reset. The convenience of this style of specifying a scope comes with the danger of leaving it active for too long. The scope can be reset with the DBServer:ClearScope() method, or by assigning NIL to the individual components. The general server scope can be set with: - Property Meaning - ForBlock A string or codeblock specifying the FOR condition. - Scope DBSCOPEALL, DBSCOPEREST or a number (meaning NEXT ). - WhileBlock A string or codeblock specifying the WHILE condition. + + + Property + Meaning + + + ForBlock + A string or codeblock specifying the FOR condition. + + + Scope + DBSCOPEALL, DBSCOPEREST or a number (meaning NEXT ). + + + WhileBlock + A string or codeblock specifying the WHILE condition. + + Note that there is no provision for specifying a specific record number with this approach. There is rarely a need to process a specific record (e.g., the average of the salary of record 5). In cases where there is, such as for Delete(), use RecNo := , GoTo() or Seek() to position the server, and then invoke Delete(). The methods that are subject to the general server scope are: @@ -807,10 +821,24 @@ But note that if a selective relation has been specified, the default source scope is the selection, not the entire file. Thus, we have four levels of inheritance with regard to the scope of an operation: - 1. The scope that explicitly specified through arguments of the call - 2. If none was provided, the scope that is set through the ForBlock, WhileBlock and Scope properties - 3. If none was set, the selection specified with the selective relation - 4. If no selective relation is active, the entire file + + + 1 + The scope that explicitly specified through arguments of the call + + + 2 + If none was provided, the scope that is set through the ForBlock, WhileBlock and Scope properties + + + 3 + If none was set, the selection specified with the selective relation + + + 4 + If no selective relation is active, the entire file + + The exceptions Delete() and Recall() use options 1 and 2, then default to the current record. DeleteAll() and RecallAll() apply to the current selection, if any; otherwise, to the entire file. Of course, a selection scope is not relevant to the Append... methods, for which the conditions apply to the source file, not this server. The DBServer Editor generates a subclass of the generic DBServer class, one with specific information such as file names and virtual fields created as access/assign methods. @@ -3340,8 +3368,16 @@ DBServer:Seek() moves to the first logical record whose key value is equal to . If such a record is found, it becomes the current record and DBServer:Seek() returns TRUE. Otherwise, DBServer:Seek() returns FALSE and the positioning of the data server is as follows: for a normal (not soft) seek, the data server is positioned to DBServer:LastRec + 1 and DBServer:EOF returns TRUE; for a soft seek, the data server is positioned to the first record whose key value is greater than the specified key value. If no such record exists, the data server is positioned to DBServer:LastRec + 1 and DBServer:EOF returns TRUE. For a data server with no controlling order, DBServer:Seek() has no effect. - Logical records: DBServer:Seek() operates on logical records. Records are processed in controlling order. If a filter is set, only records which meet the filter condition are considered. - Shared mode: For a shared file, moving to a different record can cause updates to the current record to become visible to other processes. For more information, refer to "Concurrency Control" in the Programmer's Guide. + + + Logical records + DBServer:Seek() operates on logical records. Records are processed in controlling order. If a filter is set, only records which meet the filter condition are considered. + + + Shared mode + For a shared file, moving to a different record can cause updates to the current record to become visible to other processes. For more information, refer to "Concurrency Control" in the Programmer's Guide. + + diff --git a/src/Docs/Report.Xml b/src/Docs/Report.Xml index 0e44739d1d..336fd2e3b5 100644 --- a/src/Docs/Report.Xml +++ b/src/Docs/Report.Xml @@ -118,16 +118,40 @@ One of the following constants representing an event: -
-          Constant					Description
-          REPORTCLOSEEVENT			Current report has been closed.
-          REPORTCOMPLETEERROREVENT	A print or export task has aborted.
-          REPORTCOMPLETEEVENT		A print or export task has completed.
-          REPORTFILESAVEEVENT		A report definition has been closed.
-          REPORTOPENEVENT			Requested report has been opened.
-          REPORTSERVERCLOSEEVENT	Report Editor has been closed.
-          REPORTVIEWCLOSEEVENT		A report preview has been closed (but the report itself remains open).
-        
+ + + Constant + Description + + + REPORTCLOSEEVENT + Current report has been closed. + + + REPORTCOMPLETEERROREVENT + A print or export task has aborted. + + + REPORTCOMPLETEEVENT + A print or export task has completed. + + + REPORTFILESAVEEVENT + A report definition has been closed. + + + REPORTOPENEVENT + Requested report has been opened. + + + REPORTSERVERCLOSEEVENT + Report Editor has been closed. + + + REPORTVIEWCLOSEEVENT + A report preview has been closed (but the report itself remains open). + + It should be used only in any AppWindow:ReportNotification() method you add to your window class that owns this ReportQueue object.
@@ -158,16 +182,37 @@ One of the following constants representing the report style for the new report: -
-          Constant				Description
-          RPTSTYLE_CROSSTAB		Creates a cross-tabular report.
-          RPTSTYLE_FORM			Creates a form-based report
-          RPTSTYLE_FREESTYLE	Creates a free-style report
-          RPTSTYLE_LABEL		Creates a label report
-          RPTSTYLE_LETTER		Creates a letter report
-          RPTSTYLE_TABULAR		Creates a tabular report
-          If no report style is specified, a dialog box containing all the above report styles will appear.
-        
+ + + Constant + Description + + + RPTSTYLE_CROSSTAB + Creates a cross-tabular report. + + + RPTSTYLE_FORM + Creates a form-based report + + + RPTSTYLE_FREESTYLE + Creates a free-style report + + + RPTSTYLE_LABEL + Creates a label report + + + RPTSTYLE_LETTER + Creates a letter report + + + RPTSTYLE_TABULAR + Creates a tabular report + + + If no report style is specified, a dialog box containing all the above report styles will appear. This method allows the user to edit the report definition (.RET) file and provides the same environment as the IDE.
@@ -290,48 +335,176 @@ If omitted, the default is 1 (Letter 8 1/2 x 11 in). - Paper Size <> - A3 297 x 420 mm 8 - A4 210 x 297 mm 9 - A4 Small 210 x 297 mm 10 - A5 148 x 210 mm 11 - B4 250 x 354 12 - B5 182 x 257 mm 13 - C size sheet 24 - D size sheet 25 - E size sheet 26 - Envelope B4 250 x 353 mm 33 - Envelope B5 176 x 250 mm 34 - Envelope B6 176 x 125 mm 35 - Envelope C5 162 x 229 mm 28 - Envelope C3 324 x 458 mm 29 - Envelope C4 229 x 324 mm 30 - Envelope C6 114 x 162 mm 31 - Envelope C65 114 x 229 mm 32 - Envelope DL 110 x 220 mm 27 - Envelope 110 x 230 mm 36 - Envelope Monarch 3.875 x 7.5 in 37 - 6 3/4 Envelope 3 5/8 x 6 1/2 in 38 - Envelope #9 3 7/8 x 8 7/8 19 - Envelope #10 4 1/8 x 9 1/2 20 - Envelope #11 4 1/2 x 10 3/8 21 - Envelope #12 4 \276 x 11 22 - Envelope #14 5 x 11 1/2 23 - Executive 7 1/4 x 10 1/2 in 7 - Folio 8 1/2 x 13 in 14 - German Std Fanfold 8 1/2 x 12 in 40 - German Legal Fanfold 8 1/2 x 13 in 41 - Ledger 17 x 11 in 4 - Legal 8 1/2 x 14 in 5 - Letter 8 1/2 x 11 in 1 - Letter Small 8 1/2 x 11 in 2 - Note 8 1/2 x 11 in 18 - Quarto 215 x 275 mm 15 - Statement 5 1/2 x 8 1/2 in 6 - Tabloid 11 x 17 in 3 - US Std Fanfold 14 7/8 x 11 in 39 - 10x14 in 16 - 11x17 in 17 + + + Paper Size + Value + + + A3 297 x 420 mm + 8 + + + A4 210 x 297 mm + 9 + + + A4 Small 210 x 297 mm + 10 + + + A5 148 x 210 mm + 11 + + + B4 250 x 354 + 12 + + + B5 182 x 257 mm + 13 + + + C size sheet + 24 + + + D size sheet + 25 + + + E size sheet + 26 + + + Envelope B4 250 x 353 mm + 33 + + + Envelope B5 176 x 250 mm + 34 + + + Envelope B6 176 x 125 mm + 35 + + + Envelope C5 162 x 229 mm + 28 + + + Envelope C3 324 x 458 mm + 29 + + + Envelope C4 229 x 324 mm + 30 + + + Envelope C6 114 x 162 mm + 31 + + + Envelope C65 114 x 229 mm + 32 + + + Envelope DL 110 x 220 mm + 27 + + + Envelope 110 x 230 mm + 36 + + + Envelope Monarch 3.875 x 7.5 in + 37 + + + 6 3/4 Envelope 3 5/8 x 6 1/2 in + 38 + + + Envelope #9 3 7/8 x 8 7/8 + 19 + + + Envelope #10 4 1/8 x 9 1/2 + 20 + + + Envelope #11 4 1/2 x 10 3/8 + 21 + + + Envelope #12 4 \276 x 11 + 22 + + + Envelope #14 5 x 11 1/2 + 23 + + + Executive 7 1/4 x 10 1/2 in + 7 + + + Folio 8 1/2 x 13 in + 14 + + + German Std Fanfold 8 1/2 x 12 in + 40 + + + German Legal Fanfold 8 1/2 x 13 in + 41 + + + Ledger 17 x 11 in + 4 + + + Legal 8 1/2 x 14 in + 5 + + + Letter 8 1/2 x 11 in + 1 + + + Letter Small 8 1/2 x 11 in + 2 + + + Note 8 1/2 x 11 in + 18 + + + Quarto 215 x 275 mm + 15 + + + Statement 5 1/2 x 8 1/2 in + 6 + + + Tabloid 11 x 17 in + 3 + + + US Std Fanfold 14 7/8 x 11 in + 39 + + + 10x14 in + 16 + + + 11x17 in + 17 + + The paper size should be set before calling Print() or Preview(). Not all paper sizes are supported on all printers. Consult your printer documentation for supported paper sizes. @@ -399,12 +572,24 @@ The state in which the Report Editor window area should be displayed. Specify one of the following constants: -
-          Constant		Description
-          SHOWICONIZED	Iconizes or minimizes the Report Editor window.
-          SHOWNORMAL	Normalizes the Report Editor window.  This is the default.
-          SHOWZOOMED	Maximizes the Report Editor window to a full screen.
-        
+ + + Constant + Description + + + SHOWICONIZED + Iconizes or minimizes the Report Editor window. + + + SHOWNORMAL + Normalizes the Report Editor window. This is the default. + + + SHOWZOOMED + Maximizes the Report Editor window to a full screen. + +
diff --git a/src/Docs/Sql.Xml b/src/Docs/Sql.Xml index 320bf0a9a0..66c7d80e13 100644 --- a/src/Docs/Sql.Xml +++ b/src/Docs/Sql.Xml @@ -161,13 +161,28 @@ A constant (four standard values) representing how the column can be used in searches: One of the following constants (four standard values) representing how the column can be used in searches: -
-                Constant				Meaning
-                SQL_ALL_EXCEPT_LIKE	The column can be used in a WHERE clause with all comparison operators except LIKE.
-                SQL_LIKE_ONLY			The column can be used in a WHERE clause only with the LIKE predicate.
-                SQL_SEARCHABLE		The column can be used in a WHERE clause with any comparison operator.
-                SQL_UNSEARCHABLE		The column cannot be used in a WHERE clause.
-            
+ + + Constant + Meaning + + + SQL_ALL_EXCEPT_LIKE + The column can be used in a WHERE clause with all comparison operators except LIKE. + + + SQL_LIKE_ONLY + The column can be used in a WHERE clause only with the LIKE predicate. + + + SQL_SEARCHABLE + The column can be used in a WHERE clause with any comparison operator. + + + SQL_UNSEARCHABLE + The column cannot be used in a WHERE clause. + +
@@ -449,8 +464,16 @@ Valid values include: SQL_CONCUR_LOCK SQL_CONCUR_READ_ONLY - SQL_CONCUR_TIMESTAMP (equivalent to SQL_CONCUR_ROWVER) - SQL_CONCUR_VALUES (default for most drivers) + + + SQL_CONCUR_TIMESTAMP + (equivalent to SQL_CONCUR_ROWVER) + + + SQL_CONCUR_VALUES + (default for most drivers) + + Refer to your ODBC documentation for a description of these constants.
@@ -2901,11 +2924,28 @@ The option used when the statement is freed, specified by one of the following constants: - Constant Description - SQL_CLOSE Closes the cursor. - SQL_DROP Closes the cursor, unbinds and resets the parameters, and frees the statement. - SQL_RESET_PARAMS Resets the parameters. - SQL_UNBIND Unbinds the parameters. + + + Constant + Description + + + SQL_CLOSE + Closes the cursor. + + + SQL_DROP + Closes the cursor, unbinds and resets the parameters, and frees the statement. + + + SQL_RESET_PARAMS + Resets the parameters. + + + SQL_UNBIND + Unbinds the parameters. + + @@ -2989,7 +3029,12 @@ A string containing the text of the statement. You can use the SQLSelect:SQLString assign to change the statement text. - Note: If you assign a different SQLString and the statement is Preparedm it will become 'unprepared'. + + + Note + If you assign a different SQLString and the statement is Preparedm it will become 'unprepared'. + + diff --git a/src/Docs/VFPDocs.xml b/src/Docs/VFPDocs.xml index 687d0d6463..2d4a4ad3b1 100644 --- a/src/Docs/VFPDocs.xml +++ b/src/Docs/VFPDocs.xml @@ -682,10 +682,10 @@ The following table describes the information returned by the AStackInfo( ) function: - + Array Element Description - + 1 Call Stack Level @@ -8495,7 +8495,7 @@ If eExpression is an array, the first element in the array is evaluated. - + lNullDataType Description diff --git a/src/Docs/VfpRuntimeDocs.xml b/src/Docs/VfpRuntimeDocs.xml index a31920f8ed..2e11582dd9 100644 --- a/src/Docs/VfpRuntimeDocs.xml +++ b/src/Docs/VfpRuntimeDocs.xml @@ -1207,21 +1207,20 @@ Determines whether ALEN( ) returns the number of elements, rows or columns in the array according to the following values for nArrayAttribute: - - - - - - - - - - - - - - -
0Returns the number of elements in the array. Omitting nArrayAttribute is identical to specifying 0.
1Returns the number of rows in the array.
2Returns the number of columns in the array. If the array is a one-dimensional array, ALEN( ) returns 0 (no columns).
+ + + 0 + Returns the number of elements in the array. Omitting nArrayAttribute is identical to specifying 0. + + + 1 + Returns the number of rows in the array. + + + 2 + Returns the number of columns in the array. If the array is a one-dimensional array, ALEN( ) returns 0 (no columns). + + Numeric diff --git a/src/Docs/VoFunctionDocs.xml b/src/Docs/VoFunctionDocs.xml index 23cada9f92..88e6027fe7 100644 --- a/src/Docs/VoFunctionDocs.xml +++ b/src/Docs/VoFunctionDocs.xml @@ -98,17 +98,52 @@ One of the following constants indicating the status of the window: - Constant Meaning - SW_HIDE The window is hidden and another window activated - SW_MINIMIZE The window is minimized and the top-level window in the system's list is activated - SW_RESTORE Window is activated and displayed — if minimized or maximized, Windows restores it to its original size and position (same as SW_SHOWNORMAL). - SW_SHOW Window is activated and displayed in its current size and position - SW_SHOWMAXIMIZED Window is activated and displayed as maximized - SW_SHOWMINIMIZED Window is activated and displayed as an icon - SW_SHOWMINNOACTIVE Window is displayed as an icon, leaving the currently active window active - SW_SHOWNA Window is displayed in its current state, leaving the currently active window active - SW_SHOWNOACTIVATE Window is displayed in its most recent size and position, leaving the currently active window active - SW_SHOWNORMAL Window is activated and displayed — if minimized or maximized, Windows restores it to its original size and position (same as SW_RESTORE). + + + Constant + Meaning + + + SW_HIDE + The window is hidden and another window activated + + + SW_MINIMIZE + The window is minimized and the top-level window in the system's list is activated + + + SW_RESTORE + Window is activated and displayed — if minimized or maximized, Windows restores it to its original size and position (same as SW_SHOWNORMAL). + + + SW_SHOW + Window is activated and displayed in its current size and position + + + SW_SHOWMAXIMIZED + Window is activated and displayed as maximized + + + SW_SHOWMINIMIZED + Window is activated and displayed as an icon + + + SW_SHOWMINNOACTIVE + Window is displayed as an icon, leaving the currently active window active + + + SW_SHOWNA + Window is displayed in its current state, leaving the currently active window active + + + SW_SHOWNOACTIVATE + Window is displayed in its most recent size and position, leaving the currently active window active + + + SW_SHOWNORMAL + Window is activated and displayed — if minimized or maximized, Windows restores it to its original size and position (same as SW_RESTORE). + + @@ -280,7 +315,7 @@ If the function succeeds, the return value is greater than 31. f the function fails, the return value is one of the following error values. - + Return code/value Description @@ -3197,7 +3232,7 @@ A constant defining the copy mode, as shown in the table below:
- + Constant Description @@ -3438,7 +3473,7 @@ A constant defining the copy mode, as shown in the table below:
- + Constant Description @@ -6023,11 +6058,38 @@ DBCopyXStruct() creates a database file whose contents is the structure of the current database file, with a record for the definition of each field. The structure-extended database file has the following structure: - Name Type Length Decimals - Field_Name Character 10 - Field_Type Character 1 - Field_Len Numeric 3 0 - Field_Dec Numeric 3 0 + + + Name + Type + Length + Decimals + + + Field_Name + Character + 10 + + + + Field_Type + Character + 1 + + + + Field_Len + Numeric + 3 + 0 + + + Field_Dec + Numeric + 3 + 0 + + Used in application programs, DBCopyXStruct() permits you to create or modify the structure of a database file programmatically.
To create a new database file from the structure-extended file, use CREATE FROM.
If you need an empty structure-extended file, use CREATE. @@ -6105,13 +6167,21 @@ DBCreate() creates a database file from an array containing the structure of the file. DBCreate() is similar to the CREATE FROM command, which creates a new database file structure from a structure-extended file. Before using DBCreate(), you must first create the array and fill it with the field definition arrays, according to the structure in the table above. You can create the array programmatically or by using DBStruct(). There are some specific rules for creating a field definition array, including: - - Specify all field attributes with a value of the proper data type for the attribute.
- The decimals attribute must be specified — even for non-numeric fields.
- If the field does not have a decimals attribute, specify 0. - - Specify the type attribute using the first letter of the data type as a minimum.
- Use longer and more descriptive terms for readability.
- For example, both "C" and "Character" can be specified as the type attribute for character fields. - - Unlike the CREATE FROM command, DBCreate() does not use the decimals attribute to specify the high-order part of the field length. Specify the field length directly, regardless of its magnitude. + + + Specify all field attributes with a value of the proper data type for the attribute. + The decimals attribute must be specified — even for non-numeric fields. + If the field does not have a decimals attribute, specify 0. + + + Specify the type attribute using the first letter of the data type as a minimum. + Use longer and more descriptive terms for readability. + For example, both "C" and "Character" can be specified as the type attribute for character fields. + + + Unlike the CREATE FROM command, DBCreate() does not use the decimals attribute to specify the high-order part of the field length. Specify the field length directly, regardless of its magnitude. + +
The following example demonstrates DBCreate(): @@ -6194,11 +6264,21 @@ Note:
If the RDD supports multiple orders per index file, add subsequent orders to the index file using DBCreateOrder(). - Side effects: DBCreateIndex() is guaranteed to create an order that, when made the controlling order, will impose the specified logical order on the database.
+ + + Side effects + DBCreateIndex() is guaranteed to create an order that, when made the controlling order, will impose the specified logical order on the database. + + The key expression is not necessarily evaluated at any particular time, by any particular means, or on any particular record or series of records.
If the key expression relies on information external to the database file or work area, the effect is unpredictable.
If the key expression changes the state of the work area (for example, by moving to a different record or changing the contents of a record), the effect is unpredictable. - Key evaluation: Before the key expression is evaluated, the associated work area is automatically selected as the current work area; the previously selected work area is automatically restored afterward. + + + Key evaluation + Before the key expression is evaluated, the associated work area is automatically selected as the current work area; the previously selected work area is automatically restored afterward. + +
@@ -6272,11 +6352,21 @@ Note:
Although this function is designed to work with both single-order and multiple-order index files, you may find it is easier to use DBCreateIndex() for creating single-order index files. - Side effects: DBCreateOrder() is guaranteed to create an order that, when made the controlling order, will impose the specified logical order on the database.
+ + + Side effects + DBCreateOrder() is guaranteed to create an order that, when made the controlling order, will impose the specified logical order on the database. + + The key expression is not necessarily evaluated at any particular time, by any particular means, or on any particular record or series of records.
If the key expression relies on information external to the database file or work area, the effect is unpredictable.
If the key expression changes the state of the work area (for example, by moving to a different record or changing the contents of a record), the effect is unpredictable. - Key evaluation: Before the key expression is evaluated, the associated work area is automatically selected as the current work area; the previously selected work area is automatically restored afterward. + + + Key evaluation + Before the key expression is evaluated, the associated work area is automatically selected as the current work area; the previously selected work area is automatically restored afterward. + +
@@ -6314,8 +6404,16 @@ DBDelete() is the functional equivalent of the DELETE command with a scope of the current record.
For more information, refer to DELETE. - Logical records: If SetDeleted() is TRUE, deleted records are not logically visible. That is, database operations which operate on logical records will not consider records marked for deletion. Note, however, that if SetDeleted() is TRUE when the current record is marked for deletion, the record remains visible until it is no longer the current record. - Shared mode: For a shared database, DBDelete() requires the current record to be locked. + + + Logical records + If SetDeleted() is TRUE, deleted records are not logically visible. That is, database operations which operate on logical records will not consider records marked for deletion. Note, however, that if SetDeleted() is TRUE when the current record is marked for deletion, the record remains visible until it is no longer the current record. + + + Shared mode + For a shared database, DBDelete() requires the current record to be locked. + + @@ -6575,7 +6673,12 @@ This function operates like the DBRelation() and DBRSelect() functions, which save and re-execute the linking expression of a relation within a work area. - Declared variables: A string returned by DBFilter() cannot operate correctly when recompiled and executed using the macro operator (&) if the original filter expression contained references to local or static variables or is otherwise dependent on compile-time declarations. + + + Declared variables + A string returned by DBFilter() cannot operate correctly when recompiled and executed using the macro operator (&) if the original filter expression contained references to local or static variables or is otherwise dependent on compile-time declarations. + + @@ -6637,10 +6740,20 @@ DBGoBottom() is the functional equivalent of the GO BOTTOM command.
For more information, refer to the GO command. - Logical records: DBGoBottom() operates on logical records.
+ + + Logical records + DBGoBottom() operates on logical records. + + If the work area has an active order list, DBGoBottom() moves to the last record in controlling order.
If a filter is set, only records which meet the filter condition are considered. - Shared mode: For a shared file, moving to a different record can cause updates to the current record to become visible to other processes. + + + Shared mode + For a shared file, moving to a different record can cause updates to the current record to become visible to other processes. + +
@@ -6688,8 +6801,16 @@ DbGoTo() performs the same function as the GO command.
For more information, refer to the GO command. - Logical records: DBGoTo() does not respect logical visibility. That is, if the specified record exists, it will become the current record regardless of any order or filter condition. - Shared mode: For a shared file, moving to a different record can cause updates to the current record to become visible to other processes. + + + Logical records + DBGoTo() does not respect logical visibility. That is, if the specified record exists, it will become the current record regardless of any order or filter condition. + + + Shared mode + For a shared file, moving to a different record can cause updates to the current record to become visible to other processes. + + @@ -6727,10 +6848,20 @@ DBGoTop() performs the same function as the GO TOP command. - Logical records: DBGoTop() operates on logical records.
+ + + Logical records + DBGoTop() operates on logical records. + + If the work area has an active order list, DBGoTop() moves to the first record in the controlling order.
If a filter is set, only records which meet the filter condition are considered. - Shared mode: For a shared file, moving to a different record can cause updates to the current record to become visible to other processes. + + + Shared mode + For a shared file, moving to a different record can cause updates to the current record to become visible to other processes. + +
@@ -7086,9 +7217,19 @@ DBRecall() performs the same function as the RECALL command.
For more information, refer to the DELETE and RECALL commands. - Logical records: Reinstating a deleted record affects the record's logical visibility if SetDeleted() is TRUE.
+ + + Logical records + Reinstating a deleted record affects the record's logical visibility if SetDeleted() is TRUE. + + For more information, refer to the DBDelete() function and the DELETE and RECALL commands. - Shared mode: For a shared database, DBRecall() requires the current record to be locked. + + + Shared mode + For a shared database, DBRecall() requires the current record to be locked. + +
@@ -7232,7 +7373,12 @@ DBRelation() returns the linking expression defined by the TO clause. DBRSelect() returns the work area linked as defined by the INTO clause. - Declared variables: A string returned by DBRelation() cannot operate correctly when recompiled and executed using the macro operator (&) if the original expression contained references to local or static variables, or otherwise depends on compile-time declarations. + + + Declared variables + A string returned by DBRelation() cannot operate correctly when recompiled and executed using the macro operator (&) if the original expression contained references to local or static variables, or otherwise depends on compile-time declarations. + + @@ -7470,9 +7616,19 @@ DBSeek() performs the same function as the SEEK command.
For more information, refer to the SEEK command. - Logical records: DBSeek() operates on logical records. Records are processed in controlling order.
+ + + Logical records + DBSeek() operates on logical records. Records are processed in controlling order. + + If a filter is set, only records which meet the filter condition are considered. - Shared mode: For a shared file, moving to a different record can cause updates to the current record to become visible to other processes. + + + Shared mode + For a shared file, moving to a different record can cause updates to the current record to become visible to other processes. + +
@@ -7530,8 +7686,16 @@ DBSelectArea() performs the same function as the SELECT command.
For more information, refer to the SELECT command. - Selecting 0: Selecting work area 0 causes the lowest numbered unoccupied work area to become the current work area. - Aliased expressions: The alias operator (->) can temporarily select a work area while an expression is evaluated and automatically restore the previously selected work area afterward. + + + Selecting 0 + Selecting work area 0 causes the lowest numbered unoccupied work area to become the current work area. + + + Aliased expressions + The alias operator (->) can temporarily select a work area while an expression is evaluated and automatically restore the previously selected work area afterward. + + @@ -7928,12 +8092,25 @@ DBSetRelation() performs the same function as the SET RELATION command with the ADDITIVE clause.
For more information, refer to the SET RELATION command. - Side effects: DBSetRelation() is only guaranteed to synchronize the work areas as described above.
+ + + Side effects + DBSetRelation() is only guaranteed to synchronize the work areas as described above. + + The relational expression is not necessarily evaluated at any particular time, by any particular means, or on any particular record or series of records.
If the relational expression relies on information external to the parent work area or its associated database file, the effect is unpredictable.
If the expression changes the state of either work area (for example, by moving to a different record or changing the contents of a record), the effect is unpredictable. - Evaluation context: When the relational expression is evaluated, the parent work area is automatically selected as the current work area before the evaluation; the previously selected work area is automatically restored afterward. - Soft seeking: Seek operations that occur as part of relational positioning are never soft seeks.
+ + + Evaluation context + When the relational expression is evaluated, the parent work area is automatically selected as the current work area before the evaluation; the previously selected work area is automatically restored afterward. + + + Soft seeking + Seek operations that occur as part of relational positioning are never soft seeks. + + If a relational movement is unsuccessful, the child work area is positioned to LastRec() + 1, its Found() status returns FALSE, and its EOF() status returns TRUE.
@@ -8016,10 +8193,20 @@ DBSkip() is the functional equivalent of the SKIP command.
For more information, refer to the SKIP command. - Logical records: DBSkip() operates on logical records.
+ + + Logical records + DBSkip() operates on logical records. + + If the work area has an active order list, records are considered in controlling order.
If a filter is set, only records which meet the filter condition are considered. - Shared mode: For a shared file, moving to a different record can cause updates to the current record to become visible to other processes. + + + Shared mode + For a shared file, moving to a different record can cause updates to the current record to become visible to other processes. + +
@@ -8289,7 +8476,12 @@ DBUnLock() releases any record or file locks obtained by the current process for a work area. DBUnLock() is only meaningful on a shared database. - Shared mode: Releasing locks can cause updates to the database to become visible to other processes. + + + Shared mode + Releasing locks can cause updates to the database to become visible to other processes. + + @@ -8390,7 +8582,12 @@ The source database file can be open in any mode. DBUpdate() is the functional equivalent of the UPDATE command. - Deleted records: If SetDeleted() is FALSE, deleted records in both source files are processed. Records in the file being updated retain their deleted status and are not affected by the deleted status of records in the source file.
+ + + Deleted records + If SetDeleted() is FALSE, deleted records in both source files are processed. Records in the file being updated retain their deleted status and are not affected by the deleted status of records in the source file. + + If SetDeleted()is TRUE, however, no deleted records are processed from either source file
@@ -10253,21 +10450,40 @@ - Constant Returns
- - FA_DIRECTORY D
- - FA_VOLUME V
- - FC_ARCHIVED A
- - FC_HIDDEN H
- - FC_NORMAL NULL_STRING
- - FC_READONLY R
- - FC_SYSTEM S + + + Constant + Returns + + + FA_DIRECTORY + D + + + FA_VOLUME + V + + + FC_ARCHIVED + A + + + FC_HIDDEN + H + + + FC_NORMAL + NULL_STRING + + + FC_READONLY + R + + + FC_SYSTEM + S + + One or more of the characters indicated in the table above, depending upon what file attribute constants were specified in .
@@ -10298,14 +10514,40 @@ A value indicating the attributes of the current file. The constants in the following table can be used individually or added together to determine which attributes are applicable: - Constant Description - FA_DIRECTORY Directory - FA_VOLUME Volume - FC_ARCHIVED Archived - FC_HIDDEN Hidden - FC_NORMAL Read/write - FC_READONLY Read-only - FC_SYSTEM System + + + Constant + Description + + + FA_DIRECTORY + Directory + + + FA_VOLUME + Volume + + + FC_ARCHIVED + Archived + + + FC_HIDDEN + Hidden + + + FC_NORMAL + Read/write + + + FC_READONLY + Read-only + + + FC_SYSTEM + System + + Note:
It is not uncommon for a file to have more than one attribute.
For example, it may be read-only and archived, which would be represented as FC_READONLY + FC_ARCHIVED or _Or(FC_READONLY, FC_ARCHIVED). @@ -10520,17 +10762,32 @@ One of the following constants indicating the attribute to be set when creating the file:
- Constant Description
- - FC_ARCHIVED Archived file
- - FC_HIDDEN Hidden file
- - FC_NORMAL Normal read/write file
- - FC_READONLY Read-only file
- - FC_SYSTEM System file + + + Constant + Description + + + FC_ARCHIVED + Archived file + + + FC_HIDDEN + Hidden file + + + FC_NORMAL + Normal read/write file + + + FC_READONLY + Read-only file + + + FC_SYSTEM + System file + + The DOS file handle number of the new file.
@@ -10575,17 +10832,32 @@ One of the following constants indicating the attribute to be set when creating the file:
- Constant Description
- - FC_ARCHIVED Archived file
- - FC_HIDDEN Hidden file
- - FC_NORMAL Normal read/write file
- - FC_READONLY Read-only file
- - FC_SYSTEM System file + + + Constant + Description + + + FC_ARCHIVED + Archived file + + + FC_HIDDEN + Hidden file + + + FC_NORMAL + Normal read/write file + + + FC_READONLY + Read-only file + + + FC_SYSTEM + System file + + The DOS file handle number of the new file.
@@ -10712,10 +10984,21 @@ A subsequent error code to set FError() to.
These are additional error codes used by X#: + + + Error + Meaning + + + 256 + Disk full + + + 257 + EOF was already reached when a read was tried + + - Meaning - Disk full - EOF was already reached when a read was tried The error from the last file operation or the last user-specified setting.
If there was no error, FError() returns 0. @@ -10763,17 +11046,32 @@ - Constant Description
- - FA_DIRECTORY Directory
- - FA_VOLUME Volume
- - FC_HIDDEN Hidden
- - FC_NORMAL Visible
- - FC_SYSTEM System
+ + + Constant + Description + + + FA_DIRECTORY + Directory + + + FA_VOLUME + Volume + + + FC_HIDDEN + Hidden + + + FC_NORMAL + Visible + + + FC_SYSTEM + System + + To specify more than one constant, you can either add attributes together, as in FC_SYSTEM + FC_HIDDEN, or use the _Or() operator, as in _Or(FC_SYSTEM, FC_HIDDEN).
@@ -10834,17 +11132,32 @@ One or more of the following constants indicating the file attributes to be used with as search criteria:
- Constant Description
- - FA_DIRECTORY Directory
- - FA_VOLUME Volume
- - FC_HIDDEN Hidden
- - FC_NORMAL Visible
- - FC_SYSTEM System
+ + + Constant + Description + + + FA_DIRECTORY + Directory + + + FA_VOLUME + Volume + + + FC_HIDDEN + Hidden + + + FC_NORMAL + Visible + + + FC_SYSTEM + System + + To specify more than one constant, you can either add attributes together, as in FC_SYSTEM + FC_HIDDEN, or use the _Or() operator, as in _Or(FC_SYSTEM, FC_HIDDEN).
@@ -11958,31 +12271,59 @@ Available open and sharing mode constants are listed below:
- Access Modes Operation
- - FO_READ Open for reading (default)
- - FO_READWRITE Open for reading or writing
- - FO_WRITE Open for writing
+ + + Access Modes + Operation + + + FO_READ + Open for reading (default) + + + FO_READWRITE + Open for reading or writing + + + FO_WRITE + Open for writing + +
- Sharing Modes Operation
- - FO_COMPAT Compatibility mode (default)
- - FO_DENYNONE Allow others to read or write
- - FO_DENYREAD Prevent others from reading
- - FO_DENYWRITE Prevent others from writing
- - FO_EXCLUSIVE Exclusive use
- - FO_SHARED Same as FO_DENYNONE
+ + + Sharing Modes + Operation + + + FO_COMPAT + Compatibility mode (default) + + + FO_DENYNONE + Allow others to read or write + + + FO_DENYREAD + Prevent others from reading + + + FO_DENYWRITE + Prevent others from writing + + + FO_EXCLUSIVE + Exclusive use + + + FO_SHARED + Same as FO_DENYNONE + + The default open mode is non-sharable and read-only.
If just the access mode is used, the file is opened as non-sharable. @@ -13417,21 +13758,48 @@ One or more of the following constants or strings:
- Character Constant Description
- - A FC_ARCHIVED Archived
- - D FA_DIRECTORY Directory
- - H FC_HIDDEN Hidden
- - NULL_STRING FC_NORMAL Read/write
- - R FC_READONLY Read-only
- - S FC_SYSTEM System
- - V FA_VOLUME Search for the DOS volume label and exclude all other files
+ + + Character + Constant + Description + + + A + FC_ARCHIVED + Archived + + + D + FA_DIRECTORY + Directory + + + H + FC_HIDDEN + Hidden + + + NULL_STRING + FC_NORMAL + Read/write + + + R + FC_READONLY + Read-only + + + S + FC_SYSTEM + System + + + V + FA_VOLUME + Search for the DOS volume label and exclude all other files + + To specify more than one constant, you can either add attributes together, as in FC_SYSTEM + FC_HIDDEN, or use the _Or() operator, as in _Or(FC_SYSTEM, FC_HIDDEN).
To specify more than one string, simply concatenate them, as in "SH." @@ -15179,11 +15547,28 @@ The instance variable that you want information about. A numeric value that can be interpreted as follows: - wIvarInfo Description - 0 Not found - 1 INSTANCE declaration - 2 EXPORT declaration - 3 ACCESS declaration + + + wIvarInfo + Description + + + 0 + Not found + + + 1 + INSTANCE declaration + + + 2 + EXPORT declaration + + + 3 + ACCESS declaration + + Note: PROTECT and HIDDEN variables cannot be tested with this function. @@ -15372,11 +15757,28 @@ The instance variable that you want information about. A numeric value that can be interpreted as follows: - wIvarInfo Description - 0 Not found - 1 INSTANCE declaration - 2 EXPORT declaration - 3 ASSIGN declaration + + + wIvarInfo + Description + + + 0 + Not found + + + 1 + INSTANCE declaration + + + 2 + EXPORT declaration + + + 3 + ASSIGN declaration + + Note: PROTECT and HIDDEN variables cannot be tested with this function. @@ -17613,34 +18015,119 @@ Report the status of memory. - One of the following constants, indicating the type of memory information about which you want to report (note that each constant begins with the prefix MEMORY_ as illustrated in the example below): - Action/Returns - Size of activation stack table in bytes (maximum is 64) - ClassCount() - CollectForced() - CollectCount() - DynInfoFree() - DynInfoMax() - DynInfoSize() - DynInfoUsed() - FCount() - MaxAtom() - MemTotal() - Size of private var table in bytes (maximum is 64) - Size of public var table in bytes (maximum is 64) - Number of _RegCollNotifyEnd() active - Number of _RegCollNotifyStart() active - Number of RegisterAxit() active - Number of _RegisterExit() active - Number of RegisterKid() active - Size of SEQUENCE table in bytes (maximum is 64) (see LABEL...()) - Stack pointer of application - Free stack space in bytes - Size of stack segment of application - Number of stack KID active - Calls the Windows API GlobalMemoryStatus() function, returning MemoryStatus.dwTotalPhys - Calls the Windows API GlobalMemoryStatus() function, returning MemoryStatus.dwAvailPhys - Calls the Windows API GlobalMemoryStatus() function, returning MemoryStatus.dwMemoryLoad + + One of the following constants, indicating the type of memory information about which you want to report (note that each constant begins with the prefix MEMORY_ as illustrated in the example below): + + + Constant + Action/Returns + + + MEMORY_ACTIVATION + Size of activation stack table in bytes (maximum is 64) + + + MEMORY_CLASSCOUNT + ClassCount() + + + MEMORY_COLLECT + CollectForced() + + + MEMORY_COLLECTCOUNT + CollectCount() + + + MEMORY_DYNINFOFREE + DynInfoFree() + + + MEMORY_DYNINFOMAX + DynInfoMax() + + + MEMORY_DYNINFOSIZE + DynInfoSize() + + + MEMORY_DYNINFOUSED + DynInfoUsed() + + + MEMORY_FUNCTIONCOUNT + FCount() + + + MEMORY_MAXATOM + MaxAtom() + + + MEMORY_MEMTOTAL + MemTotal() + + + MEMORY_PRIVAT + Size of private var table in bytes (maximum is 64) + + + MEMORY_PUBLIC + Size of public var table in bytes (maximum is 64) + + + MEMORY_REGCOLLNOTIFYEND_COUNT + Number of _RegCollNotifyEnd() active + + + MEMORY_REGCOLLNOTIFYSTART_COUNT + Number of _RegCollNotifyStart() active + + + MEMORY_REGISTERAXIT + Number of RegisterAxit() active + + + MEMORY_REGISTEREXIT_COUNT + Number of _RegisterExit() active + + + MEMORY_REGISTERKID + Number of RegisterKid() active + + + MEMORY_SEQUENCE + Size of SEQUENCE table in bytes (maximum is 64) (see LABEL...()) + + + MEMORY_SP + Stack pointer of application + + + MEMORY_STACK_FREE + Free stack space in bytes + + + MEMORY_STACK_SIZE + Size of stack segment of application + + + MEMORY_STACKKID + Number of stack KID active + + + MEMORY_SYSTEM_FREE + Calls the Windows API GlobalMemoryStatus() function, returning MemoryStatus.dwTotalPhys + + + MEMORY_SYSTEM_MAX + Calls the Windows API GlobalMemoryStatus() function, returning MemoryStatus.dwAvailPhys + + + MEMORY_WINDOWS_SYSTEMRESOURCES + Calls the Windows API GlobalMemoryStatus() function, returning MemoryStatus.dwMemoryLoad + + + @@ -18416,15 +18903,62 @@
Mod() is not implemented using the X# modulus operator (%). Note that there are differences between the Mod() function and the modulus operator, which are described in the following table: - Dividend Divisor Modulus Operator Mod() function - 3 0 Error 3 - 3 -2 1 -1 - -3 2 -1 1 - -3 0 Error -3 - -1 3 -1 2 - -2 3 -2 1 - 2 -3 2 -1 - 1 -3 1 -2 + + + Dividend + Divisor + Modulus Operator + Mod() function + + + 3 + 0 + Error + 3 + + + 3 + -2 + 1 + -1 + + + -3 + 2 + -1 + 1 + + + -3 + 0 + Error + -3 + + + -1 + 3 + -1 + 2 + + + -2 + 3 + -2 + 1 + + + 2 + -3 + 2 + -1 + + + 1 + -3 + 1 + -2 + + In dBASE III PLUS, a 0 divisor returns the dividend for every value of the dividend. In versions of CA-Clipper prior to Summer '87, a 0 divisor returned 0 for all dividends. In X#, by contrast, the modulus of any dividend using a 0 divisor causes a runtime error. @@ -20311,11 +20845,23 @@ ProcLine() queries the X# activation stack to determine the last line executed in a currently executing procedure, function, or method. ProcLine() is used with ProcFile() and ProcName() to report debugging information. ProcLine() and ProcName() are controlled by two options on the Application menu: - 1. Application Compiler Options displays a list of CA-Clipper compatibility options, one of which is PROCNAME/PROCLINE: - If PROCNAME/PROCLINE is selected, these functions will compile and run accurately. - If PROCNAME/PROCLINE is not selected, these functions will compile and run but may not produce accurate results. - 2. Application Properties displays a Debug option.
- If this option is selected, these functions will produce accurate results even if PROCNAME/PROCLINE is not selected. + + + 1 + + Application Compiler Options displays a list of CA-Clipper compatibility options, one of which is PROCNAME/PROCLINE: + If PROCNAME/PROCLINE is selected, these functions will compile and run accurately. + If PROCNAME/PROCLINE is not selected, these functions will compile and run but may not produce accurate results. + + + + 2 + + Application Properties displays a Debug option. + If this option is selected, these functions will produce accurate results even if PROCNAME/PROCLINE is not selected. + + + The SET PROCLINE command overrides these compiler options and application settings on an entity level. See the SET PROCLINE entry for more information.
@@ -20351,11 +20897,23 @@ ProcName() queries the X# activation stack to determine the name of a currently executing procedure, function, or method. ProcName() is used with ProcFile() and ProcLine() to report debugging information. ProcLine() and ProcName() are controlled by two options on the Application menu: - 1. Application Compiler Options displays a list of CA-Clipper compatibility options, one of which is PROCNAME/PROCLINE: - If PROCNAME/PROCLINE is selected, these functions will compile and run accurately. - If PROCNAME/PROCLINE is not selected, these functions will compile and run but may not produce accurate results. - 2. Application Properties displays a Debug option.
- If this option is selected, these functions will produce accurate results even if PROCNAME/PROCLINE is not selected. + + + 1 + + Application Compiler Options displays a list of CA-Clipper compatibility options, one of which is PROCNAME/PROCLINE: + If PROCNAME/PROCLINE is selected, these functions will compile and run accurately. + If PROCNAME/PROCLINE is not selected, these functions will compile and run but may not produce accurate results. + + + + 2 + + Application Properties displays a Debug option. + If this option is selected, these functions will produce accurate results even if PROCNAME/PROCLINE is not selected. + + + The SET PROCNAME command overrides these compiler options and application settings on an entity level. See the SET PROCNAME entry for more information.
@@ -20921,13 +21479,24 @@ The types of RDDs to count.
The types are
- Constant Description
- - RDT_FULL Fully implemented RDDs
- - RDT_TRANSFER Transfer RDDs
- - RDT_HIDDEN Specific RDDs
+ + + Constant + Description + + + RDT_FULL + Fully implemented RDDs + + + RDT_TRANSFER + Transfer RDDs + + + RDT_HIDDEN + Specific RDDs + + If is not specified, RDT_FULL + RDT_TRANSFER is assumed. @@ -20997,13 +21566,24 @@ The types of RDDs to include in the list.
The types are:
- Constant Description
- - RDT_FULL Fully implemented RDDs
- - RDT_TRANSFER Transfer RDDs
- - RDT_HIDDEN Specific RDDs
+ + + Constant + Description + + + RDT_FULL + Fully implemented RDDs + + + RDT_TRANSFER + Transfer RDDs + + + RDT_HIDDEN + Specific RDDs + + If is not specified, RDT_FULL + RDT_TRANSFER is assumed. @@ -22412,10 +22992,24 @@ For database fields of type FLOAT, such picture information resides in the database header structure and is obtainable by FieldVal(). With the Val() function and with literal floats (that is, hard-coded in source code and thus known at compile time), the number of decimals is derived from the hard-coded decimal portion and the number of digits is taken from SetDigit(). If new floats are generated in expressions or by functions, the number of digits is always taken from SetDigit() and the number of decimals is determined as follows: - Operators Number of decimals - + or - Maximum of two operands - * Sum of two operands - / Current setting of SetDecimal() + + + Operators + Number of decimals + + + + or - + Maximum of two operands + + + * + Sum of two operands + + + / + Current setting of SetDecimal() + + For functions, the number of decimals is determined by the current setting of SetDecimal() or a zero for special cases such as the Integer() function.
@@ -22955,15 +23549,44 @@ Therefore, if an application uses the #Clipper international mode, it will behave the same on all machines. Thus, to achieve a different internationalization routine, you would need a specialized version of VO28NAT.DLL. On the other hand, if the application uses the #Windows international mode, it will behave differently from machine to machine, depending on information defined in the International settings of the Control Panel. Changing SetInternational() automatically changes SetCollation() so that the two settings are the same. SetInternational() also determines the initial defaults for the functions listed in the table below and resets them each time you call the function.
For SetInternational(#Windows), the settings are taken from the corresponding International settings in the Control Panel: - Function SetInternational(#Clipper) Default - GetAMExt()/SetAMExt() NULL_STRING - GetPMExt()/SetPMExt() NULL_STRING - SetAMPM() 24-hour format - SetDateFormat() mm/dd/yy - SetDecimal() 2 - SetDecimalSep() Period (.) - SetTimeSep() Colon (:) - SetThousandSep() Comma (,) + + + Function + SetInternational(#Clipper) Default + + + GetAMExt()/SetAMExt() + NULL_STRING + + + GetPMExt()/SetPMExt() + NULL_STRING + + + SetAMPM() + 24-hour format + + + SetDateFormat() + mm/dd/yy + + + SetDecimal() + 2 + + + SetDecimalSep() + Period (.) + + + SetTimeSep() + Colon (:) + + + SetThousandSep() + Comma (,) + + Leading zeros in time strings:
The leading zeros International setting in the Control Panel is ignored. Leading zeros are always displayed for time strings. @@ -25119,20 +25742,92 @@ The table below shows the frequencies of standard musical notes. Note:
Tone() works only on IBM PC and 100% compatible computers. - Pitch Frequency Pitch Frequency - C 130.80 mid C 261.70 - C# 138.60 C# 277.20 - D 146.80 D 293.70 - D# 155.60 D# 311.10 - E 164.80 E 329.60 - F 174.60 F 349.20 - F# 185.00 F# 370.00 - G 196.00 G 392.00 - G# 207.70 G# 415.30 - A 220.00 A 440.00 - A# 233.10 A# 466.20 - B 246.90 B 493.90 - C 523.30 + + + Pitch + Frequency + Pitch + Frequency + + + C + 130.80 + mid C + 261.70 + + + C# + 138.60 + C# + 277.20 + + + D + 146.80 + D + 293.70 + + + D# + 155.60 + D# + 311.10 + + + E + 164.80 + E + 329.60 + + + F + 174.60 + F + 349.20 + + + F# + 185.00 + F# + 370.00 + + + G + 196.00 + G + 392.00 + + + G# + 207.70 + G# + 415.30 + + + A + 220.00 + A + 440.00 + + + A# + 233.10 + A# + 466.20 + + + B + 246.90 + B + 493.90 + + + C + 523.30 + + + + This example is a beep function that indicates that a batch operation has completed: @@ -25198,16 +25893,48 @@ If a function string is present, the @ character must be the leftmost character of the picture string, and the function string must not contain spaces.
A function string can be specified alone or with a template string.
If both are present, the function string must precede the template string, and the two must be separated by a single space. - Function Action - B Displays numbers left-justified - C Displays CR after positive numbers - D Displays date in SET DATE format - E Displays date in British format - R Nontemplate characters are inserted - X Displays DB after negative numbers - Z Displays zeros as blanks - ( Encloses negative numbers in parentheses - ! Converts alphabetic characters to uppercase + + + Function + Action + + + B + Displays numbers left-justified + + + C + Displays CR after positive numbers + + + D + Displays date in SET DATE format + + + E + Displays date in British format + + + R + Nontemplate characters are inserted + + + X + Displays DB after negative numbers + + + Z + Displays zeros as blanks + + + ( + Encloses negative numbers in parentheses + + + ! + Converts alphabetic characters to uppercase + + Template string:
A picture template string specifies formatting rules on a character by character basis.
The template string consists of a series of characters, some of which have special meanings (see table below).
@@ -25216,15 +25943,44 @@ If the @R picture function is used, these characters are inserted between characters of the return value; otherwise, they overwrite the corresponding characters of the return value.
A template string can be specified alone or with a function string.
If both are present, the function string must precede the template string, and the two must be separated by a single space. - Template Action - A,N,X,9,# Displays digits for any data type - L Displays logicals as "T" or "F" - Y Displays logicals as "Y" or "N" - ! Converts an alphabetic character to uppercase - $ Displays a dollar sign in place of a leading space in a numeric - * Displays an asterisk in place of a leading space in a numeric - . Specifies a decimal point position - , Specifies a comma position + + + Template + Action + + + A,N,X,9,# + Displays digits for any data type + + + L + Displays logicals as "T" or "F" + + + Y + Displays logicals as "Y" or "N" + + + ! + Converts an alphabetic character to uppercase + + + $ + Displays a dollar sign in place of a leading space in a numeric + + + * + Displays an asterisk in place of a leading space in a numeric + + + . + Specifies a decimal point position + + + , + Specifies a comma position + + This example formats a number into a currency format using a template: @@ -25329,18 +26085,56 @@ One of the following characters: - Returns Meaning - A Array - B Block - C String - D Date - L Logical - M Memo - N Numeric - O Object - U NIL, local, or static - UE Error syntactical - UI Error indeterminate + + + Returns + Meaning + + + A + Array + + + B + Block + + + C + String + + + D + Date + + + L + Logical + + + M + Memo + + + N + Numeric + + + O + Object + + + U + NIL, local, or static + + + UE + Error syntactical + + + UI + Error indeterminate + + Type() uses the macro operator (&) to determine the argument's data type; therefore, you cannot use it to determine the data type of undeclared variables or functions that are not intended for used with macros.
@@ -25619,18 +26413,56 @@ The data type of .
The return values have the following meanings: - Returns Meaning - ARRAY Array - CODEBLOCK Code block - DATE Date - FLOAT Float, Real4, Real8 - LOGIC Logical value - LONGINT Byte, Word, DWord, ShortInt, Int, LongInt - OBJECT Object or runtime code block (see example below) - VOID NIL - PTR Pointer - STRING String, PSZ - SYMBOL Symbol + + + Returns + Meaning + + + ARRAY + Array + + + CODEBLOCK + Code block + + + DATE + Date + + + FLOAT + Float, Real4, Real8 + + + LOGIC + Logical value + + + LONGINT + Byte, Word, DWord, ShortInt, Int, LongInt + + + OBJECT + Object or runtime code block (see example below) + + + VOID + NIL + + + PTR + Pointer + + + STRING + String, PSZ + + + SYMBOL + Symbol + + If is passed by reference, 128 is automatically added to the return value (see the last example).
@@ -25812,17 +26644,53 @@ One of the following characters, which represent the data type of : - Characters Meaning - A Array - B Code block - C String, PSZ - D Date - L Logic - N LongInt, ShortInt, Byte, Word, Dword, Real4, Real8, Float, Numeric - O Object - U NIL - # Symbol - - PTR + + + Characters + Meaning + + + A + Array + + + B + Code block + + + C + String, PSZ + + + D + Date + + + L + Logic + + + N + LongInt, ShortInt, Byte, Word, Dword, Real4, Real8, Float, Numeric + + + O + Object + + + U + NIL + + + # + Symbol + + + + + PTR + + If is passed by reference, the return value will be preceded by an @ sign (see the second example). @@ -27003,11 +27871,25 @@ The types of RDDs to include in the list.
The types are: + + + Constant + Description + + + RDT_FULL + Fully implemented RDDs + + + RDT_TRANSFER + Transfer RDDs + + + RDT_HIDDEN + Specific RDDs + + - Description - Fully implemented RDDs - Transfer RDDs - Specific RDDs TRUE, if successful; otherwise, FALSE.
A FALSE return value indicates an error, but this function does not call the error handler and will not, therefore, produce a runtime error message or create an error object if it fails. Thus, it may be important to check the return value to determine if the function succeeded.
diff --git a/src/Docs/XPPComments.Xml b/src/Docs/XPPComments.Xml index b2a504ec44..ecb8d46edc 100644 --- a/src/Docs/XPPComments.Xml +++ b/src/Docs/XPPComments.Xml @@ -43,7 +43,7 @@ CLASS_DESCR_MEMBERS Two dimensional array with 3-columns holding information about member variables.
- + CLASS_MEMBER_NAME Character string representing the name of a single member variable @@ -63,7 +63,7 @@ CLASS_DESCR_METHODS Two dimensional array with 3-columns array holding information about methods. - + CLASS_METHOD_NAME Character string with the name of the method