AtcUFLMW6Encoder Function

Navigation:  Crystal Reports > UFL Functions >

AtcUFLMW6Encoder Function

Previous pageReturn to chapter overviewNext page

Encodes a string using Aztec format.

Public Function AtcUFLMW6Encoder(ByVal Message As String, _

                                                       ByVal Mode As Integer, _

                                                       ByVal CorrectionLevel As Integer, _

                                                       ByVal PreferredFormat As Integer,

                                                       ByVal HandleTilde As Boolean, _

                                                       ByVal StructuredAppend As Boolean, _

                                                      ByVal SymbolID As Integer, _

                                                       ByVal SymbolCount As Integer) As Integer

Parameters

Message

     String to be encoded using Aztec format.

Mode

     Indicates which encoding mode is used, this parameter can be one of the following values.

Value

Comment

0

Auto mode for optimized encoding

1

Binary mode

CorrectionLevel

     Indicates the percentage of errors which can be recovered, the recommended value is 23.

PreferredFormat

     Indicates which format is used, the values of all formats are listed here.

HandleTilde

Indicates whether to process the tilde character "~" or not, the detailed description is:

o"~dNNN" is used to represent the ASCII character with the value of NNN.

StructuredAppend

Indicates whether the structured append is allowed or not, if this parameter is set to TRUE, use the parameters SymbolID and SymbolCount to specify which symbol this is in a sequence and the total number of symbols in the sequence.

SymbolID

     Specifies which symbol this is in a sequence, the parameter must be between 1 and SymbolCount.

SymbolCount

Specifies the total number of symbols in the sequence, the maximum value is 26, which means that up to 26 symbols can be linked together using the structured append protocol.

 

Return Value

Number of Aztec format string blocks. Each block has 254 characters, the only exception is that last block might contain <254 characters. Since Crystal Reports UFL function only allows the returned string with maximum 254 characters, we have to build entire Aztec format string by concatenating all blocks together.