UniPRT SDK v1.0.0.0
 
Loading...
Searching...
No Matches
<IMaxicodeMsgStructured> Protocol Reference

Maxicode barcode data. Maxicode Free Form carrier message. Only applies to Mode 2 and 3.Modes 2, 3 "structured carrier message" requires fields for postal code, country code, and service class. More...

#include <IMaxicodeMsgStructured.h>

Inheritance diagram for <IMaxicodeMsgStructured>:
<IMaxicodeData> AMaxicodeMsgStructured MaxicodeMsgStructured PglMaxicodeMsgStructured

Properties

NSString * postalCode
 
NSString * countryCode
 
NSString * serviceClass
 
NSString * remainingMsg
 
- Properties inherited from <IMaxicodeData>
MaxicodeModeEnum mode
 The Mode used to state the format of the barcode data. See MaxicodeModeEnum for possible supported modes.
 
NSString * data
 The barcode data that includes the primary message + secondary messages to be encoded in the barcode.
 

Detailed Description

Maxicode barcode data. Maxicode Free Form carrier message. Only applies to Mode 2 and 3.

Modes 2, 3 "structured carrier message" requires fields for postal code, country code, and service class.

Message format typically encoded as follows:

  • <primaryMsg><secondaryMsg> = <postalCode>Gs<countryCode>Gs<serviceClass>Gs<secondaryMsg>EOT

postal code (6-9 chars), country code (3 digits), service class (3 digits)

  • Mode 2 = US: up to 9 digit postal code (all numeric)
  • Mode 3 = Canada: 6 digit postal code (alphanumeric) Where:
  • Gs: Group Separator (0x1D)
  • EOT: End Of Transmit (0x04)

Property Documentation

◆ countryCode

- (NSString*) countryCode
readwritenonatomiccopy

◆ postalCode

- (NSString*) postalCode
readwritenonatomiccopy

◆ remainingMsg

- (NSString*) remainingMsg
readwritenonatomiccopy

◆ serviceClass

- (NSString*) serviceClass
readwritenonatomiccopy

The documentation for this protocol was generated from the following file: