ZKRMParametersMBS.AddKeyValuePair(item as ZKRMKeyValuePairMBS)
method, Kagi, MBS Dongle Plugin (MacKRM), class ZKRMParametersMBS, Plugin version: 4.3, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Adds a key-value pair.

ZKRMParametersMBS.BeginModalKRM(byref result as ZKRMResultMBS) as integer
method, Kagi, MBS Dongle Plugin (MacKRM), class ZKRMParametersMBS, Plugin version: 4.3, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Begin a modal KRM session.
Example:

dim r as ZKRMResultMBS
dim p as ZKRMParametersMBS
dim e as integer
dim s as string

StaticText2.text=""

p=new ZKRMParametersMBS
p.AddKeyValuePair NewZKRMKeyValuePairMBS("mykey1","myvalue1")
p.AddKeyValuePair NewZKRMKeyValuePairMBS("mykey2","myvalue2")

s=    "<krmData vendorID=""UC9"">"
s=s+  "<transactionFailureURL>http://www.mywebsite.invalid/MyTransactionFailurePage.html</transactionFailureURL>"
s=s+  "<connectionFailureURL>http://www.mywebsite.invalid/MyConnectionFailurePage.html</connectionFailureURL>"
s=s+  "<products>"
s=s+  "<product partNo="""" dbName=""KART_TEST_COMPLEX_ACG_UC9"" supplierSKU=""n/a"">"
s=s+  "<displayName lang=""en"">My Product</displayName>"
s=s+  "<price currency=""AUD"" basePrice=""100.00"" baseCurrency=""USD""/>"
s=s+  "<price currency=""CAD"" basePrice=""100.00"" baseCurrency=""USD""/>"
s=s+  "<price currency=""EUR"" basePrice=""100.00"" baseCurrency=""USD""/>"
s=s+  "<price currency=""GBP"" basePrice=""100.00"" baseCurrency=""USD""/>"
s=s+  "<price currency=""JPY"" basePrice=""100.00"" baseCurrency=""USD""/>"
s=s+  "<price currency=""USD"">100.00</price>"
s=s+  "</product>"
s=s+  "</products>"
s=s+  "</krmData>"

p.ModuleVersion=0
p.ModuleLanguage=kZKRMLanguageSystem
p.ModuleOptions=kZKRMOptionOfferWebOrder
p.ModuleUserEmail=""
p.ModuleUserName=""

p.ProductInitXML=s
p.ProductStoreURL="http://order.kagi.com/?UC9"
p.ProductTFYP="Custom string to include in the TFYP email"
p.ProductPO="Custom string to use as a Purchase Order number"

e=p.BeginModalKRM(r)

if e=kZKRMModuleNoErr then
  ResultWindow.ShowResult r
end if

StaticText2.text=str(e)+" "+GetModuleStatusString(e)

Notes:
Runs the KRM session through a modal dialog. The application will regain control when the transaction is complete.
The results are placed in a new object which will be stored in the passed result reference. (the result can be nil)

ZKRMParametersMBS.BeginModelessKRM as integer
method, Kagi, MBS Dongle Plugin (MacKRM), class ZKRMParametersMBS, Plugin version: 4.3, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Begin a modeless KRM session.
Example:

dim r as ZKRMResultMBS
// dim p as MyZKRMParametersMBS // this is saved on the window!
dim e as integer
dim s as string

StaticText1.text=""

p=new MyZKRMParametersMBS
p.AddKeyValuePair NewZKRMKeyValuePairMBS("mykey1","myvalue1")
p.AddKeyValuePair NewZKRMKeyValuePairMBS("mykey2","myvalue2")

s=    "<krmData vendorID=""UC9"">"
s=s+  "<transactionFailureURL>http://www.mywebsite.invalid/MyTransactionFailurePage.html</transactionFailureURL>"
s=s+  "<connectionFailureURL>http://www.mywebsite.invalid/MyConnectionFailurePage.html</connectionFailureURL>"
s=s+  "<products>"
s=s+  "<product partNo="""" dbName=""KART_TEST_COMPLEX_ACG_UC9"" supplierSKU=""n/a"">"
s=s+  "<displayName lang=""en"">My Product</displayName>"
s=s+  "<price currency=""AUD"" basePrice=""100.00"" baseCurrency=""USD""/>"
s=s+  "<price currency=""CAD"" basePrice=""100.00"" baseCurrency=""USD""/>"
s=s+  "<price currency=""EUR"" basePrice=""100.00"" baseCurrency=""USD""/>"
s=s+  "<price currency=""GBP"" basePrice=""100.00"" baseCurrency=""USD""/>"
s=s+  "<price currency=""JPY"" basePrice=""100.00"" baseCurrency=""USD""/>"
s=s+  "<price currency=""USD"">100.00</price>"
s=s+  "</product>"
s=s+  "</products>"
s=s+  "</krmData>"

