FieldSoftware
Home

PrinterCE SDK
   General Info
   Download
   Purchase & Pricing

Developer Info
   eVC MFC
   eVC C/C++
   eVB

Special Features
   AsciiCE
   PrintDC
   BarcodeCE

Documentation
   PrinterCE SDK
   AsciiCE
   PrintDC
   BarcodeCE

Special Topics
  Supported Printers
  Bluetooth Printing
  Network Printing

.Net CF C# or VB.Net:
  PrinterCE.NetCF SDK

-----------------------------

Software Developers
  PrinterCE SDK
  PrinterCE.NetCF SDK
  PocketHTMLprint SDK

Printing Utilities
  PrintPocketCE
  PIEprint
  PocketPixPrint
  PocketShot
  PocketClipPrint

 Arcade Games
  SockOut
  MazeCraze

Contact Info

AsciiCE2 Developer's Guide
Library Name : AsciiCE2
DLL Name : PrEngineCE.dll
Control Name: PrEngineCE.AsciiCE2  

Download Word Doc copy of this Developer's Guide

AsciiCE2 Information and Code Samples

Important Note for MFC Developers:: There is a known bug in MFC when inserting components using the Components and Controls Gallery that causes incorrect "wrapper classes" to be generated for methods that pass BYTE or BYTE* parameters (see MSDN Q241862). Two AsciiCE2 methods ("Read" and "Write") pass blocks of data through BYTE arrays. If your application uses these methods, click on the following links to download corrected "asciice2.h" and "asciice2.cpp" files and copy these into your MFC app's directory, overwriting the files that MFC created for you.   [Download asciice.h]       [Download asciice.cpp]

AsciiCE2 Methods & Properties

String describing this version of PrinterCE - including information on WinCE platform (Pocket PC, HPC/Pro and 2000), processor type and version. This string can be used in a MsgBox() to display the information.  

Capabilities
[AsciiCE2 & AsciiCE]

READ-ONLY property returns bit-values that identify all the capabilities in the current control.  

MFC Syntax:   long bitvals =AsciiCE2a.GetCapabilities();

C++ Syntax:    AsciiCE2a.get_Capabilities(long * bitvals);

eVB Syntax: bitvals = AsciiCE2a.Capabilities

Returns

Bit values that identify the capabilities of the current control:

Char
[AsciiCE2 & AsciiCE]

Return Value

retval - Current status of operation (see table above). If not user cancel or AbortError, then returns current status of printer dialog box (vbDlgUp, etc).

Remarks

By default, the "Printing in progress" dialog box is displayed with the first call by an application to most PrinterCE or AsciiCE2 operation (such as SelectPort). This dialog box will remain until ClosePort completes the printing job. Calling PrDialogBox(vbDlgDisable) will prevent AsciiCE2 from displaying the dialog box (and will not give the user any chance to cancel).

See PrDialogBoxText() for info on changing the text displayed or language used by this dialog.

PrDialogBoxText
[AsciiCE2]

This method allows changing the text displayed or language used by the "Printing in progress" dialog box.

MFC Syntax:     AsciiCE2a.PrDialogBoxText(BSTR MainStr,BSTR TitleStr,BSTR CancelBtnStr);

C++ Syntax:     AsciiCE2a. PrDialogBoxText(BSTR MainStr,BSTR TitleStr,BSTR CancelBtnStr);

eVB Syntax:  AsciiCE2a. PrDialogBoxText MainStr,TitleStr,CancelBtnStr

Parameters

MainStr - String for main text portion of the "Printing in progress" dialog box.
TitleStr - String for title portion of the "Printing in progress" dialog box.
CancelBtnStr - String for Cancel Button portion of the "Printing in progress" dialog box 

Remarks

The text of this dialog box may be changed at any time… if the dialog box is already displayed, it will be taken down, the new text added, and then the dialog box will be redisplayed. If the dialog box is not currently displayed, it will remain down until a call to PrDialogBox() or until the AsciiCE2 automatically displays it.  

ReadChar
[AsciiCE2]

Reads a single character from the printer port. If no data is available, then returns -1.

MFC Syntax: short bval=AsciiCE2a.ReadChar();
C++ Syntax: AsciiCE2a.ReadChar(short* bval);
eVB Syntax: bval=AsciiCE2a.ReadChar

Parameters

bval - Data byte read. If no data available, returns -1.

Read
[AsciiCE2]

Reads a block of data from the printer port. This can be useful for special-purpose printers, such as combination printer & magnetic card reader or smart card reader devices (see printer selections). Note that AsciiCE2 supports infrared devices via IrLPT connections and will only read data if the printer can send it using the IrLPT protocol.

