Maxicode Encoder Version 2.1.3 Programmer’s Manual Silver Bay Software LLC 100 Adams Street Dunstable, MA 01827 Phone: (800) 364-2889 Fax: (888) 315-9608 [email protected] Document Version 20091005 The information in this manual is subject to change without notice and should not be construed as a commitment by Silver Bay Software LLC. Silver Bay Software assumes no responsibility for any errors that might appear in this document. The software described in this document is furnished under a license and may be used or copied only in accordance with the terms of such license. Products or brand names used herein are trademarks or registered trademarks of their respective companies Copyright © 2009, Silver Bay Software LLC. All rights reserved. Silver Bay Software LLC Maxicode Encoder Programmer’s Manual Updating from a Previous Version of the Encoder If you are updating from a Version 2.0.x encoder to the Version 2.1.x encoder, you need to make the corresponding changes in your input structures. The specific changes are: The MODE-CONTROL element has been added to the COBOL input structure. The modeControl element has been added to the C input structure. The modeControl element has been added to the Visual Basic structure. - i - Silver Bay Software LLC Maxicode Encoder Programmer’s Manual Table of Contents 1 INTRODUCTION..............................................................................................................................................1 1.1 CONTENTS OF THIS MANUAL.......................................................................................................................1 1.2 MAXICODE SYMBOLOGY OVERVIEW ..........................................................................................................1 1.3 ENCODER OPERATION .................................................................................................................................2 1.3.1 Data Inputs ............................................................................................................................................3 1.3.2 Encoder Output......................................................................................................................................3 1.4 STEPS TO USING THE ENCODER ...................................................................................................................5 1.5 API’S PROVIDED .........................................................................................................................................6 1.6 CHARACTER SET ISSUES..............................................................................................................................6 2 MAXICODE SYMBOLOGY TECHNICAL DETAILS ................................................................................7 2.1 PHYSICAL STRUCTURE ................................................................................................................................7 2.2 HISTORICAL OVERVIEW ..............................................................................................................................8 2.3 INTERNAL ENCODING DETAILS ...................................................................................................................8 2.4 MAXICODE ENCODING MODES..................................................................................................................10 2.5 MAXICODE IN UNITED PARCEL SERVICE (UPS) APPLICATIONS ................................................................11 2.5.1 Structured Carrier Message Format ...................................................................................................11 2.5.2 Primary and Secondary Message Formats..........................................................................................13 2.5.3 Compressed Maxicode Format............................................................................................................14 3 USING THE ENCODER FOR UPS APPLICATIONS................................................................................16 3.1 COBOL LANGUAGE API ..........................................................................................................................16 3.1.1 Initializing the Encoder: MAXINIT .....................................................................................................16 3.1.2 Calling the Encoder: MAXUPSN.........................................................................................................17 3.2 C LANGUAGE API .....................................................................................................................................22 3.2.1 Initializing the Encoder: MaxInitC......................................................................................................22 3.2.2 Calling the Encoder: MaxUpsNC........................................................................................................23 3.3 VISUAL BASIC API....................................................................................................................................27 4 GENERIC MAXICODE API’S ......................................................................................................................32 4.1 COBOL LANGUAGE API ..........................................................................................................................32 4.1.1 Initialization.........................................................................................................................................32 4.1.2 Result Codes ........................................................................................................................................33 4.1.3 Record Formats ...................................................................................................................................34 4.1.4 Encoding Structured Carrier Message Symbols..................................................................................37 4.1.5 Encoding Generic Message (Non-Structured Carrier Message) Data................................................45 4.2 C LANGUAGE API .....................................................................................................................................47 4.2.1 Initialization.........................................................................................................................................47 4.2.2 Result Codes ........................................................................................................................................48 4.2.3 Data Structures....................................................................................................................................49 4.2.4 Encoding Structured Carrier Message Symbols..................................................................................53 4.2.5 Encoding Generic Message (Non-Structured Carrier Message) Data................................................60 4.3 VISUAL BASIC LANGUAGE API.................................................................................................................61 4.3.1 Initialization.........................................................................................................................................61 4.3.2 Result Codes ........................................................................................................................................63 4.3.3 Data Structures....................................................................................................................................64 4.3.4 Encoding Structured Carrier Message Symbols..................................................................................68 5 PRINTING THE MAXICODE SYMBOL.....................................................................................................71 5.1 THE MAXICODE FONT ...............................................................................................................................71 5.2 VERTICAL SPACING...................................................................................................................................72 5.3 USING HEWLETT-PACKARD PCL FONTS ...................................................................................................72 - ii - Silver Bay Software LLC Maxicode Encoder Programmer’s Manual 5.3.1 Overview..............................................................................................................................................72 5.3.2 C Language Example...........................................................................................................................74 5.4 USING AFP PAGEDEFS ...........................................................................................................................75 5.5 XEROX PRINTING ......................................................................................................................................76 5.6 USING AS/400 DDS..................................................................................................................................76 6 APPENDIX.......................................................................................................................................................78 6.1 STRUCTURED MESSAGE APPEND...............................................................................................................78 6.2 FONT INITIALIZATION VALUES..................................................................................................................79