This extension provides Satellite Forms with full access to the Symbol Magnetic Stripe Reader.

Parameters

Error Codes

0          Normal

1          Global parameter error

2          Invalid parameter

3          Library is not open

4          Library is still open by others

5          Memory error occurred

6          Card information overflow

7          Firmware NAK answer

8          Waiting timeout

9          ROM check error

10         RAM check error

11         EEPROM check error

12         Error response

13         Check sum error

14         Bad read for buffered mode

15         No data for buffered mode

16         Not enough battery charge for MSR 3000

Scripts API

The following methods are accessible from the scripting language. For prototypes double-click on the extension method in the “Project” window of App Designer.  All methods are private methods.

Usage:  [Name of Control].[Name of Method]

Example:  MSR1.mAbout()

mAbout()

Description:  Shows extension’s about box.

Parameters:  None

Returns:  None

mArmToRead()

Description:  Enable MSR to be ready for a card swipe in buffered mode.

Parameters:  None

Returns:  Error code

mClose()

Description:  Close the MSR Manager Library, and free resources. 

Parameters:  None

Returns: Error code

mGetAddedField(integer)

Description:  Retrieve MSR added field string for given field number.

Parameters:  Field numbers 1 through 6

Returns:  Character

mGetBufferMode()

Description:  Retrieve MSR buffer mode setting. 

Parameters:  None

Returns: 

"0" for Un-buffered Mode

"1" for Buffered Mode

mGetDataBuffer(integer)

Description:  Request card data information for the Buffered Mode.

Parameters: 

Types:

"0" Get All Tracks

"1" Get Track 1

"2" Get Track 2

"3" Get Track 3

Returns:  Data buffer as string

mGetDataEditSetting()

Description:  Retrieve MSR data edit setting. 

Parameters:  None

Returns:  Character

mGetDecoderMode()

Description:  Retrieve MSR decoder mode setting. 

Parameters:  None

Returns:

"0" for Disable Data Edit

"1" for Data Edit Match

"3" for Data Edit Unmatch

mGetFlexibleField(integer)

Description:  Retrieve MSR flexible field string for given field number.

Parameters:  Field number 1 through 16

Returns:  String

mGetLastError()

Description:  Returns the error status of the last MSR function executed.

Parameters:  None

Returns:  Error code

mGetLibVersion()

Description:  Returns MSR 3000 software library version.

Parameters:  None

Returns:  Integer

mGetLRCSetting()

Description:  Retrieve MSR LRC setting. 

Parameters:  None

Returns: 

"0" for No LRC

"1" for Send LRC

mGetMSRVersion()

Description:  Returns MSR 3000 version.

Parameters:  None

Returns:  Integer

mGetPostamble()

Description:  Returns MSR postamble string.

Parameters:  None

Returns:  String

mGetPreamble()

Description:  Returns MSR preamble string.

Parameters:  None

Returns: String

mGetReservedChars(integer, integer)

Description:  Retrieve MSR reserved character info for given character number.

Parameters:  Character number 1 through 3 and

Data: 

"0" format

"1" SR_Bits

"2" SR_Chars

Returns:  String

mGetSendCmd(integer)

Description:  Retrieve MSR send command string for given command number. 

Parameters:  Command number 1 through 4

Returns:  String

mGetStatus()

Description:  Returns status of last magnetic stripe read.

Parameters:  None

Returns:  String

mGetTerminator()

Description:  Retrieve MSR terminator setting. 

Parameters:  None

Returns: 

"0" for CR and LF

"1" for CR

"2" for LF

"3" for None

mGetTrackSelection()

Description:  Retrieve MSR track selection setting. 

Parameters:  None

Returns: 

"0" for Any Track

"1" for Track 1 Only

"2" for Track 2 Only

"3" for Track 1 and Track 2

"4" for Track 3 Only

"5" for Track 1 and Track 3

"6" for Track 2 and Track 3

"7" for All Three Tracks

mGetTrackFormat(integer)

