doc cleanups
This commit is contained in:
@@ -10,6 +10,10 @@
|
||||
* Change, ! Fix, % Optimization, + Addition, - Removal, ; Comment
|
||||
*/
|
||||
|
||||
2013-03-18 19:03 UTC+0100 Viktor Szakats (harbour syenar.net)
|
||||
* doc/en/*.txt
|
||||
* doc cleanups
|
||||
|
||||
2013-03-18 17:22 UTC+0100 Viktor Szakats (harbour syenar.net)
|
||||
* contrib/hbcairo/pattern.c
|
||||
! fixed cairo_pattern_get_radial_points() to cairo_pattern_get_radial_circles()
|
||||
|
||||
@@ -73,7 +73,7 @@
|
||||
$ONELINER$
|
||||
Dynamically add an element to an array
|
||||
$SYNTAX$
|
||||
AAdd(<aArray>[, <xValue>]) --> Value
|
||||
AAdd( <aArray>[, <xValue>] ) --> Value
|
||||
$ARGUMENTS$
|
||||
<aArray> The name of an array
|
||||
|
||||
@@ -119,7 +119,7 @@
|
||||
$ONELINER$
|
||||
Adjust the size of an array
|
||||
$SYNTAX$
|
||||
ASize(<aArray>, <nLen>) --> aTarget
|
||||
ASize( <aArray>, <nLen> ) --> aTarget
|
||||
$ARGUMENTS$
|
||||
<aArray> Name of array to be dynamically altered
|
||||
|
||||
@@ -241,7 +241,7 @@
|
||||
$ONELINER$
|
||||
Delete an element form an array.
|
||||
$SYNTAX$
|
||||
ADel(<aArray>, <nPos>) --> aTarget
|
||||
ADel( <aArray>, <nPos> ) --> aTarget
|
||||
$ARGUMENTS$
|
||||
<aArray> Name of array from which an element is to be removed.
|
||||
|
||||
@@ -299,7 +299,7 @@
|
||||
element to be filled and the array elements will continue to be
|
||||
filled for <nCount> positions. If Not specified, the value of
|
||||
<nStart> will be 1, and the value of <nCount> will be the value
|
||||
of Len(<aArray>); thus, all subscript positions in the array
|
||||
of Len( <aArray> ); thus, all subscript positions in the array
|
||||
<aArray> will be filled with the value of <xValue>.
|
||||
|
||||
This function will work on only a single dimension of <aArray>.
|
||||
@@ -389,7 +389,7 @@
|
||||
$ONELINER$
|
||||
Evaluates the subscript element of an array
|
||||
$SYNTAX$
|
||||
AEval(<aArray>, <bBlock>, [<nStart>], [<nCount>]) --> aArray
|
||||
AEval( <aArray>, <bBlock>, [<nStart>], [<nCount>] ) --> aArray
|
||||
$ARGUMENTS$
|
||||
<aArray> Is the array to be evaluated.
|
||||
|
||||
@@ -505,7 +505,7 @@
|
||||
$ONELINER$
|
||||
Duplicate a multidimensional array
|
||||
$SYNTAX$
|
||||
AClone(<aSource>) --> aDuplicate
|
||||
AClone( <aSource> ) --> aDuplicate
|
||||
$ARGUMENTS$
|
||||
<aSource> Name of the array to be cloned.
|
||||
$RETURNS$
|
||||
|
||||
@@ -21,7 +21,7 @@
|
||||
$ONELINER$
|
||||
Converts a date to the day of week
|
||||
$SYNTAX$
|
||||
CDoW(<dDate>) --> cDay
|
||||
CDoW( <dDate> ) --> cDay
|
||||
$ARGUMENTS$
|
||||
<dDate> Any date expression.
|
||||
$RETURNS$
|
||||
@@ -61,7 +61,7 @@
|
||||
$ONELINER$
|
||||
Return the name of the month.
|
||||
$SYNTAX$
|
||||
CMonth(<dDate>) --> cMonth
|
||||
CMonth( <dDate> ) --> cMonth
|
||||
$ARGUMENTS$
|
||||
<dDate> Any date expression.
|
||||
$RETURNS$
|
||||
@@ -136,7 +136,7 @@
|
||||
$ONELINER$
|
||||
Converts a character string to a date expression
|
||||
$SYNTAX$
|
||||
CToD(<cDateString>) --> dDate
|
||||
CToD( <cDateString> ) --> dDate
|
||||
$ARGUMENTS$
|
||||
<cDateString> A character date in format 'mm/dd/yy'
|
||||
$RETURNS$
|
||||
@@ -176,7 +176,7 @@
|
||||
$ONELINER$
|
||||
Return the numeric day of the month.
|
||||
$SYNTAX$
|
||||
Day(<cDate>) --> nMonth
|
||||
Day( <cDate> ) --> nMonth
|
||||
$ARGUMENTS$
|
||||
<cDate> Any valid date expression.
|
||||
$RETURNS$
|
||||
@@ -212,7 +212,7 @@
|
||||
$ONELINER$
|
||||
Convert elapsed seconds into days
|
||||
$SYNTAX$
|
||||
Days(<nSecs> ) --> nDay
|
||||
Days( <nSecs> ) --> nDay
|
||||
$ARGUMENTS$
|
||||
<nSecs> The number of seconds
|
||||
$RETURNS$
|
||||
@@ -248,7 +248,7 @@
|
||||
$ONELINER$
|
||||
Value for the day of week.
|
||||
$SYNTAX$
|
||||
DoW(<dDate>) --> nDay
|
||||
DoW( <dDate> ) --> nDay
|
||||
$ARGUMENTS$
|
||||
<dDate> Any valid date expression
|
||||
$RETURNS$
|
||||
@@ -284,7 +284,7 @@
|
||||
$ONELINER$
|
||||
Date to character conversion
|
||||
$SYNTAX$
|
||||
DToC(<dDateString>) --> cDate
|
||||
DToC( <dDateString> ) --> cDate
|
||||
$ARGUMENTS$
|
||||
<dDateString> Any date
|
||||
$RETURNS$
|
||||
@@ -322,7 +322,7 @@
|
||||
$ONELINER$
|
||||
Date to string conversion
|
||||
$SYNTAX$
|
||||
DToS(<dDateString>) --> cDate
|
||||
DToS( <dDateString> ) --> cDate
|
||||
$ARGUMENTS$
|
||||
<dDateString> Any date
|
||||
$RETURNS$
|
||||
@@ -358,7 +358,7 @@
|
||||
$ONELINER$
|
||||
Calculates elapted time.
|
||||
$SYNTAX$
|
||||
ElapTime(<cStartTime>,<cEndTime>) --> cDiference
|
||||
ElapTime( <cStartTime>, <cEndTime> ) --> cDiference
|
||||
$ARGUMENTS$
|
||||
<cStartTime> Start in time as a string format
|
||||
<cEndTime> End time as a string format
|
||||
@@ -402,7 +402,7 @@
|
||||
$ONELINER$
|
||||
Converts a date expression to a month value
|
||||
$SYNTAX$
|
||||
Month(<dDate>) --> nMonth
|
||||
Month( <dDate> ) --> nMonth
|
||||
$ARGUMENTS$
|
||||
<dDate> Any valid date expression
|
||||
$RETURNS$
|
||||
@@ -548,7 +548,7 @@
|
||||
$ONELINER$
|
||||
Converts the year portion of a date into a numeric value
|
||||
$SYNTAX$
|
||||
Year(<cDate>) --> nYear
|
||||
Year( <cDate> ) --> nYear
|
||||
$ARGUMENTS$
|
||||
<dDate> Any valid date expression
|
||||
$RETURNS$
|
||||
|
||||
@@ -21,7 +21,7 @@
|
||||
$ONELINER$
|
||||
Evaluate a code block
|
||||
$SYNTAX$
|
||||
Eval( <bBlock> [, <xVal> [,...]]) --> xExpression
|
||||
Eval( <bBlock> [, <xVal> [,...] ] ) --> xExpression
|
||||
$ARGUMENTS$
|
||||
<bBlock> Code block expression to be evaluated
|
||||
|
||||
|
||||
@@ -605,7 +605,7 @@
|
||||
$ONELINER$
|
||||
Reads a string from a file.
|
||||
$SYNTAX$
|
||||
FReadStr(<nHandle>, <nBytes>) --> cString
|
||||
FReadStr( <nHandle>, <nBytes> ) --> cString
|
||||
$ARGUMENTS$
|
||||
<nHandle> File handle number.
|
||||
|
||||
@@ -897,7 +897,7 @@
|
||||
$ONELINER$
|
||||
Returns the current OS directory name.
|
||||
$SYNTAX$
|
||||
CurDir( [<cDrive>] ) --> cPath
|
||||
CurDir( [<cDrive>] ) --> cPath
|
||||
$ARGUMENTS$
|
||||
<cDrive> OS drive letter
|
||||
$RETURNS$
|
||||
|
||||
@@ -43,11 +43,11 @@
|
||||
|
||||
See hbmemory.ch
|
||||
|
||||
* Transform() --> new function in format string
|
||||
* Transform() --> new function in format string
|
||||
|
||||
@0 Make a zero padded string out of the number.
|
||||
|
||||
* SToD() --> dDate
|
||||
* SToD() --> dDate
|
||||
|
||||
New function that converts a yyyymmdd string to a Date value.
|
||||
|
||||
|
||||
@@ -70,8 +70,7 @@
|
||||
$ONELINER$
|
||||
Unlocks part or all of any file
|
||||
$SYNTAX$
|
||||
hb_FUnlock( <nHandle>, <nOffset>, <nBytes> ) --> <lSuccess>
|
||||
|
||||
hb_FUnlock( <nHandle>, <nOffset>, <nBytes> ) --> <lSuccess>
|
||||
$ARGUMENTS$
|
||||
<nHandle> Dos file handle
|
||||
|
||||
|
||||
@@ -26,7 +26,7 @@
|
||||
$ONELINER$
|
||||
Return the absolute value of a number.
|
||||
$SYNTAX$
|
||||
Abs(<nNumber>) --> <nAbsNumber>
|
||||
Abs( <nNumber> ) --> <nAbsNumber>
|
||||
$ARGUMENTS$
|
||||
<nNumber> Any number.
|
||||
$RETURNS$
|
||||
@@ -181,7 +181,7 @@
|
||||
$ONELINER$
|
||||
Returns the maximum of two numbers or dates.
|
||||
$SYNTAX$
|
||||
Max( <xValue>, <xValue1> ) --> <xMax>
|
||||
Max( <xValue>, <xValue1> ) --> <xMax>
|
||||
$ARGUMENTS$
|
||||
<xValue> Any date or numeric value.
|
||||
|
||||
@@ -223,7 +223,7 @@
|
||||
$ONELINER$
|
||||
Determines the minumum of two numbers or dates.
|
||||
$SYNTAX$
|
||||
Min( <xValue>, <xValue1> ) --> <xMin>
|
||||
Min( <xValue>, <xValue1> ) --> <xMin>
|
||||
$ARGUMENTS$
|
||||
<xValue> Any date or numeric value.
|
||||
|
||||
|
||||
@@ -21,7 +21,7 @@
|
||||
$ONELINER$
|
||||
Allows selection of an element from an array
|
||||
$SYNTAX$
|
||||
AChoice(<nTop>, <nLeft>, <nBottom>, <nRight>, <acMenuItems>, [<alSelableItems> | <lSelableItems>], [<cUserFunction> | <bUserBlock>], [<nInitialItem>], [<nWindowRow>]) --> nPosition
|
||||
AChoice( <nTop>, <nLeft>, <nBottom>, <nRight>, <acMenuItems>, [<alSelableItems> | <lSelableItems>], [<cUserFunction> | <bUserBlock>], [<nInitialItem>], [<nWindowRow>] ) --> nPosition
|
||||
$ARGUMENTS$
|
||||
<nTop> - topmost row used to display array (default 0)
|
||||
|
||||
|
||||
@@ -49,7 +49,7 @@
|
||||
$ONELINER$
|
||||
Returns the HARBOUR Version or the Harbour/Compiler Version.
|
||||
$SYNTAX$
|
||||
Version() --> <cReturn>
|
||||
Version() --> <cReturn>
|
||||
$ARGUMENTS$
|
||||
None
|
||||
$RETURNS$
|
||||
@@ -83,7 +83,7 @@
|
||||
$ONELINER$
|
||||
Obtains a system environmental setting.
|
||||
$SYNTAX$
|
||||
GetEnv( <cEnviroment> ) --> <cReturn>
|
||||
GetEnv( <cEnviroment> ) --> <cReturn>
|
||||
$ARGUMENTS$
|
||||
<cEnviroment> Enviromental variable to obtain.
|
||||
$RETURNS$
|
||||
@@ -124,7 +124,7 @@
|
||||
$ONELINER$
|
||||
Obtains a system environmental setting.
|
||||
$SYNTAX$
|
||||
GetE( <cEnviroment> ) --> <cReturn>
|
||||
GetE( <cEnviroment> ) --> <cReturn>
|
||||
$ARGUMENTS$
|
||||
<cEnviroment> Enviromental variable to obtain.
|
||||
$RETURNS$
|
||||
@@ -167,18 +167,11 @@
|
||||
$ONELINER$
|
||||
Obtains a system environmental setting.
|
||||
$SYNTAX$
|
||||
hb_GetEnv(<cEnviroment>, [<cDefaultValue>], [<lApplyCodepage>] ) --> <cReturn>
|
||||
hb_GetEnv( <cEnviroment>, [<cDefaultValue>] ) --> <cReturn>
|
||||
$ARGUMENTS$
|
||||
<cEnviroment> Enviromental variable to obtain.
|
||||
|
||||
<cDefaultValue> Optional value to return if <cEnvironment> is not found.
|
||||
|
||||
<lApplyCodepage> optional logical parameter specifing whether to
|
||||
apply automatic codepage conversion (to the codepage
|
||||
specified by Set( _SET_OSCODEPAGE ) on the obtained value.
|
||||
The default is .T. Note that if the default value is passed and the environment
|
||||
value is not found, this codepage conversion is not performed against
|
||||
the returned default value
|
||||
$RETURNS$
|
||||
<cReturn> Value of the environment variable or <cDefaultValue> or an empty string.
|
||||
$DESCRIPTION$
|
||||
|
||||
@@ -594,7 +594,7 @@
|
||||
$ONELINER$
|
||||
Position the record pointer to a specific location.
|
||||
$SYNTAX$
|
||||
dbGoto(<xRecordNumber>)
|
||||
dbGoto( <xRecordNumber> )
|
||||
$ARGUMENTS$
|
||||
<xRecordNumber> Record number or unique identity
|
||||
$DESCRIPTION$
|
||||
@@ -853,7 +853,7 @@
|
||||
$ONELINER$
|
||||
Searches for a value based on an active index.
|
||||
$SYNTAX$
|
||||
dbSeek(<expKey>, [<lSoftSeek>],[<lFindLast>]) --> lFound
|
||||
dbSeek( <expKey>, [<lSoftSeek>], [<lFindLast>] ) --> lFound
|
||||
$ARGUMENTS$
|
||||
<expKey> Any expression
|
||||
|
||||
@@ -927,7 +927,7 @@
|
||||
$ONELINER$
|
||||
Change to another work area
|
||||
$SYNTAX$
|
||||
dbSelectArea(<xArea>) -
|
||||
dbSelectArea( <xArea> ) -
|
||||
$ARGUMENTS$
|
||||
<xArea> Alias or work area
|
||||
$DESCRIPTION$
|
||||
@@ -1054,7 +1054,7 @@
|
||||
$ONELINER$
|
||||
Establishes a filter condition for a work area.
|
||||
$SYNTAX$
|
||||
dbSetFilter(<bCondition>, [<cCondition>])
|
||||
dbSetFilter( <bCondition>, [<cCondition>] )
|
||||
$ARGUMENTS$
|
||||
<bCondition> Code block expression for filtered evaluation.
|
||||
|
||||
|
||||
@@ -23,7 +23,7 @@
|
||||
$ONELINER$
|
||||
Fills referenced arrays with database field information
|
||||
$SYNTAX$
|
||||
AFields(<aNames>[,<aTypes>][,<aLen>][,<aDecs>]) --> <nFields>
|
||||
AFields( <aNames>, [<aTypes>], [<aLen>], [<aDecs>] ) --> <nFields>
|
||||
$ARGUMENTS$
|
||||
<aNames> Array of field names
|
||||
|
||||
@@ -344,7 +344,7 @@
|
||||
$ONELINER$
|
||||
Obtains the value of a specified field
|
||||
$SYNTAX$
|
||||
FieldGet(<nField>) --> ValueField
|
||||
FieldGet( <nField> ) --> ValueField
|
||||
$ARGUMENTS$
|
||||
<nField> Is the numeric field position
|
||||
$RETURNS$
|
||||
@@ -383,7 +383,7 @@
|
||||
$ONELINER$
|
||||
Return the name of a field at a numeric field location.
|
||||
$SYNTAX$
|
||||
FIELDNAME/FIELD(<nPosition>) --> cFieldName
|
||||
FieldName()/Field( <nPosition> ) --> cFieldName
|
||||
$ARGUMENTS$
|
||||
<nPosition> Field order in the database.
|
||||
$RETURNS$
|
||||
@@ -425,7 +425,7 @@
|
||||
$ONELINER$
|
||||
Return the ordinal position of a field.
|
||||
$SYNTAX$
|
||||
FieldPos(<cFieldName>) --> nFieldPos
|
||||
FieldPos( <cFieldName> ) --> nFieldPos
|
||||
$ARGUMENTS$
|
||||
<cFieldName> Name of a field.
|
||||
$RETURNS$
|
||||
@@ -464,7 +464,7 @@
|
||||
$ONELINER$
|
||||
Set the value of a field variable
|
||||
$SYNTAX$
|
||||
FieldPut(<nField>, <expAssign>) --> ValueAssigned
|
||||
FieldPut( <nField>, <expAssign> ) --> ValueAssigned
|
||||
$ARGUMENTS$
|
||||
<nField> The field numeric position
|
||||
|
||||
|
||||
@@ -3,9 +3,9 @@
|
||||
* www - http://harbour-project.org
|
||||
*
|
||||
* Copyright 1999 Luiz Rafael Culik <culik@sl.conex.net>
|
||||
* DB*() documentation
|
||||
* ORD*() documentation
|
||||
* RDD*() documentation
|
||||
* db*() documentation
|
||||
* ord*() documentation
|
||||
* rdd*() documentation
|
||||
*
|
||||
* See COPYING.txt for licensing terms.
|
||||
*
|
||||
@@ -66,7 +66,7 @@
|
||||
$ONELINER$
|
||||
Returns the Order Bag Name.
|
||||
$SYNTAX$
|
||||
ordBagName(<nOrder> | <cOrderName>) --> cOrderBagName
|
||||
ordBagName( <nOrder> | <cOrderName> ) --> cOrderBagName
|
||||
$ARGUMENTS$
|
||||
<nOrder> A numeric value representing the Order bag number.
|
||||
|
||||
@@ -165,8 +165,8 @@
|
||||
$ONELINER$
|
||||
Create an Order in an Order Bag
|
||||
$SYNTAX$
|
||||
ordCreate(<cOrderBagName>,[<cOrderName>], <cExpKey>,
|
||||
[<bExpKey>], [<lUnique>])
|
||||
ordCreate( <cOrderBagName>,[<cOrderName>], <cExpKey>,
|
||||
[<bExpKey>], [<lUnique>] )
|
||||
$ARGUMENTS$
|
||||
<cOrderBagName> Name of the file that contains one or more Orders.
|
||||
|
||||
@@ -236,7 +236,7 @@
|
||||
$ONELINER$
|
||||
Remove an Order from an Order Bag
|
||||
$SYNTAX$
|
||||
ordDestroy(<cOrderName> [, <cOrderBagName> ])
|
||||
ordDestroy( <cOrderName> [, <cOrderBagName> ] )
|
||||
$ARGUMENTS$
|
||||
<cOrderName> Name of the order to remove
|
||||
|
||||
@@ -282,8 +282,7 @@
|
||||
$ONELINER$
|
||||
Return the FOR expression of an Order
|
||||
$SYNTAX$
|
||||
ordFor(<xOrder>[, <cOrderBagName>]) --> cForExp
|
||||
|
||||
ordFor( <xOrder>[, <cOrderBagName>] ) --> cForExp
|
||||
$ARGUMENTS$
|
||||
<xOrder> It the name of the target order,or the numeric position
|
||||
of the order.
|
||||
@@ -332,7 +331,7 @@
|
||||
$ONELINER$
|
||||
Return the key expression of an Order
|
||||
$SYNTAX$
|
||||
ordKey(<cOrderName> | <nOrder> [, <cOrderBagName>]) --> cExpKey
|
||||
ordKey( <cOrderName> | <nOrder> [, <cOrderBagName>] ) --> cExpKey
|
||||
$ARGUMENTS$
|
||||
<xOrder> It the name of the target order,or the numeric position
|
||||
of the order.
|
||||
@@ -418,7 +417,7 @@
|
||||
$ONELINER$
|
||||
Yields the key expression of a specified index file.
|
||||
$SYNTAX$
|
||||
IndexKey(<nOrder>) --> <cIndexKey>
|
||||
IndexKey( <nOrder> ) --> <cIndexKey>
|
||||
$ARGUMENTS$
|
||||
<nOrder> Index order number
|
||||
$RETURNS$
|
||||
|
||||
@@ -64,7 +64,7 @@
|
||||
$ONELINER$
|
||||
Changes or evaluated environmental settings
|
||||
$SYNTAX$
|
||||
Set(<nSet> [, <xNewSetting> [, <xOption> ] ] ) --> xPreviousSetting
|
||||
Set( <nSet> [, <xNewSetting> [, <xOption> ] ] ) --> xPreviousSetting
|
||||
$ARGUMENTS$
|
||||
<nSet> Set Number
|
||||
|
||||
@@ -747,7 +747,7 @@
|
||||
$ONELINER$
|
||||
Assign an action block to a key
|
||||
$SYNTAX$
|
||||
SET KEY <anKey> to p<bAction>] [when <bCondition> ] )
|
||||
SET KEY <anKey> TO <bAction>] [WHEN <bCondition>]
|
||||
$ARGUMENTS$
|
||||
<anKey> is either a numeric key value, or an array of such values
|
||||
|
||||
@@ -894,7 +894,7 @@
|
||||
$ONELINER$
|
||||
Toggle wrapping the PROMPTs in a menu.
|
||||
$SYNTAX$
|
||||
SET WRAP on | OFF | (<lWrap>
|
||||
SET WRAP on | OFF | ( <lWrap> )
|
||||
$ARGUMENTS$
|
||||
<lWrap> Logical expression for toggle
|
||||
$DESCRIPTION$
|
||||
@@ -1001,7 +1001,7 @@
|
||||
$ONELINER$
|
||||
Toggles the enhanced display of PROMPT's and GETs.
|
||||
$SYNTAX$
|
||||
SET INTENSITY ON | off | (<lInte>)
|
||||
SET INTENSITY ON | off | ( <lInte> )
|
||||
$ARGUMENTS$
|
||||
<lInte> Logical expression for toggle command
|
||||
$DESCRIPTION$
|
||||
@@ -1031,8 +1031,8 @@
|
||||
$ONELINER$
|
||||
Toggle and echos output to an alternate file
|
||||
$SYNTAX$
|
||||
SET ALTERNATE to <cFile> [ADDITIVE]
|
||||
SET ALTERNATE on | OFF | (<lAlter>)
|
||||
SET ALTERNATE TO <cFile> [ADDITIVE]
|
||||
SET ALTERNATE on | OFF | ( <lAlter> )
|
||||
$ARGUMENTS$
|
||||
<cFile> Name of alternate file.
|
||||
|
||||
@@ -1081,7 +1081,7 @@
|
||||
$ONELINER$
|
||||
Toggle the century digits in all dates display
|
||||
$SYNTAX$
|
||||
SET CENTURY on | OFF | (<lCent>)
|
||||
SET CENTURY on | OFF | ( <lCent> )
|
||||
$ARGUMENTS$
|
||||
<lCent> Logical expression for toggle
|
||||
$DESCRIPTION$
|
||||
@@ -1195,7 +1195,7 @@
|
||||
$ONELINER$
|
||||
Set the number of decimal position to be displayed
|
||||
$SYNTAX$
|
||||
SET FIXED on | OFF | (<lFixed>)
|
||||
SET FIXED on | OFF | ( <lFixed> )
|
||||
$ARGUMENTS$
|
||||
<lFixed> Logical expression for toggle
|
||||
$DESCRIPTION$
|
||||
@@ -1244,7 +1244,7 @@
|
||||
Toggles the printer and controls the printer device
|
||||
$SYNTAX$
|
||||
SET PRINTER on | OFF
|
||||
SET PRINTER (<lPrinter>)
|
||||
SET PRINTER ( <lPrinter> )
|
||||
SET PRINTER TO [<cPrinter>] [ADDITIVE]
|
||||
$ARGUMENTS$
|
||||
<lPrinter> Logical condition by which to toggle the printer
|
||||
@@ -1300,7 +1300,7 @@
|
||||
$ONELINER$
|
||||
Toggle the console display
|
||||
$SYNTAX$
|
||||
SET CONSOLE ON | off | (<lConsole>)
|
||||
SET CONSOLE ON | off | ( <lConsole> )
|
||||
$ARGUMENTS$
|
||||
<lConsole> Logical expression for toggle command
|
||||
$DESCRIPTION$
|
||||
@@ -1413,7 +1413,7 @@
|
||||
$ONELINER$
|
||||
Toggle the bell to sound once a GET has been completed.
|
||||
$SYNTAX$
|
||||
SET BELL on | OFF | (<lBell>)
|
||||
SET BELL on | OFF | ( <lBell> )
|
||||
$ARGUMENTS$
|
||||
<lBell> Logical expression for toggle command
|
||||
$DESCRIPTION$
|
||||
|
||||
@@ -927,7 +927,7 @@
|
||||
$ONELINER$
|
||||
Converts an ASCII value to it character value
|
||||
$SYNTAX$
|
||||
Chr( <nAsciiNum> ) --> cReturn
|
||||
Chr( <nAsciiNum> ) --> cReturn
|
||||
$ARGUMENTS$
|
||||
<nAsciiNum> Any ASCII character code.
|
||||
$RETURNS$
|
||||
@@ -1004,7 +1004,7 @@
|
||||
$ONELINER$
|
||||
Centers an expression for a given width
|
||||
$SYNTAX$
|
||||
PadC( <xVal>, <nWidth>, <cFill> ) --> cString
|
||||
PadC( <xVal>, <nWidth>, <cFill> ) --> cString
|
||||
$ARGUMENTS$
|
||||
<xVal> A Number, Character or Date value to pad
|
||||
|
||||
@@ -1052,7 +1052,7 @@
|
||||
$ONELINER$
|
||||
Left-justifies an expression for a given width
|
||||
$SYNTAX$
|
||||
PadL( <xVal>, <nWidth>, <cFill> ) --> cString
|
||||
PadL( <xVal>, <nWidth>, <cFill> ) --> cString
|
||||
$ARGUMENTS$
|
||||
<xVal> An number,Character or date to pad
|
||||
|
||||
@@ -1228,7 +1228,7 @@
|
||||
$ONELINER$
|
||||
Remove trailing spaces from a string.
|
||||
$SYNTAX$
|
||||
Trim( <cExpression> ) --> cString
|
||||
Trim( <cExpression> ) --> cString
|
||||
$ARGUMENTS$
|
||||
<cExpression> Any character expression
|
||||
$RETURNS$
|
||||
@@ -1270,7 +1270,7 @@
|
||||
$ONELINER$
|
||||
Repeats a single character expression
|
||||
$SYNTAX$
|
||||
Replicate( <cString>, <nSize> ) --> cReplicateString
|
||||
Replicate( <cString>, <nSize> ) --> cReplicateString
|
||||
$ARGUMENTS$
|
||||
<cString> Character string to be replicated
|
||||
|
||||
@@ -1474,7 +1474,7 @@
|
||||
$ONELINER$
|
||||
Formats a value based on a specific picture template.
|
||||
$SYNTAX$
|
||||
Transform( <xExpression>, <cTemplate> ) --> cFormatted
|
||||
Transform( <xExpression>, <cTemplate> ) --> cFormatted
|
||||
$ARGUMENTS$
|
||||
<xExpression> Any expression to be formated.
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
$ONELINER$
|
||||
Create a Browse Object
|
||||
$CONSTRUCTOR$
|
||||
TBrowseNew(<nTop>,<nLeft>,<nBottom>,<nRight>) --> <oBrowse>
|
||||
TBrowseNew( <nTop>, <nLeft>, <nBottom>, <nRight> ) --> <oBrowse>
|
||||
$ARGUMENTS$
|
||||
<nTop> Top Row
|
||||
|
||||
@@ -192,7 +192,7 @@
|
||||
$ONELINER$
|
||||
Get an optionaly Set an new Code block associated to a inkey value
|
||||
$SYNTAX$
|
||||
SetKey(<nKey>[,<bBlock>]) --> bOldBlock
|
||||
SetKey( <nKey>[, <bBlock>] ) --> bOldBlock
|
||||
$ARGUMENTS$
|
||||
<nKey> An valid inkey Code
|
||||
|
||||
@@ -256,7 +256,7 @@
|
||||
$ONELINER$
|
||||
Evaluates an code block associated with an specific key
|
||||
$SYNTAX$
|
||||
ApplyKey(<nKey>) --> nResult
|
||||
ApplyKey( <nKey> ) --> nResult
|
||||
$ARGUMENTS$
|
||||
<nKey> An valid Inkey code
|
||||
$RETURNS$
|
||||
|
||||
@@ -757,7 +757,7 @@
|
||||
$ONELINER$
|
||||
Returns the current screen column position
|
||||
$SYNTAX$
|
||||
Col() --> nPosition
|
||||
Col() --> nPosition
|
||||
$ARGUMENTS$
|
||||
None.
|
||||
$RETURNS$
|
||||
@@ -792,7 +792,7 @@
|
||||
$ONELINER$
|
||||
Returns the current screen row position
|
||||
$SYNTAX$
|
||||
Row() --> nPosition
|
||||
Row() --> nPosition
|
||||
$ARGUMENTS$
|
||||
None.
|
||||
$RETURNS$
|
||||
@@ -827,7 +827,7 @@
|
||||
$ONELINER$
|
||||
Returns the maximun number of columns in the current video mode
|
||||
$SYNTAX$
|
||||
MaxCol() --> nPosition
|
||||
MaxCol() --> nPosition
|
||||
$ARGUMENTS$
|
||||
None.
|
||||
$RETURNS$
|
||||
@@ -863,7 +863,7 @@
|
||||
$ONELINER$
|
||||
Returns the current screen row position
|
||||
$SYNTAX$
|
||||
MaxRow() --> nPosition
|
||||
MaxRow() --> nPosition
|
||||
$ARGUMENTS$
|
||||
None.
|
||||
$RETURNS$
|
||||
|
||||
@@ -427,7 +427,7 @@
|
||||
$ONELINER$
|
||||
Determine if a given name is a PUBLIC or PRIVATE memory variable
|
||||
$SYNTAX$
|
||||
__mvExist( <cVarName> ) --> <lVariableExist>
|
||||
__mvExist( <cVarName> ) --> <lVariableExist>
|
||||
$ARGUMENTS$
|
||||
<cVarName> - string that specifies the name of variable to check
|
||||
$RETURNS$
|
||||
@@ -468,7 +468,7 @@
|
||||
$ONELINER$
|
||||
This function returns value of memory variable
|
||||
$SYNTAX$
|
||||
__mvGet( <cVarName> ) --> <xVar>
|
||||
__mvGet( <cVarName> ) --> <xVar>
|
||||
$ARGUMENTS$
|
||||
<cVarName> - string that specifies the name of variable
|
||||
$RETURNS$
|
||||
@@ -506,7 +506,7 @@
|
||||
$ONELINER$
|
||||
This function set the value of memory variable
|
||||
$SYNTAX$
|
||||
__mvGet( <cVarName> [, <xValue>] ) --> <xValue>
|
||||
__mvGet( <cVarName> [, <xValue>] ) --> <xValue>
|
||||
$ARGUMENTS$
|
||||
<cVarName> - string that specifies the name of variable
|
||||
<xValue> - a value of any type that will be set - if it is not
|
||||
|
||||
Reference in New Issue
Block a user