Note: Generally, the application will use AsciiCE2's Write, WriteVar or Text methods to send commands to the printer that enables the data-gathering portion of that device to collect and send the data to be read.

MFC Syntax: AsciiCE2a.Read(long MaxBytes, long LastChar, long ModeFlags, long TimeToWait,
                             long* ResultFlags,long* BytesRead,BYTE* buffer);
C++ Syntax: AsciiCE2a.Read(long MaxBytes, long LastChar, long ModeFlags, long TimeToWait,
                             long* ResultFlags,long* BytesRead,BYTE* buffer);
eVB Syntax: None (see ReadVar method). 

Parameters

MaxBytes - Maximum number of bytes to read.
LastChar - Optional - read data stream until this byte value is found, then return all data read.
ModeFlags - Defines following modes:
    READMODE_NORMAL = 0 - Reads all data into buffer
    READMODE_FLUSHZEROS = 1 - Ignores zero value bytes - all other data is read into buffer
TimeToWait - Maximum number of microseconds to wait for data from the printer. If 0, don't time out.

ResultFlags - Returns results of block read:
     READRESULT_ERR = 0 - Error trying to read (such as loss of infrared connection)
     READRESULT_OK = 1 - Read was successful
     READRESULT_FULLBUFFER = 2 - Returning because "MaxBytes" bytes were read
     READRESULT_TIMEOUT = 3 - Returning because "TimeToWait" microseconds expired
     READRESULT_USERCANCEL = 4 - User cancelled
BytesRead - Returns actual number of bytes read into buffer
buffer - data buffer containing the bytes read
 

ReadVar
[AsciiCE2]

Identical to Read() - except that the data read is returned in a VARIANT array. This is the preferred method for eVB to read.

MFC Syntax: VARIANT* buffer=AsciiCE2a.ReadVar(long MaxBytes, long LastChar, long ModeFlags, 
                             long TimeToWait,long* ResultFlags,long* BytesRead);
C++ Syntax: AsciiCE2a.ReadVar(long MaxBytes, long LastChar, long ModeFlags, long TimeToWait,
                             long* ResultFlags,long* BytesRead,VARIANT* buffer);
eVB Syntax: buffer = AsciiCE2a.ReadVar MaxBytes, LastChar, ModeFlags, TimeToWait,
                             ResultFlags,BytesRead

Parameters

MaxBytes - Maximum number of bytes to read.
LastChar - Optional - read data stream until this byte value is found, then return all data read.
ModeFlags - Defines following modes:
    READMODE_NORMAL = 0 - Reads all data into buffer
    READMODE_FLUSHZEROS = 1 - Ignores zero value bytes - all other data is read into buffer
TimeToWait - Maximum number of microseconds to wait for data from the printer. If 0, don't time out.

ResultFlags - Returns results of block read:
     READRESULT_ERR = 0 - Error trying to read (such as loss of infrared connection)
     READRESULT_OK = 1 - Read was successful
     READRESULT_FULLBUFFER = 2 - Returning because "MaxBytes" bytes were read
     READRESULT_TIMEOUT = 3 - Returning because "TimeToWait" microseconds expired
     READRESULT_USERCANCEL = 4 - User cancelled
BytesRead - Returns actual number of bytes read into buffer
buffer - data buffer containing the bytes read - stored as VARIANT array
 

ReadString
[AsciiCE2]

Similar to Read() - but reads a string of text from the printer port. 

MFC Syntax: BSTR string=AsciiCE2a.ReadString(long MaxChars, long LastChar, long ModeFlags, 
                             long TimeToWait,long* ResultFlags,long* CharsRead);
C++ Syntax: AsciiCE2a.ReadString(long MaxChars, long LastChar, long ModeFlags, long TimeToWait,
                             long* ResultFlags,long* CharsRead ,BSTR string);
eVB Syntax: None (see ReadVar method). 

Parameters

MaxChars - Maximum number of characters to read.
LastChar - Optional - read data stream until this byte value is found, then return all data read.
ModeFlags - Defines following modes:
    READMODE_NORMAL = 0 - Reads all data into buffer
    READMODE_FLUSHZEROS = 1 - Ignores zero value bytes - all other data is read into buffer
TimeToWait - Maximum number of microseconds to wait for data from the printer. If 0, don't time out.