Description:  Retrieve MSR track format string for given track number.

Parameters:  Track Number 1 through 3.

Returns: 

"0" for Normal Decoder

"1" for Generic Decoder

"2" for Raw Data Decoder

mGetTrackSeparator()

Description:  Retrieve MSR track separator character.

Parameters:  None

Returns: Character

mOpen()

Description:  Load and initialize the MSR 3000 Manager Library. 

Parameters:  None

Returns: Error code

mReadMSRBuffer(integer)

Description:  Request Card Information until receiving data or time out. 

Parameters:  Wait time in 100ms units

Returns:  None

mReadMSRUnbuffer()

Description:  Request card data information for the unbuffered mode.

Parameters:  None

Returns:  None

mSelfDiagnose()

Description:  Initiate MSR 3000 self test and return results.

Parameters:  None

Returns:  Error code

mSetAddedField(integer)        

Description:  Set added field strings to MSR 3000.

Parameters:  Fields 1 through 6

Returns:  Error code

mSetBufferMod(integer)

Description:  Set buffer mode of MSR 3000.

Parameters: 

Modes:

"0" Un-buffered Mode

"1" Buffered Mode

Returns:  Error code

mSetDataEdit(integer)

Description:  Send data edit mode.

Parameters: 

Modes:

"0" Disable Data Edit

"1" Data Edit Match

"3" Data Edit Unmatch

Returns:  Error code

mSetDataEditSend(integer)

Description:  Set data edit send commands to MSR 3000.

Parameters:  Commands 1 through 4

Returns:  Error code

mSetDecoderMode(integer)

Description:  Set the decoder mode for the MSR 3000.

Parameters: 

Modes:

"0" Normal Decoder

"1" Generic Decoder

"2" Raw Data Decoder

Returns:  Error code

mSetDefault()

Description: 

Sets MSR with following default values: 

Buffer Mode: Un-buffered

Terminator: CR/LF

Preamble: None

Postamble: None

Track Selection: All Three Tracks

Track Separator: CR

LRC: Do Not Send LRC Data

Edit Setting: Disabled.

Parameters:  None

Returns:  Error code 

mSetFlexibleField(integer)

Description:  Sets flexible fields for data edit to MSR 3000.

Parameters:  Fields 1 through 16

Returns:  Error code

mSetLRC(integer)

Description:  Send LRC mode to MSR 3000. 

Parameters: 

Modes:

"0" No LRC

"1" Send LRC

Returns:  Error code

mSetPostamble(string)

Description:  Set a postamble string to MSR 3000.

Parameters:  Postamble string

Returns:  Error code

mSetPreamble(string)

Description:  Set a preamble string to MSR 3000.

Parameters:  Preamble string

Returns:  Error code

mSetReservedChar(integer)

Description:  Set Special Reserved Characters for Generic Decoder only. 

Parameters:  Reserved Characters 1 through 6

Returns:  Error code

mSetTerminator(integer)

Description:  Set terminator setting to MSR 3000.

Parameters: 

Terminators:

"0" CR and LF

"1" CR

"2" LF

"3" None

Returns:  Error code

mSetTrackFormat(string)

Description:  Set the parameters for the Generic Decoder, such as the Bit Format, Start and End Sentinel.

Parameters: 

Track ID

Format

SS-Bits

SS-ASCII

ES-Bits

ES-ASCII

Returns:  Error code

mSetTrackSelection(integer)

Description:  Select tracks to be decoded to MSR 3000.

Parameters: 

Track selects:

"0" Any Track

"1" Track 1 Only

"2" Track 2 Only

"3" Track 1 and Track 2

"4" Track 3 Only

"5" Track 1 and Track 3

"6" Track 2 and Track 3

"7" All Three Tracks

Returns:  Error code

mSetTrackSeparator(string)

Description:  Send a track separator character to MSR 3000.

Parameters:  Separator character

Returns:  Error code

DocID: 10150  DocDate: 2005-07-18