llReadKeyValue

Template:Needs Translation/LSL/de Template:Needs Translation/LSL/es Template:Needs Translation/LSL/el Template:Needs Translation/LSL/fr Template:Needs Translation/LSL/he Template:Needs Translation/LSL/it Template:Needs Translation/LSL/ko Template:Needs Translation/LSL/nl Template:Needs Translation/LSL/hu Template:Needs Translation/LSL/no Template:Needs Translation/LSL/da Template:Needs Translation/LSL/sv Template:Needs Translation/LSL/tr Template:Needs Translation/LSL/pl Template:Needs Translation/LSL/pt Template:Needs Translation/LSL/ru Template:Needs Translation/LSL/th Template:Needs Translation/LSL/uk Template:Needs Translation/LSL/zh-Hans Template:Needs Translation/LSL/zh-Hant

/LSL

ReadKeyValue

llReadKeyValue

Summary

Function: key llReadKeyValue( string k );

	Forced Delay
	Energy

Start an asynchronous transaction to read the value associated with the specified key (k) and the script's Experience.
Returns a handle (a key) that can be used to identify the corresponding dataserver event to determine if this command succeeded or failed and the results.

• string

k

–

The key for the key-value pair

If the key does not exist the dataserver will return a failure along with the error XP_ERROR_KEY_NOT_FOUND.

For this function to work, the script must be compiled into an Experience.

Specification

Dataserver

The dataserver callback parameters are:

• A key containing the handle returned from llReadKeyValue
• A string containing a comma-delimited list (cdl). llDumpList2String([ integer success ] + components);
  • components vary depending upon success or failure of request.
  • Failure: cdl = llDumpList2String([ 0, integer error],",")
  • Success: cdl = llDumpList2String([ 1, string value ],",")

String Components

• integer	success	–	A boolean specifying if the transaction succeeded (1) or not (0).
• integer	error	–	An XP_ERROR_* flag that describes why the operation failed.
• string	value	–	The value for the key-value pair. Maximum 2047 characters, or 4095 if using Mono. Note! This value may contain commas.

Caveats

• If you recompile a script that was previously associated with an Experience but do so with a client that lacks the ability to compile scripts into an experience the script will lose the associated Experience.

Examples

key trans;
default
{
    state_entry()
    {
        trans = llReadKeyValue("FOO");
    }
    dataserver(key t, string value)
    {
        if (t == trans)
        {
            // our llReadKeyValue transaction is done
            if (llGetSubString(value, 0, 0) == "1")
            {
                // the key-value pair was successfully read
                llSay(0, "New key-value pair value: " + llGetSubString(value, 2, -1));
            }
            else
            {
                // the key-value pair failed to read
                integer error =  (integer)llGetSubString(value, 2, -1);
                llSay(0, "Key-value failed to read: " + llGetExperienceErrorMessage(error));
            }
        } 
    }
}

Notes

Compiling

For a script to be associated with an Experience...

• It must be compiled with a client that is Experience aware,
• The "Use Experience" checkbox must be checked,
• And one of the users Experience keys selected.

Important: Not all TPVs have this functionality.

See Also

Functions

• llGetExperienceErrorMessage
• llCreateKeyValue
• llReadKeyValue
• llUpdateKeyValue
• llDeleteKeyValue
• llDataSizeKeyValue
• llKeyCountKeyValue
• llKeysKeyValue

Deep Notes

Signature
function key llReadKeyValue( string k );

Haiku
Async read starts now, Key sought in Experience, Hope it's not missing! — ChatGPT