CometWiki - User contributions [en]

IB Statements/lock

2012-05-24T14:14:47Z

SteveA:

'''LOCK statement'''

'''Syntax:''' LOCK (lun) [,EXCP=statement-label | NOEXCP]

'''Discussion:''' The LOCK statement locks a logical unit number. It is a way to prevent a specified file from being opened by another user.

The lun parameter is a numeric or symbolic constant that is previously assigned to a file by an OPEN statement -- it represents the logical unit to be locked.

If th LOCK statement is attempted while another user has the particular file open, an exception 7 (FILE UNAVAILABLE -- LOCK/UNLOCK ERROR) will be encountered.

'''Example:''' OPEN (1) "FILEB"

LOCK (1)

.

.

UNLOCK (1)

CLOSE (1)

=========================================================================

'''Posted by Jim Guerber on August 25, 2008 at 18:16:31:'''

In Reply to: Re: LOCK question posted by Grant Foraker on August 25, 2008 at 14:33:51:

Ok, Ok.

We will try to turn this "feature" off. Here is what I found.

When a program locks a file, the same partition may open the same file on multiple LUNS without a problem.

If a program running in another partition tries to open the file, it will get a lock violation.

If a program wishes to unlock a file and not close it, it can issue an unlock through the unlock(LUN) statement.(The unlock may be issued from ANY LUN that has the file opened.)

The lock flag was getting reset when ANY LUN on the owning partition was closed. This happens whether the close happens in an enter program or not. This was probably incorrect.

We will make the lock persistent such that the only way to unlock a file is to either issue an unlock or close the file on the last LUN which has it open.

Does that make sense to everyone?

If you all agree, the change will be made in the next file server release.

Talk:FAQ2010

2011-06-09T16:53:52Z

SteveA: Created page with "Can and may are frequently but not always interchangeable in senses indicating possibility: A power failure can (or may ) occur at any time. Despite the insistence by some, tha..."

Can and may are frequently but not always interchangeable in senses indicating possibility: A power failure can (or may ) occur at any time. Despite the insistence by some, that can means only “to be able” and may means “to be permitted"

[[User:SteveA|SteveA]] 09:53, 9 June 2011 (PDT)

Talk:Comet32

2011-02-24T15:14:33Z

SteveA:

Badge:
== Str() Function - changed operation. ==

<li> As mentioned on Forum, I use the Str() function to convert a numeric to string for a percentage that is then used in the key of a file to rank slaes. This change negates that.

<li> Robert has a problem with it also, details on Forum. Just typing this to see how it appears. How do you know who says what on a Wiki ?
<hr>
Jim:
The real problem with the str() function is the use of numeric expressions as the argument to the function. The C16 accumulator was implicitly defined as length 16.8. The c32 accumulator may be much larger. It is currently defined as 64.32.

It is consistent to strip leading spaces from the string, otherwise, you would not know the actual result.

That said, we are open to any change like this if everyone wants it. I just think it is short sighted to always want C32 to behave exactly like c16.

We could also only strip the string if the argument were an expression. We could also, treat expressions as arguments to the str function as if the accumulator were 16.8.

<hr>
Changing from one version of a language to another requires a re-compile. It is really the only opportunity we have to change behavior. I think we should also look at the obsolete fields in fstat() for instance.

The other big change is the unexpected error 1 if a numeric expression overflows the variable it is assigned to.

Length 3.2 & local I

I = 1234

will produce an excp=1.

----
Badge
<li> Fair enough, I can work around my problem fairly easily.
 I agree that we should take this chance to get rid of old & irrelevant stuff.
<li>
This numeric overflow thing.

If my setglobal has been populated in C16 and then I read it in C32 and there is a case of this numeric overflow. Will I get an exception 1 on the getglobal ?
 That is just plain silly, obviously once it is set in C16 it is already truncated.- Scratching around for an unexpalined excp=1.

If it happens as a result of a mathematical calculation, where do you test for the excp=1 ?

length 1.0 & local I

for i=0 to 20

i=i+1 ? excp=test for overflow ?

next i

Still chasing an elusive excp=1. It appears to be when I read my date record. Could an excp=46 be misconstrued as an excp=1 ? say there was the string 1234 where the numeric variable in Jim's example above was supposed to be. Would that give a 46 or a 1 ??

Barb:We decided to make the Comet32 str() functionality the same as the Comet16 functionality. Version .401 will be out soon and have this change.

bb

Let's see: four tildes identify the poster

[[User:SteveA|SteveA]] 07:13, 24 February 2011 (PST)

Talk:Comet32

2011-02-24T15:13:16Z

SteveA:

Badge:
== Str() Function - changed operation. ==

<li> As mentioned on Forum, I use the Str() function to convert a numeric to string for a percentage that is then used in the key of a file to rank slaes. This change negates that.

<li> Robert has a problem with it also, details on Forum. Just typing this to see how it appears. How do you know who says what on a Wiki ?
<hr>
Jim:
The real problem with the str() function is the use of numeric expressions as the argument to the function. The C16 accumulator was implicitly defined as length 16.8. The c32 accumulator may be much larger. It is currently defined as 64.32.

It is consistent to strip leading spaces from the string, otherwise, you would not know the actual result.

That said, we are open to any change like this if everyone wants it. I just think it is short sighted to always want C32 to behave exactly like c16.

We could also only strip the string if the argument were an expression. We could also, treat expressions as arguments to the str function as if the accumulator were 16.8.

<hr>
Changing from one version of a language to another requires a re-compile. It is really the only opportunity we have to change behavior. I think we should also look at the obsolete fields in fstat() for instance.

The other big change is the unexpected error 1 if a numeric expression overflows the variable it is assigned to.

Length 3.2 & local I

I = 1234

will produce an excp=1.

----
Badge
<li> Fair enough, I can work around my problem fairly easily.
 I agree that we should take this chance to get rid of old & irrelevant stuff.
<li>
This numeric overflow thing.

If my setglobal has been populated in C16 and then I read it in C32 and there is a case of this numeric overflow. Will I get an exception 1 on the getglobal ?
 That is just plain silly, obviously once it is set in C16 it is already truncated.- Scratching around for an unexpalined excp=1.

If it happens as a result of a mathematical calculation, where do you test for the excp=1 ?

length 1.0 & local I

for i=0 to 20

i=i+1 ? excp=test for overflow ?

next i

Still chasing an elusive excp=1. It appears to be when I read my date record. Could an excp=46 be misconstrued as an excp=1 ? say there was the string 1234 where the numeric variable in Jim's example above was supposed to be. Would that give a 46 or a 1 ??

Barb:We decided to make the Comet32 str() functionality the same as the Comet16 functionality. Version .401 will be out soon and have this change.

bb

Let's see four tildes identify the poster
[[User:SteveA|SteveA]] 07:13, 24 February 2011 (PST)

IB Statements/UserDefinedProcs

2011-01-20T20:48:18Z

SteveA:

'''User Defined Procedures in Comet32 (Procs)'''

May be subroutines or functions. A Proc may or may not return a value.
Procs that return a value are called Functions and those that do not are called subroutines.

Functions may be numeric or string depending on the kind of result they return. Functions may be called anywhere a system function is called.
Subroutines are invoked with the CALL verb (Not GOSUB).

Procs must be declared in the main program. Just like variables, Procs must be declared before use. In fact, they must be declared in the Main part of the program.
Procs may take arguments and have locally defined local variables. The body of a proc looks like a mini program. It has a declaration section and an executable section.
All locals declared in the proc except for arguments are cleared. A clear local statement is not required.
Procs inherit all system variables and all variables declared in the main program. If a variable name is not found in the local declarations for a proc, and the variable is declared in the main program, that variable is used by the proc. In this case, the variable is used BY REFERENCE; that is, if the proc changes the variable, it is changed for the main program as well.

Arguments may be passed by value or by reference. If an argument to a proc also appears in the declarations of local for the proc, the argument is copied into that local variable. If an argument does not also appear as a local variable, it as passed by reference. When a variable is passed by reference, no copy action is done (better performance), and the contents of the variable may be changed for the calling routine as well as for the proc.
Procs can call procs and may be recursive. Each time a proc is called; new storage for the proc is created. The arguments are then passed, initializing some of that storage. When a ProcReturn is executed, all local storage for that instance of the proc is destroyed. This provides a mechanism for recursion.
An example:

! Declare Subroutines And Functions

Numeric Factor(n)
length 32.0 & local i z

print (et)

fact:
print 'factorial of what?'
input i
if i > 29 print 'Warning -- factorial of a number > 29 will overflow' & wait
if i = 0 stop

Z = Factor(I) ! Call our function here

Print i;' Factorial Is ' ! Iterate through the function to get the factorial
Print z
Wait
z = Factorial(I) ! use the math library to get the factorial for validation purposes
Print z
wait
goto fact
end

Numeric Factor(n)
Length 32.0 & Local x
print 'fact';n
if n <= 1 Procreturn 1
print 'returning ';n &wait
x = n - 1
Procreturn Factor(x) * n ! Calling myself
End

IB Statements/operations

2011-01-18T21:33:34Z

SteveA:

The Internet Basic language supports the following types of operations:

* Numeric Operations
* String Operations
* Relational Operations
* Logical Operations
===Numeric Operations===
The following types of operations may be performed on numeric data:

* Addition
* Subtraction
* Multiplication
* Division
* Modulo

Also see the notes about Precedence.
====Addition====
The plus sign '''(+)''' is the operator used to perform addition on numeric data.

Notes: If the result of an addition operation exceeds the defined length of a receiving numeric variable, the value will be truncated on the left-hand side without warning.

If the precision of the result exceeds the defined precision of a receiving variable (and the variable has not been defined for automatic rounding), the result will be truncated on the right-hand side. See the ROUND statement for more information.

Also see the LET statement.

Example:
<pre>
LENGTH 5.0 ! Declare the length for A, B, C
LOCAL A, B, C ! Declare them as LOCAL variables
.
LET A = 500 ! Set the value for A
LET B = 2000 ! Set the value for B
LET C = A + B ! Add A and B, giving C
</pre>
====Subtraction====

The minus sign '''(-)''' is the operator used to perform subtraction on numeric data.

Notes: If the result of a subtraction operation exceeds the defined length of a receiving numeric variable, the value will be truncated on the left-hand side without warning.

If the precision of the result exceeds the defined precision of a receiving variable (and the variable has not been defined for automatic rounding), the result will be truncated on the right-hand side. See the ROUND statement for more information.

Also see the LET statement.

Example:
<pre>
LENGTH 5.0 ! Declare the length for A, B, C
LOCAL A, B, C ! Declare them as LOCAL variables
.
LET A = 800 ! Set the value for A
LET B = 200 ! Set the value for B
LET C = A - B ! Subtract B from A, giving C
</pre>
====Multiplication====

The asterisk '''(*)''' is the operator used to perform multiplication on numeric data.

Notes: If the result of a multiplication operation exceeds the defined length of a receiving numeric variable, the value will be truncated on the left-hand side without warning.

If the precision of the result exceeds the defined precision of a receiving variable (and the variable has not been defined for automatic rounding), the result will be truncated on the right-hand side. See the ROUND statement for more information.

Also see the LET statement.

Example:
<pre>
LENGTH 5.0 ! Declare the length for A, B, C
LOCAL A, B, C ! Declare them as LOCAL variables
.
LET A = 150 ! Set the value for A
LET B = 25 ! Set the value for B
LET C = A * B ! Multiply A and B, giving C
</pre>
====Division====

The backslash '''(/)''' is the operator used to perform division on numeric data.

Notes: If the result of a division operation exceeds the defined length of a receiving numeric variable, the value will be truncated on the left-hand side without warning.

If the precision of the result exceeds the defined precision of a receiving variable (and the variable has not been defined for automatic rounding), the result will be truncated on the right-hand side. See the ROUND statement for more information.

Also see the LET statement.

Example:
<pre>
LENGTH 5.0 ! Declare the length for A, B, C
LOCAL A, B, C ! Declare them as LOCAL variables
.
LET A = 150 ! Set the value for A
LET B = 25 ! Set the value for B
LET C = A / B ! Divide A by B, giving C
</pre>
====Modulo====

The MOD operator performs a modulo operation on the two numeric values (i.e., it divides the first value by the second value and returns the remainder).

The MOD operator is supported in Comet 504 and greater. In Comet32 you may use either MOD or % as the operator.

The syntax is:

numeric-value-1 MOD numeric-value-2
Example:
<pre>
LET C = 10 MOD 3
</pre>
This operation returns a value of 1 as 10 divided by 3 equals 3 with a remainder of 1.

====Precedence====

In a numeric expression containing multiple operations, the multiplication and division operations are performed first (from left to right). Next, the addition and subtraction operations are performed (also from left to right).

This algebraic order can be overridden with parentheses. In a numeric expression containing parentheses, operations inside the parentheses will be performed first, followed by the algebraic order previously described. Parentheses may be nested to any level in a numeric expression -- they will be performed from the inside to the outside.

====Results====

The temporary result of a numeric operation will contain only as many digits to the right of the decimal point as the most precise operand in the expression. For example, if an expression contains operand with two digits of precision and four digits of precision, the temporary result will contain four digits of precision.

==String Operation (Concatenation)==

The Internet Basic language supports the string operation of concatenation. The plus sign (+) is used to indicate concatenation (the combining of strings). For example, concatenating two string variables would look like this:
<pre>
FIRSTNAME$ + LASTNAME$
</pre>
You may concatenate string constants, string variables, and string functions. Here is an example of concatenating constants with variables:
<pre>
"(" + AREACODE$ + ")" + PHONENUMBER$
</pre>
The maximum number of characters in a string is 254. If a concatenation operation results in more characters than have been declared for a receiving variable, characters will be truncated on the right-hand side. THIS TRUNCATION WILL OCCUR WITHOUT WARNING OF ANY KIND.

==Relational Operation (IF/THEN/ELSE)==

The Internet Basic language supports relational operations in IF/THEN statements. The following operations are supported:
{| border = "1" cell padding="30" align = "center"
!Operation
!Internet Basic syntax
|-
|Equal to ||EQ or =
|-
|Not equal to||NE or NOT=
|-
|Greater than||GT or >
|-
|Greater than or equal to||GE or >=
|-
|Less than||LT or <
|-
|Less than or equal to||LE or <=
|-
|Contains||Contains
|-
|Soundslike||Soundslike
|}

Two strings are considered to be equal only when they are identical and have the same current length (number of characters).

When comparing string values, the ASCII values for the characters are compared. For example, upper case "A" is less than lower case "a" because the ASCII value for "A" (65) is less than the ASCII value for "a" (97). See ASCII chart [http://signature.net/ib/ascii.htm]

The Contains operator will be true when the left hand string operand contains the right hand string operand. 
The Soundslike operator will be true when the soundex key of both operands are equal. See [http://www.archives.gov/genealogy/census/soundex.html] 
Both the Contains and Soundslike operators are case '''insensitive'''.

==Logical Operations==

The Internet Basic language supports the AND and OR logical operations to be used in conjunction with relational expressions. The AND operator tests whether both relational conditions are true, while the OR operator tests for truth of either relational condition. For example:
<pre>
IF A=B AND B=C THEN... ! Both conditions must be true

IF A=B OR B=C THEN... ! Either condition may be true
</pre>
If AND and OR are combined in a relational expression, the AND operator takes precedence (i.e., it will be evaluated first). It is possible to override this precedence with parentheses, just like the precedence in numeric operations can be overridden.

For more information on relational operations and logical operations, see the [[IF]] statement.

Beginning with Comet 2004, logical operations are also supported on binary expressions. The AND, OR, and XOR operators are available.

The AND operator performs a logical conjunction on two expressions. AND compares identically positioned bits in two numeric expressions and sets the corresponding bit in the result field. A result bit will only be set to 1 if both of the corresponding bits in the expression fields are 1. Otherwise the result bit will be 0.
For example:
<pre>
C = A AND B
If A = 1010 (binary) and B = 0011 (binary), then C = 0010 (binary).
</pre>
The OR operator performs a logical disjunction on two numeric expressions. OR compares identically positioned bits in two numeric expressions and sets the corresponding bit in the result field. A result bit will always be set to 1 unless the corresponding bits in both expression fields are 0.
For example:
<pre>
C = A OR B
If A = 1010 (binary) and B = 0011 (binary), then C = 1011 (binary).
</pre>
The XOR operator performs a logical exclusion on two numeric expressions. XOR compares identically positioned bits in two numeric expressions and sets the corresponding bit in the result field. A result bit will only be set to 1 if exactly one of the expression fields has a 1 bit set in the corresponding position.
For example:
<pre>
C = A XOR B
If A = 1010 (binary) and B = 0011 (binary), then C = 1001 (binary).
</pre>

LAUNCH

2010-09-16T20:31:50Z

SteveA:

== LAUNCH ==

'''Syntax:''' LAUNCH Windows-program-or-document 
'''Placement:''' Place the LAUNCH command after the REPORT command. 
'''Discussion:''' Under Comet98 and greater, the LAUNCH command launches a Windows application or document. 
Here are some ways the LAUNCH command can be used: 

Launching a Windows program
LAUNCH c:\msoffice\excel\excel.exe

Launching a Windows program and passing it a file name
LAUNCH c:\msoffice\excel\excel.exe c:\budget\1998.xls

Launching a spreadsheet file
LAUNCH c:\budget\1998.xls

When an "xls" file is launched, Windows automatically runs the Excel program (based on the file extension).

Launching a text file
LAUNCH c:\text\sample.txt

When a "txt" file is launched, Windows automatically runs the associated text editor (Notepad, Wordpad, etc.).

Launching an intranet document
LAUNCH c:\intranet\home.htm

When a local "htm" file is launched, Windows automatically runs the default web browser and displays the HTML document.

Launching an Internet document (web page)
LAUNCH http://www.signature.net/signature/index.html

When the launch value starts with "http://", Windows runs the default web browser, connects to the Internet (if not already connected), and displays the named web page.

'''History:''' This command was added in version 99.01. 
'''Example:''' The following report erases and then creates a data file named TEMPFILE.CSV ("CSV" means "comma separated values") on directory DSK. The PRINTER statement includes a "D" parameter, which specifies a delimited format for the output data.
The report inputs data from the CUSTOMER file and outputs data to the TEMPFILE.CSV file.

After the report has been processed, the Reporter launches the Excel spreadsheet program which opens the TEMPFILE.CSV file.
<pre>
ERASE TEMPFILE.CSV,DSK
PRINTER TEMPFILE.CSV,DSK,D
INPUT CUSTOMER
REPORT
PRINT CUST.NUMBER;CUST.NAME;CREDIT.LIMIT;CURRENT.AR;
AR.OVER.30.DAYS;AR.OVER.60.DAYS;AR.OVER.90.DAYS;
AR.OVER.120.DAYS
LAUNCH c:\msoffice\excel\excel.exe c:\comet\dsk\tempfile.csv
</pre>

'''Notes:''' The Launch command expects the target file to be local to the client PC. If this is not the case you may need to execute a copyfile program prior to the launch, then launch the local copy of the file. 
The Enter command can be used to run your copyfile program. Before writing your own copyfile program you might try using the CUtlCpy utility which is released as part of the UTL directory:
<pre>
ERASE MyTextFile.txt,DSK
PRINTER MyTextFile.txt,DSK
INPUT CUSTOMER
REPORT
PRINT CUST.NUMBER;CUST.NAME;CREDIT.LIMIT;CURRENT.AR;
AR.OVER.30.DAYS;AR.OVER.60.DAYS;AR.OVER.90.DAYS;
AR.OVER.120.DAYS
ENTER CUtlCpy "MyTextFile.txt,DSK,MyPersonalTextFile.txt,$(CATEMP),Y,Y,T"
</pre>
CUtlCpy includes an option to launch the destination file after doing the copy so in this case you don't even need the Reporter launch!

LAUNCH

2010-09-16T20:28:10Z

SteveA:

== LAUNCH ==

'''Syntax:''' LAUNCH Windows-program-or-document 
'''Placement:''' Place the LAUNCH command after the REPORT command. 
'''Discussion:''' Under Comet98 and greater, the LAUNCH command launches a Windows application or document. 
Here are some ways the LAUNCH command can be used: 

Launching a Windows program
LAUNCH c:\msoffice\excel\excel.exe

Launching a Windows program and passing it a file name
LAUNCH c:\msoffice\excel\excel.exe c:\budget\1998.xls

Launching a spreadsheet file
LAUNCH c:\budget\1998.xls

When an "xls" file is launched, Windows automatically runs the Excel program (based on the file extension).

Launching a text file
LAUNCH c:\text\sample.txt

When a "txt" file is launched, Windows automatically runs the associated text editor (Notepad, Wordpad, etc.).

Launching an intranet document
LAUNCH c:\intranet\home.htm

When a local "htm" file is launched, Windows automatically runs the default web browser and displays the HTML document.

Launching an Internet document (web page)
LAUNCH http://www.signature.net/signature/index.html

When the launch value starts with "http://", Windows runs the default web browser, connects to the Internet (if not already connected), and displays the named web page.

'''History:''' This command was added in version 99.01. 
'''Example:''' The following report erases and then creates a data file named TEMPFILE.CSV ("CSV" means "comma separated values") on directory DSK. The PRINTER statement includes a "D" parameter, which specifies a delimited format for the output data.
The report inputs data from the CUSTOMER file and outputs data to the TEMPFILE.CSV file.

After the report has been processed, the Reporter launches the Excel spreadsheet program which opens the TEMPFILE.CSV file.

ERASE TEMPFILE.CSV,DSK 
PRINTER TEMPFILE.CSV,DSK,D 
INPUT CUSTOMER 
REPORT 
PRINT CUST.NUMBER;CUST.NAME;CREDIT.LIMIT;CURRENT.AR; 
AR.OVER.30.DAYS;AR.OVER.60.DAYS;AR.OVER.90.DAYS; 
AR.OVER.120.DAYS 
LAUNCH c:\msoffice\excel\excel.exe c:\comet\dsk\tempfile.csv 

'''Notes:''' The Launch command expects the target file to be local to the client PC. If this is not the case you may need to execute a copyfile program prior to the launch, then launch the local copy of the file. 
The Enter command can be used to run your copyfile program. Before writing your own copyfile program you might try using the CUtlCpy utility which is released as part of the UTL directory:
<pre>
ERASE MyTextFile.txt,DSK
PRINTER MyTextFile.txt,DSK
INPUT CUSTOMER
REPORT
PRINT CUST.NUMBER;CUST.NAME;CREDIT.LIMIT;CURRENT.AR;
AR.OVER.30.DAYS;AR.OVER.60.DAYS;AR.OVER.90.DAYS;
AR.OVER.120.DAYS
ENTER CUtlCpy "MyTextFile.txt,DSK,MyPersonalTextFile.txt,$(CATEMP),Y,Y,T"
</pre>
CUtlCpy includes an option to launch the destination file after doing the copy so in this case you don't even need the Reporter launch!

Talk:IB Statements/autoinput

2010-03-08T15:24:24Z

SteveA: New page: I have found that AutoImput is upseting to Comet operators. They are used to pressing ENTER and "magical" input upsets their rhythm Steve A 3/8/10

I have found that AutoImput is upseting to Comet operators.

They are used to pressing ENTER and "magical" input upsets their rhythm

Steve A 3/8/10

Bulletin Board

2009-10-16T15:56:39Z

SteveA:

I believe this Wiki needs Badge's comments on how pages should be edited. I've put his forum posting here for posterity. Posterity is not the body part you sit on!
:'''Community section on the Wik'''i. This is where most other Wiki's have discussions, generally someone will post a paper or a proposal and then people comment on the discussion page which is attached to all Wiki pages.
:Belatedly I have cut and pasted all the current comments on this to the said page, Indenting is done with a : and your signature is attached with <nowiki>~~~~</nowiki>.
:It is not as simple as the forum but it is a lot easier to find once it scrolls off the bottom of the forum. The Wiki man is proposing a new improved forum style discussion page, Google Wave may put some pressure on him to get it up and running quickly.

[[User:SteveA|SteveA]] 15:56, 16 October 2009 (UTC)

Bulletin Board

2009-10-16T15:56:09Z

SteveA: New page: I believe this Wiki needs Badge's comments on how pages should be edited. I've put his forum posting here for posterity. Posterity is not the body part you sit on! :Community section on th...

I believe this Wiki needs Badge's comments on how pages should be edited. I've put his forum posting here for posterity. Posterity is not the body part you sit on!
:Community section on the Wiki. This is where most other Wiki's have discussions, generally someone will post a paper or a proposal and then people comment on the discussion page which is attached to all Wiki pages.
:Belatedly I have cut and pasted all the current comments on this to the said page, Indenting is done with a : and your signature is attached with <nowiki>~~~~</nowiki>.
:It is not as simple as the forum but it is a lot easier to find once it scrolls off the bottom of the forum. The Wiki man is proposing a new improved forum style discussion page, Google Wave may put some pressure on him to get it up and running quickly.

[[User:SteveA|SteveA]] 15:56, 16 October 2009 (UTC)

Mnemonics "E"

2009-09-05T15:25:23Z

SteveA: /* (EmailDocument) */

==(Easy Scan)==

'''Mnemonic''': (Easy Scan) Hex equivalent: "@0E0000@"

'''Discussion''': The (Easy Scan) mnemonic places the Comet console into "easy scan" mode. (This mnemonic does not apply to QTerm or terminals.) 
In "easy scan" mode, if the user presses one of the recognized keys while the program is at an INPUT prompt, the program responds as if an F10, Enter, or Tab key was pressed. In combination with the returned screen coordinates (see INPUT), this feature allows for an enriched style of screen I/O programming.

In addition, if the mouse driver is active (see the (Mouse On) mnemonic), a mouse click also generates a transmit, and places the cursor's coordinates in the status buffer (see Example 2). Starting with Comet98 Build 232, (Easy Scan) turns the mouse on if it is not already being done.

The (Scan Codes Off) mnemonic terminates "easy scan" mode.

The "reason for transmit" information is stored in the 8th byte of the console's status buffer, and is stored in hex. To determine which key (or click) caused the transmit to occur, perform the following operation:
<pre>
VALUE = ASC(SUB(STS(0),8,1))

Note: VALUE is a numeric field with length/precision of 3.0.

The following values are returned:

Value Key that caused the transmit to occur
4 Up arrow
5 Down arrow
6 Left mouse click
7 Ctrl + Home
8 Ctrl + End
9 Pg Up
10 Ctrl + Pg Up
11 Pg Dn
12 Ctrl + Pg Dn
14 Right mouse click
15 Window caption bar "X" was clicked. See (CreateWindowEx).
</pre>

Values 1, 2, and 3 are generated via the INPUT statement, and do not require the (Easy Scan) mnemonic.

History: The (Easy Scan) mnemonic was added in Comet version 504.208 as part of the enhanced INPUT statement.
Values 7 through 12 were added in Comet 504.228 and Comet98 Build 228.

Starting with Comet98 Build 232, (EasyScan) turns the mouse on if it is not already being done. If it is already on, it is assumed the whoever turned it on will also turn it off.

Starting with Build 292, (EasyScan) disables any scan modes that are currently enabled.

Value 14 was added in Build 294.

As of Build 294, (EasyScan) mouse clicks now occur on the up-click instead of the down-click. This is consistent with other Windows applications.

Value 15 was added in Comet2002 Build 306.
<pre>
Example 1:
PRINT (0) (Mouse On) ! Mouse on (optional)
.
PRINT (0) (Easy Scan) ! Easy scan mode on
.
.
INPUT (0) DATA$ ! Input a field

VALUE = ASC(SUB(STS(0),8,1)) ! Reason for transmit

IF VALUE = 1 ... ! F10 key
IF VALUE = 2 ... ! Enter key
IF VALUE = 3 ... ! Tab key
IF VALUE = 4 ... ! Up arrow
IF VALUE = 5 ... ! Down arrow
IF VALUE = 6 ... ! Left mouse click
IF VALUE = 7 ... ! Ctrl + Home
IF VALUE = 8 ... ! Ctrl + End
IF VALUE = 9 ... ! Pg Up
IF VALUE = 10 ... ! Ctrl + Pg Up
IF VALUE = 11 ... ! Pg Dn
IF VALUE = 12 ... ! Ctrl + Pg Dn
IF VALUE = 14 ... ! Right mouse click
IF VALUE = 15 ... ! Window caption bar "X"
.
.
.
PRINT (0) (ScanCodesOff) ! Easy scan mode off
PRINT (0) (Mouse Off) ! Mouse off (optional)

Example 2:
Data$ = Sub(Sts(0), 1, 254) ! Get console status
J = Asc(Sub(Data$, 8, 1)) ! Get reason for transmit
If (J EQ 6) ! Mouse was clicked
Row = Asc(Sub(Data$, 15, 1)) ! Get the row
Col = Asc(sub(Data$, 16, 1)) ! Get the column
Endif
</pre>
This example shows how to determine the cursor's coordinates when the mouse is clicked.

==(Ellipse)==
'''Mnemonic''': (Ellipse=left, top, right, bottom)

'''Discussion''': This mnemonic draws an ellipse. The center of the ellipse is the center of the bounding rectangle specified by left, top, right, bottom. The ellipse is drawn with the current pen, and its interior is filled with the current brush.
The figure drawn by this function extends up to, but does not include, the right and bottom coordinates. This means that the height of the figure is bottom - top and the width of the figure is right - left.

If either the width or the height of the bounding rectangle is 0, no ellipse is drawn.

History: This mnemonic is valid in Comet98 and greater

== (EmailDocument) ==
'''Email Mnemonic:''' (EmailDocument=string-argument)

'''Discussion:''' The (EmailDocument) mnemonic may be used to specify the name associated with an attachment file. If an extension is not assigned, one appropriate for the file type will automatically be included (.pdf, .htm, etc). If this mnemonic is not used, the attachment will carry the default name assigned to the document.
<pre>
Example:
OPEN (1) "LEH"
PRINT (1) (EmailDocument="OrderDetails")
</pre>

== Email printer mnemonics ==
<pre>
Mnemonic Description
(Server = SMTPServerName$) Specify SMTP server name and port
(Domain = Domain$) Specify email domain name
(From = FromAddr$) Specify sender's name and address
(To = ToAddr$) Specify recipient's name and address
(CC = CCaddr$) Specify CC recipient's name and address
(BCC = BCCaddr$) Specify BCC recipient's name and address
(Subject = Subject$) Specify message's subject line
(Text = Text$) Specify a line of body text
(EmailDocument = Name$) Specify a name for the attachment
(Log = LogFile$,LogDir$,ERASE) Specify a log file name and erase parameter

Discussion of the Email Printer (requires access to web site)

Read about other Email Mnemonics
</pre>
== (EN) ==
<pre>
Mnemonic: (EN)
Hex equivalent: "@0E06@"
Discussion: Enter normal mode.
The (EN) control code sets the video display in normal mode. The location of displayed information, the placement of the cursor, and the places where data is transmitted are determined by the FORMAT statements in the program.

The alternative to normal mode is typewriter mode.

Example: a. 100 FORMAT (EN);(SB);"CUSTOMER INQUIRY",@(10,0)
.
PRINT (0,100)

b. PRINT (0) (EN);(SB);"CUSTOMER INQUIRY",@(10,0)

This example shows how to set normal mode, either at the beginning of a FORMAT statement or within a PRINT statement. The additional controls set background mode and display a heading at column 10, row 0.
</pre>
== (End Metafile) ==
<pre>
Mnemonic: (EndMetafile = flags)
Discussion: End the metafile collection process by saving and/or executing the currently active MetaFile.
Where flags indicate:

VMF.SAVE = 0 ! Save the file - do not execute
VMF.EXECUTE = 1 ! Execute the metafile

</pre>
== (EndWaitCursor) ==
<pre>
Mnemonic: (EndWaitCursor)
Discussion: This mnemonic turns off the hourglass cursor.
See (BeginWaitCursor) and (RestoreWaitCursor).

Example: Print (BeginWaitCursor)
.
.
.
Print (EndWaitCursor)
</pre>
== (Enhanced Mouse On) ==
<pre>
Mnemonic: (Enhanced Mouse On)
Hex equivalent: "@0E0906@"
Discussion: This control opens the enhanced mouse driver (if possible).
Also see (BIOS Mouse On) and (Mouse On).

Example: a. 100 FORMAT (Enhanced Mouse On)
.
PRINT (0,100)

b. PRINT (0) (Enhanced Mouse On

</pre>
== (EN) ==
<pre>
Mnemonic: (EN)
Hex equivalent: "@0E06@"
Discussion: Enter normal mode.
The (EN) control code sets the video display in normal mode. The location of displayed information, the placement of the cursor, and the places where data is transmitted are determined by the FORMAT statements in the program.

The alternative to normal mode is typewriter mode.

Example: a. 100 FORMAT (EN);(SB);"CUSTOMER INQUIRY",@(10,0)
.
PRINT (0,100)

b. PRINT (0) (EN);(SB);"CUSTOMER INQUIRY",@(10,0)

This example shows how to set normal mode, either at the beginning of a FORMAT statement or within a PRINT statement. The additional controls set background mode and display a heading at column 10, row 0.
</pre>
== (ET) ==
<pre>
Mnemonic: (ET)
Hex equivalent: "@0E05@"
Discussion: Enter typewriter mode.
The (ET) control code sets the video display in typewriter mode. Each new line of data written to the screen causes the screen to scroll up one line. The new line of data is written on the bottom line of the screen in background mode.

Transmit marks are automatically placed after the last byte of data written and at the lower right corner of the screen (making the remaining part of the bottom line the foreground data entry field).

The cursor is placed at the left-most position of the foreground field on the bottom line.

The alternative to typewriter mode is normal mode.

Example: a. 100 FORMAT (ET)
.
PRINT (0,100)
PRINT (0) "ENTER CUSTOMER NUMBER:"
INPUT (0) CUSTNUM$

b. PRINT (0) (ET)
PRINT (0) "ENTER CUSTOMER NUMBER:"
INPUT (0) CUSTNUM$

In this example, the screen is placed into typewriter mode. Then a prompt is displayed and data is accepted into the variable named CUSTNUM$. Items such as foreground, background and transmit marks are handled automatically.

</pre>
== (EraseFile) ==
<pre>
Mnemonic: (EraseFile=file,flags)
Discussion: The mnemonic erases a Windows file.
This mnemonic may be used by foreground programs only.

The file name is in Windows format, UNC format, or a directory alias.

Flags is the sum of the specified decimal values from the following chart:

Flag Description
1 Perform function at CometAnywhere remote system
2 If not CometAnywhere, then substitute local for remote
If the program is running on a local Comet system (not on a CometAnywhere client system), this flag substitutes the local drive/path name for a remote path/drive name.

After this mnemonic is issued, your program can issue an INPUT on LUN (0) to retrieve the error information. For example:

LENGTH 2 & LOCAL AX$,DX$
LENGTH 254 & LOCAL RESULT$
ResultFmt: FORMAT AX$;DX$;RESULT$
.
.
Print (EraseFile=File$,Flags)
Input (0,ResultFmt)

The first field, AX$, contains the function error code, and the second field, DX$, contains the suberror code (aka the Windows file error code). Both of these fields are in Intel 2's complement format, and should be processed as follows:
AX$ = SUB(AX$,2,1) + SUB(AX$,1,1) ! Flip the bytes around
DX$ = SUB(DX$,2,1) + SUB(DX$,1,1) ! Flip the bytes around
FuncError = HexDec(AX$) ! Function error code (decimal)
FileError = HexDec(DX$) ! File error code (decimal)

! For unexpected values, convert to 2's complement signed integer
If (FuncError > 32767) FuncError = FuncError-65536
If (FileError > 32767) FileError = FileError-65536

Here is a list of the function error codes in decimal form:
Error
(FuncError) Description
0 Function not supported
1 Success
2 CometAnywhere required
3 Source file error (see suberrors)
4 Aborted by user
5 Function in progress

Here is a list of the suberror codes (common Windows file errors) in decimal form:

Suberror
(FileError) Description
0 Success
2 File not found
3 Path not found
5 Access denied
12 Invalid access
15 Invalid drive
16 An error has occurred in the current directory
18 No more files
32 Sharing violation
33 Lock violation
80 File exists
161 Bad pathname

History: This mnemonic was added in Comet Build 299 and REL Version 01.07.
</pre>
== Execute Metafile ==
<pre>
Mnemonic: (ExecuteMetafile = FileName)
Discussion: Executes the previously saved metafile FileName.
</pre>

Mnemonics "E"

2009-09-05T15:24:09Z

SteveA: /* (Ellipse) */

==(Easy Scan)==

'''Mnemonic''': (Easy Scan) Hex equivalent: "@0E0000@"

'''Discussion''': The (Easy Scan) mnemonic places the Comet console into "easy scan" mode. (This mnemonic does not apply to QTerm or terminals.) 
In "easy scan" mode, if the user presses one of the recognized keys while the program is at an INPUT prompt, the program responds as if an F10, Enter, or Tab key was pressed. In combination with the returned screen coordinates (see INPUT), this feature allows for an enriched style of screen I/O programming.

In addition, if the mouse driver is active (see the (Mouse On) mnemonic), a mouse click also generates a transmit, and places the cursor's coordinates in the status buffer (see Example 2). Starting with Comet98 Build 232, (Easy Scan) turns the mouse on if it is not already being done.

The (Scan Codes Off) mnemonic terminates "easy scan" mode.

The "reason for transmit" information is stored in the 8th byte of the console's status buffer, and is stored in hex. To determine which key (or click) caused the transmit to occur, perform the following operation:
<pre>
VALUE = ASC(SUB(STS(0),8,1))

Note: VALUE is a numeric field with length/precision of 3.0.

The following values are returned:

Value Key that caused the transmit to occur
4 Up arrow
5 Down arrow
6 Left mouse click
7 Ctrl + Home
8 Ctrl + End
9 Pg Up
10 Ctrl + Pg Up
11 Pg Dn
12 Ctrl + Pg Dn
14 Right mouse click
15 Window caption bar "X" was clicked. See (CreateWindowEx).
</pre>

Values 1, 2, and 3 are generated via the INPUT statement, and do not require the (Easy Scan) mnemonic.

History: The (Easy Scan) mnemonic was added in Comet version 504.208 as part of the enhanced INPUT statement.
Values 7 through 12 were added in Comet 504.228 and Comet98 Build 228.

Starting with Comet98 Build 232, (EasyScan) turns the mouse on if it is not already being done. If it is already on, it is assumed the whoever turned it on will also turn it off.

Starting with Build 292, (EasyScan) disables any scan modes that are currently enabled.

Value 14 was added in Build 294.

As of Build 294, (EasyScan) mouse clicks now occur on the up-click instead of the down-click. This is consistent with other Windows applications.

Value 15 was added in Comet2002 Build 306.
<pre>
Example 1:
PRINT (0) (Mouse On) ! Mouse on (optional)
.
PRINT (0) (Easy Scan) ! Easy scan mode on
.
.
INPUT (0) DATA$ ! Input a field

VALUE = ASC(SUB(STS(0),8,1)) ! Reason for transmit

IF VALUE = 1 ... ! F10 key
IF VALUE = 2 ... ! Enter key
IF VALUE = 3 ... ! Tab key
IF VALUE = 4 ... ! Up arrow
IF VALUE = 5 ... ! Down arrow
IF VALUE = 6 ... ! Left mouse click
IF VALUE = 7 ... ! Ctrl + Home
IF VALUE = 8 ... ! Ctrl + End
IF VALUE = 9 ... ! Pg Up
IF VALUE = 10 ... ! Ctrl + Pg Up
IF VALUE = 11 ... ! Pg Dn
IF VALUE = 12 ... ! Ctrl + Pg Dn
IF VALUE = 14 ... ! Right mouse click
IF VALUE = 15 ... ! Window caption bar "X"
.
.
.
PRINT (0) (ScanCodesOff) ! Easy scan mode off
PRINT (0) (Mouse Off) ! Mouse off (optional)

Example 2:
Data$ = Sub(Sts(0), 1, 254) ! Get console status
J = Asc(Sub(Data$, 8, 1)) ! Get reason for transmit
If (J EQ 6) ! Mouse was clicked
Row = Asc(Sub(Data$, 15, 1)) ! Get the row
Col = Asc(sub(Data$, 16, 1)) ! Get the column
Endif
</pre>
This example shows how to determine the cursor's coordinates when the mouse is clicked.

==(Ellipse)==
'''Mnemonic''': (Ellipse=left, top, right, bottom)

'''Discussion''': This mnemonic draws an ellipse. The center of the ellipse is the center of the bounding rectangle specified by left, top, right, bottom. The ellipse is drawn with the current pen, and its interior is filled with the current brush.
The figure drawn by this function extends up to, but does not include, the right and bottom coordinates. This means that the height of the figure is bottom - top and the width of the figure is right - left.

If either the width or the height of the bounding rectangle is 0, no ellipse is drawn.

History: This mnemonic is valid in Comet98 and greater

== (EmailDocument) ==
<pre>
Email Mnemonic: (EmailDocument=string-argument)
Discussion: The (EmailDocument) mnemonic may be used to specify the name associated with an attachment file. If an extension is not assigned, one appropriate for the file type will automatically be included (.pdf, .htm, etc). If this mnemonic is not used, the attachment will carry the default name assigned to the document.
Example: OPEN (1) "LEH"
PRINT (1) (EmailDocument="OrderDetails")

</pre>
== Email printer mnemonics ==
<pre>
Mnemonic Description
(Server = SMTPServerName$) Specify SMTP server name and port
(Domain = Domain$) Specify email domain name
(From = FromAddr$) Specify sender's name and address
(To = ToAddr$) Specify recipient's name and address
(CC = CCaddr$) Specify CC recipient's name and address
(BCC = BCCaddr$) Specify BCC recipient's name and address
(Subject = Subject$) Specify message's subject line
(Text = Text$) Specify a line of body text
(EmailDocument = Name$) Specify a name for the attachment
(Log = LogFile$,LogDir$,ERASE) Specify a log file name and erase parameter

Discussion of the Email Printer (requires access to web site)

Read about other Email Mnemonics
</pre>
== (EN) ==
<pre>
Mnemonic: (EN)
Hex equivalent: "@0E06@"
Discussion: Enter normal mode.
The (EN) control code sets the video display in normal mode. The location of displayed information, the placement of the cursor, and the places where data is transmitted are determined by the FORMAT statements in the program.

The alternative to normal mode is typewriter mode.

Example: a. 100 FORMAT (EN);(SB);"CUSTOMER INQUIRY",@(10,0)
.
PRINT (0,100)

b. PRINT (0) (EN);(SB);"CUSTOMER INQUIRY",@(10,0)

This example shows how to set normal mode, either at the beginning of a FORMAT statement or within a PRINT statement. The additional controls set background mode and display a heading at column 10, row 0.
</pre>
== (End Metafile) ==
<pre>
Mnemonic: (EndMetafile = flags)
Discussion: End the metafile collection process by saving and/or executing the currently active MetaFile.
Where flags indicate:

VMF.SAVE = 0 ! Save the file - do not execute
VMF.EXECUTE = 1 ! Execute the metafile

</pre>
== (EndWaitCursor) ==
<pre>
Mnemonic: (EndWaitCursor)
Discussion: This mnemonic turns off the hourglass cursor.
See (BeginWaitCursor) and (RestoreWaitCursor).

Example: Print (BeginWaitCursor)
.
.
.
Print (EndWaitCursor)
</pre>
== (Enhanced Mouse On) ==
<pre>
Mnemonic: (Enhanced Mouse On)
Hex equivalent: "@0E0906@"
Discussion: This control opens the enhanced mouse driver (if possible).
Also see (BIOS Mouse On) and (Mouse On).

Example: a. 100 FORMAT (Enhanced Mouse On)
.
PRINT (0,100)

b. PRINT (0) (Enhanced Mouse On

</pre>
== (EN) ==
<pre>
Mnemonic: (EN)
Hex equivalent: "@0E06@"
Discussion: Enter normal mode.
The (EN) control code sets the video display in normal mode. The location of displayed information, the placement of the cursor, and the places where data is transmitted are determined by the FORMAT statements in the program.

The alternative to normal mode is typewriter mode.

Example: a. 100 FORMAT (EN);(SB);"CUSTOMER INQUIRY",@(10,0)
.
PRINT (0,100)

b. PRINT (0) (EN);(SB);"CUSTOMER INQUIRY",@(10,0)

This example shows how to set normal mode, either at the beginning of a FORMAT statement or within a PRINT statement. The additional controls set background mode and display a heading at column 10, row 0.
</pre>
== (ET) ==
<pre>
Mnemonic: (ET)
Hex equivalent: "@0E05@"
Discussion: Enter typewriter mode.
The (ET) control code sets the video display in typewriter mode. Each new line of data written to the screen causes the screen to scroll up one line. The new line of data is written on the bottom line of the screen in background mode.

Transmit marks are automatically placed after the last byte of data written and at the lower right corner of the screen (making the remaining part of the bottom line the foreground data entry field).

The cursor is placed at the left-most position of the foreground field on the bottom line.

The alternative to typewriter mode is normal mode.

Example: a. 100 FORMAT (ET)
.
PRINT (0,100)
PRINT (0) "ENTER CUSTOMER NUMBER:"
INPUT (0) CUSTNUM$

b. PRINT (0) (ET)
PRINT (0) "ENTER CUSTOMER NUMBER:"
INPUT (0) CUSTNUM$

In this example, the screen is placed into typewriter mode. Then a prompt is displayed and data is accepted into the variable named CUSTNUM$. Items such as foreground, background and transmit marks are handled automatically.

</pre>
== (EraseFile) ==
<pre>
Mnemonic: (EraseFile=file,flags)
Discussion: The mnemonic erases a Windows file.
This mnemonic may be used by foreground programs only.

The file name is in Windows format, UNC format, or a directory alias.

Flags is the sum of the specified decimal values from the following chart:

Flag Description
1 Perform function at CometAnywhere remote system
2 If not CometAnywhere, then substitute local for remote
If the program is running on a local Comet system (not on a CometAnywhere client system), this flag substitutes the local drive/path name for a remote path/drive name.

After this mnemonic is issued, your program can issue an INPUT on LUN (0) to retrieve the error information. For example:

LENGTH 2 & LOCAL AX$,DX$
LENGTH 254 & LOCAL RESULT$
ResultFmt: FORMAT AX$;DX$;RESULT$
.
.
Print (EraseFile=File$,Flags)
Input (0,ResultFmt)

The first field, AX$, contains the function error code, and the second field, DX$, contains the suberror code (aka the Windows file error code). Both of these fields are in Intel 2's complement format, and should be processed as follows:
AX$ = SUB(AX$,2,1) + SUB(AX$,1,1) ! Flip the bytes around
DX$ = SUB(DX$,2,1) + SUB(DX$,1,1) ! Flip the bytes around
FuncError = HexDec(AX$) ! Function error code (decimal)
FileError = HexDec(DX$) ! File error code (decimal)

! For unexpected values, convert to 2's complement signed integer
If (FuncError > 32767) FuncError = FuncError-65536
If (FileError > 32767) FileError = FileError-65536

Here is a list of the function error codes in decimal form:
Error
(FuncError) Description
0 Function not supported
1 Success
2 CometAnywhere required
3 Source file error (see suberrors)
4 Aborted by user
5 Function in progress

Here is a list of the suberror codes (common Windows file errors) in decimal form:

Suberror
(FileError) Description
0 Success
2 File not found
3 Path not found
5 Access denied
12 Invalid access
15 Invalid drive
16 An error has occurred in the current directory
18 No more files
32 Sharing violation
33 Lock violation
80 File exists
161 Bad pathname

History: This mnemonic was added in Comet Build 299 and REL Version 01.07.
</pre>
== Execute Metafile ==
<pre>
Mnemonic: (ExecuteMetafile = FileName)
Discussion: Executes the previously saved metafile FileName.
</pre>

Mnemonics "E"

2009-09-05T15:21:20Z

SteveA: /* (Easy Scan) */

==(Easy Scan)==

'''Mnemonic''': (Easy Scan) Hex equivalent: "@0E0000@"

'''Discussion''': The (Easy Scan) mnemonic places the Comet console into "easy scan" mode. (This mnemonic does not apply to QTerm or terminals.) 
In "easy scan" mode, if the user presses one of the recognized keys while the program is at an INPUT prompt, the program responds as if an F10, Enter, or Tab key was pressed. In combination with the returned screen coordinates (see INPUT), this feature allows for an enriched style of screen I/O programming.

In addition, if the mouse driver is active (see the (Mouse On) mnemonic), a mouse click also generates a transmit, and places the cursor's coordinates in the status buffer (see Example 2). Starting with Comet98 Build 232, (Easy Scan) turns the mouse on if it is not already being done.

The (Scan Codes Off) mnemonic terminates "easy scan" mode.

The "reason for transmit" information is stored in the 8th byte of the console's status buffer, and is stored in hex. To determine which key (or click) caused the transmit to occur, perform the following operation:
<pre>
VALUE = ASC(SUB(STS(0),8,1))

Note: VALUE is a numeric field with length/precision of 3.0.

The following values are returned:

Value Key that caused the transmit to occur
4 Up arrow
5 Down arrow
6 Left mouse click
7 Ctrl + Home
8 Ctrl + End
9 Pg Up
10 Ctrl + Pg Up
11 Pg Dn
12 Ctrl + Pg Dn
14 Right mouse click
15 Window caption bar "X" was clicked. See (CreateWindowEx).
</pre>

Values 1, 2, and 3 are generated via the INPUT statement, and do not require the (Easy Scan) mnemonic.

History: The (Easy Scan) mnemonic was added in Comet version 504.208 as part of the enhanced INPUT statement.
Values 7 through 12 were added in Comet 504.228 and Comet98 Build 228.

Starting with Comet98 Build 232, (EasyScan) turns the mouse on if it is not already being done. If it is already on, it is assumed the whoever turned it on will also turn it off.

Starting with Build 292, (EasyScan) disables any scan modes that are currently enabled.

Value 14 was added in Build 294.

As of Build 294, (EasyScan) mouse clicks now occur on the up-click instead of the down-click. This is consistent with other Windows applications.

Value 15 was added in Comet2002 Build 306.
<pre>
Example 1:
PRINT (0) (Mouse On) ! Mouse on (optional)
.
PRINT (0) (Easy Scan) ! Easy scan mode on
.
.
INPUT (0) DATA$ ! Input a field

VALUE = ASC(SUB(STS(0),8,1)) ! Reason for transmit

IF VALUE = 1 ... ! F10 key
IF VALUE = 2 ... ! Enter key
IF VALUE = 3 ... ! Tab key
IF VALUE = 4 ... ! Up arrow
IF VALUE = 5 ... ! Down arrow
IF VALUE = 6 ... ! Left mouse click
IF VALUE = 7 ... ! Ctrl + Home
IF VALUE = 8 ... ! Ctrl + End
IF VALUE = 9 ... ! Pg Up
IF VALUE = 10 ... ! Ctrl + Pg Up
IF VALUE = 11 ... ! Pg Dn
IF VALUE = 12 ... ! Ctrl + Pg Dn
IF VALUE = 14 ... ! Right mouse click
IF VALUE = 15 ... ! Window caption bar "X"
.
.
.
PRINT (0) (ScanCodesOff) ! Easy scan mode off
PRINT (0) (Mouse Off) ! Mouse off (optional)

Example 2:
Data$ = Sub(Sts(0), 1, 254) ! Get console status
J = Asc(Sub(Data$, 8, 1)) ! Get reason for transmit
If (J EQ 6) ! Mouse was clicked
Row = Asc(Sub(Data$, 15, 1)) ! Get the row
Col = Asc(sub(Data$, 16, 1)) ! Get the column
Endif
</pre>
This example shows how to determine the cursor's coordinates when the mouse is clicked.

== (Ellipse) ==
<pre>
Mnemonic: (Ellipse=left, top, right, bottom)
Discussion: This mnemonic draws an ellipse. The center of the ellipse is the center of the bounding rectangle specified by left, top, right, bottom. The ellipse is drawn with the current pen, and its interior is filled with the current brush.
The figure drawn by this function extends up to, but does not include, the right and bottom coordinates. This means that the height of the figure is bottom - top and the width of the figure is right - left.

If either the width or the height of the bounding rectangle is 0, no ellipse is drawn.

History: This mnemonic is valid in Comet98 and greater
</pre>
== (EmailDocument) ==
<pre>
Email Mnemonic: (EmailDocument=string-argument)
Discussion: The (EmailDocument) mnemonic may be used to specify the name associated with an attachment file. If an extension is not assigned, one appropriate for the file type will automatically be included (.pdf, .htm, etc). If this mnemonic is not used, the attachment will carry the default name assigned to the document.
Example: OPEN (1) "LEH"
PRINT (1) (EmailDocument="OrderDetails")

</pre>
== Email printer mnemonics ==
<pre>
Mnemonic Description
(Server = SMTPServerName$) Specify SMTP server name and port
(Domain = Domain$) Specify email domain name
(From = FromAddr$) Specify sender's name and address
(To = ToAddr$) Specify recipient's name and address
(CC = CCaddr$) Specify CC recipient's name and address
(BCC = BCCaddr$) Specify BCC recipient's name and address
(Subject = Subject$) Specify message's subject line
(Text = Text$) Specify a line of body text
(EmailDocument = Name$) Specify a name for the attachment
(Log = LogFile$,LogDir$,ERASE) Specify a log file name and erase parameter

Discussion of the Email Printer (requires access to web site)

Read about other Email Mnemonics
</pre>
== (EN) ==
<pre>
Mnemonic: (EN)
Hex equivalent: "@0E06@"
Discussion: Enter normal mode.
The (EN) control code sets the video display in normal mode. The location of displayed information, the placement of the cursor, and the places where data is transmitted are determined by the FORMAT statements in the program.

The alternative to normal mode is typewriter mode.

Example: a. 100 FORMAT (EN);(SB);"CUSTOMER INQUIRY",@(10,0)
.
PRINT (0,100)

b. PRINT (0) (EN);(SB);"CUSTOMER INQUIRY",@(10,0)

This example shows how to set normal mode, either at the beginning of a FORMAT statement or within a PRINT statement. The additional controls set background mode and display a heading at column 10, row 0.
</pre>
== (End Metafile) ==
<pre>
Mnemonic: (EndMetafile = flags)
Discussion: End the metafile collection process by saving and/or executing the currently active MetaFile.
Where flags indicate:

VMF.SAVE = 0 ! Save the file - do not execute
VMF.EXECUTE = 1 ! Execute the metafile

</pre>
== (EndWaitCursor) ==
<pre>
Mnemonic: (EndWaitCursor)
Discussion: This mnemonic turns off the hourglass cursor.
See (BeginWaitCursor) and (RestoreWaitCursor).

Example: Print (BeginWaitCursor)
.
.
.
Print (EndWaitCursor)
</pre>
== (Enhanced Mouse On) ==
<pre>
Mnemonic: (Enhanced Mouse On)
Hex equivalent: "@0E0906@"
Discussion: This control opens the enhanced mouse driver (if possible).
Also see (BIOS Mouse On) and (Mouse On).

Example: a. 100 FORMAT (Enhanced Mouse On)
.
PRINT (0,100)

b. PRINT (0) (Enhanced Mouse On

</pre>
== (EN) ==
<pre>
Mnemonic: (EN)
Hex equivalent: "@0E06@"
Discussion: Enter normal mode.
The (EN) control code sets the video display in normal mode. The location of displayed information, the placement of the cursor, and the places where data is transmitted are determined by the FORMAT statements in the program.

The alternative to normal mode is typewriter mode.

Example: a. 100 FORMAT (EN);(SB);"CUSTOMER INQUIRY",@(10,0)
.
PRINT (0,100)

b. PRINT (0) (EN);(SB);"CUSTOMER INQUIRY",@(10,0)

This example shows how to set normal mode, either at the beginning of a FORMAT statement or within a PRINT statement. The additional controls set background mode and display a heading at column 10, row 0.
</pre>
== (ET) ==
<pre>
Mnemonic: (ET)
Hex equivalent: "@0E05@"
Discussion: Enter typewriter mode.
The (ET) control code sets the video display in typewriter mode. Each new line of data written to the screen causes the screen to scroll up one line. The new line of data is written on the bottom line of the screen in background mode.

Transmit marks are automatically placed after the last byte of data written and at the lower right corner of the screen (making the remaining part of the bottom line the foreground data entry field).

The cursor is placed at the left-most position of the foreground field on the bottom line.

The alternative to typewriter mode is normal mode.

Example: a. 100 FORMAT (ET)
.
PRINT (0,100)
PRINT (0) "ENTER CUSTOMER NUMBER:"
INPUT (0) CUSTNUM$

b. PRINT (0) (ET)
PRINT (0) "ENTER CUSTOMER NUMBER:"
INPUT (0) CUSTNUM$

In this example, the screen is placed into typewriter mode. Then a prompt is displayed and data is accepted into the variable named CUSTNUM$. Items such as foreground, background and transmit marks are handled automatically.

</pre>
== (EraseFile) ==
<pre>
Mnemonic: (EraseFile=file,flags)
Discussion: The mnemonic erases a Windows file.
This mnemonic may be used by foreground programs only.

The file name is in Windows format, UNC format, or a directory alias.

Flags is the sum of the specified decimal values from the following chart:

Flag Description
1 Perform function at CometAnywhere remote system
2 If not CometAnywhere, then substitute local for remote
If the program is running on a local Comet system (not on a CometAnywhere client system), this flag substitutes the local drive/path name for a remote path/drive name.

After this mnemonic is issued, your program can issue an INPUT on LUN (0) to retrieve the error information. For example:

LENGTH 2 & LOCAL AX$,DX$
LENGTH 254 & LOCAL RESULT$
ResultFmt: FORMAT AX$;DX$;RESULT$
.
.
Print (EraseFile=File$,Flags)
Input (0,ResultFmt)

The first field, AX$, contains the function error code, and the second field, DX$, contains the suberror code (aka the Windows file error code). Both of these fields are in Intel 2's complement format, and should be processed as follows:
AX$ = SUB(AX$,2,1) + SUB(AX$,1,1) ! Flip the bytes around
DX$ = SUB(DX$,2,1) + SUB(DX$,1,1) ! Flip the bytes around
FuncError = HexDec(AX$) ! Function error code (decimal)
FileError = HexDec(DX$) ! File error code (decimal)

! For unexpected values, convert to 2's complement signed integer
If (FuncError > 32767) FuncError = FuncError-65536
If (FileError > 32767) FileError = FileError-65536

Here is a list of the function error codes in decimal form:
Error
(FuncError) Description
0 Function not supported
1 Success
2 CometAnywhere required
3 Source file error (see suberrors)
4 Aborted by user
5 Function in progress

Here is a list of the suberror codes (common Windows file errors) in decimal form:

Suberror
(FileError) Description
0 Success
2 File not found
3 Path not found
5 Access denied
12 Invalid access
15 Invalid drive
16 An error has occurred in the current directory
18 No more files
32 Sharing violation
33 Lock violation
80 File exists
161 Bad pathname

History: This mnemonic was added in Comet Build 299 and REL Version 01.07.
</pre>
== Execute Metafile ==
<pre>
Mnemonic: (ExecuteMetafile = FileName)
Discussion: Executes the previously saved metafile FileName.
</pre>

Mnemonics "D"

2009-09-04T21:31:08Z

SteveA: /* (Draw Text) */

==(DE)==
'''Mnemonic''': (DE) Hex equivalent: "@0404@"

'''Discussion''': Default characters per line.
This control code sets the default number of characters per line. The default value is established in the terminal setup, the terminal emulator setup, or the console setup, depending on the type of device being used.

Also see (Screen), (CPL132), (CPL64), and (CPL80).
<pre>
Example:
a. 100 FORMAT (DE)
.
PRINT (0,100)

b. PRINT (0) (DE)
</pre>

==(Delete Window)==
'''Mnemonic''': (Delete Window) Hex equivalent: "@0E0D01@"

'''Discussion''': This mnemonic deletes a Comet window. If multiple windows have been created, this mnemonic deletes the most recently displayed window. 
When a window is deleted, the memory it used is returned to the amount of available window memory. To determine how much window memory remains, perform a numeric input immediately following the deletion of a window. See the window memory page for more information. If you do not need to know how much window memory remains, perform a null INPUT immediately after printing the (Delete Window) mnemonic.

Also see the discussion on Comet windows.
<pre>
Example:
a. 100 FORMAT (Delete Window)
.
PRINT (0,100)
INPUT (0) ""

b. PRINT (0) (Delete Window)
INPUT (0) ""
</pre>

==(DeleteWindowEx)==
'''Mnemonic''': (DeleteWindowEx=handle$)

'''Discussion''': This mnemonic deletes an extended window.
Each extended window is identified by a 4-byte string known as a window handle. The handle value is assigned by the system and returned to the Internet Basic program via an INPUT statement following the (CreateWindowEx).

See the WinDemo.ibs program (available at www.signature.net/download/demos) for examples of extended windows.

Also see (SelectWindowEx).

History: This feature is supported in Comet2002 Build 306 and higher.
Example: The following example creates two extended windows, then uses the (DeleteWindowEx) mnemonic to delete them.
<pre>
Length 4 & Local Handle1$,Handle2$
.
Print (CreateWindowEx=0,0,35,15,68,0,"Window 1")
Input Handle1$

Print (CreateWindowEx=0,40,20,10,68,0,"Window 2")
Input Handle2$
.
.
.
Print (DeleteWindowEx=Handle1$) ! delete window 1
Print (DeleteWindowEx=Handle2$) ! delete window 2
</pre>

==(Document)==
'''Mnemonic''': (Document=string-argument, string argument)

'''Discussion''': The (Document) mnemonic specifies a file name and Comet directory to be used for pdf, html, or txt print files. You may issue the mnemonic several times to produce multiple uniquely-named copies of the output file. Because a qdir entry will not be created for this file, you may use long filenames. CosP uses CometLib to make the document copies. Thus, a COM license is required to use this mnemonic.
The first string-argument is a string constant or variable containing the file name. If the name does not contain an extension, the appropriate one (.pdf, .html, or .txt) will be added depending on the type of printer being used. The second string-argument is the 3-character name of the CFAM directory where the file will be created.

If the second argument is an empty string, it is assumed that the first argument is a fully qualified windows path to the output file. This may point to a CFAM or non CFAM controlled directory. This path may not contain a directory alias. If a directory alias is required, use the (GetDirAlias) mnemonic to build the path.

Note: Do not confuse the (Document) mnemonic's use with that of (SpoolMessage). They serve two different purposes and may both be used on the same document. While the (Document) mnemonic is used to copy the document to any CFAM directory or windows path, the (SpoolMessage) mnemonic is used to name the document stored in a configured Archive.

The (Document) mnemonic is not available for CometAnywhere Clients.
<pre>
Example:
OPEN(1) "LPH"
PRINT(1) (DOCUMENT="Sales Report","RPT")
PRINT(1) (DOCUMENT="\\MyServer\archive\Sales Report 05-14-08.htm","")
</pre>

==(Domain)==
'''Email Mnemonic''': (Domain=string-argument)

'''Discussion''': The (Domain) mnemonic may be used to specify a domain name for the the smtp server for your email printer. If not specified, the email printer will supply the same domain as designated in the (Server=) mnemonic.
<pre>
Example:
OPEN (1) "LEH"
PRINT (1) (Server="smtp.our.mail.server.net 25")
PRINT (1) (Domain="our.mail.server.net")
</pre>

==(Draw Bit Map)==
'''Mnemonic''': (Draw Bit Map=left, top, right, bottom, scaleX, scaleY, flags); filename

'''Discussion''': This mnemonic draws the bitmap contained in the file (.BMP/.JPG) specified in filename in the rectangle specified by left, top, right, bottom using the format codes contained in flags. Scaling factors can be specified in scaleX, scaleY.
Valid format code are:
<pre>
BMR.FIT.TO.RECT Stretch (or shrink) bitmap to fit rectangle.

Cannot be used with any other codes or

BMR.CENTER.HZ.RECT Center the bitmap horizontally in rectangle
BMR.CENTER.VT.RECT Center the bitmap vertically in rectangle
BMR.SCALE Multiply dimensions by scaling factors below

When scaling, values contained in ScaleX and ScaleY are converted to floating point, divided by 100, and then multiplied by their respective axis to providing scaling by as little as 1 percent.
Scaling example:

To double only the horizontal size of a bitmap:

ScaleX = 200 ! * 2
ScaleY = 100 ! * 1

To halve a bitmap
ScaleX = 50 ! * .5
ScaleY = 50 ! * .5

To convert bitmap pixels to .01 inch:
ScaleX = 1440 ! * 14.40 (TWIPS/inch)
ScaleY = 1440 ! * 14.40 (TWIPS/inch)
</pre>
See (Draw Image).
History: This mnemonic is valid in Comet98 and greater.

==(Draw box)==

'''Mnemonic''': (Draw box=a,b,c,d) 
where: 
'''a''' = upper left column (decimal) 
'''b''' = upper left row (decimal) 
'''c''' = lower right column (decimal) 
'''d''' = lower right row (decimal)

Hex equivalent: -- 
'''Discussion''': This mnemonic draws a graphical box using the specified screen coordinates (decimal values).
Note: The box overwrites any text displayed on the screen within the specified coordinates (i.e., this is not a "window").

Also see the discussion on Comet windows.
<pre>
Example:
a. 100 FORMAT (Draw box=2,3,5,10)
.
PRINT (0,100

b. PRINT (0) (Draw box=2,3,5,10)
</pre>

==(Draw Image)==
'''Mnemonic''': (Draw Image=left, top, right, bottom, scaleX, scaleY, flags, filename)

'''Discussion''': This mnemonic draws the bitmap contained in the file (.BMP/.JPG) specified in filename in the rectangle specified by left, top, right, bottom using the format codes contained in flags. Scaling factors can be specified in scaleX, scaleY.
(Draw Image) performs the same function as (Draw Bitmap), except that the filename is included as an argument of the mnemonic instead of a field following the mnemonic. This makes it unnecessary to add a trailing "@00@" to the printername.
<pre>
Valid format code are:

BMR.FIT.TO.RECT Stretch (or shrink) bitmap to fit rectangle.

Cannot be used with any other codes or

BMR.CENTER.HZ.RECT Center the bitmap horizontally in rectangle
BMR.CENTER.VT.RECT Center the bitmap vertically in rectangle
BMR.SCALE Multiply dimensions by scaling factors below
</pre>
When scaling, values contained in ScaleX and ScaleY are converted to floating point, divided by 100, and then multiplied by their respective axis to providing scaling by as little as 1 percent.
Scaling example:
<pre>
To double only the horizontal size of a bitmap:

ScaleX = 200 ! * 2
ScaleY = 100 ! * 1

To halve a bitmap
ScaleX = 50 ! * .5
ScaleY = 50 ! * .5

To convert bitmap pixels to .01 inch:
ScaleX = 1440 ! * 14.40 (TWIPS/inch)
ScaleY = 1440 ! * 14.40 (TWIPS/inch)
</pre>
History: This mnemonic is valid in Comet98 and greater.

==(Draw Text)==

'''Mnemonic''': (Draw Text=left, top, right, bottom, flags); printable-text

'''Discussion''': Prints the specified printable-text into the rectangle specified by the coordinates left, top, right, bottom using the format codes specified in flags. 
Call this member function to format text in the given rectangle. It formats text by expanding tabs into appropriate spaces, aligning text to the left, right, or center of the given rectangle, and breaking text into lines that fit within the given rectangle, and breaking text into lines that fit within the given rectangle. The type of formatting is specified by flags.

The formatting codes can be combined and are specified in flags.
{| border="1"
|DT.TOP
|Specifies top-justified text (single line only).
|-
|DT.LEFT
|Aligns text flush-left.
|-
|DT.CENTER
|Centers text horizontally.
|-
|DT.RIGHT
|Aligns text flush-right.
|-
|DT.VCENTER
|Specifies vertically centered text (single line only).
|-
|DT.BOTTOM
|Specifies bottom-justified text. This value must be combined with DT.SINGLELINE.
|-
|DT.WORDBREAK
|Specifies word-breaking. Lines are automatically broken between words if a word would extend past the edge of the rectangle specified by left, top, right, bottom. A carriage return-linefeed sequence will also break the line.
|-
|DT.SINGLELINE
|Specifies single line only. Carriage returns and linefeeds do not break the line.
|-
|DT.EXPANDTABS
|Expands tab characters. The default number of characters per tab is eight.
|-
|DT.TABSTOP
|Sets tab stops. The high-order byte of PtrFlags is the number of characters for each tab. The default number of characters per tab is eight.
|-
|DT.NOCLIP
|Draws without clipping. DrawText is somewhat faster when DT.NOCLIP is used.
|-
|DT.EXTERNALLEADING
|Includes the font's external leading in the line height. Normally, external leading is not included in the height of a line of text.
|-
|DT.CALCRECT
|Returns the height of the formatted text, but does not draw the text.
|-
|DT.NOPREFIX
|Turns off processing of prefix characters. Normally, DrawText interprets the ampersand (&) mnemonic-prefix character as a directive to underscore the character that follows, and the two-ampersand (&&) mnemonic- prefix characters as a directive to print a single ampersand. By specifying DT.NOPREFIX, this processing is turned off.
|-
|DT.INTERNAL
|Uses the system font to calculate text metrics.
|-
|DT.EDITCONTROL
|Duplicates the text-displaying characteristics of a multiline edit control. Specifically, the average character width is calculated in the same manner as for an edit control, and the function does not display a partially visible last line.
|-
|DT.PATH.ELLIPSIS
|See DT.END.ELLIPSIS Below
|-
|DT.END.ELLIPSIS
|Replaces part of the given string with ellipses, if necessary, so that the result fits in the specified rectangle. The given string is not modified unless the DT.MODIFYSTRING flag is specified.
You can specify DT.END.ELLIPSIS to replace characters at the end of the string, or DT.PATH.ELLIPSIS to replace characters in the middle of the string. If the string contains backslash (\) characters,
|-
|DT.PATH.ELLIPSIS
|preserves as much as possible of the text after the last backslash.
|-
|DT.MODIFYSTRING
|Modifies the given string to match the displayed text. This flag has no effect unless the
|-
|DT_END_ELLIPSIS or DT_PATH_ELLIPSIS
|flag is specified.
|-
|DT.RTLREADING
|Layout in right to left reading order for bi-directional text when the font selected into the hdc is a Hebrew or Arabic font. The default reading order for all text is left to right.
|-
|DT.WORD.ELLIPSIS
|Truncates text that does not fit in the rectangle and adds ellipses.
|}

NOTE: The values DT.CALCRECT, DT.EXTERNALLEADING, DT.INTERNAL, DT.NOCLIP, and DT.NOPREFIX cannot be used with the DT.TABSTOP value.

History: This mnemonic is valid in Comet98 and greater.

Mnemonics "D"

2009-09-04T21:20:52Z

SteveA: /* (Draw Text) */

==(DE)==
'''Mnemonic''': (DE) Hex equivalent: "@0404@"

'''Discussion''': Default characters per line.
This control code sets the default number of characters per line. The default value is established in the terminal setup, the terminal emulator setup, or the console setup, depending on the type of device being used.

Also see (Screen), (CPL132), (CPL64), and (CPL80).
<pre>
Example:
a. 100 FORMAT (DE)
.
PRINT (0,100)

b. PRINT (0) (DE)
</pre>

==(Delete Window)==
'''Mnemonic''': (Delete Window) Hex equivalent: "@0E0D01@"

'''Discussion''': This mnemonic deletes a Comet window. If multiple windows have been created, this mnemonic deletes the most recently displayed window. 
When a window is deleted, the memory it used is returned to the amount of available window memory. To determine how much window memory remains, perform a numeric input immediately following the deletion of a window. See the window memory page for more information. If you do not need to know how much window memory remains, perform a null INPUT immediately after printing the (Delete Window) mnemonic.

Also see the discussion on Comet windows.
<pre>
Example:
a. 100 FORMAT (Delete Window)
.
PRINT (0,100)
INPUT (0) ""

b. PRINT (0) (Delete Window)
INPUT (0) ""
</pre>

==(DeleteWindowEx)==
'''Mnemonic''': (DeleteWindowEx=handle$)

'''Discussion''': This mnemonic deletes an extended window.
Each extended window is identified by a 4-byte string known as a window handle. The handle value is assigned by the system and returned to the Internet Basic program via an INPUT statement following the (CreateWindowEx).

See the WinDemo.ibs program (available at www.signature.net/download/demos) for examples of extended windows.

Also see (SelectWindowEx).

History: This feature is supported in Comet2002 Build 306 and higher.
Example: The following example creates two extended windows, then uses the (DeleteWindowEx) mnemonic to delete them.
<pre>
Length 4 & Local Handle1$,Handle2$
.
Print (CreateWindowEx=0,0,35,15,68,0,"Window 1")
Input Handle1$

Print (CreateWindowEx=0,40,20,10,68,0,"Window 2")
Input Handle2$
.
.
.
Print (DeleteWindowEx=Handle1$) ! delete window 1
Print (DeleteWindowEx=Handle2$) ! delete window 2
</pre>

==(Document)==
'''Mnemonic''': (Document=string-argument, string argument)

'''Discussion''': The (Document) mnemonic specifies a file name and Comet directory to be used for pdf, html, or txt print files. You may issue the mnemonic several times to produce multiple uniquely-named copies of the output file. Because a qdir entry will not be created for this file, you may use long filenames. CosP uses CometLib to make the document copies. Thus, a COM license is required to use this mnemonic.
The first string-argument is a string constant or variable containing the file name. If the name does not contain an extension, the appropriate one (.pdf, .html, or .txt) will be added depending on the type of printer being used. The second string-argument is the 3-character name of the CFAM directory where the file will be created.

If the second argument is an empty string, it is assumed that the first argument is a fully qualified windows path to the output file. This may point to a CFAM or non CFAM controlled directory. This path may not contain a directory alias. If a directory alias is required, use the (GetDirAlias) mnemonic to build the path.

Note: Do not confuse the (Document) mnemonic's use with that of (SpoolMessage). They serve two different purposes and may both be used on the same document. While the (Document) mnemonic is used to copy the document to any CFAM directory or windows path, the (SpoolMessage) mnemonic is used to name the document stored in a configured Archive.

The (Document) mnemonic is not available for CometAnywhere Clients.
<pre>
Example:
OPEN(1) "LPH"
PRINT(1) (DOCUMENT="Sales Report","RPT")
PRINT(1) (DOCUMENT="\\MyServer\archive\Sales Report 05-14-08.htm","")
</pre>

==(Domain)==
'''Email Mnemonic''': (Domain=string-argument)

'''Discussion''': The (Domain) mnemonic may be used to specify a domain name for the the smtp server for your email printer. If not specified, the email printer will supply the same domain as designated in the (Server=) mnemonic.
<pre>
Example:
OPEN (1) "LEH"
PRINT (1) (Server="smtp.our.mail.server.net 25")
PRINT (1) (Domain="our.mail.server.net")
</pre>

==(Draw Bit Map)==
'''Mnemonic''': (Draw Bit Map=left, top, right, bottom, scaleX, scaleY, flags); filename

'''Discussion''': This mnemonic draws the bitmap contained in the file (.BMP/.JPG) specified in filename in the rectangle specified by left, top, right, bottom using the format codes contained in flags. Scaling factors can be specified in scaleX, scaleY.
Valid format code are:
<pre>
BMR.FIT.TO.RECT Stretch (or shrink) bitmap to fit rectangle.

Cannot be used with any other codes or

BMR.CENTER.HZ.RECT Center the bitmap horizontally in rectangle
BMR.CENTER.VT.RECT Center the bitmap vertically in rectangle
BMR.SCALE Multiply dimensions by scaling factors below

When scaling, values contained in ScaleX and ScaleY are converted to floating point, divided by 100, and then multiplied by their respective axis to providing scaling by as little as 1 percent.
Scaling example:

To double only the horizontal size of a bitmap:

ScaleX = 200 ! * 2
ScaleY = 100 ! * 1

To halve a bitmap
ScaleX = 50 ! * .5
ScaleY = 50 ! * .5

To convert bitmap pixels to .01 inch:
ScaleX = 1440 ! * 14.40 (TWIPS/inch)
ScaleY = 1440 ! * 14.40 (TWIPS/inch)
</pre>
See (Draw Image).
History: This mnemonic is valid in Comet98 and greater.

==(Draw box)==

'''Mnemonic''': (Draw box=a,b,c,d) 
where: 
'''a''' = upper left column (decimal) 
'''b''' = upper left row (decimal) 
'''c''' = lower right column (decimal) 
'''d''' = lower right row (decimal)

Hex equivalent: -- 
'''Discussion''': This mnemonic draws a graphical box using the specified screen coordinates (decimal values).
Note: The box overwrites any text displayed on the screen within the specified coordinates (i.e., this is not a "window").

Also see the discussion on Comet windows.
<pre>
Example:
a. 100 FORMAT (Draw box=2,3,5,10)
.
PRINT (0,100

b. PRINT (0) (Draw box=2,3,5,10)
</pre>

==(Draw Image)==
'''Mnemonic''': (Draw Image=left, top, right, bottom, scaleX, scaleY, flags, filename)

'''Discussion''': This mnemonic draws the bitmap contained in the file (.BMP/.JPG) specified in filename in the rectangle specified by left, top, right, bottom using the format codes contained in flags. Scaling factors can be specified in scaleX, scaleY.
(Draw Image) performs the same function as (Draw Bitmap), except that the filename is included as an argument of the mnemonic instead of a field following the mnemonic. This makes it unnecessary to add a trailing "@00@" to the printername.
<pre>
Valid format code are:

BMR.FIT.TO.RECT Stretch (or shrink) bitmap to fit rectangle.

Cannot be used with any other codes or

BMR.CENTER.HZ.RECT Center the bitmap horizontally in rectangle
BMR.CENTER.VT.RECT Center the bitmap vertically in rectangle
BMR.SCALE Multiply dimensions by scaling factors below
</pre>
When scaling, values contained in ScaleX and ScaleY are converted to floating point, divided by 100, and then multiplied by their respective axis to providing scaling by as little as 1 percent.
Scaling example:
<pre>
To double only the horizontal size of a bitmap:

ScaleX = 200 ! * 2
ScaleY = 100 ! * 1

To halve a bitmap
ScaleX = 50 ! * .5
ScaleY = 50 ! * .5

To convert bitmap pixels to .01 inch:
ScaleX = 1440 ! * 14.40 (TWIPS/inch)
ScaleY = 1440 ! * 14.40 (TWIPS/inch)
</pre>
History: This mnemonic is valid in Comet98 and greater.

==(Draw Text)==

'''Mnemonic''': (Draw Text=left, top, right, bottom, flags); printable-text

'''Discussion''': Prints the specified printable-text into the rectangle specified by the coordinates left, top, right, bottom using the format codes specified in flags. 
Call this member function to format text in the given rectangle. It formats text by expanding tabs into appropriate spaces, aligning text to the left, right, or center of the given rectangle, and breaking text into lines that fit within the given rectangle, and breaking text into lines that fit within the given rectangle. The type of formatting is specified by flags.

The formatting codes can be combined and are specified in flags.
<pre>
DT.TOP Specifies top-justified text (single line only).
DT.LEFT Aligns text flush-left.
DT.CENTER Centers text horizontally.
DT.RIGHT Aligns text flush-right.
DT.VCENTER Specifies vertically centered text (single line only).
DT.BOTTOM Specifies bottom-justified text. This value must be combined with DT.SINGLELINE.
DT.WORDBREAK Specifies word-breaking. Lines are automatically broken between words if a word would extend past the edge of the rectangle specified by left, top, right, bottom. A carriage return-linefeed sequence will also break the line.
DT.SINGLELINE Specifies single line only. Carriage returns and linefeeds do not break the line.
DT.EXPANDTABS Expands tab characters. The default number of characters per tab is eight.
DT.TABSTOP Sets tab stops. The high-order byte of PtrFlags is the number of characters for each tab. The default number of characters per tab is eight.
DT.NOCLIP Draws without clipping. DrawText is somewhat faster when DT.NOCLIP is used.
DT.EXTERNALLEADING Includes the font's external leading in the line height. Normally, external leading is not included in the height of a line of text.
DT.CALCRECT Returns the height of the formatted text, but does not draw the text.
DT.NOPREFIX Turns off processing of prefix characters. Normally, DrawText interprets the ampersand (&) mnemonic-prefix character as a directive to underscore the character that follows, and the two-ampersand (&&) mnemonic- prefix characters as a directive to print a single ampersand. By specifying DT.NOPREFIX, this processing is turned off.
DT.INTERNAL Uses the system font to calculate text metrics.
DT.EDITCONTROL Duplicates the text-displaying characteristics of a multiline edit control. Specifically, the average character width is calculated in the same manner as for an edit control, and the function does not display a partially visible last line.
DT.PATH.ELLIPSIS See DT.END.ELLIPSIS Below
DT.END.ELLIPSIS Replaces part of the given string with ellipses, if necessary, so that the result fits in the specified rectangle. The given string is not modified unless the DT.MODIFYSTRING flag is specified.
You can specify DT.END.ELLIPSIS to replace characters at the end of the string, or DT.PATH.ELLIPSIS to replace characters in the middle of the string. If the string contains backslash (\) characters, DT.PATH.ELLIPSIS preserves as much as possible of the text after the last backslash.

DT.MODIFYSTRING Modifies the given string to match the displayed text. This flag has no effect unless the DT_END_ELLIPSIS or DT_PATH_ELLIPSIS flag is specified.
DT.RTLREADING Layout in right to left reading order for bi-directional text when the font selected into the hdc is a Hebrew or Arabic font. The default reading order for all text is left to right.
DT.WORD.ELLIPSIS Truncates text that does not fit in the rectangle and adds ellipses.
</pre>

NOTE: The values DT.CALCRECT, DT.EXTERNALLEADING, DT.INTERNAL, DT.NOCLIP, and DT.NOPREFIX cannot be used with the DT.TABSTOP value.

History: This mnemonic is valid in Comet98 and greater.

Mnemonics "D"

2009-09-04T21:19:08Z

SteveA: /* (Draw Image) */

==(DE)==
'''Mnemonic''': (DE) Hex equivalent: "@0404@"

'''Discussion''': Default characters per line.
This control code sets the default number of characters per line. The default value is established in the terminal setup, the terminal emulator setup, or the console setup, depending on the type of device being used.

Also see (Screen), (CPL132), (CPL64), and (CPL80).
<pre>
Example:
a. 100 FORMAT (DE)
.
PRINT (0,100)

b. PRINT (0) (DE)
</pre>

==(Delete Window)==
'''Mnemonic''': (Delete Window) Hex equivalent: "@0E0D01@"

'''Discussion''': This mnemonic deletes a Comet window. If multiple windows have been created, this mnemonic deletes the most recently displayed window. 
When a window is deleted, the memory it used is returned to the amount of available window memory. To determine how much window memory remains, perform a numeric input immediately following the deletion of a window. See the window memory page for more information. If you do not need to know how much window memory remains, perform a null INPUT immediately after printing the (Delete Window) mnemonic.

Also see the discussion on Comet windows.
<pre>
Example:
a. 100 FORMAT (Delete Window)
.
PRINT (0,100)
INPUT (0) ""

b. PRINT (0) (Delete Window)
INPUT (0) ""
</pre>

==(DeleteWindowEx)==
'''Mnemonic''': (DeleteWindowEx=handle$)

'''Discussion''': This mnemonic deletes an extended window.
Each extended window is identified by a 4-byte string known as a window handle. The handle value is assigned by the system and returned to the Internet Basic program via an INPUT statement following the (CreateWindowEx).

See the WinDemo.ibs program (available at www.signature.net/download/demos) for examples of extended windows.

Also see (SelectWindowEx).

History: This feature is supported in Comet2002 Build 306 and higher.
Example: The following example creates two extended windows, then uses the (DeleteWindowEx) mnemonic to delete them.
<pre>
Length 4 & Local Handle1$,Handle2$
.
Print (CreateWindowEx=0,0,35,15,68,0,"Window 1")
Input Handle1$

Print (CreateWindowEx=0,40,20,10,68,0,"Window 2")
Input Handle2$
.
.
.
Print (DeleteWindowEx=Handle1$) ! delete window 1
Print (DeleteWindowEx=Handle2$) ! delete window 2
</pre>

==(Document)==
'''Mnemonic''': (Document=string-argument, string argument)

'''Discussion''': The (Document) mnemonic specifies a file name and Comet directory to be used for pdf, html, or txt print files. You may issue the mnemonic several times to produce multiple uniquely-named copies of the output file. Because a qdir entry will not be created for this file, you may use long filenames. CosP uses CometLib to make the document copies. Thus, a COM license is required to use this mnemonic.
The first string-argument is a string constant or variable containing the file name. If the name does not contain an extension, the appropriate one (.pdf, .html, or .txt) will be added depending on the type of printer being used. The second string-argument is the 3-character name of the CFAM directory where the file will be created.

If the second argument is an empty string, it is assumed that the first argument is a fully qualified windows path to the output file. This may point to a CFAM or non CFAM controlled directory. This path may not contain a directory alias. If a directory alias is required, use the (GetDirAlias) mnemonic to build the path.

Note: Do not confuse the (Document) mnemonic's use with that of (SpoolMessage). They serve two different purposes and may both be used on the same document. While the (Document) mnemonic is used to copy the document to any CFAM directory or windows path, the (SpoolMessage) mnemonic is used to name the document stored in a configured Archive.

The (Document) mnemonic is not available for CometAnywhere Clients.
<pre>
Example:
OPEN(1) "LPH"
PRINT(1) (DOCUMENT="Sales Report","RPT")
PRINT(1) (DOCUMENT="\\MyServer\archive\Sales Report 05-14-08.htm","")
</pre>

==(Domain)==
'''Email Mnemonic''': (Domain=string-argument)

'''Discussion''': The (Domain) mnemonic may be used to specify a domain name for the the smtp server for your email printer. If not specified, the email printer will supply the same domain as designated in the (Server=) mnemonic.
<pre>
Example:
OPEN (1) "LEH"
PRINT (1) (Server="smtp.our.mail.server.net 25")
PRINT (1) (Domain="our.mail.server.net")
</pre>

==(Draw Bit Map)==
'''Mnemonic''': (Draw Bit Map=left, top, right, bottom, scaleX, scaleY, flags); filename

'''Discussion''': This mnemonic draws the bitmap contained in the file (.BMP/.JPG) specified in filename in the rectangle specified by left, top, right, bottom using the format codes contained in flags. Scaling factors can be specified in scaleX, scaleY.
Valid format code are:
<pre>
BMR.FIT.TO.RECT Stretch (or shrink) bitmap to fit rectangle.

Cannot be used with any other codes or

BMR.CENTER.HZ.RECT Center the bitmap horizontally in rectangle
BMR.CENTER.VT.RECT Center the bitmap vertically in rectangle
BMR.SCALE Multiply dimensions by scaling factors below

When scaling, values contained in ScaleX and ScaleY are converted to floating point, divided by 100, and then multiplied by their respective axis to providing scaling by as little as 1 percent.
Scaling example:

To double only the horizontal size of a bitmap:

ScaleX = 200 ! * 2
ScaleY = 100 ! * 1

To halve a bitmap
ScaleX = 50 ! * .5
ScaleY = 50 ! * .5

To convert bitmap pixels to .01 inch:
ScaleX = 1440 ! * 14.40 (TWIPS/inch)
ScaleY = 1440 ! * 14.40 (TWIPS/inch)
</pre>
See (Draw Image).
History: This mnemonic is valid in Comet98 and greater.

==(Draw box)==

'''Mnemonic''': (Draw box=a,b,c,d) 
where: 
'''a''' = upper left column (decimal) 
'''b''' = upper left row (decimal) 
'''c''' = lower right column (decimal) 
'''d''' = lower right row (decimal)

Hex equivalent: -- 
'''Discussion''': This mnemonic draws a graphical box using the specified screen coordinates (decimal values).
Note: The box overwrites any text displayed on the screen within the specified coordinates (i.e., this is not a "window").

Also see the discussion on Comet windows.
<pre>
Example:
a. 100 FORMAT (Draw box=2,3,5,10)
.
PRINT (0,100

b. PRINT (0) (Draw box=2,3,5,10)
</pre>

==(Draw Image)==
'''Mnemonic''': (Draw Image=left, top, right, bottom, scaleX, scaleY, flags, filename)

'''Discussion''': This mnemonic draws the bitmap contained in the file (.BMP/.JPG) specified in filename in the rectangle specified by left, top, right, bottom using the format codes contained in flags. Scaling factors can be specified in scaleX, scaleY.
(Draw Image) performs the same function as (Draw Bitmap), except that the filename is included as an argument of the mnemonic instead of a field following the mnemonic. This makes it unnecessary to add a trailing "@00@" to the printername.
<pre>
Valid format code are:

BMR.FIT.TO.RECT Stretch (or shrink) bitmap to fit rectangle.

Cannot be used with any other codes or

BMR.CENTER.HZ.RECT Center the bitmap horizontally in rectangle
BMR.CENTER.VT.RECT Center the bitmap vertically in rectangle
BMR.SCALE Multiply dimensions by scaling factors below
</pre>
When scaling, values contained in ScaleX and ScaleY are converted to floating point, divided by 100, and then multiplied by their respective axis to providing scaling by as little as 1 percent.
Scaling example:
<pre>
To double only the horizontal size of a bitmap:

ScaleX = 200 ! * 2
ScaleY = 100 ! * 1

To halve a bitmap
ScaleX = 50 ! * .5
ScaleY = 50 ! * .5

To convert bitmap pixels to .01 inch:
ScaleX = 1440 ! * 14.40 (TWIPS/inch)
ScaleY = 1440 ! * 14.40 (TWIPS/inch)
</pre>
History: This mnemonic is valid in Comet98 and greater.

== (Draw Text) ==

Mnemonic: (Draw Text=left, top, right, bottom, flags); printable-text
Discussion: Prints the specified printable-text into the rectangle specified by the coordinates left, top, right, bottom using the format codes specified in flags.
Call this member function to format text in the given rectangle. It formats text by expanding tabs into appropriate spaces, aligning text to the left, right, or center of the given rectangle, and breaking text into lines that fit within the given rectangle, and breaking text into lines that fit within the given rectangle. The type of formatting is specified by flags.

The formatting codes can be combined and are specified in flags.

DT.TOP Specifies top-justified text (single line only).
DT.LEFT Aligns text flush-left.
DT.CENTER Centers text horizontally.
DT.RIGHT Aligns text flush-right.
DT.VCENTER Specifies vertically centered text (single line only).
DT.BOTTOM Specifies bottom-justified text. This value must be combined with DT.SINGLELINE.
DT.WORDBREAK Specifies word-breaking. Lines are automatically broken between words if a word would extend past the edge of the rectangle specified by left, top, right, bottom. A carriage return-linefeed sequence will also break the line.
DT.SINGLELINE Specifies single line only. Carriage returns and linefeeds do not break the line.
DT.EXPANDTABS Expands tab characters. The default number of characters per tab is eight.
DT.TABSTOP Sets tab stops. The high-order byte of PtrFlags is the number of characters for each tab. The default number of characters per tab is eight.
DT.NOCLIP Draws without clipping. DrawText is somewhat faster when DT.NOCLIP is used.
DT.EXTERNALLEADING Includes the font's external leading in the line height. Normally, external leading is not included in the height of a line of text.
DT.CALCRECT Returns the height of the formatted text, but does not draw the text.
DT.NOPREFIX Turns off processing of prefix characters. Normally, DrawText interprets the ampersand (&) mnemonic-prefix character as a directive to underscore the character that follows, and the two-ampersand (&&) mnemonic- prefix characters as a directive to print a single ampersand. By specifying DT.NOPREFIX, this processing is turned off.
DT.INTERNAL Uses the system font to calculate text metrics.
DT.EDITCONTROL Duplicates the text-displaying characteristics of a multiline edit control. Specifically, the average character width is calculated in the same manner as for an edit control, and the function does not display a partially visible last line.
DT.PATH.ELLIPSIS See DT.END.ELLIPSIS Below
DT.END.ELLIPSIS Replaces part of the given string with ellipses, if necessary, so that the result fits in the specified rectangle. The given string is not modified unless the DT.MODIFYSTRING flag is specified.
You can specify DT.END.ELLIPSIS to replace characters at the end of the string, or DT.PATH.ELLIPSIS to replace characters in the middle of the string. If the string contains backslash (\) characters, DT.PATH.ELLIPSIS preserves as much as possible of the text after the last backslash.

DT.MODIFYSTRING Modifies the given string to match the displayed text. This flag has no effect unless the DT_END_ELLIPSIS or DT_PATH_ELLIPSIS flag is specified.
DT.RTLREADING Layout in right to left reading order for bi-directional text when the font selected into the hdc is a Hebrew or Arabic font. The default reading order for all text is left to right.
DT.WORD.ELLIPSIS Truncates text that does not fit in the rectangle and adds ellipses.

NOTE: The values DT.CALCRECT, DT.EXTERNALLEADING, DT.INTERNAL, DT.NOCLIP, and DT.NOPREFIX cannot be used with the DT.TABSTOP value.

History: This mnemonic is valid in Comet98 and greater.

Mnemonics "D"

2009-09-04T21:17:31Z

SteveA: /* (Draw box) */

==(DE)==
'''Mnemonic''': (DE) Hex equivalent: "@0404@"

'''Discussion''': Default characters per line.
This control code sets the default number of characters per line. The default value is established in the terminal setup, the terminal emulator setup, or the console setup, depending on the type of device being used.

Also see (Screen), (CPL132), (CPL64), and (CPL80).
<pre>
Example:
a. 100 FORMAT (DE)
.
PRINT (0,100)

b. PRINT (0) (DE)
</pre>

==(Delete Window)==
'''Mnemonic''': (Delete Window) Hex equivalent: "@0E0D01@"

'''Discussion''': This mnemonic deletes a Comet window. If multiple windows have been created, this mnemonic deletes the most recently displayed window. 
When a window is deleted, the memory it used is returned to the amount of available window memory. To determine how much window memory remains, perform a numeric input immediately following the deletion of a window. See the window memory page for more information. If you do not need to know how much window memory remains, perform a null INPUT immediately after printing the (Delete Window) mnemonic.

Also see the discussion on Comet windows.
<pre>
Example:
a. 100 FORMAT (Delete Window)
.
PRINT (0,100)
INPUT (0) ""

b. PRINT (0) (Delete Window)
INPUT (0) ""
</pre>

==(DeleteWindowEx)==
'''Mnemonic''': (DeleteWindowEx=handle$)

'''Discussion''': This mnemonic deletes an extended window.
Each extended window is identified by a 4-byte string known as a window handle. The handle value is assigned by the system and returned to the Internet Basic program via an INPUT statement following the (CreateWindowEx).

See the WinDemo.ibs program (available at www.signature.net/download/demos) for examples of extended windows.

Also see (SelectWindowEx).

History: This feature is supported in Comet2002 Build 306 and higher.
Example: The following example creates two extended windows, then uses the (DeleteWindowEx) mnemonic to delete them.
<pre>
Length 4 & Local Handle1$,Handle2$
.
Print (CreateWindowEx=0,0,35,15,68,0,"Window 1")
Input Handle1$

Print (CreateWindowEx=0,40,20,10,68,0,"Window 2")
Input Handle2$
.
.
.
Print (DeleteWindowEx=Handle1$) ! delete window 1
Print (DeleteWindowEx=Handle2$) ! delete window 2
</pre>

==(Document)==
'''Mnemonic''': (Document=string-argument, string argument)

'''Discussion''': The (Document) mnemonic specifies a file name and Comet directory to be used for pdf, html, or txt print files. You may issue the mnemonic several times to produce multiple uniquely-named copies of the output file. Because a qdir entry will not be created for this file, you may use long filenames. CosP uses CometLib to make the document copies. Thus, a COM license is required to use this mnemonic.
The first string-argument is a string constant or variable containing the file name. If the name does not contain an extension, the appropriate one (.pdf, .html, or .txt) will be added depending on the type of printer being used. The second string-argument is the 3-character name of the CFAM directory where the file will be created.

If the second argument is an empty string, it is assumed that the first argument is a fully qualified windows path to the output file. This may point to a CFAM or non CFAM controlled directory. This path may not contain a directory alias. If a directory alias is required, use the (GetDirAlias) mnemonic to build the path.

Note: Do not confuse the (Document) mnemonic's use with that of (SpoolMessage). They serve two different purposes and may both be used on the same document. While the (Document) mnemonic is used to copy the document to any CFAM directory or windows path, the (SpoolMessage) mnemonic is used to name the document stored in a configured Archive.

The (Document) mnemonic is not available for CometAnywhere Clients.
<pre>
Example:
OPEN(1) "LPH"
PRINT(1) (DOCUMENT="Sales Report","RPT")
PRINT(1) (DOCUMENT="\\MyServer\archive\Sales Report 05-14-08.htm","")
</pre>

==(Domain)==
'''Email Mnemonic''': (Domain=string-argument)

'''Discussion''': The (Domain) mnemonic may be used to specify a domain name for the the smtp server for your email printer. If not specified, the email printer will supply the same domain as designated in the (Server=) mnemonic.
<pre>
Example:
OPEN (1) "LEH"
PRINT (1) (Server="smtp.our.mail.server.net 25")
PRINT (1) (Domain="our.mail.server.net")
</pre>

==(Draw Bit Map)==
'''Mnemonic''': (Draw Bit Map=left, top, right, bottom, scaleX, scaleY, flags); filename

'''Discussion''': This mnemonic draws the bitmap contained in the file (.BMP/.JPG) specified in filename in the rectangle specified by left, top, right, bottom using the format codes contained in flags. Scaling factors can be specified in scaleX, scaleY.
Valid format code are:
<pre>
BMR.FIT.TO.RECT Stretch (or shrink) bitmap to fit rectangle.

Cannot be used with any other codes or

BMR.CENTER.HZ.RECT Center the bitmap horizontally in rectangle
BMR.CENTER.VT.RECT Center the bitmap vertically in rectangle
BMR.SCALE Multiply dimensions by scaling factors below

When scaling, values contained in ScaleX and ScaleY are converted to floating point, divided by 100, and then multiplied by their respective axis to providing scaling by as little as 1 percent.
Scaling example:

To double only the horizontal size of a bitmap:

ScaleX = 200 ! * 2
ScaleY = 100 ! * 1

To halve a bitmap
ScaleX = 50 ! * .5
ScaleY = 50 ! * .5

To convert bitmap pixels to .01 inch:
ScaleX = 1440 ! * 14.40 (TWIPS/inch)
ScaleY = 1440 ! * 14.40 (TWIPS/inch)
</pre>
See (Draw Image).
History: This mnemonic is valid in Comet98 and greater.

==(Draw box)==

'''Mnemonic''': (Draw box=a,b,c,d) 
where: 
'''a''' = upper left column (decimal) 
'''b''' = upper left row (decimal) 
'''c''' = lower right column (decimal) 
'''d''' = lower right row (decimal)

Hex equivalent: -- 
'''Discussion''': This mnemonic draws a graphical box using the specified screen coordinates (decimal values).
Note: The box overwrites any text displayed on the screen within the specified coordinates (i.e., this is not a "window").

Also see the discussion on Comet windows.
<pre>
Example:
a. 100 FORMAT (Draw box=2,3,5,10)
.
PRINT (0,100

b. PRINT (0) (Draw box=2,3,5,10)
</pre>

== (Draw Image) ==

Mnemonic: (Draw Image=left, top, right, bottom, scaleX, scaleY, flags, filename)
Discussion: This mnemonic draws the bitmap contained in the file (.BMP/.JPG) specified in filename in the rectangle specified by left, top, right, bottom using the format codes contained in flags. Scaling factors can be specified in scaleX, scaleY.
(Draw Image) performs the same function as (Draw Bitmap), except that the filename is included as an argument of the mnemonic instead of a field following the mnemonic. This makes it unnecessary to add a trailing "@00@" to the printername.

Valid format code are:

BMR.FIT.TO.RECT Stretch (or shrink) bitmap to fit rectangle.

Cannot be used with any other codes or

BMR.CENTER.HZ.RECT Center the bitmap horizontally in rectangle
BMR.CENTER.VT.RECT Center the bitmap vertically in rectangle
BMR.SCALE Multiply dimensions by scaling factors below

When scaling, values contained in ScaleX and ScaleY are converted to floating point, divided by 100, and then multiplied by their respective axis to providing scaling by as little as 1 percent.
Scaling example:

To double only the horizontal size of a bitmap:

ScaleX = 200 ! * 2
ScaleY = 100 ! * 1

To halve a bitmap
ScaleX = 50 ! * .5
ScaleY = 50 ! * .5

To convert bitmap pixels to .01 inch:
ScaleX = 1440 ! * 14.40 (TWIPS/inch)
ScaleY = 1440 ! * 14.40 (TWIPS/inch)

History: This mnemonic is valid in Comet98 and greater.

== (Draw Text) ==

Mnemonic: (Draw Text=left, top, right, bottom, flags); printable-text
Discussion: Prints the specified printable-text into the rectangle specified by the coordinates left, top, right, bottom using the format codes specified in flags.
Call this member function to format text in the given rectangle. It formats text by expanding tabs into appropriate spaces, aligning text to the left, right, or center of the given rectangle, and breaking text into lines that fit within the given rectangle, and breaking text into lines that fit within the given rectangle. The type of formatting is specified by flags.

The formatting codes can be combined and are specified in flags.

DT.TOP Specifies top-justified text (single line only).
DT.LEFT Aligns text flush-left.
DT.CENTER Centers text horizontally.
DT.RIGHT Aligns text flush-right.
DT.VCENTER Specifies vertically centered text (single line only).
DT.BOTTOM Specifies bottom-justified text. This value must be combined with DT.SINGLELINE.
DT.WORDBREAK Specifies word-breaking. Lines are automatically broken between words if a word would extend past the edge of the rectangle specified by left, top, right, bottom. A carriage return-linefeed sequence will also break the line.
DT.SINGLELINE Specifies single line only. Carriage returns and linefeeds do not break the line.
DT.EXPANDTABS Expands tab characters. The default number of characters per tab is eight.
DT.TABSTOP Sets tab stops. The high-order byte of PtrFlags is the number of characters for each tab. The default number of characters per tab is eight.
DT.NOCLIP Draws without clipping. DrawText is somewhat faster when DT.NOCLIP is used.
DT.EXTERNALLEADING Includes the font's external leading in the line height. Normally, external leading is not included in the height of a line of text.
DT.CALCRECT Returns the height of the formatted text, but does not draw the text.
DT.NOPREFIX Turns off processing of prefix characters. Normally, DrawText interprets the ampersand (&) mnemonic-prefix character as a directive to underscore the character that follows, and the two-ampersand (&&) mnemonic- prefix characters as a directive to print a single ampersand. By specifying DT.NOPREFIX, this processing is turned off.
DT.INTERNAL Uses the system font to calculate text metrics.
DT.EDITCONTROL Duplicates the text-displaying characteristics of a multiline edit control. Specifically, the average character width is calculated in the same manner as for an edit control, and the function does not display a partially visible last line.
DT.PATH.ELLIPSIS See DT.END.ELLIPSIS Below
DT.END.ELLIPSIS Replaces part of the given string with ellipses, if necessary, so that the result fits in the specified rectangle. The given string is not modified unless the DT.MODIFYSTRING flag is specified.
You can specify DT.END.ELLIPSIS to replace characters at the end of the string, or DT.PATH.ELLIPSIS to replace characters in the middle of the string. If the string contains backslash (\) characters, DT.PATH.ELLIPSIS preserves as much as possible of the text after the last backslash.

DT.MODIFYSTRING Modifies the given string to match the displayed text. This flag has no effect unless the DT_END_ELLIPSIS or DT_PATH_ELLIPSIS flag is specified.
DT.RTLREADING Layout in right to left reading order for bi-directional text when the font selected into the hdc is a Hebrew or Arabic font. The default reading order for all text is left to right.
DT.WORD.ELLIPSIS Truncates text that does not fit in the rectangle and adds ellipses.

NOTE: The values DT.CALCRECT, DT.EXTERNALLEADING, DT.INTERNAL, DT.NOCLIP, and DT.NOPREFIX cannot be used with the DT.TABSTOP value.

History: This mnemonic is valid in Comet98 and greater.

Mnemonics "D"

2009-09-04T21:15:02Z

SteveA: /* (Draw Bit Map) */

==(DE)==
'''Mnemonic''': (DE) Hex equivalent: "@0404@"

'''Discussion''': Default characters per line.
This control code sets the default number of characters per line. The default value is established in the terminal setup, the terminal emulator setup, or the console setup, depending on the type of device being used.

Also see (Screen), (CPL132), (CPL64), and (CPL80).
<pre>
Example:
a. 100 FORMAT (DE)
.
PRINT (0,100)

b. PRINT (0) (DE)
</pre>

==(Delete Window)==
'''Mnemonic''': (Delete Window) Hex equivalent: "@0E0D01@"

'''Discussion''': This mnemonic deletes a Comet window. If multiple windows have been created, this mnemonic deletes the most recently displayed window. 
When a window is deleted, the memory it used is returned to the amount of available window memory. To determine how much window memory remains, perform a numeric input immediately following the deletion of a window. See the window memory page for more information. If you do not need to know how much window memory remains, perform a null INPUT immediately after printing the (Delete Window) mnemonic.

Also see the discussion on Comet windows.
<pre>
Example:
a. 100 FORMAT (Delete Window)
.
PRINT (0,100)
INPUT (0) ""

b. PRINT (0) (Delete Window)
INPUT (0) ""
</pre>

==(DeleteWindowEx)==
'''Mnemonic''': (DeleteWindowEx=handle$)

'''Discussion''': This mnemonic deletes an extended window.
Each extended window is identified by a 4-byte string known as a window handle. The handle value is assigned by the system and returned to the Internet Basic program via an INPUT statement following the (CreateWindowEx).

See the WinDemo.ibs program (available at www.signature.net/download/demos) for examples of extended windows.

Also see (SelectWindowEx).

History: This feature is supported in Comet2002 Build 306 and higher.
Example: The following example creates two extended windows, then uses the (DeleteWindowEx) mnemonic to delete them.
<pre>
Length 4 & Local Handle1$,Handle2$
.
Print (CreateWindowEx=0,0,35,15,68,0,"Window 1")
Input Handle1$

Print (CreateWindowEx=0,40,20,10,68,0,"Window 2")
Input Handle2$
.
.
.
Print (DeleteWindowEx=Handle1$) ! delete window 1
Print (DeleteWindowEx=Handle2$) ! delete window 2
</pre>

==(Document)==
'''Mnemonic''': (Document=string-argument, string argument)

'''Discussion''': The (Document) mnemonic specifies a file name and Comet directory to be used for pdf, html, or txt print files. You may issue the mnemonic several times to produce multiple uniquely-named copies of the output file. Because a qdir entry will not be created for this file, you may use long filenames. CosP uses CometLib to make the document copies. Thus, a COM license is required to use this mnemonic.
The first string-argument is a string constant or variable containing the file name. If the name does not contain an extension, the appropriate one (.pdf, .html, or .txt) will be added depending on the type of printer being used. The second string-argument is the 3-character name of the CFAM directory where the file will be created.

If the second argument is an empty string, it is assumed that the first argument is a fully qualified windows path to the output file. This may point to a CFAM or non CFAM controlled directory. This path may not contain a directory alias. If a directory alias is required, use the (GetDirAlias) mnemonic to build the path.

Note: Do not confuse the (Document) mnemonic's use with that of (SpoolMessage). They serve two different purposes and may both be used on the same document. While the (Document) mnemonic is used to copy the document to any CFAM directory or windows path, the (SpoolMessage) mnemonic is used to name the document stored in a configured Archive.

The (Document) mnemonic is not available for CometAnywhere Clients.
<pre>
Example:
OPEN(1) "LPH"
PRINT(1) (DOCUMENT="Sales Report","RPT")
PRINT(1) (DOCUMENT="\\MyServer\archive\Sales Report 05-14-08.htm","")
</pre>

==(Domain)==
'''Email Mnemonic''': (Domain=string-argument)

'''Discussion''': The (Domain) mnemonic may be used to specify a domain name for the the smtp server for your email printer. If not specified, the email printer will supply the same domain as designated in the (Server=) mnemonic.
<pre>
Example:
OPEN (1) "LEH"
PRINT (1) (Server="smtp.our.mail.server.net 25")
PRINT (1) (Domain="our.mail.server.net")
</pre>

==(Draw Bit Map)==
'''Mnemonic''': (Draw Bit Map=left, top, right, bottom, scaleX, scaleY, flags); filename

'''Discussion''': This mnemonic draws the bitmap contained in the file (.BMP/.JPG) specified in filename in the rectangle specified by left, top, right, bottom using the format codes contained in flags. Scaling factors can be specified in scaleX, scaleY.
Valid format code are:
<pre>
BMR.FIT.TO.RECT Stretch (or shrink) bitmap to fit rectangle.

Cannot be used with any other codes or

BMR.CENTER.HZ.RECT Center the bitmap horizontally in rectangle
BMR.CENTER.VT.RECT Center the bitmap vertically in rectangle
BMR.SCALE Multiply dimensions by scaling factors below

When scaling, values contained in ScaleX and ScaleY are converted to floating point, divided by 100, and then multiplied by their respective axis to providing scaling by as little as 1 percent.
Scaling example:

To double only the horizontal size of a bitmap:

ScaleX = 200 ! * 2
ScaleY = 100 ! * 1

To halve a bitmap
ScaleX = 50 ! * .5
ScaleY = 50 ! * .5

To convert bitmap pixels to .01 inch:
ScaleX = 1440 ! * 14.40 (TWIPS/inch)
ScaleY = 1440 ! * 14.40 (TWIPS/inch)
</pre>
See (Draw Image).
History: This mnemonic is valid in Comet98 and greater.

== (Draw box) ==

Mnemonic: (Draw box=a,b,c,d)
where:
a = upper left column (decimal)
b = upper left row (decimal)
c = lower right column (decimal)
d = lower right row (decimal)

Hex equivalent: --
Discussion: This mnemonic draws a graphical box using the specified screen coordinates (decimal values).
Note: The box overwrites any text displayed on the screen within the specified coordinates (i.e., this is not a "window").

Also see the discussion on Comet windows.

Example: a. 100 FORMAT (Draw box=2,3,5,10)
.
PRINT (0,100

b. PRINT (0) (Draw box=2,3,5,10)

== (Draw Image) ==

Mnemonic: (Draw Image=left, top, right, bottom, scaleX, scaleY, flags, filename)
Discussion: This mnemonic draws the bitmap contained in the file (.BMP/.JPG) specified in filename in the rectangle specified by left, top, right, bottom using the format codes contained in flags. Scaling factors can be specified in scaleX, scaleY.
(Draw Image) performs the same function as (Draw Bitmap), except that the filename is included as an argument of the mnemonic instead of a field following the mnemonic. This makes it unnecessary to add a trailing "@00@" to the printername.

Valid format code are:

BMR.FIT.TO.RECT Stretch (or shrink) bitmap to fit rectangle.

Cannot be used with any other codes or

BMR.CENTER.HZ.RECT Center the bitmap horizontally in rectangle
BMR.CENTER.VT.RECT Center the bitmap vertically in rectangle
BMR.SCALE Multiply dimensions by scaling factors below

When scaling, values contained in ScaleX and ScaleY are converted to floating point, divided by 100, and then multiplied by their respective axis to providing scaling by as little as 1 percent.
Scaling example:

To double only the horizontal size of a bitmap:

ScaleX = 200 ! * 2
ScaleY = 100 ! * 1

To halve a bitmap
ScaleX = 50 ! * .5
ScaleY = 50 ! * .5

To convert bitmap pixels to .01 inch:
ScaleX = 1440 ! * 14.40 (TWIPS/inch)
ScaleY = 1440 ! * 14.40 (TWIPS/inch)

History: This mnemonic is valid in Comet98 and greater.

== (Draw Text) ==

Mnemonic: (Draw Text=left, top, right, bottom, flags); printable-text
Discussion: Prints the specified printable-text into the rectangle specified by the coordinates left, top, right, bottom using the format codes specified in flags.
Call this member function to format text in the given rectangle. It formats text by expanding tabs into appropriate spaces, aligning text to the left, right, or center of the given rectangle, and breaking text into lines that fit within the given rectangle, and breaking text into lines that fit within the given rectangle. The type of formatting is specified by flags.

The formatting codes can be combined and are specified in flags.

DT.TOP Specifies top-justified text (single line only).
DT.LEFT Aligns text flush-left.
DT.CENTER Centers text horizontally.
DT.RIGHT Aligns text flush-right.
DT.VCENTER Specifies vertically centered text (single line only).
DT.BOTTOM Specifies bottom-justified text. This value must be combined with DT.SINGLELINE.
DT.WORDBREAK Specifies word-breaking. Lines are automatically broken between words if a word would extend past the edge of the rectangle specified by left, top, right, bottom. A carriage return-linefeed sequence will also break the line.
DT.SINGLELINE Specifies single line only. Carriage returns and linefeeds do not break the line.
DT.EXPANDTABS Expands tab characters. The default number of characters per tab is eight.
DT.TABSTOP Sets tab stops. The high-order byte of PtrFlags is the number of characters for each tab. The default number of characters per tab is eight.
DT.NOCLIP Draws without clipping. DrawText is somewhat faster when DT.NOCLIP is used.
DT.EXTERNALLEADING Includes the font's external leading in the line height. Normally, external leading is not included in the height of a line of text.
DT.CALCRECT Returns the height of the formatted text, but does not draw the text.
DT.NOPREFIX Turns off processing of prefix characters. Normally, DrawText interprets the ampersand (&) mnemonic-prefix character as a directive to underscore the character that follows, and the two-ampersand (&&) mnemonic- prefix characters as a directive to print a single ampersand. By specifying DT.NOPREFIX, this processing is turned off.
DT.INTERNAL Uses the system font to calculate text metrics.
DT.EDITCONTROL Duplicates the text-displaying characteristics of a multiline edit control. Specifically, the average character width is calculated in the same manner as for an edit control, and the function does not display a partially visible last line.
DT.PATH.ELLIPSIS See DT.END.ELLIPSIS Below
DT.END.ELLIPSIS Replaces part of the given string with ellipses, if necessary, so that the result fits in the specified rectangle. The given string is not modified unless the DT.MODIFYSTRING flag is specified.
You can specify DT.END.ELLIPSIS to replace characters at the end of the string, or DT.PATH.ELLIPSIS to replace characters in the middle of the string. If the string contains backslash (\) characters, DT.PATH.ELLIPSIS preserves as much as possible of the text after the last backslash.

DT.MODIFYSTRING Modifies the given string to match the displayed text. This flag has no effect unless the DT_END_ELLIPSIS or DT_PATH_ELLIPSIS flag is specified.
DT.RTLREADING Layout in right to left reading order for bi-directional text when the font selected into the hdc is a Hebrew or Arabic font. The default reading order for all text is left to right.
DT.WORD.ELLIPSIS Truncates text that does not fit in the rectangle and adds ellipses.

NOTE: The values DT.CALCRECT, DT.EXTERNALLEADING, DT.INTERNAL, DT.NOCLIP, and DT.NOPREFIX cannot be used with the DT.TABSTOP value.

History: This mnemonic is valid in Comet98 and greater.

Mnemonics "D"

2009-09-04T21:14:03Z

SteveA: /* (Draw Bit Map) */

==(DE)==
'''Mnemonic''': (DE) Hex equivalent: "@0404@"

'''Discussion''': Default characters per line.
This control code sets the default number of characters per line. The default value is established in the terminal setup, the terminal emulator setup, or the console setup, depending on the type of device being used.

Also see (Screen), (CPL132), (CPL64), and (CPL80).
<pre>
Example:
a. 100 FORMAT (DE)
.
PRINT (0,100)

b. PRINT (0) (DE)
</pre>

==(Delete Window)==
'''Mnemonic''': (Delete Window) Hex equivalent: "@0E0D01@"

'''Discussion''': This mnemonic deletes a Comet window. If multiple windows have been created, this mnemonic deletes the most recently displayed window. 
When a window is deleted, the memory it used is returned to the amount of available window memory. To determine how much window memory remains, perform a numeric input immediately following the deletion of a window. See the window memory page for more information. If you do not need to know how much window memory remains, perform a null INPUT immediately after printing the (Delete Window) mnemonic.

Also see the discussion on Comet windows.
<pre>
Example:
a. 100 FORMAT (Delete Window)
.
PRINT (0,100)
INPUT (0) ""

b. PRINT (0) (Delete Window)
INPUT (0) ""
</pre>

==(DeleteWindowEx)==
'''Mnemonic''': (DeleteWindowEx=handle$)

'''Discussion''': This mnemonic deletes an extended window.
Each extended window is identified by a 4-byte string known as a window handle. The handle value is assigned by the system and returned to the Internet Basic program via an INPUT statement following the (CreateWindowEx).

See the WinDemo.ibs program (available at www.signature.net/download/demos) for examples of extended windows.

Also see (SelectWindowEx).

History: This feature is supported in Comet2002 Build 306 and higher.
Example: The following example creates two extended windows, then uses the (DeleteWindowEx) mnemonic to delete them.
<pre>
Length 4 & Local Handle1$,Handle2$
.
Print (CreateWindowEx=0,0,35,15,68,0,"Window 1")
Input Handle1$

Print (CreateWindowEx=0,40,20,10,68,0,"Window 2")
Input Handle2$
.
.
.
Print (DeleteWindowEx=Handle1$) ! delete window 1
Print (DeleteWindowEx=Handle2$) ! delete window 2
</pre>

==(Document)==
'''Mnemonic''': (Document=string-argument, string argument)

'''Discussion''': The (Document) mnemonic specifies a file name and Comet directory to be used for pdf, html, or txt print files. You may issue the mnemonic several times to produce multiple uniquely-named copies of the output file. Because a qdir entry will not be created for this file, you may use long filenames. CosP uses CometLib to make the document copies. Thus, a COM license is required to use this mnemonic.
The first string-argument is a string constant or variable containing the file name. If the name does not contain an extension, the appropriate one (.pdf, .html, or .txt) will be added depending on the type of printer being used. The second string-argument is the 3-character name of the CFAM directory where the file will be created.

If the second argument is an empty string, it is assumed that the first argument is a fully qualified windows path to the output file. This may point to a CFAM or non CFAM controlled directory. This path may not contain a directory alias. If a directory alias is required, use the (GetDirAlias) mnemonic to build the path.

Note: Do not confuse the (Document) mnemonic's use with that of (SpoolMessage). They serve two different purposes and may both be used on the same document. While the (Document) mnemonic is used to copy the document to any CFAM directory or windows path, the (SpoolMessage) mnemonic is used to name the document stored in a configured Archive.

The (Document) mnemonic is not available for CometAnywhere Clients.
<pre>
Example:
OPEN(1) "LPH"
PRINT(1) (DOCUMENT="Sales Report","RPT")
PRINT(1) (DOCUMENT="\\MyServer\archive\Sales Report 05-14-08.htm","")
</pre>

==(Domain)==
'''Email Mnemonic''': (Domain=string-argument)

'''Discussion''': The (Domain) mnemonic may be used to specify a domain name for the the smtp server for your email printer. If not specified, the email printer will supply the same domain as designated in the (Server=) mnemonic.
<pre>
Example:
OPEN (1) "LEH"
PRINT (1) (Server="smtp.our.mail.server.net 25")
PRINT (1) (Domain="our.mail.server.net")
</pre>

==(Draw Bit Map)==
'''Mnemonic''': (Draw Bit Map=left, top, right, bottom, scaleX, scaleY, flags); filename

'''Discussion''': This mnemonic draws the bitmap contained in the file (.BMP/.JPG) specified in filename in the rectangle specified by left, top, right, bottom using the format codes contained in flags. Scaling factors can be specified in scaleX, scaleY.
Valid format code are:
<pre>
BMR.FIT.TO.RECT Stretch (or shrink) bitmap to fit rectangle.

Cannot be used with any other codes or

'''BMR.CENTER.HZ.REC'''T Center the bitmap horizontally in rectangle
'''BMR.CENTER.VT.RECT''' Center the bitmap vertically in rectangle
'''BMR.SCALE''' Multiply dimensions by scaling factors below

When scaling, values contained in ScaleX and ScaleY are converted to floating point, divided by 100, and then multiplied by their respective axis to providing scaling by as little as 1 percent.
Scaling example:

To double only the horizontal size of a bitmap:

ScaleX = 200 ! * 2
ScaleY = 100 ! * 1

To halve a bitmap
ScaleX = 50 ! * .5
ScaleY = 50 ! * .5

To convert bitmap pixels to .01 inch:
ScaleX = 1440 ! * 14.40 (TWIPS/inch)
ScaleY = 1440 ! * 14.40 (TWIPS/inch)
</pre>
See (Draw Image).
History: This mnemonic is valid in Comet98 and greater.

== (Draw box) ==

Mnemonic: (Draw box=a,b,c,d)
where:
a = upper left column (decimal)
b = upper left row (decimal)
c = lower right column (decimal)
d = lower right row (decimal)

Hex equivalent: --
Discussion: This mnemonic draws a graphical box using the specified screen coordinates (decimal values).
Note: The box overwrites any text displayed on the screen within the specified coordinates (i.e., this is not a "window").

Also see the discussion on Comet windows.

Example: a. 100 FORMAT (Draw box=2,3,5,10)
.
PRINT (0,100

b. PRINT (0) (Draw box=2,3,5,10)

== (Draw Image) ==

Mnemonic: (Draw Image=left, top, right, bottom, scaleX, scaleY, flags, filename)
Discussion: This mnemonic draws the bitmap contained in the file (.BMP/.JPG) specified in filename in the rectangle specified by left, top, right, bottom using the format codes contained in flags. Scaling factors can be specified in scaleX, scaleY.
(Draw Image) performs the same function as (Draw Bitmap), except that the filename is included as an argument of the mnemonic instead of a field following the mnemonic. This makes it unnecessary to add a trailing "@00@" to the printername.

Valid format code are:

BMR.FIT.TO.RECT Stretch (or shrink) bitmap to fit rectangle.

Cannot be used with any other codes or

BMR.CENTER.HZ.RECT Center the bitmap horizontally in rectangle
BMR.CENTER.VT.RECT Center the bitmap vertically in rectangle
BMR.SCALE Multiply dimensions by scaling factors below

When scaling, values contained in ScaleX and ScaleY are converted to floating point, divided by 100, and then multiplied by their respective axis to providing scaling by as little as 1 percent.
Scaling example:

To double only the horizontal size of a bitmap:

ScaleX = 200 ! * 2
ScaleY = 100 ! * 1

To halve a bitmap
ScaleX = 50 ! * .5
ScaleY = 50 ! * .5

To convert bitmap pixels to .01 inch:
ScaleX = 1440 ! * 14.40 (TWIPS/inch)
ScaleY = 1440 ! * 14.40 (TWIPS/inch)

History: This mnemonic is valid in Comet98 and greater.

== (Draw Text) ==

Mnemonic: (Draw Text=left, top, right, bottom, flags); printable-text
Discussion: Prints the specified printable-text into the rectangle specified by the coordinates left, top, right, bottom using the format codes specified in flags.
Call this member function to format text in the given rectangle. It formats text by expanding tabs into appropriate spaces, aligning text to the left, right, or center of the given rectangle, and breaking text into lines that fit within the given rectangle, and breaking text into lines that fit within the given rectangle. The type of formatting is specified by flags.

The formatting codes can be combined and are specified in flags.

DT.TOP Specifies top-justified text (single line only).
DT.LEFT Aligns text flush-left.
DT.CENTER Centers text horizontally.
DT.RIGHT Aligns text flush-right.
DT.VCENTER Specifies vertically centered text (single line only).
DT.BOTTOM Specifies bottom-justified text. This value must be combined with DT.SINGLELINE.
DT.WORDBREAK Specifies word-breaking. Lines are automatically broken between words if a word would extend past the edge of the rectangle specified by left, top, right, bottom. A carriage return-linefeed sequence will also break the line.
DT.SINGLELINE Specifies single line only. Carriage returns and linefeeds do not break the line.
DT.EXPANDTABS Expands tab characters. The default number of characters per tab is eight.
DT.TABSTOP Sets tab stops. The high-order byte of PtrFlags is the number of characters for each tab. The default number of characters per tab is eight.
DT.NOCLIP Draws without clipping. DrawText is somewhat faster when DT.NOCLIP is used.
DT.EXTERNALLEADING Includes the font's external leading in the line height. Normally, external leading is not included in the height of a line of text.
DT.CALCRECT Returns the height of the formatted text, but does not draw the text.
DT.NOPREFIX Turns off processing of prefix characters. Normally, DrawText interprets the ampersand (&) mnemonic-prefix character as a directive to underscore the character that follows, and the two-ampersand (&&) mnemonic- prefix characters as a directive to print a single ampersand. By specifying DT.NOPREFIX, this processing is turned off.
DT.INTERNAL Uses the system font to calculate text metrics.
DT.EDITCONTROL Duplicates the text-displaying characteristics of a multiline edit control. Specifically, the average character width is calculated in the same manner as for an edit control, and the function does not display a partially visible last line.
DT.PATH.ELLIPSIS See DT.END.ELLIPSIS Below
DT.END.ELLIPSIS Replaces part of the given string with ellipses, if necessary, so that the result fits in the specified rectangle. The given string is not modified unless the DT.MODIFYSTRING flag is specified.
You can specify DT.END.ELLIPSIS to replace characters at the end of the string, or DT.PATH.ELLIPSIS to replace characters in the middle of the string. If the string contains backslash (\) characters, DT.PATH.ELLIPSIS preserves as much as possible of the text after the last backslash.

DT.MODIFYSTRING Modifies the given string to match the displayed text. This flag has no effect unless the DT_END_ELLIPSIS or DT_PATH_ELLIPSIS flag is specified.
DT.RTLREADING Layout in right to left reading order for bi-directional text when the font selected into the hdc is a Hebrew or Arabic font. The default reading order for all text is left to right.
DT.WORD.ELLIPSIS Truncates text that does not fit in the rectangle and adds ellipses.

NOTE: The values DT.CALCRECT, DT.EXTERNALLEADING, DT.INTERNAL, DT.NOCLIP, and DT.NOPREFIX cannot be used with the DT.TABSTOP value.

History: This mnemonic is valid in Comet98 and greater.

Mnemonics "D"

2009-09-04T21:12:49Z

SteveA: /* (Draw Bit Map) */

==(DE)==
'''Mnemonic''': (DE) Hex equivalent: "@0404@"

'''Discussion''': Default characters per line.
This control code sets the default number of characters per line. The default value is established in the terminal setup, the terminal emulator setup, or the console setup, depending on the type of device being used.

Also see (Screen), (CPL132), (CPL64), and (CPL80).
<pre>
Example:
a. 100 FORMAT (DE)
.
PRINT (0,100)

b. PRINT (0) (DE)
</pre>

==(Delete Window)==
'''Mnemonic''': (Delete Window) Hex equivalent: "@0E0D01@"

'''Discussion''': This mnemonic deletes a Comet window. If multiple windows have been created, this mnemonic deletes the most recently displayed window. 
When a window is deleted, the memory it used is returned to the amount of available window memory. To determine how much window memory remains, perform a numeric input immediately following the deletion of a window. See the window memory page for more information. If you do not need to know how much window memory remains, perform a null INPUT immediately after printing the (Delete Window) mnemonic.

Also see the discussion on Comet windows.
<pre>
Example:
a. 100 FORMAT (Delete Window)
.
PRINT (0,100)
INPUT (0) ""

b. PRINT (0) (Delete Window)
INPUT (0) ""
</pre>

==(DeleteWindowEx)==
'''Mnemonic''': (DeleteWindowEx=handle$)

'''Discussion''': This mnemonic deletes an extended window.
Each extended window is identified by a 4-byte string known as a window handle. The handle value is assigned by the system and returned to the Internet Basic program via an INPUT statement following the (CreateWindowEx).

See the WinDemo.ibs program (available at www.signature.net/download/demos) for examples of extended windows.

Also see (SelectWindowEx).

History: This feature is supported in Comet2002 Build 306 and higher.
Example: The following example creates two extended windows, then uses the (DeleteWindowEx) mnemonic to delete them.
<pre>
Length 4 & Local Handle1$,Handle2$
.
Print (CreateWindowEx=0,0,35,15,68,0,"Window 1")
Input Handle1$

Print (CreateWindowEx=0,40,20,10,68,0,"Window 2")
Input Handle2$
.
.
.
Print (DeleteWindowEx=Handle1$) ! delete window 1
Print (DeleteWindowEx=Handle2$) ! delete window 2
</pre>

==(Document)==
'''Mnemonic''': (Document=string-argument, string argument)

'''Discussion''': The (Document) mnemonic specifies a file name and Comet directory to be used for pdf, html, or txt print files. You may issue the mnemonic several times to produce multiple uniquely-named copies of the output file. Because a qdir entry will not be created for this file, you may use long filenames. CosP uses CometLib to make the document copies. Thus, a COM license is required to use this mnemonic.
The first string-argument is a string constant or variable containing the file name. If the name does not contain an extension, the appropriate one (.pdf, .html, or .txt) will be added depending on the type of printer being used. The second string-argument is the 3-character name of the CFAM directory where the file will be created.

If the second argument is an empty string, it is assumed that the first argument is a fully qualified windows path to the output file. This may point to a CFAM or non CFAM controlled directory. This path may not contain a directory alias. If a directory alias is required, use the (GetDirAlias) mnemonic to build the path.

Note: Do not confuse the (Document) mnemonic's use with that of (SpoolMessage). They serve two different purposes and may both be used on the same document. While the (Document) mnemonic is used to copy the document to any CFAM directory or windows path, the (SpoolMessage) mnemonic is used to name the document stored in a configured Archive.

The (Document) mnemonic is not available for CometAnywhere Clients.
<pre>
Example:
OPEN(1) "LPH"
PRINT(1) (DOCUMENT="Sales Report","RPT")
PRINT(1) (DOCUMENT="\\MyServer\archive\Sales Report 05-14-08.htm","")
</pre>

==(Domain)==
'''Email Mnemonic''': (Domain=string-argument)

'''Discussion''': The (Domain) mnemonic may be used to specify a domain name for the the smtp server for your email printer. If not specified, the email printer will supply the same domain as designated in the (Server=) mnemonic.
<pre>
Example:
OPEN (1) "LEH"
PRINT (1) (Server="smtp.our.mail.server.net 25")
PRINT (1) (Domain="our.mail.server.net")
</pre>

==(Draw Bit Map)==
'''Mnemonic''': (Draw Bit Map=left, top, right, bottom, scaleX, scaleY, flags); filename

'''Discussion''': This mnemonic draws the bitmap contained in the file (.BMP/.JPG) specified in filename in the rectangle specified by left, top, right, bottom using the format codes contained in flags. Scaling factors can be specified in scaleX, scaleY.
Valid format code are:

BMR.FIT.TO.RECT Stretch (or shrink) bitmap to fit rectangle.

Cannot be used with any other codes or

BMR.CENTER.HZ.RECT Center the bitmap horizontally in rectangle
BMR.CENTER.VT.RECT Center the bitmap vertically in rectangle
BMR.SCALE Multiply dimensions by scaling factors below

When scaling, values contained in ScaleX and ScaleY are converted to floating point, divided by 100, and then multiplied by their respective axis to providing scaling by as little as 1 percent.
Scaling example:

To double only the horizontal size of a bitmap:

ScaleX = 200 ! * 2
ScaleY = 100 ! * 1

To halve a bitmap
ScaleX = 50 ! * .5
ScaleY = 50 ! * .5

To convert bitmap pixels to .01 inch:
ScaleX = 1440 ! * 14.40 (TWIPS/inch)
ScaleY = 1440 ! * 14.40 (TWIPS/inch)

See (Draw Image).
History: This mnemonic is valid in Comet98 and greater.

== (Draw box) ==

Mnemonic: (Draw box=a,b,c,d)
where:
a = upper left column (decimal)
b = upper left row (decimal)
c = lower right column (decimal)
d = lower right row (decimal)

Hex equivalent: --
Discussion: This mnemonic draws a graphical box using the specified screen coordinates (decimal values).
Note: The box overwrites any text displayed on the screen within the specified coordinates (i.e., this is not a "window").

Also see the discussion on Comet windows.

Example: a. 100 FORMAT (Draw box=2,3,5,10)
.
PRINT (0,100

b. PRINT (0) (Draw box=2,3,5,10)

== (Draw Image) ==

Mnemonic: (Draw Image=left, top, right, bottom, scaleX, scaleY, flags, filename)
Discussion: This mnemonic draws the bitmap contained in the file (.BMP/.JPG) specified in filename in the rectangle specified by left, top, right, bottom using the format codes contained in flags. Scaling factors can be specified in scaleX, scaleY.
(Draw Image) performs the same function as (Draw Bitmap), except that the filename is included as an argument of the mnemonic instead of a field following the mnemonic. This makes it unnecessary to add a trailing "@00@" to the printername.

Valid format code are:

BMR.FIT.TO.RECT Stretch (or shrink) bitmap to fit rectangle.

Cannot be used with any other codes or

BMR.CENTER.HZ.RECT Center the bitmap horizontally in rectangle
BMR.CENTER.VT.RECT Center the bitmap vertically in rectangle
BMR.SCALE Multiply dimensions by scaling factors below

When scaling, values contained in ScaleX and ScaleY are converted to floating point, divided by 100, and then multiplied by their respective axis to providing scaling by as little as 1 percent.
Scaling example:

To double only the horizontal size of a bitmap:

ScaleX = 200 ! * 2
ScaleY = 100 ! * 1

To halve a bitmap
ScaleX = 50 ! * .5
ScaleY = 50 ! * .5

To convert bitmap pixels to .01 inch:
ScaleX = 1440 ! * 14.40 (TWIPS/inch)
ScaleY = 1440 ! * 14.40 (TWIPS/inch)

History: This mnemonic is valid in Comet98 and greater.

== (Draw Text) ==

Mnemonic: (Draw Text=left, top, right, bottom, flags); printable-text
Discussion: Prints the specified printable-text into the rectangle specified by the coordinates left, top, right, bottom using the format codes specified in flags.
Call this member function to format text in the given rectangle. It formats text by expanding tabs into appropriate spaces, aligning text to the left, right, or center of the given rectangle, and breaking text into lines that fit within the given rectangle, and breaking text into lines that fit within the given rectangle. The type of formatting is specified by flags.

The formatting codes can be combined and are specified in flags.

DT.TOP Specifies top-justified text (single line only).
DT.LEFT Aligns text flush-left.
DT.CENTER Centers text horizontally.
DT.RIGHT Aligns text flush-right.
DT.VCENTER Specifies vertically centered text (single line only).
DT.BOTTOM Specifies bottom-justified text. This value must be combined with DT.SINGLELINE.
DT.WORDBREAK Specifies word-breaking. Lines are automatically broken between words if a word would extend past the edge of the rectangle specified by left, top, right, bottom. A carriage return-linefeed sequence will also break the line.
DT.SINGLELINE Specifies single line only. Carriage returns and linefeeds do not break the line.
DT.EXPANDTABS Expands tab characters. The default number of characters per tab is eight.
DT.TABSTOP Sets tab stops. The high-order byte of PtrFlags is the number of characters for each tab. The default number of characters per tab is eight.
DT.NOCLIP Draws without clipping. DrawText is somewhat faster when DT.NOCLIP is used.
DT.EXTERNALLEADING Includes the font's external leading in the line height. Normally, external leading is not included in the height of a line of text.
DT.CALCRECT Returns the height of the formatted text, but does not draw the text.
DT.NOPREFIX Turns off processing of prefix characters. Normally, DrawText interprets the ampersand (&) mnemonic-prefix character as a directive to underscore the character that follows, and the two-ampersand (&&) mnemonic- prefix characters as a directive to print a single ampersand. By specifying DT.NOPREFIX, this processing is turned off.
DT.INTERNAL Uses the system font to calculate text metrics.
DT.EDITCONTROL Duplicates the text-displaying characteristics of a multiline edit control. Specifically, the average character width is calculated in the same manner as for an edit control, and the function does not display a partially visible last line.
DT.PATH.ELLIPSIS See DT.END.ELLIPSIS Below
DT.END.ELLIPSIS Replaces part of the given string with ellipses, if necessary, so that the result fits in the specified rectangle. The given string is not modified unless the DT.MODIFYSTRING flag is specified.
You can specify DT.END.ELLIPSIS to replace characters at the end of the string, or DT.PATH.ELLIPSIS to replace characters in the middle of the string. If the string contains backslash (\) characters, DT.PATH.ELLIPSIS preserves as much as possible of the text after the last backslash.

DT.MODIFYSTRING Modifies the given string to match the displayed text. This flag has no effect unless the DT_END_ELLIPSIS or DT_PATH_ELLIPSIS flag is specified.
DT.RTLREADING Layout in right to left reading order for bi-directional text when the font selected into the hdc is a Hebrew or Arabic font. The default reading order for all text is left to right.
DT.WORD.ELLIPSIS Truncates text that does not fit in the rectangle and adds ellipses.

NOTE: The values DT.CALCRECT, DT.EXTERNALLEADING, DT.INTERNAL, DT.NOCLIP, and DT.NOPREFIX cannot be used with the DT.TABSTOP value.

History: This mnemonic is valid in Comet98 and greater.

Mnemonics "D"

2009-09-04T21:11:41Z

SteveA: /* (Domain) */

==(DE)==
'''Mnemonic''': (DE) Hex equivalent: "@0404@"

'''Discussion''': Default characters per line.
This control code sets the default number of characters per line. The default value is established in the terminal setup, the terminal emulator setup, or the console setup, depending on the type of device being used.

Also see (Screen), (CPL132), (CPL64), and (CPL80).
<pre>
Example:
a. 100 FORMAT (DE)
.
PRINT (0,100)

b. PRINT (0) (DE)
</pre>

==(Delete Window)==
'''Mnemonic''': (Delete Window) Hex equivalent: "@0E0D01@"

'''Discussion''': This mnemonic deletes a Comet window. If multiple windows have been created, this mnemonic deletes the most recently displayed window. 
When a window is deleted, the memory it used is returned to the amount of available window memory. To determine how much window memory remains, perform a numeric input immediately following the deletion of a window. See the window memory page for more information. If you do not need to know how much window memory remains, perform a null INPUT immediately after printing the (Delete Window) mnemonic.

Also see the discussion on Comet windows.
<pre>
Example:
a. 100 FORMAT (Delete Window)
.
PRINT (0,100)
INPUT (0) ""

b. PRINT (0) (Delete Window)
INPUT (0) ""
</pre>

==(DeleteWindowEx)==
'''Mnemonic''': (DeleteWindowEx=handle$)

'''Discussion''': This mnemonic deletes an extended window.
Each extended window is identified by a 4-byte string known as a window handle. The handle value is assigned by the system and returned to the Internet Basic program via an INPUT statement following the (CreateWindowEx).

See the WinDemo.ibs program (available at www.signature.net/download/demos) for examples of extended windows.

Also see (SelectWindowEx).

History: This feature is supported in Comet2002 Build 306 and higher.
Example: The following example creates two extended windows, then uses the (DeleteWindowEx) mnemonic to delete them.
<pre>
Length 4 & Local Handle1$,Handle2$
.
Print (CreateWindowEx=0,0,35,15,68,0,"Window 1")
Input Handle1$

Print (CreateWindowEx=0,40,20,10,68,0,"Window 2")
Input Handle2$
.
.
.
Print (DeleteWindowEx=Handle1$) ! delete window 1
Print (DeleteWindowEx=Handle2$) ! delete window 2
</pre>

==(Document)==
'''Mnemonic''': (Document=string-argument, string argument)

'''Discussion''': The (Document) mnemonic specifies a file name and Comet directory to be used for pdf, html, or txt print files. You may issue the mnemonic several times to produce multiple uniquely-named copies of the output file. Because a qdir entry will not be created for this file, you may use long filenames. CosP uses CometLib to make the document copies. Thus, a COM license is required to use this mnemonic.
The first string-argument is a string constant or variable containing the file name. If the name does not contain an extension, the appropriate one (.pdf, .html, or .txt) will be added depending on the type of printer being used. The second string-argument is the 3-character name of the CFAM directory where the file will be created.

If the second argument is an empty string, it is assumed that the first argument is a fully qualified windows path to the output file. This may point to a CFAM or non CFAM controlled directory. This path may not contain a directory alias. If a directory alias is required, use the (GetDirAlias) mnemonic to build the path.

Note: Do not confuse the (Document) mnemonic's use with that of (SpoolMessage). They serve two different purposes and may both be used on the same document. While the (Document) mnemonic is used to copy the document to any CFAM directory or windows path, the (SpoolMessage) mnemonic is used to name the document stored in a configured Archive.

The (Document) mnemonic is not available for CometAnywhere Clients.
<pre>
Example:
OPEN(1) "LPH"
PRINT(1) (DOCUMENT="Sales Report","RPT")
PRINT(1) (DOCUMENT="\\MyServer\archive\Sales Report 05-14-08.htm","")
</pre>

==(Domain)==
'''Email Mnemonic''': (Domain=string-argument)

'''Discussion''': The (Domain) mnemonic may be used to specify a domain name for the the smtp server for your email printer. If not specified, the email printer will supply the same domain as designated in the (Server=) mnemonic.
<pre>
Example:
OPEN (1) "LEH"
PRINT (1) (Server="smtp.our.mail.server.net 25")
PRINT (1) (Domain="our.mail.server.net")
</pre>

== (Draw Bit Map) ==

Mnemonic: (Draw Bit Map=left, top, right, bottom, scaleX, scaleY, flags); filename
Discussion: This mnemonic draws the bitmap contained in the file (.BMP/.JPG) specified in filename in the rectangle specified by left, top, right, bottom using the format codes contained in flags. Scaling factors can be specified in scaleX, scaleY.
Valid format code are:

BMR.FIT.TO.RECT Stretch (or shrink) bitmap to fit rectangle.

Cannot be used with any other codes or

BMR.CENTER.HZ.RECT Center the bitmap horizontally in rectangle
BMR.CENTER.VT.RECT Center the bitmap vertically in rectangle
BMR.SCALE Multiply dimensions by scaling factors below

When scaling, values contained in ScaleX and ScaleY are converted to floating point, divided by 100, and then multiplied by their respective axis to providing scaling by as little as 1 percent.
Scaling example:

To double only the horizontal size of a bitmap:

ScaleX = 200 ! * 2
ScaleY = 100 ! * 1

To halve a bitmap
ScaleX = 50 ! * .5
ScaleY = 50 ! * .5

To convert bitmap pixels to .01 inch:
ScaleX = 1440 ! * 14.40 (TWIPS/inch)
ScaleY = 1440 ! * 14.40 (TWIPS/inch)

See (Draw Image).
History: This mnemonic is valid in Comet98 and greater.

== (Draw box) ==

Mnemonic: (Draw box=a,b,c,d)
where:
a = upper left column (decimal)
b = upper left row (decimal)
c = lower right column (decimal)
d = lower right row (decimal)

Hex equivalent: --
Discussion: This mnemonic draws a graphical box using the specified screen coordinates (decimal values).
Note: The box overwrites any text displayed on the screen within the specified coordinates (i.e., this is not a "window").

Also see the discussion on Comet windows.

Example: a. 100 FORMAT (Draw box=2,3,5,10)
.
PRINT (0,100

b. PRINT (0) (Draw box=2,3,5,10)

== (Draw Image) ==

Mnemonic: (Draw Image=left, top, right, bottom, scaleX, scaleY, flags, filename)
Discussion: This mnemonic draws the bitmap contained in the file (.BMP/.JPG) specified in filename in the rectangle specified by left, top, right, bottom using the format codes contained in flags. Scaling factors can be specified in scaleX, scaleY.
(Draw Image) performs the same function as (Draw Bitmap), except that the filename is included as an argument of the mnemonic instead of a field following the mnemonic. This makes it unnecessary to add a trailing "@00@" to the printername.

Valid format code are:

BMR.FIT.TO.RECT Stretch (or shrink) bitmap to fit rectangle.

Cannot be used with any other codes or

BMR.CENTER.HZ.RECT Center the bitmap horizontally in rectangle
BMR.CENTER.VT.RECT Center the bitmap vertically in rectangle
BMR.SCALE Multiply dimensions by scaling factors below

When scaling, values contained in ScaleX and ScaleY are converted to floating point, divided by 100, and then multiplied by their respective axis to providing scaling by as little as 1 percent.
Scaling example:

To double only the horizontal size of a bitmap:

ScaleX = 200 ! * 2
ScaleY = 100 ! * 1

To halve a bitmap
ScaleX = 50 ! * .5
ScaleY = 50 ! * .5

To convert bitmap pixels to .01 inch:
ScaleX = 1440 ! * 14.40 (TWIPS/inch)
ScaleY = 1440 ! * 14.40 (TWIPS/inch)

History: This mnemonic is valid in Comet98 and greater.

== (Draw Text) ==

Mnemonic: (Draw Text=left, top, right, bottom, flags); printable-text
Discussion: Prints the specified printable-text into the rectangle specified by the coordinates left, top, right, bottom using the format codes specified in flags.
Call this member function to format text in the given rectangle. It formats text by expanding tabs into appropriate spaces, aligning text to the left, right, or center of the given rectangle, and breaking text into lines that fit within the given rectangle, and breaking text into lines that fit within the given rectangle. The type of formatting is specified by flags.

The formatting codes can be combined and are specified in flags.

DT.TOP Specifies top-justified text (single line only).
DT.LEFT Aligns text flush-left.
DT.CENTER Centers text horizontally.
DT.RIGHT Aligns text flush-right.
DT.VCENTER Specifies vertically centered text (single line only).
DT.BOTTOM Specifies bottom-justified text. This value must be combined with DT.SINGLELINE.
DT.WORDBREAK Specifies word-breaking. Lines are automatically broken between words if a word would extend past the edge of the rectangle specified by left, top, right, bottom. A carriage return-linefeed sequence will also break the line.
DT.SINGLELINE Specifies single line only. Carriage returns and linefeeds do not break the line.
DT.EXPANDTABS Expands tab characters. The default number of characters per tab is eight.
DT.TABSTOP Sets tab stops. The high-order byte of PtrFlags is the number of characters for each tab. The default number of characters per tab is eight.
DT.NOCLIP Draws without clipping. DrawText is somewhat faster when DT.NOCLIP is used.
DT.EXTERNALLEADING Includes the font's external leading in the line height. Normally, external leading is not included in the height of a line of text.
DT.CALCRECT Returns the height of the formatted text, but does not draw the text.
DT.NOPREFIX Turns off processing of prefix characters. Normally, DrawText interprets the ampersand (&) mnemonic-prefix character as a directive to underscore the character that follows, and the two-ampersand (&&) mnemonic- prefix characters as a directive to print a single ampersand. By specifying DT.NOPREFIX, this processing is turned off.
DT.INTERNAL Uses the system font to calculate text metrics.
DT.EDITCONTROL Duplicates the text-displaying characteristics of a multiline edit control. Specifically, the average character width is calculated in the same manner as for an edit control, and the function does not display a partially visible last line.
DT.PATH.ELLIPSIS See DT.END.ELLIPSIS Below
DT.END.ELLIPSIS Replaces part of the given string with ellipses, if necessary, so that the result fits in the specified rectangle. The given string is not modified unless the DT.MODIFYSTRING flag is specified.
You can specify DT.END.ELLIPSIS to replace characters at the end of the string, or DT.PATH.ELLIPSIS to replace characters in the middle of the string. If the string contains backslash (\) characters, DT.PATH.ELLIPSIS preserves as much as possible of the text after the last backslash.

DT.MODIFYSTRING Modifies the given string to match the displayed text. This flag has no effect unless the DT_END_ELLIPSIS or DT_PATH_ELLIPSIS flag is specified.
DT.RTLREADING Layout in right to left reading order for bi-directional text when the font selected into the hdc is a Hebrew or Arabic font. The default reading order for all text is left to right.
DT.WORD.ELLIPSIS Truncates text that does not fit in the rectangle and adds ellipses.

NOTE: The values DT.CALCRECT, DT.EXTERNALLEADING, DT.INTERNAL, DT.NOCLIP, and DT.NOPREFIX cannot be used with the DT.TABSTOP value.

History: This mnemonic is valid in Comet98 and greater.

Mnemonics "D"

2009-09-04T21:10:15Z

SteveA: /* (Document) */

==(DE)==
'''Mnemonic''': (DE) Hex equivalent: "@0404@"

'''Discussion''': Default characters per line.
This control code sets the default number of characters per line. The default value is established in the terminal setup, the terminal emulator setup, or the console setup, depending on the type of device being used.

Also see (Screen), (CPL132), (CPL64), and (CPL80).
<pre>
Example:
a. 100 FORMAT (DE)
.
PRINT (0,100)

b. PRINT (0) (DE)
</pre>

==(Delete Window)==
'''Mnemonic''': (Delete Window) Hex equivalent: "@0E0D01@"

'''Discussion''': This mnemonic deletes a Comet window. If multiple windows have been created, this mnemonic deletes the most recently displayed window. 
When a window is deleted, the memory it used is returned to the amount of available window memory. To determine how much window memory remains, perform a numeric input immediately following the deletion of a window. See the window memory page for more information. If you do not need to know how much window memory remains, perform a null INPUT immediately after printing the (Delete Window) mnemonic.

Also see the discussion on Comet windows.
<pre>
Example:
a. 100 FORMAT (Delete Window)
.
PRINT (0,100)
INPUT (0) ""

b. PRINT (0) (Delete Window)
INPUT (0) ""
</pre>

==(DeleteWindowEx)==
'''Mnemonic''': (DeleteWindowEx=handle$)

'''Discussion''': This mnemonic deletes an extended window.
Each extended window is identified by a 4-byte string known as a window handle. The handle value is assigned by the system and returned to the Internet Basic program via an INPUT statement following the (CreateWindowEx).

See the WinDemo.ibs program (available at www.signature.net/download/demos) for examples of extended windows.

Also see (SelectWindowEx).

History: This feature is supported in Comet2002 Build 306 and higher.
Example: The following example creates two extended windows, then uses the (DeleteWindowEx) mnemonic to delete them.
<pre>
Length 4 & Local Handle1$,Handle2$
.
Print (CreateWindowEx=0,0,35,15,68,0,"Window 1")
Input Handle1$

Print (CreateWindowEx=0,40,20,10,68,0,"Window 2")
Input Handle2$
.
.
.
Print (DeleteWindowEx=Handle1$) ! delete window 1
Print (DeleteWindowEx=Handle2$) ! delete window 2
</pre>

==(Document)==
'''Mnemonic''': (Document=string-argument, string argument)

'''Discussion''': The (Document) mnemonic specifies a file name and Comet directory to be used for pdf, html, or txt print files. You may issue the mnemonic several times to produce multiple uniquely-named copies of the output file. Because a qdir entry will not be created for this file, you may use long filenames. CosP uses CometLib to make the document copies. Thus, a COM license is required to use this mnemonic.
The first string-argument is a string constant or variable containing the file name. If the name does not contain an extension, the appropriate one (.pdf, .html, or .txt) will be added depending on the type of printer being used. The second string-argument is the 3-character name of the CFAM directory where the file will be created.

If the second argument is an empty string, it is assumed that the first argument is a fully qualified windows path to the output file. This may point to a CFAM or non CFAM controlled directory. This path may not contain a directory alias. If a directory alias is required, use the (GetDirAlias) mnemonic to build the path.

Note: Do not confuse the (Document) mnemonic's use with that of (SpoolMessage). They serve two different purposes and may both be used on the same document. While the (Document) mnemonic is used to copy the document to any CFAM directory or windows path, the (SpoolMessage) mnemonic is used to name the document stored in a configured Archive.

The (Document) mnemonic is not available for CometAnywhere Clients.
<pre>
Example:
OPEN(1) "LPH"
PRINT(1) (DOCUMENT="Sales Report","RPT")
PRINT(1) (DOCUMENT="\\MyServer\archive\Sales Report 05-14-08.htm","")
</pre>

== (Domain) ==

Email Mnemonic: (Domain=string-argument)
Discussion: The (Domain) mnemonic may be used to specify a domain name for the the smtp server for your email printer. If not specified, the email printer will supply the same domain as designated in the (Server=) mnemonic.
Example: OPEN (1) "LEH"
PRINT (1) (Server="smtp.our.mail.server.net 25")
PRINT (1) (Domain="our.mail.server.net")

== (Draw Bit Map) ==

Mnemonic: (Draw Bit Map=left, top, right, bottom, scaleX, scaleY, flags); filename
Discussion: This mnemonic draws the bitmap contained in the file (.BMP/.JPG) specified in filename in the rectangle specified by left, top, right, bottom using the format codes contained in flags. Scaling factors can be specified in scaleX, scaleY.
Valid format code are:

BMR.FIT.TO.RECT Stretch (or shrink) bitmap to fit rectangle.

Cannot be used with any other codes or

BMR.CENTER.HZ.RECT Center the bitmap horizontally in rectangle
BMR.CENTER.VT.RECT Center the bitmap vertically in rectangle
BMR.SCALE Multiply dimensions by scaling factors below

When scaling, values contained in ScaleX and ScaleY are converted to floating point, divided by 100, and then multiplied by their respective axis to providing scaling by as little as 1 percent.
Scaling example:

To double only the horizontal size of a bitmap:

ScaleX = 200 ! * 2
ScaleY = 100 ! * 1

To halve a bitmap
ScaleX = 50 ! * .5
ScaleY = 50 ! * .5

To convert bitmap pixels to .01 inch:
ScaleX = 1440 ! * 14.40 (TWIPS/inch)
ScaleY = 1440 ! * 14.40 (TWIPS/inch)

See (Draw Image).
History: This mnemonic is valid in Comet98 and greater.

== (Draw box) ==

Mnemonic: (Draw box=a,b,c,d)
where:
a = upper left column (decimal)
b = upper left row (decimal)
c = lower right column (decimal)
d = lower right row (decimal)

Hex equivalent: --
Discussion: This mnemonic draws a graphical box using the specified screen coordinates (decimal values).
Note: The box overwrites any text displayed on the screen within the specified coordinates (i.e., this is not a "window").

Also see the discussion on Comet windows.

Example: a. 100 FORMAT (Draw box=2,3,5,10)
.
PRINT (0,100

b. PRINT (0) (Draw box=2,3,5,10)

== (Draw Image) ==

Mnemonic: (Draw Image=left, top, right, bottom, scaleX, scaleY, flags, filename)
Discussion: This mnemonic draws the bitmap contained in the file (.BMP/.JPG) specified in filename in the rectangle specified by left, top, right, bottom using the format codes contained in flags. Scaling factors can be specified in scaleX, scaleY.
(Draw Image) performs the same function as (Draw Bitmap), except that the filename is included as an argument of the mnemonic instead of a field following the mnemonic. This makes it unnecessary to add a trailing "@00@" to the printername.

Valid format code are:

BMR.FIT.TO.RECT Stretch (or shrink) bitmap to fit rectangle.

Cannot be used with any other codes or

BMR.CENTER.HZ.RECT Center the bitmap horizontally in rectangle
BMR.CENTER.VT.RECT Center the bitmap vertically in rectangle
BMR.SCALE Multiply dimensions by scaling factors below

When scaling, values contained in ScaleX and ScaleY are converted to floating point, divided by 100, and then multiplied by their respective axis to providing scaling by as little as 1 percent.
Scaling example:

To double only the horizontal size of a bitmap:

ScaleX = 200 ! * 2
ScaleY = 100 ! * 1

To halve a bitmap
ScaleX = 50 ! * .5
ScaleY = 50 ! * .5

To convert bitmap pixels to .01 inch:
ScaleX = 1440 ! * 14.40 (TWIPS/inch)
ScaleY = 1440 ! * 14.40 (TWIPS/inch)

History: This mnemonic is valid in Comet98 and greater.

== (Draw Text) ==

Mnemonic: (Draw Text=left, top, right, bottom, flags); printable-text
Discussion: Prints the specified printable-text into the rectangle specified by the coordinates left, top, right, bottom using the format codes specified in flags.
Call this member function to format text in the given rectangle. It formats text by expanding tabs into appropriate spaces, aligning text to the left, right, or center of the given rectangle, and breaking text into lines that fit within the given rectangle, and breaking text into lines that fit within the given rectangle. The type of formatting is specified by flags.

The formatting codes can be combined and are specified in flags.

DT.TOP Specifies top-justified text (single line only).
DT.LEFT Aligns text flush-left.
DT.CENTER Centers text horizontally.
DT.RIGHT Aligns text flush-right.
DT.VCENTER Specifies vertically centered text (single line only).
DT.BOTTOM Specifies bottom-justified text. This value must be combined with DT.SINGLELINE.
DT.WORDBREAK Specifies word-breaking. Lines are automatically broken between words if a word would extend past the edge of the rectangle specified by left, top, right, bottom. A carriage return-linefeed sequence will also break the line.
DT.SINGLELINE Specifies single line only. Carriage returns and linefeeds do not break the line.
DT.EXPANDTABS Expands tab characters. The default number of characters per tab is eight.
DT.TABSTOP Sets tab stops. The high-order byte of PtrFlags is the number of characters for each tab. The default number of characters per tab is eight.
DT.NOCLIP Draws without clipping. DrawText is somewhat faster when DT.NOCLIP is used.
DT.EXTERNALLEADING Includes the font's external leading in the line height. Normally, external leading is not included in the height of a line of text.
DT.CALCRECT Returns the height of the formatted text, but does not draw the text.
DT.NOPREFIX Turns off processing of prefix characters. Normally, DrawText interprets the ampersand (&) mnemonic-prefix character as a directive to underscore the character that follows, and the two-ampersand (&&) mnemonic- prefix characters as a directive to print a single ampersand. By specifying DT.NOPREFIX, this processing is turned off.
DT.INTERNAL Uses the system font to calculate text metrics.
DT.EDITCONTROL Duplicates the text-displaying characteristics of a multiline edit control. Specifically, the average character width is calculated in the same manner as for an edit control, and the function does not display a partially visible last line.
DT.PATH.ELLIPSIS See DT.END.ELLIPSIS Below
DT.END.ELLIPSIS Replaces part of the given string with ellipses, if necessary, so that the result fits in the specified rectangle. The given string is not modified unless the DT.MODIFYSTRING flag is specified.
You can specify DT.END.ELLIPSIS to replace characters at the end of the string, or DT.PATH.ELLIPSIS to replace characters in the middle of the string. If the string contains backslash (\) characters, DT.PATH.ELLIPSIS preserves as much as possible of the text after the last backslash.

DT.MODIFYSTRING Modifies the given string to match the displayed text. This flag has no effect unless the DT_END_ELLIPSIS or DT_PATH_ELLIPSIS flag is specified.
DT.RTLREADING Layout in right to left reading order for bi-directional text when the font selected into the hdc is a Hebrew or Arabic font. The default reading order for all text is left to right.
DT.WORD.ELLIPSIS Truncates text that does not fit in the rectangle and adds ellipses.

NOTE: The values DT.CALCRECT, DT.EXTERNALLEADING, DT.INTERNAL, DT.NOCLIP, and DT.NOPREFIX cannot be used with the DT.TABSTOP value.

History: This mnemonic is valid in Comet98 and greater.

Mnemonics "D"

2009-09-04T21:08:42Z

SteveA: /* (DeleteWindowEx) */

==(DE)==
'''Mnemonic''': (DE) Hex equivalent: "@0404@"

'''Discussion''': Default characters per line.
This control code sets the default number of characters per line. The default value is established in the terminal setup, the terminal emulator setup, or the console setup, depending on the type of device being used.

Also see (Screen), (CPL132), (CPL64), and (CPL80).
<pre>
Example:
a. 100 FORMAT (DE)
.
PRINT (0,100)

b. PRINT (0) (DE)
</pre>

==(Delete Window)==
'''Mnemonic''': (Delete Window) Hex equivalent: "@0E0D01@"

'''Discussion''': This mnemonic deletes a Comet window. If multiple windows have been created, this mnemonic deletes the most recently displayed window. 
When a window is deleted, the memory it used is returned to the amount of available window memory. To determine how much window memory remains, perform a numeric input immediately following the deletion of a window. See the window memory page for more information. If you do not need to know how much window memory remains, perform a null INPUT immediately after printing the (Delete Window) mnemonic.

Also see the discussion on Comet windows.
<pre>
Example:
a. 100 FORMAT (Delete Window)
.
PRINT (0,100)
INPUT (0) ""

b. PRINT (0) (Delete Window)
INPUT (0) ""
</pre>

==(DeleteWindowEx)==
'''Mnemonic''': (DeleteWindowEx=handle$)

'''Discussion''': This mnemonic deletes an extended window.
Each extended window is identified by a 4-byte string known as a window handle. The handle value is assigned by the system and returned to the Internet Basic program via an INPUT statement following the (CreateWindowEx).

See the WinDemo.ibs program (available at www.signature.net/download/demos) for examples of extended windows.

Also see (SelectWindowEx).

History: This feature is supported in Comet2002 Build 306 and higher.
Example: The following example creates two extended windows, then uses the (DeleteWindowEx) mnemonic to delete them.
<pre>
Length 4 & Local Handle1$,Handle2$
.
Print (CreateWindowEx=0,0,35,15,68,0,"Window 1")
Input Handle1$

Print (CreateWindowEx=0,40,20,10,68,0,"Window 2")
Input Handle2$
.
.
.
Print (DeleteWindowEx=Handle1$) ! delete window 1
Print (DeleteWindowEx=Handle2$) ! delete window 2
</pre>

== (Document) ==

Mnemonic: (Document=string-argument, string argument)
Discussion: The (Document) mnemonic specifies a file name and Comet directory to be used for pdf, html, or txt print files. You may issue the mnemonic several times to produce multiple uniquely-named copies of the output file. Because a qdir entry will not be created for this file, you may use long filenames. CosP uses CometLib to make the document copies. Thus, a COM license is required to use this mnemonic.
The first string-argument is a string constant or variable containing the file name. If the name does not contain an extension, the appropriate one (.pdf, .html, or .txt) will be added depending on the type of printer being used. The second string-argument is the 3-character name of the CFAM directory where the file will be created.

If the second argument is an empty string, it is assumed that the first argument is a fully qualified windows path to the output file. This may point to a CFAM or non CFAM controlled directory. This path may not contain a directory alias. If a directory alias is required, use the (GetDirAlias) mnemonic to build the path.

Note: Do not confuse the (Document) mnemonic's use with that of (SpoolMessage). They serve two different purposes and may both be used on the same document. While the (Document) mnemonic is used to copy the document to any CFAM directory or windows path, the (SpoolMessage) mnemonic is used to name the document stored in a configured Archive.

The (Document) mnemonic is not available for CometAnywhere Clients.

Example: OPEN(1) "LPH"
PRINT(1) (DOCUMENT="Sales Report","RPT")
PRINT(1) (DOCUMENT="\\MyServer\archive\Sales Report 05-14-08.htm","")

== (Domain) ==

Email Mnemonic: (Domain=string-argument)
Discussion: The (Domain) mnemonic may be used to specify a domain name for the the smtp server for your email printer. If not specified, the email printer will supply the same domain as designated in the (Server=) mnemonic.
Example: OPEN (1) "LEH"
PRINT (1) (Server="smtp.our.mail.server.net 25")
PRINT (1) (Domain="our.mail.server.net")

== (Draw Bit Map) ==

Mnemonic: (Draw Bit Map=left, top, right, bottom, scaleX, scaleY, flags); filename
Discussion: This mnemonic draws the bitmap contained in the file (.BMP/.JPG) specified in filename in the rectangle specified by left, top, right, bottom using the format codes contained in flags. Scaling factors can be specified in scaleX, scaleY.
Valid format code are:

BMR.FIT.TO.RECT Stretch (or shrink) bitmap to fit rectangle.

Cannot be used with any other codes or

BMR.CENTER.HZ.RECT Center the bitmap horizontally in rectangle
BMR.CENTER.VT.RECT Center the bitmap vertically in rectangle
BMR.SCALE Multiply dimensions by scaling factors below

When scaling, values contained in ScaleX and ScaleY are converted to floating point, divided by 100, and then multiplied by their respective axis to providing scaling by as little as 1 percent.
Scaling example:

To double only the horizontal size of a bitmap:

ScaleX = 200 ! * 2
ScaleY = 100 ! * 1

To halve a bitmap
ScaleX = 50 ! * .5
ScaleY = 50 ! * .5

To convert bitmap pixels to .01 inch:
ScaleX = 1440 ! * 14.40 (TWIPS/inch)
ScaleY = 1440 ! * 14.40 (TWIPS/inch)

See (Draw Image).
History: This mnemonic is valid in Comet98 and greater.

== (Draw box) ==

Mnemonic: (Draw box=a,b,c,d)
where:
a = upper left column (decimal)
b = upper left row (decimal)
c = lower right column (decimal)
d = lower right row (decimal)

Hex equivalent: --
Discussion: This mnemonic draws a graphical box using the specified screen coordinates (decimal values).
Note: The box overwrites any text displayed on the screen within the specified coordinates (i.e., this is not a "window").

Also see the discussion on Comet windows.

Example: a. 100 FORMAT (Draw box=2,3,5,10)
.
PRINT (0,100

b. PRINT (0) (Draw box=2,3,5,10)

== (Draw Image) ==

Mnemonic: (Draw Image=left, top, right, bottom, scaleX, scaleY, flags, filename)
Discussion: This mnemonic draws the bitmap contained in the file (.BMP/.JPG) specified in filename in the rectangle specified by left, top, right, bottom using the format codes contained in flags. Scaling factors can be specified in scaleX, scaleY.
(Draw Image) performs the same function as (Draw Bitmap), except that the filename is included as an argument of the mnemonic instead of a field following the mnemonic. This makes it unnecessary to add a trailing "@00@" to the printername.

Valid format code are:

BMR.FIT.TO.RECT Stretch (or shrink) bitmap to fit rectangle.

Cannot be used with any other codes or

BMR.CENTER.HZ.RECT Center the bitmap horizontally in rectangle
BMR.CENTER.VT.RECT Center the bitmap vertically in rectangle
BMR.SCALE Multiply dimensions by scaling factors below

When scaling, values contained in ScaleX and ScaleY are converted to floating point, divided by 100, and then multiplied by their respective axis to providing scaling by as little as 1 percent.
Scaling example:

To double only the horizontal size of a bitmap:

ScaleX = 200 ! * 2
ScaleY = 100 ! * 1

To halve a bitmap
ScaleX = 50 ! * .5
ScaleY = 50 ! * .5

To convert bitmap pixels to .01 inch:
ScaleX = 1440 ! * 14.40 (TWIPS/inch)
ScaleY = 1440 ! * 14.40 (TWIPS/inch)

History: This mnemonic is valid in Comet98 and greater.

== (Draw Text) ==

Mnemonic: (Draw Text=left, top, right, bottom, flags); printable-text
Discussion: Prints the specified printable-text into the rectangle specified by the coordinates left, top, right, bottom using the format codes specified in flags.
Call this member function to format text in the given rectangle. It formats text by expanding tabs into appropriate spaces, aligning text to the left, right, or center of the given rectangle, and breaking text into lines that fit within the given rectangle, and breaking text into lines that fit within the given rectangle. The type of formatting is specified by flags.

The formatting codes can be combined and are specified in flags.

DT.TOP Specifies top-justified text (single line only).
DT.LEFT Aligns text flush-left.
DT.CENTER Centers text horizontally.
DT.RIGHT Aligns text flush-right.
DT.VCENTER Specifies vertically centered text (single line only).
DT.BOTTOM Specifies bottom-justified text. This value must be combined with DT.SINGLELINE.
DT.WORDBREAK Specifies word-breaking. Lines are automatically broken between words if a word would extend past the edge of the rectangle specified by left, top, right, bottom. A carriage return-linefeed sequence will also break the line.
DT.SINGLELINE Specifies single line only. Carriage returns and linefeeds do not break the line.
DT.EXPANDTABS Expands tab characters. The default number of characters per tab is eight.
DT.TABSTOP Sets tab stops. The high-order byte of PtrFlags is the number of characters for each tab. The default number of characters per tab is eight.
DT.NOCLIP Draws without clipping. DrawText is somewhat faster when DT.NOCLIP is used.
DT.EXTERNALLEADING Includes the font's external leading in the line height. Normally, external leading is not included in the height of a line of text.
DT.CALCRECT Returns the height of the formatted text, but does not draw the text.
DT.NOPREFIX Turns off processing of prefix characters. Normally, DrawText interprets the ampersand (&) mnemonic-prefix character as a directive to underscore the character that follows, and the two-ampersand (&&) mnemonic- prefix characters as a directive to print a single ampersand. By specifying DT.NOPREFIX, this processing is turned off.
DT.INTERNAL Uses the system font to calculate text metrics.
DT.EDITCONTROL Duplicates the text-displaying characteristics of a multiline edit control. Specifically, the average character width is calculated in the same manner as for an edit control, and the function does not display a partially visible last line.
DT.PATH.ELLIPSIS See DT.END.ELLIPSIS Below
DT.END.ELLIPSIS Replaces part of the given string with ellipses, if necessary, so that the result fits in the specified rectangle. The given string is not modified unless the DT.MODIFYSTRING flag is specified.
You can specify DT.END.ELLIPSIS to replace characters at the end of the string, or DT.PATH.ELLIPSIS to replace characters in the middle of the string. If the string contains backslash (\) characters, DT.PATH.ELLIPSIS preserves as much as possible of the text after the last backslash.

DT.MODIFYSTRING Modifies the given string to match the displayed text. This flag has no effect unless the DT_END_ELLIPSIS or DT_PATH_ELLIPSIS flag is specified.
DT.RTLREADING Layout in right to left reading order for bi-directional text when the font selected into the hdc is a Hebrew or Arabic font. The default reading order for all text is left to right.
DT.WORD.ELLIPSIS Truncates text that does not fit in the rectangle and adds ellipses.

NOTE: The values DT.CALCRECT, DT.EXTERNALLEADING, DT.INTERNAL, DT.NOCLIP, and DT.NOPREFIX cannot be used with the DT.TABSTOP value.

History: This mnemonic is valid in Comet98 and greater.

Mnemonics "D"

2009-09-04T21:07:35Z

SteveA: /* (Delete Window) */

==(DE)==
'''Mnemonic''': (DE) Hex equivalent: "@0404@"

'''Discussion''': Default characters per line.
This control code sets the default number of characters per line. The default value is established in the terminal setup, the terminal emulator setup, or the console setup, depending on the type of device being used.

Also see (Screen), (CPL132), (CPL64), and (CPL80).
<pre>
Example:
a. 100 FORMAT (DE)
.
PRINT (0,100)

b. PRINT (0) (DE)
</pre>

==(Delete Window)==
'''Mnemonic''': (Delete Window) Hex equivalent: "@0E0D01@"

'''Discussion''': This mnemonic deletes a Comet window. If multiple windows have been created, this mnemonic deletes the most recently displayed window. 
When a window is deleted, the memory it used is returned to the amount of available window memory. To determine how much window memory remains, perform a numeric input immediately following the deletion of a window. See the window memory page for more information. If you do not need to know how much window memory remains, perform a null INPUT immediately after printing the (Delete Window) mnemonic.

Also see the discussion on Comet windows.
<pre>
Example:
a. 100 FORMAT (Delete Window)
.
PRINT (0,100)
INPUT (0) ""

b. PRINT (0) (Delete Window)
INPUT (0) ""
</pre>

== (DeleteWindowEx) ==

Mnemonic: (DeleteWindowEx=handle$)
Discussion: This mnemonic deletes an extended window.
Each extended window is identified by a 4-byte string known as a window handle. The handle value is assigned by the system and returned to the Internet Basic program via an INPUT statement following the (CreateWindowEx).

See the WinDemo.ibs program (available at www.signature.net/download/demos) for examples of extended windows.

Also see (SelectWindowEx).

History: This feature is supported in Comet2002 Build 306 and higher.
Example: The following example creates two extended windows, then uses the (DeleteWindowEx) mnemonic to delete them.
Length 4 & Local Handle1$,Handle2$
.
Print (CreateWindowEx=0,0,35,15,68,0,"Window 1")
Input Handle1$

Print (CreateWindowEx=0,40,20,10,68,0,"Window 2")
Input Handle2$
.
.
.
Print (DeleteWindowEx=Handle1$) ! delete window 1
Print (DeleteWindowEx=Handle2$) ! delete window 2

== (Document) ==

Mnemonic: (Document=string-argument, string argument)
Discussion: The (Document) mnemonic specifies a file name and Comet directory to be used for pdf, html, or txt print files. You may issue the mnemonic several times to produce multiple uniquely-named copies of the output file. Because a qdir entry will not be created for this file, you may use long filenames. CosP uses CometLib to make the document copies. Thus, a COM license is required to use this mnemonic.
The first string-argument is a string constant or variable containing the file name. If the name does not contain an extension, the appropriate one (.pdf, .html, or .txt) will be added depending on the type of printer being used. The second string-argument is the 3-character name of the CFAM directory where the file will be created.

If the second argument is an empty string, it is assumed that the first argument is a fully qualified windows path to the output file. This may point to a CFAM or non CFAM controlled directory. This path may not contain a directory alias. If a directory alias is required, use the (GetDirAlias) mnemonic to build the path.

Note: Do not confuse the (Document) mnemonic's use with that of (SpoolMessage). They serve two different purposes and may both be used on the same document. While the (Document) mnemonic is used to copy the document to any CFAM directory or windows path, the (SpoolMessage) mnemonic is used to name the document stored in a configured Archive.

The (Document) mnemonic is not available for CometAnywhere Clients.

Example: OPEN(1) "LPH"
PRINT(1) (DOCUMENT="Sales Report","RPT")
PRINT(1) (DOCUMENT="\\MyServer\archive\Sales Report 05-14-08.htm","")

== (Domain) ==

Email Mnemonic: (Domain=string-argument)
Discussion: The (Domain) mnemonic may be used to specify a domain name for the the smtp server for your email printer. If not specified, the email printer will supply the same domain as designated in the (Server=) mnemonic.
Example: OPEN (1) "LEH"
PRINT (1) (Server="smtp.our.mail.server.net 25")
PRINT (1) (Domain="our.mail.server.net")

== (Draw Bit Map) ==

Mnemonic: (Draw Bit Map=left, top, right, bottom, scaleX, scaleY, flags); filename
Discussion: This mnemonic draws the bitmap contained in the file (.BMP/.JPG) specified in filename in the rectangle specified by left, top, right, bottom using the format codes contained in flags. Scaling factors can be specified in scaleX, scaleY.
Valid format code are:

BMR.FIT.TO.RECT Stretch (or shrink) bitmap to fit rectangle.

Cannot be used with any other codes or

BMR.CENTER.HZ.RECT Center the bitmap horizontally in rectangle
BMR.CENTER.VT.RECT Center the bitmap vertically in rectangle
BMR.SCALE Multiply dimensions by scaling factors below

When scaling, values contained in ScaleX and ScaleY are converted to floating point, divided by 100, and then multiplied by their respective axis to providing scaling by as little as 1 percent.
Scaling example:

To double only the horizontal size of a bitmap:

ScaleX = 200 ! * 2
ScaleY = 100 ! * 1

To halve a bitmap
ScaleX = 50 ! * .5
ScaleY = 50 ! * .5

To convert bitmap pixels to .01 inch:
ScaleX = 1440 ! * 14.40 (TWIPS/inch)
ScaleY = 1440 ! * 14.40 (TWIPS/inch)

See (Draw Image).
History: This mnemonic is valid in Comet98 and greater.

== (Draw box) ==

Mnemonic: (Draw box=a,b,c,d)
where:
a = upper left column (decimal)
b = upper left row (decimal)
c = lower right column (decimal)
d = lower right row (decimal)

Hex equivalent: --
Discussion: This mnemonic draws a graphical box using the specified screen coordinates (decimal values).
Note: The box overwrites any text displayed on the screen within the specified coordinates (i.e., this is not a "window").

Also see the discussion on Comet windows.

Example: a. 100 FORMAT (Draw box=2,3,5,10)
.
PRINT (0,100

b. PRINT (0) (Draw box=2,3,5,10)

== (Draw Image) ==

Mnemonic: (Draw Image=left, top, right, bottom, scaleX, scaleY, flags, filename)
Discussion: This mnemonic draws the bitmap contained in the file (.BMP/.JPG) specified in filename in the rectangle specified by left, top, right, bottom using the format codes contained in flags. Scaling factors can be specified in scaleX, scaleY.
(Draw Image) performs the same function as (Draw Bitmap), except that the filename is included as an argument of the mnemonic instead of a field following the mnemonic. This makes it unnecessary to add a trailing "@00@" to the printername.

Valid format code are:

BMR.FIT.TO.RECT Stretch (or shrink) bitmap to fit rectangle.

Cannot be used with any other codes or

BMR.CENTER.HZ.RECT Center the bitmap horizontally in rectangle
BMR.CENTER.VT.RECT Center the bitmap vertically in rectangle
BMR.SCALE Multiply dimensions by scaling factors below

When scaling, values contained in ScaleX and ScaleY are converted to floating point, divided by 100, and then multiplied by their respective axis to providing scaling by as little as 1 percent.
Scaling example:

To double only the horizontal size of a bitmap:

ScaleX = 200 ! * 2
ScaleY = 100 ! * 1

To halve a bitmap
ScaleX = 50 ! * .5
ScaleY = 50 ! * .5

To convert bitmap pixels to .01 inch:
ScaleX = 1440 ! * 14.40 (TWIPS/inch)
ScaleY = 1440 ! * 14.40 (TWIPS/inch)

History: This mnemonic is valid in Comet98 and greater.

== (Draw Text) ==

Mnemonic: (Draw Text=left, top, right, bottom, flags); printable-text
Discussion: Prints the specified printable-text into the rectangle specified by the coordinates left, top, right, bottom using the format codes specified in flags.
Call this member function to format text in the given rectangle. It formats text by expanding tabs into appropriate spaces, aligning text to the left, right, or center of the given rectangle, and breaking text into lines that fit within the given rectangle, and breaking text into lines that fit within the given rectangle. The type of formatting is specified by flags.

The formatting codes can be combined and are specified in flags.

DT.TOP Specifies top-justified text (single line only).
DT.LEFT Aligns text flush-left.
DT.CENTER Centers text horizontally.
DT.RIGHT Aligns text flush-right.
DT.VCENTER Specifies vertically centered text (single line only).
DT.BOTTOM Specifies bottom-justified text. This value must be combined with DT.SINGLELINE.
DT.WORDBREAK Specifies word-breaking. Lines are automatically broken between words if a word would extend past the edge of the rectangle specified by left, top, right, bottom. A carriage return-linefeed sequence will also break the line.
DT.SINGLELINE Specifies single line only. Carriage returns and linefeeds do not break the line.
DT.EXPANDTABS Expands tab characters. The default number of characters per tab is eight.
DT.TABSTOP Sets tab stops. The high-order byte of PtrFlags is the number of characters for each tab. The default number of characters per tab is eight.
DT.NOCLIP Draws without clipping. DrawText is somewhat faster when DT.NOCLIP is used.
DT.EXTERNALLEADING Includes the font's external leading in the line height. Normally, external leading is not included in the height of a line of text.
DT.CALCRECT Returns the height of the formatted text, but does not draw the text.
DT.NOPREFIX Turns off processing of prefix characters. Normally, DrawText interprets the ampersand (&) mnemonic-prefix character as a directive to underscore the character that follows, and the two-ampersand (&&) mnemonic- prefix characters as a directive to print a single ampersand. By specifying DT.NOPREFIX, this processing is turned off.
DT.INTERNAL Uses the system font to calculate text metrics.
DT.EDITCONTROL Duplicates the text-displaying characteristics of a multiline edit control. Specifically, the average character width is calculated in the same manner as for an edit control, and the function does not display a partially visible last line.
DT.PATH.ELLIPSIS See DT.END.ELLIPSIS Below
DT.END.ELLIPSIS Replaces part of the given string with ellipses, if necessary, so that the result fits in the specified rectangle. The given string is not modified unless the DT.MODIFYSTRING flag is specified.
You can specify DT.END.ELLIPSIS to replace characters at the end of the string, or DT.PATH.ELLIPSIS to replace characters in the middle of the string. If the string contains backslash (\) characters, DT.PATH.ELLIPSIS preserves as much as possible of the text after the last backslash.

DT.MODIFYSTRING Modifies the given string to match the displayed text. This flag has no effect unless the DT_END_ELLIPSIS or DT_PATH_ELLIPSIS flag is specified.
DT.RTLREADING Layout in right to left reading order for bi-directional text when the font selected into the hdc is a Hebrew or Arabic font. The default reading order for all text is left to right.
DT.WORD.ELLIPSIS Truncates text that does not fit in the rectangle and adds ellipses.

NOTE: The values DT.CALCRECT, DT.EXTERNALLEADING, DT.INTERNAL, DT.NOCLIP, and DT.NOPREFIX cannot be used with the DT.TABSTOP value.

History: This mnemonic is valid in Comet98 and greater.

Mnemonics "D"

2009-09-04T21:05:53Z

SteveA: /* (DE) */

==(DE)==
'''Mnemonic''': (DE) Hex equivalent: "@0404@"

'''Discussion''': Default characters per line.
This control code sets the default number of characters per line. The default value is established in the terminal setup, the terminal emulator setup, or the console setup, depending on the type of device being used.

Also see (Screen), (CPL132), (CPL64), and (CPL80).
<pre>
Example:
a. 100 FORMAT (DE)
.
PRINT (0,100)

b. PRINT (0) (DE)
</pre>

== (Delete Window) ==

Mnemonic: (Delete Window)
Hex equivalent: "@0E0D01@"
Discussion: This mnemonic deletes a Comet window. If multiple windows have been created, this mnemonic deletes the most recently displayed window.
When a window is deleted, the memory it used is returned to the amount of available window memory. To determine how much window memory remains, perform a numeric input immediately following the deletion of a window. See the window memory page for more information. If you do not need to know how much window memory remains, perform a null INPUT immediately after printing the (Delete Window) mnemonic.

Also see the discussion on Comet windows.

Example: a. 100 FORMAT (Delete Window)
.
PRINT (0,100)
INPUT (0) ""

b. PRINT (0) (Delete Window)
INPUT (0) ""

== (DeleteWindowEx) ==

Mnemonic: (DeleteWindowEx=handle$)
Discussion: This mnemonic deletes an extended window.
Each extended window is identified by a 4-byte string known as a window handle. The handle value is assigned by the system and returned to the Internet Basic program via an INPUT statement following the (CreateWindowEx).

See the WinDemo.ibs program (available at www.signature.net/download/demos) for examples of extended windows.

Also see (SelectWindowEx).

History: This feature is supported in Comet2002 Build 306 and higher.
Example: The following example creates two extended windows, then uses the (DeleteWindowEx) mnemonic to delete them.
Length 4 & Local Handle1$,Handle2$
.
Print (CreateWindowEx=0,0,35,15,68,0,"Window 1")
Input Handle1$

Print (CreateWindowEx=0,40,20,10,68,0,"Window 2")
Input Handle2$
.
.
.
Print (DeleteWindowEx=Handle1$) ! delete window 1
Print (DeleteWindowEx=Handle2$) ! delete window 2

== (Document) ==

Mnemonic: (Document=string-argument, string argument)
Discussion: The (Document) mnemonic specifies a file name and Comet directory to be used for pdf, html, or txt print files. You may issue the mnemonic several times to produce multiple uniquely-named copies of the output file. Because a qdir entry will not be created for this file, you may use long filenames. CosP uses CometLib to make the document copies. Thus, a COM license is required to use this mnemonic.
The first string-argument is a string constant or variable containing the file name. If the name does not contain an extension, the appropriate one (.pdf, .html, or .txt) will be added depending on the type of printer being used. The second string-argument is the 3-character name of the CFAM directory where the file will be created.

If the second argument is an empty string, it is assumed that the first argument is a fully qualified windows path to the output file. This may point to a CFAM or non CFAM controlled directory. This path may not contain a directory alias. If a directory alias is required, use the (GetDirAlias) mnemonic to build the path.

Note: Do not confuse the (Document) mnemonic's use with that of (SpoolMessage). They serve two different purposes and may both be used on the same document. While the (Document) mnemonic is used to copy the document to any CFAM directory or windows path, the (SpoolMessage) mnemonic is used to name the document stored in a configured Archive.

The (Document) mnemonic is not available for CometAnywhere Clients.

Example: OPEN(1) "LPH"
PRINT(1) (DOCUMENT="Sales Report","RPT")
PRINT(1) (DOCUMENT="\\MyServer\archive\Sales Report 05-14-08.htm","")

== (Domain) ==

Email Mnemonic: (Domain=string-argument)
Discussion: The (Domain) mnemonic may be used to specify a domain name for the the smtp server for your email printer. If not specified, the email printer will supply the same domain as designated in the (Server=) mnemonic.
Example: OPEN (1) "LEH"
PRINT (1) (Server="smtp.our.mail.server.net 25")
PRINT (1) (Domain="our.mail.server.net")

== (Draw Bit Map) ==

Mnemonic: (Draw Bit Map=left, top, right, bottom, scaleX, scaleY, flags); filename
Discussion: This mnemonic draws the bitmap contained in the file (.BMP/.JPG) specified in filename in the rectangle specified by left, top, right, bottom using the format codes contained in flags. Scaling factors can be specified in scaleX, scaleY.
Valid format code are:

BMR.FIT.TO.RECT Stretch (or shrink) bitmap to fit rectangle.

Cannot be used with any other codes or

BMR.CENTER.HZ.RECT Center the bitmap horizontally in rectangle
BMR.CENTER.VT.RECT Center the bitmap vertically in rectangle
BMR.SCALE Multiply dimensions by scaling factors below

When scaling, values contained in ScaleX and ScaleY are converted to floating point, divided by 100, and then multiplied by their respective axis to providing scaling by as little as 1 percent.
Scaling example:

To double only the horizontal size of a bitmap:

ScaleX = 200 ! * 2
ScaleY = 100 ! * 1

To halve a bitmap
ScaleX = 50 ! * .5
ScaleY = 50 ! * .5

To convert bitmap pixels to .01 inch:
ScaleX = 1440 ! * 14.40 (TWIPS/inch)
ScaleY = 1440 ! * 14.40 (TWIPS/inch)

See (Draw Image).
History: This mnemonic is valid in Comet98 and greater.

== (Draw box) ==

Mnemonic: (Draw box=a,b,c,d)
where:
a = upper left column (decimal)
b = upper left row (decimal)
c = lower right column (decimal)
d = lower right row (decimal)

Hex equivalent: --
Discussion: This mnemonic draws a graphical box using the specified screen coordinates (decimal values).
Note: The box overwrites any text displayed on the screen within the specified coordinates (i.e., this is not a "window").

Also see the discussion on Comet windows.

Example: a. 100 FORMAT (Draw box=2,3,5,10)
.
PRINT (0,100

b. PRINT (0) (Draw box=2,3,5,10)

== (Draw Image) ==

Mnemonic: (Draw Image=left, top, right, bottom, scaleX, scaleY, flags, filename)
Discussion: This mnemonic draws the bitmap contained in the file (.BMP/.JPG) specified in filename in the rectangle specified by left, top, right, bottom using the format codes contained in flags. Scaling factors can be specified in scaleX, scaleY.
(Draw Image) performs the same function as (Draw Bitmap), except that the filename is included as an argument of the mnemonic instead of a field following the mnemonic. This makes it unnecessary to add a trailing "@00@" to the printername.

Valid format code are:

BMR.FIT.TO.RECT Stretch (or shrink) bitmap to fit rectangle.

Cannot be used with any other codes or

BMR.CENTER.HZ.RECT Center the bitmap horizontally in rectangle
BMR.CENTER.VT.RECT Center the bitmap vertically in rectangle
BMR.SCALE Multiply dimensions by scaling factors below

When scaling, values contained in ScaleX and ScaleY are converted to floating point, divided by 100, and then multiplied by their respective axis to providing scaling by as little as 1 percent.
Scaling example:

To double only the horizontal size of a bitmap:

ScaleX = 200 ! * 2
ScaleY = 100 ! * 1

To halve a bitmap
ScaleX = 50 ! * .5
ScaleY = 50 ! * .5

To convert bitmap pixels to .01 inch:
ScaleX = 1440 ! * 14.40 (TWIPS/inch)
ScaleY = 1440 ! * 14.40 (TWIPS/inch)

History: This mnemonic is valid in Comet98 and greater.

== (Draw Text) ==

Mnemonic: (Draw Text=left, top, right, bottom, flags); printable-text
Discussion: Prints the specified printable-text into the rectangle specified by the coordinates left, top, right, bottom using the format codes specified in flags.
Call this member function to format text in the given rectangle. It formats text by expanding tabs into appropriate spaces, aligning text to the left, right, or center of the given rectangle, and breaking text into lines that fit within the given rectangle, and breaking text into lines that fit within the given rectangle. The type of formatting is specified by flags.

The formatting codes can be combined and are specified in flags.

DT.TOP Specifies top-justified text (single line only).
DT.LEFT Aligns text flush-left.
DT.CENTER Centers text horizontally.
DT.RIGHT Aligns text flush-right.
DT.VCENTER Specifies vertically centered text (single line only).
DT.BOTTOM Specifies bottom-justified text. This value must be combined with DT.SINGLELINE.
DT.WORDBREAK Specifies word-breaking. Lines are automatically broken between words if a word would extend past the edge of the rectangle specified by left, top, right, bottom. A carriage return-linefeed sequence will also break the line.
DT.SINGLELINE Specifies single line only. Carriage returns and linefeeds do not break the line.
DT.EXPANDTABS Expands tab characters. The default number of characters per tab is eight.
DT.TABSTOP Sets tab stops. The high-order byte of PtrFlags is the number of characters for each tab. The default number of characters per tab is eight.
DT.NOCLIP Draws without clipping. DrawText is somewhat faster when DT.NOCLIP is used.
DT.EXTERNALLEADING Includes the font's external leading in the line height. Normally, external leading is not included in the height of a line of text.
DT.CALCRECT Returns the height of the formatted text, but does not draw the text.
DT.NOPREFIX Turns off processing of prefix characters. Normally, DrawText interprets the ampersand (&) mnemonic-prefix character as a directive to underscore the character that follows, and the two-ampersand (&&) mnemonic- prefix characters as a directive to print a single ampersand. By specifying DT.NOPREFIX, this processing is turned off.
DT.INTERNAL Uses the system font to calculate text metrics.
DT.EDITCONTROL Duplicates the text-displaying characteristics of a multiline edit control. Specifically, the average character width is calculated in the same manner as for an edit control, and the function does not display a partially visible last line.
DT.PATH.ELLIPSIS See DT.END.ELLIPSIS Below
DT.END.ELLIPSIS Replaces part of the given string with ellipses, if necessary, so that the result fits in the specified rectangle. The given string is not modified unless the DT.MODIFYSTRING flag is specified.
You can specify DT.END.ELLIPSIS to replace characters at the end of the string, or DT.PATH.ELLIPSIS to replace characters in the middle of the string. If the string contains backslash (\) characters, DT.PATH.ELLIPSIS preserves as much as possible of the text after the last backslash.

DT.MODIFYSTRING Modifies the given string to match the displayed text. This flag has no effect unless the DT_END_ELLIPSIS or DT_PATH_ELLIPSIS flag is specified.
DT.RTLREADING Layout in right to left reading order for bi-directional text when the font selected into the hdc is a Hebrew or Arabic font. The default reading order for all text is left to right.
DT.WORD.ELLIPSIS Truncates text that does not fit in the rectangle and adds ellipses.

NOTE: The values DT.CALCRECT, DT.EXTERNALLEADING, DT.INTERNAL, DT.NOCLIP, and DT.NOPREFIX cannot be used with the DT.TABSTOP value.

History: This mnemonic is valid in Comet98 and greater.

Mnemonics "B"

2009-09-04T21:03:17Z

SteveA: /* (BF) */

==(BCC)==
'''Email Mnemonic''': (BCC=string-argument)

'''Discussion:''' The (BCC) mnemonic may be used to specify "blind carbon copy" recipients of your email message.
<pre>
Example: OPEN (1) "LEH" PRINT (1) (BCC="brian@@signature.net")
</pre>

== (Begin Metafile) ==
'''Mnemonic''': (BeginMetafile = FileName)

'''Discussion''': Initiates the collecting of GDI functions into a virtual memory block (Metafile) that is passed to COSW in a single write rather than one function at a time enhancing performance. If FileName is non-blank the file can be saved to disk and recalled at a later time (see [[#ExecuteMetafile]]).

Read about other Email Mnemonics

==(BeginWaitCursor)==
'''Mnemonic''': (BeginWaitCursor)

'''Discussion''': This mnemonic turns on the hourglass cursor. See [[#(EndWaitCursor)]] and [[#(RestoreWaitCursor)]].
<pre>
Example:
Print (BeginWaitCursor) . . .
Print (EndWaitCursor)
</pre>

==(BF)==

'''Mnemonic''': (BF) Hex equivalent: "@0406@"

'''Discussion''': Blank fill. The (BF) control code replaces all characters from the cursor position to the end of the line with blanks. The current mode -- foreground, background, or invisible (suppressed background) -- determines the type of blank. When this control is complete, the cursor is positioned at the beginning of the next line (or the next available foreground position on the screen).

This control code may also include a positioning statement to start the fill operation from a specific point on the screen.
<pre>
Example:
a. 100 FORMAT (SB);(BF),@(10,0)
.
PRINT (0,100)
b. PRINT (0) (SB);(BF),@(10,0)
</pre>
This example sets the video mode to background (SB), and then blank fills the top row of the screen (i.e., row 0) from position 10 to the end of the line.

==(BIOS Mouse On)==

'''Mnemonic''': (BIOS Mouse On) Hex equivalent: "@0E0905@"

'''Discussion''': This control opens the BIOS mouse driver (if possible). Also see [[#(Mouse On)]] and [[#(Enhanced Mouse On)]].
<pre>
Example:
a. 100 FORMAT (BIOS Mouse On)
.
PRINT (0,100
b. PRINT (0) (BIOS Mouse On
</pre>

==(BM)==
'''Mnemonic''': (BM) Hex equivalent: "@0405@"

'''Discussion''': Blind mode. The (BM) control code establishes "blind mode" -- an attribute where characters entered from the keyboard do not appear on the screen. Up to 32 characters can be entered with the video device in blind mode. This control code is typically used for entering invisible passwords.
<pre>
Example:
a. LENGTH 32 & LOCAL PASSWORD$
100 FORMAT (BM)
.
PRINT (0,100)
INPUT (0) PASSWORD$
b. LENGTH 32 & LOCAL PASSWORD$
.
PRINT (0) (BM)
INPUT (0) PASSWORD$
</pre>
This example shows how to set the blind mode input buffer. The (BM) control code is written and the data is entered into the variable named PASSWORD$. This data will not be visible on the screen as it is entered.

== (Blink) ==
<pre>
Note: As of Comet version 504, this mnemonic is no longer supported. Mnemonic: (Blink) Hex equivalent: "@0E0001@" Discussion: This mnemonic displays blinking characters on the Comet console. Blinking works only on "bright" characters that are defined as the "background color" of a field (i.e., the first character in the color definition). Blinking works on all of the "bright" characters on the screen, including foreground fields, background fields, invisible fields, and data entry fields. To blink all "bright" characters on the screen, use the following instruction:

PRINT (0) (Blink)

To display "bright" characters, and stop the blinking, use the following instruction:

PRINT (0) (Bright)

The 16 VGA colors are shown below, with the "bright" characters shown at the right-hand side:

Regular colors Bright colors (blinking works here)
==========================================================
0 black 8 gray
1 blue 9 light blue
2 green A light green
3 cyan B light cyan
4 red C light red
5 magenta D light magenta
6 brown E yellow
7 white F bright white
Examples:
Color Definition Will it blink?
==============================================================
17 blue background, white characters no
97 light blue background, white characters yes
1F blue background, bright white characters no
9F light blue background, bright white characters yes

Example: a. 100 FORMAT (Blink)

.
PRINT (0,100)
b. PRINT (0) (Blink)
</pre>

== (Bright) ==
<pre>
Note: As of Comet version 504, this mnemonic is no longer supported. Mnemonic: (Bright) Hex equivalent: "@0E0002@" Discussion: This mnemonic displays bright characters on the Comet console. Bright characters that are defined as the "background color" of a field (i.e., the first character in the color definition). To display "bright" characters, use the following instruction:

PRINT (0) (Bright)

Note: The (Bright) mnemonic also turns off blinking fields that have been previously set with the (Blink) mnemonic.

The 16 VGA colors are shown below, with the "bright" characters shown at the right-hand side:

Regular colors Bright colors
=========================================
0 black 8 gray
1 blue 9 light blue
2 green A light green
3 cyan B light cyan
4 red C light red
5 magenta D light magenta
6 brown E yellow
7 white F bright white

Example: a. 100 FORMAT (Bright)

.
PRINT (0,100)
b. PRINT (0) (Bright)
</pre>

Mnemonics "B"

2009-09-04T21:03:00Z

SteveA: /* (BM) */

==(BCC)==
'''Email Mnemonic''': (BCC=string-argument)

'''Discussion:''' The (BCC) mnemonic may be used to specify "blind carbon copy" recipients of your email message.
<pre>
Example: OPEN (1) "LEH" PRINT (1) (BCC="brian@@signature.net")
</pre>

== (Begin Metafile) ==
'''Mnemonic''': (BeginMetafile = FileName)

'''Discussion''': Initiates the collecting of GDI functions into a virtual memory block (Metafile) that is passed to COSW in a single write rather than one function at a time enhancing performance. If FileName is non-blank the file can be saved to disk and recalled at a later time (see [[#ExecuteMetafile]]).

Read about other Email Mnemonics

==(BeginWaitCursor)==
'''Mnemonic''': (BeginWaitCursor)

'''Discussion''': This mnemonic turns on the hourglass cursor. See [[#(EndWaitCursor)]] and [[#(RestoreWaitCursor)]].
<pre>
Example:
Print (BeginWaitCursor) . . .
Print (EndWaitCursor)
</pre>

==(BF)==

'''Mnemonic''': (BF) Hex equivalent: "@0406@"

'''Discussion''': Blank fill. The (BF) control code replaces all characters from the cursor position to the end of the line with blanks. The current mode -- foreground, background, or invisible (suppressed background) -- determines the type of blank. When this control is complete, the cursor is positioned at the beginning of the next line (or the next available foreground position on the screen).

This control code may also include a positioning statement to start the fill operation from a specific point on the screen.
<pre>
Example:
a. 100 FORMAT (SB);(BF),@(10,0)
.
PRINT (0,100)
b. PRINT (0) (SB);(BF),@(10,0)
</pre>
This example sets the video mode to background (SB), and then blank fills the top row of the screen (i.e., row 0) from position 10 to the end of the line.

==(BIOS Mouse On)==

'''Mnemonic''': (BIOS Mouse On) Hex equivalent: "@0E0905@"

'''Discussion''': This control opens the BIOS mouse driver (if possible). Also see [[#(Mouse On)]] and [[#(Enhanced Mouse On)]].
<pre>
Example:
a. 100 FORMAT (BIOS Mouse On)
.
PRINT (0,100
b. PRINT (0) (BIOS Mouse On
</pre>

==(BF)==

'''Mnemonic''': (BF) Hex equivalent: "@0406@"

'''Discussion''': Blank fill. The (BF) control code replaces all characters from the cursor position to the end of the line with blanks. The current mode -- foreground, background, or invisible (suppressed background) -- determines the type of blank. When this control is complete, the cursor is positioned at the beginning of the next line (or the next available foreground position on the screen).

This control code may also include a positioning statement to start the fill operation from a specific point on the screen.
<pre>
Example:
a. 100 FORMAT (SB);(BF),@(10,0)
.
PRINT (0,100)
b. PRINT (0) (SB);(BF),@(10,0)
</pre>
This example sets the video mode to background (SB), and then blank fills the top row of the screen (i.e., row 0) from position 10 to the end of the line.

==(BM)==
'''Mnemonic''': (BM) Hex equivalent: "@0405@"

'''Discussion''': Blind mode. The (BM) control code establishes "blind mode" -- an attribute where characters entered from the keyboard do not appear on the screen. Up to 32 characters can be entered with the video device in blind mode. This control code is typically used for entering invisible passwords.
<pre>
Example:
a. LENGTH 32 & LOCAL PASSWORD$
100 FORMAT (BM)
.
PRINT (0,100)
INPUT (0) PASSWORD$
b. LENGTH 32 & LOCAL PASSWORD$
.
PRINT (0) (BM)
INPUT (0) PASSWORD$
</pre>
This example shows how to set the blind mode input buffer. The (BM) control code is written and the data is entered into the variable named PASSWORD$. This data will not be visible on the screen as it is entered.

== (Blink) ==
<pre>
Note: As of Comet version 504, this mnemonic is no longer supported. Mnemonic: (Blink) Hex equivalent: "@0E0001@" Discussion: This mnemonic displays blinking characters on the Comet console. Blinking works only on "bright" characters that are defined as the "background color" of a field (i.e., the first character in the color definition). Blinking works on all of the "bright" characters on the screen, including foreground fields, background fields, invisible fields, and data entry fields. To blink all "bright" characters on the screen, use the following instruction:

PRINT (0) (Blink)

To display "bright" characters, and stop the blinking, use the following instruction:

PRINT (0) (Bright)

The 16 VGA colors are shown below, with the "bright" characters shown at the right-hand side:

Regular colors Bright colors (blinking works here)
==========================================================
0 black 8 gray
1 blue 9 light blue
2 green A light green
3 cyan B light cyan
4 red C light red
5 magenta D light magenta
6 brown E yellow
7 white F bright white
Examples:
Color Definition Will it blink?
==============================================================
17 blue background, white characters no
97 light blue background, white characters yes
1F blue background, bright white characters no
9F light blue background, bright white characters yes

Example: a. 100 FORMAT (Blink)

.
PRINT (0,100)
b. PRINT (0) (Blink)
</pre>

== (Bright) ==
<pre>
Note: As of Comet version 504, this mnemonic is no longer supported. Mnemonic: (Bright) Hex equivalent: "@0E0002@" Discussion: This mnemonic displays bright characters on the Comet console. Bright characters that are defined as the "background color" of a field (i.e., the first character in the color definition). To display "bright" characters, use the following instruction:

PRINT (0) (Bright)

Note: The (Bright) mnemonic also turns off blinking fields that have been previously set with the (Blink) mnemonic.

The 16 VGA colors are shown below, with the "bright" characters shown at the right-hand side:

Regular colors Bright colors
=========================================
0 black 8 gray
1 blue 9 light blue
2 green A light green
3 cyan B light cyan
4 red C light red
5 magenta D light magenta
6 brown E yellow
7 white F bright white

Example: a. 100 FORMAT (Bright)

.
PRINT (0,100)
b. PRINT (0) (Bright)
</pre>

Mnemonics "B"

2009-09-04T21:01:48Z

SteveA: /* (BM) */

==(BCC)==
'''Email Mnemonic''': (BCC=string-argument)

'''Discussion:''' The (BCC) mnemonic may be used to specify "blind carbon copy" recipients of your email message.
<pre>
Example: OPEN (1) "LEH" PRINT (1) (BCC="brian@@signature.net")
</pre>

== (Begin Metafile) ==
'''Mnemonic''': (BeginMetafile = FileName)

'''Discussion''': Initiates the collecting of GDI functions into a virtual memory block (Metafile) that is passed to COSW in a single write rather than one function at a time enhancing performance. If FileName is non-blank the file can be saved to disk and recalled at a later time (see [[#ExecuteMetafile]]).

Read about other Email Mnemonics

==(BeginWaitCursor)==
'''Mnemonic''': (BeginWaitCursor)

'''Discussion''': This mnemonic turns on the hourglass cursor. See [[#(EndWaitCursor)]] and [[#(RestoreWaitCursor)]].
<pre>
Example:
Print (BeginWaitCursor) . . .
Print (EndWaitCursor)
</pre>

==(BF)==

'''Mnemonic''': (BF) Hex equivalent: "@0406@"

'''Discussion''': Blank fill. The (BF) control code replaces all characters from the cursor position to the end of the line with blanks. The current mode -- foreground, background, or invisible (suppressed background) -- determines the type of blank. When this control is complete, the cursor is positioned at the beginning of the next line (or the next available foreground position on the screen).

This control code may also include a positioning statement to start the fill operation from a specific point on the screen.
<pre>
Example:
a. 100 FORMAT (SB);(BF),@(10,0)
.
PRINT (0,100)
b. PRINT (0) (SB);(BF),@(10,0)
</pre>
This example sets the video mode to background (SB), and then blank fills the top row of the screen (i.e., row 0) from position 10 to the end of the line.

==(BIOS Mouse On)==

'''Mnemonic''': (BIOS Mouse On) Hex equivalent: "@0E0905@"

'''Discussion''': This control opens the BIOS mouse driver (if possible). Also see [[#(Mouse On)]] and [[#(Enhanced Mouse On)]].
<pre>
Example:
a. 100 FORMAT (BIOS Mouse On)
.
PRINT (0,100
b. PRINT (0) (BIOS Mouse On
</pre>

==(BF)==

'''Mnemonic''': (BF) Hex equivalent: "@0406@"

'''Discussion''': Blank fill. The (BF) control code replaces all characters from the cursor position to the end of the line with blanks. The current mode -- foreground, background, or invisible (suppressed background) -- determines the type of blank. When this control is complete, the cursor is positioned at the beginning of the next line (or the next available foreground position on the screen).

This control code may also include a positioning statement to start the fill operation from a specific point on the screen.
<pre>
Example:
a. 100 FORMAT (SB);(BF),@(10,0)
.
PRINT (0,100)
b. PRINT (0) (SB);(BF),@(10,0)
</pre>
This example sets the video mode to background (SB), and then blank fills the top row of the screen (i.e., row 0) from position 10 to the end of the line.

==(BM)==
'''Mnemonic''': (BM) Hex equivalent: "@0405@"

'''Discussion''': Blind mode. The (BM) control code establishes "blind mode" -- an attribute where characters entered from the keyboard do not appear on the screen. Up to 32 characters can be entered with the video device in blind mode. This control code is typically used for entering invisible passwords.
<pre>
Example:
a. LENGTH 32 & LOCAL PASSWORD$
100 FORMAT (BM)
.
PRINT (0,100)
INPUT (0) PASSWORD$
b. LENGTH 32 & LOCAL PASSWORD$
.
PRINT (0) (BM)
INPUT (0) PASSWORD$
</pre>
This example shows how to set the blind mode input buffer. The (BM) control code is written and the data is entered into the variable named PASSWORD$. This data will not be visible on the screen as it is entered.

== (Blink) ==
<pre>
Note: As of Comet version 504, this mnemonic is no longer supported. Mnemonic: (Blink) Hex equivalent: "@0E0001@" Discussion: This mnemonic displays blinking characters on the Comet console. Blinking works only on "bright" characters that are defined as the "background color" of a field (i.e., the first character in the color definition). Blinking works on all of the "bright" characters on the screen, including foreground fields, background fields, invisible fields, and data entry fields. To blink all "bright" characters on the screen, use the following instruction:

PRINT (0) (Blink)

To display "bright" characters, and stop the blinking, use the following instruction:

PRINT (0) (Bright)

The 16 VGA colors are shown below, with the "bright" characters shown at the right-hand side:

Regular colors Bright colors (blinking works here)
==========================================================
0 black 8 gray
1 blue 9 light blue
2 green A light green
3 cyan B light cyan
4 red C light red
5 magenta D light magenta
6 brown E yellow
7 white F bright white
Examples:
Color Definition Will it blink?
==============================================================
17 blue background, white characters no
97 light blue background, white characters yes
1F blue background, bright white characters no
9F light blue background, bright white characters yes

Example: a. 100 FORMAT (Blink)

.
PRINT (0,100)
b. PRINT (0) (Blink)
</pre>

==(BM)==
'''Mnemonic''': (BM) Hex equivalent: "@0405@"

'''Discussion''': Blind mode. The (BM) control code establishes "blind mode" -- an attribute where characters entered from the keyboard do not appear on the screen. Up to 32 characters can be entered with the video device in blind mode. This control code is typically used for entering invisible passwords.
<pre>
Example:
a. LENGTH 32 & LOCAL PASSWORD$
100 FORMAT (BM)
.
PRINT (0,100)
INPUT (0) PASSWORD$
b. LENGTH 32 & LOCAL PASSWORD$
.
PRINT (0) (BM)
INPUT (0) PASSWORD$
</pre>
This example shows how to set the blind mode input buffer. The (BM) control code is written and the data is entered into the variable named PASSWORD$. This data will not be visible on the screen as it is entered.

== (Bright) ==
<pre>
Note: As of Comet version 504, this mnemonic is no longer supported. Mnemonic: (Bright) Hex equivalent: "@0E0002@" Discussion: This mnemonic displays bright characters on the Comet console. Bright characters that are defined as the "background color" of a field (i.e., the first character in the color definition). To display "bright" characters, use the following instruction:

PRINT (0) (Bright)

Note: The (Bright) mnemonic also turns off blinking fields that have been previously set with the (Blink) mnemonic.

The 16 VGA colors are shown below, with the "bright" characters shown at the right-hand side:

Regular colors Bright colors
=========================================
0 black 8 gray
1 blue 9 light blue
2 green A light green
3 cyan B light cyan
4 red C light red
5 magenta D light magenta
6 brown E yellow
7 white F bright white

Example: a. 100 FORMAT (Bright)

.
PRINT (0,100)
b. PRINT (0) (Bright)
</pre>

Mnemonics "B"

2009-09-04T21:00:04Z

SteveA: /* (BM) */

==(BCC)==
'''Email Mnemonic''': (BCC=string-argument)

'''Discussion:''' The (BCC) mnemonic may be used to specify "blind carbon copy" recipients of your email message.
<pre>
Example: OPEN (1) "LEH" PRINT (1) (BCC="brian@@signature.net")
</pre>

== (Begin Metafile) ==
'''Mnemonic''': (BeginMetafile = FileName)

'''Discussion''': Initiates the collecting of GDI functions into a virtual memory block (Metafile) that is passed to COSW in a single write rather than one function at a time enhancing performance. If FileName is non-blank the file can be saved to disk and recalled at a later time (see [[#ExecuteMetafile]]).

Read about other Email Mnemonics

==(BeginWaitCursor)==
'''Mnemonic''': (BeginWaitCursor)

'''Discussion''': This mnemonic turns on the hourglass cursor. See [[#(EndWaitCursor)]] and [[#(RestoreWaitCursor)]].
<pre>
Example:
Print (BeginWaitCursor) . . .
Print (EndWaitCursor)
</pre>

==(BF)==

'''Mnemonic''': (BF) Hex equivalent: "@0406@"

'''Discussion''': Blank fill. The (BF) control code replaces all characters from the cursor position to the end of the line with blanks. The current mode -- foreground, background, or invisible (suppressed background) -- determines the type of blank. When this control is complete, the cursor is positioned at the beginning of the next line (or the next available foreground position on the screen).

This control code may also include a positioning statement to start the fill operation from a specific point on the screen.
<pre>
Example:
a. 100 FORMAT (SB);(BF),@(10,0)
.
PRINT (0,100)
b. PRINT (0) (SB);(BF),@(10,0)
</pre>
This example sets the video mode to background (SB), and then blank fills the top row of the screen (i.e., row 0) from position 10 to the end of the line.

==(BIOS Mouse On)==

'''Mnemonic''': (BIOS Mouse On) Hex equivalent: "@0E0905@"

'''Discussion''': This control opens the BIOS mouse driver (if possible). Also see [[#(Mouse On)]] and [[#(Enhanced Mouse On)]].
<pre>
Example:
a. 100 FORMAT (BIOS Mouse On)
.
PRINT (0,100
b. PRINT (0) (BIOS Mouse On
</pre>

==(BF)==

'''Mnemonic''': (BF) Hex equivalent: "@0406@"

'''Discussion''': Blank fill. The (BF) control code replaces all characters from the cursor position to the end of the line with blanks. The current mode -- foreground, background, or invisible (suppressed background) -- determines the type of blank. When this control is complete, the cursor is positioned at the beginning of the next line (or the next available foreground position on the screen).

This control code may also include a positioning statement to start the fill operation from a specific point on the screen.
<pre>
Example:
a. 100 FORMAT (SB);(BF),@(10,0)
.
PRINT (0,100)
b. PRINT (0) (SB);(BF),@(10,0)
</pre>
This example sets the video mode to background (SB), and then blank fills the top row of the screen (i.e., row 0) from position 10 to the end of the line.

==(BM)==
'''Mnemonic''': (BM) Hex equivalent: "@0405@"

'''Discussion''': Blind mode. The (BM) control code establishes "blind mode" -- an attribute where characters entered from the keyboard do not appear on the screen. Up to 32 characters can be entered with the video device in blind mode. This control code is typically used for entering invisible passwords.
<pre>
Example:
a. LENGTH 32 & LOCAL PASSWORD$
100 FORMAT (BM)
.
PRINT (0,100)
INPUT (0) PASSWORD$
b. LENGTH 32 & LOCAL PASSWORD$
.
PRINT (0) (BM)
INPUT (0) PASSWORD$
</pre>
This example shows how to set the blind mode input buffer. The (BM) control code is written and the data is entered into the variable named PASSWORD$. This data will not be visible on the screen as it is entered.

== (Blink) ==
<pre>
Note: As of Comet version 504, this mnemonic is no longer supported. Mnemonic: (Blink) Hex equivalent: "@0E0001@" Discussion: This mnemonic displays blinking characters on the Comet console. Blinking works only on "bright" characters that are defined as the "background color" of a field (i.e., the first character in the color definition). Blinking works on all of the "bright" characters on the screen, including foreground fields, background fields, invisible fields, and data entry fields. To blink all "bright" characters on the screen, use the following instruction:

PRINT (0) (Blink)

To display "bright" characters, and stop the blinking, use the following instruction:

PRINT (0) (Bright)

The 16 VGA colors are shown below, with the "bright" characters shown at the right-hand side:

Regular colors Bright colors (blinking works here)
==========================================================
0 black 8 gray
1 blue 9 light blue
2 green A light green
3 cyan B light cyan
4 red C light red
5 magenta D light magenta
6 brown E yellow
7 white F bright white
Examples:
Color Definition Will it blink?
==============================================================
17 blue background, white characters no
97 light blue background, white characters yes
1F blue background, bright white characters no
9F light blue background, bright white characters yes

Example: a. 100 FORMAT (Blink)

.
PRINT (0,100)
b. PRINT (0) (Blink)
</pre>

== (BM) ==
<pre>
Mnemonic: (BM) Hex equivalent: "@0405@" Discussion: Blind mode. The (BM) control code establishes "blind mode" -- an attribute where characters entered from the keyboard do not appear on the screen. Up to 32 characters can be entered with the video device in blind mode. This control code is typically used for entering invisible passwords.

Example: a. LENGTH 32 & LOCAL PASSWORD$

100 FORMAT (BM)
.
PRINT (0,100)
INPUT (0) PASSWORD$
b. LENGTH 32 & LOCAL PASSWORD$

.
PRINT (0) (BM)
INPUT (0) PASSWORD$
This example shows how to set the blind mode input buffer. The (BM) control code is written and the data is entered into the variable named PASSWORD$. This data will not be visible on the screen as it is entered.
</pre>
== (Bright) ==
<pre>
Note: As of Comet version 504, this mnemonic is no longer supported. Mnemonic: (Bright) Hex equivalent: "@0E0002@" Discussion: This mnemonic displays bright characters on the Comet console. Bright characters that are defined as the "background color" of a field (i.e., the first character in the color definition). To display "bright" characters, use the following instruction:

PRINT (0) (Bright)

Note: The (Bright) mnemonic also turns off blinking fields that have been previously set with the (Blink) mnemonic.

The 16 VGA colors are shown below, with the "bright" characters shown at the right-hand side:

Regular colors Bright colors
=========================================
0 black 8 gray
1 blue 9 light blue
2 green A light green
3 cyan B light cyan
4 red C light red
5 magenta D light magenta
6 brown E yellow
7 white F bright white

Example: a. 100 FORMAT (Bright)

.
PRINT (0,100)
b. PRINT (0) (Bright)
</pre>

Mnemonics "B"

2009-09-04T20:58:36Z

SteveA: /* (BF) */

==(BCC)==
'''Email Mnemonic''': (BCC=string-argument)

'''Discussion:''' The (BCC) mnemonic may be used to specify "blind carbon copy" recipients of your email message.
<pre>
Example: OPEN (1) "LEH" PRINT (1) (BCC="brian@@signature.net")
</pre>

== (Begin Metafile) ==
'''Mnemonic''': (BeginMetafile = FileName)

'''Discussion''': Initiates the collecting of GDI functions into a virtual memory block (Metafile) that is passed to COSW in a single write rather than one function at a time enhancing performance. If FileName is non-blank the file can be saved to disk and recalled at a later time (see [[#ExecuteMetafile]]).

Read about other Email Mnemonics

==(BeginWaitCursor)==
'''Mnemonic''': (BeginWaitCursor)

'''Discussion''': This mnemonic turns on the hourglass cursor. See [[#(EndWaitCursor)]] and [[#(RestoreWaitCursor)]].
<pre>
Example:
Print (BeginWaitCursor) . . .
Print (EndWaitCursor)
</pre>

==(BF)==

'''Mnemonic''': (BF) Hex equivalent: "@0406@"

'''Discussion''': Blank fill. The (BF) control code replaces all characters from the cursor position to the end of the line with blanks. The current mode -- foreground, background, or invisible (suppressed background) -- determines the type of blank. When this control is complete, the cursor is positioned at the beginning of the next line (or the next available foreground position on the screen).

This control code may also include a positioning statement to start the fill operation from a specific point on the screen.
<pre>
Example:
a. 100 FORMAT (SB);(BF),@(10,0)
.
PRINT (0,100)
b. PRINT (0) (SB);(BF),@(10,0)
</pre>
This example sets the video mode to background (SB), and then blank fills the top row of the screen (i.e., row 0) from position 10 to the end of the line.

==(BIOS Mouse On)==

'''Mnemonic''': (BIOS Mouse On) Hex equivalent: "@0E0905@"

'''Discussion''': This control opens the BIOS mouse driver (if possible). Also see [[#(Mouse On)]] and [[#(Enhanced Mouse On)]].
<pre>
Example:
a. 100 FORMAT (BIOS Mouse On)
.
PRINT (0,100
b. PRINT (0) (BIOS Mouse On
</pre>

==(BF)==

'''Mnemonic''': (BF) Hex equivalent: "@0406@"

'''Discussion''': Blank fill. The (BF) control code replaces all characters from the cursor position to the end of the line with blanks. The current mode -- foreground, background, or invisible (suppressed background) -- determines the type of blank. When this control is complete, the cursor is positioned at the beginning of the next line (or the next available foreground position on the screen).

This control code may also include a positioning statement to start the fill operation from a specific point on the screen.
<pre>
Example:
a. 100 FORMAT (SB);(BF),@(10,0)
.
PRINT (0,100)
b. PRINT (0) (SB);(BF),@(10,0)
</pre>
This example sets the video mode to background (SB), and then blank fills the top row of the screen (i.e., row 0) from position 10 to the end of the line.

== (BM) ==
<pre>

Mnemonic: (BM) Hex equivalent: "@0405@" Discussion: Blind mode. The (BM) control code establishes "blind mode" -- an attribute where characters entered from the keyboard do not appear on the screen. Up to 32 characters can be entered with the video device in blind mode. This control code is typically used for entering invisible passwords.

Example: a. LENGTH 32 & LOCAL PASSWORD$

100 FORMAT (BM)
.
PRINT (0,100)
INPUT (0) PASSWORD$
b. LENGTH 32 & LOCAL PASSWORD$

.
PRINT (0) (BM)
INPUT (0) PASSWORD$
This example shows how to set the blind mode input buffer. The (BM) control code is written and the data is entered into the variable named PASSWORD$. This data will not be visible on the screen as it is entered.
</pre>
== (Blink) ==
<pre>
Note: As of Comet version 504, this mnemonic is no longer supported. Mnemonic: (Blink) Hex equivalent: "@0E0001@" Discussion: This mnemonic displays blinking characters on the Comet console. Blinking works only on "bright" characters that are defined as the "background color" of a field (i.e., the first character in the color definition). Blinking works on all of the "bright" characters on the screen, including foreground fields, background fields, invisible fields, and data entry fields. To blink all "bright" characters on the screen, use the following instruction:

PRINT (0) (Blink)

To display "bright" characters, and stop the blinking, use the following instruction:

PRINT (0) (Bright)

The 16 VGA colors are shown below, with the "bright" characters shown at the right-hand side:

Regular colors Bright colors (blinking works here)
==========================================================
0 black 8 gray
1 blue 9 light blue
2 green A light green
3 cyan B light cyan
4 red C light red
5 magenta D light magenta
6 brown E yellow
7 white F bright white
Examples:
Color Definition Will it blink?
==============================================================
17 blue background, white characters no
97 light blue background, white characters yes
1F blue background, bright white characters no
9F light blue background, bright white characters yes

Example: a. 100 FORMAT (Blink)

.
PRINT (0,100)
b. PRINT (0) (Blink)
</pre>

== (BM) ==
<pre>
Mnemonic: (BM) Hex equivalent: "@0405@" Discussion: Blind mode. The (BM) control code establishes "blind mode" -- an attribute where characters entered from the keyboard do not appear on the screen. Up to 32 characters can be entered with the video device in blind mode. This control code is typically used for entering invisible passwords.

Example: a. LENGTH 32 & LOCAL PASSWORD$

100 FORMAT (BM)
.
PRINT (0,100)
INPUT (0) PASSWORD$
b. LENGTH 32 & LOCAL PASSWORD$

.
PRINT (0) (BM)
INPUT (0) PASSWORD$
This example shows how to set the blind mode input buffer. The (BM) control code is written and the data is entered into the variable named PASSWORD$. This data will not be visible on the screen as it is entered.
</pre>
== (Bright) ==
<pre>
Note: As of Comet version 504, this mnemonic is no longer supported. Mnemonic: (Bright) Hex equivalent: "@0E0002@" Discussion: This mnemonic displays bright characters on the Comet console. Bright characters that are defined as the "background color" of a field (i.e., the first character in the color definition). To display "bright" characters, use the following instruction:

PRINT (0) (Bright)

Note: The (Bright) mnemonic also turns off blinking fields that have been previously set with the (Blink) mnemonic.

The 16 VGA colors are shown below, with the "bright" characters shown at the right-hand side:

Regular colors Bright colors
=========================================
0 black 8 gray
1 blue 9 light blue
2 green A light green
3 cyan B light cyan
4 red C light red
5 magenta D light magenta
6 brown E yellow
7 white F bright white

Example: a. 100 FORMAT (Bright)

.
PRINT (0,100)
b. PRINT (0) (Bright)
</pre>

Mnemonics "B"

2009-09-04T20:57:30Z

SteveA: /* (BIOS Mouse On) */

==(BCC)==
'''Email Mnemonic''': (BCC=string-argument)

'''Discussion:''' The (BCC) mnemonic may be used to specify "blind carbon copy" recipients of your email message.
<pre>
Example: OPEN (1) "LEH" PRINT (1) (BCC="brian@@signature.net")
</pre>

== (Begin Metafile) ==
'''Mnemonic''': (BeginMetafile = FileName)

'''Discussion''': Initiates the collecting of GDI functions into a virtual memory block (Metafile) that is passed to COSW in a single write rather than one function at a time enhancing performance. If FileName is non-blank the file can be saved to disk and recalled at a later time (see [[#ExecuteMetafile]]).

Read about other Email Mnemonics

==(BeginWaitCursor)==
'''Mnemonic''': (BeginWaitCursor)

'''Discussion''': This mnemonic turns on the hourglass cursor. See [[#(EndWaitCursor)]] and [[#(RestoreWaitCursor)]].
<pre>
Example:
Print (BeginWaitCursor) . . .
Print (EndWaitCursor)
</pre>

==(BF)==

'''Mnemonic''': (BF) Hex equivalent: "@0406@"

'''Discussion''': Blank fill. The (BF) control code replaces all characters from the cursor position to the end of the line with blanks. The current mode -- foreground, background, or invisible (suppressed background) -- determines the type of blank. When this control is complete, the cursor is positioned at the beginning of the next line (or the next available foreground position on the screen).

This control code may also include a positioning statement to start the fill operation from a specific point on the screen.
<pre>
Example:
a. 100 FORMAT (SB);(BF),@(10,0)
.
PRINT (0,100)
b. PRINT (0) (SB);(BF),@(10,0)
</pre>
This example sets the video mode to background (SB), and then blank fills the top row of the screen (i.e., row 0) from position 10 to the end of the line.

==(BIOS Mouse On)==

'''Mnemonic''': (BIOS Mouse On) Hex equivalent: "@0E0905@"

'''Discussion''': This control opens the BIOS mouse driver (if possible). Also see [[#(Mouse On)]] and [[#(Enhanced Mouse On)]].
<pre>
Example:
a. 100 FORMAT (BIOS Mouse On)
.
PRINT (0,100
b. PRINT (0) (BIOS Mouse On
</pre>

== (BF) ==
<pre>
Mnemonic: (BF) Hex equivalent: "@0406@" Discussion: Blank fill. The (BF) control code replaces all characters from the cursor position to the end of the line with blanks. The current mode -- foreground, background, or invisible (suppressed background) -- determines the type of blank. When this control is complete, the cursor is positioned at the beginning of the next line (or the next available foreground position on the screen).

This control code may also include a positioning statement to start the fill operation from a specific point on the screen.

Example: a. 100 FORMAT (SB);(BF),@(10,0)

.
PRINT (0,100)
b. PRINT (0) (SB);(BF),@(10,0)

This example sets the video mode to background (SB), and then blank fills the top row of the screen (i.e., row 0) from position 10 to the end of the line.

</pre>
== (BM) ==
<pre>

Mnemonic: (BM) Hex equivalent: "@0405@" Discussion: Blind mode. The (BM) control code establishes "blind mode" -- an attribute where characters entered from the keyboard do not appear on the screen. Up to 32 characters can be entered with the video device in blind mode. This control code is typically used for entering invisible passwords.

Example: a. LENGTH 32 & LOCAL PASSWORD$

100 FORMAT (BM)
.
PRINT (0,100)
INPUT (0) PASSWORD$
b. LENGTH 32 & LOCAL PASSWORD$

.
PRINT (0) (BM)
INPUT (0) PASSWORD$
This example shows how to set the blind mode input buffer. The (BM) control code is written and the data is entered into the variable named PASSWORD$. This data will not be visible on the screen as it is entered.
</pre>
== (Blink) ==
<pre>
Note: As of Comet version 504, this mnemonic is no longer supported. Mnemonic: (Blink) Hex equivalent: "@0E0001@" Discussion: This mnemonic displays blinking characters on the Comet console. Blinking works only on "bright" characters that are defined as the "background color" of a field (i.e., the first character in the color definition). Blinking works on all of the "bright" characters on the screen, including foreground fields, background fields, invisible fields, and data entry fields. To blink all "bright" characters on the screen, use the following instruction:

PRINT (0) (Blink)

To display "bright" characters, and stop the blinking, use the following instruction:

PRINT (0) (Bright)

The 16 VGA colors are shown below, with the "bright" characters shown at the right-hand side:

Regular colors Bright colors (blinking works here)
==========================================================
0 black 8 gray
1 blue 9 light blue
2 green A light green
3 cyan B light cyan
4 red C light red
5 magenta D light magenta
6 brown E yellow
7 white F bright white
Examples:
Color Definition Will it blink?
==============================================================
17 blue background, white characters no
97 light blue background, white characters yes
1F blue background, bright white characters no
9F light blue background, bright white characters yes

Example: a. 100 FORMAT (Blink)

.
PRINT (0,100)
b. PRINT (0) (Blink)
</pre>

== (BM) ==
<pre>
Mnemonic: (BM) Hex equivalent: "@0405@" Discussion: Blind mode. The (BM) control code establishes "blind mode" -- an attribute where characters entered from the keyboard do not appear on the screen. Up to 32 characters can be entered with the video device in blind mode. This control code is typically used for entering invisible passwords.

Example: a. LENGTH 32 & LOCAL PASSWORD$

100 FORMAT (BM)
.
PRINT (0,100)
INPUT (0) PASSWORD$
b. LENGTH 32 & LOCAL PASSWORD$

.
PRINT (0) (BM)
INPUT (0) PASSWORD$
This example shows how to set the blind mode input buffer. The (BM) control code is written and the data is entered into the variable named PASSWORD$. This data will not be visible on the screen as it is entered.
</pre>
== (Bright) ==
<pre>
Note: As of Comet version 504, this mnemonic is no longer supported. Mnemonic: (Bright) Hex equivalent: "@0E0002@" Discussion: This mnemonic displays bright characters on the Comet console. Bright characters that are defined as the "background color" of a field (i.e., the first character in the color definition). To display "bright" characters, use the following instruction:

PRINT (0) (Bright)

Note: The (Bright) mnemonic also turns off blinking fields that have been previously set with the (Blink) mnemonic.

The 16 VGA colors are shown below, with the "bright" characters shown at the right-hand side:

Regular colors Bright colors
=========================================
0 black 8 gray
1 blue 9 light blue
2 green A light green
3 cyan B light cyan
4 red C light red
5 magenta D light magenta
6 brown E yellow
7 white F bright white

Example: a. 100 FORMAT (Bright)

.
PRINT (0,100)
b. PRINT (0) (Bright)
</pre>

Mnemonics "B"

2009-09-04T20:56:04Z

SteveA: /* (BF) */

==(BCC)==
'''Email Mnemonic''': (BCC=string-argument)

'''Discussion:''' The (BCC) mnemonic may be used to specify "blind carbon copy" recipients of your email message.
<pre>
Example: OPEN (1) "LEH" PRINT (1) (BCC="brian@@signature.net")
</pre>

== (Begin Metafile) ==
'''Mnemonic''': (BeginMetafile = FileName)

'''Discussion''': Initiates the collecting of GDI functions into a virtual memory block (Metafile) that is passed to COSW in a single write rather than one function at a time enhancing performance. If FileName is non-blank the file can be saved to disk and recalled at a later time (see [[#ExecuteMetafile]]).

Read about other Email Mnemonics

==(BeginWaitCursor)==
'''Mnemonic''': (BeginWaitCursor)

'''Discussion''': This mnemonic turns on the hourglass cursor. See [[#(EndWaitCursor)]] and [[#(RestoreWaitCursor)]].
<pre>
Example:
Print (BeginWaitCursor) . . .
Print (EndWaitCursor)
</pre>

==(BF)==

'''Mnemonic''': (BF) Hex equivalent: "@0406@"

'''Discussion''': Blank fill. The (BF) control code replaces all characters from the cursor position to the end of the line with blanks. The current mode -- foreground, background, or invisible (suppressed background) -- determines the type of blank. When this control is complete, the cursor is positioned at the beginning of the next line (or the next available foreground position on the screen).

This control code may also include a positioning statement to start the fill operation from a specific point on the screen.
<pre>
Example:
a. 100 FORMAT (SB);(BF),@(10,0)
.
PRINT (0,100)
b. PRINT (0) (SB);(BF),@(10,0)
</pre>
This example sets the video mode to background (SB), and then blank fills the top row of the screen (i.e., row 0) from position 10 to the end of the line.

== (BIOS Mouse On) ==
<pre>
Mnemonic: (BIOS Mouse On) Hex equivalent: "@0E0905@" Discussion: This control opens the BIOS mouse driver (if possible). Also see (Mouse On) and (Enhanced Mouse On).

Example: a. 100 FORMAT (BIOS Mouse On)

.
PRINT (0,100
b. PRINT (0) (BIOS Mouse On

</pre>
== (BF) ==
<pre>
Mnemonic: (BF) Hex equivalent: "@0406@" Discussion: Blank fill. The (BF) control code replaces all characters from the cursor position to the end of the line with blanks. The current mode -- foreground, background, or invisible (suppressed background) -- determines the type of blank. When this control is complete, the cursor is positioned at the beginning of the next line (or the next available foreground position on the screen).

This control code may also include a positioning statement to start the fill operation from a specific point on the screen.

Example: a. 100 FORMAT (SB);(BF),@(10,0)

.
PRINT (0,100)
b. PRINT (0) (SB);(BF),@(10,0)

This example sets the video mode to background (SB), and then blank fills the top row of the screen (i.e., row 0) from position 10 to the end of the line.

</pre>
== (BM) ==
<pre>

Mnemonic: (BM) Hex equivalent: "@0405@" Discussion: Blind mode. The (BM) control code establishes "blind mode" -- an attribute where characters entered from the keyboard do not appear on the screen. Up to 32 characters can be entered with the video device in blind mode. This control code is typically used for entering invisible passwords.

Example: a. LENGTH 32 & LOCAL PASSWORD$

100 FORMAT (BM)
.
PRINT (0,100)
INPUT (0) PASSWORD$
b. LENGTH 32 & LOCAL PASSWORD$

.
PRINT (0) (BM)
INPUT (0) PASSWORD$
This example shows how to set the blind mode input buffer. The (BM) control code is written and the data is entered into the variable named PASSWORD$. This data will not be visible on the screen as it is entered.
</pre>
== (Blink) ==
<pre>
Note: As of Comet version 504, this mnemonic is no longer supported. Mnemonic: (Blink) Hex equivalent: "@0E0001@" Discussion: This mnemonic displays blinking characters on the Comet console. Blinking works only on "bright" characters that are defined as the "background color" of a field (i.e., the first character in the color definition). Blinking works on all of the "bright" characters on the screen, including foreground fields, background fields, invisible fields, and data entry fields. To blink all "bright" characters on the screen, use the following instruction:

PRINT (0) (Blink)

To display "bright" characters, and stop the blinking, use the following instruction:

PRINT (0) (Bright)

The 16 VGA colors are shown below, with the "bright" characters shown at the right-hand side:

Regular colors Bright colors (blinking works here)
==========================================================
0 black 8 gray
1 blue 9 light blue
2 green A light green
3 cyan B light cyan
4 red C light red
5 magenta D light magenta
6 brown E yellow
7 white F bright white
Examples:
Color Definition Will it blink?
==============================================================
17 blue background, white characters no
97 light blue background, white characters yes
1F blue background, bright white characters no
9F light blue background, bright white characters yes

Example: a. 100 FORMAT (Blink)

.
PRINT (0,100)
b. PRINT (0) (Blink)
</pre>

== (BM) ==
<pre>
Mnemonic: (BM) Hex equivalent: "@0405@" Discussion: Blind mode. The (BM) control code establishes "blind mode" -- an attribute where characters entered from the keyboard do not appear on the screen. Up to 32 characters can be entered with the video device in blind mode. This control code is typically used for entering invisible passwords.

Example: a. LENGTH 32 & LOCAL PASSWORD$

100 FORMAT (BM)
.
PRINT (0,100)
INPUT (0) PASSWORD$
b. LENGTH 32 & LOCAL PASSWORD$

.
PRINT (0) (BM)
INPUT (0) PASSWORD$
This example shows how to set the blind mode input buffer. The (BM) control code is written and the data is entered into the variable named PASSWORD$. This data will not be visible on the screen as it is entered.
</pre>
== (Bright) ==
<pre>
Note: As of Comet version 504, this mnemonic is no longer supported. Mnemonic: (Bright) Hex equivalent: "@0E0002@" Discussion: This mnemonic displays bright characters on the Comet console. Bright characters that are defined as the "background color" of a field (i.e., the first character in the color definition). To display "bright" characters, use the following instruction:

PRINT (0) (Bright)

Note: The (Bright) mnemonic also turns off blinking fields that have been previously set with the (Blink) mnemonic.

The 16 VGA colors are shown below, with the "bright" characters shown at the right-hand side:

Regular colors Bright colors
=========================================
0 black 8 gray
1 blue 9 light blue
2 green A light green
3 cyan B light cyan
4 red C light red
5 magenta D light magenta
6 brown E yellow
7 white F bright white

Example: a. 100 FORMAT (Bright)

.
PRINT (0,100)
b. PRINT (0) (Bright)
</pre>

Mnemonics "B"

2009-09-04T20:54:45Z

SteveA: /* (BeginWaitCursor) */

==(BCC)==
'''Email Mnemonic''': (BCC=string-argument)

'''Discussion:''' The (BCC) mnemonic may be used to specify "blind carbon copy" recipients of your email message.
<pre>
Example: OPEN (1) "LEH" PRINT (1) (BCC="brian@@signature.net")
</pre>

== (Begin Metafile) ==
'''Mnemonic''': (BeginMetafile = FileName)

'''Discussion''': Initiates the collecting of GDI functions into a virtual memory block (Metafile) that is passed to COSW in a single write rather than one function at a time enhancing performance. If FileName is non-blank the file can be saved to disk and recalled at a later time (see [[#ExecuteMetafile]]).

Read about other Email Mnemonics

==(BeginWaitCursor)==
'''Mnemonic''': (BeginWaitCursor)

'''Discussion''': This mnemonic turns on the hourglass cursor. See [[#(EndWaitCursor)]] and [[#(RestoreWaitCursor)]].
<pre>
Example:
Print (BeginWaitCursor) . . .
Print (EndWaitCursor)
</pre>

== (BF) ==
<pre>
Mnemonic: (BF) Hex equivalent: "@0406@" Discussion: Blank fill. The (BF) control code replaces all characters from the cursor position to the end of the line with blanks. The current mode -- foreground, background, or invisible (suppressed background) -- determines the type of blank. When this control is complete, the cursor is positioned at the beginning of the next line (or the next available foreground position on the screen).

This control code may also include a positioning statement to start the fill operation from a specific point on the screen.

Example: a. 100 FORMAT (SB);(BF),@(10,0)

.
PRINT (0,100)
b. PRINT (0) (SB);(BF),@(10,0)

This example sets the video mode to background (SB), and then blank fills the top row of the screen (i.e., row 0) from position 10 to the end of the line.

</pre>
== (BIOS Mouse On) ==
<pre>
Mnemonic: (BIOS Mouse On) Hex equivalent: "@0E0905@" Discussion: This control opens the BIOS mouse driver (if possible). Also see (Mouse On) and (Enhanced Mouse On).

Example: a. 100 FORMAT (BIOS Mouse On)

.
PRINT (0,100
b. PRINT (0) (BIOS Mouse On

</pre>
== (BF) ==
<pre>
Mnemonic: (BF) Hex equivalent: "@0406@" Discussion: Blank fill. The (BF) control code replaces all characters from the cursor position to the end of the line with blanks. The current mode -- foreground, background, or invisible (suppressed background) -- determines the type of blank. When this control is complete, the cursor is positioned at the beginning of the next line (or the next available foreground position on the screen).

This control code may also include a positioning statement to start the fill operation from a specific point on the screen.

Example: a. 100 FORMAT (SB);(BF),@(10,0)

.
PRINT (0,100)
b. PRINT (0) (SB);(BF),@(10,0)

This example sets the video mode to background (SB), and then blank fills the top row of the screen (i.e., row 0) from position 10 to the end of the line.

</pre>
== (BM) ==
<pre>

Mnemonic: (BM) Hex equivalent: "@0405@" Discussion: Blind mode. The (BM) control code establishes "blind mode" -- an attribute where characters entered from the keyboard do not appear on the screen. Up to 32 characters can be entered with the video device in blind mode. This control code is typically used for entering invisible passwords.

Example: a. LENGTH 32 & LOCAL PASSWORD$

100 FORMAT (BM)
.
PRINT (0,100)
INPUT (0) PASSWORD$
b. LENGTH 32 & LOCAL PASSWORD$

.
PRINT (0) (BM)
INPUT (0) PASSWORD$
This example shows how to set the blind mode input buffer. The (BM) control code is written and the data is entered into the variable named PASSWORD$. This data will not be visible on the screen as it is entered.
</pre>
== (Blink) ==
<pre>
Note: As of Comet version 504, this mnemonic is no longer supported. Mnemonic: (Blink) Hex equivalent: "@0E0001@" Discussion: This mnemonic displays blinking characters on the Comet console. Blinking works only on "bright" characters that are defined as the "background color" of a field (i.e., the first character in the color definition). Blinking works on all of the "bright" characters on the screen, including foreground fields, background fields, invisible fields, and data entry fields. To blink all "bright" characters on the screen, use the following instruction:

PRINT (0) (Blink)

To display "bright" characters, and stop the blinking, use the following instruction:

PRINT (0) (Bright)

The 16 VGA colors are shown below, with the "bright" characters shown at the right-hand side:

Regular colors Bright colors (blinking works here)
==========================================================
0 black 8 gray
1 blue 9 light blue
2 green A light green
3 cyan B light cyan
4 red C light red
5 magenta D light magenta
6 brown E yellow
7 white F bright white
Examples:
Color Definition Will it blink?
==============================================================
17 blue background, white characters no
97 light blue background, white characters yes
1F blue background, bright white characters no
9F light blue background, bright white characters yes

Example: a. 100 FORMAT (Blink)

.
PRINT (0,100)
b. PRINT (0) (Blink)
</pre>

== (BM) ==
<pre>
Mnemonic: (BM) Hex equivalent: "@0405@" Discussion: Blind mode. The (BM) control code establishes "blind mode" -- an attribute where characters entered from the keyboard do not appear on the screen. Up to 32 characters can be entered with the video device in blind mode. This control code is typically used for entering invisible passwords.

Example: a. LENGTH 32 & LOCAL PASSWORD$

100 FORMAT (BM)
.
PRINT (0,100)
INPUT (0) PASSWORD$
b. LENGTH 32 & LOCAL PASSWORD$

.
PRINT (0) (BM)
INPUT (0) PASSWORD$
This example shows how to set the blind mode input buffer. The (BM) control code is written and the data is entered into the variable named PASSWORD$. This data will not be visible on the screen as it is entered.
</pre>
== (Bright) ==
<pre>
Note: As of Comet version 504, this mnemonic is no longer supported. Mnemonic: (Bright) Hex equivalent: "@0E0002@" Discussion: This mnemonic displays bright characters on the Comet console. Bright characters that are defined as the "background color" of a field (i.e., the first character in the color definition). To display "bright" characters, use the following instruction:

PRINT (0) (Bright)

Note: The (Bright) mnemonic also turns off blinking fields that have been previously set with the (Blink) mnemonic.

The 16 VGA colors are shown below, with the "bright" characters shown at the right-hand side:

Regular colors Bright colors
=========================================
0 black 8 gray
1 blue 9 light blue
2 green A light green
3 cyan B light cyan
4 red C light red
5 magenta D light magenta
6 brown E yellow
7 white F bright white

Example: a. 100 FORMAT (Bright)

.
PRINT (0,100)
b. PRINT (0) (Bright)
</pre>

Mnemonics "B"

2009-09-04T20:53:18Z

SteveA: /* (Begin Metafile) */

==(BCC)==
'''Email Mnemonic''': (BCC=string-argument)

'''Discussion:''' The (BCC) mnemonic may be used to specify "blind carbon copy" recipients of your email message.
<pre>
Example: OPEN (1) "LEH" PRINT (1) (BCC="brian@@signature.net")
</pre>

== (Begin Metafile) ==
'''Mnemonic''': (BeginMetafile = FileName)

'''Discussion''': Initiates the collecting of GDI functions into a virtual memory block (Metafile) that is passed to COSW in a single write rather than one function at a time enhancing performance. If FileName is non-blank the file can be saved to disk and recalled at a later time (see [[#ExecuteMetafile]]).

Read about other Email Mnemonics

== (BeginWaitCursor) ==
<pre>
Mnemonic: (BeginWaitCursor) Discussion: This mnemonic turns on the hourglass cursor. See (EndWaitCursor) and (RestoreWaitCursor).

Example: Print (BeginWaitCursor) . . . Print (EndWaitCursor)

</pre>
== (BF) ==
<pre>
Mnemonic: (BF) Hex equivalent: "@0406@" Discussion: Blank fill. The (BF) control code replaces all characters from the cursor position to the end of the line with blanks. The current mode -- foreground, background, or invisible (suppressed background) -- determines the type of blank. When this control is complete, the cursor is positioned at the beginning of the next line (or the next available foreground position on the screen).

This control code may also include a positioning statement to start the fill operation from a specific point on the screen.

Example: a. 100 FORMAT (SB);(BF),@(10,0)

.
PRINT (0,100)
b. PRINT (0) (SB);(BF),@(10,0)

This example sets the video mode to background (SB), and then blank fills the top row of the screen (i.e., row 0) from position 10 to the end of the line.

</pre>
== (BIOS Mouse On) ==
<pre>
Mnemonic: (BIOS Mouse On) Hex equivalent: "@0E0905@" Discussion: This control opens the BIOS mouse driver (if possible). Also see (Mouse On) and (Enhanced Mouse On).

Example: a. 100 FORMAT (BIOS Mouse On)

.
PRINT (0,100
b. PRINT (0) (BIOS Mouse On

</pre>
== (BF) ==
<pre>
Mnemonic: (BF) Hex equivalent: "@0406@" Discussion: Blank fill. The (BF) control code replaces all characters from the cursor position to the end of the line with blanks. The current mode -- foreground, background, or invisible (suppressed background) -- determines the type of blank. When this control is complete, the cursor is positioned at the beginning of the next line (or the next available foreground position on the screen).

This control code may also include a positioning statement to start the fill operation from a specific point on the screen.

Example: a. 100 FORMAT (SB);(BF),@(10,0)

.
PRINT (0,100)
b. PRINT (0) (SB);(BF),@(10,0)

This example sets the video mode to background (SB), and then blank fills the top row of the screen (i.e., row 0) from position 10 to the end of the line.

</pre>
== (BM) ==
<pre>

Mnemonic: (BM) Hex equivalent: "@0405@" Discussion: Blind mode. The (BM) control code establishes "blind mode" -- an attribute where characters entered from the keyboard do not appear on the screen. Up to 32 characters can be entered with the video device in blind mode. This control code is typically used for entering invisible passwords.

Example: a. LENGTH 32 & LOCAL PASSWORD$

100 FORMAT (BM)
.
PRINT (0,100)
INPUT (0) PASSWORD$
b. LENGTH 32 & LOCAL PASSWORD$

.
PRINT (0) (BM)
INPUT (0) PASSWORD$
This example shows how to set the blind mode input buffer. The (BM) control code is written and the data is entered into the variable named PASSWORD$. This data will not be visible on the screen as it is entered.
</pre>
== (Blink) ==
<pre>
Note: As of Comet version 504, this mnemonic is no longer supported. Mnemonic: (Blink) Hex equivalent: "@0E0001@" Discussion: This mnemonic displays blinking characters on the Comet console. Blinking works only on "bright" characters that are defined as the "background color" of a field (i.e., the first character in the color definition). Blinking works on all of the "bright" characters on the screen, including foreground fields, background fields, invisible fields, and data entry fields. To blink all "bright" characters on the screen, use the following instruction:

PRINT (0) (Blink)

To display "bright" characters, and stop the blinking, use the following instruction:

PRINT (0) (Bright)

The 16 VGA colors are shown below, with the "bright" characters shown at the right-hand side:

Regular colors Bright colors (blinking works here)
==========================================================
0 black 8 gray
1 blue 9 light blue
2 green A light green
3 cyan B light cyan
4 red C light red
5 magenta D light magenta
6 brown E yellow
7 white F bright white
Examples:
Color Definition Will it blink?
==============================================================
17 blue background, white characters no
97 light blue background, white characters yes
1F blue background, bright white characters no
9F light blue background, bright white characters yes

Example: a. 100 FORMAT (Blink)

.
PRINT (0,100)
b. PRINT (0) (Blink)
</pre>

== (BM) ==
<pre>
Mnemonic: (BM) Hex equivalent: "@0405@" Discussion: Blind mode. The (BM) control code establishes "blind mode" -- an attribute where characters entered from the keyboard do not appear on the screen. Up to 32 characters can be entered with the video device in blind mode. This control code is typically used for entering invisible passwords.

Example: a. LENGTH 32 & LOCAL PASSWORD$

100 FORMAT (BM)
.
PRINT (0,100)
INPUT (0) PASSWORD$
b. LENGTH 32 & LOCAL PASSWORD$

.
PRINT (0) (BM)
INPUT (0) PASSWORD$
This example shows how to set the blind mode input buffer. The (BM) control code is written and the data is entered into the variable named PASSWORD$. This data will not be visible on the screen as it is entered.
</pre>
== (Bright) ==
<pre>
Note: As of Comet version 504, this mnemonic is no longer supported. Mnemonic: (Bright) Hex equivalent: "@0E0002@" Discussion: This mnemonic displays bright characters on the Comet console. Bright characters that are defined as the "background color" of a field (i.e., the first character in the color definition). To display "bright" characters, use the following instruction:

PRINT (0) (Bright)

Note: The (Bright) mnemonic also turns off blinking fields that have been previously set with the (Blink) mnemonic.

The 16 VGA colors are shown below, with the "bright" characters shown at the right-hand side:

Regular colors Bright colors
=========================================
0 black 8 gray
1 blue 9 light blue
2 green A light green
3 cyan B light cyan
4 red C light red
5 magenta D light magenta
6 brown E yellow
7 white F bright white

Example: a. 100 FORMAT (Bright)

.
PRINT (0,100)
b. PRINT (0) (Bright)
</pre>

Mnemonics "B"

2009-09-04T20:51:54Z

SteveA: /* (BCC) */

==(BCC)==
'''Email Mnemonic''': (BCC=string-argument)

'''Discussion:''' The (BCC) mnemonic may be used to specify "blind carbon copy" recipients of your email message.
<pre>
Example: OPEN (1) "LEH" PRINT (1) (BCC="brian@@signature.net")
</pre>

== (Begin Metafile) ==
<pre>
Mnemonic: (BeginMetafile = FileName) Discussion: Initiates the collecting of GDI functions into a virtual memory block (Metafile) that is passed to COSW in a single write rather than one function at a time enhancing performance. If FileName is non-blank the file can be saved to disk and recalled at a later time (see ExecuteMetafile).

Read about other Email Mnemonics
</pre>
== (BeginWaitCursor) ==
<pre>
Mnemonic: (BeginWaitCursor) Discussion: This mnemonic turns on the hourglass cursor. See (EndWaitCursor) and (RestoreWaitCursor).

Example: Print (BeginWaitCursor) . . . Print (EndWaitCursor)

</pre>
== (BF) ==
<pre>
Mnemonic: (BF) Hex equivalent: "@0406@" Discussion: Blank fill. The (BF) control code replaces all characters from the cursor position to the end of the line with blanks. The current mode -- foreground, background, or invisible (suppressed background) -- determines the type of blank. When this control is complete, the cursor is positioned at the beginning of the next line (or the next available foreground position on the screen).

This control code may also include a positioning statement to start the fill operation from a specific point on the screen.

Example: a. 100 FORMAT (SB);(BF),@(10,0)

.
PRINT (0,100)
b. PRINT (0) (SB);(BF),@(10,0)

This example sets the video mode to background (SB), and then blank fills the top row of the screen (i.e., row 0) from position 10 to the end of the line.

</pre>
== (BIOS Mouse On) ==
<pre>
Mnemonic: (BIOS Mouse On) Hex equivalent: "@0E0905@" Discussion: This control opens the BIOS mouse driver (if possible). Also see (Mouse On) and (Enhanced Mouse On).

Example: a. 100 FORMAT (BIOS Mouse On)

.
PRINT (0,100
b. PRINT (0) (BIOS Mouse On

</pre>
== (BF) ==
<pre>
Mnemonic: (BF) Hex equivalent: "@0406@" Discussion: Blank fill. The (BF) control code replaces all characters from the cursor position to the end of the line with blanks. The current mode -- foreground, background, or invisible (suppressed background) -- determines the type of blank. When this control is complete, the cursor is positioned at the beginning of the next line (or the next available foreground position on the screen).

This control code may also include a positioning statement to start the fill operation from a specific point on the screen.

Example: a. 100 FORMAT (SB);(BF),@(10,0)

.
PRINT (0,100)
b. PRINT (0) (SB);(BF),@(10,0)

This example sets the video mode to background (SB), and then blank fills the top row of the screen (i.e., row 0) from position 10 to the end of the line.

</pre>
== (BM) ==
<pre>

Mnemonic: (BM) Hex equivalent: "@0405@" Discussion: Blind mode. The (BM) control code establishes "blind mode" -- an attribute where characters entered from the keyboard do not appear on the screen. Up to 32 characters can be entered with the video device in blind mode. This control code is typically used for entering invisible passwords.

Example: a. LENGTH 32 & LOCAL PASSWORD$

100 FORMAT (BM)
.
PRINT (0,100)
INPUT (0) PASSWORD$
b. LENGTH 32 & LOCAL PASSWORD$

.
PRINT (0) (BM)
INPUT (0) PASSWORD$
This example shows how to set the blind mode input buffer. The (BM) control code is written and the data is entered into the variable named PASSWORD$. This data will not be visible on the screen as it is entered.
</pre>
== (Blink) ==
<pre>
Note: As of Comet version 504, this mnemonic is no longer supported. Mnemonic: (Blink) Hex equivalent: "@0E0001@" Discussion: This mnemonic displays blinking characters on the Comet console. Blinking works only on "bright" characters that are defined as the "background color" of a field (i.e., the first character in the color definition). Blinking works on all of the "bright" characters on the screen, including foreground fields, background fields, invisible fields, and data entry fields. To blink all "bright" characters on the screen, use the following instruction:

PRINT (0) (Blink)

To display "bright" characters, and stop the blinking, use the following instruction:

PRINT (0) (Bright)

The 16 VGA colors are shown below, with the "bright" characters shown at the right-hand side:

Regular colors Bright colors (blinking works here)
==========================================================
0 black 8 gray
1 blue 9 light blue
2 green A light green
3 cyan B light cyan
4 red C light red
5 magenta D light magenta
6 brown E yellow
7 white F bright white
Examples:
Color Definition Will it blink?
==============================================================
17 blue background, white characters no
97 light blue background, white characters yes
1F blue background, bright white characters no
9F light blue background, bright white characters yes

Example: a. 100 FORMAT (Blink)

.
PRINT (0,100)
b. PRINT (0) (Blink)
</pre>

== (BM) ==
<pre>
Mnemonic: (BM) Hex equivalent: "@0405@" Discussion: Blind mode. The (BM) control code establishes "blind mode" -- an attribute where characters entered from the keyboard do not appear on the screen. Up to 32 characters can be entered with the video device in blind mode. This control code is typically used for entering invisible passwords.

Example: a. LENGTH 32 & LOCAL PASSWORD$

100 FORMAT (BM)
.
PRINT (0,100)
INPUT (0) PASSWORD$
b. LENGTH 32 & LOCAL PASSWORD$

.
PRINT (0) (BM)
INPUT (0) PASSWORD$
This example shows how to set the blind mode input buffer. The (BM) control code is written and the data is entered into the variable named PASSWORD$. This data will not be visible on the screen as it is entered.
</pre>
== (Bright) ==
<pre>
Note: As of Comet version 504, this mnemonic is no longer supported. Mnemonic: (Bright) Hex equivalent: "@0E0002@" Discussion: This mnemonic displays bright characters on the Comet console. Bright characters that are defined as the "background color" of a field (i.e., the first character in the color definition). To display "bright" characters, use the following instruction:

PRINT (0) (Bright)

Note: The (Bright) mnemonic also turns off blinking fields that have been previously set with the (Blink) mnemonic.

The 16 VGA colors are shown below, with the "bright" characters shown at the right-hand side:

Regular colors Bright colors
=========================================
0 black 8 gray
1 blue 9 light blue
2 green A light green
3 cyan B light cyan
4 red C light red
5 magenta D light magenta
6 brown E yellow
7 white F bright white

Example: a. 100 FORMAT (Bright)

.
PRINT (0,100)
b. PRINT (0) (Bright)
</pre>

Mnemonics "A"

2009-09-04T20:50:12Z

SteveA: /* (AutoCROn) */

==(Allow Maximize)==

'''Mnemonic''': (Allow Maximize=state)

'''Discussion''': This mnemonic disables/enables the maximize controls on the COSW window. Use this mnemonic to prevent the user from maximizing the COSW window. State is a flag indicating which function is to be performed:

'''0''' Disable the maximize controls 
'''1''' Enable the maximize controls

<pre>
Example:
! Disable the maximize controls
Print (Allow Maximize=0) . . .
! Enable the maximize controls
Print (Allow Maximize=1)
</pre>

== Archive mnemonics ==

'''Mnemonic''' 
'''Description''' (Document=longfilename,dir) Specifies a name for a copy of an archive document
<pre>
(SpoolMessage=DocumentName) Specifies the filename to be used for a document stored in an archive.
</pre>

==(Auto Metafile)==

'''Mnemonic''': (AutoMetafile = State)

'''Discussion''': Enables/disables the automatic use of un-named metafiles. AutoMetafile is ON by default. When disabled, the existing metafile (if present) will be executed. Where State is:
<pre>
AMF.DISABLE = 0 ! Disables automatic metafiles
AMF.ENABLE = 1 ! Enables automatic metafiles
</pre>

==(Auto Tab Off)==
'''Mnemonic''': (Auto TAB Off) Hex equivalent: "@0E0004@"

'''Discussion''': This mnemonic turns off the "automatic tab mode." Also see (Auto TAB On).
<pre>
Example:
a. 100 FORMAT (Auto TAB Off)
.
PRINT (0,100)
b. PRINT (0) (Auto TAB Off)
</pre>

==(Auto Tab On)==

'''Mnemonic''': (Auto TAB On) Hex equivalent: "@0E0003@"

'''Discussion''': This mnemonic turns on the "automatic tab mode." In this mode, the cursor automatically advances to the next input field when it reaches the last character of the current input field. Also see [[#(Auto TAB Off)]].
<pre>
Example:
a. 100 FORMAT (Auto TAB On)
.
PRINT (0,100)
b. PRINT (0) (Auto TAB On)
</pre>

==(AutoCROff)==

'''Mnemonic''': (AutoCROff)

'''Discussion''': The (AutoCROff) mnemonic turns off the extra CR/LF added by CosP to the end of each line not followed with a (TR). The mnemonic is in effect until either the printer is closed or the [[#(AutoCROn)]] mnemonic is sent. The effect will persist over an EXIT, so a subprogram may issue the mnemonic for a printer opened by the parent program.

History: Support for this mnemonic was added in Comet 2004.
<pre>
Example:
a. 100 FORMAT (AutoCROff)
.
OPEN (1) "LP1"
.
PRINT (1,100)

b. OPEN (1) "LP1"
.
PRINT (1) (AutoCROff)
</pre>

==(AutoCROn)==

'''Mnemonic''': (AutoCROn)

'''Discussion''': The (AutoCROn) mnemonic turns on the extra CR/LF added by CosP to the end of each line not followed with a (TR). The mnemonic is in effect until either the printer is closed or the [[#(AutoCROff)]] mnemonic is sent. The effect will persist over an EXIT, so a subprogram may issue the mnemonic for a printer opened by the parent program.

History: Support for this mnemonic was added in Comet 2004.
<pre>
Example: a. 100 FORMAT (AutoCROn)
.
OPEN (1) "LP1"
.
PRINT (1,100)
b. OPEN (1) "LP1"
.
PRINT (1) (AutoCROn)
</pre>

Mnemonics "A"

2009-09-04T20:48:43Z

SteveA: /* (AutoCROff) */

==(Allow Maximize)==

'''Mnemonic''': (Allow Maximize=state)

'''Discussion''': This mnemonic disables/enables the maximize controls on the COSW window. Use this mnemonic to prevent the user from maximizing the COSW window. State is a flag indicating which function is to be performed:

'''0''' Disable the maximize controls 
'''1''' Enable the maximize controls

<pre>
Example:
! Disable the maximize controls
Print (Allow Maximize=0) . . .
! Enable the maximize controls
Print (Allow Maximize=1)
</pre>

== Archive mnemonics ==

'''Mnemonic''' 
'''Description''' (Document=longfilename,dir) Specifies a name for a copy of an archive document
<pre>
(SpoolMessage=DocumentName) Specifies the filename to be used for a document stored in an archive.
</pre>

==(Auto Metafile)==

'''Mnemonic''': (AutoMetafile = State)

'''Discussion''': Enables/disables the automatic use of un-named metafiles. AutoMetafile is ON by default. When disabled, the existing metafile (if present) will be executed. Where State is:
<pre>
AMF.DISABLE = 0 ! Disables automatic metafiles
AMF.ENABLE = 1 ! Enables automatic metafiles
</pre>

==(Auto Tab Off)==
'''Mnemonic''': (Auto TAB Off) Hex equivalent: "@0E0004@"

'''Discussion''': This mnemonic turns off the "automatic tab mode." Also see (Auto TAB On).
<pre>
Example:
a. 100 FORMAT (Auto TAB Off)
.
PRINT (0,100)
b. PRINT (0) (Auto TAB Off)
</pre>

==(Auto Tab On)==

'''Mnemonic''': (Auto TAB On) Hex equivalent: "@0E0003@"

'''Discussion''': This mnemonic turns on the "automatic tab mode." In this mode, the cursor automatically advances to the next input field when it reaches the last character of the current input field. Also see [[#(Auto TAB Off)]].
<pre>
Example:
a. 100 FORMAT (Auto TAB On)
.
PRINT (0,100)
b. PRINT (0) (Auto TAB On)
</pre>

==(AutoCROff)==

'''Mnemonic''': (AutoCROff)

'''Discussion''': The (AutoCROff) mnemonic turns off the extra CR/LF added by CosP to the end of each line not followed with a (TR). The mnemonic is in effect until either the printer is closed or the [[#(AutoCROn)]] mnemonic is sent. The effect will persist over an EXIT, so a subprogram may issue the mnemonic for a printer opened by the parent program.

History: Support for this mnemonic was added in Comet 2004.
<pre>
Example:
a. 100 FORMAT (AutoCROff)
.
OPEN (1) "LP1"
.
PRINT (1,100)

b. OPEN (1) "LP1"
.
PRINT (1) (AutoCROff)
</pre>

== (AutoCROn) ==
<pre>
Mnemonic: (AutoCROn) Discussion: The (AutoCROn) mnemonic turns on the extra CR/LF added by CosP to the end of each line not followed with a (TR). The mnemonic is in effect until either the printer is closed or the (AutoCROff) mnemonic is sent. The effect will persist over an EXIT, so a subprogram may issue the mnemonic for a printer opened by the parent program. History: Support for this mnemonic was added in Comet 2004. Example: a. 100 FORMAT (AutoCROn)

.
OPEN (1) "LP1"
.
PRINT (1,100)

b. OPEN (1) "LP1"

.
PRINT (1) (AutoCROn)
</pre>

Mnemonics "A"

2009-09-04T20:46:29Z

SteveA: /* (Auto Tab On) */

==(Allow Maximize)==

'''Mnemonic''': (Allow Maximize=state)

'''Discussion''': This mnemonic disables/enables the maximize controls on the COSW window. Use this mnemonic to prevent the user from maximizing the COSW window. State is a flag indicating which function is to be performed:

'''0''' Disable the maximize controls 
'''1''' Enable the maximize controls

<pre>
Example:
! Disable the maximize controls
Print (Allow Maximize=0) . . .
! Enable the maximize controls
Print (Allow Maximize=1)
</pre>

== Archive mnemonics ==

'''Mnemonic''' 
'''Description''' (Document=longfilename,dir) Specifies a name for a copy of an archive document
<pre>
(SpoolMessage=DocumentName) Specifies the filename to be used for a document stored in an archive.
</pre>

==(Auto Metafile)==

'''Mnemonic''': (AutoMetafile = State)

'''Discussion''': Enables/disables the automatic use of un-named metafiles. AutoMetafile is ON by default. When disabled, the existing metafile (if present) will be executed. Where State is:
<pre>
AMF.DISABLE = 0 ! Disables automatic metafiles
AMF.ENABLE = 1 ! Enables automatic metafiles
</pre>

==(Auto Tab Off)==
'''Mnemonic''': (Auto TAB Off) Hex equivalent: "@0E0004@"

'''Discussion''': This mnemonic turns off the "automatic tab mode." Also see (Auto TAB On).
<pre>
Example:
a. 100 FORMAT (Auto TAB Off)
.
PRINT (0,100)
b. PRINT (0) (Auto TAB Off)
</pre>

==(Auto Tab On)==

'''Mnemonic''': (Auto TAB On) Hex equivalent: "@0E0003@"

'''Discussion''': This mnemonic turns on the "automatic tab mode." In this mode, the cursor automatically advances to the next input field when it reaches the last character of the current input field. Also see [[#(Auto TAB Off)]].
<pre>
Example:
a. 100 FORMAT (Auto TAB On)
.
PRINT (0,100)
b. PRINT (0) (Auto TAB On)
</pre>

== (AutoCROff) ==
<pre>
Mnemonic: (AutoCROff) Discussion: The (AutoCROff) mnemonic turns off the extra CR/LF added by CosP to the end of each line not followed with a (TR). The mnemonic is in effect until either the printer is closed or the (AutoCROn) mnemonic is sent. The effect will persist over an EXIT, so a subprogram may issue the mnemonic for a printer opened by the parent program. History: Support for this mnemonic was added in Comet 2004. Example: a. 100 FORMAT (AutoCROff)

.
OPEN (1) "LP1"
.
PRINT (1,100)

b. OPEN (1) "LP1"

.
PRINT (1) (AutoCROff)
</pre>
== (AutoCROn) ==
<pre>
Mnemonic: (AutoCROn) Discussion: The (AutoCROn) mnemonic turns on the extra CR/LF added by CosP to the end of each line not followed with a (TR). The mnemonic is in effect until either the printer is closed or the (AutoCROff) mnemonic is sent. The effect will persist over an EXIT, so a subprogram may issue the mnemonic for a printer opened by the parent program. History: Support for this mnemonic was added in Comet 2004. Example: a. 100 FORMAT (AutoCROn)

.
OPEN (1) "LP1"
.
PRINT (1,100)

b. OPEN (1) "LP1"

.
PRINT (1) (AutoCROn)
</pre>

Mnemonics "A"

2009-09-04T20:45:20Z

SteveA: /* (Auto Tab Off) */

==(Allow Maximize)==

'''Mnemonic''': (Allow Maximize=state)

'''Discussion''': This mnemonic disables/enables the maximize controls on the COSW window. Use this mnemonic to prevent the user from maximizing the COSW window. State is a flag indicating which function is to be performed:

'''0''' Disable the maximize controls 
'''1''' Enable the maximize controls

<pre>
Example:
! Disable the maximize controls
Print (Allow Maximize=0) . . .
! Enable the maximize controls
Print (Allow Maximize=1)
</pre>

== Archive mnemonics ==

'''Mnemonic''' 
'''Description''' (Document=longfilename,dir) Specifies a name for a copy of an archive document
<pre>
(SpoolMessage=DocumentName) Specifies the filename to be used for a document stored in an archive.
</pre>

==(Auto Metafile)==

'''Mnemonic''': (AutoMetafile = State)

'''Discussion''': Enables/disables the automatic use of un-named metafiles. AutoMetafile is ON by default. When disabled, the existing metafile (if present) will be executed. Where State is:
<pre>
AMF.DISABLE = 0 ! Disables automatic metafiles
AMF.ENABLE = 1 ! Enables automatic metafiles
</pre>

==(Auto Tab Off)==
'''Mnemonic''': (Auto TAB Off) Hex equivalent: "@0E0004@"

'''Discussion''': This mnemonic turns off the "automatic tab mode." Also see (Auto TAB On).
<pre>
Example:
a. 100 FORMAT (Auto TAB Off)
.
PRINT (0,100)
b. PRINT (0) (Auto TAB Off)
</pre>

== (Auto Tab On) ==
<pre>
Mnemonic: (Auto TAB On) Hex equivalent: "@0E0003@" Discussion: This mnemonic turns on the "automatic tab mode." In this mode, the cursor automatically advances to the next input field when it reaches the last character of the current input field. Also see (Auto TAB Off).

Example: a. 100 FORMAT (Auto TAB On)

.
PRINT (0,100)
b. PRINT (0) (Auto TAB On)

</pre>
== (AutoCROff) ==
<pre>
Mnemonic: (AutoCROff) Discussion: The (AutoCROff) mnemonic turns off the extra CR/LF added by CosP to the end of each line not followed with a (TR). The mnemonic is in effect until either the printer is closed or the (AutoCROn) mnemonic is sent. The effect will persist over an EXIT, so a subprogram may issue the mnemonic for a printer opened by the parent program. History: Support for this mnemonic was added in Comet 2004. Example: a. 100 FORMAT (AutoCROff)

.
OPEN (1) "LP1"
.
PRINT (1,100)

b. OPEN (1) "LP1"

.
PRINT (1) (AutoCROff)
</pre>
== (AutoCROn) ==
<pre>
Mnemonic: (AutoCROn) Discussion: The (AutoCROn) mnemonic turns on the extra CR/LF added by CosP to the end of each line not followed with a (TR). The mnemonic is in effect until either the printer is closed or the (AutoCROff) mnemonic is sent. The effect will persist over an EXIT, so a subprogram may issue the mnemonic for a printer opened by the parent program. History: Support for this mnemonic was added in Comet 2004. Example: a. 100 FORMAT (AutoCROn)

.
OPEN (1) "LP1"
.
PRINT (1,100)

b. OPEN (1) "LP1"

.
PRINT (1) (AutoCROn)
</pre>

Mnemonics "A"

2009-09-04T20:44:11Z

SteveA: /* (Auto Metafile) */

==(Allow Maximize)==

'''Mnemonic''': (Allow Maximize=state)

'''Discussion''': This mnemonic disables/enables the maximize controls on the COSW window. Use this mnemonic to prevent the user from maximizing the COSW window. State is a flag indicating which function is to be performed:

'''0''' Disable the maximize controls 
'''1''' Enable the maximize controls

<pre>
Example:
! Disable the maximize controls
Print (Allow Maximize=0) . . .
! Enable the maximize controls
Print (Allow Maximize=1)
</pre>

== Archive mnemonics ==

'''Mnemonic''' 
'''Description''' (Document=longfilename,dir) Specifies a name for a copy of an archive document
<pre>
(SpoolMessage=DocumentName) Specifies the filename to be used for a document stored in an archive.
</pre>

==(Auto Metafile)==

'''Mnemonic''': (AutoMetafile = State)

'''Discussion''': Enables/disables the automatic use of un-named metafiles. AutoMetafile is ON by default. When disabled, the existing metafile (if present) will be executed. Where State is:
<pre>
AMF.DISABLE = 0 ! Disables automatic metafiles
AMF.ENABLE = 1 ! Enables automatic metafiles
</pre>

== (Auto Tab Off) ==
<pre>
Mnemonic: (Auto TAB Off) Hex equivalent: "@0E0004@" Discussion: This mnemonic turns off the "automatic tab mode." Also see (Auto TAB On).

Example: a. 100 FORMAT (Auto TAB Off)

.
PRINT (0,100)
b. PRINT (0) (Auto TAB Off)

</pre>
== (Auto Tab On) ==
<pre>
Mnemonic: (Auto TAB On) Hex equivalent: "@0E0003@" Discussion: This mnemonic turns on the "automatic tab mode." In this mode, the cursor automatically advances to the next input field when it reaches the last character of the current input field. Also see (Auto TAB Off).

Example: a. 100 FORMAT (Auto TAB On)

.
PRINT (0,100)
b. PRINT (0) (Auto TAB On)

</pre>
== (AutoCROff) ==
<pre>
Mnemonic: (AutoCROff) Discussion: The (AutoCROff) mnemonic turns off the extra CR/LF added by CosP to the end of each line not followed with a (TR). The mnemonic is in effect until either the printer is closed or the (AutoCROn) mnemonic is sent. The effect will persist over an EXIT, so a subprogram may issue the mnemonic for a printer opened by the parent program. History: Support for this mnemonic was added in Comet 2004. Example: a. 100 FORMAT (AutoCROff)

.
OPEN (1) "LP1"
.
PRINT (1,100)

b. OPEN (1) "LP1"

.
PRINT (1) (AutoCROff)
</pre>
== (AutoCROn) ==
<pre>
Mnemonic: (AutoCROn) Discussion: The (AutoCROn) mnemonic turns on the extra CR/LF added by CosP to the end of each line not followed with a (TR). The mnemonic is in effect until either the printer is closed or the (AutoCROff) mnemonic is sent. The effect will persist over an EXIT, so a subprogram may issue the mnemonic for a printer opened by the parent program. History: Support for this mnemonic was added in Comet 2004. Example: a. 100 FORMAT (AutoCROn)

.
OPEN (1) "LP1"
.
PRINT (1,100)

b. OPEN (1) "LP1"

.
PRINT (1) (AutoCROn)
</pre>

Mnemonics "A"

2009-09-04T20:42:50Z

SteveA: /* Archive mnemonics */

==(Allow Maximize)==

'''Mnemonic''': (Allow Maximize=state)

'''Discussion''': This mnemonic disables/enables the maximize controls on the COSW window. Use this mnemonic to prevent the user from maximizing the COSW window. State is a flag indicating which function is to be performed:

'''0''' Disable the maximize controls 
'''1''' Enable the maximize controls

<pre>
Example:
! Disable the maximize controls
Print (Allow Maximize=0) . . .
! Enable the maximize controls
Print (Allow Maximize=1)
</pre>

== Archive mnemonics ==

'''Mnemonic''' 
'''Description''' (Document=longfilename,dir) Specifies a name for a copy of an archive document
<pre>
(SpoolMessage=DocumentName) Specifies the filename to be used for a document stored in an archive.
</pre>

== (Auto Metafile) ==
<pre>
Mnemonic: (AutoMetafile = State) Discussion: Enables/disables the automatic use of un-named metafiles. AutoMetafile is ON by default. When disabled, the existing metafile (if present) will be executed. Where State is:

AMF.DISABLE = 0 ! Disables automatic metafiles AMF.ENABLE = 1 ! Enables automatic metafiles

</pre>
== (Auto Tab Off) ==
<pre>
Mnemonic: (Auto TAB Off) Hex equivalent: "@0E0004@" Discussion: This mnemonic turns off the "automatic tab mode." Also see (Auto TAB On).

Example: a. 100 FORMAT (Auto TAB Off)

.
PRINT (0,100)
b. PRINT (0) (Auto TAB Off)

</pre>
== (Auto Tab On) ==
<pre>
Mnemonic: (Auto TAB On) Hex equivalent: "@0E0003@" Discussion: This mnemonic turns on the "automatic tab mode." In this mode, the cursor automatically advances to the next input field when it reaches the last character of the current input field. Also see (Auto TAB Off).

Example: a. 100 FORMAT (Auto TAB On)

.
PRINT (0,100)
b. PRINT (0) (Auto TAB On)

</pre>
== (AutoCROff) ==
<pre>
Mnemonic: (AutoCROff) Discussion: The (AutoCROff) mnemonic turns off the extra CR/LF added by CosP to the end of each line not followed with a (TR). The mnemonic is in effect until either the printer is closed or the (AutoCROn) mnemonic is sent. The effect will persist over an EXIT, so a subprogram may issue the mnemonic for a printer opened by the parent program. History: Support for this mnemonic was added in Comet 2004. Example: a. 100 FORMAT (AutoCROff)

.
OPEN (1) "LP1"
.
PRINT (1,100)

b. OPEN (1) "LP1"

.
PRINT (1) (AutoCROff)
</pre>
== (AutoCROn) ==
<pre>
Mnemonic: (AutoCROn) Discussion: The (AutoCROn) mnemonic turns on the extra CR/LF added by CosP to the end of each line not followed with a (TR). The mnemonic is in effect until either the printer is closed or the (AutoCROff) mnemonic is sent. The effect will persist over an EXIT, so a subprogram may issue the mnemonic for a printer opened by the parent program. History: Support for this mnemonic was added in Comet 2004. Example: a. 100 FORMAT (AutoCROn)

.
OPEN (1) "LP1"
.
PRINT (1,100)

b. OPEN (1) "LP1"

.
PRINT (1) (AutoCROn)
</pre>

Mnemonics "A"

2009-09-04T20:41:28Z

SteveA: /* (Allow Maximize) */

==(Allow Maximize)==

'''Mnemonic''': (Allow Maximize=state)

'''Discussion''': This mnemonic disables/enables the maximize controls on the COSW window. Use this mnemonic to prevent the user from maximizing the COSW window. State is a flag indicating which function is to be performed:

'''0''' Disable the maximize controls 
'''1''' Enable the maximize controls

<pre>
Example:
! Disable the maximize controls
Print (Allow Maximize=0) . . .
! Enable the maximize controls
Print (Allow Maximize=1)
</pre>

== Archive mnemonics ==
<pre>
Mnemonic Description (Document=longfilename,dir) Specifies a name for a copy of an archive document (SpoolMessage=DocumentName) Specifies the filename to be used for a document stored in an archive.

</pre>
== (Auto Metafile) ==
<pre>
Mnemonic: (AutoMetafile = State) Discussion: Enables/disables the automatic use of un-named metafiles. AutoMetafile is ON by default. When disabled, the existing metafile (if present) will be executed. Where State is:

AMF.DISABLE = 0 ! Disables automatic metafiles AMF.ENABLE = 1 ! Enables automatic metafiles

</pre>
== (Auto Tab Off) ==
<pre>
Mnemonic: (Auto TAB Off) Hex equivalent: "@0E0004@" Discussion: This mnemonic turns off the "automatic tab mode." Also see (Auto TAB On).

Example: a. 100 FORMAT (Auto TAB Off)

.
PRINT (0,100)
b. PRINT (0) (Auto TAB Off)

</pre>
== (Auto Tab On) ==
<pre>
Mnemonic: (Auto TAB On) Hex equivalent: "@0E0003@" Discussion: This mnemonic turns on the "automatic tab mode." In this mode, the cursor automatically advances to the next input field when it reaches the last character of the current input field. Also see (Auto TAB Off).

Example: a. 100 FORMAT (Auto TAB On)

.
PRINT (0,100)
b. PRINT (0) (Auto TAB On)

</pre>
== (AutoCROff) ==
<pre>
Mnemonic: (AutoCROff) Discussion: The (AutoCROff) mnemonic turns off the extra CR/LF added by CosP to the end of each line not followed with a (TR). The mnemonic is in effect until either the printer is closed or the (AutoCROn) mnemonic is sent. The effect will persist over an EXIT, so a subprogram may issue the mnemonic for a printer opened by the parent program. History: Support for this mnemonic was added in Comet 2004. Example: a. 100 FORMAT (AutoCROff)

.
OPEN (1) "LP1"
.
PRINT (1,100)

b. OPEN (1) "LP1"

.
PRINT (1) (AutoCROff)
</pre>
== (AutoCROn) ==
<pre>
Mnemonic: (AutoCROn) Discussion: The (AutoCROn) mnemonic turns on the extra CR/LF added by CosP to the end of each line not followed with a (TR). The mnemonic is in effect until either the printer is closed or the (AutoCROff) mnemonic is sent. The effect will persist over an EXIT, so a subprogram may issue the mnemonic for a printer opened by the parent program. History: Support for this mnemonic was added in Comet 2004. Example: a. 100 FORMAT (AutoCROn)

.
OPEN (1) "LP1"
.
PRINT (1,100)

b. OPEN (1) "LP1"

.
PRINT (1) (AutoCROn)
</pre>

Mnemonics "C"

2009-09-04T20:38:16Z

SteveA: /* (CH) */

== (CA Sessions) ==

'''Mnemonic''': (CA Sessions=maximum-number-of-sessions)

'''Discussion''': This mnemonic sets a limit on the number of CometAnywhere sessions. The maximum-number-of-sessions is a decimal value. To get information on the current setting, set the argument to 0 and follow the mnemonic with an INPUT (see example 2).

Example 1: Print (CA Sessions=3)

This example sets the maximum number of CometAnywhere sessions to 3.

Example 2: Print (CA Sessions=0) Input A$

This example sets the argument to 0.

As a result, the current setting is returned to the string variable contained in the next INPUT statement following the mnemonic. The return value is a one-byte hex string. For example, if the current maximum-number-of-sessions is 3, the hex value "@03@" is assigned to A$.

== (CapsOff) ==
<pre>
Mnemonic: (CapsOff) Discussion: This mnemonic turns the Caps Lock keyboard function off. See (CapsOn).

Example: Print (CapsOff)

</pre>
== (CapsOn) ==
<pre>
Mnemonic: (CapsOn) Discussion: This mnemonic turns the Caps Lock keyboard function on. See (CapsOff).

Example: Print (CapsOn)
</pre>
== (CC) ==
'''Email Mnemonic:''' (CC=string-argument)

'''Discussion:''' The (CC) mnemonic may be used to specify the "carbon copy" recipients of your email message. Example: OPEN (1) "LEH" PRINT (1) (CC="barbara@@signature.net")

== (CF) ==
'''Mnemonic''': (CF) Hex equivalent: "@06@"

'''Discussion''': Clear foreground. The (CF) control code clears all foreground screen positions to foreground blanks and positions the cursor at the first foreground position on the screen (the upper left corner). This control does not affect background or invisible (suppressed background) screen positions.

This control code is typically used to clear input data from a formatted screen after it is entered in order to prepare for the next set of input data.
<PRE>
Example: a. 100 FORMAT (CF)
.
PRINT (0,100)
b. PRINT (0) (CF)
</pre>
This example shows how to clear all foreground screen positions.

Read about other Email Mnemonics

== (CFLD) ==
'''Mnemonic''': (CFLD) Hex equivalent: "@0407@"

'''Discussion''': Clear field. The (CFLD) control code clears all foreground characters in a field in which the cursor is located and replaces them with foreground blanks. It then positions the cursor in the first position of the field (left-most position for alphanumeric fields and right-most position for right-justified numeric fields). The control code does not affect background or invisible (suppressed background) fields.

This control code may also include a positioning statement to start the clearing operation at a specific point on the screen.
<pre>
Example:
a. 100 FORMAT (CFLD),@(10,0)
.
PRINT (0,100)
b. PRINT (0) (CFLD),@(10,0)
</pre>
These examples demonstrates the "clear field" control code. The positioning statement puts the control into action at column 10, row 0. If this location is a foreground field, it will be cleared to foreground blanks (if not, the control code will do nothing).

== (CH) ==

'''Mnemonic''': (CH) Hex equivalent:

'''Discussion''': Cursor home. The (CH) control code moves the cursor to the "home" position on the screen. Home position is the upper left foreground location of the screen. Since the cursor will land only in a foreground area, "home" may be something other than the upper left corner.

For example, if the upper left corner of the screen contains background or invisible (suppressed background) characters, the cursor will search to the right and to the next line(s) if necessary for the first available foreground position.

Once a foreground field is located, the cursor will be positioned at the first location in that field (left-most position for alphanumeric fields and right-most position for right-justified numeric fields).
<pre>
Example:
a. 100 FORMAT (CH)
.
PRINT (0,100)
b. PRINT (0) (CH)
</pre>
This example shows how to move the cursor to the home position.

== (Change Color) ==

'''Mnemonic''': (Change Color=ARG1$) Hex equivalent: "@0E0E0Bxx00@" where: xx = the foreground color

'''Discussion''': This mnemonic changes the foreground color attribute on the Comet console, and is effective only for the current write operation. ARG1$ is the foreground color; it may be a string constant or a string variable containing the hex representation of the screen color.

See [[Screen Colors]] for a list of color codes.

Also see [[#(Change Colors)]] for a way to change all of the screen colors.
<pre>
Example:
a. 100 FORMAT (Change Color="@07@")
.
PRINT (0,100)
b. PRINT (0) (Change Color="@07@")
</pre>

==(Change Colors)==
'''Mnemonic:''' (Change Colors=ARG1$,ARG2$,ARG3$,ARG4$,ARG5$)

'''Hex equivalent:''' "@0E0E0Evvwwxxyyzz@" where: vv = the foreground color ww = the background color xx = the invisible color (for TM's, TP's, and RJ's) yy = the border color zz = the entry field color

'''Discussion:''' The mnemonic changes all of the screen colors on the Comet console, or within the current Comet window. ARG1$ is the foreground color ARG2$ is the background color ARG3$ is the invisible color (for TM's, TP's, and RJ's) ARG4$ is the border color ARG5$ is the entry field color

All of these arguments are in hex and may be string constants or a string variable containing the hex representation of the screen color.

See [[Screen Colors]] for a list of color codes.

Also see ([[#Change Color]]) for a way to change the foreground color only.
<pre>
Example:
a. 100 FORMAT (Change colors="@0F@","@A0@","@00@","@C0@","@0F@")
.
PRINT (0,100)
b. Print (0) (Change colors="@0F@","@A0@","@00@","@C0@","@0F@")
</pre>

==(CPL132)==
'''Mnemonic''': (CPL132) Hex equivalent: "@040009@"

'''Discussion''': This mnemonic sets the video display mode to 132 characters per line. Also see ([[#Screen]]), ([[#CPL64]]), ([[#CPL80]]), and ([[#DE]]).
<pre>
Example:
a. 100 FORMAT (CPL132)
.
PRINT (0,100)
b. PRINT (0) (CPL132)
</pre>

==(CPL64)==

'''Mnemonic''': (CPL64) Hex equivalent: "@0402@"

'''Discussion''': The (CPL64) control code sets the screen display mode to 64 characters per line by 27 lines. The screen is cleared to foreground blanks and the cursor is moved to the "home" position. (Note: In normal mode, the cursor will be moved to the upper left corner of the screen. If typewriter mode is in effect, the cursor will be moved to the lower left corner of the screen.) This control code may be overridden by the system configuration (if the configuration forces the screen display to 80 columns, for example).

Also see [[#(Screen)]], [[#(CPL132)]], [[#(CPL80)]], and [[#(DE)]].
<pre>
Example:
a. 100 FORMAT (CPL64)
.
PRINT (0,100)
b. PRINT (0) (CPL64)
</pre>

==(CPL80)==

'''Mnemonic''': (CPL80) Hex equivalent: "@0403@"

'''Discussion''': The (CPL80) control code sets the screen display mode to 80 characters per line by 24 lines. The screen is cleared to foreground blanks and the cursor is moved to the "home" position. (Note: In normal mode, the cursor will be moved to the upper left corner of the screen. If typewriter mode is in effect, the cursor will be moved to the lower left corner of the screen.) Also see [[#(Screen)]], [[#(CPL132)]], [[#(CPL64)]], and [[#(DE)]].
</pre>
Example:
a. 100 FORMAT (CPL80)
.
PRINT (0,100)
b. PRINT (0) (CPL80)
</pre>

== (Check Box Off) ==
<pre>
Note: This feature is not supported beyond Comet 504. Mnemonic: (Check Box Off) Hex equivalent: "@CAC6B6@" Discussion: This mnemonic draws a graphical check box on the screen. The check box is in the "off" position (i.e., no check mark appears in the box), as shown here:

The check box symbol occupies 3 spaces on the screen.

Note: The (Enhanced Characters On) mnemonic must be used before the (Check Box Off) mnemonic us used.

Also see (Check Box On).

Example: a. 100 FORMAT (Check Box Off)

.
PRINT (0,100)
b. PRINT (0) (Check Box Off)

</pre>
== (Check Box On) ==
<pre>
Note: This feature is not supported beyond Comet 504. Mnemonic: (Check Box On) Hex equivalent: "@CACEB6@" Discussion: This mnemonic draws a graphical check box on the screen. The check box is in the "on" position (i.e., a check mark appears in the box), as shown here:

The check box symbol occupies 3 spaces on the screen.

Note: The (Enhanced Characters On) mnemonic must be used before the (Check Box On) mnemonic us used.

Also see (Check Box Off).

Example: a. 100 FORMAT (Check Box On)

.
PRINT (0,100)
b. PRINT (0) (Check Box On)

Retrieved from "http://64.142.11.195/index.php/Mnemonics"
</pre>
== (CFLD) ==

'''Mnemonic''': (CFLD) Hex equivalent: "@0407@"

'''Discussion''': Clear field. 
The (CFLD) control code clears all foreground characters in a field in which the cursor is located and replaces them with foreground blanks. It then positions the cursor in the first position of the field (left-most position for alphanumeric fields and right-most position for right-justified numeric fields). The control code does not affect background or invisible (suppressed background) fields.

This control code may also include a positioning statement to start the clearing operation at a specific point on the screen.
<pre>
Example:
a. 100 FORMAT (CFLD),@(10,0)
.
PRINT (0,100)
b. PRINT (0) (CFLD),@(10,0)
</pre>
This example demonstrates the "clear field" control code. The positioning statement puts the control into action at column 10, row 0. If this location is a foreground field, it will be cleared to foreground blanks (if not, the control code will do nothing).

== (CF) ==

'''Mnemonic''': (CF) Hex equivalent: "@06@" 
'''Discussion''': Clear foreground.
The (CF) control code clears all foreground screen positions to foreground blanks and positions the cursor at the first foreground position on the screen (the upper left corner). This control does not affect background or invisible (suppressed background) screen positions.

This control code is typically used to clear input data from a formatted screen after it is entered in order to prepare for the next set of input data.
<pre>
Example:
a. 100 FORMAT (CF)
.
PRINT (0,100)
b. PRINT (0) (CF)
</pre>
This example shows how to clear all foreground screen positions.

== (CS) ==

'''Mnemonic''': (CS) Hex equivalent: "@05@" 
'''Discussion''': Clear screen.
The (CS) control code clears the entire screen to foreground blanks and moves the cursor to the home position.
<pre>
Example:
a. 100 FORMAT (CS)
.
PRINT (0,100)
b. PRINT (0) (CS)
</pre>

== (Close Icon) ==
<pre>
Note: This feature is not supported beyond Comet 504.
Mnemonic: (Close Icon)
Hex equivalent: "@CCB8@"
Discussion: This mnemonic draws a graphical "close" icon on the screen, as shown here:

The close icon occupies 2 spaces on the screen.

Note: The (Enhanced Characters On) mnemonic must be used before the (Close Icon) mnemonic us used.

Example: a. 100 FORMAT (Close Icon)
.
PRINT (0,100)

b. PRINT (0) (Close Icon)

</pre>
== Close the mouse ==
Use the following instruction to close the mouse driver:
<pre>
PRINT (0) (Mouse off)
</pre>
See also Show/hide the mouse cursor.

The mouse cursor may be shown or hidden. For mouse-driven applications, you will normally want to show the mouse cursor. For touch-sensitive screen applications, you will normally want to hide the mouse cursor.

To show the regular cursor, use the following instruction:
<pre>
PRINT (0) (Show Mouse Cursor)
</pre>

To hide the regular cursor, use the following instruction:
<pre>
PRINT (0) (Hide Mouse Cursor)
</pre>
Also see Regular cursor display.

==(Copy from Clipboard)==
'''Mnemonic''': (Copy from Clipboard) 
'''Discussion''': This mnemonic, which is used with the system driver (X00), copies the contents from the Windows clipboard into one or more program variables. This mnemonic is issued via a PRINT statement, and the clipboard data is obtained via a subsequent INPUT statement (see example below).

== (Query Clipboard) ==
<pre>

History: This mnemonic was added in REL 01.05 and requires Build 292 or higher.
Example 1: LENGTH 254 & LOCAL RESULT$ ! Define a variable
.
.
.
Open (1) "X00" ! Open system driver
Print (1) (CopyFromClipboard) ! Copy data from clipboard
Input (1) Result$ ! to this variable
Close (1) ! Close system driver

Example 2: LENGTH 254 & LOCAL A$,B$,C$ ! Define 3 variables

CLIP: FORMAT A$;B$;C$ ! FORMAT statement for clipboard data

Open (1) "X00" ! Open system driver
Print (1) (CopyFromClipboard) ! Copy data from clipboard
Input (1,CLIP) ! to the variables in this FORMAT statement
Close (1) ! Close system driver
</pre>
== (Copy to Clipboard) ==
'''Mnemonic''': (Copy to Clipboard) 
'''Discussion''': This mnemonic, which is used with the system driver (X00), copies program data to the Windows clipboard. This mnemonic is issued via a PRINT statement (see examples below).
This mnemonic returns a result string, so it is necessary to issue an INPUT statement following the PRINT statement. However, since this mnemonic should never fail, the result string will not contain any meaningful data.

Also see:
[[#(Copy from Clipboard)]]
[[#(Query Clipboard)]]

History: This mnemonic was added in REL 01.05 and requires Build 292 or higher.
<pre>
Example 1: LENGTH 254 & LOCAL RESULT$
.
Open (1) "X00"
Print (1) (Copy to Clipboard);"This is some data for the clipboard."
Input (1) Result$
Close (1)

Example 2: LENGTH 254 & LOCAL RESULT$,DATA$
.
.
.
DATA$ = "This is some data for the clipboard."
Open (1) "X00"
Print (1) (Copy to Clipboard);DATA$
Input (1) Result$
Close (1)

Example 3: LENGTH 254 & LOCAL RESULT$
.
.
.
Open (1) "X00"
Print (1) (Copy to Clipboard);"" ! Clear the clipboard
Input (1) Result$
Close (1)

</pre>

==(CopyFile)==

'''Mnemonic:''' (CopyFile=source-file,destination-file,flags)

'''Discussion:''' This mnemonic copies the source-file to the destination-file, using the specified flags.

This mnemonic may be used by foreground programs only.

'''Note:''' The (CopyFile) mnemonic is intended to replace (Verify File).

The source-file, which is specified as a full Windows path, UNC path, or directory alias, may be located on a local Comet system/network or a CometAnywhere client system (default is local system).

The destination-file, which is specified as a full Windows path, UNC path, or directory alias, may be located on a local Comet system/network or CometAnywhere client system (default is local system).

When issued on lun (0), this mnemonic copies a file:

*from a local Comet system/network to itself
*from a local Comet system/network to a CometAnywhere client system
*from a CometAnywhere client system to a local Comet system/network
*from the CometAnywhere client system to itself

The mnemonic provides many powerful features, such as an option to compare the source file's modify date with the destination file's modify date (in the case where the destination file already exists) in order to determine whether the source file needs to be copied, an option to display a progress bar during CometAnywhere transfers, and options to create a directory, overwrite an existing file, and create a CAFILE alias if required.

Flags is a numeric value representing the sum of the numeric values listed in the following chart:

'''Flag Description'''

'''1''' The source file is located on the CometAnywhere client system 
'''2''' CometAnywhere is required if remote files are specified

If a flag is set indicating that the source file is located on a CometAnywhere client system (flag='''1''') and/or that the destination file is located on a CometAnywhere client system (flag='''512'''), but the user is running on a local Comet system (i.e., not a CometAnywhere client system):

If this flag is set, an error is reported (see function error 2).
If this flag is not set, Comet substitutes the local drive/path name for a remote path/drive name.

'''64''' Synchronize source and destination files
If the source file is newer than the destination file, or the destination file does not exist, the destination file is updated (assuming that the other flags call for the copying to occur).

If this flag is omitted, the destination file is updated (assuming that the other flags call for the copying to occur).

Note: Different file systems may return file update times in different formats. For example, the NT file system (NTFS) returns file update times in Coordinated Universal Time (abbreviated as UTC; formely known as Greenwich Mean Time), while FAT returns file update times in local time. Therefore, when using this flag, make sure that the source and destination files use the same file system and return the file update times in the same format.

'''128''' Create CAFILES alias if required
If an alias is specified in the destination file name, and the alias doesn't already exist, this flag creates the alias.

'''256''' Don't copy the file; just indicate if an update is needed
See the function error codes (below), particularly values 20 and 21.

'''512''' The destination file is located on the CometAnywhere client system

'''1024''' Show a progress bar for transfers between a local Comet system/network and a CometAnywhere client system

'''2048''' Overwrite existing file
If the destination file already exists, overwrite it with the contents of the source file.

'''4096''' Create directory
If a directory is specified for the destination file, and that directory does not already exist, create it.

After this mnemonic is issued, your program should issue an INPUT on LUN (0) to retrieve success/error information. For example:
<pre>
LENGTH 2 & LOCAL AX$,DX$
ResultFmt: FORMAT AX$;DX$
.
.
Print (CopyFile=Source$,Dest$,Flags)
Input (0,ResultFmt)
</pre>
The first field, AX$, contains the function error code, and the second field, DX$, contains the suberror code (aka the Windows file error code). Both of these fields are in Intel 2's complement format, and should be processed as follows:
<pre>
AX$ = SUB(AX$,2,1) + SUB(AX$,1,1) ! Flip the bytes around
DX$ = SUB(DX$,2,1) + SUB(DX$,1,1) ! Flip the bytes around
FuncError = HexDec(AX$) ! Function error code (decimal)
FileError = HexDec(DX$) ! File error code (decimal)

! For unexpected values, convert to 2's complement signed integer
If (FuncError > 32767) FuncError = FuncError-65536
If (FileError > 32767) FileError = FileError-65536
</pre>
Here is a link to Jons error code summary table [[Comet_Error_Codes#CopyFileErrors:]]

Here is a list of the function error codes in decimal form:
Error
('''FuncError''') Description
'''0''' Function not supported
'''1''' Success -- update performed
'''2''' CometAnywhere required
'''3''' Source file error (see suberrors)
'''4''' Aborted by user
'''5''' Function in progress
'''20''' Success -- update not required
'''21''' Success -- update required
'''22''' Destination file error (see suberrors)

Here is a list of the suberror codes (common Windows file errors) in decimal form:

Suberror
('''FileError''') Description
'''0''' Success
'''2''' File not found
'''3''' Path not found
'''5''' Access denied
'''12''' Invalid access
'''15''' Invalid drive
'''16''' An error has occurred in the current directory
'''18''' No more files
'''32''' Sharing violation
'''33''' Lock violation
'''39''' File located on Remote Computer
'''80''' File exists
'''123''' The Filename, Directory Name, or Volume Label Syntax Is Incorrect
'''161''' Bad pathname
'''1326''' User not logged in to Remote Computer

History: This mnemonic was added in Comet Build 299 and REL Version 01.07.
<pre>
Example 1:
Source$ = "C:\SAMPLEFILES\TEST.TXT"
Dest$ = "A:\TEST.TXT"
Flags = 2048
Print (CopyFile=Source$,Dest$,Flags)
</pre>

This example copies the source file named C:\SAMPLEFILES\TEST.TXT to the destination file named A:\TEST.TXT. By default, both files are located on the local Comet system/network. The flag value of 2048 tells Comet to overwrite the destination file if it exists.
If the copying is successful, the function error code will be equal to 1 (Success -- update performed), and the suberror code will be equal to 0 (Success).

<pre>
Example 2:
Source$ = "C:\FILE1.TXT"
Dest$ = "C:\FILE2.TXT"
Flags = 512 + 2048
Print (CopyFile=Source$,Dest$,Flags)
</pre>

This example copies a source file named C:\FILE1.TXT to a destination file named C:\FILE2.TXT
The sum of the two flags tells Comet that the destination file is on the CometAnywhere client system (512), and to overwrite the destination file if the destination file already exists (2048). By default, the source file is on the local Comet system.

Suppose the flag value was changed to the following:

Flags = 1 + 2048

This would tell Comet that the source file is on the CometAnywhere client system (1), while the destination file (by default) is on the local Comet system. The destination file would be overwritten (2048).
Suppose the flag value was changed to the following:

Flags = 1 + 512 + 2048

In this case, the source and destination files are located on the CometAnywhere client system (1 and 512), and the destination file will be overwritten (2048).

Example 3: Suppose you want to copy a file from a local Comet system to a CometAnywhere client system, and you want to synchronize the files (i.e., copy only if the source file is newer than the destination file).
Here are the flags that are used in the following example:

2 = CometAnywhere is required (otherwise an error occurs)
64 = Synchronize the files
512 = Destination file is on CometAnywhere client system
1024 = Show progress bar
2048 = Overwrite existing file
4096 = Create directory

<pre>
Source$ = "C:\FILE1"
Dest$ = "C:\DATA\FILE2"
Flags = 2 + 64 + 512 + 1024 + 2048 + 4096
Print (CopyFile=Source$,Dest$,Flags)
</pre>

Example 4: Suppose you need to copy a large file between a local Comet system and a CometAnywhere client system, but before copying you want to check and see if (a) the update is needed, and (b) if the user wants to perform the update now.
This is done in two steps. First, use the flag that checks to see if the update is required without copying the file (flag=256). If the update is required (as indicated by FuncError=21), then proceed with the copying (change the flags to copy the file).

<pre>
Source$ = "C:\BIGFILE" ! on local Comet system
Dest$ = "C:\BIGFILE" ! on CometAnywhere client system

Flags = 256 + 512 ! 256 = don't copy file; just check to
! see if updated is needed
! 512 = destination is on
! CometAnywhere system

Print (CopyFile=Source$,Dest$,Flags)
Input (0,ResultFmt)

AX$ = SUB(AX$,2,1) + SUB(AX$,1,1) ! Flip the bytes around
DX$ = SUB(DX$,2,1) + SUB(DX$,1,1) ! Flip the bytes around
FuncError = HexDec(AX$) ! Function error code (decimal)
FileError = HexDec(DX$) ! File error code (decimal)

! For unexpected values, convert to 2's complement signed integer
If (FuncError > 32767) FuncError = FuncError-65536
If (FileError > 32767) FileError = FileError-65536

If FuncError = 21
Print "The file needs to be updated."
Print "Do you want to update it now?"
Input A$

If A$ = "Y"
Flags = 512 + 2048
Print (CopyFile=Source$,Dest$,Flags)
Input (0,ResultFmt)
.
.
.
EndIf
EndIf
</pre>

Notes: Depending on your situation you might try using the CUtlCpy utility which is released as part of the UTL directory. You can ENTER it from your app to easily accomplish a file copy or move.
To use a directory alias as the pathname for either of the filenames you can do it like this: FileName$ = "$(AliasNameHere)\" + thefilename$

==(CPL132)==

'''Mnemonic''': (CPL132) Hex equivalent: "@040009@"

'''Discussion''': This mnemonic sets the video display mode to 132 characters per line.
Also see [[#(Screen)]], [[#(CPL64)]], [[#(CPL80)]], and [[#(DE)]].
<pre>
Example:
a. 100 FORMAT (CPL132)
.
PRINT (0,100)
b. PRINT (0) (CPL132)
</pre>

==(CPL64)==

'''Mnemonic''': (CPL64) Hex equivalent: "@0402@"

'''Discussion''': The (CPL64) control code sets the screen display mode to 64 characters per line by 27 lines. The screen is cleared to foreground blanks and the cursor is moved to the "home" position. (Note: In normal mode, the cursor will be moved to the upper left corner of the screen. If typewriter mode is in effect, the cursor will be moved to the lower left corner of the screen.)
This control code may be overridden by the system configuration (if the configuration forces the screen display to 80 columns, for example).

Also see [[#(Screen)]], [[#(CPL132)]], [[#(CPL80)]], and [[#(DE)]].
<pre>
Example:
a. 100 FORMAT (CPL64)
.
PRINT (0,100)

b. PRINT (0) (CPL64)
</pre>

==(CPL80)==
'''Mnemonic''': (CPL80) Hex equivalent: "@0403@"

'''Discussion''': The (CPL80) control code sets the screen display mode to 80 characters per line by 24 lines. The screen is cleared to foreground blanks and the cursor is moved to the "home" position. (Note: In normal mode, the cursor will be moved to the upper left corner of the screen. If typewriter mode is in effect, the cursor will be moved to the lower left corner of the screen.)
Also see [[#(Screen)]], [[#(CPL132)]], [[#(CPL64)]], and [[#(DE)]].
<pre>
Example:
a. 100 FORMAT (CPL80)
.
PRINT (0,100)

b. PRINT (0) (CPL80)
</pre>

==(CR)==
'''Mnemonic''': (CR)

'''Discussion''': Cursor return/carriage return.
This control code can be used on a video device or a printer.

'''Video device'''
In normal mode, the (CR) control code moves the cursor to the first foreground position on the following line. If the cursor is on the bottom line when this control code is issued, the cursor will be moved to the top line of the screen. In either case, the cursor will land only in a foreground field.

In typewriter mode, this control code scrolls the screen up one line (forcing the top line off the screen) and will move the cursor to the beginning (left side) of the bottom line on the screen.

'''Printer'''
The (CR) control code performs a carriage return function for the printer. If this control is issued in the middle of a print line, it advances the printer to the beginning of the next line (unlike a line feed control, which would skip the next line and move to the beginning of the following line).
<pre>
Example (video):
a. 100 FORMAT (CR)
.
PRINT (0,100)

b. PRINT (0) (CR)

Example (printer):
a. 100 FORMAT "CUSTOMER LISTING";(CR);"PRINTED ON:";DAY$
.
OPEN (1) "LP1"
.
PRINT (1,100)

b. OPEN (1) "LP1"
.
PRINT (1) "CUSTOMER LISTING";(CR);"PRINTED ON:";DAY$
</pre>
This last example prints a heading, performs a carriage return, and then prints a subheading on the next line.

==(Create Window)==
'''Mnemonic''': (Create Window=a,b,c,d)
where:
a = upper left column (decimal)
b = upper left row (decimal)
c = lower right column (decimal)
d = lower right row (decimal)

Hex equivalent: "@0E0D00wwxxyyzz@"
where:
ww = upper left row (hex)
xx = upper left column (hex)
yy = lower right row (hex)
zz = lower right column (hex)

'''Discussion''': This mnemonic creates a Comet window using the specified screen coordinates. Note: These coordinates are relative to the full screen (e.g., column 0, row 0 always represents the upper left corner of the display).
When a window is created, the amount of available window memory decreases by the size of the window. To determine how much window memory remains, perform a numeric input immediately following the creation of a window. See the window memory page for more information. If you do not need to know how much window memory remains, perform a null INPUT immediately after printing the (Create Window) mnemonic.

Also see the discussion on Comet windows.
<pre>
Example:
a. 100 FORMAT (Create Window=2,3,70,20)
.
PRINT (0,100)
INPUT (0) ""

b. PRINT (0) (Create Window=2,3,70,20)
INPUT (0) ""
</pre>
This example show how to create a Comet window from column 2, row 3 (the upper left corner) to column 70, row 20 (the lower right corner). The INPUT (0) "" statement allows the program to bypass the value that is returned from the (Create Window) mnemonic (the amount of remaining window memory).

==(CreateWindowEx)==

'''Mnemonic''': (CreateWindowEx=column,row,width,height,style,flags,caption$)

'''Discussion''': This mnemonic creates and selects an extended window, using the following parameters: 
'''Parameter Description''' 
'''column''' The column location of the upper, left-hand corner of the window. This numeric value is expressed in QCRT characters or screen pixels, depending on the value of the flags (see below). 
'''row''' The row location of the upper, left-hand corner of the window. This numeric value is expressed in QCRT characters or screen pixels, depending on the value of the flags (see below). 
'''width''' The width of the window. This numeric value is expressed in QCRT characters. 
'''height''' The height of the window. This numeric value is expressed in QCRT characters. 
'''style''' The style of Window. This numeric value is the sum of the following options: 
'''Style Value Meaning''' 
'''1''' A popup window. The window can be moved outside of Comet window. This value should not be used with 2 (which specifies a child window). 
'''2''' A child window. The window remains within the view window. This value should not be used with 1 (which specifies a popup window). 
'''4''' The window includes a caption bar. 
'''8''' The window includes a border. 
'''16''' The caption bar includes an "X" which closes the window. 
Note: Clicking on the "X" causes an (EasyScan) event to be reported to the Internet Basic program. The EasyScan value is 15. 
'''32''' The window includes a thick frame that lets the user resize the window. 
'''64''' The window is visible. 

'''flags''' The flags for the window. This numeric value is the sum of the following options:
Value Meaning 
'''0''' A modeless window (also known as a user-selectable window). 
Note: If multiple Comet windows are displayed, the user can select which window is the active one by clicking the caption bar. The Internet Basic program can determine the handle of the the window from which data was transmitted via the STS function. 
'''1''' A modal window. All other Comet windows are disabled until this window closes. 
'''2''' A child window with no frame (border). This flag can be used to simulate a legacy Comet window (see CreateWindow). 
'''4''' The window includes a message line (also known as a control line). Any text written with the (WC) mnemonic will be displayed on the message line within this window. 

The following flags pertain to non-child windows only:

'''Value Meaning''' 
'''8''' The column and row positions are expressed in screen pixels, and are relative to the screen (i.e., 0,0 = the upper, left-hand pixel of the screen). 
'''16''' The column and row positions are expressed in screen pixels, and are relative to the client window (i.e., 0,0 = the upper, left-hand pixel of the client window). 
'''32''' The column and row positions are expressed in screen pixels, and are relative to the frame window (i.e., 0,0 = the upper, left-hand pixel of the frame window). 

'''caption$''' If the caption bar style is in effect, this string value is displayed on the caption bar.

Each extended window is identified by a 4-byte string known as a window handle. The handle value is assigned by the system and returned to the Internet Basic program via an INPUT statement following the (CreateWindowEx) mnemonic, as follows:
<pre>
Length 4 & Local Handle1$
.
Print (CreateWindowEx=0,0,35,15,68,1,"This is the caption")
Input Handle1$
</pre>
It follows that the Internet Basic program can create multiple extended windows. The program can select which window to use via the (SelectWindowEx) mnemonic.
An extended window is deleted via the (DeleteWindowEx) mnemonic.

Note: If you write a program that displays more than one extended window at a time, your program may need some way to distinguish which window was active at the time that data was input. The STS function returns the handle of the window that generated the input. This 4-byte value starts in position 11, as shown here:
<pre>
Length 4 & Local Handle$
.
Handle$ = SUB(STS(0),11,4)
</pre>
Symbolic constants: Symbolic constants can be very useful when dealing with the multiple style and flag values. For example, here is a list of recommended symbolic constants for extended windows:
<pre>
'''! Window style'''
SET COS.WS.POPUP = 1 ! Can be moved outside of Comet window. Should
! not be used with COS.WS.CHILD.
SET COS.WS.CHILD = 2 ! Remains within view window. Should not be used
! with COS.WS.POPUP.
SET COS.WS.CAPTION = 4 ! Includes a caption bar
SET COS.WS.BORDER = 8 ! Window includes a border
SET COS.WS.SYSMENU = 16 ! Caption bar 'X' closes window
SET COS.WS.THICKFRAME = 32 ! Thick frame for sizing
SET COS.WS.VISIBLE = 64 ! Window is visible
SET COS.WS.POPUPWINDOW = 25 ! (COS.WS.POPUP+COS.WS.BORDER+COS.WS.SYSMENU)

'''! Window flags'''
SET COS.WF.MODELESS = 0 ! - User selectable window - Use EasyScan
! to determine when a window is activated.
SET COS.WF.MODAL = 1 ! - All other windows are disabled until
! this window closes
SET COS.WF.NOFRAME = 2 ! Create CHILD window with no frame (border).
! Used to simulate a Comet window
SET COS.WF.MSGLINE = 4 ! Has a message line

! The following flags pertain to non-child windows only
SET COS.WF.SCNPIXELPOS = 8 ! Position is in pixels, screen relative
SET COS.WF.CLIPIXELPOS = 16 ! Position is in pixels, client window relative
SET COS.WF.FRMPIXELPOS = 32 ! Position is in pixels, frame window relative
</pre>
With these symbolic constants in place, you can specify the style and flag values by writing a symbolic "formula," as follows:
<pre>
Length 3.0 & Local Style, Flags
Length 5 & Local Handle1$
.
.
Style = COS.WS.POPUPWINDOW + COS.WS.CAPTION
Flags = COS.WF.MODAL + COS.WF.MSGLINE + COS.WF.CLIPIXELPOS
Print (CreateWindowEx=0,0,35,15,Style,Flags,"This is the caption")
Input Handle1$
</pre>

History: This feature is supported in Comet2002 Build 306 and higher.
Examples: See the WinDemo.ibs program (available at www.signature.net/download/demos) for examples of extended windows. This demo program includes many combinations of the style and flags parameters, and also demonstrates some very useful applications for extended windows.

==(CrMode)==

'''Mnemonic''': (CrMode=mode)

'''Discussion''': This mnemonic controls the action of the Enter key. The following values may be used: 
'''0''' = default (from SYSGEN) 
'''1''' = Enter key works like Tab 
'''2''' = Enter key behaves like a CR (goes to beginning of next line unless a TM or TP is encountered) 
History: This mnemonic was added in REL 00.06.
<pre>
Example:
a. 100 FORMAT (CrMode=1)
.
PRINT (0,100)

b. PRINT (0) (CrMode=1)
</pre>
This example shows how to make the Enter key work like the Tab key.

==(CS)==
'''Mnemonic''': (CS) Hex equivalent: "@05@"

'''Discussion''': Clear screen.
The (CS) control code clears the entire screen to foreground blanks and moves the cursor to the home position.
<pre>
Example:
a. 100 FORMAT (CS)
.
PRINT (0,100)

b. PRINT (0) (CS)
</pre>

==(CH)==
'''Mnemonic''': (CH) Hex equivalent:

'''Discussion''': Cursor home. 
The (CH) control code moves the cursor to the "home" position on the screen. Home position is the upper left foreground location of the screen. Since the cursor will land only in a foreground area, "home" may be something other than the upper left corner.

For example, if the upper left corner of the screen contains background or invisible (suppressed background) characters, the cursor will search to the right and to the next line(s) if necessary for the first available foreground position.

Once a foreground field is located, the cursor will be positioned at the first location in that field (left-most position for alphanumeric fields and right-most position for right-justified numeric fields).
<pre>
Example:
a. 100 FORMAT (CH)
.
PRINT (0,100)

b. PRINT (0) (CH)
</pre>
This example shows how to move the cursor to the home position.

==(CR)==
'''Mnemonic''': (CR)

'''Discussion''': Cursor return/carriage return.
This control code can be used on a video device or a printer.

'''Video device'''
In normal mode, the (CR) control code moves the cursor to the first foreground position on the following line. If the cursor is on the bottom line when this control code is issued, the cursor will be moved to the top line of the screen. In either case, the cursor will land only in a foreground field.

In typewriter mode, this control code scrolls the screen up one line (forcing the top line off the screen) and will move the cursor to the beginning (left side) of the bottom line on the screen.

'''Printer'''
The (CR) control code performs a carriage return function for the printer. If this control is issued in the middle of a print line, it advances the printer to the beginning of the next line (unlike a line feed control, which would skip the next line and move to the beginning of the following line).
<pre>
Example (video):
a. 100 FORMAT (CR)
.
PRINT (0,100)

b. PRINT (0) (CR)

Example (printer):
a. 100 FORMAT "CUSTOMER LISTING";(CR);"PRINTED ON:";DAY$
.
OPEN (1) "LP1"
.
PRINT (1,100)

b. OPEN (1) "LP1"
.
PRINT (1) "CUSTOMER LISTING";(CR);"PRINTED ON:";DAY$
</pre>
This last example prints a heading, performs a carriage return, and then prints a subheading on the next line.

Mnemonics "C"

2009-09-04T20:35:16Z

SteveA: /* (CS) */

== (CA Sessions) ==

'''Mnemonic''': (CA Sessions=maximum-number-of-sessions)

'''Discussion''': This mnemonic sets a limit on the number of CometAnywhere sessions. The maximum-number-of-sessions is a decimal value. To get information on the current setting, set the argument to 0 and follow the mnemonic with an INPUT (see example 2).

Example 1: Print (CA Sessions=3)

This example sets the maximum number of CometAnywhere sessions to 3.

Example 2: Print (CA Sessions=0) Input A$

This example sets the argument to 0.

As a result, the current setting is returned to the string variable contained in the next INPUT statement following the mnemonic. The return value is a one-byte hex string. For example, if the current maximum-number-of-sessions is 3, the hex value "@03@" is assigned to A$.

== (CapsOff) ==
<pre>
Mnemonic: (CapsOff) Discussion: This mnemonic turns the Caps Lock keyboard function off. See (CapsOn).

Example: Print (CapsOff)

</pre>
== (CapsOn) ==
<pre>
Mnemonic: (CapsOn) Discussion: This mnemonic turns the Caps Lock keyboard function on. See (CapsOff).

Example: Print (CapsOn)
</pre>
== (CC) ==
'''Email Mnemonic:''' (CC=string-argument)

'''Discussion:''' The (CC) mnemonic may be used to specify the "carbon copy" recipients of your email message. Example: OPEN (1) "LEH" PRINT (1) (CC="barbara@@signature.net")

== (CF) ==
'''Mnemonic''': (CF) Hex equivalent: "@06@"

'''Discussion''': Clear foreground. The (CF) control code clears all foreground screen positions to foreground blanks and positions the cursor at the first foreground position on the screen (the upper left corner). This control does not affect background or invisible (suppressed background) screen positions.

This control code is typically used to clear input data from a formatted screen after it is entered in order to prepare for the next set of input data.
<PRE>
Example: a. 100 FORMAT (CF)
.
PRINT (0,100)
b. PRINT (0) (CF)
</pre>
This example shows how to clear all foreground screen positions.

Read about other Email Mnemonics

== (CFLD) ==
'''Mnemonic''': (CFLD) Hex equivalent: "@0407@"

'''Discussion''': Clear field. The (CFLD) control code clears all foreground characters in a field in which the cursor is located and replaces them with foreground blanks. It then positions the cursor in the first position of the field (left-most position for alphanumeric fields and right-most position for right-justified numeric fields). The control code does not affect background or invisible (suppressed background) fields.

This control code may also include a positioning statement to start the clearing operation at a specific point on the screen.
<pre>
Example:
a. 100 FORMAT (CFLD),@(10,0)
.
PRINT (0,100)
b. PRINT (0) (CFLD),@(10,0)
</pre>
These examples demonstrates the "clear field" control code. The positioning statement puts the control into action at column 10, row 0. If this location is a foreground field, it will be cleared to foreground blanks (if not, the control code will do nothing).

== (CH) ==

'''Mnemonic''': (CH) Hex equivalent:

'''Discussion''': Cursor home. The (CH) control code moves the cursor to the "home" position on the screen. Home position is the upper left foreground location of the screen. Since the cursor will land only in a foreground area, "home" may be something other than the upper left corner.

For example, if the upper left corner of the screen contains background or invisible (suppressed background) characters, the cursor will search to the right and to the next line(s) if necessary for the first available foreground position.

Once a foreground field is located, the cursor will be positioned at the first location in that field (left-most position for alphanumeric fields and right-most position for right-justified numeric fields).
<pre>
Example:
a. 100 FORMAT (CH)
.
PRINT (0,100)
b. PRINT (0) (CH)
</pre>
This example shows how to move the cursor to the home position.

== (Change Color) ==

'''Mnemonic''': (Change Color=ARG1$) Hex equivalent: "@0E0E0Bxx00@" where: xx = the foreground color

'''Discussion''': This mnemonic changes the foreground color attribute on the Comet console, and is effective only for the current write operation. ARG1$ is the foreground color; it may be a string constant or a string variable containing the hex representation of the screen color.

See [[Screen Colors]] for a list of color codes.

Also see [[#(Change Colors)]] for a way to change all of the screen colors.
<pre>
Example:
a. 100 FORMAT (Change Color="@07@")
.
PRINT (0,100)
b. PRINT (0) (Change Color="@07@")
</pre>

==(Change Colors)==
'''Mnemonic:''' (Change Colors=ARG1$,ARG2$,ARG3$,ARG4$,ARG5$)

'''Hex equivalent:''' "@0E0E0Evvwwxxyyzz@" where: vv = the foreground color ww = the background color xx = the invisible color (for TM's, TP's, and RJ's) yy = the border color zz = the entry field color

'''Discussion:''' The mnemonic changes all of the screen colors on the Comet console, or within the current Comet window. ARG1$ is the foreground color ARG2$ is the background color ARG3$ is the invisible color (for TM's, TP's, and RJ's) ARG4$ is the border color ARG5$ is the entry field color

All of these arguments are in hex and may be string constants or a string variable containing the hex representation of the screen color.

See [[Screen Colors]] for a list of color codes.

Also see ([[#Change Color]]) for a way to change the foreground color only.
<pre>
Example:
a. 100 FORMAT (Change colors="@0F@","@A0@","@00@","@C0@","@0F@")
.
PRINT (0,100)
b. Print (0) (Change colors="@0F@","@A0@","@00@","@C0@","@0F@")
</pre>

==(CPL132)==
'''Mnemonic''': (CPL132) Hex equivalent: "@040009@"

'''Discussion''': This mnemonic sets the video display mode to 132 characters per line. Also see ([[#Screen]]), ([[#CPL64]]), ([[#CPL80]]), and ([[#DE]]).
<pre>
Example:
a. 100 FORMAT (CPL132)
.
PRINT (0,100)
b. PRINT (0) (CPL132)
</pre>

==(CPL64)==

'''Mnemonic''': (CPL64) Hex equivalent: "@0402@"

'''Discussion''': The (CPL64) control code sets the screen display mode to 64 characters per line by 27 lines. The screen is cleared to foreground blanks and the cursor is moved to the "home" position. (Note: In normal mode, the cursor will be moved to the upper left corner of the screen. If typewriter mode is in effect, the cursor will be moved to the lower left corner of the screen.) This control code may be overridden by the system configuration (if the configuration forces the screen display to 80 columns, for example).

Also see [[#(Screen)]], [[#(CPL132)]], [[#(CPL80)]], and [[#(DE)]].
<pre>
Example:
a. 100 FORMAT (CPL64)
.
PRINT (0,100)
b. PRINT (0) (CPL64)
</pre>

==(CPL80)==

'''Mnemonic''': (CPL80) Hex equivalent: "@0403@"

'''Discussion''': The (CPL80) control code sets the screen display mode to 80 characters per line by 24 lines. The screen is cleared to foreground blanks and the cursor is moved to the "home" position. (Note: In normal mode, the cursor will be moved to the upper left corner of the screen. If typewriter mode is in effect, the cursor will be moved to the lower left corner of the screen.) Also see [[#(Screen)]], [[#(CPL132)]], [[#(CPL64)]], and [[#(DE)]].
</pre>
Example:
a. 100 FORMAT (CPL80)
.
PRINT (0,100)
b. PRINT (0) (CPL80)
</pre>

== (Check Box Off) ==
<pre>
Note: This feature is not supported beyond Comet 504. Mnemonic: (Check Box Off) Hex equivalent: "@CAC6B6@" Discussion: This mnemonic draws a graphical check box on the screen. The check box is in the "off" position (i.e., no check mark appears in the box), as shown here:

The check box symbol occupies 3 spaces on the screen.

Note: The (Enhanced Characters On) mnemonic must be used before the (Check Box Off) mnemonic us used.

Also see (Check Box On).

Example: a. 100 FORMAT (Check Box Off)

.
PRINT (0,100)
b. PRINT (0) (Check Box Off)

</pre>
== (Check Box On) ==
<pre>
Note: This feature is not supported beyond Comet 504. Mnemonic: (Check Box On) Hex equivalent: "@CACEB6@" Discussion: This mnemonic draws a graphical check box on the screen. The check box is in the "on" position (i.e., a check mark appears in the box), as shown here:

The check box symbol occupies 3 spaces on the screen.

Note: The (Enhanced Characters On) mnemonic must be used before the (Check Box On) mnemonic us used.

Also see (Check Box Off).

Example: a. 100 FORMAT (Check Box On)

.
PRINT (0,100)
b. PRINT (0) (Check Box On)

Retrieved from "http://64.142.11.195/index.php/Mnemonics"
</pre>
== (CFLD) ==

'''Mnemonic''': (CFLD) Hex equivalent: "@0407@"

'''Discussion''': Clear field. 
The (CFLD) control code clears all foreground characters in a field in which the cursor is located and replaces them with foreground blanks. It then positions the cursor in the first position of the field (left-most position for alphanumeric fields and right-most position for right-justified numeric fields). The control code does not affect background or invisible (suppressed background) fields.

This control code may also include a positioning statement to start the clearing operation at a specific point on the screen.
<pre>
Example:
a. 100 FORMAT (CFLD),@(10,0)
.
PRINT (0,100)
b. PRINT (0) (CFLD),@(10,0)
</pre>
This example demonstrates the "clear field" control code. The positioning statement puts the control into action at column 10, row 0. If this location is a foreground field, it will be cleared to foreground blanks (if not, the control code will do nothing).

== (CF) ==

'''Mnemonic''': (CF) Hex equivalent: "@06@" 
'''Discussion''': Clear foreground.
The (CF) control code clears all foreground screen positions to foreground blanks and positions the cursor at the first foreground position on the screen (the upper left corner). This control does not affect background or invisible (suppressed background) screen positions.

This control code is typically used to clear input data from a formatted screen after it is entered in order to prepare for the next set of input data.
<pre>
Example:
a. 100 FORMAT (CF)
.
PRINT (0,100)
b. PRINT (0) (CF)
</pre>
This example shows how to clear all foreground screen positions.

== (CS) ==

'''Mnemonic''': (CS) Hex equivalent: "@05@" 
'''Discussion''': Clear screen.
The (CS) control code clears the entire screen to foreground blanks and moves the cursor to the home position.
<pre>
Example:
a. 100 FORMAT (CS)
.
PRINT (0,100)
b. PRINT (0) (CS)
</pre>

== (Close Icon) ==
<pre>
Note: This feature is not supported beyond Comet 504.
Mnemonic: (Close Icon)
Hex equivalent: "@CCB8@"
Discussion: This mnemonic draws a graphical "close" icon on the screen, as shown here:

The close icon occupies 2 spaces on the screen.

Note: The (Enhanced Characters On) mnemonic must be used before the (Close Icon) mnemonic us used.

Example: a. 100 FORMAT (Close Icon)
.
PRINT (0,100)

b. PRINT (0) (Close Icon)

</pre>
== Close the mouse ==
Use the following instruction to close the mouse driver:
<pre>
PRINT (0) (Mouse off)
</pre>
See also Show/hide the mouse cursor.

The mouse cursor may be shown or hidden. For mouse-driven applications, you will normally want to show the mouse cursor. For touch-sensitive screen applications, you will normally want to hide the mouse cursor.

To show the regular cursor, use the following instruction:
<pre>
PRINT (0) (Show Mouse Cursor)
</pre>

To hide the regular cursor, use the following instruction:
<pre>
PRINT (0) (Hide Mouse Cursor)
</pre>
Also see Regular cursor display.

==(Copy from Clipboard)==
'''Mnemonic''': (Copy from Clipboard) 
'''Discussion''': This mnemonic, which is used with the system driver (X00), copies the contents from the Windows clipboard into one or more program variables. This mnemonic is issued via a PRINT statement, and the clipboard data is obtained via a subsequent INPUT statement (see example below).

== (Query Clipboard) ==
<pre>

History: This mnemonic was added in REL 01.05 and requires Build 292 or higher.
Example 1: LENGTH 254 & LOCAL RESULT$ ! Define a variable
.
.
.
Open (1) "X00" ! Open system driver
Print (1) (CopyFromClipboard) ! Copy data from clipboard
Input (1) Result$ ! to this variable
Close (1) ! Close system driver

Example 2: LENGTH 254 & LOCAL A$,B$,C$ ! Define 3 variables

CLIP: FORMAT A$;B$;C$ ! FORMAT statement for clipboard data

Open (1) "X00" ! Open system driver
Print (1) (CopyFromClipboard) ! Copy data from clipboard
Input (1,CLIP) ! to the variables in this FORMAT statement
Close (1) ! Close system driver
</pre>
== (Copy to Clipboard) ==
'''Mnemonic''': (Copy to Clipboard) 
'''Discussion''': This mnemonic, which is used with the system driver (X00), copies program data to the Windows clipboard. This mnemonic is issued via a PRINT statement (see examples below).
This mnemonic returns a result string, so it is necessary to issue an INPUT statement following the PRINT statement. However, since this mnemonic should never fail, the result string will not contain any meaningful data.

Also see:
[[#(Copy from Clipboard)]]
[[#(Query Clipboard)]]

History: This mnemonic was added in REL 01.05 and requires Build 292 or higher.
<pre>
Example 1: LENGTH 254 & LOCAL RESULT$
.
Open (1) "X00"
Print (1) (Copy to Clipboard);"This is some data for the clipboard."
Input (1) Result$
Close (1)

Example 2: LENGTH 254 & LOCAL RESULT$,DATA$
.
.
.
DATA$ = "This is some data for the clipboard."
Open (1) "X00"
Print (1) (Copy to Clipboard);DATA$
Input (1) Result$
Close (1)

Example 3: LENGTH 254 & LOCAL RESULT$
.
.
.
Open (1) "X00"
Print (1) (Copy to Clipboard);"" ! Clear the clipboard
Input (1) Result$
Close (1)

</pre>

==(CopyFile)==

'''Mnemonic:''' (CopyFile=source-file,destination-file,flags)

'''Discussion:''' This mnemonic copies the source-file to the destination-file, using the specified flags.

This mnemonic may be used by foreground programs only.

'''Note:''' The (CopyFile) mnemonic is intended to replace (Verify File).

The source-file, which is specified as a full Windows path, UNC path, or directory alias, may be located on a local Comet system/network or a CometAnywhere client system (default is local system).

The destination-file, which is specified as a full Windows path, UNC path, or directory alias, may be located on a local Comet system/network or CometAnywhere client system (default is local system).

When issued on lun (0), this mnemonic copies a file:

*from a local Comet system/network to itself
*from a local Comet system/network to a CometAnywhere client system
*from a CometAnywhere client system to a local Comet system/network
*from the CometAnywhere client system to itself

The mnemonic provides many powerful features, such as an option to compare the source file's modify date with the destination file's modify date (in the case where the destination file already exists) in order to determine whether the source file needs to be copied, an option to display a progress bar during CometAnywhere transfers, and options to create a directory, overwrite an existing file, and create a CAFILE alias if required.

Flags is a numeric value representing the sum of the numeric values listed in the following chart:

'''Flag Description'''

'''1''' The source file is located on the CometAnywhere client system 
'''2''' CometAnywhere is required if remote files are specified

If a flag is set indicating that the source file is located on a CometAnywhere client system (flag='''1''') and/or that the destination file is located on a CometAnywhere client system (flag='''512'''), but the user is running on a local Comet system (i.e., not a CometAnywhere client system):

If this flag is set, an error is reported (see function error 2).
If this flag is not set, Comet substitutes the local drive/path name for a remote path/drive name.

'''64''' Synchronize source and destination files
If the source file is newer than the destination file, or the destination file does not exist, the destination file is updated (assuming that the other flags call for the copying to occur).

If this flag is omitted, the destination file is updated (assuming that the other flags call for the copying to occur).

Note: Different file systems may return file update times in different formats. For example, the NT file system (NTFS) returns file update times in Coordinated Universal Time (abbreviated as UTC; formely known as Greenwich Mean Time), while FAT returns file update times in local time. Therefore, when using this flag, make sure that the source and destination files use the same file system and return the file update times in the same format.

'''128''' Create CAFILES alias if required
If an alias is specified in the destination file name, and the alias doesn't already exist, this flag creates the alias.

'''256''' Don't copy the file; just indicate if an update is needed
See the function error codes (below), particularly values 20 and 21.

'''512''' The destination file is located on the CometAnywhere client system

'''1024''' Show a progress bar for transfers between a local Comet system/network and a CometAnywhere client system

'''2048''' Overwrite existing file
If the destination file already exists, overwrite it with the contents of the source file.

'''4096''' Create directory
If a directory is specified for the destination file, and that directory does not already exist, create it.

After this mnemonic is issued, your program should issue an INPUT on LUN (0) to retrieve success/error information. For example:
<pre>
LENGTH 2 & LOCAL AX$,DX$
ResultFmt: FORMAT AX$;DX$
.
.
Print (CopyFile=Source$,Dest$,Flags)
Input (0,ResultFmt)
</pre>
The first field, AX$, contains the function error code, and the second field, DX$, contains the suberror code (aka the Windows file error code). Both of these fields are in Intel 2's complement format, and should be processed as follows:
<pre>
AX$ = SUB(AX$,2,1) + SUB(AX$,1,1) ! Flip the bytes around
DX$ = SUB(DX$,2,1) + SUB(DX$,1,1) ! Flip the bytes around
FuncError = HexDec(AX$) ! Function error code (decimal)
FileError = HexDec(DX$) ! File error code (decimal)

! For unexpected values, convert to 2's complement signed integer
If (FuncError > 32767) FuncError = FuncError-65536
If (FileError > 32767) FileError = FileError-65536
</pre>
Here is a link to Jons error code summary table [[Comet_Error_Codes#CopyFileErrors:]]

Here is a list of the function error codes in decimal form:
Error
('''FuncError''') Description
'''0''' Function not supported
'''1''' Success -- update performed
'''2''' CometAnywhere required
'''3''' Source file error (see suberrors)
'''4''' Aborted by user
'''5''' Function in progress
'''20''' Success -- update not required
'''21''' Success -- update required
'''22''' Destination file error (see suberrors)

Here is a list of the suberror codes (common Windows file errors) in decimal form:

Suberror
('''FileError''') Description
'''0''' Success
'''2''' File not found
'''3''' Path not found
'''5''' Access denied
'''12''' Invalid access
'''15''' Invalid drive
'''16''' An error has occurred in the current directory
'''18''' No more files
'''32''' Sharing violation
'''33''' Lock violation
'''39''' File located on Remote Computer
'''80''' File exists
'''123''' The Filename, Directory Name, or Volume Label Syntax Is Incorrect
'''161''' Bad pathname
'''1326''' User not logged in to Remote Computer

History: This mnemonic was added in Comet Build 299 and REL Version 01.07.
<pre>
Example 1:
Source$ = "C:\SAMPLEFILES\TEST.TXT"
Dest$ = "A:\TEST.TXT"
Flags = 2048
Print (CopyFile=Source$,Dest$,Flags)
</pre>

This example copies the source file named C:\SAMPLEFILES\TEST.TXT to the destination file named A:\TEST.TXT. By default, both files are located on the local Comet system/network. The flag value of 2048 tells Comet to overwrite the destination file if it exists.
If the copying is successful, the function error code will be equal to 1 (Success -- update performed), and the suberror code will be equal to 0 (Success).

<pre>
Example 2:
Source$ = "C:\FILE1.TXT"
Dest$ = "C:\FILE2.TXT"
Flags = 512 + 2048
Print (CopyFile=Source$,Dest$,Flags)
</pre>

This example copies a source file named C:\FILE1.TXT to a destination file named C:\FILE2.TXT
The sum of the two flags tells Comet that the destination file is on the CometAnywhere client system (512), and to overwrite the destination file if the destination file already exists (2048). By default, the source file is on the local Comet system.

Suppose the flag value was changed to the following:

Flags = 1 + 2048

This would tell Comet that the source file is on the CometAnywhere client system (1), while the destination file (by default) is on the local Comet system. The destination file would be overwritten (2048).
Suppose the flag value was changed to the following:

Flags = 1 + 512 + 2048

In this case, the source and destination files are located on the CometAnywhere client system (1 and 512), and the destination file will be overwritten (2048).

Example 3: Suppose you want to copy a file from a local Comet system to a CometAnywhere client system, and you want to synchronize the files (i.e., copy only if the source file is newer than the destination file).
Here are the flags that are used in the following example:

2 = CometAnywhere is required (otherwise an error occurs)
64 = Synchronize the files
512 = Destination file is on CometAnywhere client system
1024 = Show progress bar
2048 = Overwrite existing file
4096 = Create directory

<pre>
Source$ = "C:\FILE1"
Dest$ = "C:\DATA\FILE2"
Flags = 2 + 64 + 512 + 1024 + 2048 + 4096
Print (CopyFile=Source$,Dest$,Flags)
</pre>

Example 4: Suppose you need to copy a large file between a local Comet system and a CometAnywhere client system, but before copying you want to check and see if (a) the update is needed, and (b) if the user wants to perform the update now.
This is done in two steps. First, use the flag that checks to see if the update is required without copying the file (flag=256). If the update is required (as indicated by FuncError=21), then proceed with the copying (change the flags to copy the file).

<pre>
Source$ = "C:\BIGFILE" ! on local Comet system
Dest$ = "C:\BIGFILE" ! on CometAnywhere client system

Flags = 256 + 512 ! 256 = don't copy file; just check to
! see if updated is needed
! 512 = destination is on
! CometAnywhere system

Print (CopyFile=Source$,Dest$,Flags)
Input (0,ResultFmt)

AX$ = SUB(AX$,2,1) + SUB(AX$,1,1) ! Flip the bytes around
DX$ = SUB(DX$,2,1) + SUB(DX$,1,1) ! Flip the bytes around
FuncError = HexDec(AX$) ! Function error code (decimal)
FileError = HexDec(DX$) ! File error code (decimal)

! For unexpected values, convert to 2's complement signed integer
If (FuncError > 32767) FuncError = FuncError-65536
If (FileError > 32767) FileError = FileError-65536

If FuncError = 21
Print "The file needs to be updated."
Print "Do you want to update it now?"
Input A$

If A$ = "Y"
Flags = 512 + 2048
Print (CopyFile=Source$,Dest$,Flags)
Input (0,ResultFmt)
.
.
.
EndIf
EndIf
</pre>

Notes: Depending on your situation you might try using the CUtlCpy utility which is released as part of the UTL directory. You can ENTER it from your app to easily accomplish a file copy or move.
To use a directory alias as the pathname for either of the filenames you can do it like this: FileName$ = "$(AliasNameHere)\" + thefilename$

==(CPL132)==

'''Mnemonic''': (CPL132) Hex equivalent: "@040009@"

'''Discussion''': This mnemonic sets the video display mode to 132 characters per line.
Also see [[#(Screen)]], [[#(CPL64)]], [[#(CPL80)]], and [[#(DE)]].
<pre>
Example:
a. 100 FORMAT (CPL132)
.
PRINT (0,100)
b. PRINT (0) (CPL132)
</pre>

==(CPL64)==

'''Mnemonic''': (CPL64) Hex equivalent: "@0402@"

'''Discussion''': The (CPL64) control code sets the screen display mode to 64 characters per line by 27 lines. The screen is cleared to foreground blanks and the cursor is moved to the "home" position. (Note: In normal mode, the cursor will be moved to the upper left corner of the screen. If typewriter mode is in effect, the cursor will be moved to the lower left corner of the screen.)
This control code may be overridden by the system configuration (if the configuration forces the screen display to 80 columns, for example).

Also see [[#(Screen)]], [[#(CPL132)]], [[#(CPL80)]], and [[#(DE)]].
<pre>
Example:
a. 100 FORMAT (CPL64)
.
PRINT (0,100)

b. PRINT (0) (CPL64)
</pre>

==(CPL80)==
'''Mnemonic''': (CPL80) Hex equivalent: "@0403@"

'''Discussion''': The (CPL80) control code sets the screen display mode to 80 characters per line by 24 lines. The screen is cleared to foreground blanks and the cursor is moved to the "home" position. (Note: In normal mode, the cursor will be moved to the upper left corner of the screen. If typewriter mode is in effect, the cursor will be moved to the lower left corner of the screen.)
Also see [[#(Screen)]], [[#(CPL132)]], [[#(CPL64)]], and [[#(DE)]].
<pre>
Example:
a. 100 FORMAT (CPL80)
.
PRINT (0,100)

b. PRINT (0) (CPL80)
</pre>

==(CR)==
'''Mnemonic''': (CR)

'''Discussion''': Cursor return/carriage return.
This control code can be used on a video device or a printer.

'''Video device'''
In normal mode, the (CR) control code moves the cursor to the first foreground position on the following line. If the cursor is on the bottom line when this control code is issued, the cursor will be moved to the top line of the screen. In either case, the cursor will land only in a foreground field.

In typewriter mode, this control code scrolls the screen up one line (forcing the top line off the screen) and will move the cursor to the beginning (left side) of the bottom line on the screen.

'''Printer'''
The (CR) control code performs a carriage return function for the printer. If this control is issued in the middle of a print line, it advances the printer to the beginning of the next line (unlike a line feed control, which would skip the next line and move to the beginning of the following line).
<pre>
Example (video):
a. 100 FORMAT (CR)
.
PRINT (0,100)

b. PRINT (0) (CR)

Example (printer):
a. 100 FORMAT "CUSTOMER LISTING";(CR);"PRINTED ON:";DAY$
.
OPEN (1) "LP1"
.
PRINT (1,100)

b. OPEN (1) "LP1"
.
PRINT (1) "CUSTOMER LISTING";(CR);"PRINTED ON:";DAY$
</pre>
This last example prints a heading, performs a carriage return, and then prints a subheading on the next line.

==(Create Window)==
'''Mnemonic''': (Create Window=a,b,c,d)
where:
a = upper left column (decimal)
b = upper left row (decimal)
c = lower right column (decimal)
d = lower right row (decimal)

Hex equivalent: "@0E0D00wwxxyyzz@"
where:
ww = upper left row (hex)
xx = upper left column (hex)
yy = lower right row (hex)
zz = lower right column (hex)

'''Discussion''': This mnemonic creates a Comet window using the specified screen coordinates. Note: These coordinates are relative to the full screen (e.g., column 0, row 0 always represents the upper left corner of the display).
When a window is created, the amount of available window memory decreases by the size of the window. To determine how much window memory remains, perform a numeric input immediately following the creation of a window. See the window memory page for more information. If you do not need to know how much window memory remains, perform a null INPUT immediately after printing the (Create Window) mnemonic.

Also see the discussion on Comet windows.
<pre>
Example:
a. 100 FORMAT (Create Window=2,3,70,20)
.
PRINT (0,100)
INPUT (0) ""

b. PRINT (0) (Create Window=2,3,70,20)
INPUT (0) ""
</pre>
This example show how to create a Comet window from column 2, row 3 (the upper left corner) to column 70, row 20 (the lower right corner). The INPUT (0) "" statement allows the program to bypass the value that is returned from the (Create Window) mnemonic (the amount of remaining window memory).

==(CreateWindowEx)==

'''Mnemonic''': (CreateWindowEx=column,row,width,height,style,flags,caption$)

'''Discussion''': This mnemonic creates and selects an extended window, using the following parameters: 
'''Parameter Description''' 
'''column''' The column location of the upper, left-hand corner of the window. This numeric value is expressed in QCRT characters or screen pixels, depending on the value of the flags (see below). 
'''row''' The row location of the upper, left-hand corner of the window. This numeric value is expressed in QCRT characters or screen pixels, depending on the value of the flags (see below). 
'''width''' The width of the window. This numeric value is expressed in QCRT characters. 
'''height''' The height of the window. This numeric value is expressed in QCRT characters. 
'''style''' The style of Window. This numeric value is the sum of the following options: 
'''Style Value Meaning''' 
'''1''' A popup window. The window can be moved outside of Comet window. This value should not be used with 2 (which specifies a child window). 
'''2''' A child window. The window remains within the view window. This value should not be used with 1 (which specifies a popup window). 
'''4''' The window includes a caption bar. 
'''8''' The window includes a border. 
'''16''' The caption bar includes an "X" which closes the window. 
Note: Clicking on the "X" causes an (EasyScan) event to be reported to the Internet Basic program. The EasyScan value is 15. 
'''32''' The window includes a thick frame that lets the user resize the window. 
'''64''' The window is visible. 

'''flags''' The flags for the window. This numeric value is the sum of the following options:
Value Meaning 
'''0''' A modeless window (also known as a user-selectable window). 
Note: If multiple Comet windows are displayed, the user can select which window is the active one by clicking the caption bar. The Internet Basic program can determine the handle of the the window from which data was transmitted via the STS function. 
'''1''' A modal window. All other Comet windows are disabled until this window closes. 
'''2''' A child window with no frame (border). This flag can be used to simulate a legacy Comet window (see CreateWindow). 
'''4''' The window includes a message line (also known as a control line). Any text written with the (WC) mnemonic will be displayed on the message line within this window. 

The following flags pertain to non-child windows only:

'''Value Meaning''' 
'''8''' The column and row positions are expressed in screen pixels, and are relative to the screen (i.e., 0,0 = the upper, left-hand pixel of the screen). 
'''16''' The column and row positions are expressed in screen pixels, and are relative to the client window (i.e., 0,0 = the upper, left-hand pixel of the client window). 
'''32''' The column and row positions are expressed in screen pixels, and are relative to the frame window (i.e., 0,0 = the upper, left-hand pixel of the frame window). 

'''caption$''' If the caption bar style is in effect, this string value is displayed on the caption bar.

Each extended window is identified by a 4-byte string known as a window handle. The handle value is assigned by the system and returned to the Internet Basic program via an INPUT statement following the (CreateWindowEx) mnemonic, as follows:
<pre>
Length 4 & Local Handle1$
.
Print (CreateWindowEx=0,0,35,15,68,1,"This is the caption")
Input Handle1$
</pre>
It follows that the Internet Basic program can create multiple extended windows. The program can select which window to use via the (SelectWindowEx) mnemonic.
An extended window is deleted via the (DeleteWindowEx) mnemonic.

Note: If you write a program that displays more than one extended window at a time, your program may need some way to distinguish which window was active at the time that data was input. The STS function returns the handle of the window that generated the input. This 4-byte value starts in position 11, as shown here:
<pre>
Length 4 & Local Handle$
.
Handle$ = SUB(STS(0),11,4)
</pre>
Symbolic constants: Symbolic constants can be very useful when dealing with the multiple style and flag values. For example, here is a list of recommended symbolic constants for extended windows:
<pre>
'''! Window style'''
SET COS.WS.POPUP = 1 ! Can be moved outside of Comet window. Should
! not be used with COS.WS.CHILD.
SET COS.WS.CHILD = 2 ! Remains within view window. Should not be used
! with COS.WS.POPUP.
SET COS.WS.CAPTION = 4 ! Includes a caption bar
SET COS.WS.BORDER = 8 ! Window includes a border
SET COS.WS.SYSMENU = 16 ! Caption bar 'X' closes window
SET COS.WS.THICKFRAME = 32 ! Thick frame for sizing
SET COS.WS.VISIBLE = 64 ! Window is visible
SET COS.WS.POPUPWINDOW = 25 ! (COS.WS.POPUP+COS.WS.BORDER+COS.WS.SYSMENU)

'''! Window flags'''
SET COS.WF.MODELESS = 0 ! - User selectable window - Use EasyScan
! to determine when a window is activated.
SET COS.WF.MODAL = 1 ! - All other windows are disabled until
! this window closes
SET COS.WF.NOFRAME = 2 ! Create CHILD window with no frame (border).
! Used to simulate a Comet window
SET COS.WF.MSGLINE = 4 ! Has a message line

! The following flags pertain to non-child windows only
SET COS.WF.SCNPIXELPOS = 8 ! Position is in pixels, screen relative
SET COS.WF.CLIPIXELPOS = 16 ! Position is in pixels, client window relative
SET COS.WF.FRMPIXELPOS = 32 ! Position is in pixels, frame window relative
</pre>
With these symbolic constants in place, you can specify the style and flag values by writing a symbolic "formula," as follows:
<pre>
Length 3.0 & Local Style, Flags
Length 5 & Local Handle1$
.
.
Style = COS.WS.POPUPWINDOW + COS.WS.CAPTION
Flags = COS.WF.MODAL + COS.WF.MSGLINE + COS.WF.CLIPIXELPOS
Print (CreateWindowEx=0,0,35,15,Style,Flags,"This is the caption")
Input Handle1$
</pre>

History: This feature is supported in Comet2002 Build 306 and higher.
Examples: See the WinDemo.ibs program (available at www.signature.net/download/demos) for examples of extended windows. This demo program includes many combinations of the style and flags parameters, and also demonstrates some very useful applications for extended windows.

==(CrMode)==

'''Mnemonic''': (CrMode=mode)

'''Discussion''': This mnemonic controls the action of the Enter key. The following values may be used: 
'''0''' = default (from SYSGEN) 
'''1''' = Enter key works like Tab 
'''2''' = Enter key behaves like a CR (goes to beginning of next line unless a TM or TP is encountered) 
History: This mnemonic was added in REL 00.06.
<pre>
Example:
a. 100 FORMAT (CrMode=1)
.
PRINT (0,100)

b. PRINT (0) (CrMode=1)
</pre>
This example shows how to make the Enter key work like the Tab key.

==(CS)==
'''Mnemonic''': (CS) Hex equivalent: "@05@"

'''Discussion''': Clear screen.
The (CS) control code clears the entire screen to foreground blanks and moves the cursor to the home position.
<pre>
Example:
a. 100 FORMAT (CS)
.
PRINT (0,100)

b. PRINT (0) (CS)
</pre>

== (CH) ==
<pre>
Mnemonic: (CH)
Hex equivalent:
Discussion: Cursor home.
The (CH) control code moves the cursor to the "home" position on the screen. Home position is the upper left foreground location of the screen. Since the cursor will land only in a foreground area, "home" may be something other than the upper left corner.

For example, if the upper left corner of the screen contains background or invisible (suppressed background) characters, the cursor will search to the right and to the next line(s) if necessary for the first available foreground position.

Once a foreground field is located, the cursor will be positioned at the first location in that field (left-most position for alphanumeric fields and right-most position for right-justified numeric fields).

Example: a. 100 FORMAT (CH)
.
PRINT (0,100)

b. PRINT (0) (CH)

This example shows how to move the cursor to the home position.

</pre>
==(CR)==
'''Mnemonic''': (CR)

'''Discussion''': Cursor return/carriage return.
This control code can be used on a video device or a printer.

'''Video device'''
In normal mode, the (CR) control code moves the cursor to the first foreground position on the following line. If the cursor is on the bottom line when this control code is issued, the cursor will be moved to the top line of the screen. In either case, the cursor will land only in a foreground field.

In typewriter mode, this control code scrolls the screen up one line (forcing the top line off the screen) and will move the cursor to the beginning (left side) of the bottom line on the screen.

'''Printer'''
The (CR) control code performs a carriage return function for the printer. If this control is issued in the middle of a print line, it advances the printer to the beginning of the next line (unlike a line feed control, which would skip the next line and move to the beginning of the following line).
<pre>
Example (video):
a. 100 FORMAT (CR)
.
PRINT (0,100)

b. PRINT (0) (CR)

Example (printer):
a. 100 FORMAT "CUSTOMER LISTING";(CR);"PRINTED ON:";DAY$
.
OPEN (1) "LP1"
.
PRINT (1,100)

b. OPEN (1) "LP1"
.
PRINT (1) "CUSTOMER LISTING";(CR);"PRINTED ON:";DAY$
</pre>
This last example prints a heading, performs a carriage return, and then prints a subheading on the next line.

Mnemonics "C"

2009-09-04T20:33:21Z

SteveA: /* (CrMode) */

== (CA Sessions) ==

'''Mnemonic''': (CA Sessions=maximum-number-of-sessions)

'''Discussion''': This mnemonic sets a limit on the number of CometAnywhere sessions. The maximum-number-of-sessions is a decimal value. To get information on the current setting, set the argument to 0 and follow the mnemonic with an INPUT (see example 2).

Example 1: Print (CA Sessions=3)

This example sets the maximum number of CometAnywhere sessions to 3.

Example 2: Print (CA Sessions=0) Input A$

This example sets the argument to 0.

As a result, the current setting is returned to the string variable contained in the next INPUT statement following the mnemonic. The return value is a one-byte hex string. For example, if the current maximum-number-of-sessions is 3, the hex value "@03@" is assigned to A$.

== (CapsOff) ==
<pre>
Mnemonic: (CapsOff) Discussion: This mnemonic turns the Caps Lock keyboard function off. See (CapsOn).

Example: Print (CapsOff)

</pre>
== (CapsOn) ==
<pre>
Mnemonic: (CapsOn) Discussion: This mnemonic turns the Caps Lock keyboard function on. See (CapsOff).

Example: Print (CapsOn)
</pre>
== (CC) ==
'''Email Mnemonic:''' (CC=string-argument)

'''Discussion:''' The (CC) mnemonic may be used to specify the "carbon copy" recipients of your email message. Example: OPEN (1) "LEH" PRINT (1) (CC="barbara@@signature.net")

== (CF) ==
'''Mnemonic''': (CF) Hex equivalent: "@06@"

'''Discussion''': Clear foreground. The (CF) control code clears all foreground screen positions to foreground blanks and positions the cursor at the first foreground position on the screen (the upper left corner). This control does not affect background or invisible (suppressed background) screen positions.

This control code is typically used to clear input data from a formatted screen after it is entered in order to prepare for the next set of input data.
<PRE>
Example: a. 100 FORMAT (CF)
.
PRINT (0,100)
b. PRINT (0) (CF)
</pre>
This example shows how to clear all foreground screen positions.

Read about other Email Mnemonics

== (CFLD) ==
'''Mnemonic''': (CFLD) Hex equivalent: "@0407@"

'''Discussion''': Clear field. The (CFLD) control code clears all foreground characters in a field in which the cursor is located and replaces them with foreground blanks. It then positions the cursor in the first position of the field (left-most position for alphanumeric fields and right-most position for right-justified numeric fields). The control code does not affect background or invisible (suppressed background) fields.

This control code may also include a positioning statement to start the clearing operation at a specific point on the screen.
<pre>
Example:
a. 100 FORMAT (CFLD),@(10,0)
.
PRINT (0,100)
b. PRINT (0) (CFLD),@(10,0)
</pre>
These examples demonstrates the "clear field" control code. The positioning statement puts the control into action at column 10, row 0. If this location is a foreground field, it will be cleared to foreground blanks (if not, the control code will do nothing).

== (CH) ==

'''Mnemonic''': (CH) Hex equivalent:

'''Discussion''': Cursor home. The (CH) control code moves the cursor to the "home" position on the screen. Home position is the upper left foreground location of the screen. Since the cursor will land only in a foreground area, "home" may be something other than the upper left corner.

For example, if the upper left corner of the screen contains background or invisible (suppressed background) characters, the cursor will search to the right and to the next line(s) if necessary for the first available foreground position.

Once a foreground field is located, the cursor will be positioned at the first location in that field (left-most position for alphanumeric fields and right-most position for right-justified numeric fields).
<pre>
Example:
a. 100 FORMAT (CH)
.
PRINT (0,100)
b. PRINT (0) (CH)
</pre>
This example shows how to move the cursor to the home position.

== (Change Color) ==

'''Mnemonic''': (Change Color=ARG1$) Hex equivalent: "@0E0E0Bxx00@" where: xx = the foreground color

'''Discussion''': This mnemonic changes the foreground color attribute on the Comet console, and is effective only for the current write operation. ARG1$ is the foreground color; it may be a string constant or a string variable containing the hex representation of the screen color.

See [[Screen Colors]] for a list of color codes.

Also see [[#(Change Colors)]] for a way to change all of the screen colors.
<pre>
Example:
a. 100 FORMAT (Change Color="@07@")
.
PRINT (0,100)
b. PRINT (0) (Change Color="@07@")
</pre>

==(Change Colors)==
'''Mnemonic:''' (Change Colors=ARG1$,ARG2$,ARG3$,ARG4$,ARG5$)

'''Hex equivalent:''' "@0E0E0Evvwwxxyyzz@" where: vv = the foreground color ww = the background color xx = the invisible color (for TM's, TP's, and RJ's) yy = the border color zz = the entry field color

'''Discussion:''' The mnemonic changes all of the screen colors on the Comet console, or within the current Comet window. ARG1$ is the foreground color ARG2$ is the background color ARG3$ is the invisible color (for TM's, TP's, and RJ's) ARG4$ is the border color ARG5$ is the entry field color

All of these arguments are in hex and may be string constants or a string variable containing the hex representation of the screen color.

See [[Screen Colors]] for a list of color codes.

Also see ([[#Change Color]]) for a way to change the foreground color only.
<pre>
Example:
a. 100 FORMAT (Change colors="@0F@","@A0@","@00@","@C0@","@0F@")
.
PRINT (0,100)
b. Print (0) (Change colors="@0F@","@A0@","@00@","@C0@","@0F@")
</pre>

==(CPL132)==
'''Mnemonic''': (CPL132) Hex equivalent: "@040009@"

'''Discussion''': This mnemonic sets the video display mode to 132 characters per line. Also see ([[#Screen]]), ([[#CPL64]]), ([[#CPL80]]), and ([[#DE]]).
<pre>
Example:
a. 100 FORMAT (CPL132)
.
PRINT (0,100)
b. PRINT (0) (CPL132)
</pre>

==(CPL64)==

'''Mnemonic''': (CPL64) Hex equivalent: "@0402@"

'''Discussion''': The (CPL64) control code sets the screen display mode to 64 characters per line by 27 lines. The screen is cleared to foreground blanks and the cursor is moved to the "home" position. (Note: In normal mode, the cursor will be moved to the upper left corner of the screen. If typewriter mode is in effect, the cursor will be moved to the lower left corner of the screen.) This control code may be overridden by the system configuration (if the configuration forces the screen display to 80 columns, for example).

Also see [[#(Screen)]], [[#(CPL132)]], [[#(CPL80)]], and [[#(DE)]].
<pre>
Example:
a. 100 FORMAT (CPL64)
.
PRINT (0,100)
b. PRINT (0) (CPL64)
</pre>

==(CPL80)==

'''Mnemonic''': (CPL80) Hex equivalent: "@0403@"

'''Discussion''': The (CPL80) control code sets the screen display mode to 80 characters per line by 24 lines. The screen is cleared to foreground blanks and the cursor is moved to the "home" position. (Note: In normal mode, the cursor will be moved to the upper left corner of the screen. If typewriter mode is in effect, the cursor will be moved to the lower left corner of the screen.) Also see [[#(Screen)]], [[#(CPL132)]], [[#(CPL64)]], and [[#(DE)]].
</pre>
Example:
a. 100 FORMAT (CPL80)
.
PRINT (0,100)
b. PRINT (0) (CPL80)
</pre>

== (Check Box Off) ==
<pre>
Note: This feature is not supported beyond Comet 504. Mnemonic: (Check Box Off) Hex equivalent: "@CAC6B6@" Discussion: This mnemonic draws a graphical check box on the screen. The check box is in the "off" position (i.e., no check mark appears in the box), as shown here:

The check box symbol occupies 3 spaces on the screen.

Note: The (Enhanced Characters On) mnemonic must be used before the (Check Box Off) mnemonic us used.

Also see (Check Box On).

Example: a. 100 FORMAT (Check Box Off)

.
PRINT (0,100)
b. PRINT (0) (Check Box Off)

</pre>
== (Check Box On) ==
<pre>
Note: This feature is not supported beyond Comet 504. Mnemonic: (Check Box On) Hex equivalent: "@CACEB6@" Discussion: This mnemonic draws a graphical check box on the screen. The check box is in the "on" position (i.e., a check mark appears in the box), as shown here:

The check box symbol occupies 3 spaces on the screen.

Note: The (Enhanced Characters On) mnemonic must be used before the (Check Box On) mnemonic us used.

Also see (Check Box Off).

Example: a. 100 FORMAT (Check Box On)

.
PRINT (0,100)
b. PRINT (0) (Check Box On)

Retrieved from "http://64.142.11.195/index.php/Mnemonics"
</pre>
== (CFLD) ==

'''Mnemonic''': (CFLD) Hex equivalent: "@0407@"

'''Discussion''': Clear field. 
The (CFLD) control code clears all foreground characters in a field in which the cursor is located and replaces them with foreground blanks. It then positions the cursor in the first position of the field (left-most position for alphanumeric fields and right-most position for right-justified numeric fields). The control code does not affect background or invisible (suppressed background) fields.

This control code may also include a positioning statement to start the clearing operation at a specific point on the screen.
<pre>
Example:
a. 100 FORMAT (CFLD),@(10,0)
.
PRINT (0,100)
b. PRINT (0) (CFLD),@(10,0)
</pre>
This example demonstrates the "clear field" control code. The positioning statement puts the control into action at column 10, row 0. If this location is a foreground field, it will be cleared to foreground blanks (if not, the control code will do nothing).

== (CF) ==

'''Mnemonic''': (CF) Hex equivalent: "@06@" 
'''Discussion''': Clear foreground.
The (CF) control code clears all foreground screen positions to foreground blanks and positions the cursor at the first foreground position on the screen (the upper left corner). This control does not affect background or invisible (suppressed background) screen positions.

This control code is typically used to clear input data from a formatted screen after it is entered in order to prepare for the next set of input data.
<pre>
Example:
a. 100 FORMAT (CF)
.
PRINT (0,100)
b. PRINT (0) (CF)
</pre>
This example shows how to clear all foreground screen positions.

== (CS) ==

'''Mnemonic''': (CS) Hex equivalent: "@05@" 
'''Discussion''': Clear screen.
The (CS) control code clears the entire screen to foreground blanks and moves the cursor to the home position.
<pre>
Example:
a. 100 FORMAT (CS)
.
PRINT (0,100)
b. PRINT (0) (CS)
</pre>

== (Close Icon) ==
<pre>
Note: This feature is not supported beyond Comet 504.
Mnemonic: (Close Icon)
Hex equivalent: "@CCB8@"
Discussion: This mnemonic draws a graphical "close" icon on the screen, as shown here:

The close icon occupies 2 spaces on the screen.

Note: The (Enhanced Characters On) mnemonic must be used before the (Close Icon) mnemonic us used.

Example: a. 100 FORMAT (Close Icon)
.
PRINT (0,100)

b. PRINT (0) (Close Icon)

</pre>
== Close the mouse ==
Use the following instruction to close the mouse driver:
<pre>
PRINT (0) (Mouse off)
</pre>
See also Show/hide the mouse cursor.

The mouse cursor may be shown or hidden. For mouse-driven applications, you will normally want to show the mouse cursor. For touch-sensitive screen applications, you will normally want to hide the mouse cursor.

To show the regular cursor, use the following instruction:
<pre>
PRINT (0) (Show Mouse Cursor)
</pre>

To hide the regular cursor, use the following instruction:
<pre>
PRINT (0) (Hide Mouse Cursor)
</pre>
Also see Regular cursor display.

==(Copy from Clipboard)==
'''Mnemonic''': (Copy from Clipboard) 
'''Discussion''': This mnemonic, which is used with the system driver (X00), copies the contents from the Windows clipboard into one or more program variables. This mnemonic is issued via a PRINT statement, and the clipboard data is obtained via a subsequent INPUT statement (see example below).

== (Query Clipboard) ==
<pre>

History: This mnemonic was added in REL 01.05 and requires Build 292 or higher.
Example 1: LENGTH 254 & LOCAL RESULT$ ! Define a variable
.
.
.
Open (1) "X00" ! Open system driver
Print (1) (CopyFromClipboard) ! Copy data from clipboard
Input (1) Result$ ! to this variable
Close (1) ! Close system driver

Example 2: LENGTH 254 & LOCAL A$,B$,C$ ! Define 3 variables

CLIP: FORMAT A$;B$;C$ ! FORMAT statement for clipboard data

Open (1) "X00" ! Open system driver
Print (1) (CopyFromClipboard) ! Copy data from clipboard
Input (1,CLIP) ! to the variables in this FORMAT statement
Close (1) ! Close system driver
</pre>
== (Copy to Clipboard) ==
'''Mnemonic''': (Copy to Clipboard) 
'''Discussion''': This mnemonic, which is used with the system driver (X00), copies program data to the Windows clipboard. This mnemonic is issued via a PRINT statement (see examples below).
This mnemonic returns a result string, so it is necessary to issue an INPUT statement following the PRINT statement. However, since this mnemonic should never fail, the result string will not contain any meaningful data.

Also see:
[[#(Copy from Clipboard)]]
[[#(Query Clipboard)]]

History: This mnemonic was added in REL 01.05 and requires Build 292 or higher.
<pre>
Example 1: LENGTH 254 & LOCAL RESULT$
.
Open (1) "X00"
Print (1) (Copy to Clipboard);"This is some data for the clipboard."
Input (1) Result$
Close (1)

Example 2: LENGTH 254 & LOCAL RESULT$,DATA$
.
.
.
DATA$ = "This is some data for the clipboard."
Open (1) "X00"
Print (1) (Copy to Clipboard);DATA$
Input (1) Result$
Close (1)

Example 3: LENGTH 254 & LOCAL RESULT$
.
.
.
Open (1) "X00"
Print (1) (Copy to Clipboard);"" ! Clear the clipboard
Input (1) Result$
Close (1)

</pre>

==(CopyFile)==

'''Mnemonic:''' (CopyFile=source-file,destination-file,flags)

'''Discussion:''' This mnemonic copies the source-file to the destination-file, using the specified flags.

This mnemonic may be used by foreground programs only.

'''Note:''' The (CopyFile) mnemonic is intended to replace (Verify File).

The source-file, which is specified as a full Windows path, UNC path, or directory alias, may be located on a local Comet system/network or a CometAnywhere client system (default is local system).

The destination-file, which is specified as a full Windows path, UNC path, or directory alias, may be located on a local Comet system/network or CometAnywhere client system (default is local system).

When issued on lun (0), this mnemonic copies a file:

*from a local Comet system/network to itself
*from a local Comet system/network to a CometAnywhere client system
*from a CometAnywhere client system to a local Comet system/network
*from the CometAnywhere client system to itself

The mnemonic provides many powerful features, such as an option to compare the source file's modify date with the destination file's modify date (in the case where the destination file already exists) in order to determine whether the source file needs to be copied, an option to display a progress bar during CometAnywhere transfers, and options to create a directory, overwrite an existing file, and create a CAFILE alias if required.

Flags is a numeric value representing the sum of the numeric values listed in the following chart:

'''Flag Description'''

'''1''' The source file is located on the CometAnywhere client system 
'''2''' CometAnywhere is required if remote files are specified

If a flag is set indicating that the source file is located on a CometAnywhere client system (flag='''1''') and/or that the destination file is located on a CometAnywhere client system (flag='''512'''), but the user is running on a local Comet system (i.e., not a CometAnywhere client system):

If this flag is set, an error is reported (see function error 2).
If this flag is not set, Comet substitutes the local drive/path name for a remote path/drive name.

'''64''' Synchronize source and destination files
If the source file is newer than the destination file, or the destination file does not exist, the destination file is updated (assuming that the other flags call for the copying to occur).

If this flag is omitted, the destination file is updated (assuming that the other flags call for the copying to occur).

Note: Different file systems may return file update times in different formats. For example, the NT file system (NTFS) returns file update times in Coordinated Universal Time (abbreviated as UTC; formely known as Greenwich Mean Time), while FAT returns file update times in local time. Therefore, when using this flag, make sure that the source and destination files use the same file system and return the file update times in the same format.

'''128''' Create CAFILES alias if required
If an alias is specified in the destination file name, and the alias doesn't already exist, this flag creates the alias.

'''256''' Don't copy the file; just indicate if an update is needed
See the function error codes (below), particularly values 20 and 21.

'''512''' The destination file is located on the CometAnywhere client system

'''1024''' Show a progress bar for transfers between a local Comet system/network and a CometAnywhere client system

'''2048''' Overwrite existing file
If the destination file already exists, overwrite it with the contents of the source file.

'''4096''' Create directory
If a directory is specified for the destination file, and that directory does not already exist, create it.

After this mnemonic is issued, your program should issue an INPUT on LUN (0) to retrieve success/error information. For example:
<pre>
LENGTH 2 & LOCAL AX$,DX$
ResultFmt: FORMAT AX$;DX$
.
.
Print (CopyFile=Source$,Dest$,Flags)
Input (0,ResultFmt)
</pre>
The first field, AX$, contains the function error code, and the second field, DX$, contains the suberror code (aka the Windows file error code). Both of these fields are in Intel 2's complement format, and should be processed as follows:
<pre>
AX$ = SUB(AX$,2,1) + SUB(AX$,1,1) ! Flip the bytes around
DX$ = SUB(DX$,2,1) + SUB(DX$,1,1) ! Flip the bytes around
FuncError = HexDec(AX$) ! Function error code (decimal)
FileError = HexDec(DX$) ! File error code (decimal)

! For unexpected values, convert to 2's complement signed integer
If (FuncError > 32767) FuncError = FuncError-65536
If (FileError > 32767) FileError = FileError-65536
</pre>
Here is a link to Jons error code summary table [[Comet_Error_Codes#CopyFileErrors:]]

Here is a list of the function error codes in decimal form:
Error
('''FuncError''') Description
'''0''' Function not supported
'''1''' Success -- update performed
'''2''' CometAnywhere required
'''3''' Source file error (see suberrors)
'''4''' Aborted by user
'''5''' Function in progress
'''20''' Success -- update not required
'''21''' Success -- update required
'''22''' Destination file error (see suberrors)

Here is a list of the suberror codes (common Windows file errors) in decimal form:

Suberror
('''FileError''') Description
'''0''' Success
'''2''' File not found
'''3''' Path not found
'''5''' Access denied
'''12''' Invalid access
'''15''' Invalid drive
'''16''' An error has occurred in the current directory
'''18''' No more files
'''32''' Sharing violation
'''33''' Lock violation
'''39''' File located on Remote Computer
'''80''' File exists
'''123''' The Filename, Directory Name, or Volume Label Syntax Is Incorrect
'''161''' Bad pathname
'''1326''' User not logged in to Remote Computer

History: This mnemonic was added in Comet Build 299 and REL Version 01.07.
<pre>
Example 1:
Source$ = "C:\SAMPLEFILES\TEST.TXT"
Dest$ = "A:\TEST.TXT"
Flags = 2048
Print (CopyFile=Source$,Dest$,Flags)
</pre>

This example copies the source file named C:\SAMPLEFILES\TEST.TXT to the destination file named A:\TEST.TXT. By default, both files are located on the local Comet system/network. The flag value of 2048 tells Comet to overwrite the destination file if it exists.
If the copying is successful, the function error code will be equal to 1 (Success -- update performed), and the suberror code will be equal to 0 (Success).

<pre>
Example 2:
Source$ = "C:\FILE1.TXT"
Dest$ = "C:\FILE2.TXT"
Flags = 512 + 2048
Print (CopyFile=Source$,Dest$,Flags)
</pre>

This example copies a source file named C:\FILE1.TXT to a destination file named C:\FILE2.TXT
The sum of the two flags tells Comet that the destination file is on the CometAnywhere client system (512), and to overwrite the destination file if the destination file already exists (2048). By default, the source file is on the local Comet system.

Suppose the flag value was changed to the following:

Flags = 1 + 2048

This would tell Comet that the source file is on the CometAnywhere client system (1), while the destination file (by default) is on the local Comet system. The destination file would be overwritten (2048).
Suppose the flag value was changed to the following:

Flags = 1 + 512 + 2048

In this case, the source and destination files are located on the CometAnywhere client system (1 and 512), and the destination file will be overwritten (2048).

Example 3: Suppose you want to copy a file from a local Comet system to a CometAnywhere client system, and you want to synchronize the files (i.e., copy only if the source file is newer than the destination file).
Here are the flags that are used in the following example:

2 = CometAnywhere is required (otherwise an error occurs)
64 = Synchronize the files
512 = Destination file is on CometAnywhere client system
1024 = Show progress bar
2048 = Overwrite existing file
4096 = Create directory

<pre>
Source$ = "C:\FILE1"
Dest$ = "C:\DATA\FILE2"
Flags = 2 + 64 + 512 + 1024 + 2048 + 4096
Print (CopyFile=Source$,Dest$,Flags)
</pre>

Example 4: Suppose you need to copy a large file between a local Comet system and a CometAnywhere client system, but before copying you want to check and see if (a) the update is needed, and (b) if the user wants to perform the update now.
This is done in two steps. First, use the flag that checks to see if the update is required without copying the file (flag=256). If the update is required (as indicated by FuncError=21), then proceed with the copying (change the flags to copy the file).

<pre>
Source$ = "C:\BIGFILE" ! on local Comet system
Dest$ = "C:\BIGFILE" ! on CometAnywhere client system

Flags = 256 + 512 ! 256 = don't copy file; just check to
! see if updated is needed
! 512 = destination is on
! CometAnywhere system

Print (CopyFile=Source$,Dest$,Flags)
Input (0,ResultFmt)

AX$ = SUB(AX$,2,1) + SUB(AX$,1,1) ! Flip the bytes around
DX$ = SUB(DX$,2,1) + SUB(DX$,1,1) ! Flip the bytes around
FuncError = HexDec(AX$) ! Function error code (decimal)
FileError = HexDec(DX$) ! File error code (decimal)

! For unexpected values, convert to 2's complement signed integer
If (FuncError > 32767) FuncError = FuncError-65536
If (FileError > 32767) FileError = FileError-65536

If FuncError = 21
Print "The file needs to be updated."
Print "Do you want to update it now?"
Input A$

If A$ = "Y"
Flags = 512 + 2048
Print (CopyFile=Source$,Dest$,Flags)
Input (0,ResultFmt)
.
.
.
EndIf
EndIf
</pre>

Notes: Depending on your situation you might try using the CUtlCpy utility which is released as part of the UTL directory. You can ENTER it from your app to easily accomplish a file copy or move.
To use a directory alias as the pathname for either of the filenames you can do it like this: FileName$ = "$(AliasNameHere)\" + thefilename$

==(CPL132)==

'''Mnemonic''': (CPL132) Hex equivalent: "@040009@"

'''Discussion''': This mnemonic sets the video display mode to 132 characters per line.
Also see [[#(Screen)]], [[#(CPL64)]], [[#(CPL80)]], and [[#(DE)]].
<pre>
Example:
a. 100 FORMAT (CPL132)
.
PRINT (0,100)
b. PRINT (0) (CPL132)
</pre>

==(CPL64)==

'''Mnemonic''': (CPL64) Hex equivalent: "@0402@"

'''Discussion''': The (CPL64) control code sets the screen display mode to 64 characters per line by 27 lines. The screen is cleared to foreground blanks and the cursor is moved to the "home" position. (Note: In normal mode, the cursor will be moved to the upper left corner of the screen. If typewriter mode is in effect, the cursor will be moved to the lower left corner of the screen.)
This control code may be overridden by the system configuration (if the configuration forces the screen display to 80 columns, for example).

Also see [[#(Screen)]], [[#(CPL132)]], [[#(CPL80)]], and [[#(DE)]].
<pre>
Example:
a. 100 FORMAT (CPL64)
.
PRINT (0,100)

b. PRINT (0) (CPL64)
</pre>

==(CPL80)==
'''Mnemonic''': (CPL80) Hex equivalent: "@0403@"

'''Discussion''': The (CPL80) control code sets the screen display mode to 80 characters per line by 24 lines. The screen is cleared to foreground blanks and the cursor is moved to the "home" position. (Note: In normal mode, the cursor will be moved to the upper left corner of the screen. If typewriter mode is in effect, the cursor will be moved to the lower left corner of the screen.)
Also see [[#(Screen)]], [[#(CPL132)]], [[#(CPL64)]], and [[#(DE)]].
<pre>
Example:
a. 100 FORMAT (CPL80)
.
PRINT (0,100)

b. PRINT (0) (CPL80)
</pre>

==(CR)==
'''Mnemonic''': (CR)

'''Discussion''': Cursor return/carriage return.
This control code can be used on a video device or a printer.

'''Video device'''
In normal mode, the (CR) control code moves the cursor to the first foreground position on the following line. If the cursor is on the bottom line when this control code is issued, the cursor will be moved to the top line of the screen. In either case, the cursor will land only in a foreground field.

In typewriter mode, this control code scrolls the screen up one line (forcing the top line off the screen) and will move the cursor to the beginning (left side) of the bottom line on the screen.

'''Printer'''
The (CR) control code performs a carriage return function for the printer. If this control is issued in the middle of a print line, it advances the printer to the beginning of the next line (unlike a line feed control, which would skip the next line and move to the beginning of the following line).
<pre>
Example (video):
a. 100 FORMAT (CR)
.
PRINT (0,100)

b. PRINT (0) (CR)

Example (printer):
a. 100 FORMAT "CUSTOMER LISTING";(CR);"PRINTED ON:";DAY$
.
OPEN (1) "LP1"
.
PRINT (1,100)

b. OPEN (1) "LP1"
.
PRINT (1) "CUSTOMER LISTING";(CR);"PRINTED ON:";DAY$
</pre>
This last example prints a heading, performs a carriage return, and then prints a subheading on the next line.

==(Create Window)==
'''Mnemonic''': (Create Window=a,b,c,d)
where:
a = upper left column (decimal)
b = upper left row (decimal)
c = lower right column (decimal)
d = lower right row (decimal)

Hex equivalent: "@0E0D00wwxxyyzz@"
where:
ww = upper left row (hex)
xx = upper left column (hex)
yy = lower right row (hex)
zz = lower right column (hex)

'''Discussion''': This mnemonic creates a Comet window using the specified screen coordinates. Note: These coordinates are relative to the full screen (e.g., column 0, row 0 always represents the upper left corner of the display).
When a window is created, the amount of available window memory decreases by the size of the window. To determine how much window memory remains, perform a numeric input immediately following the creation of a window. See the window memory page for more information. If you do not need to know how much window memory remains, perform a null INPUT immediately after printing the (Create Window) mnemonic.

Also see the discussion on Comet windows.
<pre>
Example:
a. 100 FORMAT (Create Window=2,3,70,20)
.
PRINT (0,100)
INPUT (0) ""

b. PRINT (0) (Create Window=2,3,70,20)
INPUT (0) ""
</pre>
This example show how to create a Comet window from column 2, row 3 (the upper left corner) to column 70, row 20 (the lower right corner). The INPUT (0) "" statement allows the program to bypass the value that is returned from the (Create Window) mnemonic (the amount of remaining window memory).

==(CreateWindowEx)==

'''Mnemonic''': (CreateWindowEx=column,row,width,height,style,flags,caption$)

'''Discussion''': This mnemonic creates and selects an extended window, using the following parameters: 
'''Parameter Description''' 
'''column''' The column location of the upper, left-hand corner of the window. This numeric value is expressed in QCRT characters or screen pixels, depending on the value of the flags (see below). 
'''row''' The row location of the upper, left-hand corner of the window. This numeric value is expressed in QCRT characters or screen pixels, depending on the value of the flags (see below). 
'''width''' The width of the window. This numeric value is expressed in QCRT characters. 
'''height''' The height of the window. This numeric value is expressed in QCRT characters. 
'''style''' The style of Window. This numeric value is the sum of the following options: 
'''Style Value Meaning''' 
'''1''' A popup window. The window can be moved outside of Comet window. This value should not be used with 2 (which specifies a child window). 
'''2''' A child window. The window remains within the view window. This value should not be used with 1 (which specifies a popup window). 
'''4''' The window includes a caption bar. 
'''8''' The window includes a border. 
'''16''' The caption bar includes an "X" which closes the window. 
Note: Clicking on the "X" causes an (EasyScan) event to be reported to the Internet Basic program. The EasyScan value is 15. 
'''32''' The window includes a thick frame that lets the user resize the window. 
'''64''' The window is visible. 

'''flags''' The flags for the window. This numeric value is the sum of the following options:
Value Meaning 
'''0''' A modeless window (also known as a user-selectable window). 
Note: If multiple Comet windows are displayed, the user can select which window is the active one by clicking the caption bar. The Internet Basic program can determine the handle of the the window from which data was transmitted via the STS function. 
'''1''' A modal window. All other Comet windows are disabled until this window closes. 
'''2''' A child window with no frame (border). This flag can be used to simulate a legacy Comet window (see CreateWindow). 
'''4''' The window includes a message line (also known as a control line). Any text written with the (WC) mnemonic will be displayed on the message line within this window. 

The following flags pertain to non-child windows only:

'''Value Meaning''' 
'''8''' The column and row positions are expressed in screen pixels, and are relative to the screen (i.e., 0,0 = the upper, left-hand pixel of the screen). 
'''16''' The column and row positions are expressed in screen pixels, and are relative to the client window (i.e., 0,0 = the upper, left-hand pixel of the client window). 
'''32''' The column and row positions are expressed in screen pixels, and are relative to the frame window (i.e., 0,0 = the upper, left-hand pixel of the frame window). 

'''caption$''' If the caption bar style is in effect, this string value is displayed on the caption bar.

Each extended window is identified by a 4-byte string known as a window handle. The handle value is assigned by the system and returned to the Internet Basic program via an INPUT statement following the (CreateWindowEx) mnemonic, as follows:
<pre>
Length 4 & Local Handle1$
.
Print (CreateWindowEx=0,0,35,15,68,1,"This is the caption")
Input Handle1$
</pre>
It follows that the Internet Basic program can create multiple extended windows. The program can select which window to use via the (SelectWindowEx) mnemonic.
An extended window is deleted via the (DeleteWindowEx) mnemonic.

Note: If you write a program that displays more than one extended window at a time, your program may need some way to distinguish which window was active at the time that data was input. The STS function returns the handle of the window that generated the input. This 4-byte value starts in position 11, as shown here:
<pre>
Length 4 & Local Handle$
.
Handle$ = SUB(STS(0),11,4)
</pre>
Symbolic constants: Symbolic constants can be very useful when dealing with the multiple style and flag values. For example, here is a list of recommended symbolic constants for extended windows:
<pre>
'''! Window style'''
SET COS.WS.POPUP = 1 ! Can be moved outside of Comet window. Should
! not be used with COS.WS.CHILD.
SET COS.WS.CHILD = 2 ! Remains within view window. Should not be used
! with COS.WS.POPUP.
SET COS.WS.CAPTION = 4 ! Includes a caption bar
SET COS.WS.BORDER = 8 ! Window includes a border
SET COS.WS.SYSMENU = 16 ! Caption bar 'X' closes window
SET COS.WS.THICKFRAME = 32 ! Thick frame for sizing
SET COS.WS.VISIBLE = 64 ! Window is visible
SET COS.WS.POPUPWINDOW = 25 ! (COS.WS.POPUP+COS.WS.BORDER+COS.WS.SYSMENU)

'''! Window flags'''
SET COS.WF.MODELESS = 0 ! - User selectable window - Use EasyScan
! to determine when a window is activated.
SET COS.WF.MODAL = 1 ! - All other windows are disabled until
! this window closes
SET COS.WF.NOFRAME = 2 ! Create CHILD window with no frame (border).
! Used to simulate a Comet window
SET COS.WF.MSGLINE = 4 ! Has a message line

! The following flags pertain to non-child windows only
SET COS.WF.SCNPIXELPOS = 8 ! Position is in pixels, screen relative
SET COS.WF.CLIPIXELPOS = 16 ! Position is in pixels, client window relative
SET COS.WF.FRMPIXELPOS = 32 ! Position is in pixels, frame window relative
</pre>
With these symbolic constants in place, you can specify the style and flag values by writing a symbolic "formula," as follows:
<pre>
Length 3.0 & Local Style, Flags
Length 5 & Local Handle1$
.
.
Style = COS.WS.POPUPWINDOW + COS.WS.CAPTION
Flags = COS.WF.MODAL + COS.WF.MSGLINE + COS.WF.CLIPIXELPOS
Print (CreateWindowEx=0,0,35,15,Style,Flags,"This is the caption")
Input Handle1$
</pre>

History: This feature is supported in Comet2002 Build 306 and higher.
Examples: See the WinDemo.ibs program (available at www.signature.net/download/demos) for examples of extended windows. This demo program includes many combinations of the style and flags parameters, and also demonstrates some very useful applications for extended windows.

==(CrMode)==

'''Mnemonic''': (CrMode=mode)

'''Discussion''': This mnemonic controls the action of the Enter key. The following values may be used: 
'''0''' = default (from SYSGEN) 
'''1''' = Enter key works like Tab 
'''2''' = Enter key behaves like a CR (goes to beginning of next line unless a TM or TP is encountered) 
History: This mnemonic was added in REL 00.06.
<pre>
Example:
a. 100 FORMAT (CrMode=1)
.
PRINT (0,100)

b. PRINT (0) (CrMode=1)
</pre>
This example shows how to make the Enter key work like the Tab key.

== (CS) ==
<pre>

Mnemonic: (CS)
Hex equivalent: "@05@"
Discussion: Clear screen.
The (CS) control code clears the entire screen to foreground blanks and moves the cursor to the home position.

Example: a. 100 FORMAT (CS)
.
PRINT (0,100)

b. PRINT (0) (CS)

</pre>
== (CH) ==
<pre>
Mnemonic: (CH)
Hex equivalent:
Discussion: Cursor home.
The (CH) control code moves the cursor to the "home" position on the screen. Home position is the upper left foreground location of the screen. Since the cursor will land only in a foreground area, "home" may be something other than the upper left corner.

For example, if the upper left corner of the screen contains background or invisible (suppressed background) characters, the cursor will search to the right and to the next line(s) if necessary for the first available foreground position.

Once a foreground field is located, the cursor will be positioned at the first location in that field (left-most position for alphanumeric fields and right-most position for right-justified numeric fields).

Example: a. 100 FORMAT (CH)
.
PRINT (0,100)

b. PRINT (0) (CH)

This example shows how to move the cursor to the home position.

</pre>
==(CR)==
'''Mnemonic''': (CR)

'''Discussion''': Cursor return/carriage return.
This control code can be used on a video device or a printer.

'''Video device'''
In normal mode, the (CR) control code moves the cursor to the first foreground position on the following line. If the cursor is on the bottom line when this control code is issued, the cursor will be moved to the top line of the screen. In either case, the cursor will land only in a foreground field.

In typewriter mode, this control code scrolls the screen up one line (forcing the top line off the screen) and will move the cursor to the beginning (left side) of the bottom line on the screen.

'''Printer'''
The (CR) control code performs a carriage return function for the printer. If this control is issued in the middle of a print line, it advances the printer to the beginning of the next line (unlike a line feed control, which would skip the next line and move to the beginning of the following line).
<pre>
Example (video):
a. 100 FORMAT (CR)
.
PRINT (0,100)

b. PRINT (0) (CR)

Example (printer):
a. 100 FORMAT "CUSTOMER LISTING";(CR);"PRINTED ON:";DAY$
.
OPEN (1) "LP1"
.
PRINT (1,100)

b. OPEN (1) "LP1"
.
PRINT (1) "CUSTOMER LISTING";(CR);"PRINTED ON:";DAY$
</pre>
This last example prints a heading, performs a carriage return, and then prints a subheading on the next line.

Mnemonics "C"

2009-09-04T20:32:42Z

SteveA: /* (CrMode) */

== (CA Sessions) ==

'''Mnemonic''': (CA Sessions=maximum-number-of-sessions)

'''Discussion''': This mnemonic sets a limit on the number of CometAnywhere sessions. The maximum-number-of-sessions is a decimal value. To get information on the current setting, set the argument to 0 and follow the mnemonic with an INPUT (see example 2).

Example 1: Print (CA Sessions=3)

This example sets the maximum number of CometAnywhere sessions to 3.

Example 2: Print (CA Sessions=0) Input A$

This example sets the argument to 0.

As a result, the current setting is returned to the string variable contained in the next INPUT statement following the mnemonic. The return value is a one-byte hex string. For example, if the current maximum-number-of-sessions is 3, the hex value "@03@" is assigned to A$.

== (CapsOff) ==
<pre>
Mnemonic: (CapsOff) Discussion: This mnemonic turns the Caps Lock keyboard function off. See (CapsOn).

Example: Print (CapsOff)

</pre>
== (CapsOn) ==
<pre>
Mnemonic: (CapsOn) Discussion: This mnemonic turns the Caps Lock keyboard function on. See (CapsOff).

Example: Print (CapsOn)
</pre>
== (CC) ==
'''Email Mnemonic:''' (CC=string-argument)

'''Discussion:''' The (CC) mnemonic may be used to specify the "carbon copy" recipients of your email message. Example: OPEN (1) "LEH" PRINT (1) (CC="barbara@@signature.net")

== (CF) ==
'''Mnemonic''': (CF) Hex equivalent: "@06@"

'''Discussion''': Clear foreground. The (CF) control code clears all foreground screen positions to foreground blanks and positions the cursor at the first foreground position on the screen (the upper left corner). This control does not affect background or invisible (suppressed background) screen positions.

This control code is typically used to clear input data from a formatted screen after it is entered in order to prepare for the next set of input data.
<PRE>
Example: a. 100 FORMAT (CF)
.
PRINT (0,100)
b. PRINT (0) (CF)
</pre>
This example shows how to clear all foreground screen positions.

Read about other Email Mnemonics

== (CFLD) ==
'''Mnemonic''': (CFLD) Hex equivalent: "@0407@"

'''Discussion''': Clear field. The (CFLD) control code clears all foreground characters in a field in which the cursor is located and replaces them with foreground blanks. It then positions the cursor in the first position of the field (left-most position for alphanumeric fields and right-most position for right-justified numeric fields). The control code does not affect background or invisible (suppressed background) fields.

This control code may also include a positioning statement to start the clearing operation at a specific point on the screen.
<pre>
Example:
a. 100 FORMAT (CFLD),@(10,0)
.
PRINT (0,100)
b. PRINT (0) (CFLD),@(10,0)
</pre>
These examples demonstrates the "clear field" control code. The positioning statement puts the control into action at column 10, row 0. If this location is a foreground field, it will be cleared to foreground blanks (if not, the control code will do nothing).

== (CH) ==

'''Mnemonic''': (CH) Hex equivalent:

'''Discussion''': Cursor home. The (CH) control code moves the cursor to the "home" position on the screen. Home position is the upper left foreground location of the screen. Since the cursor will land only in a foreground area, "home" may be something other than the upper left corner.

For example, if the upper left corner of the screen contains background or invisible (suppressed background) characters, the cursor will search to the right and to the next line(s) if necessary for the first available foreground position.

Once a foreground field is located, the cursor will be positioned at the first location in that field (left-most position for alphanumeric fields and right-most position for right-justified numeric fields).
<pre>
Example:
a. 100 FORMAT (CH)
.
PRINT (0,100)
b. PRINT (0) (CH)
</pre>
This example shows how to move the cursor to the home position.

== (Change Color) ==

'''Mnemonic''': (Change Color=ARG1$) Hex equivalent: "@0E0E0Bxx00@" where: xx = the foreground color

'''Discussion''': This mnemonic changes the foreground color attribute on the Comet console, and is effective only for the current write operation. ARG1$ is the foreground color; it may be a string constant or a string variable containing the hex representation of the screen color.

See [[Screen Colors]] for a list of color codes.

Also see [[#(Change Colors)]] for a way to change all of the screen colors.
<pre>
Example:
a. 100 FORMAT (Change Color="@07@")
.
PRINT (0,100)
b. PRINT (0) (Change Color="@07@")
</pre>

==(Change Colors)==
'''Mnemonic:''' (Change Colors=ARG1$,ARG2$,ARG3$,ARG4$,ARG5$)

'''Hex equivalent:''' "@0E0E0Evvwwxxyyzz@" where: vv = the foreground color ww = the background color xx = the invisible color (for TM's, TP's, and RJ's) yy = the border color zz = the entry field color

'''Discussion:''' The mnemonic changes all of the screen colors on the Comet console, or within the current Comet window. ARG1$ is the foreground color ARG2$ is the background color ARG3$ is the invisible color (for TM's, TP's, and RJ's) ARG4$ is the border color ARG5$ is the entry field color

All of these arguments are in hex and may be string constants or a string variable containing the hex representation of the screen color.

See [[Screen Colors]] for a list of color codes.

Also see ([[#Change Color]]) for a way to change the foreground color only.
<pre>
Example:
a. 100 FORMAT (Change colors="@0F@","@A0@","@00@","@C0@","@0F@")
.
PRINT (0,100)
b. Print (0) (Change colors="@0F@","@A0@","@00@","@C0@","@0F@")
</pre>

==(CPL132)==
'''Mnemonic''': (CPL132) Hex equivalent: "@040009@"

'''Discussion''': This mnemonic sets the video display mode to 132 characters per line. Also see ([[#Screen]]), ([[#CPL64]]), ([[#CPL80]]), and ([[#DE]]).
<pre>
Example:
a. 100 FORMAT (CPL132)
.
PRINT (0,100)
b. PRINT (0) (CPL132)
</pre>

==(CPL64)==

'''Mnemonic''': (CPL64) Hex equivalent: "@0402@"

'''Discussion''': The (CPL64) control code sets the screen display mode to 64 characters per line by 27 lines. The screen is cleared to foreground blanks and the cursor is moved to the "home" position. (Note: In normal mode, the cursor will be moved to the upper left corner of the screen. If typewriter mode is in effect, the cursor will be moved to the lower left corner of the screen.) This control code may be overridden by the system configuration (if the configuration forces the screen display to 80 columns, for example).

Also see [[#(Screen)]], [[#(CPL132)]], [[#(CPL80)]], and [[#(DE)]].
<pre>
Example:
a. 100 FORMAT (CPL64)
.
PRINT (0,100)
b. PRINT (0) (CPL64)
</pre>

==(CPL80)==

'''Mnemonic''': (CPL80) Hex equivalent: "@0403@"

'''Discussion''': The (CPL80) control code sets the screen display mode to 80 characters per line by 24 lines. The screen is cleared to foreground blanks and the cursor is moved to the "home" position. (Note: In normal mode, the cursor will be moved to the upper left corner of the screen. If typewriter mode is in effect, the cursor will be moved to the lower left corner of the screen.) Also see [[#(Screen)]], [[#(CPL132)]], [[#(CPL64)]], and [[#(DE)]].
</pre>
Example:
a. 100 FORMAT (CPL80)
.
PRINT (0,100)
b. PRINT (0) (CPL80)
</pre>

== (Check Box Off) ==
<pre>
Note: This feature is not supported beyond Comet 504. Mnemonic: (Check Box Off) Hex equivalent: "@CAC6B6@" Discussion: This mnemonic draws a graphical check box on the screen. The check box is in the "off" position (i.e., no check mark appears in the box), as shown here:

The check box symbol occupies 3 spaces on the screen.

Note: The (Enhanced Characters On) mnemonic must be used before the (Check Box Off) mnemonic us used.

Also see (Check Box On).

Example: a. 100 FORMAT (Check Box Off)

.
PRINT (0,100)
b. PRINT (0) (Check Box Off)

</pre>
== (Check Box On) ==
<pre>
Note: This feature is not supported beyond Comet 504. Mnemonic: (Check Box On) Hex equivalent: "@CACEB6@" Discussion: This mnemonic draws a graphical check box on the screen. The check box is in the "on" position (i.e., a check mark appears in the box), as shown here:

The check box symbol occupies 3 spaces on the screen.

Note: The (Enhanced Characters On) mnemonic must be used before the (Check Box On) mnemonic us used.

Also see (Check Box Off).

Example: a. 100 FORMAT (Check Box On)

.
PRINT (0,100)
b. PRINT (0) (Check Box On)

Retrieved from "http://64.142.11.195/index.php/Mnemonics"
</pre>
== (CFLD) ==

'''Mnemonic''': (CFLD) Hex equivalent: "@0407@"

'''Discussion''': Clear field. 
The (CFLD) control code clears all foreground characters in a field in which the cursor is located and replaces them with foreground blanks. It then positions the cursor in the first position of the field (left-most position for alphanumeric fields and right-most position for right-justified numeric fields). The control code does not affect background or invisible (suppressed background) fields.

This control code may also include a positioning statement to start the clearing operation at a specific point on the screen.
<pre>
Example:
a. 100 FORMAT (CFLD),@(10,0)
.
PRINT (0,100)
b. PRINT (0) (CFLD),@(10,0)
</pre>
This example demonstrates the "clear field" control code. The positioning statement puts the control into action at column 10, row 0. If this location is a foreground field, it will be cleared to foreground blanks (if not, the control code will do nothing).

== (CF) ==

'''Mnemonic''': (CF) Hex equivalent: "@06@" 
'''Discussion''': Clear foreground.
The (CF) control code clears all foreground screen positions to foreground blanks and positions the cursor at the first foreground position on the screen (the upper left corner). This control does not affect background or invisible (suppressed background) screen positions.

This control code is typically used to clear input data from a formatted screen after it is entered in order to prepare for the next set of input data.
<pre>
Example:
a. 100 FORMAT (CF)
.
PRINT (0,100)
b. PRINT (0) (CF)
</pre>
This example shows how to clear all foreground screen positions.

== (CS) ==

'''Mnemonic''': (CS) Hex equivalent: "@05@" 
'''Discussion''': Clear screen.
The (CS) control code clears the entire screen to foreground blanks and moves the cursor to the home position.
<pre>
Example:
a. 100 FORMAT (CS)
.
PRINT (0,100)
b. PRINT (0) (CS)
</pre>

== (Close Icon) ==
<pre>
Note: This feature is not supported beyond Comet 504.
Mnemonic: (Close Icon)
Hex equivalent: "@CCB8@"
Discussion: This mnemonic draws a graphical "close" icon on the screen, as shown here:

The close icon occupies 2 spaces on the screen.

Note: The (Enhanced Characters On) mnemonic must be used before the (Close Icon) mnemonic us used.

Example: a. 100 FORMAT (Close Icon)
.
PRINT (0,100)

b. PRINT (0) (Close Icon)

</pre>
== Close the mouse ==
Use the following instruction to close the mouse driver:
<pre>
PRINT (0) (Mouse off)
</pre>
See also Show/hide the mouse cursor.

The mouse cursor may be shown or hidden. For mouse-driven applications, you will normally want to show the mouse cursor. For touch-sensitive screen applications, you will normally want to hide the mouse cursor.

To show the regular cursor, use the following instruction:
<pre>
PRINT (0) (Show Mouse Cursor)
</pre>

To hide the regular cursor, use the following instruction:
<pre>
PRINT (0) (Hide Mouse Cursor)
</pre>
Also see Regular cursor display.

==(Copy from Clipboard)==
'''Mnemonic''': (Copy from Clipboard) 
'''Discussion''': This mnemonic, which is used with the system driver (X00), copies the contents from the Windows clipboard into one or more program variables. This mnemonic is issued via a PRINT statement, and the clipboard data is obtained via a subsequent INPUT statement (see example below).

== (Query Clipboard) ==
<pre>

History: This mnemonic was added in REL 01.05 and requires Build 292 or higher.
Example 1: LENGTH 254 & LOCAL RESULT$ ! Define a variable
.
.
.
Open (1) "X00" ! Open system driver
Print (1) (CopyFromClipboard) ! Copy data from clipboard
Input (1) Result$ ! to this variable
Close (1) ! Close system driver

Example 2: LENGTH 254 & LOCAL A$,B$,C$ ! Define 3 variables

CLIP: FORMAT A$;B$;C$ ! FORMAT statement for clipboard data

Open (1) "X00" ! Open system driver
Print (1) (CopyFromClipboard) ! Copy data from clipboard
Input (1,CLIP) ! to the variables in this FORMAT statement
Close (1) ! Close system driver
</pre>
== (Copy to Clipboard) ==
'''Mnemonic''': (Copy to Clipboard) 
'''Discussion''': This mnemonic, which is used with the system driver (X00), copies program data to the Windows clipboard. This mnemonic is issued via a PRINT statement (see examples below).
This mnemonic returns a result string, so it is necessary to issue an INPUT statement following the PRINT statement. However, since this mnemonic should never fail, the result string will not contain any meaningful data.

Also see:
[[#(Copy from Clipboard)]]
[[#(Query Clipboard)]]

History: This mnemonic was added in REL 01.05 and requires Build 292 or higher.
<pre>
Example 1: LENGTH 254 & LOCAL RESULT$
.
Open (1) "X00"
Print (1) (Copy to Clipboard);"This is some data for the clipboard."
Input (1) Result$
Close (1)

Example 2: LENGTH 254 & LOCAL RESULT$,DATA$
.
.
.
DATA$ = "This is some data for the clipboard."
Open (1) "X00"
Print (1) (Copy to Clipboard);DATA$
Input (1) Result$
Close (1)

Example 3: LENGTH 254 & LOCAL RESULT$
.
.
.
Open (1) "X00"
Print (1) (Copy to Clipboard);"" ! Clear the clipboard
Input (1) Result$
Close (1)

</pre>

==(CopyFile)==

'''Mnemonic:''' (CopyFile=source-file,destination-file,flags)

'''Discussion:''' This mnemonic copies the source-file to the destination-file, using the specified flags.

This mnemonic may be used by foreground programs only.

'''Note:''' The (CopyFile) mnemonic is intended to replace (Verify File).

The source-file, which is specified as a full Windows path, UNC path, or directory alias, may be located on a local Comet system/network or a CometAnywhere client system (default is local system).

The destination-file, which is specified as a full Windows path, UNC path, or directory alias, may be located on a local Comet system/network or CometAnywhere client system (default is local system).

When issued on lun (0), this mnemonic copies a file:

*from a local Comet system/network to itself
*from a local Comet system/network to a CometAnywhere client system
*from a CometAnywhere client system to a local Comet system/network
*from the CometAnywhere client system to itself

The mnemonic provides many powerful features, such as an option to compare the source file's modify date with the destination file's modify date (in the case where the destination file already exists) in order to determine whether the source file needs to be copied, an option to display a progress bar during CometAnywhere transfers, and options to create a directory, overwrite an existing file, and create a CAFILE alias if required.

Flags is a numeric value representing the sum of the numeric values listed in the following chart:

'''Flag Description'''

'''1''' The source file is located on the CometAnywhere client system 
'''2''' CometAnywhere is required if remote files are specified

If a flag is set indicating that the source file is located on a CometAnywhere client system (flag='''1''') and/or that the destination file is located on a CometAnywhere client system (flag='''512'''), but the user is running on a local Comet system (i.e., not a CometAnywhere client system):

If this flag is set, an error is reported (see function error 2).
If this flag is not set, Comet substitutes the local drive/path name for a remote path/drive name.

'''64''' Synchronize source and destination files
If the source file is newer than the destination file, or the destination file does not exist, the destination file is updated (assuming that the other flags call for the copying to occur).

If this flag is omitted, the destination file is updated (assuming that the other flags call for the copying to occur).

Note: Different file systems may return file update times in different formats. For example, the NT file system (NTFS) returns file update times in Coordinated Universal Time (abbreviated as UTC; formely known as Greenwich Mean Time), while FAT returns file update times in local time. Therefore, when using this flag, make sure that the source and destination files use the same file system and return the file update times in the same format.

'''128''' Create CAFILES alias if required
If an alias is specified in the destination file name, and the alias doesn't already exist, this flag creates the alias.

'''256''' Don't copy the file; just indicate if an update is needed
See the function error codes (below), particularly values 20 and 21.

'''512''' The destination file is located on the CometAnywhere client system

'''1024''' Show a progress bar for transfers between a local Comet system/network and a CometAnywhere client system

'''2048''' Overwrite existing file
If the destination file already exists, overwrite it with the contents of the source file.

'''4096''' Create directory
If a directory is specified for the destination file, and that directory does not already exist, create it.

After this mnemonic is issued, your program should issue an INPUT on LUN (0) to retrieve success/error information. For example:
<pre>
LENGTH 2 & LOCAL AX$,DX$
ResultFmt: FORMAT AX$;DX$
.
.
Print (CopyFile=Source$,Dest$,Flags)
Input (0,ResultFmt)
</pre>
The first field, AX$, contains the function error code, and the second field, DX$, contains the suberror code (aka the Windows file error code). Both of these fields are in Intel 2's complement format, and should be processed as follows:
<pre>
AX$ = SUB(AX$,2,1) + SUB(AX$,1,1) ! Flip the bytes around
DX$ = SUB(DX$,2,1) + SUB(DX$,1,1) ! Flip the bytes around
FuncError = HexDec(AX$) ! Function error code (decimal)
FileError = HexDec(DX$) ! File error code (decimal)

! For unexpected values, convert to 2's complement signed integer
If (FuncError > 32767) FuncError = FuncError-65536
If (FileError > 32767) FileError = FileError-65536
</pre>
Here is a link to Jons error code summary table [[Comet_Error_Codes#CopyFileErrors:]]

Here is a list of the function error codes in decimal form:
Error
('''FuncError''') Description
'''0''' Function not supported
'''1''' Success -- update performed
'''2''' CometAnywhere required
'''3''' Source file error (see suberrors)
'''4''' Aborted by user
'''5''' Function in progress
'''20''' Success -- update not required
'''21''' Success -- update required
'''22''' Destination file error (see suberrors)

Here is a list of the suberror codes (common Windows file errors) in decimal form:

Suberror
('''FileError''') Description
'''0''' Success
'''2''' File not found
'''3''' Path not found
'''5''' Access denied
'''12''' Invalid access
'''15''' Invalid drive
'''16''' An error has occurred in the current directory
'''18''' No more files
'''32''' Sharing violation
'''33''' Lock violation
'''39''' File located on Remote Computer
'''80''' File exists
'''123''' The Filename, Directory Name, or Volume Label Syntax Is Incorrect
'''161''' Bad pathname
'''1326''' User not logged in to Remote Computer

History: This mnemonic was added in Comet Build 299 and REL Version 01.07.
<pre>
Example 1:
Source$ = "C:\SAMPLEFILES\TEST.TXT"
Dest$ = "A:\TEST.TXT"
Flags = 2048
Print (CopyFile=Source$,Dest$,Flags)
</pre>

This example copies the source file named C:\SAMPLEFILES\TEST.TXT to the destination file named A:\TEST.TXT. By default, both files are located on the local Comet system/network. The flag value of 2048 tells Comet to overwrite the destination file if it exists.
If the copying is successful, the function error code will be equal to 1 (Success -- update performed), and the suberror code will be equal to 0 (Success).

<pre>
Example 2:
Source$ = "C:\FILE1.TXT"
Dest$ = "C:\FILE2.TXT"
Flags = 512 + 2048
Print (CopyFile=Source$,Dest$,Flags)
</pre>

This example copies a source file named C:\FILE1.TXT to a destination file named C:\FILE2.TXT
The sum of the two flags tells Comet that the destination file is on the CometAnywhere client system (512), and to overwrite the destination file if the destination file already exists (2048). By default, the source file is on the local Comet system.

Suppose the flag value was changed to the following:

Flags = 1 + 2048

This would tell Comet that the source file is on the CometAnywhere client system (1), while the destination file (by default) is on the local Comet system. The destination file would be overwritten (2048).
Suppose the flag value was changed to the following:

Flags = 1 + 512 + 2048

In this case, the source and destination files are located on the CometAnywhere client system (1 and 512), and the destination file will be overwritten (2048).

Example 3: Suppose you want to copy a file from a local Comet system to a CometAnywhere client system, and you want to synchronize the files (i.e., copy only if the source file is newer than the destination file).
Here are the flags that are used in the following example:

2 = CometAnywhere is required (otherwise an error occurs)
64 = Synchronize the files
512 = Destination file is on CometAnywhere client system
1024 = Show progress bar
2048 = Overwrite existing file
4096 = Create directory

<pre>
Source$ = "C:\FILE1"
Dest$ = "C:\DATA\FILE2"
Flags = 2 + 64 + 512 + 1024 + 2048 + 4096
Print (CopyFile=Source$,Dest$,Flags)
</pre>

Example 4: Suppose you need to copy a large file between a local Comet system and a CometAnywhere client system, but before copying you want to check and see if (a) the update is needed, and (b) if the user wants to perform the update now.
This is done in two steps. First, use the flag that checks to see if the update is required without copying the file (flag=256). If the update is required (as indicated by FuncError=21), then proceed with the copying (change the flags to copy the file).

<pre>
Source$ = "C:\BIGFILE" ! on local Comet system
Dest$ = "C:\BIGFILE" ! on CometAnywhere client system

Flags = 256 + 512 ! 256 = don't copy file; just check to
! see if updated is needed
! 512 = destination is on
! CometAnywhere system

Print (CopyFile=Source$,Dest$,Flags)
Input (0,ResultFmt)

AX$ = SUB(AX$,2,1) + SUB(AX$,1,1) ! Flip the bytes around
DX$ = SUB(DX$,2,1) + SUB(DX$,1,1) ! Flip the bytes around
FuncError = HexDec(AX$) ! Function error code (decimal)
FileError = HexDec(DX$) ! File error code (decimal)

! For unexpected values, convert to 2's complement signed integer
If (FuncError > 32767) FuncError = FuncError-65536
If (FileError > 32767) FileError = FileError-65536

If FuncError = 21
Print "The file needs to be updated."
Print "Do you want to update it now?"
Input A$

If A$ = "Y"
Flags = 512 + 2048
Print (CopyFile=Source$,Dest$,Flags)
Input (0,ResultFmt)
.
.
.
EndIf
EndIf
</pre>

Notes: Depending on your situation you might try using the CUtlCpy utility which is released as part of the UTL directory. You can ENTER it from your app to easily accomplish a file copy or move.
To use a directory alias as the pathname for either of the filenames you can do it like this: FileName$ = "$(AliasNameHere)\" + thefilename$

==(CPL132)==

'''Mnemonic''': (CPL132) Hex equivalent: "@040009@"

'''Discussion''': This mnemonic sets the video display mode to 132 characters per line.
Also see [[#(Screen)]], [[#(CPL64)]], [[#(CPL80)]], and [[#(DE)]].
<pre>
Example:
a. 100 FORMAT (CPL132)
.
PRINT (0,100)
b. PRINT (0) (CPL132)
</pre>

==(CPL64)==

'''Mnemonic''': (CPL64) Hex equivalent: "@0402@"

'''Discussion''': The (CPL64) control code sets the screen display mode to 64 characters per line by 27 lines. The screen is cleared to foreground blanks and the cursor is moved to the "home" position. (Note: In normal mode, the cursor will be moved to the upper left corner of the screen. If typewriter mode is in effect, the cursor will be moved to the lower left corner of the screen.)
This control code may be overridden by the system configuration (if the configuration forces the screen display to 80 columns, for example).

Also see [[#(Screen)]], [[#(CPL132)]], [[#(CPL80)]], and [[#(DE)]].
<pre>
Example:
a. 100 FORMAT (CPL64)
.
PRINT (0,100)

b. PRINT (0) (CPL64)
</pre>

==(CPL80)==
'''Mnemonic''': (CPL80) Hex equivalent: "@0403@"

'''Discussion''': The (CPL80) control code sets the screen display mode to 80 characters per line by 24 lines. The screen is cleared to foreground blanks and the cursor is moved to the "home" position. (Note: In normal mode, the cursor will be moved to the upper left corner of the screen. If typewriter mode is in effect, the cursor will be moved to the lower left corner of the screen.)
Also see [[#(Screen)]], [[#(CPL132)]], [[#(CPL64)]], and [[#(DE)]].
<pre>
Example:
a. 100 FORMAT (CPL80)
.
PRINT (0,100)

b. PRINT (0) (CPL80)
</pre>

==(CR)==
'''Mnemonic''': (CR)

'''Discussion''': Cursor return/carriage return.
This control code can be used on a video device or a printer.

'''Video device'''
In normal mode, the (CR) control code moves the cursor to the first foreground position on the following line. If the cursor is on the bottom line when this control code is issued, the cursor will be moved to the top line of the screen. In either case, the cursor will land only in a foreground field.

In typewriter mode, this control code scrolls the screen up one line (forcing the top line off the screen) and will move the cursor to the beginning (left side) of the bottom line on the screen.

'''Printer'''
The (CR) control code performs a carriage return function for the printer. If this control is issued in the middle of a print line, it advances the printer to the beginning of the next line (unlike a line feed control, which would skip the next line and move to the beginning of the following line).
<pre>
Example (video):
a. 100 FORMAT (CR)
.
PRINT (0,100)

b. PRINT (0) (CR)

Example (printer):
a. 100 FORMAT "CUSTOMER LISTING";(CR);"PRINTED ON:";DAY$
.
OPEN (1) "LP1"
.
PRINT (1,100)

b. OPEN (1) "LP1"
.
PRINT (1) "CUSTOMER LISTING";(CR);"PRINTED ON:";DAY$
</pre>
This last example prints a heading, performs a carriage return, and then prints a subheading on the next line.

==(Create Window)==
'''Mnemonic''': (Create Window=a,b,c,d)
where:
a = upper left column (decimal)
b = upper left row (decimal)
c = lower right column (decimal)
d = lower right row (decimal)

Hex equivalent: "@0E0D00wwxxyyzz@"
where:
ww = upper left row (hex)
xx = upper left column (hex)
yy = lower right row (hex)
zz = lower right column (hex)

'''Discussion''': This mnemonic creates a Comet window using the specified screen coordinates. Note: These coordinates are relative to the full screen (e.g., column 0, row 0 always represents the upper left corner of the display).
When a window is created, the amount of available window memory decreases by the size of the window. To determine how much window memory remains, perform a numeric input immediately following the creation of a window. See the window memory page for more information. If you do not need to know how much window memory remains, perform a null INPUT immediately after printing the (Create Window) mnemonic.

Also see the discussion on Comet windows.
<pre>
Example:
a. 100 FORMAT (Create Window=2,3,70,20)
.
PRINT (0,100)
INPUT (0) ""

b. PRINT (0) (Create Window=2,3,70,20)
INPUT (0) ""
</pre>
This example show how to create a Comet window from column 2, row 3 (the upper left corner) to column 70, row 20 (the lower right corner). The INPUT (0) "" statement allows the program to bypass the value that is returned from the (Create Window) mnemonic (the amount of remaining window memory).

==(CreateWindowEx)==

'''Mnemonic''': (CreateWindowEx=column,row,width,height,style,flags,caption$)

'''Discussion''': This mnemonic creates and selects an extended window, using the following parameters: 
'''Parameter Description''' 
'''column''' The column location of the upper, left-hand corner of the window. This numeric value is expressed in QCRT characters or screen pixels, depending on the value of the flags (see below). 
'''row''' The row location of the upper, left-hand corner of the window. This numeric value is expressed in QCRT characters or screen pixels, depending on the value of the flags (see below). 
'''width''' The width of the window. This numeric value is expressed in QCRT characters. 
'''height''' The height of the window. This numeric value is expressed in QCRT characters. 
'''style''' The style of Window. This numeric value is the sum of the following options: 
'''Style Value Meaning''' 
'''1''' A popup window. The window can be moved outside of Comet window. This value should not be used with 2 (which specifies a child window). 
'''2''' A child window. The window remains within the view window. This value should not be used with 1 (which specifies a popup window). 
'''4''' The window includes a caption bar. 
'''8''' The window includes a border. 
'''16''' The caption bar includes an "X" which closes the window. 
Note: Clicking on the "X" causes an (EasyScan) event to be reported to the Internet Basic program. The EasyScan value is 15. 
'''32''' The window includes a thick frame that lets the user resize the window. 
'''64''' The window is visible. 

'''flags''' The flags for the window. This numeric value is the sum of the following options:
Value Meaning 
'''0''' A modeless window (also known as a user-selectable window). 
Note: If multiple Comet windows are displayed, the user can select which window is the active one by clicking the caption bar. The Internet Basic program can determine the handle of the the window from which data was transmitted via the STS function. 
'''1''' A modal window. All other Comet windows are disabled until this window closes. 
'''2''' A child window with no frame (border). This flag can be used to simulate a legacy Comet window (see CreateWindow). 
'''4''' The window includes a message line (also known as a control line). Any text written with the (WC) mnemonic will be displayed on the message line within this window. 

The following flags pertain to non-child windows only:

'''Value Meaning''' 
'''8''' The column and row positions are expressed in screen pixels, and are relative to the screen (i.e., 0,0 = the upper, left-hand pixel of the screen). 
'''16''' The column and row positions are expressed in screen pixels, and are relative to the client window (i.e., 0,0 = the upper, left-hand pixel of the client window). 
'''32''' The column and row positions are expressed in screen pixels, and are relative to the frame window (i.e., 0,0 = the upper, left-hand pixel of the frame window). 

'''caption$''' If the caption bar style is in effect, this string value is displayed on the caption bar.

Each extended window is identified by a 4-byte string known as a window handle. The handle value is assigned by the system and returned to the Internet Basic program via an INPUT statement following the (CreateWindowEx) mnemonic, as follows:
<pre>
Length 4 & Local Handle1$
.
Print (CreateWindowEx=0,0,35,15,68,1,"This is the caption")
Input Handle1$
</pre>
It follows that the Internet Basic program can create multiple extended windows. The program can select which window to use via the (SelectWindowEx) mnemonic.
An extended window is deleted via the (DeleteWindowEx) mnemonic.

Note: If you write a program that displays more than one extended window at a time, your program may need some way to distinguish which window was active at the time that data was input. The STS function returns the handle of the window that generated the input. This 4-byte value starts in position 11, as shown here:
<pre>
Length 4 & Local Handle$
.
Handle$ = SUB(STS(0),11,4)
</pre>
Symbolic constants: Symbolic constants can be very useful when dealing with the multiple style and flag values. For example, here is a list of recommended symbolic constants for extended windows:
<pre>
'''! Window style'''
SET COS.WS.POPUP = 1 ! Can be moved outside of Comet window. Should
! not be used with COS.WS.CHILD.
SET COS.WS.CHILD = 2 ! Remains within view window. Should not be used
! with COS.WS.POPUP.
SET COS.WS.CAPTION = 4 ! Includes a caption bar
SET COS.WS.BORDER = 8 ! Window includes a border
SET COS.WS.SYSMENU = 16 ! Caption bar 'X' closes window
SET COS.WS.THICKFRAME = 32 ! Thick frame for sizing
SET COS.WS.VISIBLE = 64 ! Window is visible
SET COS.WS.POPUPWINDOW = 25 ! (COS.WS.POPUP+COS.WS.BORDER+COS.WS.SYSMENU)

'''! Window flags'''
SET COS.WF.MODELESS = 0 ! - User selectable window - Use EasyScan
! to determine when a window is activated.
SET COS.WF.MODAL = 1 ! - All other windows are disabled until
! this window closes
SET COS.WF.NOFRAME = 2 ! Create CHILD window with no frame (border).
! Used to simulate a Comet window
SET COS.WF.MSGLINE = 4 ! Has a message line

! The following flags pertain to non-child windows only
SET COS.WF.SCNPIXELPOS = 8 ! Position is in pixels, screen relative
SET COS.WF.CLIPIXELPOS = 16 ! Position is in pixels, client window relative
SET COS.WF.FRMPIXELPOS = 32 ! Position is in pixels, frame window relative
</pre>
With these symbolic constants in place, you can specify the style and flag values by writing a symbolic "formula," as follows:
<pre>
Length 3.0 & Local Style, Flags
Length 5 & Local Handle1$
.
.
Style = COS.WS.POPUPWINDOW + COS.WS.CAPTION
Flags = COS.WF.MODAL + COS.WF.MSGLINE + COS.WF.CLIPIXELPOS
Print (CreateWindowEx=0,0,35,15,Style,Flags,"This is the caption")
Input Handle1$
</pre>

History: This feature is supported in Comet2002 Build 306 and higher.
Examples: See the WinDemo.ibs program (available at www.signature.net/download/demos) for examples of extended windows. This demo program includes many combinations of the style and flags parameters, and also demonstrates some very useful applications for extended windows.

==(CrMode)==

'''Mnemonic''': (CrMode=mode)

'''Discussion''': This mnemonic controls the action of the Enter key. The following values may be used: 
'''0''' = default (from SYSGEN) 
'''1''' = Enter key works like Tab 
'''2''' = Enter key behaves like a CR (goes to beginning of next line unless a TM or TP is encountered) 

History: This mnemonic was added in REL 00.06.

<pre>
Example:
a. 100 FORMAT (CrMode=1)
.
PRINT (0,100)

b. PRINT (0) (CrMode=1)
</pre>
This example shows how to make the Enter key work like the Tab key.

== (CS) ==
<pre>

Mnemonic: (CS)
Hex equivalent: "@05@"
Discussion: Clear screen.
The (CS) control code clears the entire screen to foreground blanks and moves the cursor to the home position.

Example: a. 100 FORMAT (CS)
.
PRINT (0,100)

b. PRINT (0) (CS)

</pre>
== (CH) ==
<pre>
Mnemonic: (CH)
Hex equivalent:
Discussion: Cursor home.
The (CH) control code moves the cursor to the "home" position on the screen. Home position is the upper left foreground location of the screen. Since the cursor will land only in a foreground area, "home" may be something other than the upper left corner.

For example, if the upper left corner of the screen contains background or invisible (suppressed background) characters, the cursor will search to the right and to the next line(s) if necessary for the first available foreground position.

Once a foreground field is located, the cursor will be positioned at the first location in that field (left-most position for alphanumeric fields and right-most position for right-justified numeric fields).

Example: a. 100 FORMAT (CH)
.
PRINT (0,100)

b. PRINT (0) (CH)

This example shows how to move the cursor to the home position.

</pre>
==(CR)==
'''Mnemonic''': (CR)

'''Discussion''': Cursor return/carriage return.
This control code can be used on a video device or a printer.

'''Video device'''
In normal mode, the (CR) control code moves the cursor to the first foreground position on the following line. If the cursor is on the bottom line when this control code is issued, the cursor will be moved to the top line of the screen. In either case, the cursor will land only in a foreground field.

In typewriter mode, this control code scrolls the screen up one line (forcing the top line off the screen) and will move the cursor to the beginning (left side) of the bottom line on the screen.

'''Printer'''
The (CR) control code performs a carriage return function for the printer. If this control is issued in the middle of a print line, it advances the printer to the beginning of the next line (unlike a line feed control, which would skip the next line and move to the beginning of the following line).
<pre>
Example (video):
a. 100 FORMAT (CR)
.
PRINT (0,100)

b. PRINT (0) (CR)

Example (printer):
a. 100 FORMAT "CUSTOMER LISTING";(CR);"PRINTED ON:";DAY$
.
OPEN (1) "LP1"
.
PRINT (1,100)

b. OPEN (1) "LP1"
.
PRINT (1) "CUSTOMER LISTING";(CR);"PRINTED ON:";DAY$
</pre>
This last example prints a heading, performs a carriage return, and then prints a subheading on the next line.

Mnemonics "C"

2009-09-04T20:30:07Z

SteveA: /* (CrMode) */

== (CA Sessions) ==

'''Mnemonic''': (CA Sessions=maximum-number-of-sessions)

'''Discussion''': This mnemonic sets a limit on the number of CometAnywhere sessions. The maximum-number-of-sessions is a decimal value. To get information on the current setting, set the argument to 0 and follow the mnemonic with an INPUT (see example 2).

Example 1: Print (CA Sessions=3)

This example sets the maximum number of CometAnywhere sessions to 3.

Example 2: Print (CA Sessions=0) Input A$

This example sets the argument to 0.

As a result, the current setting is returned to the string variable contained in the next INPUT statement following the mnemonic. The return value is a one-byte hex string. For example, if the current maximum-number-of-sessions is 3, the hex value "@03@" is assigned to A$.

== (CapsOff) ==
<pre>
Mnemonic: (CapsOff) Discussion: This mnemonic turns the Caps Lock keyboard function off. See (CapsOn).

Example: Print (CapsOff)

</pre>
== (CapsOn) ==
<pre>
Mnemonic: (CapsOn) Discussion: This mnemonic turns the Caps Lock keyboard function on. See (CapsOff).

Example: Print (CapsOn)
</pre>
== (CC) ==
'''Email Mnemonic:''' (CC=string-argument)

'''Discussion:''' The (CC) mnemonic may be used to specify the "carbon copy" recipients of your email message. Example: OPEN (1) "LEH" PRINT (1) (CC="barbara@@signature.net")

== (CF) ==
'''Mnemonic''': (CF) Hex equivalent: "@06@"

'''Discussion''': Clear foreground. The (CF) control code clears all foreground screen positions to foreground blanks and positions the cursor at the first foreground position on the screen (the upper left corner). This control does not affect background or invisible (suppressed background) screen positions.

This control code is typically used to clear input data from a formatted screen after it is entered in order to prepare for the next set of input data.
<PRE>
Example: a. 100 FORMAT (CF)
.
PRINT (0,100)
b. PRINT (0) (CF)
</pre>
This example shows how to clear all foreground screen positions.

Read about other Email Mnemonics

== (CFLD) ==
'''Mnemonic''': (CFLD) Hex equivalent: "@0407@"

'''Discussion''': Clear field. The (CFLD) control code clears all foreground characters in a field in which the cursor is located and replaces them with foreground blanks. It then positions the cursor in the first position of the field (left-most position for alphanumeric fields and right-most position for right-justified numeric fields). The control code does not affect background or invisible (suppressed background) fields.

This control code may also include a positioning statement to start the clearing operation at a specific point on the screen.
<pre>
Example:
a. 100 FORMAT (CFLD),@(10,0)
.
PRINT (0,100)
b. PRINT (0) (CFLD),@(10,0)
</pre>
These examples demonstrates the "clear field" control code. The positioning statement puts the control into action at column 10, row 0. If this location is a foreground field, it will be cleared to foreground blanks (if not, the control code will do nothing).

== (CH) ==

'''Mnemonic''': (CH) Hex equivalent:

'''Discussion''': Cursor home. The (CH) control code moves the cursor to the "home" position on the screen. Home position is the upper left foreground location of the screen. Since the cursor will land only in a foreground area, "home" may be something other than the upper left corner.

For example, if the upper left corner of the screen contains background or invisible (suppressed background) characters, the cursor will search to the right and to the next line(s) if necessary for the first available foreground position.

Once a foreground field is located, the cursor will be positioned at the first location in that field (left-most position for alphanumeric fields and right-most position for right-justified numeric fields).
<pre>
Example:
a. 100 FORMAT (CH)
.
PRINT (0,100)
b. PRINT (0) (CH)
</pre>
This example shows how to move the cursor to the home position.

== (Change Color) ==

'''Mnemonic''': (Change Color=ARG1$) Hex equivalent: "@0E0E0Bxx00@" where: xx = the foreground color

'''Discussion''': This mnemonic changes the foreground color attribute on the Comet console, and is effective only for the current write operation. ARG1$ is the foreground color; it may be a string constant or a string variable containing the hex representation of the screen color.

See [[Screen Colors]] for a list of color codes.

Also see [[#(Change Colors)]] for a way to change all of the screen colors.
<pre>
Example:
a. 100 FORMAT (Change Color="@07@")
.
PRINT (0,100)
b. PRINT (0) (Change Color="@07@")
</pre>

==(Change Colors)==
'''Mnemonic:''' (Change Colors=ARG1$,ARG2$,ARG3$,ARG4$,ARG5$)

'''Hex equivalent:''' "@0E0E0Evvwwxxyyzz@" where: vv = the foreground color ww = the background color xx = the invisible color (for TM's, TP's, and RJ's) yy = the border color zz = the entry field color

'''Discussion:''' The mnemonic changes all of the screen colors on the Comet console, or within the current Comet window. ARG1$ is the foreground color ARG2$ is the background color ARG3$ is the invisible color (for TM's, TP's, and RJ's) ARG4$ is the border color ARG5$ is the entry field color

All of these arguments are in hex and may be string constants or a string variable containing the hex representation of the screen color.

See [[Screen Colors]] for a list of color codes.

Also see ([[#Change Color]]) for a way to change the foreground color only.
<pre>
Example:
a. 100 FORMAT (Change colors="@0F@","@A0@","@00@","@C0@","@0F@")
.
PRINT (0,100)
b. Print (0) (Change colors="@0F@","@A0@","@00@","@C0@","@0F@")
</pre>

==(CPL132)==
'''Mnemonic''': (CPL132) Hex equivalent: "@040009@"

'''Discussion''': This mnemonic sets the video display mode to 132 characters per line. Also see ([[#Screen]]), ([[#CPL64]]), ([[#CPL80]]), and ([[#DE]]).
<pre>
Example:
a. 100 FORMAT (CPL132)
.
PRINT (0,100)
b. PRINT (0) (CPL132)
</pre>

==(CPL64)==

'''Mnemonic''': (CPL64) Hex equivalent: "@0402@"

'''Discussion''': The (CPL64) control code sets the screen display mode to 64 characters per line by 27 lines. The screen is cleared to foreground blanks and the cursor is moved to the "home" position. (Note: In normal mode, the cursor will be moved to the upper left corner of the screen. If typewriter mode is in effect, the cursor will be moved to the lower left corner of the screen.) This control code may be overridden by the system configuration (if the configuration forces the screen display to 80 columns, for example).

Also see [[#(Screen)]], [[#(CPL132)]], [[#(CPL80)]], and [[#(DE)]].
<pre>
Example:
a. 100 FORMAT (CPL64)
.
PRINT (0,100)
b. PRINT (0) (CPL64)
</pre>

==(CPL80)==

'''Mnemonic''': (CPL80) Hex equivalent: "@0403@"

'''Discussion''': The (CPL80) control code sets the screen display mode to 80 characters per line by 24 lines. The screen is cleared to foreground blanks and the cursor is moved to the "home" position. (Note: In normal mode, the cursor will be moved to the upper left corner of the screen. If typewriter mode is in effect, the cursor will be moved to the lower left corner of the screen.) Also see [[#(Screen)]], [[#(CPL132)]], [[#(CPL64)]], and [[#(DE)]].
</pre>
Example:
a. 100 FORMAT (CPL80)
.
PRINT (0,100)
b. PRINT (0) (CPL80)
</pre>

== (Check Box Off) ==
<pre>
Note: This feature is not supported beyond Comet 504. Mnemonic: (Check Box Off) Hex equivalent: "@CAC6B6@" Discussion: This mnemonic draws a graphical check box on the screen. The check box is in the "off" position (i.e., no check mark appears in the box), as shown here:

The check box symbol occupies 3 spaces on the screen.

Note: The (Enhanced Characters On) mnemonic must be used before the (Check Box Off) mnemonic us used.

Also see (Check Box On).

Example: a. 100 FORMAT (Check Box Off)

.
PRINT (0,100)
b. PRINT (0) (Check Box Off)

</pre>
== (Check Box On) ==
<pre>
Note: This feature is not supported beyond Comet 504. Mnemonic: (Check Box On) Hex equivalent: "@CACEB6@" Discussion: This mnemonic draws a graphical check box on the screen. The check box is in the "on" position (i.e., a check mark appears in the box), as shown here:

The check box symbol occupies 3 spaces on the screen.

Note: The (Enhanced Characters On) mnemonic must be used before the (Check Box On) mnemonic us used.

Also see (Check Box Off).

Example: a. 100 FORMAT (Check Box On)

.
PRINT (0,100)
b. PRINT (0) (Check Box On)

Retrieved from "http://64.142.11.195/index.php/Mnemonics"
</pre>
== (CFLD) ==

'''Mnemonic''': (CFLD) Hex equivalent: "@0407@"

'''Discussion''': Clear field. 
The (CFLD) control code clears all foreground characters in a field in which the cursor is located and replaces them with foreground blanks. It then positions the cursor in the first position of the field (left-most position for alphanumeric fields and right-most position for right-justified numeric fields). The control code does not affect background or invisible (suppressed background) fields.

This control code may also include a positioning statement to start the clearing operation at a specific point on the screen.
<pre>
Example:
a. 100 FORMAT (CFLD),@(10,0)
.
PRINT (0,100)
b. PRINT (0) (CFLD),@(10,0)
</pre>
This example demonstrates the "clear field" control code. The positioning statement puts the control into action at column 10, row 0. If this location is a foreground field, it will be cleared to foreground blanks (if not, the control code will do nothing).

== (CF) ==

'''Mnemonic''': (CF) Hex equivalent: "@06@" 
'''Discussion''': Clear foreground.
The (CF) control code clears all foreground screen positions to foreground blanks and positions the cursor at the first foreground position on the screen (the upper left corner). This control does not affect background or invisible (suppressed background) screen positions.

This control code is typically used to clear input data from a formatted screen after it is entered in order to prepare for the next set of input data.
<pre>
Example:
a. 100 FORMAT (CF)
.
PRINT (0,100)
b. PRINT (0) (CF)
</pre>
This example shows how to clear all foreground screen positions.

== (CS) ==

'''Mnemonic''': (CS) Hex equivalent: "@05@" 
'''Discussion''': Clear screen.
The (CS) control code clears the entire screen to foreground blanks and moves the cursor to the home position.
<pre>
Example:
a. 100 FORMAT (CS)
.
PRINT (0,100)
b. PRINT (0) (CS)
</pre>

== (Close Icon) ==
<pre>
Note: This feature is not supported beyond Comet 504.
Mnemonic: (Close Icon)
Hex equivalent: "@CCB8@"
Discussion: This mnemonic draws a graphical "close" icon on the screen, as shown here:

The close icon occupies 2 spaces on the screen.

Note: The (Enhanced Characters On) mnemonic must be used before the (Close Icon) mnemonic us used.

Example: a. 100 FORMAT (Close Icon)
.
PRINT (0,100)

b. PRINT (0) (Close Icon)

</pre>
== Close the mouse ==
Use the following instruction to close the mouse driver:
<pre>
PRINT (0) (Mouse off)
</pre>
See also Show/hide the mouse cursor.

The mouse cursor may be shown or hidden. For mouse-driven applications, you will normally want to show the mouse cursor. For touch-sensitive screen applications, you will normally want to hide the mouse cursor.

To show the regular cursor, use the following instruction:
<pre>
PRINT (0) (Show Mouse Cursor)
</pre>

To hide the regular cursor, use the following instruction:
<pre>
PRINT (0) (Hide Mouse Cursor)
</pre>
Also see Regular cursor display.

==(Copy from Clipboard)==
'''Mnemonic''': (Copy from Clipboard) 
'''Discussion''': This mnemonic, which is used with the system driver (X00), copies the contents from the Windows clipboard into one or more program variables. This mnemonic is issued via a PRINT statement, and the clipboard data is obtained via a subsequent INPUT statement (see example below).

== (Query Clipboard) ==
<pre>

History: This mnemonic was added in REL 01.05 and requires Build 292 or higher.
Example 1: LENGTH 254 & LOCAL RESULT$ ! Define a variable
.
.
.
Open (1) "X00" ! Open system driver
Print (1) (CopyFromClipboard) ! Copy data from clipboard
Input (1) Result$ ! to this variable
Close (1) ! Close system driver

Example 2: LENGTH 254 & LOCAL A$,B$,C$ ! Define 3 variables

CLIP: FORMAT A$;B$;C$ ! FORMAT statement for clipboard data

Open (1) "X00" ! Open system driver
Print (1) (CopyFromClipboard) ! Copy data from clipboard
Input (1,CLIP) ! to the variables in this FORMAT statement
Close (1) ! Close system driver
</pre>
== (Copy to Clipboard) ==
'''Mnemonic''': (Copy to Clipboard) 
'''Discussion''': This mnemonic, which is used with the system driver (X00), copies program data to the Windows clipboard. This mnemonic is issued via a PRINT statement (see examples below).
This mnemonic returns a result string, so it is necessary to issue an INPUT statement following the PRINT statement. However, since this mnemonic should never fail, the result string will not contain any meaningful data.

Also see:
[[#(Copy from Clipboard)]]
[[#(Query Clipboard)]]

History: This mnemonic was added in REL 01.05 and requires Build 292 or higher.
<pre>
Example 1: LENGTH 254 & LOCAL RESULT$
.
Open (1) "X00"
Print (1) (Copy to Clipboard);"This is some data for the clipboard."
Input (1) Result$
Close (1)

Example 2: LENGTH 254 & LOCAL RESULT$,DATA$
.
.
.
DATA$ = "This is some data for the clipboard."
Open (1) "X00"
Print (1) (Copy to Clipboard);DATA$
Input (1) Result$
Close (1)

Example 3: LENGTH 254 & LOCAL RESULT$
.
.
.
Open (1) "X00"
Print (1) (Copy to Clipboard);"" ! Clear the clipboard
Input (1) Result$
Close (1)

</pre>

==(CopyFile)==

'''Mnemonic:''' (CopyFile=source-file,destination-file,flags)

'''Discussion:''' This mnemonic copies the source-file to the destination-file, using the specified flags.

This mnemonic may be used by foreground programs only.

'''Note:''' The (CopyFile) mnemonic is intended to replace (Verify File).

The source-file, which is specified as a full Windows path, UNC path, or directory alias, may be located on a local Comet system/network or a CometAnywhere client system (default is local system).

The destination-file, which is specified as a full Windows path, UNC path, or directory alias, may be located on a local Comet system/network or CometAnywhere client system (default is local system).

When issued on lun (0), this mnemonic copies a file:

*from a local Comet system/network to itself
*from a local Comet system/network to a CometAnywhere client system
*from a CometAnywhere client system to a local Comet system/network
*from the CometAnywhere client system to itself

The mnemonic provides many powerful features, such as an option to compare the source file's modify date with the destination file's modify date (in the case where the destination file already exists) in order to determine whether the source file needs to be copied, an option to display a progress bar during CometAnywhere transfers, and options to create a directory, overwrite an existing file, and create a CAFILE alias if required.

Flags is a numeric value representing the sum of the numeric values listed in the following chart:

'''Flag Description'''

'''1''' The source file is located on the CometAnywhere client system 
'''2''' CometAnywhere is required if remote files are specified

If a flag is set indicating that the source file is located on a CometAnywhere client system (flag='''1''') and/or that the destination file is located on a CometAnywhere client system (flag='''512'''), but the user is running on a local Comet system (i.e., not a CometAnywhere client system):

If this flag is set, an error is reported (see function error 2).
If this flag is not set, Comet substitutes the local drive/path name for a remote path/drive name.

'''64''' Synchronize source and destination files
If the source file is newer than the destination file, or the destination file does not exist, the destination file is updated (assuming that the other flags call for the copying to occur).

If this flag is omitted, the destination file is updated (assuming that the other flags call for the copying to occur).

Note: Different file systems may return file update times in different formats. For example, the NT file system (NTFS) returns file update times in Coordinated Universal Time (abbreviated as UTC; formely known as Greenwich Mean Time), while FAT returns file update times in local time. Therefore, when using this flag, make sure that the source and destination files use the same file system and return the file update times in the same format.

'''128''' Create CAFILES alias if required
If an alias is specified in the destination file name, and the alias doesn't already exist, this flag creates the alias.

'''256''' Don't copy the file; just indicate if an update is needed
See the function error codes (below), particularly values 20 and 21.

'''512''' The destination file is located on the CometAnywhere client system

'''1024''' Show a progress bar for transfers between a local Comet system/network and a CometAnywhere client system

'''2048''' Overwrite existing file
If the destination file already exists, overwrite it with the contents of the source file.

'''4096''' Create directory
If a directory is specified for the destination file, and that directory does not already exist, create it.

After this mnemonic is issued, your program should issue an INPUT on LUN (0) to retrieve success/error information. For example:
<pre>
LENGTH 2 & LOCAL AX$,DX$
ResultFmt: FORMAT AX$;DX$
.
.
Print (CopyFile=Source$,Dest$,Flags)
Input (0,ResultFmt)
</pre>
The first field, AX$, contains the function error code, and the second field, DX$, contains the suberror code (aka the Windows file error code). Both of these fields are in Intel 2's complement format, and should be processed as follows:
<pre>
AX$ = SUB(AX$,2,1) + SUB(AX$,1,1) ! Flip the bytes around
DX$ = SUB(DX$,2,1) + SUB(DX$,1,1) ! Flip the bytes around
FuncError = HexDec(AX$) ! Function error code (decimal)
FileError = HexDec(DX$) ! File error code (decimal)

! For unexpected values, convert to 2's complement signed integer
If (FuncError > 32767) FuncError = FuncError-65536
If (FileError > 32767) FileError = FileError-65536
</pre>
Here is a link to Jons error code summary table [[Comet_Error_Codes#CopyFileErrors:]]

Here is a list of the function error codes in decimal form:
Error
('''FuncError''') Description
'''0''' Function not supported
'''1''' Success -- update performed
'''2''' CometAnywhere required
'''3''' Source file error (see suberrors)
'''4''' Aborted by user
'''5''' Function in progress
'''20''' Success -- update not required
'''21''' Success -- update required
'''22''' Destination file error (see suberrors)

Here is a list of the suberror codes (common Windows file errors) in decimal form:

Suberror
('''FileError''') Description
'''0''' Success
'''2''' File not found
'''3''' Path not found
'''5''' Access denied
'''12''' Invalid access
'''15''' Invalid drive
'''16''' An error has occurred in the current directory
'''18''' No more files
'''32''' Sharing violation
'''33''' Lock violation
'''39''' File located on Remote Computer
'''80''' File exists
'''123''' The Filename, Directory Name, or Volume Label Syntax Is Incorrect
'''161''' Bad pathname
'''1326''' User not logged in to Remote Computer

History: This mnemonic was added in Comet Build 299 and REL Version 01.07.
<pre>
Example 1:
Source$ = "C:\SAMPLEFILES\TEST.TXT"
Dest$ = "A:\TEST.TXT"
Flags = 2048
Print (CopyFile=Source$,Dest$,Flags)
</pre>

This example copies the source file named C:\SAMPLEFILES\TEST.TXT to the destination file named A:\TEST.TXT. By default, both files are located on the local Comet system/network. The flag value of 2048 tells Comet to overwrite the destination file if it exists.
If the copying is successful, the function error code will be equal to 1 (Success -- update performed), and the suberror code will be equal to 0 (Success).

<pre>
Example 2:
Source$ = "C:\FILE1.TXT"
Dest$ = "C:\FILE2.TXT"
Flags = 512 + 2048
Print (CopyFile=Source$,Dest$,Flags)
</pre>

This example copies a source file named C:\FILE1.TXT to a destination file named C:\FILE2.TXT
The sum of the two flags tells Comet that the destination file is on the CometAnywhere client system (512), and to overwrite the destination file if the destination file already exists (2048). By default, the source file is on the local Comet system.

Suppose the flag value was changed to the following:

Flags = 1 + 2048

This would tell Comet that the source file is on the CometAnywhere client system (1), while the destination file (by default) is on the local Comet system. The destination file would be overwritten (2048).
Suppose the flag value was changed to the following:

Flags = 1 + 512 + 2048

In this case, the source and destination files are located on the CometAnywhere client system (1 and 512), and the destination file will be overwritten (2048).

Example 3: Suppose you want to copy a file from a local Comet system to a CometAnywhere client system, and you want to synchronize the files (i.e., copy only if the source file is newer than the destination file).
Here are the flags that are used in the following example:

2 = CometAnywhere is required (otherwise an error occurs)
64 = Synchronize the files
512 = Destination file is on CometAnywhere client system
1024 = Show progress bar
2048 = Overwrite existing file
4096 = Create directory

<pre>
Source$ = "C:\FILE1"
Dest$ = "C:\DATA\FILE2"
Flags = 2 + 64 + 512 + 1024 + 2048 + 4096
Print (CopyFile=Source$,Dest$,Flags)
</pre>

Example 4: Suppose you need to copy a large file between a local Comet system and a CometAnywhere client system, but before copying you want to check and see if (a) the update is needed, and (b) if the user wants to perform the update now.
This is done in two steps. First, use the flag that checks to see if the update is required without copying the file (flag=256). If the update is required (as indicated by FuncError=21), then proceed with the copying (change the flags to copy the file).

<pre>
Source$ = "C:\BIGFILE" ! on local Comet system
Dest$ = "C:\BIGFILE" ! on CometAnywhere client system

Flags = 256 + 512 ! 256 = don't copy file; just check to
! see if updated is needed
! 512 = destination is on
! CometAnywhere system

Print (CopyFile=Source$,Dest$,Flags)
Input (0,ResultFmt)

AX$ = SUB(AX$,2,1) + SUB(AX$,1,1) ! Flip the bytes around
DX$ = SUB(DX$,2,1) + SUB(DX$,1,1) ! Flip the bytes around
FuncError = HexDec(AX$) ! Function error code (decimal)
FileError = HexDec(DX$) ! File error code (decimal)

! For unexpected values, convert to 2's complement signed integer
If (FuncError > 32767) FuncError = FuncError-65536
If (FileError > 32767) FileError = FileError-65536

If FuncError = 21
Print "The file needs to be updated."
Print "Do you want to update it now?"
Input A$

If A$ = "Y"
Flags = 512 + 2048
Print (CopyFile=Source$,Dest$,Flags)
Input (0,ResultFmt)
.
.
.
EndIf
EndIf
</pre>

Notes: Depending on your situation you might try using the CUtlCpy utility which is released as part of the UTL directory. You can ENTER it from your app to easily accomplish a file copy or move.
To use a directory alias as the pathname for either of the filenames you can do it like this: FileName$ = "$(AliasNameHere)\" + thefilename$

==(CPL132)==

'''Mnemonic''': (CPL132) Hex equivalent: "@040009@"

'''Discussion''': This mnemonic sets the video display mode to 132 characters per line.
Also see [[#(Screen)]], [[#(CPL64)]], [[#(CPL80)]], and [[#(DE)]].
<pre>
Example:
a. 100 FORMAT (CPL132)
.
PRINT (0,100)
b. PRINT (0) (CPL132)
</pre>

==(CPL64)==

'''Mnemonic''': (CPL64) Hex equivalent: "@0402@"

'''Discussion''': The (CPL64) control code sets the screen display mode to 64 characters per line by 27 lines. The screen is cleared to foreground blanks and the cursor is moved to the "home" position. (Note: In normal mode, the cursor will be moved to the upper left corner of the screen. If typewriter mode is in effect, the cursor will be moved to the lower left corner of the screen.)
This control code may be overridden by the system configuration (if the configuration forces the screen display to 80 columns, for example).

Also see [[#(Screen)]], [[#(CPL132)]], [[#(CPL80)]], and [[#(DE)]].
<pre>
Example:
a. 100 FORMAT (CPL64)
.
PRINT (0,100)

b. PRINT (0) (CPL64)
</pre>

==(CPL80)==
'''Mnemonic''': (CPL80) Hex equivalent: "@0403@"

'''Discussion''': The (CPL80) control code sets the screen display mode to 80 characters per line by 24 lines. The screen is cleared to foreground blanks and the cursor is moved to the "home" position. (Note: In normal mode, the cursor will be moved to the upper left corner of the screen. If typewriter mode is in effect, the cursor will be moved to the lower left corner of the screen.)
Also see [[#(Screen)]], [[#(CPL132)]], [[#(CPL64)]], and [[#(DE)]].
<pre>
Example:
a. 100 FORMAT (CPL80)
.
PRINT (0,100)

b. PRINT (0) (CPL80)
</pre>

==(CR)==
'''Mnemonic''': (CR)

'''Discussion''': Cursor return/carriage return.
This control code can be used on a video device or a printer.

'''Video device'''
In normal mode, the (CR) control code moves the cursor to the first foreground position on the following line. If the cursor is on the bottom line when this control code is issued, the cursor will be moved to the top line of the screen. In either case, the cursor will land only in a foreground field.

In typewriter mode, this control code scrolls the screen up one line (forcing the top line off the screen) and will move the cursor to the beginning (left side) of the bottom line on the screen.

'''Printer'''
The (CR) control code performs a carriage return function for the printer. If this control is issued in the middle of a print line, it advances the printer to the beginning of the next line (unlike a line feed control, which would skip the next line and move to the beginning of the following line).
<pre>
Example (video):
a. 100 FORMAT (CR)
.
PRINT (0,100)

b. PRINT (0) (CR)

Example (printer):
a. 100 FORMAT "CUSTOMER LISTING";(CR);"PRINTED ON:";DAY$
.
OPEN (1) "LP1"
.
PRINT (1,100)

b. OPEN (1) "LP1"
.
PRINT (1) "CUSTOMER LISTING";(CR);"PRINTED ON:";DAY$
</pre>
This last example prints a heading, performs a carriage return, and then prints a subheading on the next line.

==(Create Window)==
'''Mnemonic''': (Create Window=a,b,c,d)
where:
a = upper left column (decimal)
b = upper left row (decimal)
c = lower right column (decimal)
d = lower right row (decimal)

Hex equivalent: "@0E0D00wwxxyyzz@"
where:
ww = upper left row (hex)
xx = upper left column (hex)
yy = lower right row (hex)
zz = lower right column (hex)

'''Discussion''': This mnemonic creates a Comet window using the specified screen coordinates. Note: These coordinates are relative to the full screen (e.g., column 0, row 0 always represents the upper left corner of the display).
When a window is created, the amount of available window memory decreases by the size of the window. To determine how much window memory remains, perform a numeric input immediately following the creation of a window. See the window memory page for more information. If you do not need to know how much window memory remains, perform a null INPUT immediately after printing the (Create Window) mnemonic.

Also see the discussion on Comet windows.
<pre>
Example:
a. 100 FORMAT (Create Window=2,3,70,20)
.
PRINT (0,100)
INPUT (0) ""

b. PRINT (0) (Create Window=2,3,70,20)
INPUT (0) ""
</pre>
This example show how to create a Comet window from column 2, row 3 (the upper left corner) to column 70, row 20 (the lower right corner). The INPUT (0) "" statement allows the program to bypass the value that is returned from the (Create Window) mnemonic (the amount of remaining window memory).

==(CreateWindowEx)==

'''Mnemonic''': (CreateWindowEx=column,row,width,height,style,flags,caption$)

'''Discussion''': This mnemonic creates and selects an extended window, using the following parameters: 
'''Parameter Description''' 
'''column''' The column location of the upper, left-hand corner of the window. This numeric value is expressed in QCRT characters or screen pixels, depending on the value of the flags (see below). 
'''row''' The row location of the upper, left-hand corner of the window. This numeric value is expressed in QCRT characters or screen pixels, depending on the value of the flags (see below). 
'''width''' The width of the window. This numeric value is expressed in QCRT characters. 
'''height''' The height of the window. This numeric value is expressed in QCRT characters. 
'''style''' The style of Window. This numeric value is the sum of the following options: 
'''Style Value Meaning''' 
'''1''' A popup window. The window can be moved outside of Comet window. This value should not be used with 2 (which specifies a child window). 
'''2''' A child window. The window remains within the view window. This value should not be used with 1 (which specifies a popup window). 
'''4''' The window includes a caption bar. 
'''8''' The window includes a border. 
'''16''' The caption bar includes an "X" which closes the window. 
Note: Clicking on the "X" causes an (EasyScan) event to be reported to the Internet Basic program. The EasyScan value is 15. 
'''32''' The window includes a thick frame that lets the user resize the window. 
'''64''' The window is visible. 

'''flags''' The flags for the window. This numeric value is the sum of the following options:
Value Meaning 
'''0''' A modeless window (also known as a user-selectable window). 
Note: If multiple Comet windows are displayed, the user can select which window is the active one by clicking the caption bar. The Internet Basic program can determine the handle of the the window from which data was transmitted via the STS function. 
'''1''' A modal window. All other Comet windows are disabled until this window closes. 
'''2''' A child window with no frame (border). This flag can be used to simulate a legacy Comet window (see CreateWindow). 
'''4''' The window includes a message line (also known as a control line). Any text written with the (WC) mnemonic will be displayed on the message line within this window. 

The following flags pertain to non-child windows only:

'''Value Meaning''' 
'''8''' The column and row positions are expressed in screen pixels, and are relative to the screen (i.e., 0,0 = the upper, left-hand pixel of the screen). 
'''16''' The column and row positions are expressed in screen pixels, and are relative to the client window (i.e., 0,0 = the upper, left-hand pixel of the client window). 
'''32''' The column and row positions are expressed in screen pixels, and are relative to the frame window (i.e., 0,0 = the upper, left-hand pixel of the frame window). 

'''caption$''' If the caption bar style is in effect, this string value is displayed on the caption bar.

Each extended window is identified by a 4-byte string known as a window handle. The handle value is assigned by the system and returned to the Internet Basic program via an INPUT statement following the (CreateWindowEx) mnemonic, as follows:
<pre>
Length 4 & Local Handle1$
.
Print (CreateWindowEx=0,0,35,15,68,1,"This is the caption")
Input Handle1$
</pre>
It follows that the Internet Basic program can create multiple extended windows. The program can select which window to use via the (SelectWindowEx) mnemonic.
An extended window is deleted via the (DeleteWindowEx) mnemonic.

Note: If you write a program that displays more than one extended window at a time, your program may need some way to distinguish which window was active at the time that data was input. The STS function returns the handle of the window that generated the input. This 4-byte value starts in position 11, as shown here:
<pre>
Length 4 & Local Handle$
.
Handle$ = SUB(STS(0),11,4)
</pre>
Symbolic constants: Symbolic constants can be very useful when dealing with the multiple style and flag values. For example, here is a list of recommended symbolic constants for extended windows:
<pre>
'''! Window style'''
SET COS.WS.POPUP = 1 ! Can be moved outside of Comet window. Should
! not be used with COS.WS.CHILD.
SET COS.WS.CHILD = 2 ! Remains within view window. Should not be used
! with COS.WS.POPUP.
SET COS.WS.CAPTION = 4 ! Includes a caption bar
SET COS.WS.BORDER = 8 ! Window includes a border
SET COS.WS.SYSMENU = 16 ! Caption bar 'X' closes window
SET COS.WS.THICKFRAME = 32 ! Thick frame for sizing
SET COS.WS.VISIBLE = 64 ! Window is visible
SET COS.WS.POPUPWINDOW = 25 ! (COS.WS.POPUP+COS.WS.BORDER+COS.WS.SYSMENU)

'''! Window flags'''
SET COS.WF.MODELESS = 0 ! - User selectable window - Use EasyScan
! to determine when a window is activated.
SET COS.WF.MODAL = 1 ! - All other windows are disabled until
! this window closes
SET COS.WF.NOFRAME = 2 ! Create CHILD window with no frame (border).
! Used to simulate a Comet window
SET COS.WF.MSGLINE = 4 ! Has a message line

! The following flags pertain to non-child windows only
SET COS.WF.SCNPIXELPOS = 8 ! Position is in pixels, screen relative
SET COS.WF.CLIPIXELPOS = 16 ! Position is in pixels, client window relative
SET COS.WF.FRMPIXELPOS = 32 ! Position is in pixels, frame window relative
</pre>
With these symbolic constants in place, you can specify the style and flag values by writing a symbolic "formula," as follows:
<pre>
Length 3.0 & Local Style, Flags
Length 5 & Local Handle1$
.
.
Style = COS.WS.POPUPWINDOW + COS.WS.CAPTION
Flags = COS.WF.MODAL + COS.WF.MSGLINE + COS.WF.CLIPIXELPOS
Print (CreateWindowEx=0,0,35,15,Style,Flags,"This is the caption")
Input Handle1$
</pre>

History: This feature is supported in Comet2002 Build 306 and higher.
Examples: See the WinDemo.ibs program (available at www.signature.net/download/demos) for examples of extended windows. This demo program includes many combinations of the style and flags parameters, and also demonstrates some very useful applications for extended windows.

==(CrMode)==

'''Mnemonic''': (CrMode=mode)

'''Discussion''': This mnemonic controls the action of the Enter key. The following values may be used:
'''0''' = default (from SYSGEN)
'''1''' = Enter key works like Tab
'''2''' = Enter key behaves like a CR (goes to beginning of next line unless a TM or TP is encountered)

History: This mnemonic was added in REL 00.06.

<pre>
Example:
a. 100 FORMAT (CrMode=1)
.
PRINT (0,100)

b. PRINT (0) (CrMode=1)
</pre>
This example shows how to make the Enter key work like the Tab key.

== (CS) ==
<pre>

Mnemonic: (CS)
Hex equivalent: "@05@"
Discussion: Clear screen.
The (CS) control code clears the entire screen to foreground blanks and moves the cursor to the home position.

Example: a. 100 FORMAT (CS)
.
PRINT (0,100)

b. PRINT (0) (CS)

</pre>
== (CH) ==
<pre>
Mnemonic: (CH)
Hex equivalent:
Discussion: Cursor home.
The (CH) control code moves the cursor to the "home" position on the screen. Home position is the upper left foreground location of the screen. Since the cursor will land only in a foreground area, "home" may be something other than the upper left corner.

For example, if the upper left corner of the screen contains background or invisible (suppressed background) characters, the cursor will search to the right and to the next line(s) if necessary for the first available foreground position.

Once a foreground field is located, the cursor will be positioned at the first location in that field (left-most position for alphanumeric fields and right-most position for right-justified numeric fields).

Example: a. 100 FORMAT (CH)
.
PRINT (0,100)

b. PRINT (0) (CH)

This example shows how to move the cursor to the home position.

</pre>
==(CR)==
'''Mnemonic''': (CR)

'''Discussion''': Cursor return/carriage return.
This control code can be used on a video device or a printer.

'''Video device'''
In normal mode, the (CR) control code moves the cursor to the first foreground position on the following line. If the cursor is on the bottom line when this control code is issued, the cursor will be moved to the top line of the screen. In either case, the cursor will land only in a foreground field.

In typewriter mode, this control code scrolls the screen up one line (forcing the top line off the screen) and will move the cursor to the beginning (left side) of the bottom line on the screen.

'''Printer'''
The (CR) control code performs a carriage return function for the printer. If this control is issued in the middle of a print line, it advances the printer to the beginning of the next line (unlike a line feed control, which would skip the next line and move to the beginning of the following line).
<pre>
Example (video):
a. 100 FORMAT (CR)
.
PRINT (0,100)

b. PRINT (0) (CR)

Example (printer):
a. 100 FORMAT "CUSTOMER LISTING";(CR);"PRINTED ON:";DAY$
.
OPEN (1) "LP1"
.
PRINT (1,100)

b. OPEN (1) "LP1"
.
PRINT (1) "CUSTOMER LISTING";(CR);"PRINTED ON:";DAY$
</pre>
This last example prints a heading, performs a carriage return, and then prints a subheading on the next line.

Mnemonics "C"

2009-09-04T20:29:50Z

SteveA: /* (CrMode) */

== (CA Sessions) ==

'''Mnemonic''': (CA Sessions=maximum-number-of-sessions)

'''Discussion''': This mnemonic sets a limit on the number of CometAnywhere sessions. The maximum-number-of-sessions is a decimal value. To get information on the current setting, set the argument to 0 and follow the mnemonic with an INPUT (see example 2).

Example 1: Print (CA Sessions=3)

This example sets the maximum number of CometAnywhere sessions to 3.

Example 2: Print (CA Sessions=0) Input A$

This example sets the argument to 0.

As a result, the current setting is returned to the string variable contained in the next INPUT statement following the mnemonic. The return value is a one-byte hex string. For example, if the current maximum-number-of-sessions is 3, the hex value "@03@" is assigned to A$.

== (CapsOff) ==
<pre>
Mnemonic: (CapsOff) Discussion: This mnemonic turns the Caps Lock keyboard function off. See (CapsOn).

Example: Print (CapsOff)

</pre>
== (CapsOn) ==
<pre>
Mnemonic: (CapsOn) Discussion: This mnemonic turns the Caps Lock keyboard function on. See (CapsOff).

Example: Print (CapsOn)
</pre>
== (CC) ==
'''Email Mnemonic:''' (CC=string-argument)

'''Discussion:''' The (CC) mnemonic may be used to specify the "carbon copy" recipients of your email message. Example: OPEN (1) "LEH" PRINT (1) (CC="barbara@@signature.net")

== (CF) ==
'''Mnemonic''': (CF) Hex equivalent: "@06@"

'''Discussion''': Clear foreground. The (CF) control code clears all foreground screen positions to foreground blanks and positions the cursor at the first foreground position on the screen (the upper left corner). This control does not affect background or invisible (suppressed background) screen positions.

This control code is typically used to clear input data from a formatted screen after it is entered in order to prepare for the next set of input data.
<PRE>
Example: a. 100 FORMAT (CF)
.
PRINT (0,100)
b. PRINT (0) (CF)
</pre>
This example shows how to clear all foreground screen positions.

Read about other Email Mnemonics

== (CFLD) ==
'''Mnemonic''': (CFLD) Hex equivalent: "@0407@"

'''Discussion''': Clear field. The (CFLD) control code clears all foreground characters in a field in which the cursor is located and replaces them with foreground blanks. It then positions the cursor in the first position of the field (left-most position for alphanumeric fields and right-most position for right-justified numeric fields). The control code does not affect background or invisible (suppressed background) fields.

This control code may also include a positioning statement to start the clearing operation at a specific point on the screen.
<pre>
Example:
a. 100 FORMAT (CFLD),@(10,0)
.
PRINT (0,100)
b. PRINT (0) (CFLD),@(10,0)
</pre>
These examples demonstrates the "clear field" control code. The positioning statement puts the control into action at column 10, row 0. If this location is a foreground field, it will be cleared to foreground blanks (if not, the control code will do nothing).

== (CH) ==

'''Mnemonic''': (CH) Hex equivalent:

'''Discussion''': Cursor home. The (CH) control code moves the cursor to the "home" position on the screen. Home position is the upper left foreground location of the screen. Since the cursor will land only in a foreground area, "home" may be something other than the upper left corner.

For example, if the upper left corner of the screen contains background or invisible (suppressed background) characters, the cursor will search to the right and to the next line(s) if necessary for the first available foreground position.

Once a foreground field is located, the cursor will be positioned at the first location in that field (left-most position for alphanumeric fields and right-most position for right-justified numeric fields).
<pre>
Example:
a. 100 FORMAT (CH)
.
PRINT (0,100)
b. PRINT (0) (CH)
</pre>
This example shows how to move the cursor to the home position.

== (Change Color) ==

'''Mnemonic''': (Change Color=ARG1$) Hex equivalent: "@0E0E0Bxx00@" where: xx = the foreground color

'''Discussion''': This mnemonic changes the foreground color attribute on the Comet console, and is effective only for the current write operation. ARG1$ is the foreground color; it may be a string constant or a string variable containing the hex representation of the screen color.

See [[Screen Colors]] for a list of color codes.

Also see [[#(Change Colors)]] for a way to change all of the screen colors.
<pre>
Example:
a. 100 FORMAT (Change Color="@07@")
.
PRINT (0,100)
b. PRINT (0) (Change Color="@07@")
</pre>

==(Change Colors)==
'''Mnemonic:''' (Change Colors=ARG1$,ARG2$,ARG3$,ARG4$,ARG5$)

'''Hex equivalent:''' "@0E0E0Evvwwxxyyzz@" where: vv = the foreground color ww = the background color xx = the invisible color (for TM's, TP's, and RJ's) yy = the border color zz = the entry field color

'''Discussion:''' The mnemonic changes all of the screen colors on the Comet console, or within the current Comet window. ARG1$ is the foreground color ARG2$ is the background color ARG3$ is the invisible color (for TM's, TP's, and RJ's) ARG4$ is the border color ARG5$ is the entry field color

All of these arguments are in hex and may be string constants or a string variable containing the hex representation of the screen color.

See [[Screen Colors]] for a list of color codes.

Also see ([[#Change Color]]) for a way to change the foreground color only.
<pre>
Example:
a. 100 FORMAT (Change colors="@0F@","@A0@","@00@","@C0@","@0F@")
.
PRINT (0,100)
b. Print (0) (Change colors="@0F@","@A0@","@00@","@C0@","@0F@")
</pre>

==(CPL132)==
'''Mnemonic''': (CPL132) Hex equivalent: "@040009@"

'''Discussion''': This mnemonic sets the video display mode to 132 characters per line. Also see ([[#Screen]]), ([[#CPL64]]), ([[#CPL80]]), and ([[#DE]]).
<pre>
Example:
a. 100 FORMAT (CPL132)
.
PRINT (0,100)
b. PRINT (0) (CPL132)
</pre>

==(CPL64)==

'''Mnemonic''': (CPL64) Hex equivalent: "@0402@"

'''Discussion''': The (CPL64) control code sets the screen display mode to 64 characters per line by 27 lines. The screen is cleared to foreground blanks and the cursor is moved to the "home" position. (Note: In normal mode, the cursor will be moved to the upper left corner of the screen. If typewriter mode is in effect, the cursor will be moved to the lower left corner of the screen.) This control code may be overridden by the system configuration (if the configuration forces the screen display to 80 columns, for example).

Also see [[#(Screen)]], [[#(CPL132)]], [[#(CPL80)]], and [[#(DE)]].
<pre>
Example:
a. 100 FORMAT (CPL64)
.
PRINT (0,100)
b. PRINT (0) (CPL64)
</pre>

==(CPL80)==

'''Mnemonic''': (CPL80) Hex equivalent: "@0403@"

'''Discussion''': The (CPL80) control code sets the screen display mode to 80 characters per line by 24 lines. The screen is cleared to foreground blanks and the cursor is moved to the "home" position. (Note: In normal mode, the cursor will be moved to the upper left corner of the screen. If typewriter mode is in effect, the cursor will be moved to the lower left corner of the screen.) Also see [[#(Screen)]], [[#(CPL132)]], [[#(CPL64)]], and [[#(DE)]].
</pre>
Example:
a. 100 FORMAT (CPL80)
.
PRINT (0,100)
b. PRINT (0) (CPL80)
</pre>

== (Check Box Off) ==
<pre>
Note: This feature is not supported beyond Comet 504. Mnemonic: (Check Box Off) Hex equivalent: "@CAC6B6@" Discussion: This mnemonic draws a graphical check box on the screen. The check box is in the "off" position (i.e., no check mark appears in the box), as shown here:

The check box symbol occupies 3 spaces on the screen.

Note: The (Enhanced Characters On) mnemonic must be used before the (Check Box Off) mnemonic us used.

Also see (Check Box On).

Example: a. 100 FORMAT (Check Box Off)

.
PRINT (0,100)
b. PRINT (0) (Check Box Off)

</pre>
== (Check Box On) ==
<pre>
Note: This feature is not supported beyond Comet 504. Mnemonic: (Check Box On) Hex equivalent: "@CACEB6@" Discussion: This mnemonic draws a graphical check box on the screen. The check box is in the "on" position (i.e., a check mark appears in the box), as shown here:

The check box symbol occupies 3 spaces on the screen.

Note: The (Enhanced Characters On) mnemonic must be used before the (Check Box On) mnemonic us used.

Also see (Check Box Off).

Example: a. 100 FORMAT (Check Box On)

.
PRINT (0,100)
b. PRINT (0) (Check Box On)

Retrieved from "http://64.142.11.195/index.php/Mnemonics"
</pre>
== (CFLD) ==

'''Mnemonic''': (CFLD) Hex equivalent: "@0407@"

'''Discussion''': Clear field. 
The (CFLD) control code clears all foreground characters in a field in which the cursor is located and replaces them with foreground blanks. It then positions the cursor in the first position of the field (left-most position for alphanumeric fields and right-most position for right-justified numeric fields). The control code does not affect background or invisible (suppressed background) fields.

This control code may also include a positioning statement to start the clearing operation at a specific point on the screen.
<pre>
Example:
a. 100 FORMAT (CFLD),@(10,0)
.
PRINT (0,100)
b. PRINT (0) (CFLD),@(10,0)
</pre>
This example demonstrates the "clear field" control code. The positioning statement puts the control into action at column 10, row 0. If this location is a foreground field, it will be cleared to foreground blanks (if not, the control code will do nothing).

== (CF) ==

'''Mnemonic''': (CF) Hex equivalent: "@06@" 
'''Discussion''': Clear foreground.
The (CF) control code clears all foreground screen positions to foreground blanks and positions the cursor at the first foreground position on the screen (the upper left corner). This control does not affect background or invisible (suppressed background) screen positions.

This control code is typically used to clear input data from a formatted screen after it is entered in order to prepare for the next set of input data.
<pre>
Example:
a. 100 FORMAT (CF)
.
PRINT (0,100)
b. PRINT (0) (CF)
</pre>
This example shows how to clear all foreground screen positions.

== (CS) ==

'''Mnemonic''': (CS) Hex equivalent: "@05@" 
'''Discussion''': Clear screen.
The (CS) control code clears the entire screen to foreground blanks and moves the cursor to the home position.
<pre>
Example:
a. 100 FORMAT (CS)
.
PRINT (0,100)
b. PRINT (0) (CS)
</pre>

== (Close Icon) ==
<pre>
Note: This feature is not supported beyond Comet 504.
Mnemonic: (Close Icon)
Hex equivalent: "@CCB8@"
Discussion: This mnemonic draws a graphical "close" icon on the screen, as shown here:

The close icon occupies 2 spaces on the screen.

Note: The (Enhanced Characters On) mnemonic must be used before the (Close Icon) mnemonic us used.

Example: a. 100 FORMAT (Close Icon)
.
PRINT (0,100)

b. PRINT (0) (Close Icon)

</pre>
== Close the mouse ==
Use the following instruction to close the mouse driver:
<pre>
PRINT (0) (Mouse off)
</pre>
See also Show/hide the mouse cursor.

The mouse cursor may be shown or hidden. For mouse-driven applications, you will normally want to show the mouse cursor. For touch-sensitive screen applications, you will normally want to hide the mouse cursor.

To show the regular cursor, use the following instruction:
<pre>
PRINT (0) (Show Mouse Cursor)
</pre>

To hide the regular cursor, use the following instruction:
<pre>
PRINT (0) (Hide Mouse Cursor)
</pre>
Also see Regular cursor display.

==(Copy from Clipboard)==
'''Mnemonic''': (Copy from Clipboard) 
'''Discussion''': This mnemonic, which is used with the system driver (X00), copies the contents from the Windows clipboard into one or more program variables. This mnemonic is issued via a PRINT statement, and the clipboard data is obtained via a subsequent INPUT statement (see example below).

== (Query Clipboard) ==
<pre>

History: This mnemonic was added in REL 01.05 and requires Build 292 or higher.
Example 1: LENGTH 254 & LOCAL RESULT$ ! Define a variable
.
.
.
Open (1) "X00" ! Open system driver
Print (1) (CopyFromClipboard) ! Copy data from clipboard
Input (1) Result$ ! to this variable
Close (1) ! Close system driver

Example 2: LENGTH 254 & LOCAL A$,B$,C$ ! Define 3 variables

CLIP: FORMAT A$;B$;C$ ! FORMAT statement for clipboard data

Open (1) "X00" ! Open system driver
Print (1) (CopyFromClipboard) ! Copy data from clipboard
Input (1,CLIP) ! to the variables in this FORMAT statement
Close (1) ! Close system driver
</pre>
== (Copy to Clipboard) ==
'''Mnemonic''': (Copy to Clipboard) 
'''Discussion''': This mnemonic, which is used with the system driver (X00), copies program data to the Windows clipboard. This mnemonic is issued via a PRINT statement (see examples below).
This mnemonic returns a result string, so it is necessary to issue an INPUT statement following the PRINT statement. However, since this mnemonic should never fail, the result string will not contain any meaningful data.

Also see:
[[#(Copy from Clipboard)]]
[[#(Query Clipboard)]]

History: This mnemonic was added in REL 01.05 and requires Build 292 or higher.
<pre>
Example 1: LENGTH 254 & LOCAL RESULT$
.
Open (1) "X00"
Print (1) (Copy to Clipboard);"This is some data for the clipboard."
Input (1) Result$
Close (1)

Example 2: LENGTH 254 & LOCAL RESULT$,DATA$
.
.
.
DATA$ = "This is some data for the clipboard."
Open (1) "X00"
Print (1) (Copy to Clipboard);DATA$
Input (1) Result$
Close (1)

Example 3: LENGTH 254 & LOCAL RESULT$
.
.
.
Open (1) "X00"
Print (1) (Copy to Clipboard);"" ! Clear the clipboard
Input (1) Result$
Close (1)

</pre>

==(CopyFile)==

'''Mnemonic:''' (CopyFile=source-file,destination-file,flags)

'''Discussion:''' This mnemonic copies the source-file to the destination-file, using the specified flags.

This mnemonic may be used by foreground programs only.

'''Note:''' The (CopyFile) mnemonic is intended to replace (Verify File).

The source-file, which is specified as a full Windows path, UNC path, or directory alias, may be located on a local Comet system/network or a CometAnywhere client system (default is local system).

The destination-file, which is specified as a full Windows path, UNC path, or directory alias, may be located on a local Comet system/network or CometAnywhere client system (default is local system).

When issued on lun (0), this mnemonic copies a file:

*from a local Comet system/network to itself
*from a local Comet system/network to a CometAnywhere client system
*from a CometAnywhere client system to a local Comet system/network
*from the CometAnywhere client system to itself

The mnemonic provides many powerful features, such as an option to compare the source file's modify date with the destination file's modify date (in the case where the destination file already exists) in order to determine whether the source file needs to be copied, an option to display a progress bar during CometAnywhere transfers, and options to create a directory, overwrite an existing file, and create a CAFILE alias if required.

Flags is a numeric value representing the sum of the numeric values listed in the following chart:

'''Flag Description'''

'''1''' The source file is located on the CometAnywhere client system 
'''2''' CometAnywhere is required if remote files are specified

If a flag is set indicating that the source file is located on a CometAnywhere client system (flag='''1''') and/or that the destination file is located on a CometAnywhere client system (flag='''512'''), but the user is running on a local Comet system (i.e., not a CometAnywhere client system):

If this flag is set, an error is reported (see function error 2).
If this flag is not set, Comet substitutes the local drive/path name for a remote path/drive name.

'''64''' Synchronize source and destination files
If the source file is newer than the destination file, or the destination file does not exist, the destination file is updated (assuming that the other flags call for the copying to occur).

If this flag is omitted, the destination file is updated (assuming that the other flags call for the copying to occur).

Note: Different file systems may return file update times in different formats. For example, the NT file system (NTFS) returns file update times in Coordinated Universal Time (abbreviated as UTC; formely known as Greenwich Mean Time), while FAT returns file update times in local time. Therefore, when using this flag, make sure that the source and destination files use the same file system and return the file update times in the same format.

'''128''' Create CAFILES alias if required
If an alias is specified in the destination file name, and the alias doesn't already exist, this flag creates the alias.

'''256''' Don't copy the file; just indicate if an update is needed
See the function error codes (below), particularly values 20 and 21.

'''512''' The destination file is located on the CometAnywhere client system

'''1024''' Show a progress bar for transfers between a local Comet system/network and a CometAnywhere client system

'''2048''' Overwrite existing file
If the destination file already exists, overwrite it with the contents of the source file.

'''4096''' Create directory
If a directory is specified for the destination file, and that directory does not already exist, create it.

After this mnemonic is issued, your program should issue an INPUT on LUN (0) to retrieve success/error information. For example:
<pre>
LENGTH 2 & LOCAL AX$,DX$
ResultFmt: FORMAT AX$;DX$
.
.
Print (CopyFile=Source$,Dest$,Flags)
Input (0,ResultFmt)
</pre>
The first field, AX$, contains the function error code, and the second field, DX$, contains the suberror code (aka the Windows file error code). Both of these fields are in Intel 2's complement format, and should be processed as follows:
<pre>
AX$ = SUB(AX$,2,1) + SUB(AX$,1,1) ! Flip the bytes around
DX$ = SUB(DX$,2,1) + SUB(DX$,1,1) ! Flip the bytes around
FuncError = HexDec(AX$) ! Function error code (decimal)
FileError = HexDec(DX$) ! File error code (decimal)

! For unexpected values, convert to 2's complement signed integer
If (FuncError > 32767) FuncError = FuncError-65536
If (FileError > 32767) FileError = FileError-65536
</pre>
Here is a link to Jons error code summary table [[Comet_Error_Codes#CopyFileErrors:]]

Here is a list of the function error codes in decimal form:
Error
('''FuncError''') Description
'''0''' Function not supported
'''1''' Success -- update performed
'''2''' CometAnywhere required
'''3''' Source file error (see suberrors)
'''4''' Aborted by user
'''5''' Function in progress
'''20''' Success -- update not required
'''21''' Success -- update required
'''22''' Destination file error (see suberrors)

Here is a list of the suberror codes (common Windows file errors) in decimal form:

Suberror
('''FileError''') Description
'''0''' Success
'''2''' File not found
'''3''' Path not found
'''5''' Access denied
'''12''' Invalid access
'''15''' Invalid drive
'''16''' An error has occurred in the current directory
'''18''' No more files
'''32''' Sharing violation
'''33''' Lock violation
'''39''' File located on Remote Computer
'''80''' File exists
'''123''' The Filename, Directory Name, or Volume Label Syntax Is Incorrect
'''161''' Bad pathname
'''1326''' User not logged in to Remote Computer

History: This mnemonic was added in Comet Build 299 and REL Version 01.07.
<pre>
Example 1:
Source$ = "C:\SAMPLEFILES\TEST.TXT"
Dest$ = "A:\TEST.TXT"
Flags = 2048
Print (CopyFile=Source$,Dest$,Flags)
</pre>

This example copies the source file named C:\SAMPLEFILES\TEST.TXT to the destination file named A:\TEST.TXT. By default, both files are located on the local Comet system/network. The flag value of 2048 tells Comet to overwrite the destination file if it exists.
If the copying is successful, the function error code will be equal to 1 (Success -- update performed), and the suberror code will be equal to 0 (Success).

<pre>
Example 2:
Source$ = "C:\FILE1.TXT"
Dest$ = "C:\FILE2.TXT"
Flags = 512 + 2048
Print (CopyFile=Source$,Dest$,Flags)
</pre>

This example copies a source file named C:\FILE1.TXT to a destination file named C:\FILE2.TXT
The sum of the two flags tells Comet that the destination file is on the CometAnywhere client system (512), and to overwrite the destination file if the destination file already exists (2048). By default, the source file is on the local Comet system.

Suppose the flag value was changed to the following:

Flags = 1 + 2048

This would tell Comet that the source file is on the CometAnywhere client system (1), while the destination file (by default) is on the local Comet system. The destination file would be overwritten (2048).
Suppose the flag value was changed to the following:

Flags = 1 + 512 + 2048

In this case, the source and destination files are located on the CometAnywhere client system (1 and 512), and the destination file will be overwritten (2048).

Example 3: Suppose you want to copy a file from a local Comet system to a CometAnywhere client system, and you want to synchronize the files (i.e., copy only if the source file is newer than the destination file).
Here are the flags that are used in the following example:

2 = CometAnywhere is required (otherwise an error occurs)
64 = Synchronize the files
512 = Destination file is on CometAnywhere client system
1024 = Show progress bar
2048 = Overwrite existing file
4096 = Create directory

<pre>
Source$ = "C:\FILE1"
Dest$ = "C:\DATA\FILE2"
Flags = 2 + 64 + 512 + 1024 + 2048 + 4096
Print (CopyFile=Source$,Dest$,Flags)
</pre>

Example 4: Suppose you need to copy a large file between a local Comet system and a CometAnywhere client system, but before copying you want to check and see if (a) the update is needed, and (b) if the user wants to perform the update now.
This is done in two steps. First, use the flag that checks to see if the update is required without copying the file (flag=256). If the update is required (as indicated by FuncError=21), then proceed with the copying (change the flags to copy the file).

<pre>
Source$ = "C:\BIGFILE" ! on local Comet system
Dest$ = "C:\BIGFILE" ! on CometAnywhere client system

Flags = 256 + 512 ! 256 = don't copy file; just check to
! see if updated is needed
! 512 = destination is on
! CometAnywhere system

Print (CopyFile=Source$,Dest$,Flags)
Input (0,ResultFmt)

AX$ = SUB(AX$,2,1) + SUB(AX$,1,1) ! Flip the bytes around
DX$ = SUB(DX$,2,1) + SUB(DX$,1,1) ! Flip the bytes around
FuncError = HexDec(AX$) ! Function error code (decimal)
FileError = HexDec(DX$) ! File error code (decimal)

! For unexpected values, convert to 2's complement signed integer
If (FuncError > 32767) FuncError = FuncError-65536
If (FileError > 32767) FileError = FileError-65536

If FuncError = 21
Print "The file needs to be updated."
Print "Do you want to update it now?"
Input A$

If A$ = "Y"
Flags = 512 + 2048
Print (CopyFile=Source$,Dest$,Flags)
Input (0,ResultFmt)
.
.
.
EndIf
EndIf
</pre>

Notes: Depending on your situation you might try using the CUtlCpy utility which is released as part of the UTL directory. You can ENTER it from your app to easily accomplish a file copy or move.
To use a directory alias as the pathname for either of the filenames you can do it like this: FileName$ = "$(AliasNameHere)\" + thefilename$

==(CPL132)==

'''Mnemonic''': (CPL132) Hex equivalent: "@040009@"

'''Discussion''': This mnemonic sets the video display mode to 132 characters per line.
Also see [[#(Screen)]], [[#(CPL64)]], [[#(CPL80)]], and [[#(DE)]].
<pre>
Example:
a. 100 FORMAT (CPL132)
.
PRINT (0,100)
b. PRINT (0) (CPL132)
</pre>

==(CPL64)==

'''Mnemonic''': (CPL64) Hex equivalent: "@0402@"

'''Discussion''': The (CPL64) control code sets the screen display mode to 64 characters per line by 27 lines. The screen is cleared to foreground blanks and the cursor is moved to the "home" position. (Note: In normal mode, the cursor will be moved to the upper left corner of the screen. If typewriter mode is in effect, the cursor will be moved to the lower left corner of the screen.)
This control code may be overridden by the system configuration (if the configuration forces the screen display to 80 columns, for example).

Also see [[#(Screen)]], [[#(CPL132)]], [[#(CPL80)]], and [[#(DE)]].
<pre>
Example:
a. 100 FORMAT (CPL64)
.
PRINT (0,100)

b. PRINT (0) (CPL64)
</pre>

==(CPL80)==
'''Mnemonic''': (CPL80) Hex equivalent: "@0403@"

'''Discussion''': The (CPL80) control code sets the screen display mode to 80 characters per line by 24 lines. The screen is cleared to foreground blanks and the cursor is moved to the "home" position. (Note: In normal mode, the cursor will be moved to the upper left corner of the screen. If typewriter mode is in effect, the cursor will be moved to the lower left corner of the screen.)
Also see [[#(Screen)]], [[#(CPL132)]], [[#(CPL64)]], and [[#(DE)]].
<pre>
Example:
a. 100 FORMAT (CPL80)
.
PRINT (0,100)

b. PRINT (0) (CPL80)
</pre>

==(CR)==
'''Mnemonic''': (CR)

'''Discussion''': Cursor return/carriage return.
This control code can be used on a video device or a printer.

'''Video device'''
In normal mode, the (CR) control code moves the cursor to the first foreground position on the following line. If the cursor is on the bottom line when this control code is issued, the cursor will be moved to the top line of the screen. In either case, the cursor will land only in a foreground field.

In typewriter mode, this control code scrolls the screen up one line (forcing the top line off the screen) and will move the cursor to the beginning (left side) of the bottom line on the screen.

'''Printer'''
The (CR) control code performs a carriage return function for the printer. If this control is issued in the middle of a print line, it advances the printer to the beginning of the next line (unlike a line feed control, which would skip the next line and move to the beginning of the following line).
<pre>
Example (video):
a. 100 FORMAT (CR)
.
PRINT (0,100)

b. PRINT (0) (CR)

Example (printer):
a. 100 FORMAT "CUSTOMER LISTING";(CR);"PRINTED ON:";DAY$
.
OPEN (1) "LP1"
.
PRINT (1,100)

b. OPEN (1) "LP1"
.
PRINT (1) "CUSTOMER LISTING";(CR);"PRINTED ON:";DAY$
</pre>
This last example prints a heading, performs a carriage return, and then prints a subheading on the next line.

==(Create Window)==
'''Mnemonic''': (Create Window=a,b,c,d)
where:
a = upper left column (decimal)
b = upper left row (decimal)
c = lower right column (decimal)
d = lower right row (decimal)

Hex equivalent: "@0E0D00wwxxyyzz@"
where:
ww = upper left row (hex)
xx = upper left column (hex)
yy = lower right row (hex)
zz = lower right column (hex)

'''Discussion''': This mnemonic creates a Comet window using the specified screen coordinates. Note: These coordinates are relative to the full screen (e.g., column 0, row 0 always represents the upper left corner of the display).
When a window is created, the amount of available window memory decreases by the size of the window. To determine how much window memory remains, perform a numeric input immediately following the creation of a window. See the window memory page for more information. If you do not need to know how much window memory remains, perform a null INPUT immediately after printing the (Create Window) mnemonic.

Also see the discussion on Comet windows.
<pre>
Example:
a. 100 FORMAT (Create Window=2,3,70,20)
.
PRINT (0,100)
INPUT (0) ""

b. PRINT (0) (Create Window=2,3,70,20)
INPUT (0) ""
</pre>
This example show how to create a Comet window from column 2, row 3 (the upper left corner) to column 70, row 20 (the lower right corner). The INPUT (0) "" statement allows the program to bypass the value that is returned from the (Create Window) mnemonic (the amount of remaining window memory).

==(CreateWindowEx)==

'''Mnemonic''': (CreateWindowEx=column,row,width,height,style,flags,caption$)

'''Discussion''': This mnemonic creates and selects an extended window, using the following parameters: 
'''Parameter Description''' 
'''column''' The column location of the upper, left-hand corner of the window. This numeric value is expressed in QCRT characters or screen pixels, depending on the value of the flags (see below). 
'''row''' The row location of the upper, left-hand corner of the window. This numeric value is expressed in QCRT characters or screen pixels, depending on the value of the flags (see below). 
'''width''' The width of the window. This numeric value is expressed in QCRT characters. 
'''height''' The height of the window. This numeric value is expressed in QCRT characters. 
'''style''' The style of Window. This numeric value is the sum of the following options: 
'''Style Value Meaning''' 
'''1''' A popup window. The window can be moved outside of Comet window. This value should not be used with 2 (which specifies a child window). 
'''2''' A child window. The window remains within the view window. This value should not be used with 1 (which specifies a popup window). 
'''4''' The window includes a caption bar. 
'''8''' The window includes a border. 
'''16''' The caption bar includes an "X" which closes the window. 
Note: Clicking on the "X" causes an (EasyScan) event to be reported to the Internet Basic program. The EasyScan value is 15. 
'''32''' The window includes a thick frame that lets the user resize the window. 
'''64''' The window is visible. 

'''flags''' The flags for the window. This numeric value is the sum of the following options:
Value Meaning 
'''0''' A modeless window (also known as a user-selectable window). 
Note: If multiple Comet windows are displayed, the user can select which window is the active one by clicking the caption bar. The Internet Basic program can determine the handle of the the window from which data was transmitted via the STS function. 
'''1''' A modal window. All other Comet windows are disabled until this window closes. 
'''2''' A child window with no frame (border). This flag can be used to simulate a legacy Comet window (see CreateWindow). 
'''4''' The window includes a message line (also known as a control line). Any text written with the (WC) mnemonic will be displayed on the message line within this window. 

The following flags pertain to non-child windows only:

'''Value Meaning''' 
'''8''' The column and row positions are expressed in screen pixels, and are relative to the screen (i.e., 0,0 = the upper, left-hand pixel of the screen). 
'''16''' The column and row positions are expressed in screen pixels, and are relative to the client window (i.e., 0,0 = the upper, left-hand pixel of the client window). 
'''32''' The column and row positions are expressed in screen pixels, and are relative to the frame window (i.e., 0,0 = the upper, left-hand pixel of the frame window). 

'''caption$''' If the caption bar style is in effect, this string value is displayed on the caption bar.

Each extended window is identified by a 4-byte string known as a window handle. The handle value is assigned by the system and returned to the Internet Basic program via an INPUT statement following the (CreateWindowEx) mnemonic, as follows:
<pre>
Length 4 & Local Handle1$
.
Print (CreateWindowEx=0,0,35,15,68,1,"This is the caption")
Input Handle1$
</pre>
It follows that the Internet Basic program can create multiple extended windows. The program can select which window to use via the (SelectWindowEx) mnemonic.
An extended window is deleted via the (DeleteWindowEx) mnemonic.

Note: If you write a program that displays more than one extended window at a time, your program may need some way to distinguish which window was active at the time that data was input. The STS function returns the handle of the window that generated the input. This 4-byte value starts in position 11, as shown here:
<pre>
Length 4 & Local Handle$
.
Handle$ = SUB(STS(0),11,4)
</pre>
Symbolic constants: Symbolic constants can be very useful when dealing with the multiple style and flag values. For example, here is a list of recommended symbolic constants for extended windows:
<pre>
'''! Window style'''
SET COS.WS.POPUP = 1 ! Can be moved outside of Comet window. Should
! not be used with COS.WS.CHILD.
SET COS.WS.CHILD = 2 ! Remains within view window. Should not be used
! with COS.WS.POPUP.
SET COS.WS.CAPTION = 4 ! Includes a caption bar
SET COS.WS.BORDER = 8 ! Window includes a border
SET COS.WS.SYSMENU = 16 ! Caption bar 'X' closes window
SET COS.WS.THICKFRAME = 32 ! Thick frame for sizing
SET COS.WS.VISIBLE = 64 ! Window is visible
SET COS.WS.POPUPWINDOW = 25 ! (COS.WS.POPUP+COS.WS.BORDER+COS.WS.SYSMENU)

'''! Window flags'''
SET COS.WF.MODELESS = 0 ! - User selectable window - Use EasyScan
! to determine when a window is activated.
SET COS.WF.MODAL = 1 ! - All other windows are disabled until
! this window closes
SET COS.WF.NOFRAME = 2 ! Create CHILD window with no frame (border).
! Used to simulate a Comet window
SET COS.WF.MSGLINE = 4 ! Has a message line

! The following flags pertain to non-child windows only
SET COS.WF.SCNPIXELPOS = 8 ! Position is in pixels, screen relative
SET COS.WF.CLIPIXELPOS = 16 ! Position is in pixels, client window relative
SET COS.WF.FRMPIXELPOS = 32 ! Position is in pixels, frame window relative
</pre>
With these symbolic constants in place, you can specify the style and flag values by writing a symbolic "formula," as follows:
<pre>
Length 3.0 & Local Style, Flags
Length 5 & Local Handle1$
.
.
Style = COS.WS.POPUPWINDOW + COS.WS.CAPTION
Flags = COS.WF.MODAL + COS.WF.MSGLINE + COS.WF.CLIPIXELPOS
Print (CreateWindowEx=0,0,35,15,Style,Flags,"This is the caption")
Input Handle1$
</pre>

History: This feature is supported in Comet2002 Build 306 and higher.
Examples: See the WinDemo.ibs program (available at www.signature.net/download/demos) for examples of extended windows. This demo program includes many combinations of the style and flags parameters, and also demonstrates some very useful applications for extended windows.

==(CrMode)==

'''Mnemonic''': (CrMode=mode)
'''Discussion''': This mnemonic controls the action of the Enter key. The following values may be used:
'''0''' = default (from SYSGEN)
'''1''' = Enter key works like Tab
'''2''' = Enter key behaves like a CR (goes to beginning of next line unless a TM or TP is encountered)

History: This mnemonic was added in REL 00.06.

<pre>
Example:
a. 100 FORMAT (CrMode=1)
.
PRINT (0,100)

b. PRINT (0) (CrMode=1)
</pre>
This example shows how to make the Enter key work like the Tab key.

== (CS) ==
<pre>

Mnemonic: (CS)
Hex equivalent: "@05@"
Discussion: Clear screen.
The (CS) control code clears the entire screen to foreground blanks and moves the cursor to the home position.

Example: a. 100 FORMAT (CS)
.
PRINT (0,100)

b. PRINT (0) (CS)

</pre>
== (CH) ==
<pre>
Mnemonic: (CH)
Hex equivalent:
Discussion: Cursor home.
The (CH) control code moves the cursor to the "home" position on the screen. Home position is the upper left foreground location of the screen. Since the cursor will land only in a foreground area, "home" may be something other than the upper left corner.

For example, if the upper left corner of the screen contains background or invisible (suppressed background) characters, the cursor will search to the right and to the next line(s) if necessary for the first available foreground position.

Once a foreground field is located, the cursor will be positioned at the first location in that field (left-most position for alphanumeric fields and right-most position for right-justified numeric fields).

Example: a. 100 FORMAT (CH)
.
PRINT (0,100)

b. PRINT (0) (CH)

This example shows how to move the cursor to the home position.

</pre>
==(CR)==
'''Mnemonic''': (CR)

'''Discussion''': Cursor return/carriage return.
This control code can be used on a video device or a printer.

'''Video device'''
In normal mode, the (CR) control code moves the cursor to the first foreground position on the following line. If the cursor is on the bottom line when this control code is issued, the cursor will be moved to the top line of the screen. In either case, the cursor will land only in a foreground field.

In typewriter mode, this control code scrolls the screen up one line (forcing the top line off the screen) and will move the cursor to the beginning (left side) of the bottom line on the screen.

'''Printer'''
The (CR) control code performs a carriage return function for the printer. If this control is issued in the middle of a print line, it advances the printer to the beginning of the next line (unlike a line feed control, which would skip the next line and move to the beginning of the following line).
<pre>
Example (video):
a. 100 FORMAT (CR)
.
PRINT (0,100)

b. PRINT (0) (CR)

Example (printer):
a. 100 FORMAT "CUSTOMER LISTING";(CR);"PRINTED ON:";DAY$
.
OPEN (1) "LP1"
.
PRINT (1,100)

b. OPEN (1) "LP1"
.
PRINT (1) "CUSTOMER LISTING";(CR);"PRINTED ON:";DAY$
</pre>
This last example prints a heading, performs a carriage return, and then prints a subheading on the next line.

Mnemonics "C"

2009-09-04T20:26:23Z

SteveA: /* (CreateWindowEx) */

== (CA Sessions) ==

'''Mnemonic''': (CA Sessions=maximum-number-of-sessions)

'''Discussion''': This mnemonic sets a limit on the number of CometAnywhere sessions. The maximum-number-of-sessions is a decimal value. To get information on the current setting, set the argument to 0 and follow the mnemonic with an INPUT (see example 2).

Example 1: Print (CA Sessions=3)

This example sets the maximum number of CometAnywhere sessions to 3.

Example 2: Print (CA Sessions=0) Input A$

This example sets the argument to 0.

As a result, the current setting is returned to the string variable contained in the next INPUT statement following the mnemonic. The return value is a one-byte hex string. For example, if the current maximum-number-of-sessions is 3, the hex value "@03@" is assigned to A$.

== (CapsOff) ==
<pre>
Mnemonic: (CapsOff) Discussion: This mnemonic turns the Caps Lock keyboard function off. See (CapsOn).

Example: Print (CapsOff)

</pre>
== (CapsOn) ==
<pre>
Mnemonic: (CapsOn) Discussion: This mnemonic turns the Caps Lock keyboard function on. See (CapsOff).

Example: Print (CapsOn)
</pre>
== (CC) ==
'''Email Mnemonic:''' (CC=string-argument)

'''Discussion:''' The (CC) mnemonic may be used to specify the "carbon copy" recipients of your email message. Example: OPEN (1) "LEH" PRINT (1) (CC="barbara@@signature.net")

== (CF) ==
'''Mnemonic''': (CF) Hex equivalent: "@06@"

'''Discussion''': Clear foreground. The (CF) control code clears all foreground screen positions to foreground blanks and positions the cursor at the first foreground position on the screen (the upper left corner). This control does not affect background or invisible (suppressed background) screen positions.

This control code is typically used to clear input data from a formatted screen after it is entered in order to prepare for the next set of input data.
<PRE>
Example: a. 100 FORMAT (CF)
.
PRINT (0,100)
b. PRINT (0) (CF)
</pre>
This example shows how to clear all foreground screen positions.

Read about other Email Mnemonics

== (CFLD) ==
'''Mnemonic''': (CFLD) Hex equivalent: "@0407@"

'''Discussion''': Clear field. The (CFLD) control code clears all foreground characters in a field in which the cursor is located and replaces them with foreground blanks. It then positions the cursor in the first position of the field (left-most position for alphanumeric fields and right-most position for right-justified numeric fields). The control code does not affect background or invisible (suppressed background) fields.

This control code may also include a positioning statement to start the clearing operation at a specific point on the screen.
<pre>
Example:
a. 100 FORMAT (CFLD),@(10,0)
.
PRINT (0,100)
b. PRINT (0) (CFLD),@(10,0)
</pre>
These examples demonstrates the "clear field" control code. The positioning statement puts the control into action at column 10, row 0. If this location is a foreground field, it will be cleared to foreground blanks (if not, the control code will do nothing).

== (CH) ==

'''Mnemonic''': (CH) Hex equivalent:

'''Discussion''': Cursor home. The (CH) control code moves the cursor to the "home" position on the screen. Home position is the upper left foreground location of the screen. Since the cursor will land only in a foreground area, "home" may be something other than the upper left corner.

For example, if the upper left corner of the screen contains background or invisible (suppressed background) characters, the cursor will search to the right and to the next line(s) if necessary for the first available foreground position.

Once a foreground field is located, the cursor will be positioned at the first location in that field (left-most position for alphanumeric fields and right-most position for right-justified numeric fields).
<pre>
Example:
a. 100 FORMAT (CH)
.
PRINT (0,100)
b. PRINT (0) (CH)
</pre>
This example shows how to move the cursor to the home position.

== (Change Color) ==

'''Mnemonic''': (Change Color=ARG1$) Hex equivalent: "@0E0E0Bxx00@" where: xx = the foreground color

'''Discussion''': This mnemonic changes the foreground color attribute on the Comet console, and is effective only for the current write operation. ARG1$ is the foreground color; it may be a string constant or a string variable containing the hex representation of the screen color.

See [[Screen Colors]] for a list of color codes.

Also see [[#(Change Colors)]] for a way to change all of the screen colors.
<pre>
Example:
a. 100 FORMAT (Change Color="@07@")
.
PRINT (0,100)
b. PRINT (0) (Change Color="@07@")
</pre>

==(Change Colors)==
'''Mnemonic:''' (Change Colors=ARG1$,ARG2$,ARG3$,ARG4$,ARG5$)

'''Hex equivalent:''' "@0E0E0Evvwwxxyyzz@" where: vv = the foreground color ww = the background color xx = the invisible color (for TM's, TP's, and RJ's) yy = the border color zz = the entry field color

'''Discussion:''' The mnemonic changes all of the screen colors on the Comet console, or within the current Comet window. ARG1$ is the foreground color ARG2$ is the background color ARG3$ is the invisible color (for TM's, TP's, and RJ's) ARG4$ is the border color ARG5$ is the entry field color

All of these arguments are in hex and may be string constants or a string variable containing the hex representation of the screen color.

See [[Screen Colors]] for a list of color codes.

Also see ([[#Change Color]]) for a way to change the foreground color only.
<pre>
Example:
a. 100 FORMAT (Change colors="@0F@","@A0@","@00@","@C0@","@0F@")
.
PRINT (0,100)
b. Print (0) (Change colors="@0F@","@A0@","@00@","@C0@","@0F@")
</pre>

==(CPL132)==
'''Mnemonic''': (CPL132) Hex equivalent: "@040009@"

'''Discussion''': This mnemonic sets the video display mode to 132 characters per line. Also see ([[#Screen]]), ([[#CPL64]]), ([[#CPL80]]), and ([[#DE]]).
<pre>
Example:
a. 100 FORMAT (CPL132)
.
PRINT (0,100)
b. PRINT (0) (CPL132)
</pre>

==(CPL64)==

'''Mnemonic''': (CPL64) Hex equivalent: "@0402@"

'''Discussion''': The (CPL64) control code sets the screen display mode to 64 characters per line by 27 lines. The screen is cleared to foreground blanks and the cursor is moved to the "home" position. (Note: In normal mode, the cursor will be moved to the upper left corner of the screen. If typewriter mode is in effect, the cursor will be moved to the lower left corner of the screen.) This control code may be overridden by the system configuration (if the configuration forces the screen display to 80 columns, for example).

Also see [[#(Screen)]], [[#(CPL132)]], [[#(CPL80)]], and [[#(DE)]].
<pre>
Example:
a. 100 FORMAT (CPL64)
.
PRINT (0,100)
b. PRINT (0) (CPL64)
</pre>

==(CPL80)==

'''Mnemonic''': (CPL80) Hex equivalent: "@0403@"

'''Discussion''': The (CPL80) control code sets the screen display mode to 80 characters per line by 24 lines. The screen is cleared to foreground blanks and the cursor is moved to the "home" position. (Note: In normal mode, the cursor will be moved to the upper left corner of the screen. If typewriter mode is in effect, the cursor will be moved to the lower left corner of the screen.) Also see [[#(Screen)]], [[#(CPL132)]], [[#(CPL64)]], and [[#(DE)]].
</pre>
Example:
a. 100 FORMAT (CPL80)
.
PRINT (0,100)
b. PRINT (0) (CPL80)
</pre>

== (Check Box Off) ==
<pre>
Note: This feature is not supported beyond Comet 504. Mnemonic: (Check Box Off) Hex equivalent: "@CAC6B6@" Discussion: This mnemonic draws a graphical check box on the screen. The check box is in the "off" position (i.e., no check mark appears in the box), as shown here:

The check box symbol occupies 3 spaces on the screen.

Note: The (Enhanced Characters On) mnemonic must be used before the (Check Box Off) mnemonic us used.

Also see (Check Box On).

Example: a. 100 FORMAT (Check Box Off)

.
PRINT (0,100)
b. PRINT (0) (Check Box Off)

</pre>
== (Check Box On) ==
<pre>
Note: This feature is not supported beyond Comet 504. Mnemonic: (Check Box On) Hex equivalent: "@CACEB6@" Discussion: This mnemonic draws a graphical check box on the screen. The check box is in the "on" position (i.e., a check mark appears in the box), as shown here:

The check box symbol occupies 3 spaces on the screen.

Note: The (Enhanced Characters On) mnemonic must be used before the (Check Box On) mnemonic us used.

Also see (Check Box Off).

Example: a. 100 FORMAT (Check Box On)

.
PRINT (0,100)
b. PRINT (0) (Check Box On)

Retrieved from "http://64.142.11.195/index.php/Mnemonics"
</pre>
== (CFLD) ==

'''Mnemonic''': (CFLD) Hex equivalent: "@0407@"

'''Discussion''': Clear field. 
The (CFLD) control code clears all foreground characters in a field in which the cursor is located and replaces them with foreground blanks. It then positions the cursor in the first position of the field (left-most position for alphanumeric fields and right-most position for right-justified numeric fields). The control code does not affect background or invisible (suppressed background) fields.

This control code may also include a positioning statement to start the clearing operation at a specific point on the screen.
<pre>
Example:
a. 100 FORMAT (CFLD),@(10,0)
.
PRINT (0,100)
b. PRINT (0) (CFLD),@(10,0)
</pre>
This example demonstrates the "clear field" control code. The positioning statement puts the control into action at column 10, row 0. If this location is a foreground field, it will be cleared to foreground blanks (if not, the control code will do nothing).

== (CF) ==

'''Mnemonic''': (CF) Hex equivalent: "@06@" 
'''Discussion''': Clear foreground.
The (CF) control code clears all foreground screen positions to foreground blanks and positions the cursor at the first foreground position on the screen (the upper left corner). This control does not affect background or invisible (suppressed background) screen positions.

This control code is typically used to clear input data from a formatted screen after it is entered in order to prepare for the next set of input data.
<pre>
Example:
a. 100 FORMAT (CF)
.
PRINT (0,100)
b. PRINT (0) (CF)
</pre>
This example shows how to clear all foreground screen positions.

== (CS) ==

'''Mnemonic''': (CS) Hex equivalent: "@05@" 
'''Discussion''': Clear screen.
The (CS) control code clears the entire screen to foreground blanks and moves the cursor to the home position.
<pre>
Example:
a. 100 FORMAT (CS)
.
PRINT (0,100)
b. PRINT (0) (CS)
</pre>

== (Close Icon) ==
<pre>
Note: This feature is not supported beyond Comet 504.
Mnemonic: (Close Icon)
Hex equivalent: "@CCB8@"
Discussion: This mnemonic draws a graphical "close" icon on the screen, as shown here:

The close icon occupies 2 spaces on the screen.

Note: The (Enhanced Characters On) mnemonic must be used before the (Close Icon) mnemonic us used.

Example: a. 100 FORMAT (Close Icon)
.
PRINT (0,100)

b. PRINT (0) (Close Icon)

</pre>
== Close the mouse ==
Use the following instruction to close the mouse driver:
<pre>
PRINT (0) (Mouse off)
</pre>
See also Show/hide the mouse cursor.

The mouse cursor may be shown or hidden. For mouse-driven applications, you will normally want to show the mouse cursor. For touch-sensitive screen applications, you will normally want to hide the mouse cursor.

To show the regular cursor, use the following instruction:
<pre>
PRINT (0) (Show Mouse Cursor)
</pre>

To hide the regular cursor, use the following instruction:
<pre>
PRINT (0) (Hide Mouse Cursor)
</pre>
Also see Regular cursor display.

==(Copy from Clipboard)==
'''Mnemonic''': (Copy from Clipboard) 
'''Discussion''': This mnemonic, which is used with the system driver (X00), copies the contents from the Windows clipboard into one or more program variables. This mnemonic is issued via a PRINT statement, and the clipboard data is obtained via a subsequent INPUT statement (see example below).

== (Query Clipboard) ==
<pre>

History: This mnemonic was added in REL 01.05 and requires Build 292 or higher.
Example 1: LENGTH 254 & LOCAL RESULT$ ! Define a variable
.
.
.
Open (1) "X00" ! Open system driver
Print (1) (CopyFromClipboard) ! Copy data from clipboard
Input (1) Result$ ! to this variable
Close (1) ! Close system driver

Example 2: LENGTH 254 & LOCAL A$,B$,C$ ! Define 3 variables

CLIP: FORMAT A$;B$;C$ ! FORMAT statement for clipboard data

Open (1) "X00" ! Open system driver
Print (1) (CopyFromClipboard) ! Copy data from clipboard
Input (1,CLIP) ! to the variables in this FORMAT statement
Close (1) ! Close system driver
</pre>
== (Copy to Clipboard) ==
'''Mnemonic''': (Copy to Clipboard) 
'''Discussion''': This mnemonic, which is used with the system driver (X00), copies program data to the Windows clipboard. This mnemonic is issued via a PRINT statement (see examples below).
This mnemonic returns a result string, so it is necessary to issue an INPUT statement following the PRINT statement. However, since this mnemonic should never fail, the result string will not contain any meaningful data.

Also see:
[[#(Copy from Clipboard)]]
[[#(Query Clipboard)]]

History: This mnemonic was added in REL 01.05 and requires Build 292 or higher.
<pre>
Example 1: LENGTH 254 & LOCAL RESULT$
.
Open (1) "X00"
Print (1) (Copy to Clipboard);"This is some data for the clipboard."
Input (1) Result$
Close (1)

Example 2: LENGTH 254 & LOCAL RESULT$,DATA$
.
.
.
DATA$ = "This is some data for the clipboard."
Open (1) "X00"
Print (1) (Copy to Clipboard);DATA$
Input (1) Result$
Close (1)

Example 3: LENGTH 254 & LOCAL RESULT$
.
.
.
Open (1) "X00"
Print (1) (Copy to Clipboard);"" ! Clear the clipboard
Input (1) Result$
Close (1)

</pre>

==(CopyFile)==

'''Mnemonic:''' (CopyFile=source-file,destination-file,flags)

'''Discussion:''' This mnemonic copies the source-file to the destination-file, using the specified flags.

This mnemonic may be used by foreground programs only.

'''Note:''' The (CopyFile) mnemonic is intended to replace (Verify File).

The source-file, which is specified as a full Windows path, UNC path, or directory alias, may be located on a local Comet system/network or a CometAnywhere client system (default is local system).

The destination-file, which is specified as a full Windows path, UNC path, or directory alias, may be located on a local Comet system/network or CometAnywhere client system (default is local system).

When issued on lun (0), this mnemonic copies a file:

*from a local Comet system/network to itself
*from a local Comet system/network to a CometAnywhere client system
*from a CometAnywhere client system to a local Comet system/network
*from the CometAnywhere client system to itself

The mnemonic provides many powerful features, such as an option to compare the source file's modify date with the destination file's modify date (in the case where the destination file already exists) in order to determine whether the source file needs to be copied, an option to display a progress bar during CometAnywhere transfers, and options to create a directory, overwrite an existing file, and create a CAFILE alias if required.

Flags is a numeric value representing the sum of the numeric values listed in the following chart:

'''Flag Description'''

'''1''' The source file is located on the CometAnywhere client system 
'''2''' CometAnywhere is required if remote files are specified

If a flag is set indicating that the source file is located on a CometAnywhere client system (flag='''1''') and/or that the destination file is located on a CometAnywhere client system (flag='''512'''), but the user is running on a local Comet system (i.e., not a CometAnywhere client system):

If this flag is set, an error is reported (see function error 2).
If this flag is not set, Comet substitutes the local drive/path name for a remote path/drive name.

'''64''' Synchronize source and destination files
If the source file is newer than the destination file, or the destination file does not exist, the destination file is updated (assuming that the other flags call for the copying to occur).

If this flag is omitted, the destination file is updated (assuming that the other flags call for the copying to occur).

Note: Different file systems may return file update times in different formats. For example, the NT file system (NTFS) returns file update times in Coordinated Universal Time (abbreviated as UTC; formely known as Greenwich Mean Time), while FAT returns file update times in local time. Therefore, when using this flag, make sure that the source and destination files use the same file system and return the file update times in the same format.

'''128''' Create CAFILES alias if required
If an alias is specified in the destination file name, and the alias doesn't already exist, this flag creates the alias.

'''256''' Don't copy the file; just indicate if an update is needed
See the function error codes (below), particularly values 20 and 21.

'''512''' The destination file is located on the CometAnywhere client system

'''1024''' Show a progress bar for transfers between a local Comet system/network and a CometAnywhere client system

'''2048''' Overwrite existing file
If the destination file already exists, overwrite it with the contents of the source file.

'''4096''' Create directory
If a directory is specified for the destination file, and that directory does not already exist, create it.

After this mnemonic is issued, your program should issue an INPUT on LUN (0) to retrieve success/error information. For example:
<pre>
LENGTH 2 & LOCAL AX$,DX$
ResultFmt: FORMAT AX$;DX$
.
.
Print (CopyFile=Source$,Dest$,Flags)
Input (0,ResultFmt)
</pre>
The first field, AX$, contains the function error code, and the second field, DX$, contains the suberror code (aka the Windows file error code). Both of these fields are in Intel 2's complement format, and should be processed as follows:
<pre>
AX$ = SUB(AX$,2,1) + SUB(AX$,1,1) ! Flip the bytes around
DX$ = SUB(DX$,2,1) + SUB(DX$,1,1) ! Flip the bytes around
FuncError = HexDec(AX$) ! Function error code (decimal)
FileError = HexDec(DX$) ! File error code (decimal)

! For unexpected values, convert to 2's complement signed integer
If (FuncError > 32767) FuncError = FuncError-65536
If (FileError > 32767) FileError = FileError-65536
</pre>
Here is a link to Jons error code summary table [[Comet_Error_Codes#CopyFileErrors:]]

Here is a list of the function error codes in decimal form:
Error
('''FuncError''') Description
'''0''' Function not supported
'''1''' Success -- update performed
'''2''' CometAnywhere required
'''3''' Source file error (see suberrors)
'''4''' Aborted by user
'''5''' Function in progress
'''20''' Success -- update not required
'''21''' Success -- update required
'''22''' Destination file error (see suberrors)

Here is a list of the suberror codes (common Windows file errors) in decimal form:

Suberror
('''FileError''') Description
'''0''' Success
'''2''' File not found
'''3''' Path not found
'''5''' Access denied
'''12''' Invalid access
'''15''' Invalid drive
'''16''' An error has occurred in the current directory
'''18''' No more files
'''32''' Sharing violation
'''33''' Lock violation
'''39''' File located on Remote Computer
'''80''' File exists
'''123''' The Filename, Directory Name, or Volume Label Syntax Is Incorrect
'''161''' Bad pathname
'''1326''' User not logged in to Remote Computer

History: This mnemonic was added in Comet Build 299 and REL Version 01.07.
<pre>
Example 1:
Source$ = "C:\SAMPLEFILES\TEST.TXT"
Dest$ = "A:\TEST.TXT"
Flags = 2048
Print (CopyFile=Source$,Dest$,Flags)
</pre>

This example copies the source file named C:\SAMPLEFILES\TEST.TXT to the destination file named A:\TEST.TXT. By default, both files are located on the local Comet system/network. The flag value of 2048 tells Comet to overwrite the destination file if it exists.
If the copying is successful, the function error code will be equal to 1 (Success -- update performed), and the suberror code will be equal to 0 (Success).

<pre>
Example 2:
Source$ = "C:\FILE1.TXT"
Dest$ = "C:\FILE2.TXT"
Flags = 512 + 2048
Print (CopyFile=Source$,Dest$,Flags)
</pre>

This example copies a source file named C:\FILE1.TXT to a destination file named C:\FILE2.TXT
The sum of the two flags tells Comet that the destination file is on the CometAnywhere client system (512), and to overwrite the destination file if the destination file already exists (2048). By default, the source file is on the local Comet system.

Suppose the flag value was changed to the following:

Flags = 1 + 2048

This would tell Comet that the source file is on the CometAnywhere client system (1), while the destination file (by default) is on the local Comet system. The destination file would be overwritten (2048).
Suppose the flag value was changed to the following:

Flags = 1 + 512 + 2048

In this case, the source and destination files are located on the CometAnywhere client system (1 and 512), and the destination file will be overwritten (2048).

Example 3: Suppose you want to copy a file from a local Comet system to a CometAnywhere client system, and you want to synchronize the files (i.e., copy only if the source file is newer than the destination file).
Here are the flags that are used in the following example:

2 = CometAnywhere is required (otherwise an error occurs)
64 = Synchronize the files
512 = Destination file is on CometAnywhere client system
1024 = Show progress bar
2048 = Overwrite existing file
4096 = Create directory

<pre>
Source$ = "C:\FILE1"
Dest$ = "C:\DATA\FILE2"
Flags = 2 + 64 + 512 + 1024 + 2048 + 4096
Print (CopyFile=Source$,Dest$,Flags)
</pre>

Example 4: Suppose you need to copy a large file between a local Comet system and a CometAnywhere client system, but before copying you want to check and see if (a) the update is needed, and (b) if the user wants to perform the update now.
This is done in two steps. First, use the flag that checks to see if the update is required without copying the file (flag=256). If the update is required (as indicated by FuncError=21), then proceed with the copying (change the flags to copy the file).

<pre>
Source$ = "C:\BIGFILE" ! on local Comet system
Dest$ = "C:\BIGFILE" ! on CometAnywhere client system

Flags = 256 + 512 ! 256 = don't copy file; just check to
! see if updated is needed
! 512 = destination is on
! CometAnywhere system

Print (CopyFile=Source$,Dest$,Flags)
Input (0,ResultFmt)

AX$ = SUB(AX$,2,1) + SUB(AX$,1,1) ! Flip the bytes around
DX$ = SUB(DX$,2,1) + SUB(DX$,1,1) ! Flip the bytes around
FuncError = HexDec(AX$) ! Function error code (decimal)
FileError = HexDec(DX$) ! File error code (decimal)

! For unexpected values, convert to 2's complement signed integer
If (FuncError > 32767) FuncError = FuncError-65536
If (FileError > 32767) FileError = FileError-65536

If FuncError = 21
Print "The file needs to be updated."
Print "Do you want to update it now?"
Input A$

If A$ = "Y"
Flags = 512 + 2048
Print (CopyFile=Source$,Dest$,Flags)
Input (0,ResultFmt)
.
.
.
EndIf
EndIf
</pre>

Notes: Depending on your situation you might try using the CUtlCpy utility which is released as part of the UTL directory. You can ENTER it from your app to easily accomplish a file copy or move.
To use a directory alias as the pathname for either of the filenames you can do it like this: FileName$ = "$(AliasNameHere)\" + thefilename$

==(CPL132)==

'''Mnemonic''': (CPL132) Hex equivalent: "@040009@"

'''Discussion''': This mnemonic sets the video display mode to 132 characters per line.
Also see [[#(Screen)]], [[#(CPL64)]], [[#(CPL80)]], and [[#(DE)]].
<pre>
Example:
a. 100 FORMAT (CPL132)
.
PRINT (0,100)
b. PRINT (0) (CPL132)
</pre>

==(CPL64)==

'''Mnemonic''': (CPL64) Hex equivalent: "@0402@"

'''Discussion''': The (CPL64) control code sets the screen display mode to 64 characters per line by 27 lines. The screen is cleared to foreground blanks and the cursor is moved to the "home" position. (Note: In normal mode, the cursor will be moved to the upper left corner of the screen. If typewriter mode is in effect, the cursor will be moved to the lower left corner of the screen.)
This control code may be overridden by the system configuration (if the configuration forces the screen display to 80 columns, for example).

Also see [[#(Screen)]], [[#(CPL132)]], [[#(CPL80)]], and [[#(DE)]].
<pre>
Example:
a. 100 FORMAT (CPL64)
.
PRINT (0,100)

b. PRINT (0) (CPL64)
</pre>

==(CPL80)==
'''Mnemonic''': (CPL80) Hex equivalent: "@0403@"

'''Discussion''': The (CPL80) control code sets the screen display mode to 80 characters per line by 24 lines. The screen is cleared to foreground blanks and the cursor is moved to the "home" position. (Note: In normal mode, the cursor will be moved to the upper left corner of the screen. If typewriter mode is in effect, the cursor will be moved to the lower left corner of the screen.)
Also see [[#(Screen)]], [[#(CPL132)]], [[#(CPL64)]], and [[#(DE)]].
<pre>
Example:
a. 100 FORMAT (CPL80)
.
PRINT (0,100)

b. PRINT (0) (CPL80)
</pre>

==(CR)==
'''Mnemonic''': (CR)

'''Discussion''': Cursor return/carriage return.
This control code can be used on a video device or a printer.

'''Video device'''
In normal mode, the (CR) control code moves the cursor to the first foreground position on the following line. If the cursor is on the bottom line when this control code is issued, the cursor will be moved to the top line of the screen. In either case, the cursor will land only in a foreground field.

In typewriter mode, this control code scrolls the screen up one line (forcing the top line off the screen) and will move the cursor to the beginning (left side) of the bottom line on the screen.

'''Printer'''
The (CR) control code performs a carriage return function for the printer. If this control is issued in the middle of a print line, it advances the printer to the beginning of the next line (unlike a line feed control, which would skip the next line and move to the beginning of the following line).
<pre>
Example (video):
a. 100 FORMAT (CR)
.
PRINT (0,100)

b. PRINT (0) (CR)

Example (printer):
a. 100 FORMAT "CUSTOMER LISTING";(CR);"PRINTED ON:";DAY$
.
OPEN (1) "LP1"
.
PRINT (1,100)

b. OPEN (1) "LP1"
.
PRINT (1) "CUSTOMER LISTING";(CR);"PRINTED ON:";DAY$
</pre>
This last example prints a heading, performs a carriage return, and then prints a subheading on the next line.

==(Create Window)==
'''Mnemonic''': (Create Window=a,b,c,d)
where:
a = upper left column (decimal)
b = upper left row (decimal)
c = lower right column (decimal)
d = lower right row (decimal)

Hex equivalent: "@0E0D00wwxxyyzz@"
where:
ww = upper left row (hex)
xx = upper left column (hex)
yy = lower right row (hex)
zz = lower right column (hex)

'''Discussion''': This mnemonic creates a Comet window using the specified screen coordinates. Note: These coordinates are relative to the full screen (e.g., column 0, row 0 always represents the upper left corner of the display).
When a window is created, the amount of available window memory decreases by the size of the window. To determine how much window memory remains, perform a numeric input immediately following the creation of a window. See the window memory page for more information. If you do not need to know how much window memory remains, perform a null INPUT immediately after printing the (Create Window) mnemonic.

Also see the discussion on Comet windows.
<pre>
Example:
a. 100 FORMAT (Create Window=2,3,70,20)
.
PRINT (0,100)
INPUT (0) ""

b. PRINT (0) (Create Window=2,3,70,20)
INPUT (0) ""
</pre>
This example show how to create a Comet window from column 2, row 3 (the upper left corner) to column 70, row 20 (the lower right corner). The INPUT (0) "" statement allows the program to bypass the value that is returned from the (Create Window) mnemonic (the amount of remaining window memory).

==(CreateWindowEx)==

'''Mnemonic''': (CreateWindowEx=column,row,width,height,style,flags,caption$)

'''Discussion''': This mnemonic creates and selects an extended window, using the following parameters: 
'''Parameter Description''' 
'''column''' The column location of the upper, left-hand corner of the window. This numeric value is expressed in QCRT characters or screen pixels, depending on the value of the flags (see below). 
'''row''' The row location of the upper, left-hand corner of the window. This numeric value is expressed in QCRT characters or screen pixels, depending on the value of the flags (see below). 
'''width''' The width of the window. This numeric value is expressed in QCRT characters. 
'''height''' The height of the window. This numeric value is expressed in QCRT characters. 
'''style''' The style of Window. This numeric value is the sum of the following options: 
'''Style Value Meaning''' 
'''1''' A popup window. The window can be moved outside of Comet window. This value should not be used with 2 (which specifies a child window). 
'''2''' A child window. The window remains within the view window. This value should not be used with 1 (which specifies a popup window). 
'''4''' The window includes a caption bar. 
'''8''' The window includes a border. 
'''16''' The caption bar includes an "X" which closes the window. 
Note: Clicking on the "X" causes an (EasyScan) event to be reported to the Internet Basic program. The EasyScan value is 15. 
'''32''' The window includes a thick frame that lets the user resize the window. 
'''64''' The window is visible. 

'''flags''' The flags for the window. This numeric value is the sum of the following options:
Value Meaning 
'''0''' A modeless window (also known as a user-selectable window). 
Note: If multiple Comet windows are displayed, the user can select which window is the active one by clicking the caption bar. The Internet Basic program can determine the handle of the the window from which data was transmitted via the STS function. 
'''1''' A modal window. All other Comet windows are disabled until this window closes. 
'''2''' A child window with no frame (border). This flag can be used to simulate a legacy Comet window (see CreateWindow). 
'''4''' The window includes a message line (also known as a control line). Any text written with the (WC) mnemonic will be displayed on the message line within this window. 

The following flags pertain to non-child windows only:

'''Value Meaning''' 
'''8''' The column and row positions are expressed in screen pixels, and are relative to the screen (i.e., 0,0 = the upper, left-hand pixel of the screen). 
'''16''' The column and row positions are expressed in screen pixels, and are relative to the client window (i.e., 0,0 = the upper, left-hand pixel of the client window). 
'''32''' The column and row positions are expressed in screen pixels, and are relative to the frame window (i.e., 0,0 = the upper, left-hand pixel of the frame window). 

'''caption$''' If the caption bar style is in effect, this string value is displayed on the caption bar.

Each extended window is identified by a 4-byte string known as a window handle. The handle value is assigned by the system and returned to the Internet Basic program via an INPUT statement following the (CreateWindowEx) mnemonic, as follows:
<pre>
Length 4 & Local Handle1$
.
Print (CreateWindowEx=0,0,35,15,68,1,"This is the caption")
Input Handle1$
</pre>
It follows that the Internet Basic program can create multiple extended windows. The program can select which window to use via the (SelectWindowEx) mnemonic.
An extended window is deleted via the (DeleteWindowEx) mnemonic.

Note: If you write a program that displays more than one extended window at a time, your program may need some way to distinguish which window was active at the time that data was input. The STS function returns the handle of the window that generated the input. This 4-byte value starts in position 11, as shown here:
<pre>
Length 4 & Local Handle$
.
Handle$ = SUB(STS(0),11,4)
</pre>
Symbolic constants: Symbolic constants can be very useful when dealing with the multiple style and flag values. For example, here is a list of recommended symbolic constants for extended windows:
<pre>
'''! Window style'''
SET COS.WS.POPUP = 1 ! Can be moved outside of Comet window. Should
! not be used with COS.WS.CHILD.
SET COS.WS.CHILD = 2 ! Remains within view window. Should not be used
! with COS.WS.POPUP.
SET COS.WS.CAPTION = 4 ! Includes a caption bar
SET COS.WS.BORDER = 8 ! Window includes a border
SET COS.WS.SYSMENU = 16 ! Caption bar 'X' closes window
SET COS.WS.THICKFRAME = 32 ! Thick frame for sizing
SET COS.WS.VISIBLE = 64 ! Window is visible
SET COS.WS.POPUPWINDOW = 25 ! (COS.WS.POPUP+COS.WS.BORDER+COS.WS.SYSMENU)

'''! Window flags'''
SET COS.WF.MODELESS = 0 ! - User selectable window - Use EasyScan
! to determine when a window is activated.
SET COS.WF.MODAL = 1 ! - All other windows are disabled until
! this window closes
SET COS.WF.NOFRAME = 2 ! Create CHILD window with no frame (border).
! Used to simulate a Comet window
SET COS.WF.MSGLINE = 4 ! Has a message line

! The following flags pertain to non-child windows only
SET COS.WF.SCNPIXELPOS = 8 ! Position is in pixels, screen relative
SET COS.WF.CLIPIXELPOS = 16 ! Position is in pixels, client window relative
SET COS.WF.FRMPIXELPOS = 32 ! Position is in pixels, frame window relative
</pre>
With these symbolic constants in place, you can specify the style and flag values by writing a symbolic "formula," as follows:
<pre>
Length 3.0 & Local Style, Flags
Length 5 & Local Handle1$
.
.
Style = COS.WS.POPUPWINDOW + COS.WS.CAPTION
Flags = COS.WF.MODAL + COS.WF.MSGLINE + COS.WF.CLIPIXELPOS
Print (CreateWindowEx=0,0,35,15,Style,Flags,"This is the caption")
Input Handle1$
</pre>

History: This feature is supported in Comet2002 Build 306 and higher.
Examples: See the WinDemo.ibs program (available at www.signature.net/download/demos) for examples of extended windows. This demo program includes many combinations of the style and flags parameters, and also demonstrates some very useful applications for extended windows.

== (CrMode) ==
<pre>
Mnemonic: (CrMode=mode)
Discussion: This mnemonic controls the action of the Enter key. The following values may be used:
0 = default (from SYSGEN)
1 = Enter key works like Tab
2 = Enter key behaves like a CR (goes to beginning of next
line unless a TM or TP is encountered)

History: This mnemonic was added in REL 00.06.
Example: a. 100 FORMAT (CrMode=1)
.
PRINT (0,100)

b. PRINT (0) (CrMode=1)

This example shows how to make the Enter key work like the Tab key.

</pre>
== (CS) ==
<pre>

Mnemonic: (CS)
Hex equivalent: "@05@"
Discussion: Clear screen.
The (CS) control code clears the entire screen to foreground blanks and moves the cursor to the home position.

Example: a. 100 FORMAT (CS)
.
PRINT (0,100)

b. PRINT (0) (CS)

</pre>
== (CH) ==
<pre>
Mnemonic: (CH)
Hex equivalent:
Discussion: Cursor home.
The (CH) control code moves the cursor to the "home" position on the screen. Home position is the upper left foreground location of the screen. Since the cursor will land only in a foreground area, "home" may be something other than the upper left corner.

For example, if the upper left corner of the screen contains background or invisible (suppressed background) characters, the cursor will search to the right and to the next line(s) if necessary for the first available foreground position.

Once a foreground field is located, the cursor will be positioned at the first location in that field (left-most position for alphanumeric fields and right-most position for right-justified numeric fields).

Example: a. 100 FORMAT (CH)
.
PRINT (0,100)

b. PRINT (0) (CH)

This example shows how to move the cursor to the home position.

</pre>
==(CR)==
'''Mnemonic''': (CR)

'''Discussion''': Cursor return/carriage return.
This control code can be used on a video device or a printer.

'''Video device'''
In normal mode, the (CR) control code moves the cursor to the first foreground position on the following line. If the cursor is on the bottom line when this control code is issued, the cursor will be moved to the top line of the screen. In either case, the cursor will land only in a foreground field.

In typewriter mode, this control code scrolls the screen up one line (forcing the top line off the screen) and will move the cursor to the beginning (left side) of the bottom line on the screen.

'''Printer'''
The (CR) control code performs a carriage return function for the printer. If this control is issued in the middle of a print line, it advances the printer to the beginning of the next line (unlike a line feed control, which would skip the next line and move to the beginning of the following line).
<pre>
Example (video):
a. 100 FORMAT (CR)
.
PRINT (0,100)

b. PRINT (0) (CR)

Example (printer):
a. 100 FORMAT "CUSTOMER LISTING";(CR);"PRINTED ON:";DAY$
.
OPEN (1) "LP1"
.
PRINT (1,100)

b. OPEN (1) "LP1"
.
PRINT (1) "CUSTOMER LISTING";(CR);"PRINTED ON:";DAY$
</pre>
This last example prints a heading, performs a carriage return, and then prints a subheading on the next line.

Mnemonics "C"

2009-09-04T20:22:53Z

SteveA: /* (CreateWindowEx) */

== (CA Sessions) ==

'''Mnemonic''': (CA Sessions=maximum-number-of-sessions)

'''Discussion''': This mnemonic sets a limit on the number of CometAnywhere sessions. The maximum-number-of-sessions is a decimal value. To get information on the current setting, set the argument to 0 and follow the mnemonic with an INPUT (see example 2).

Example 1: Print (CA Sessions=3)

This example sets the maximum number of CometAnywhere sessions to 3.

Example 2: Print (CA Sessions=0) Input A$

This example sets the argument to 0.

As a result, the current setting is returned to the string variable contained in the next INPUT statement following the mnemonic. The return value is a one-byte hex string. For example, if the current maximum-number-of-sessions is 3, the hex value "@03@" is assigned to A$.

== (CapsOff) ==
<pre>
Mnemonic: (CapsOff) Discussion: This mnemonic turns the Caps Lock keyboard function off. See (CapsOn).

Example: Print (CapsOff)

</pre>
== (CapsOn) ==
<pre>
Mnemonic: (CapsOn) Discussion: This mnemonic turns the Caps Lock keyboard function on. See (CapsOff).

Example: Print (CapsOn)
</pre>
== (CC) ==
'''Email Mnemonic:''' (CC=string-argument)

'''Discussion:''' The (CC) mnemonic may be used to specify the "carbon copy" recipients of your email message. Example: OPEN (1) "LEH" PRINT (1) (CC="barbara@@signature.net")

== (CF) ==
'''Mnemonic''': (CF) Hex equivalent: "@06@"

'''Discussion''': Clear foreground. The (CF) control code clears all foreground screen positions to foreground blanks and positions the cursor at the first foreground position on the screen (the upper left corner). This control does not affect background or invisible (suppressed background) screen positions.

This control code is typically used to clear input data from a formatted screen after it is entered in order to prepare for the next set of input data.
<PRE>
Example: a. 100 FORMAT (CF)
.
PRINT (0,100)
b. PRINT (0) (CF)
</pre>
This example shows how to clear all foreground screen positions.

Read about other Email Mnemonics

== (CFLD) ==
'''Mnemonic''': (CFLD) Hex equivalent: "@0407@"

'''Discussion''': Clear field. The (CFLD) control code clears all foreground characters in a field in which the cursor is located and replaces them with foreground blanks. It then positions the cursor in the first position of the field (left-most position for alphanumeric fields and right-most position for right-justified numeric fields). The control code does not affect background or invisible (suppressed background) fields.

This control code may also include a positioning statement to start the clearing operation at a specific point on the screen.
<pre>
Example:
a. 100 FORMAT (CFLD),@(10,0)
.
PRINT (0,100)
b. PRINT (0) (CFLD),@(10,0)
</pre>
These examples demonstrates the "clear field" control code. The positioning statement puts the control into action at column 10, row 0. If this location is a foreground field, it will be cleared to foreground blanks (if not, the control code will do nothing).

== (CH) ==

'''Mnemonic''': (CH) Hex equivalent:

'''Discussion''': Cursor home. The (CH) control code moves the cursor to the "home" position on the screen. Home position is the upper left foreground location of the screen. Since the cursor will land only in a foreground area, "home" may be something other than the upper left corner.

For example, if the upper left corner of the screen contains background or invisible (suppressed background) characters, the cursor will search to the right and to the next line(s) if necessary for the first available foreground position.

Once a foreground field is located, the cursor will be positioned at the first location in that field (left-most position for alphanumeric fields and right-most position for right-justified numeric fields).
<pre>
Example:
a. 100 FORMAT (CH)
.
PRINT (0,100)
b. PRINT (0) (CH)
</pre>
This example shows how to move the cursor to the home position.

== (Change Color) ==

'''Mnemonic''': (Change Color=ARG1$) Hex equivalent: "@0E0E0Bxx00@" where: xx = the foreground color

'''Discussion''': This mnemonic changes the foreground color attribute on the Comet console, and is effective only for the current write operation. ARG1$ is the foreground color; it may be a string constant or a string variable containing the hex representation of the screen color.

See [[Screen Colors]] for a list of color codes.

Also see [[#(Change Colors)]] for a way to change all of the screen colors.
<pre>
Example:
a. 100 FORMAT (Change Color="@07@")
.
PRINT (0,100)
b. PRINT (0) (Change Color="@07@")
</pre>

==(Change Colors)==
'''Mnemonic:''' (Change Colors=ARG1$,ARG2$,ARG3$,ARG4$,ARG5$)

'''Hex equivalent:''' "@0E0E0Evvwwxxyyzz@" where: vv = the foreground color ww = the background color xx = the invisible color (for TM's, TP's, and RJ's) yy = the border color zz = the entry field color

'''Discussion:''' The mnemonic changes all of the screen colors on the Comet console, or within the current Comet window. ARG1$ is the foreground color ARG2$ is the background color ARG3$ is the invisible color (for TM's, TP's, and RJ's) ARG4$ is the border color ARG5$ is the entry field color

All of these arguments are in hex and may be string constants or a string variable containing the hex representation of the screen color.

See [[Screen Colors]] for a list of color codes.

Also see ([[#Change Color]]) for a way to change the foreground color only.
<pre>
Example:
a. 100 FORMAT (Change colors="@0F@","@A0@","@00@","@C0@","@0F@")
.
PRINT (0,100)
b. Print (0) (Change colors="@0F@","@A0@","@00@","@C0@","@0F@")
</pre>

==(CPL132)==
'''Mnemonic''': (CPL132) Hex equivalent: "@040009@"

'''Discussion''': This mnemonic sets the video display mode to 132 characters per line. Also see ([[#Screen]]), ([[#CPL64]]), ([[#CPL80]]), and ([[#DE]]).
<pre>
Example:
a. 100 FORMAT (CPL132)
.
PRINT (0,100)
b. PRINT (0) (CPL132)
</pre>

==(CPL64)==

'''Mnemonic''': (CPL64) Hex equivalent: "@0402@"

'''Discussion''': The (CPL64) control code sets the screen display mode to 64 characters per line by 27 lines. The screen is cleared to foreground blanks and the cursor is moved to the "home" position. (Note: In normal mode, the cursor will be moved to the upper left corner of the screen. If typewriter mode is in effect, the cursor will be moved to the lower left corner of the screen.) This control code may be overridden by the system configuration (if the configuration forces the screen display to 80 columns, for example).

Also see [[#(Screen)]], [[#(CPL132)]], [[#(CPL80)]], and [[#(DE)]].
<pre>
Example:
a. 100 FORMAT (CPL64)
.
PRINT (0,100)
b. PRINT (0) (CPL64)
</pre>

==(CPL80)==

'''Mnemonic''': (CPL80) Hex equivalent: "@0403@"

'''Discussion''': The (CPL80) control code sets the screen display mode to 80 characters per line by 24 lines. The screen is cleared to foreground blanks and the cursor is moved to the "home" position. (Note: In normal mode, the cursor will be moved to the upper left corner of the screen. If typewriter mode is in effect, the cursor will be moved to the lower left corner of the screen.) Also see [[#(Screen)]], [[#(CPL132)]], [[#(CPL64)]], and [[#(DE)]].
</pre>
Example:
a. 100 FORMAT (CPL80)
.
PRINT (0,100)
b. PRINT (0) (CPL80)
</pre>

== (Check Box Off) ==
<pre>
Note: This feature is not supported beyond Comet 504. Mnemonic: (Check Box Off) Hex equivalent: "@CAC6B6@" Discussion: This mnemonic draws a graphical check box on the screen. The check box is in the "off" position (i.e., no check mark appears in the box), as shown here:

The check box symbol occupies 3 spaces on the screen.

Note: The (Enhanced Characters On) mnemonic must be used before the (Check Box Off) mnemonic us used.

Also see (Check Box On).

Example: a. 100 FORMAT (Check Box Off)

.
PRINT (0,100)
b. PRINT (0) (Check Box Off)

</pre>
== (Check Box On) ==
<pre>
Note: This feature is not supported beyond Comet 504. Mnemonic: (Check Box On) Hex equivalent: "@CACEB6@" Discussion: This mnemonic draws a graphical check box on the screen. The check box is in the "on" position (i.e., a check mark appears in the box), as shown here:

The check box symbol occupies 3 spaces on the screen.

Note: The (Enhanced Characters On) mnemonic must be used before the (Check Box On) mnemonic us used.

Also see (Check Box Off).

Example: a. 100 FORMAT (Check Box On)

.
PRINT (0,100)
b. PRINT (0) (Check Box On)

Retrieved from "http://64.142.11.195/index.php/Mnemonics"
</pre>
== (CFLD) ==

'''Mnemonic''': (CFLD) Hex equivalent: "@0407@"

'''Discussion''': Clear field. 
The (CFLD) control code clears all foreground characters in a field in which the cursor is located and replaces them with foreground blanks. It then positions the cursor in the first position of the field (left-most position for alphanumeric fields and right-most position for right-justified numeric fields). The control code does not affect background or invisible (suppressed background) fields.

This control code may also include a positioning statement to start the clearing operation at a specific point on the screen.
<pre>
Example:
a. 100 FORMAT (CFLD),@(10,0)
.
PRINT (0,100)
b. PRINT (0) (CFLD),@(10,0)
</pre>
This example demonstrates the "clear field" control code. The positioning statement puts the control into action at column 10, row 0. If this location is a foreground field, it will be cleared to foreground blanks (if not, the control code will do nothing).

== (CF) ==

'''Mnemonic''': (CF) Hex equivalent: "@06@" 
'''Discussion''': Clear foreground.
The (CF) control code clears all foreground screen positions to foreground blanks and positions the cursor at the first foreground position on the screen (the upper left corner). This control does not affect background or invisible (suppressed background) screen positions.

This control code is typically used to clear input data from a formatted screen after it is entered in order to prepare for the next set of input data.
<pre>
Example:
a. 100 FORMAT (CF)
.
PRINT (0,100)
b. PRINT (0) (CF)
</pre>
This example shows how to clear all foreground screen positions.

== (CS) ==

'''Mnemonic''': (CS) Hex equivalent: "@05@" 
'''Discussion''': Clear screen.
The (CS) control code clears the entire screen to foreground blanks and moves the cursor to the home position.
<pre>
Example:
a. 100 FORMAT (CS)
.
PRINT (0,100)
b. PRINT (0) (CS)
</pre>

== (Close Icon) ==
<pre>
Note: This feature is not supported beyond Comet 504.
Mnemonic: (Close Icon)
Hex equivalent: "@CCB8@"
Discussion: This mnemonic draws a graphical "close" icon on the screen, as shown here:

The close icon occupies 2 spaces on the screen.

Note: The (Enhanced Characters On) mnemonic must be used before the (Close Icon) mnemonic us used.

Example: a. 100 FORMAT (Close Icon)
.
PRINT (0,100)

b. PRINT (0) (Close Icon)

</pre>
== Close the mouse ==
Use the following instruction to close the mouse driver:
<pre>
PRINT (0) (Mouse off)
</pre>
See also Show/hide the mouse cursor.

The mouse cursor may be shown or hidden. For mouse-driven applications, you will normally want to show the mouse cursor. For touch-sensitive screen applications, you will normally want to hide the mouse cursor.

To show the regular cursor, use the following instruction:
<pre>
PRINT (0) (Show Mouse Cursor)
</pre>

To hide the regular cursor, use the following instruction:
<pre>
PRINT (0) (Hide Mouse Cursor)
</pre>
Also see Regular cursor display.

==(Copy from Clipboard)==
'''Mnemonic''': (Copy from Clipboard) 
'''Discussion''': This mnemonic, which is used with the system driver (X00), copies the contents from the Windows clipboard into one or more program variables. This mnemonic is issued via a PRINT statement, and the clipboard data is obtained via a subsequent INPUT statement (see example below).

== (Query Clipboard) ==
<pre>

History: This mnemonic was added in REL 01.05 and requires Build 292 or higher.
Example 1: LENGTH 254 & LOCAL RESULT$ ! Define a variable
.
.
.
Open (1) "X00" ! Open system driver
Print (1) (CopyFromClipboard) ! Copy data from clipboard
Input (1) Result$ ! to this variable
Close (1) ! Close system driver

Example 2: LENGTH 254 & LOCAL A$,B$,C$ ! Define 3 variables

CLIP: FORMAT A$;B$;C$ ! FORMAT statement for clipboard data

Open (1) "X00" ! Open system driver
Print (1) (CopyFromClipboard) ! Copy data from clipboard
Input (1,CLIP) ! to the variables in this FORMAT statement
Close (1) ! Close system driver
</pre>
== (Copy to Clipboard) ==
'''Mnemonic''': (Copy to Clipboard) 
'''Discussion''': This mnemonic, which is used with the system driver (X00), copies program data to the Windows clipboard. This mnemonic is issued via a PRINT statement (see examples below).
This mnemonic returns a result string, so it is necessary to issue an INPUT statement following the PRINT statement. However, since this mnemonic should never fail, the result string will not contain any meaningful data.

Also see:
[[#(Copy from Clipboard)]]
[[#(Query Clipboard)]]

History: This mnemonic was added in REL 01.05 and requires Build 292 or higher.
<pre>
Example 1: LENGTH 254 & LOCAL RESULT$
.
Open (1) "X00"
Print (1) (Copy to Clipboard);"This is some data for the clipboard."
Input (1) Result$
Close (1)

Example 2: LENGTH 254 & LOCAL RESULT$,DATA$
.
.
.
DATA$ = "This is some data for the clipboard."
Open (1) "X00"
Print (1) (Copy to Clipboard);DATA$
Input (1) Result$
Close (1)

Example 3: LENGTH 254 & LOCAL RESULT$
.
.
.
Open (1) "X00"
Print (1) (Copy to Clipboard);"" ! Clear the clipboard
Input (1) Result$
Close (1)

</pre>

==(CopyFile)==

'''Mnemonic:''' (CopyFile=source-file,destination-file,flags)

'''Discussion:''' This mnemonic copies the source-file to the destination-file, using the specified flags.

This mnemonic may be used by foreground programs only.

'''Note:''' The (CopyFile) mnemonic is intended to replace (Verify File).

The source-file, which is specified as a full Windows path, UNC path, or directory alias, may be located on a local Comet system/network or a CometAnywhere client system (default is local system).

The destination-file, which is specified as a full Windows path, UNC path, or directory alias, may be located on a local Comet system/network or CometAnywhere client system (default is local system).

When issued on lun (0), this mnemonic copies a file:

*from a local Comet system/network to itself
*from a local Comet system/network to a CometAnywhere client system
*from a CometAnywhere client system to a local Comet system/network
*from the CometAnywhere client system to itself

The mnemonic provides many powerful features, such as an option to compare the source file's modify date with the destination file's modify date (in the case where the destination file already exists) in order to determine whether the source file needs to be copied, an option to display a progress bar during CometAnywhere transfers, and options to create a directory, overwrite an existing file, and create a CAFILE alias if required.

Flags is a numeric value representing the sum of the numeric values listed in the following chart:

'''Flag Description'''

'''1''' The source file is located on the CometAnywhere client system 
'''2''' CometAnywhere is required if remote files are specified

If a flag is set indicating that the source file is located on a CometAnywhere client system (flag='''1''') and/or that the destination file is located on a CometAnywhere client system (flag='''512'''), but the user is running on a local Comet system (i.e., not a CometAnywhere client system):

If this flag is set, an error is reported (see function error 2).
If this flag is not set, Comet substitutes the local drive/path name for a remote path/drive name.

'''64''' Synchronize source and destination files
If the source file is newer than the destination file, or the destination file does not exist, the destination file is updated (assuming that the other flags call for the copying to occur).

If this flag is omitted, the destination file is updated (assuming that the other flags call for the copying to occur).

Note: Different file systems may return file update times in different formats. For example, the NT file system (NTFS) returns file update times in Coordinated Universal Time (abbreviated as UTC; formely known as Greenwich Mean Time), while FAT returns file update times in local time. Therefore, when using this flag, make sure that the source and destination files use the same file system and return the file update times in the same format.

'''128''' Create CAFILES alias if required
If an alias is specified in the destination file name, and the alias doesn't already exist, this flag creates the alias.

'''256''' Don't copy the file; just indicate if an update is needed
See the function error codes (below), particularly values 20 and 21.

'''512''' The destination file is located on the CometAnywhere client system

'''1024''' Show a progress bar for transfers between a local Comet system/network and a CometAnywhere client system

'''2048''' Overwrite existing file
If the destination file already exists, overwrite it with the contents of the source file.

'''4096''' Create directory
If a directory is specified for the destination file, and that directory does not already exist, create it.

After this mnemonic is issued, your program should issue an INPUT on LUN (0) to retrieve success/error information. For example:
<pre>
LENGTH 2 & LOCAL AX$,DX$
ResultFmt: FORMAT AX$;DX$
.
.
Print (CopyFile=Source$,Dest$,Flags)
Input (0,ResultFmt)
</pre>
The first field, AX$, contains the function error code, and the second field, DX$, contains the suberror code (aka the Windows file error code). Both of these fields are in Intel 2's complement format, and should be processed as follows:
<pre>
AX$ = SUB(AX$,2,1) + SUB(AX$,1,1) ! Flip the bytes around
DX$ = SUB(DX$,2,1) + SUB(DX$,1,1) ! Flip the bytes around
FuncError = HexDec(AX$) ! Function error code (decimal)
FileError = HexDec(DX$) ! File error code (decimal)

! For unexpected values, convert to 2's complement signed integer
If (FuncError > 32767) FuncError = FuncError-65536
If (FileError > 32767) FileError = FileError-65536
</pre>
Here is a link to Jons error code summary table [[Comet_Error_Codes#CopyFileErrors:]]

Here is a list of the function error codes in decimal form:
Error
('''FuncError''') Description
'''0''' Function not supported
'''1''' Success -- update performed
'''2''' CometAnywhere required
'''3''' Source file error (see suberrors)
'''4''' Aborted by user
'''5''' Function in progress
'''20''' Success -- update not required
'''21''' Success -- update required
'''22''' Destination file error (see suberrors)

Here is a list of the suberror codes (common Windows file errors) in decimal form:

Suberror
('''FileError''') Description
'''0''' Success
'''2''' File not found
'''3''' Path not found
'''5''' Access denied
'''12''' Invalid access
'''15''' Invalid drive
'''16''' An error has occurred in the current directory
'''18''' No more files
'''32''' Sharing violation
'''33''' Lock violation
'''39''' File located on Remote Computer
'''80''' File exists
'''123''' The Filename, Directory Name, or Volume Label Syntax Is Incorrect
'''161''' Bad pathname
'''1326''' User not logged in to Remote Computer

History: This mnemonic was added in Comet Build 299 and REL Version 01.07.
<pre>
Example 1:
Source$ = "C:\SAMPLEFILES\TEST.TXT"
Dest$ = "A:\TEST.TXT"
Flags = 2048
Print (CopyFile=Source$,Dest$,Flags)
</pre>

This example copies the source file named C:\SAMPLEFILES\TEST.TXT to the destination file named A:\TEST.TXT. By default, both files are located on the local Comet system/network. The flag value of 2048 tells Comet to overwrite the destination file if it exists.
If the copying is successful, the function error code will be equal to 1 (Success -- update performed), and the suberror code will be equal to 0 (Success).

<pre>
Example 2:
Source$ = "C:\FILE1.TXT"
Dest$ = "C:\FILE2.TXT"
Flags = 512 + 2048
Print (CopyFile=Source$,Dest$,Flags)
</pre>

This example copies a source file named C:\FILE1.TXT to a destination file named C:\FILE2.TXT
The sum of the two flags tells Comet that the destination file is on the CometAnywhere client system (512), and to overwrite the destination file if the destination file already exists (2048). By default, the source file is on the local Comet system.

Suppose the flag value was changed to the following:

Flags = 1 + 2048

This would tell Comet that the source file is on the CometAnywhere client system (1), while the destination file (by default) is on the local Comet system. The destination file would be overwritten (2048).
Suppose the flag value was changed to the following:

Flags = 1 + 512 + 2048

In this case, the source and destination files are located on the CometAnywhere client system (1 and 512), and the destination file will be overwritten (2048).

Example 3: Suppose you want to copy a file from a local Comet system to a CometAnywhere client system, and you want to synchronize the files (i.e., copy only if the source file is newer than the destination file).
Here are the flags that are used in the following example:

2 = CometAnywhere is required (otherwise an error occurs)
64 = Synchronize the files
512 = Destination file is on CometAnywhere client system
1024 = Show progress bar
2048 = Overwrite existing file
4096 = Create directory

<pre>
Source$ = "C:\FILE1"
Dest$ = "C:\DATA\FILE2"
Flags = 2 + 64 + 512 + 1024 + 2048 + 4096
Print (CopyFile=Source$,Dest$,Flags)
</pre>

Example 4: Suppose you need to copy a large file between a local Comet system and a CometAnywhere client system, but before copying you want to check and see if (a) the update is needed, and (b) if the user wants to perform the update now.
This is done in two steps. First, use the flag that checks to see if the update is required without copying the file (flag=256). If the update is required (as indicated by FuncError=21), then proceed with the copying (change the flags to copy the file).

<pre>
Source$ = "C:\BIGFILE" ! on local Comet system
Dest$ = "C:\BIGFILE" ! on CometAnywhere client system

Flags = 256 + 512 ! 256 = don't copy file; just check to
! see if updated is needed
! 512 = destination is on
! CometAnywhere system

Print (CopyFile=Source$,Dest$,Flags)
Input (0,ResultFmt)

AX$ = SUB(AX$,2,1) + SUB(AX$,1,1) ! Flip the bytes around
DX$ = SUB(DX$,2,1) + SUB(DX$,1,1) ! Flip the bytes around
FuncError = HexDec(AX$) ! Function error code (decimal)
FileError = HexDec(DX$) ! File error code (decimal)

! For unexpected values, convert to 2's complement signed integer
If (FuncError > 32767) FuncError = FuncError-65536
If (FileError > 32767) FileError = FileError-65536

If FuncError = 21
Print "The file needs to be updated."
Print "Do you want to update it now?"
Input A$

If A$ = "Y"
Flags = 512 + 2048
Print (CopyFile=Source$,Dest$,Flags)
Input (0,ResultFmt)
.
.
.
EndIf
EndIf
</pre>

Notes: Depending on your situation you might try using the CUtlCpy utility which is released as part of the UTL directory. You can ENTER it from your app to easily accomplish a file copy or move.
To use a directory alias as the pathname for either of the filenames you can do it like this: FileName$ = "$(AliasNameHere)\" + thefilename$

==(CPL132)==

'''Mnemonic''': (CPL132) Hex equivalent: "@040009@"

'''Discussion''': This mnemonic sets the video display mode to 132 characters per line.
Also see [[#(Screen)]], [[#(CPL64)]], [[#(CPL80)]], and [[#(DE)]].
<pre>
Example:
a. 100 FORMAT (CPL132)
.
PRINT (0,100)
b. PRINT (0) (CPL132)
</pre>

==(CPL64)==

'''Mnemonic''': (CPL64) Hex equivalent: "@0402@"

'''Discussion''': The (CPL64) control code sets the screen display mode to 64 characters per line by 27 lines. The screen is cleared to foreground blanks and the cursor is moved to the "home" position. (Note: In normal mode, the cursor will be moved to the upper left corner of the screen. If typewriter mode is in effect, the cursor will be moved to the lower left corner of the screen.)
This control code may be overridden by the system configuration (if the configuration forces the screen display to 80 columns, for example).

Also see [[#(Screen)]], [[#(CPL132)]], [[#(CPL80)]], and [[#(DE)]].
<pre>
Example:
a. 100 FORMAT (CPL64)
.
PRINT (0,100)

b. PRINT (0) (CPL64)
</pre>

==(CPL80)==
'''Mnemonic''': (CPL80) Hex equivalent: "@0403@"

'''Discussion''': The (CPL80) control code sets the screen display mode to 80 characters per line by 24 lines. The screen is cleared to foreground blanks and the cursor is moved to the "home" position. (Note: In normal mode, the cursor will be moved to the upper left corner of the screen. If typewriter mode is in effect, the cursor will be moved to the lower left corner of the screen.)
Also see [[#(Screen)]], [[#(CPL132)]], [[#(CPL64)]], and [[#(DE)]].
<pre>
Example:
a. 100 FORMAT (CPL80)
.
PRINT (0,100)

b. PRINT (0) (CPL80)
</pre>

==(CR)==
'''Mnemonic''': (CR)

'''Discussion''': Cursor return/carriage return.
This control code can be used on a video device or a printer.

'''Video device'''
In normal mode, the (CR) control code moves the cursor to the first foreground position on the following line. If the cursor is on the bottom line when this control code is issued, the cursor will be moved to the top line of the screen. In either case, the cursor will land only in a foreground field.

In typewriter mode, this control code scrolls the screen up one line (forcing the top line off the screen) and will move the cursor to the beginning (left side) of the bottom line on the screen.

'''Printer'''
The (CR) control code performs a carriage return function for the printer. If this control is issued in the middle of a print line, it advances the printer to the beginning of the next line (unlike a line feed control, which would skip the next line and move to the beginning of the following line).
<pre>
Example (video):
a. 100 FORMAT (CR)
.
PRINT (0,100)

b. PRINT (0) (CR)

Example (printer):
a. 100 FORMAT "CUSTOMER LISTING";(CR);"PRINTED ON:";DAY$
.
OPEN (1) "LP1"
.
PRINT (1,100)

b. OPEN (1) "LP1"
.
PRINT (1) "CUSTOMER LISTING";(CR);"PRINTED ON:";DAY$
</pre>
This last example prints a heading, performs a carriage return, and then prints a subheading on the next line.

==(Create Window)==
'''Mnemonic''': (Create Window=a,b,c,d)
where:
a = upper left column (decimal)
b = upper left row (decimal)
c = lower right column (decimal)
d = lower right row (decimal)

Hex equivalent: "@0E0D00wwxxyyzz@"
where:
ww = upper left row (hex)
xx = upper left column (hex)
yy = lower right row (hex)
zz = lower right column (hex)

'''Discussion''': This mnemonic creates a Comet window using the specified screen coordinates. Note: These coordinates are relative to the full screen (e.g., column 0, row 0 always represents the upper left corner of the display).
When a window is created, the amount of available window memory decreases by the size of the window. To determine how much window memory remains, perform a numeric input immediately following the creation of a window. See the window memory page for more information. If you do not need to know how much window memory remains, perform a null INPUT immediately after printing the (Create Window) mnemonic.

Also see the discussion on Comet windows.
<pre>
Example:
a. 100 FORMAT (Create Window=2,3,70,20)
.
PRINT (0,100)
INPUT (0) ""

b. PRINT (0) (Create Window=2,3,70,20)
INPUT (0) ""
</pre>
This example show how to create a Comet window from column 2, row 3 (the upper left corner) to column 70, row 20 (the lower right corner). The INPUT (0) "" statement allows the program to bypass the value that is returned from the (Create Window) mnemonic (the amount of remaining window memory).

==(CreateWindowEx)==

'''Mnemonic''': (CreateWindowEx=column,row,width,height,style,flags,caption$)

'''Discussion''': This mnemonic creates and selects an extended window, using the following parameters: 
'''Parameter Description''' 
'''column''' The column location of the upper, left-hand corner of the window. This numeric value is expressed in QCRT characters or screen pixels, depending on the value of the flags (see below). 
'''row''' The row location of the upper, left-hand corner of the window. This numeric value is expressed in QCRT characters or screen pixels, depending on the value of the flags (see below). 
'''width''' The width of the window. This numeric value is expressed in QCRT characters. 
'''height''' The height of the window. This numeric value is expressed in QCRT characters. 
'''style''' The style of Window. This numeric value is the sum of the following options: 
'''Value Meaning''' 
'''1''' A popup window. The window can be moved outside of Comet window. This value should not be used with 2 (which specifies a child window). 
'''2''' A child window. The window remains within the view window. This value should not be used with 1 (which specifies a popup window). 
'''4''' The window includes a caption bar. 
'''8''' The window includes a border. 
'''16''' The caption bar includes an "X" which closes the window. 
Note: Clicking on the "X" causes an (EasyScan) event to be reported to the Internet Basic program. The EasyScan value is 15. 
'''32''' The window includes a thick frame that lets the user resize the window. 
'''64''' The window is visible. 

'''flags''' The flags for the window. This numeric value is the sum of the following options:
Value Meaning
'''0''' A modeless window (also known as a user-selectable window).
Note: If multiple Comet windows are displayed, the user can select which window is the active one by clicking the caption bar. The Internet Basic program can determine the handle of the the window from which data was transmitted via the STS function.
'''1''' A modal window. All other Comet windows are disabled until this window closes.
'''2''' A child window with no frame (border). This flag can be used to simulate a legacy Comet window (see CreateWindow).
'''4''' The window includes a message line (also known as a control line). Any text written with the (WC) mnemonic will be displayed on the message line within this window.

The following flags pertain to non-child windows only:

'''Value Meaning'''
'''8''' The column and row positions are expressed in screen pixels, and are relative to the screen (i.e., 0,0 = the upper, left-hand pixel of the screen).
'''16''' The column and row positions are expressed in screen pixels, and are relative to the client window (i.e., 0,0 = the upper, left-hand pixel of the client window).
'''32''' The column and row positions are expressed in screen pixels, and are relative to the frame window (i.e., 0,0 = the upper, left-hand pixel of the frame window).

'''caption$''' If the caption bar style is in effect, this string value is displayed on the caption bar.

Each extended window is identified by a 4-byte string known as a window handle. The handle value is assigned by the system and returned to the Internet Basic program via an INPUT statement following the (CreateWindowEx) mnemonic, as follows:
<pre>
Length 4 & Local Handle1$
.
Print (CreateWindowEx=0,0,35,15,68,1,"This is the caption")
Input Handle1$
</pre>
It follows that the Internet Basic program can create multiple extended windows. The program can select which window to use via the (SelectWindowEx) mnemonic.
An extended window is deleted via the (DeleteWindowEx) mnemonic.

Note: If you write a program that displays more than one extended window at a time, your program may need some way to distinguish which window was active at the time that data was input. The STS function returns the handle of the window that generated the input. This 4-byte value starts in position 11, as shown here:
<pre>
Length 4 & Local Handle$
.
Handle$ = SUB(STS(0),11,4)
</pre>
Symbolic constants: Symbolic constants can be very useful when dealing with the multiple style and flag values. For example, here is a list of recommended symbolic constants for extended windows:
<pre>
'''! Window style'''
SET COS.WS.POPUP = 1 ! Can be moved outside of Comet window. Should
! not be used with COS.WS.CHILD.
SET COS.WS.CHILD = 2 ! Remains within view window. Should not be used
! with COS.WS.POPUP.
SET COS.WS.CAPTION = 4 ! Includes a caption bar
SET COS.WS.BORDER = 8 ! Window includes a border
SET COS.WS.SYSMENU = 16 ! Caption bar 'X' closes window
SET COS.WS.THICKFRAME = 32 ! Thick frame for sizing
SET COS.WS.VISIBLE = 64 ! Window is visible
SET COS.WS.POPUPWINDOW = 25 ! (COS.WS.POPUP+COS.WS.BORDER+COS.WS.SYSMENU)

'''! Window flags'''
SET COS.WF.MODELESS = 0 ! - User selectable window - Use EasyScan
! to determine when a window is activated.
SET COS.WF.MODAL = 1 ! - All other windows are disabled until
! this window closes
SET COS.WF.NOFRAME = 2 ! Create CHILD window with no frame (border).
! Used to simulate a Comet window
SET COS.WF.MSGLINE = 4 ! Has a message line

! The following flags pertain to non-child windows only
SET COS.WF.SCNPIXELPOS = 8 ! Position is in pixels, screen relative
SET COS.WF.CLIPIXELPOS = 16 ! Position is in pixels, client window relative
SET COS.WF.FRMPIXELPOS = 32 ! Position is in pixels, frame window relative
</pre>
With these symbolic constants in place, you can specify the style and flag values by writing a symbolic "formula," as follows:
<pre>
Length 3.0 & Local Style, Flags
Length 5 & Local Handle1$
.
.
Style = COS.WS.POPUPWINDOW + COS.WS.CAPTION
Flags = COS.WF.MODAL + COS.WF.MSGLINE + COS.WF.CLIPIXELPOS
Print (CreateWindowEx=0,0,35,15,Style,Flags,"This is the caption")
Input Handle1$
</pre>

History: This feature is supported in Comet2002 Build 306 and higher.
Examples: See the WinDemo.ibs program (available at www.signature.net/download/demos) for examples of extended windows. This demo program includes many combinations of the style and flags parameters, and also demonstrates some very useful applications for extended windows.

== (CrMode) ==
<pre>
Mnemonic: (CrMode=mode)
Discussion: This mnemonic controls the action of the Enter key. The following values may be used:
0 = default (from SYSGEN)
1 = Enter key works like Tab
2 = Enter key behaves like a CR (goes to beginning of next
line unless a TM or TP is encountered)

History: This mnemonic was added in REL 00.06.
Example: a. 100 FORMAT (CrMode=1)
.
PRINT (0,100)

b. PRINT (0) (CrMode=1)

This example shows how to make the Enter key work like the Tab key.

</pre>
== (CS) ==
<pre>

Mnemonic: (CS)
Hex equivalent: "@05@"
Discussion: Clear screen.
The (CS) control code clears the entire screen to foreground blanks and moves the cursor to the home position.

Example: a. 100 FORMAT (CS)
.
PRINT (0,100)

b. PRINT (0) (CS)

</pre>
== (CH) ==
<pre>
Mnemonic: (CH)
Hex equivalent:
Discussion: Cursor home.
The (CH) control code moves the cursor to the "home" position on the screen. Home position is the upper left foreground location of the screen. Since the cursor will land only in a foreground area, "home" may be something other than the upper left corner.

For example, if the upper left corner of the screen contains background or invisible (suppressed background) characters, the cursor will search to the right and to the next line(s) if necessary for the first available foreground position.

Once a foreground field is located, the cursor will be positioned at the first location in that field (left-most position for alphanumeric fields and right-most position for right-justified numeric fields).

Example: a. 100 FORMAT (CH)
.
PRINT (0,100)

b. PRINT (0) (CH)

This example shows how to move the cursor to the home position.

</pre>
==(CR)==
'''Mnemonic''': (CR)

'''Discussion''': Cursor return/carriage return.
This control code can be used on a video device or a printer.

'''Video device'''
In normal mode, the (CR) control code moves the cursor to the first foreground position on the following line. If the cursor is on the bottom line when this control code is issued, the cursor will be moved to the top line of the screen. In either case, the cursor will land only in a foreground field.

In typewriter mode, this control code scrolls the screen up one line (forcing the top line off the screen) and will move the cursor to the beginning (left side) of the bottom line on the screen.

'''Printer'''
The (CR) control code performs a carriage return function for the printer. If this control is issued in the middle of a print line, it advances the printer to the beginning of the next line (unlike a line feed control, which would skip the next line and move to the beginning of the following line).
<pre>
Example (video):
a. 100 FORMAT (CR)
.
PRINT (0,100)

b. PRINT (0) (CR)

Example (printer):
a. 100 FORMAT "CUSTOMER LISTING";(CR);"PRINTED ON:";DAY$
.
OPEN (1) "LP1"
.
PRINT (1,100)

b. OPEN (1) "LP1"
.
PRINT (1) "CUSTOMER LISTING";(CR);"PRINTED ON:";DAY$
</pre>
This last example prints a heading, performs a carriage return, and then prints a subheading on the next line.