ResultFlags - Returns results of block read:
     READRESULT_ERR = 0 - Error trying to read (such as loss of infrared connection)
     READRESULT_OK = 1 - Read was successful
     READRESULT_FULLBUFFER = 2 - Returning because "MaxBytes" bytes were read
     READRESULT_TIMEOUT = 3 - Returning because "TimeToWait" microseconds expired
     READRESULT_USERCANCEL = 4 - User cancelled
CharsRead - Returns actual number of characters read into buffer
string - text containing the bytes read
 

ReadStringVar
[AsciiCE2]

Identical to ReadString() - except that the "ResultFlags" and "CharsRead" values are returned as VARIANTS. This is the preferred method for eVB to read text strings.

MFC Syntax: BSTR* string=AsciiCE2a.ReadStringVar(long MaxChars, long LastChar, 
                             long ModeFlags, long TimeToWait,VARIANT* ResultFlags,VARIANT* CharsRead);
C++ Syntax: AsciiCE2a.ReadStringVar(long MaxChars, long LastChar, long ModeFlags, 
                             long TimeToWait,VARIANT* ResultFlags,VARIANT* CharsRead, BSTR* string);
eVB Syntax: buffer = AsciiCE2a.ReadStringVar(MaxChars, LastChar, ModeFlags, TimeToWait,
                             ResultFlags, CharsRead

Parameters

MaxChars - Maximum number of characters to read.
LastChar - Optional - read data stream until this byte value is found, then return all data read.
ModeFlags - Defines following modes:
    READMODE_NORMAL = 0 - Reads all data into buffer
    READMODE_FLUSHZEROS = 1 - Ignores zero value bytes - all other data is read into buffer
TimeToWait - Maximum number of microseconds to wait for data from the printer. If 0, don't time out.

ResultFlags - Returns results of block read:
     READRESULT_ERR = 0 - Error trying to read (such as loss of infrared connection)
     READRESULT_OK = 1 - Read was successful
     READRESULT_FULLBUFFER = 2 - Returning because "MaxBytes" bytes were read
     READRESULT_TIMEOUT = 3 - Returning because "TimeToWait" microseconds expired
     READRESULT_USERCANCEL = 4 - User cancelled
CharsRead - Returns actual number of characters read into buffer
string - text containing the bytes read
 

RepeatChar
[AsciiCE2 & AsciiCE]

This method sends one or more copies of a character byte value to the printer.

MFC Syntax:    AsciiCE2a.RepeatChar(long ch,long repeatcnt);

C++ Syntax:    AsciiCE2a.RepeatChar(long ch,long repeatcnt);

eVB Syntax: AsciiCE2a.RepeatChar ch, repeatcnt

Parameters

ch - character to be sent to printer
repeatcnt - count of number of copies of "ch" to send to printer.

BaudRate : 

Handshake (plus OR any needed Handshake Bitflags below): 

Handshake -> Parity: (OR with Handshake): 

Handshake -> Stopbits: (OR with Handshake): 

Handshake -> Bytesize: (OR with Handshake): 

SelectPortEx
[AsciiCE2]

This method extends the SelectPort() method in two ways: it allows the creation of a "read" operation to permit reading data from the printer port. It also offers one additional "port type" - PORT_PRINTERCE - to allow shared use of the printer port by PrinterCE and AsciiCE2 -> with cautions and alerts sounded!! See AsciiCE discussion here.

MFC Syntax:
   long retval = AsciiCE2a.SelectPortEx(long Port,long BaudRate,long HandShake,long ReadBufferSize);  
C++ Syntax:
   AsciiCE2a.SelectPortEx(long Port,long BaudRate,long HandShake,long ReadBufferSize,long* retval);
eVB Syntax:
   retval = AsciiCE2a.SelectPortEx(Port, BaudRate, Handshake, ReadBufferSize)

Parameters

Port - Port type: 

BaudRate : 

Handshake: 

ReadBufferSize:  An integer value for number of bytes to be set aside for "read" buffer that AsciiCE2 will use to read and store data read in from the printer port. If ReadBufferSize is zero, then no read-buffer is established and no reading will occur. Otherwise, AsciiCE2 creates a separate read thread and buffer to store data read in from the printer port. See AsciiCE2's Read and Peek methods for more info.

Remarks

There are two approaches that a VB program can take while using AsciiCE2… first is to set up "On Error" statements in each sub or function that calls a PrinterCE method or property and use the "On Error" handler to determine the course of action when an error occurs within PrinterCE. The second approach is to use occasional calls to StatusCheck to determine if an error has occurred.

When an error occurs within AsciiCE2, the severity of the error is determined and PrinterCE "remembers" this as appropriate. So, for example, if a printer error occurs, the entire printing job must be aborted, so all calls to PrinterCE will remember that it is aborting and this will be handled gracefully.

This structure allows the VB program that uses AsciiCE2 to have a relaxed approach to error handling, even to the point of ignoring errors completely (although it would be kind to the user to do StatusCheck calls and display error dialog boxes as needed).

C++ and MFC-based applications can use the StatusCheck() method to determine if some error or user action has caused AsciiCE2 to stop printing. Since AsciiCE2 stops trying to print once an error or user cancel has been found, StatusCheck() only needs to be called when the application may be entering some extended period of activity.

SetReportLevel
[AsciiCE2]

This Write-Only property sets error level of errors returned by AsciiCE2..

MFC Syntax:    AsciiCE2a.SetSetReportLevel(long value);

C++ Syntax:    AsciiCE2a.put_SetReportLevel(long value);

eVB Syntax: AsciiCE2a.SetReportLevel =value

Parameters

value - Integer that specifies four available error levels

Remarks

There are two approaches that a VB program can take while using AsciiCE2… first is to set up "On Error" statements in each sub or function that calls a PrinterCE method or property and use the "On Error" handler to determine the course of action when an error occurs within PrinterCE. The second approach is to use occasional calls to StatusCheck to determine if an error has occurred.

When an error occurs within AsciiCE2, the severity of the error is determined and PrinterCE "remembers" this as appropriate. So, for example, if a printer error occurs, the entire printing job must be aborted, so all calls to PrinterCE will remember that it is aborting and this will be handled gracefully.

This structure allows the VB program that uses AsciiCE2 to have a relaxed approach to error handling, even to the point of ignoring errors completely (although it would be kind to the user to do StatusCheck calls and display error dialog boxes as needed).

C++ and MFC-based applications can use the StatusCheck() method to determine if some error or user action has caused AsciiCE to stop printing. Since AsciiCE stops trying to print once an error or user cancel has been found, StatusCheck() only needs to be called when the application may be entering some extended period of activity.

StatusCheck
[AsciiCE2]

This READ-ONLY property returns the current status of AsciiCE2.

MFC Syntax:   long value=AsciiCE2a.GetStatusCheck();

C++ Syntax:    AsciiCE2a.get_StatusCheck(long * value);

eVB Syntax: value = AsciiCE2a.StatusCheck

Returns

value - Integer that specifies four possible status values

Text
[AsciiCE2 & AsciiCE]

This is the main text printing method.

MFC Syntax:    AsciiCE2a.Text(BSTR textstring);

C++ Syntax:    AsciiCE2a.Text(BSTR textstring);

eVB Syntax: AsciiCE2a.Text textstring

Parameters

textstring - Text string to be printed.  

Write
[AsciiCE2]

Sends block of data to printer..

MFC Syntax: AsciiCE2a.Write(BYTE* buffer,long NumberBytesToWrite,long* BytesWritten);

C++ Syntax: AsciiCE2a.Write(BYTE* buffer,long NumberBytesToWrite,long* BytesWritten);

eVB Syntax: None (see WriteVar method).

Parameters

buffer - Block of bytes to be sent to printer
NumberBytesToWrite - count of bytes to send from "buffer"  
BytesWritten - Returns count of bytes successfully sent to printer  

NOTE: If using both PrinterCE and AsciiCE2 (SelectPortEx -> PORT_PRINTERCE mode) simultaneously, any calls to AsciiCE2's Write, WriteVar, or Text result in flushing all PrinterCE printing operations before processing the AsciiCE2 command. If the call to Write or WriteVar is strictly a printer control command, you can pass NumberBytesToWrite as a negative value (for example, NumberBytesToWrite = -22 if sending a 22 byte printer control block). A negative value for NumberBytesToWrite is passed immediately without causing PrinterCE operations to be printed first. See "Intermixing PrinterCE and AsciiCE2" for more info.

WriteVar
[AsciiCE2]

Sends block of data to printer. The data is passed in the form of a VARIANT array - this is eVB's native method of passing arrays of data and so WriteVar() should be used by eVB applications. 
For MFC and C++, the "Write" method is preferred.

MFC Syntax:
   AsciiCE2a.WriteVar(VARIANT* buffer,long NumberBytesToWrite,long* BytesWritten);
C++ Syntax:
   AsciiCE2a.WriteVar(VARIANT* buffer,long NumberBytesToWrite,long* BytesWritten);  
eVB Syntax:
   AsciiCE2a.WriteVar varbuffer, NumberBytesToWrite, BytesWritten

Parameters