p.ModuleVersion=0
p.ModuleLanguage=kZKRMLanguageSystem
p.ModuleOptions=kZKRMOptionOfferWebOrder
p.ModuleUserEmail=""
p.ModuleUserName=""

p.ProductInitXML=s
p.ProductStoreURL="http://order.kagi.com/?UC9"
p.ProductTFYP="Custom string to include in the TFYP email"
p.ProductPO="Custom string to use as a Purchase Order number"

e=p.BeginModelessKRM

StaticText1.text=str(e)+" "+GetModuleStatusString(e)

Notes:
Runs the KRM session through a modeless dialog. The application will regain control immediately, with a preliminary status result.

The result is given with the Complete Event being called.
If kZKRMModuleNoErr is returned, a Complete Event will be dispatched to the application later.

class ZKRMParametersMBS
class, Kagi, MBS Dongle Plugin (MacKRM), class ZKRMParametersMBS, Plugin version: 4.3, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: A class for configuration parameters passed to the Zonic KRM.
Notes: This class is part of the "Kagi Realbasic Plugin" which is distributed by Kagi. See <http://www.kagi.com/KRMzonic/>.

ZKRMParametersMBS.ClearKeyValuePairs
method, Kagi, MBS Dongle Plugin (MacKRM), class ZKRMParametersMBS, Plugin version: 4.3, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Clears the list of key-value pairs.

ZKRMParametersMBS.Completed(result as ZKRMResultMBS)
event, Kagi, MBS Dongle Plugin (MacKRM), class ZKRMParametersMBS, Plugin version: 4.3, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The event called on a modeless KRM session.

ZKRMParametersMBS.GetKeyValuePair(index as integer) as ZKRMKeyValuePairMBS
method, Kagi, MBS Dongle Plugin (MacKRM), class ZKRMParametersMBS, Plugin version: 4.3, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Returns a key-value pair.
Notes:
Returns nil on any error.
Index is 0 based.

ZKRMParametersMBS.KeyValuePairCount as integer
method, Kagi, MBS Dongle Plugin (MacKRM), class ZKRMParametersMBS, Plugin version: 4.3, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Counts all key-value pairs.
Notes: Returns 0 on any error.

ZKRMParametersMBS.ModuleLanguage as Integer
property, Kagi, MBS Dongle Plugin (MacKRM), class ZKRMParametersMBS, Plugin version: 4.3, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The language to be used by the module user interface.
Notes:
useful constants:

kZKRMLanguageSystem	=0	The user interface will attempt to match the user's preferred language for the system. If this language is not supported by the Zonic KRM, kZKRMLanguageEnglishIntl will be used.
kZKRMLanguageEnglishUS	=10	The user interface will be displayed in US English.
kZKRMLanguageEnglishIntl	=20	The user interface will be displayed in International English.
kZKRMLanguageJapanese	=30	The user interface will be displayed in Japanese.
kZKRMLanguageGerman	=40	The user interface will be displayed in German.
kZKRMLanguageFrench	=50	The user interface will be displayed in French.
kZKRMLanguageItalian	=60	The user interface will be displayed in Italian.

