OUI_Object_Unlock()
See also: OpenObjects API
Return to Introduction  Previous page  Next page

This function is used to "unlock" and read the source of an OpenObject in the database, allowing you to send the passcode for decrypting or unlocking. It uses the format:

<MvFUNCTION NAME = "OUI_Object_Unlock" PARAMETERS = "code, encrypt, lock, source VAR, encrypt_flg VAR, lock_flg VAR, encrypt_ok VAR, lock_ok VAR" STANDARDOUTPUTLEVEL = "" ERROROUTPUTLEVEL = "syntax,expression">  

This function is called with the parameters:

·l.code      set to the object code  
·l.encrypt   set to the passcode to encrypt the object so it's token string cannot be viewed (without the passcode)  
·l.lock      set to the passcode to lock the object, so it's token string cannot be modified (without the passcode)  
·l.source   returns the clean object token string  
·l.encrypt_flg   returns the flag if the object is encrypted (1 = encrypted, 0 = not encrypted)  
·l.lock_flg   returns the flag if the object is locked (1 = locked, 0 = not locked)  
·l.encrypt_ok   returns the flag if the passcode was correct (1 = ok, 0 = not ok)  
·l.lock_ok   returns the flag if the passcode was correct (1 = ok, 0 = not ok)  

The return value is either a 1 (success) or 0 (failure).

*** On compiled Merchant, your Vendor ID Block must be registered (via OUI_Register_Vendor()) before calling this function ***

 

Send feedback on this documentation.
© 2004 - 2000 Darren Ehlers & OpenUI Developer Consortium