(Read and Write property)

ZKRMParametersMBS.ModuleOptions as Integer
property, Kagi, MBS Dongle Plugin (MacKRM), class ZKRMParametersMBS, Plugin version: 4.3, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Options to control the module.
Notes:
Should be set to kZKRMOptionDefault if the default behaviour is required.

Useful constants:

kZKRMOptionDefault	=0	The KRM should use the default behaviour for all options.
kZKRMOptionOfferWebOrder	=1	If set, the KRM will offer the user a chance to purchase through the Kagi Web Store before presenting the normal KRM user interface. This option can be used for products that can be purchased in a manner not supported by the KRM (e.g., cash or bulk orders), and where the application has not invoked the KRM through a "Order a single copy now with a credit card" user interface element. If the KRM has been invoked through a generic "Register Now" user interface element, this option ensures that users can still reach the Web Store if required.
kZKRMOptionEncryptedProductXML	=2	If set, the productInitXML field of the ZKRMParametersMBS structure is decrypted before use. This option can be set if the productInitXML field has been encrypted with a call to EncryptKRMString.

(Read and Write property)

ZKRMParametersMBS.ModuleUserEmail as String
property, Kagi, MBS Dongle Plugin (MacKRM), class ZKRMParametersMBS, Plugin version: 4.3, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Optional user email address to use as the default for the purchase window.
Notes:
If this field is "", the user email address will be obtained from the system.
(Read and Write property)

ZKRMParametersMBS.ModuleUserName as String
property, Kagi, MBS Dongle Plugin (MacKRM), class ZKRMParametersMBS, Plugin version: 4.3, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Optional user name to use as the default for the purchase window.
Notes:
If this field is "", the user name will be obtained from the system.
(Read and Write property)

ZKRMParametersMBS.ProductAffiliate as String
property, Kagi, MBS Dongle Plugin (MacKRM), class ZKRMParametersMBS, Plugin version: 5.3, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: A product affiliate code to pass to the Kagi Transaction Server.
Notes: (Read and Write property)

ZKRMParametersMBS.ProductInitXML as String
property, Kagi, MBS Dongle Plugin (MacKRM), class ZKRMParametersMBS, Plugin version: 4.3, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Product initialization XML.
Notes:
This string is passed to the Kagi Registration Server, which uses it to construct an appropriate order description for the KRM.
(Read and Write property)

ZKRMParametersMBS.ProductPO as String
property, Kagi, MBS Dongle Plugin (MacKRM), class ZKRMParametersMBS, Plugin version: 4.3, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Optional product-specific purchase order number.
Notes:
This string is passed unchanged through the Kagi Registration Server, and included in both the final TFYP email and any printed receipt.
(Read and Write property)

ZKRMParametersMBS.ProductStoreURL as String
property, Kagi, MBS Dongle Plugin (MacKRM), class ZKRMParametersMBS, Plugin version: 4.3, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Product store URL.
Notes:
If moduleOptions contains kZKRMOptionOfferWebOrder, the user will be offered the chance to bypass the KRM and visit this URL in their browser.
(Read and Write property)

ZKRMParametersMBS.ProductTFYP as String
property, Kagi, MBS Dongle Plugin (MacKRM), class ZKRMParametersMBS, Plugin version: 4.3, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: Optional product-specific "TFYP" data.
Notes:
This string is passed unchanged through the Kagi Registration Server, and included in both the final TFYP email and any printed receipt.
(Read and Write property)

ZKRMParametersMBS.Version as integer
method, Kagi, MBS Dongle Plugin (MacKRM), class ZKRMParametersMBS, Plugin version: 5.3, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.

Function: The version of this structure.